commit doc: document that -c, -C, -F and --fixup with -m error
[git.git] / config.c
blobe617c2018d22b6d389548a3573d2deb2ec608b99
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 "repository.h"
11 #include "lockfile.h"
12 #include "exec_cmd.h"
13 #include "strbuf.h"
14 #include "quote.h"
15 #include "hashmap.h"
16 #include "string-list.h"
17 #include "utf8.h"
18 #include "dir.h"
20 struct config_source {
21 struct config_source *prev;
22 union {
23 FILE *file;
24 struct config_buf {
25 const char *buf;
26 size_t len;
27 size_t pos;
28 } buf;
29 } u;
30 enum config_origin_type origin_type;
31 const char *name;
32 const char *path;
33 int die_on_error;
34 int linenr;
35 int eof;
36 struct strbuf value;
37 struct strbuf var;
39 int (*do_fgetc)(struct config_source *c);
40 int (*do_ungetc)(int c, struct config_source *conf);
41 long (*do_ftell)(struct config_source *c);
45 * These variables record the "current" config source, which
46 * can be accessed by parsing callbacks.
48 * The "cf" variable will be non-NULL only when we are actually parsing a real
49 * config source (file, blob, cmdline, etc).
51 * The "current_config_kvi" variable will be non-NULL only when we are feeding
52 * cached config from a configset into a callback.
54 * They should generally never be non-NULL at the same time. If they are both
55 * NULL, then we aren't parsing anything (and depending on the function looking
56 * at the variables, it's either a bug for it to be called in the first place,
57 * or it's a function which can be reused for non-config purposes, and should
58 * fall back to some sane behavior).
60 static struct config_source *cf;
61 static struct key_value_info *current_config_kvi;
64 * Similar to the variables above, this gives access to the "scope" of the
65 * current value (repo, global, etc). For cached values, it can be found via
66 * the current_config_kvi as above. During parsing, the current value can be
67 * found in this variable. It's not part of "cf" because it transcends a single
68 * file (i.e., a file included from .git/config is still in "repo" scope).
70 static enum config_scope current_parsing_scope;
72 static int core_compression_seen;
73 static int pack_compression_seen;
74 static int zlib_compression_seen;
76 static int config_file_fgetc(struct config_source *conf)
78 return getc_unlocked(conf->u.file);
81 static int config_file_ungetc(int c, struct config_source *conf)
83 return ungetc(c, conf->u.file);
86 static long config_file_ftell(struct config_source *conf)
88 return ftell(conf->u.file);
92 static int config_buf_fgetc(struct config_source *conf)
94 if (conf->u.buf.pos < conf->u.buf.len)
95 return conf->u.buf.buf[conf->u.buf.pos++];
97 return EOF;
100 static int config_buf_ungetc(int c, struct config_source *conf)
102 if (conf->u.buf.pos > 0) {
103 conf->u.buf.pos--;
104 if (conf->u.buf.buf[conf->u.buf.pos] != c)
105 die("BUG: config_buf can only ungetc the same character");
106 return c;
109 return EOF;
112 static long config_buf_ftell(struct config_source *conf)
114 return conf->u.buf.pos;
117 #define MAX_INCLUDE_DEPTH 10
118 static const char include_depth_advice[] =
119 "exceeded maximum include depth (%d) while including\n"
120 " %s\n"
121 "from\n"
122 " %s\n"
123 "Do you have circular includes?";
124 static int handle_path_include(const char *path, struct config_include_data *inc)
126 int ret = 0;
127 struct strbuf buf = STRBUF_INIT;
128 char *expanded;
130 if (!path)
131 return config_error_nonbool("include.path");
133 expanded = expand_user_path(path, 0);
134 if (!expanded)
135 return error("could not expand include path '%s'", path);
136 path = expanded;
139 * Use an absolute path as-is, but interpret relative paths
140 * based on the including config file.
142 if (!is_absolute_path(path)) {
143 char *slash;
145 if (!cf || !cf->path)
146 return error("relative config includes must come from files");
148 slash = find_last_dir_sep(cf->path);
149 if (slash)
150 strbuf_add(&buf, cf->path, slash - cf->path + 1);
151 strbuf_addstr(&buf, path);
152 path = buf.buf;
155 if (!access_or_die(path, R_OK, 0)) {
156 if (++inc->depth > MAX_INCLUDE_DEPTH)
157 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
158 !cf ? "<unknown>" :
159 cf->name ? cf->name :
160 "the command line");
161 ret = git_config_from_file(git_config_include, path, inc);
162 inc->depth--;
164 strbuf_release(&buf);
165 free(expanded);
166 return ret;
169 static int prepare_include_condition_pattern(struct strbuf *pat)
171 struct strbuf path = STRBUF_INIT;
172 char *expanded;
173 int prefix = 0;
175 expanded = expand_user_path(pat->buf, 1);
176 if (expanded) {
177 strbuf_reset(pat);
178 strbuf_addstr(pat, expanded);
179 free(expanded);
182 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
183 const char *slash;
185 if (!cf || !cf->path)
186 return error(_("relative config include "
187 "conditionals must come from files"));
189 strbuf_realpath(&path, cf->path, 1);
190 slash = find_last_dir_sep(path.buf);
191 if (!slash)
192 die("BUG: how is this possible?");
193 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
194 prefix = slash - path.buf + 1 /* slash */;
195 } else if (!is_absolute_path(pat->buf))
196 strbuf_insert(pat, 0, "**/", 3);
198 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
199 strbuf_addstr(pat, "**");
201 strbuf_release(&path);
202 return prefix;
205 static int include_by_gitdir(const struct config_options *opts,
206 const char *cond, size_t cond_len, int icase)
208 struct strbuf text = STRBUF_INIT;
209 struct strbuf pattern = STRBUF_INIT;
210 int ret = 0, prefix;
211 const char *git_dir;
212 int already_tried_absolute = 0;
214 if (opts->git_dir)
215 git_dir = opts->git_dir;
216 else
217 goto done;
219 strbuf_realpath(&text, git_dir, 1);
220 strbuf_add(&pattern, cond, cond_len);
221 prefix = prepare_include_condition_pattern(&pattern);
223 again:
224 if (prefix < 0)
225 goto done;
227 if (prefix > 0) {
229 * perform literal matching on the prefix part so that
230 * any wildcard character in it can't create side effects.
232 if (text.len < prefix)
233 goto done;
234 if (!icase && strncmp(pattern.buf, text.buf, prefix))
235 goto done;
236 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
237 goto done;
240 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
241 icase ? WM_CASEFOLD : 0);
243 if (!ret && !already_tried_absolute) {
245 * We've tried e.g. matching gitdir:~/work, but if
246 * ~/work is a symlink to /mnt/storage/work
247 * strbuf_realpath() will expand it, so the rule won't
248 * match. Let's match against a
249 * strbuf_add_absolute_path() version of the path,
250 * which'll do the right thing
252 strbuf_reset(&text);
253 strbuf_add_absolute_path(&text, git_dir);
254 already_tried_absolute = 1;
255 goto again;
257 done:
258 strbuf_release(&pattern);
259 strbuf_release(&text);
260 return ret;
263 static int include_condition_is_true(const struct config_options *opts,
264 const char *cond, size_t cond_len)
267 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
268 return include_by_gitdir(opts, cond, cond_len, 0);
269 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
270 return include_by_gitdir(opts, cond, cond_len, 1);
272 /* unknown conditionals are always false */
273 return 0;
276 int git_config_include(const char *var, const char *value, void *data)
278 struct config_include_data *inc = data;
279 const char *cond, *key;
280 int cond_len;
281 int ret;
284 * Pass along all values, including "include" directives; this makes it
285 * possible to query information on the includes themselves.
287 ret = inc->fn(var, value, inc->data);
288 if (ret < 0)
289 return ret;
291 if (!strcmp(var, "include.path"))
292 ret = handle_path_include(value, inc);
294 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
295 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
296 !strcmp(key, "path"))
297 ret = handle_path_include(value, inc);
299 return ret;
302 void git_config_push_parameter(const char *text)
304 struct strbuf env = STRBUF_INIT;
305 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
306 if (old && *old) {
307 strbuf_addstr(&env, old);
308 strbuf_addch(&env, ' ');
310 sq_quote_buf(&env, text);
311 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
312 strbuf_release(&env);
315 static inline int iskeychar(int c)
317 return isalnum(c) || c == '-';
321 * Auxiliary function to sanity-check and split the key into the section
322 * identifier and variable name.
324 * Returns 0 on success, -1 when there is an invalid character in the key and
325 * -2 if there is no section name in the key.
327 * store_key - pointer to char* which will hold a copy of the key with
328 * lowercase section and variable name
329 * baselen - pointer to int which will hold the length of the
330 * section + subsection part, can be NULL
332 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
334 int i, dot, baselen;
335 const char *last_dot = strrchr(key, '.');
338 * Since "key" actually contains the section name and the real
339 * key name separated by a dot, we have to know where the dot is.
342 if (last_dot == NULL || last_dot == key) {
343 if (!quiet)
344 error("key does not contain a section: %s", key);
345 return -CONFIG_NO_SECTION_OR_NAME;
348 if (!last_dot[1]) {
349 if (!quiet)
350 error("key does not contain variable name: %s", key);
351 return -CONFIG_NO_SECTION_OR_NAME;
354 baselen = last_dot - key;
355 if (baselen_)
356 *baselen_ = baselen;
359 * Validate the key and while at it, lower case it for matching.
361 if (store_key)
362 *store_key = xmallocz(strlen(key));
364 dot = 0;
365 for (i = 0; key[i]; i++) {
366 unsigned char c = key[i];
367 if (c == '.')
368 dot = 1;
369 /* Leave the extended basename untouched.. */
370 if (!dot || i > baselen) {
371 if (!iskeychar(c) ||
372 (i == baselen + 1 && !isalpha(c))) {
373 if (!quiet)
374 error("invalid key: %s", key);
375 goto out_free_ret_1;
377 c = tolower(c);
378 } else if (c == '\n') {
379 if (!quiet)
380 error("invalid key (newline): %s", key);
381 goto out_free_ret_1;
383 if (store_key)
384 (*store_key)[i] = c;
387 return 0;
389 out_free_ret_1:
390 if (store_key) {
391 FREE_AND_NULL(*store_key);
393 return -CONFIG_INVALID_KEY;
396 int git_config_parse_key(const char *key, char **store_key, int *baselen)
398 return git_config_parse_key_1(key, store_key, baselen, 0);
401 int git_config_key_is_valid(const char *key)
403 return !git_config_parse_key_1(key, NULL, NULL, 1);
406 int git_config_parse_parameter(const char *text,
407 config_fn_t fn, void *data)
409 const char *value;
410 char *canonical_name;
411 struct strbuf **pair;
412 int ret;
414 pair = strbuf_split_str(text, '=', 2);
415 if (!pair[0])
416 return error("bogus config parameter: %s", text);
418 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
419 strbuf_setlen(pair[0], pair[0]->len - 1);
420 value = pair[1] ? pair[1]->buf : "";
421 } else {
422 value = NULL;
425 strbuf_trim(pair[0]);
426 if (!pair[0]->len) {
427 strbuf_list_free(pair);
428 return error("bogus config parameter: %s", text);
431 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
432 ret = -1;
433 } else {
434 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
435 free(canonical_name);
437 strbuf_list_free(pair);
438 return ret;
441 int git_config_from_parameters(config_fn_t fn, void *data)
443 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
444 int ret = 0;
445 char *envw;
446 const char **argv = NULL;
447 int nr = 0, alloc = 0;
448 int i;
449 struct config_source source;
451 if (!env)
452 return 0;
454 memset(&source, 0, sizeof(source));
455 source.prev = cf;
456 source.origin_type = CONFIG_ORIGIN_CMDLINE;
457 cf = &source;
459 /* sq_dequote will write over it */
460 envw = xstrdup(env);
462 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
463 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
464 goto out;
467 for (i = 0; i < nr; i++) {
468 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
469 ret = -1;
470 goto out;
474 out:
475 free(argv);
476 free(envw);
477 cf = source.prev;
478 return ret;
481 static int get_next_char(void)
483 int c = cf->do_fgetc(cf);
485 if (c == '\r') {
486 /* DOS like systems */
487 c = cf->do_fgetc(cf);
488 if (c != '\n') {
489 if (c != EOF)
490 cf->do_ungetc(c, cf);
491 c = '\r';
494 if (c == '\n')
495 cf->linenr++;
496 if (c == EOF) {
497 cf->eof = 1;
498 cf->linenr++;
499 c = '\n';
501 return c;
504 static char *parse_value(void)
506 int quote = 0, comment = 0, space = 0;
508 strbuf_reset(&cf->value);
509 for (;;) {
510 int c = get_next_char();
511 if (c == '\n') {
512 if (quote) {
513 cf->linenr--;
514 return NULL;
516 return cf->value.buf;
518 if (comment)
519 continue;
520 if (isspace(c) && !quote) {
521 if (cf->value.len)
522 space++;
523 continue;
525 if (!quote) {
526 if (c == ';' || c == '#') {
527 comment = 1;
528 continue;
531 for (; space; space--)
532 strbuf_addch(&cf->value, ' ');
533 if (c == '\\') {
534 c = get_next_char();
535 switch (c) {
536 case '\n':
537 continue;
538 case 't':
539 c = '\t';
540 break;
541 case 'b':
542 c = '\b';
543 break;
544 case 'n':
545 c = '\n';
546 break;
547 /* Some characters escape as themselves */
548 case '\\': case '"':
549 break;
550 /* Reject unknown escape sequences */
551 default:
552 return NULL;
554 strbuf_addch(&cf->value, c);
555 continue;
557 if (c == '"') {
558 quote = 1-quote;
559 continue;
561 strbuf_addch(&cf->value, c);
565 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
567 int c;
568 char *value;
569 int ret;
571 /* Get the full name */
572 for (;;) {
573 c = get_next_char();
574 if (cf->eof)
575 break;
576 if (!iskeychar(c))
577 break;
578 strbuf_addch(name, tolower(c));
581 while (c == ' ' || c == '\t')
582 c = get_next_char();
584 value = NULL;
585 if (c != '\n') {
586 if (c != '=')
587 return -1;
588 value = parse_value();
589 if (!value)
590 return -1;
593 * We already consumed the \n, but we need linenr to point to
594 * the line we just parsed during the call to fn to get
595 * accurate line number in error messages.
597 cf->linenr--;
598 ret = fn(name->buf, value, data);
599 if (ret >= 0)
600 cf->linenr++;
601 return ret;
604 static int get_extended_base_var(struct strbuf *name, int c)
606 do {
607 if (c == '\n')
608 goto error_incomplete_line;
609 c = get_next_char();
610 } while (isspace(c));
612 /* We require the format to be '[base "extension"]' */
613 if (c != '"')
614 return -1;
615 strbuf_addch(name, '.');
617 for (;;) {
618 int c = get_next_char();
619 if (c == '\n')
620 goto error_incomplete_line;
621 if (c == '"')
622 break;
623 if (c == '\\') {
624 c = get_next_char();
625 if (c == '\n')
626 goto error_incomplete_line;
628 strbuf_addch(name, c);
631 /* Final ']' */
632 if (get_next_char() != ']')
633 return -1;
634 return 0;
635 error_incomplete_line:
636 cf->linenr--;
637 return -1;
640 static int get_base_var(struct strbuf *name)
642 for (;;) {
643 int c = get_next_char();
644 if (cf->eof)
645 return -1;
646 if (c == ']')
647 return 0;
648 if (isspace(c))
649 return get_extended_base_var(name, c);
650 if (!iskeychar(c) && c != '.')
651 return -1;
652 strbuf_addch(name, tolower(c));
656 static int git_parse_source(config_fn_t fn, void *data)
658 int comment = 0;
659 int baselen = 0;
660 struct strbuf *var = &cf->var;
661 int error_return = 0;
662 char *error_msg = NULL;
664 /* U+FEFF Byte Order Mark in UTF8 */
665 const char *bomptr = utf8_bom;
667 for (;;) {
668 int c = get_next_char();
669 if (bomptr && *bomptr) {
670 /* We are at the file beginning; skip UTF8-encoded BOM
671 * if present. Sane editors won't put this in on their
672 * own, but e.g. Windows Notepad will do it happily. */
673 if (c == (*bomptr & 0377)) {
674 bomptr++;
675 continue;
676 } else {
677 /* Do not tolerate partial BOM. */
678 if (bomptr != utf8_bom)
679 break;
680 /* No BOM at file beginning. Cool. */
681 bomptr = NULL;
684 if (c == '\n') {
685 if (cf->eof)
686 return 0;
687 comment = 0;
688 continue;
690 if (comment || isspace(c))
691 continue;
692 if (c == '#' || c == ';') {
693 comment = 1;
694 continue;
696 if (c == '[') {
697 /* Reset prior to determining a new stem */
698 strbuf_reset(var);
699 if (get_base_var(var) < 0 || var->len < 1)
700 break;
701 strbuf_addch(var, '.');
702 baselen = var->len;
703 continue;
705 if (!isalpha(c))
706 break;
708 * Truncate the var name back to the section header
709 * stem prior to grabbing the suffix part of the name
710 * and the value.
712 strbuf_setlen(var, baselen);
713 strbuf_addch(var, tolower(c));
714 if (get_value(fn, data, var) < 0)
715 break;
718 switch (cf->origin_type) {
719 case CONFIG_ORIGIN_BLOB:
720 error_msg = xstrfmt(_("bad config line %d in blob %s"),
721 cf->linenr, cf->name);
722 break;
723 case CONFIG_ORIGIN_FILE:
724 error_msg = xstrfmt(_("bad config line %d in file %s"),
725 cf->linenr, cf->name);
726 break;
727 case CONFIG_ORIGIN_STDIN:
728 error_msg = xstrfmt(_("bad config line %d in standard input"),
729 cf->linenr);
730 break;
731 case CONFIG_ORIGIN_SUBMODULE_BLOB:
732 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
733 cf->linenr, cf->name);
734 break;
735 case CONFIG_ORIGIN_CMDLINE:
736 error_msg = xstrfmt(_("bad config line %d in command line %s"),
737 cf->linenr, cf->name);
738 break;
739 default:
740 error_msg = xstrfmt(_("bad config line %d in %s"),
741 cf->linenr, cf->name);
744 if (cf->die_on_error)
745 die("%s", error_msg);
746 else
747 error_return = error("%s", error_msg);
749 free(error_msg);
750 return error_return;
753 static int parse_unit_factor(const char *end, uintmax_t *val)
755 if (!*end)
756 return 1;
757 else if (!strcasecmp(end, "k")) {
758 *val *= 1024;
759 return 1;
761 else if (!strcasecmp(end, "m")) {
762 *val *= 1024 * 1024;
763 return 1;
765 else if (!strcasecmp(end, "g")) {
766 *val *= 1024 * 1024 * 1024;
767 return 1;
769 return 0;
772 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
774 if (value && *value) {
775 char *end;
776 intmax_t val;
777 uintmax_t uval;
778 uintmax_t factor = 1;
780 errno = 0;
781 val = strtoimax(value, &end, 0);
782 if (errno == ERANGE)
783 return 0;
784 if (!parse_unit_factor(end, &factor)) {
785 errno = EINVAL;
786 return 0;
788 uval = labs(val);
789 uval *= factor;
790 if (uval > max || labs(val) > uval) {
791 errno = ERANGE;
792 return 0;
794 val *= factor;
795 *ret = val;
796 return 1;
798 errno = EINVAL;
799 return 0;
802 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
804 if (value && *value) {
805 char *end;
806 uintmax_t val;
807 uintmax_t oldval;
809 errno = 0;
810 val = strtoumax(value, &end, 0);
811 if (errno == ERANGE)
812 return 0;
813 oldval = val;
814 if (!parse_unit_factor(end, &val)) {
815 errno = EINVAL;
816 return 0;
818 if (val > max || oldval > val) {
819 errno = ERANGE;
820 return 0;
822 *ret = val;
823 return 1;
825 errno = EINVAL;
826 return 0;
829 static int git_parse_int(const char *value, int *ret)
831 intmax_t tmp;
832 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
833 return 0;
834 *ret = tmp;
835 return 1;
838 static int git_parse_int64(const char *value, int64_t *ret)
840 intmax_t tmp;
841 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
842 return 0;
843 *ret = tmp;
844 return 1;
847 int git_parse_ulong(const char *value, unsigned long *ret)
849 uintmax_t tmp;
850 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
851 return 0;
852 *ret = tmp;
853 return 1;
856 static int git_parse_ssize_t(const char *value, ssize_t *ret)
858 intmax_t tmp;
859 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
860 return 0;
861 *ret = tmp;
862 return 1;
865 NORETURN
866 static void die_bad_number(const char *name, const char *value)
868 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
870 if (!value)
871 value = "";
873 if (!(cf && cf->name))
874 die(_("bad numeric config value '%s' for '%s': %s"),
875 value, name, error_type);
877 switch (cf->origin_type) {
878 case CONFIG_ORIGIN_BLOB:
879 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
880 value, name, cf->name, error_type);
881 case CONFIG_ORIGIN_FILE:
882 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
883 value, name, cf->name, error_type);
884 case CONFIG_ORIGIN_STDIN:
885 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
886 value, name, error_type);
887 case CONFIG_ORIGIN_SUBMODULE_BLOB:
888 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
889 value, name, cf->name, error_type);
890 case CONFIG_ORIGIN_CMDLINE:
891 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
892 value, name, cf->name, error_type);
893 default:
894 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
895 value, name, cf->name, error_type);
899 int git_config_int(const char *name, const char *value)
901 int ret;
902 if (!git_parse_int(value, &ret))
903 die_bad_number(name, value);
904 return ret;
907 int64_t git_config_int64(const char *name, const char *value)
909 int64_t ret;
910 if (!git_parse_int64(value, &ret))
911 die_bad_number(name, value);
912 return ret;
915 unsigned long git_config_ulong(const char *name, const char *value)
917 unsigned long ret;
918 if (!git_parse_ulong(value, &ret))
919 die_bad_number(name, value);
920 return ret;
923 ssize_t git_config_ssize_t(const char *name, const char *value)
925 ssize_t ret;
926 if (!git_parse_ssize_t(value, &ret))
927 die_bad_number(name, value);
928 return ret;
931 static int git_parse_maybe_bool_text(const char *value)
933 if (!value)
934 return 1;
935 if (!*value)
936 return 0;
937 if (!strcasecmp(value, "true")
938 || !strcasecmp(value, "yes")
939 || !strcasecmp(value, "on"))
940 return 1;
941 if (!strcasecmp(value, "false")
942 || !strcasecmp(value, "no")
943 || !strcasecmp(value, "off"))
944 return 0;
945 return -1;
948 int git_parse_maybe_bool(const char *value)
950 int v = git_parse_maybe_bool_text(value);
951 if (0 <= v)
952 return v;
953 if (git_parse_int(value, &v))
954 return !!v;
955 return -1;
958 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
960 int v = git_parse_maybe_bool_text(value);
961 if (0 <= v) {
962 *is_bool = 1;
963 return v;
965 *is_bool = 0;
966 return git_config_int(name, value);
969 int git_config_bool(const char *name, const char *value)
971 int discard;
972 return !!git_config_bool_or_int(name, value, &discard);
975 int git_config_string(const char **dest, const char *var, const char *value)
977 if (!value)
978 return config_error_nonbool(var);
979 *dest = xstrdup(value);
980 return 0;
983 int git_config_pathname(const char **dest, const char *var, const char *value)
985 if (!value)
986 return config_error_nonbool(var);
987 *dest = expand_user_path(value, 0);
988 if (!*dest)
989 die(_("failed to expand user dir in: '%s'"), value);
990 return 0;
993 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
995 if (!value)
996 return config_error_nonbool(var);
997 if (parse_expiry_date(value, timestamp))
998 return error(_("'%s' for '%s' is not a valid timestamp"),
999 value, var);
1000 return 0;
1003 static int git_default_core_config(const char *var, const char *value)
1005 /* This needs a better name */
1006 if (!strcmp(var, "core.filemode")) {
1007 trust_executable_bit = git_config_bool(var, value);
1008 return 0;
1010 if (!strcmp(var, "core.trustctime")) {
1011 trust_ctime = git_config_bool(var, value);
1012 return 0;
1014 if (!strcmp(var, "core.checkstat")) {
1015 if (!strcasecmp(value, "default"))
1016 check_stat = 1;
1017 else if (!strcasecmp(value, "minimal"))
1018 check_stat = 0;
1021 if (!strcmp(var, "core.quotepath")) {
1022 quote_path_fully = git_config_bool(var, value);
1023 return 0;
1026 if (!strcmp(var, "core.symlinks")) {
1027 has_symlinks = git_config_bool(var, value);
1028 return 0;
1031 if (!strcmp(var, "core.ignorecase")) {
1032 ignore_case = git_config_bool(var, value);
1033 return 0;
1036 if (!strcmp(var, "core.attributesfile"))
1037 return git_config_pathname(&git_attributes_file, var, value);
1039 if (!strcmp(var, "core.hookspath"))
1040 return git_config_pathname(&git_hooks_path, var, value);
1042 if (!strcmp(var, "core.bare")) {
1043 is_bare_repository_cfg = git_config_bool(var, value);
1044 return 0;
1047 if (!strcmp(var, "core.ignorestat")) {
1048 assume_unchanged = git_config_bool(var, value);
1049 return 0;
1052 if (!strcmp(var, "core.prefersymlinkrefs")) {
1053 prefer_symlink_refs = git_config_bool(var, value);
1054 return 0;
1057 if (!strcmp(var, "core.logallrefupdates")) {
1058 if (value && !strcasecmp(value, "always"))
1059 log_all_ref_updates = LOG_REFS_ALWAYS;
1060 else if (git_config_bool(var, value))
1061 log_all_ref_updates = LOG_REFS_NORMAL;
1062 else
1063 log_all_ref_updates = LOG_REFS_NONE;
1064 return 0;
1067 if (!strcmp(var, "core.warnambiguousrefs")) {
1068 warn_ambiguous_refs = git_config_bool(var, value);
1069 return 0;
1072 if (!strcmp(var, "core.abbrev")) {
1073 if (!value)
1074 return config_error_nonbool(var);
1075 if (!strcasecmp(value, "auto"))
1076 default_abbrev = -1;
1077 else {
1078 int abbrev = git_config_int(var, value);
1079 if (abbrev < minimum_abbrev || abbrev > 40)
1080 return error("abbrev length out of range: %d", abbrev);
1081 default_abbrev = abbrev;
1083 return 0;
1086 if (!strcmp(var, "core.disambiguate"))
1087 return set_disambiguate_hint_config(var, value);
1089 if (!strcmp(var, "core.loosecompression")) {
1090 int level = git_config_int(var, value);
1091 if (level == -1)
1092 level = Z_DEFAULT_COMPRESSION;
1093 else if (level < 0 || level > Z_BEST_COMPRESSION)
1094 die(_("bad zlib compression level %d"), level);
1095 zlib_compression_level = level;
1096 zlib_compression_seen = 1;
1097 return 0;
1100 if (!strcmp(var, "core.compression")) {
1101 int level = git_config_int(var, value);
1102 if (level == -1)
1103 level = Z_DEFAULT_COMPRESSION;
1104 else if (level < 0 || level > Z_BEST_COMPRESSION)
1105 die(_("bad zlib compression level %d"), level);
1106 core_compression_level = level;
1107 core_compression_seen = 1;
1108 if (!zlib_compression_seen)
1109 zlib_compression_level = level;
1110 if (!pack_compression_seen)
1111 pack_compression_level = level;
1112 return 0;
1115 if (!strcmp(var, "core.packedgitwindowsize")) {
1116 int pgsz_x2 = getpagesize() * 2;
1117 packed_git_window_size = git_config_ulong(var, value);
1119 /* This value must be multiple of (pagesize * 2) */
1120 packed_git_window_size /= pgsz_x2;
1121 if (packed_git_window_size < 1)
1122 packed_git_window_size = 1;
1123 packed_git_window_size *= pgsz_x2;
1124 return 0;
1127 if (!strcmp(var, "core.bigfilethreshold")) {
1128 big_file_threshold = git_config_ulong(var, value);
1129 return 0;
1132 if (!strcmp(var, "core.packedgitlimit")) {
1133 packed_git_limit = git_config_ulong(var, value);
1134 return 0;
1137 if (!strcmp(var, "core.deltabasecachelimit")) {
1138 delta_base_cache_limit = git_config_ulong(var, value);
1139 return 0;
1142 if (!strcmp(var, "core.autocrlf")) {
1143 if (value && !strcasecmp(value, "input")) {
1144 auto_crlf = AUTO_CRLF_INPUT;
1145 return 0;
1147 auto_crlf = git_config_bool(var, value);
1148 return 0;
1151 if (!strcmp(var, "core.safecrlf")) {
1152 if (value && !strcasecmp(value, "warn")) {
1153 safe_crlf = SAFE_CRLF_WARN;
1154 return 0;
1156 safe_crlf = git_config_bool(var, value);
1157 return 0;
1160 if (!strcmp(var, "core.eol")) {
1161 if (value && !strcasecmp(value, "lf"))
1162 core_eol = EOL_LF;
1163 else if (value && !strcasecmp(value, "crlf"))
1164 core_eol = EOL_CRLF;
1165 else if (value && !strcasecmp(value, "native"))
1166 core_eol = EOL_NATIVE;
1167 else
1168 core_eol = EOL_UNSET;
1169 return 0;
1172 if (!strcmp(var, "core.notesref")) {
1173 notes_ref_name = xstrdup(value);
1174 return 0;
1177 if (!strcmp(var, "core.editor"))
1178 return git_config_string(&editor_program, var, value);
1180 if (!strcmp(var, "core.commentchar")) {
1181 if (!value)
1182 return config_error_nonbool(var);
1183 else if (!strcasecmp(value, "auto"))
1184 auto_comment_line_char = 1;
1185 else if (value[0] && !value[1]) {
1186 comment_line_char = value[0];
1187 auto_comment_line_char = 0;
1188 } else
1189 return error("core.commentChar should only be one character");
1190 return 0;
1193 if (!strcmp(var, "core.askpass"))
1194 return git_config_string(&askpass_program, var, value);
1196 if (!strcmp(var, "core.excludesfile"))
1197 return git_config_pathname(&excludes_file, var, value);
1199 if (!strcmp(var, "core.whitespace")) {
1200 if (!value)
1201 return config_error_nonbool(var);
1202 whitespace_rule_cfg = parse_whitespace_rule(value);
1203 return 0;
1206 if (!strcmp(var, "core.fsyncobjectfiles")) {
1207 fsync_object_files = git_config_bool(var, value);
1208 return 0;
1211 if (!strcmp(var, "core.preloadindex")) {
1212 core_preload_index = git_config_bool(var, value);
1213 return 0;
1216 if (!strcmp(var, "core.createobject")) {
1217 if (!strcmp(value, "rename"))
1218 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1219 else if (!strcmp(value, "link"))
1220 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1221 else
1222 die(_("invalid mode for object creation: %s"), value);
1223 return 0;
1226 if (!strcmp(var, "core.sparsecheckout")) {
1227 core_apply_sparse_checkout = git_config_bool(var, value);
1228 return 0;
1231 if (!strcmp(var, "core.precomposeunicode")) {
1232 precomposed_unicode = git_config_bool(var, value);
1233 return 0;
1236 if (!strcmp(var, "core.protecthfs")) {
1237 protect_hfs = git_config_bool(var, value);
1238 return 0;
1241 if (!strcmp(var, "core.protectntfs")) {
1242 protect_ntfs = git_config_bool(var, value);
1243 return 0;
1246 if (!strcmp(var, "core.hidedotfiles")) {
1247 if (value && !strcasecmp(value, "dotgitonly"))
1248 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1249 else
1250 hide_dotfiles = git_config_bool(var, value);
1251 return 0;
1254 /* Add other config variables here and to Documentation/config.txt. */
1255 return 0;
1258 static int git_default_i18n_config(const char *var, const char *value)
1260 if (!strcmp(var, "i18n.commitencoding"))
1261 return git_config_string(&git_commit_encoding, var, value);
1263 if (!strcmp(var, "i18n.logoutputencoding"))
1264 return git_config_string(&git_log_output_encoding, var, value);
1266 /* Add other config variables here and to Documentation/config.txt. */
1267 return 0;
1270 static int git_default_branch_config(const char *var, const char *value)
1272 if (!strcmp(var, "branch.autosetupmerge")) {
1273 if (value && !strcasecmp(value, "always")) {
1274 git_branch_track = BRANCH_TRACK_ALWAYS;
1275 return 0;
1277 git_branch_track = git_config_bool(var, value);
1278 return 0;
1280 if (!strcmp(var, "branch.autosetuprebase")) {
1281 if (!value)
1282 return config_error_nonbool(var);
1283 else if (!strcmp(value, "never"))
1284 autorebase = AUTOREBASE_NEVER;
1285 else if (!strcmp(value, "local"))
1286 autorebase = AUTOREBASE_LOCAL;
1287 else if (!strcmp(value, "remote"))
1288 autorebase = AUTOREBASE_REMOTE;
1289 else if (!strcmp(value, "always"))
1290 autorebase = AUTOREBASE_ALWAYS;
1291 else
1292 return error("malformed value for %s", var);
1293 return 0;
1296 /* Add other config variables here and to Documentation/config.txt. */
1297 return 0;
1300 static int git_default_push_config(const char *var, const char *value)
1302 if (!strcmp(var, "push.default")) {
1303 if (!value)
1304 return config_error_nonbool(var);
1305 else if (!strcmp(value, "nothing"))
1306 push_default = PUSH_DEFAULT_NOTHING;
1307 else if (!strcmp(value, "matching"))
1308 push_default = PUSH_DEFAULT_MATCHING;
1309 else if (!strcmp(value, "simple"))
1310 push_default = PUSH_DEFAULT_SIMPLE;
1311 else if (!strcmp(value, "upstream"))
1312 push_default = PUSH_DEFAULT_UPSTREAM;
1313 else if (!strcmp(value, "tracking")) /* deprecated */
1314 push_default = PUSH_DEFAULT_UPSTREAM;
1315 else if (!strcmp(value, "current"))
1316 push_default = PUSH_DEFAULT_CURRENT;
1317 else {
1318 error("malformed value for %s: %s", var, value);
1319 return error("Must be one of nothing, matching, simple, "
1320 "upstream or current.");
1322 return 0;
1325 /* Add other config variables here and to Documentation/config.txt. */
1326 return 0;
1329 static int git_default_mailmap_config(const char *var, const char *value)
1331 if (!strcmp(var, "mailmap.file"))
1332 return git_config_pathname(&git_mailmap_file, var, value);
1333 if (!strcmp(var, "mailmap.blob"))
1334 return git_config_string(&git_mailmap_blob, var, value);
1336 /* Add other config variables here and to Documentation/config.txt. */
1337 return 0;
1340 int git_default_config(const char *var, const char *value, void *dummy)
1342 if (starts_with(var, "core."))
1343 return git_default_core_config(var, value);
1345 if (starts_with(var, "user."))
1346 return git_ident_config(var, value, dummy);
1348 if (starts_with(var, "i18n."))
1349 return git_default_i18n_config(var, value);
1351 if (starts_with(var, "branch."))
1352 return git_default_branch_config(var, value);
1354 if (starts_with(var, "push."))
1355 return git_default_push_config(var, value);
1357 if (starts_with(var, "mailmap."))
1358 return git_default_mailmap_config(var, value);
1360 if (starts_with(var, "advice."))
1361 return git_default_advice_config(var, value);
1363 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1364 pager_use_color = git_config_bool(var,value);
1365 return 0;
1368 if (!strcmp(var, "pack.packsizelimit")) {
1369 pack_size_limit_cfg = git_config_ulong(var, value);
1370 return 0;
1373 if (!strcmp(var, "pack.compression")) {
1374 int level = git_config_int(var, value);
1375 if (level == -1)
1376 level = Z_DEFAULT_COMPRESSION;
1377 else if (level < 0 || level > Z_BEST_COMPRESSION)
1378 die(_("bad pack compression level %d"), level);
1379 pack_compression_level = level;
1380 pack_compression_seen = 1;
1381 return 0;
1384 /* Add other config variables here and to Documentation/config.txt. */
1385 return 0;
1389 * All source specific fields in the union, die_on_error, name and the callbacks
1390 * fgetc, ungetc, ftell of top need to be initialized before calling
1391 * this function.
1393 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1395 int ret;
1397 /* push config-file parsing state stack */
1398 top->prev = cf;
1399 top->linenr = 1;
1400 top->eof = 0;
1401 strbuf_init(&top->value, 1024);
1402 strbuf_init(&top->var, 1024);
1403 cf = top;
1405 ret = git_parse_source(fn, data);
1407 /* pop config-file parsing state stack */
1408 strbuf_release(&top->value);
1409 strbuf_release(&top->var);
1410 cf = top->prev;
1412 return ret;
1415 static int do_config_from_file(config_fn_t fn,
1416 const enum config_origin_type origin_type,
1417 const char *name, const char *path, FILE *f,
1418 void *data)
1420 struct config_source top;
1422 top.u.file = f;
1423 top.origin_type = origin_type;
1424 top.name = name;
1425 top.path = path;
1426 top.die_on_error = 1;
1427 top.do_fgetc = config_file_fgetc;
1428 top.do_ungetc = config_file_ungetc;
1429 top.do_ftell = config_file_ftell;
1431 return do_config_from(&top, fn, data);
1434 static int git_config_from_stdin(config_fn_t fn, void *data)
1436 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1439 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1441 int ret = -1;
1442 FILE *f;
1444 f = fopen_or_warn(filename, "r");
1445 if (f) {
1446 flockfile(f);
1447 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1448 funlockfile(f);
1449 fclose(f);
1451 return ret;
1454 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1455 const char *name, const char *buf, size_t len, void *data)
1457 struct config_source top;
1459 top.u.buf.buf = buf;
1460 top.u.buf.len = len;
1461 top.u.buf.pos = 0;
1462 top.origin_type = origin_type;
1463 top.name = name;
1464 top.path = NULL;
1465 top.die_on_error = 0;
1466 top.do_fgetc = config_buf_fgetc;
1467 top.do_ungetc = config_buf_ungetc;
1468 top.do_ftell = config_buf_ftell;
1470 return do_config_from(&top, fn, data);
1473 int git_config_from_blob_oid(config_fn_t fn,
1474 const char *name,
1475 const struct object_id *oid,
1476 void *data)
1478 enum object_type type;
1479 char *buf;
1480 unsigned long size;
1481 int ret;
1483 buf = read_sha1_file(oid->hash, &type, &size);
1484 if (!buf)
1485 return error("unable to load config blob object '%s'", name);
1486 if (type != OBJ_BLOB) {
1487 free(buf);
1488 return error("reference '%s' does not point to a blob", name);
1491 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1492 free(buf);
1494 return ret;
1497 static int git_config_from_blob_ref(config_fn_t fn,
1498 const char *name,
1499 void *data)
1501 struct object_id oid;
1503 if (get_oid(name, &oid) < 0)
1504 return error("unable to resolve config blob '%s'", name);
1505 return git_config_from_blob_oid(fn, name, &oid, data);
1508 const char *git_etc_gitconfig(void)
1510 static const char *system_wide;
1511 if (!system_wide)
1512 system_wide = system_path(ETC_GITCONFIG);
1513 return system_wide;
1517 * Parse environment variable 'k' as a boolean (in various
1518 * possible spellings); if missing, use the default value 'def'.
1520 int git_env_bool(const char *k, int def)
1522 const char *v = getenv(k);
1523 return v ? git_config_bool(k, v) : def;
1527 * Parse environment variable 'k' as ulong with possibly a unit
1528 * suffix; if missing, use the default value 'val'.
1530 unsigned long git_env_ulong(const char *k, unsigned long val)
1532 const char *v = getenv(k);
1533 if (v && !git_parse_ulong(v, &val))
1534 die("failed to parse %s", k);
1535 return val;
1538 int git_config_system(void)
1540 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1543 static int do_git_config_sequence(const struct config_options *opts,
1544 config_fn_t fn, void *data)
1546 int ret = 0;
1547 char *xdg_config = xdg_config_home("config");
1548 char *user_config = expand_user_path("~/.gitconfig", 0);
1549 char *repo_config;
1551 if (opts->commondir)
1552 repo_config = mkpathdup("%s/config", opts->commondir);
1553 else
1554 repo_config = NULL;
1556 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1557 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1558 ret += git_config_from_file(fn, git_etc_gitconfig(),
1559 data);
1561 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1562 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1563 ret += git_config_from_file(fn, xdg_config, data);
1565 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1566 ret += git_config_from_file(fn, user_config, data);
1568 current_parsing_scope = CONFIG_SCOPE_REPO;
1569 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1570 ret += git_config_from_file(fn, repo_config, data);
1572 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1573 if (git_config_from_parameters(fn, data) < 0)
1574 die(_("unable to parse command-line config"));
1576 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1577 free(xdg_config);
1578 free(user_config);
1579 free(repo_config);
1580 return ret;
1583 int config_with_options(config_fn_t fn, void *data,
1584 struct git_config_source *config_source,
1585 const struct config_options *opts)
1587 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1589 if (opts->respect_includes) {
1590 inc.fn = fn;
1591 inc.data = data;
1592 inc.opts = opts;
1593 fn = git_config_include;
1594 data = &inc;
1598 * If we have a specific filename, use it. Otherwise, follow the
1599 * regular lookup sequence.
1601 if (config_source && config_source->use_stdin)
1602 return git_config_from_stdin(fn, data);
1603 else if (config_source && config_source->file)
1604 return git_config_from_file(fn, config_source->file, data);
1605 else if (config_source && config_source->blob)
1606 return git_config_from_blob_ref(fn, config_source->blob, data);
1608 return do_git_config_sequence(opts, fn, data);
1611 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1613 int i, value_index;
1614 struct string_list *values;
1615 struct config_set_element *entry;
1616 struct configset_list *list = &cs->list;
1618 for (i = 0; i < list->nr; i++) {
1619 entry = list->items[i].e;
1620 value_index = list->items[i].value_index;
1621 values = &entry->value_list;
1623 current_config_kvi = values->items[value_index].util;
1625 if (fn(entry->key, values->items[value_index].string, data) < 0)
1626 git_die_config_linenr(entry->key,
1627 current_config_kvi->filename,
1628 current_config_kvi->linenr);
1630 current_config_kvi = NULL;
1634 void read_early_config(config_fn_t cb, void *data)
1636 struct config_options opts = {0};
1637 struct strbuf commondir = STRBUF_INIT;
1638 struct strbuf gitdir = STRBUF_INIT;
1640 opts.respect_includes = 1;
1642 if (have_git_dir()) {
1643 opts.commondir = get_git_common_dir();
1644 opts.git_dir = get_git_dir();
1646 * When setup_git_directory() was not yet asked to discover the
1647 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1648 * is any repository config we should use (but unlike
1649 * setup_git_directory_gently(), no global state is changed, most
1650 * notably, the current working directory is still the same after the
1651 * call).
1653 } else if (!discover_git_directory(&commondir, &gitdir)) {
1654 opts.commondir = commondir.buf;
1655 opts.git_dir = gitdir.buf;
1658 config_with_options(cb, data, NULL, &opts);
1660 strbuf_release(&commondir);
1661 strbuf_release(&gitdir);
1664 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1666 struct config_set_element k;
1667 struct config_set_element *found_entry;
1668 char *normalized_key;
1670 * `key` may come from the user, so normalize it before using it
1671 * for querying entries from the hashmap.
1673 if (git_config_parse_key(key, &normalized_key, NULL))
1674 return NULL;
1676 hashmap_entry_init(&k, strhash(normalized_key));
1677 k.key = normalized_key;
1678 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1679 free(normalized_key);
1680 return found_entry;
1683 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1685 struct config_set_element *e;
1686 struct string_list_item *si;
1687 struct configset_list_item *l_item;
1688 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1690 e = configset_find_element(cs, key);
1692 * Since the keys are being fed by git_config*() callback mechanism, they
1693 * are already normalized. So simply add them without any further munging.
1695 if (!e) {
1696 e = xmalloc(sizeof(*e));
1697 hashmap_entry_init(e, strhash(key));
1698 e->key = xstrdup(key);
1699 string_list_init(&e->value_list, 1);
1700 hashmap_add(&cs->config_hash, e);
1702 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1704 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1705 l_item = &cs->list.items[cs->list.nr++];
1706 l_item->e = e;
1707 l_item->value_index = e->value_list.nr - 1;
1709 if (!cf)
1710 die("BUG: configset_add_value has no source");
1711 if (cf->name) {
1712 kv_info->filename = strintern(cf->name);
1713 kv_info->linenr = cf->linenr;
1714 kv_info->origin_type = cf->origin_type;
1715 } else {
1716 /* for values read from `git_config_from_parameters()` */
1717 kv_info->filename = NULL;
1718 kv_info->linenr = -1;
1719 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1721 kv_info->scope = current_parsing_scope;
1722 si->util = kv_info;
1724 return 0;
1727 static int config_set_element_cmp(const void *unused_cmp_data,
1728 const void *entry,
1729 const void *entry_or_key,
1730 const void *unused_keydata)
1732 const struct config_set_element *e1 = entry;
1733 const struct config_set_element *e2 = entry_or_key;
1735 return strcmp(e1->key, e2->key);
1738 void git_configset_init(struct config_set *cs)
1740 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1741 cs->hash_initialized = 1;
1742 cs->list.nr = 0;
1743 cs->list.alloc = 0;
1744 cs->list.items = NULL;
1747 void git_configset_clear(struct config_set *cs)
1749 struct config_set_element *entry;
1750 struct hashmap_iter iter;
1751 if (!cs->hash_initialized)
1752 return;
1754 hashmap_iter_init(&cs->config_hash, &iter);
1755 while ((entry = hashmap_iter_next(&iter))) {
1756 free(entry->key);
1757 string_list_clear(&entry->value_list, 1);
1759 hashmap_free(&cs->config_hash, 1);
1760 cs->hash_initialized = 0;
1761 free(cs->list.items);
1762 cs->list.nr = 0;
1763 cs->list.alloc = 0;
1764 cs->list.items = NULL;
1767 static int config_set_callback(const char *key, const char *value, void *cb)
1769 struct config_set *cs = cb;
1770 configset_add_value(cs, key, value);
1771 return 0;
1774 int git_configset_add_file(struct config_set *cs, const char *filename)
1776 return git_config_from_file(config_set_callback, filename, cs);
1779 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1781 const struct string_list *values = NULL;
1783 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1784 * queried key in the files of the configset, the value returned will be the last
1785 * value in the value list for that key.
1787 values = git_configset_get_value_multi(cs, key);
1789 if (!values)
1790 return 1;
1791 assert(values->nr > 0);
1792 *value = values->items[values->nr - 1].string;
1793 return 0;
1796 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1798 struct config_set_element *e = configset_find_element(cs, key);
1799 return e ? &e->value_list : NULL;
1802 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1804 const char *value;
1805 if (!git_configset_get_value(cs, key, &value))
1806 return git_config_string(dest, key, value);
1807 else
1808 return 1;
1811 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1813 return git_configset_get_string_const(cs, key, (const char **)dest);
1816 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1818 const char *value;
1819 if (!git_configset_get_value(cs, key, &value)) {
1820 *dest = git_config_int(key, value);
1821 return 0;
1822 } else
1823 return 1;
1826 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1828 const char *value;
1829 if (!git_configset_get_value(cs, key, &value)) {
1830 *dest = git_config_ulong(key, value);
1831 return 0;
1832 } else
1833 return 1;
1836 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1838 const char *value;
1839 if (!git_configset_get_value(cs, key, &value)) {
1840 *dest = git_config_bool(key, value);
1841 return 0;
1842 } else
1843 return 1;
1846 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1847 int *is_bool, int *dest)
1849 const char *value;
1850 if (!git_configset_get_value(cs, key, &value)) {
1851 *dest = git_config_bool_or_int(key, value, is_bool);
1852 return 0;
1853 } else
1854 return 1;
1857 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1859 const char *value;
1860 if (!git_configset_get_value(cs, key, &value)) {
1861 *dest = git_parse_maybe_bool(value);
1862 if (*dest == -1)
1863 return -1;
1864 return 0;
1865 } else
1866 return 1;
1869 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1871 const char *value;
1872 if (!git_configset_get_value(cs, key, &value))
1873 return git_config_pathname(dest, key, value);
1874 else
1875 return 1;
1878 /* Functions use to read configuration from a repository */
1879 static void repo_read_config(struct repository *repo)
1881 struct config_options opts;
1883 opts.respect_includes = 1;
1884 opts.commondir = repo->commondir;
1885 opts.git_dir = repo->gitdir;
1887 if (!repo->config)
1888 repo->config = xcalloc(1, sizeof(struct config_set));
1889 else
1890 git_configset_clear(repo->config);
1892 git_configset_init(repo->config);
1894 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
1896 * config_with_options() normally returns only
1897 * zero, as most errors are fatal, and
1898 * non-fatal potential errors are guarded by "if"
1899 * statements that are entered only when no error is
1900 * possible.
1902 * If we ever encounter a non-fatal error, it means
1903 * something went really wrong and we should stop
1904 * immediately.
1906 die(_("unknown error occurred while reading the configuration files"));
1909 static void git_config_check_init(struct repository *repo)
1911 if (repo->config && repo->config->hash_initialized)
1912 return;
1913 repo_read_config(repo);
1916 static void repo_config_clear(struct repository *repo)
1918 if (!repo->config || !repo->config->hash_initialized)
1919 return;
1920 git_configset_clear(repo->config);
1923 void repo_config(struct repository *repo, config_fn_t fn, void *data)
1925 git_config_check_init(repo);
1926 configset_iter(repo->config, fn, data);
1929 int repo_config_get_value(struct repository *repo,
1930 const char *key, const char **value)
1932 git_config_check_init(repo);
1933 return git_configset_get_value(repo->config, key, value);
1936 const struct string_list *repo_config_get_value_multi(struct repository *repo,
1937 const char *key)
1939 git_config_check_init(repo);
1940 return git_configset_get_value_multi(repo->config, key);
1943 int repo_config_get_string_const(struct repository *repo,
1944 const char *key, const char **dest)
1946 int ret;
1947 git_config_check_init(repo);
1948 ret = git_configset_get_string_const(repo->config, key, dest);
1949 if (ret < 0)
1950 git_die_config(key, NULL);
1951 return ret;
1954 int repo_config_get_string(struct repository *repo,
1955 const char *key, char **dest)
1957 git_config_check_init(repo);
1958 return repo_config_get_string_const(repo, key, (const char **)dest);
1961 int repo_config_get_int(struct repository *repo,
1962 const char *key, int *dest)
1964 git_config_check_init(repo);
1965 return git_configset_get_int(repo->config, key, dest);
1968 int repo_config_get_ulong(struct repository *repo,
1969 const char *key, unsigned long *dest)
1971 git_config_check_init(repo);
1972 return git_configset_get_ulong(repo->config, key, dest);
1975 int repo_config_get_bool(struct repository *repo,
1976 const char *key, int *dest)
1978 git_config_check_init(repo);
1979 return git_configset_get_bool(repo->config, key, dest);
1982 int repo_config_get_bool_or_int(struct repository *repo,
1983 const char *key, int *is_bool, int *dest)
1985 git_config_check_init(repo);
1986 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
1989 int repo_config_get_maybe_bool(struct repository *repo,
1990 const char *key, int *dest)
1992 git_config_check_init(repo);
1993 return git_configset_get_maybe_bool(repo->config, key, dest);
1996 int repo_config_get_pathname(struct repository *repo,
1997 const char *key, const char **dest)
1999 int ret;
2000 git_config_check_init(repo);
2001 ret = git_configset_get_pathname(repo->config, key, dest);
2002 if (ret < 0)
2003 git_die_config(key, NULL);
2004 return ret;
2007 /* Functions used historically to read configuration from 'the_repository' */
2008 void git_config(config_fn_t fn, void *data)
2010 repo_config(the_repository, fn, data);
2013 void git_config_clear(void)
2015 repo_config_clear(the_repository);
2018 int git_config_get_value(const char *key, const char **value)
2020 return repo_config_get_value(the_repository, key, value);
2023 const struct string_list *git_config_get_value_multi(const char *key)
2025 return repo_config_get_value_multi(the_repository, key);
2028 int git_config_get_string_const(const char *key, const char **dest)
2030 return repo_config_get_string_const(the_repository, key, dest);
2033 int git_config_get_string(const char *key, char **dest)
2035 return repo_config_get_string(the_repository, key, dest);
2038 int git_config_get_int(const char *key, int *dest)
2040 return repo_config_get_int(the_repository, key, dest);
2043 int git_config_get_ulong(const char *key, unsigned long *dest)
2045 return repo_config_get_ulong(the_repository, key, dest);
2048 int git_config_get_bool(const char *key, int *dest)
2050 return repo_config_get_bool(the_repository, key, dest);
2053 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2055 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2058 int git_config_get_maybe_bool(const char *key, int *dest)
2060 return repo_config_get_maybe_bool(the_repository, key, dest);
2063 int git_config_get_pathname(const char *key, const char **dest)
2065 return repo_config_get_pathname(the_repository, key, dest);
2069 * Note: This function exists solely to maintain backward compatibility with
2070 * 'fetch' and 'update_clone' storing configuration in '.gitmodules' and should
2071 * NOT be used anywhere else.
2073 * Runs the provided config function on the '.gitmodules' file found in the
2074 * working directory.
2076 void config_from_gitmodules(config_fn_t fn, void *data)
2078 if (the_repository->worktree) {
2079 char *file = repo_worktree_path(the_repository, GITMODULES_FILE);
2080 git_config_from_file(fn, file, data);
2081 free(file);
2085 int git_config_get_expiry(const char *key, const char **output)
2087 int ret = git_config_get_string_const(key, output);
2088 if (ret)
2089 return ret;
2090 if (strcmp(*output, "now")) {
2091 timestamp_t now = approxidate("now");
2092 if (approxidate(*output) >= now)
2093 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2095 return ret;
2098 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2100 char *expiry_string;
2101 intmax_t days;
2102 timestamp_t when;
2104 if (git_config_get_string(key, &expiry_string))
2105 return 1; /* no such thing */
2107 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2108 const int scale = 86400;
2109 *expiry = now - days * scale;
2110 return 0;
2113 if (!parse_expiry_date(expiry_string, &when)) {
2114 *expiry = when;
2115 return 0;
2117 return -1; /* thing exists but cannot be parsed */
2120 int git_config_get_untracked_cache(void)
2122 int val = -1;
2123 const char *v;
2125 /* Hack for test programs like test-dump-untracked-cache */
2126 if (ignore_untracked_cache_config)
2127 return -1;
2129 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2130 return val;
2132 if (!git_config_get_value("core.untrackedcache", &v)) {
2133 if (!strcasecmp(v, "keep"))
2134 return -1;
2136 error(_("unknown core.untrackedCache value '%s'; "
2137 "using 'keep' default value"), v);
2138 return -1;
2141 return -1; /* default value */
2144 int git_config_get_split_index(void)
2146 int val;
2148 if (!git_config_get_maybe_bool("core.splitindex", &val))
2149 return val;
2151 return -1; /* default value */
2154 int git_config_get_max_percent_split_change(void)
2156 int val = -1;
2158 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2159 if (0 <= val && val <= 100)
2160 return val;
2162 return error(_("splitIndex.maxPercentChange value '%d' "
2163 "should be between 0 and 100"), val);
2166 return -1; /* default value */
2169 int git_config_get_fsmonitor(void)
2171 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2172 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2174 if (core_fsmonitor && !*core_fsmonitor)
2175 core_fsmonitor = NULL;
2177 if (core_fsmonitor)
2178 return 1;
2180 return 0;
2183 NORETURN
2184 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2186 if (!filename)
2187 die(_("unable to parse '%s' from command-line config"), key);
2188 else
2189 die(_("bad config variable '%s' in file '%s' at line %d"),
2190 key, filename, linenr);
2193 NORETURN __attribute__((format(printf, 2, 3)))
2194 void git_die_config(const char *key, const char *err, ...)
2196 const struct string_list *values;
2197 struct key_value_info *kv_info;
2199 if (err) {
2200 va_list params;
2201 va_start(params, err);
2202 vreportf("error: ", err, params);
2203 va_end(params);
2205 values = git_config_get_value_multi(key);
2206 kv_info = values->items[values->nr - 1].util;
2207 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2211 * Find all the stuff for git_config_set() below.
2214 static struct {
2215 int baselen;
2216 char *key;
2217 int do_not_match;
2218 regex_t *value_regex;
2219 int multi_replace;
2220 size_t *offset;
2221 unsigned int offset_alloc;
2222 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2223 unsigned int seen;
2224 } store;
2226 static int matches(const char *key, const char *value)
2228 if (strcmp(key, store.key))
2229 return 0; /* not ours */
2230 if (!store.value_regex)
2231 return 1; /* always matches */
2232 if (store.value_regex == CONFIG_REGEX_NONE)
2233 return 0; /* never matches */
2235 return store.do_not_match ^
2236 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2239 static int store_aux(const char *key, const char *value, void *cb)
2241 const char *ep;
2242 size_t section_len;
2244 switch (store.state) {
2245 case KEY_SEEN:
2246 if (matches(key, value)) {
2247 if (store.seen == 1 && store.multi_replace == 0) {
2248 warning(_("%s has multiple values"), key);
2251 ALLOC_GROW(store.offset, store.seen + 1,
2252 store.offset_alloc);
2254 store.offset[store.seen] = cf->do_ftell(cf);
2255 store.seen++;
2257 break;
2258 case SECTION_SEEN:
2260 * What we are looking for is in store.key (both
2261 * section and var), and its section part is baselen
2262 * long. We found key (again, both section and var).
2263 * We would want to know if this key is in the same
2264 * section as what we are looking for. We already
2265 * know we are in the same section as what should
2266 * hold store.key.
2268 ep = strrchr(key, '.');
2269 section_len = ep - key;
2271 if ((section_len != store.baselen) ||
2272 memcmp(key, store.key, section_len+1)) {
2273 store.state = SECTION_END_SEEN;
2274 break;
2278 * Do not increment matches: this is no match, but we
2279 * just made sure we are in the desired section.
2281 ALLOC_GROW(store.offset, store.seen + 1,
2282 store.offset_alloc);
2283 store.offset[store.seen] = cf->do_ftell(cf);
2284 /* fallthru */
2285 case SECTION_END_SEEN:
2286 case START:
2287 if (matches(key, value)) {
2288 ALLOC_GROW(store.offset, store.seen + 1,
2289 store.offset_alloc);
2290 store.offset[store.seen] = cf->do_ftell(cf);
2291 store.state = KEY_SEEN;
2292 store.seen++;
2293 } else {
2294 if (strrchr(key, '.') - key == store.baselen &&
2295 !strncmp(key, store.key, store.baselen)) {
2296 store.state = SECTION_SEEN;
2297 ALLOC_GROW(store.offset,
2298 store.seen + 1,
2299 store.offset_alloc);
2300 store.offset[store.seen] = cf->do_ftell(cf);
2304 return 0;
2307 static int write_error(const char *filename)
2309 error("failed to write new configuration file %s", filename);
2311 /* Same error code as "failed to rename". */
2312 return 4;
2315 static struct strbuf store_create_section(const char *key)
2317 const char *dot;
2318 int i;
2319 struct strbuf sb = STRBUF_INIT;
2321 dot = memchr(key, '.', store.baselen);
2322 if (dot) {
2323 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2324 for (i = dot - key + 1; i < store.baselen; i++) {
2325 if (key[i] == '"' || key[i] == '\\')
2326 strbuf_addch(&sb, '\\');
2327 strbuf_addch(&sb, key[i]);
2329 strbuf_addstr(&sb, "\"]\n");
2330 } else {
2331 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2334 return sb;
2337 static ssize_t write_section(int fd, const char *key)
2339 struct strbuf sb = store_create_section(key);
2340 ssize_t ret;
2342 ret = write_in_full(fd, sb.buf, sb.len);
2343 strbuf_release(&sb);
2345 return ret;
2348 static ssize_t write_pair(int fd, const char *key, const char *value)
2350 int i;
2351 ssize_t ret;
2352 int length = strlen(key + store.baselen + 1);
2353 const char *quote = "";
2354 struct strbuf sb = STRBUF_INIT;
2357 * Check to see if the value needs to be surrounded with a dq pair.
2358 * Note that problematic characters are always backslash-quoted; this
2359 * check is about not losing leading or trailing SP and strings that
2360 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2361 * configuration parser.
2363 if (value[0] == ' ')
2364 quote = "\"";
2365 for (i = 0; value[i]; i++)
2366 if (value[i] == ';' || value[i] == '#')
2367 quote = "\"";
2368 if (i && value[i - 1] == ' ')
2369 quote = "\"";
2371 strbuf_addf(&sb, "\t%.*s = %s",
2372 length, key + store.baselen + 1, quote);
2374 for (i = 0; value[i]; i++)
2375 switch (value[i]) {
2376 case '\n':
2377 strbuf_addstr(&sb, "\\n");
2378 break;
2379 case '\t':
2380 strbuf_addstr(&sb, "\\t");
2381 break;
2382 case '"':
2383 case '\\':
2384 strbuf_addch(&sb, '\\');
2385 /* fallthrough */
2386 default:
2387 strbuf_addch(&sb, value[i]);
2388 break;
2390 strbuf_addf(&sb, "%s\n", quote);
2392 ret = write_in_full(fd, sb.buf, sb.len);
2393 strbuf_release(&sb);
2395 return ret;
2398 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2399 size_t offset_, int *found_bracket)
2401 size_t equal_offset = size, bracket_offset = size;
2402 ssize_t offset;
2404 contline:
2405 for (offset = offset_-2; offset > 0
2406 && contents[offset] != '\n'; offset--)
2407 switch (contents[offset]) {
2408 case '=': equal_offset = offset; break;
2409 case ']': bracket_offset = offset; break;
2411 if (offset > 0 && contents[offset-1] == '\\') {
2412 offset_ = offset;
2413 goto contline;
2415 if (bracket_offset < equal_offset) {
2416 *found_bracket = 1;
2417 offset = bracket_offset+1;
2418 } else
2419 offset++;
2421 return offset;
2424 int git_config_set_in_file_gently(const char *config_filename,
2425 const char *key, const char *value)
2427 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2430 void git_config_set_in_file(const char *config_filename,
2431 const char *key, const char *value)
2433 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2436 int git_config_set_gently(const char *key, const char *value)
2438 return git_config_set_multivar_gently(key, value, NULL, 0);
2441 void git_config_set(const char *key, const char *value)
2443 git_config_set_multivar(key, value, NULL, 0);
2447 * If value==NULL, unset in (remove from) config,
2448 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2449 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2450 * (only add a new one)
2451 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2452 * else all matching key/values (regardless how many) are removed,
2453 * before the new pair is written.
2455 * Returns 0 on success.
2457 * This function does this:
2459 * - it locks the config file by creating ".git/config.lock"
2461 * - it then parses the config using store_aux() as validator to find
2462 * the position on the key/value pair to replace. If it is to be unset,
2463 * it must be found exactly once.
2465 * - the config file is mmap()ed and the part before the match (if any) is
2466 * written to the lock file, then the changed part and the rest.
2468 * - the config file is removed and the lock file rename()d to it.
2471 int git_config_set_multivar_in_file_gently(const char *config_filename,
2472 const char *key, const char *value,
2473 const char *value_regex,
2474 int multi_replace)
2476 int fd = -1, in_fd = -1;
2477 int ret;
2478 struct lock_file lock = LOCK_INIT;
2479 char *filename_buf = NULL;
2480 char *contents = NULL;
2481 size_t contents_sz;
2483 /* parse-key returns negative; flip the sign to feed exit(3) */
2484 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2485 if (ret)
2486 goto out_free;
2488 store.multi_replace = multi_replace;
2490 if (!config_filename)
2491 config_filename = filename_buf = git_pathdup("config");
2494 * The lock serves a purpose in addition to locking: the new
2495 * contents of .git/config will be written into it.
2497 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2498 if (fd < 0) {
2499 error_errno("could not lock config file %s", config_filename);
2500 free(store.key);
2501 ret = CONFIG_NO_LOCK;
2502 goto out_free;
2506 * If .git/config does not exist yet, write a minimal version.
2508 in_fd = open(config_filename, O_RDONLY);
2509 if ( in_fd < 0 ) {
2510 free(store.key);
2512 if ( ENOENT != errno ) {
2513 error_errno("opening %s", config_filename);
2514 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2515 goto out_free;
2517 /* if nothing to unset, error out */
2518 if (value == NULL) {
2519 ret = CONFIG_NOTHING_SET;
2520 goto out_free;
2523 store.key = (char *)key;
2524 if (write_section(fd, key) < 0 ||
2525 write_pair(fd, key, value) < 0)
2526 goto write_err_out;
2527 } else {
2528 struct stat st;
2529 size_t copy_begin, copy_end;
2530 int i, new_line = 0;
2532 if (value_regex == NULL)
2533 store.value_regex = NULL;
2534 else if (value_regex == CONFIG_REGEX_NONE)
2535 store.value_regex = CONFIG_REGEX_NONE;
2536 else {
2537 if (value_regex[0] == '!') {
2538 store.do_not_match = 1;
2539 value_regex++;
2540 } else
2541 store.do_not_match = 0;
2543 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2544 if (regcomp(store.value_regex, value_regex,
2545 REG_EXTENDED)) {
2546 error("invalid pattern: %s", value_regex);
2547 free(store.value_regex);
2548 ret = CONFIG_INVALID_PATTERN;
2549 goto out_free;
2553 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2554 store.offset[0] = 0;
2555 store.state = START;
2556 store.seen = 0;
2559 * After this, store.offset will contain the *end* offset
2560 * of the last match, or remain at 0 if no match was found.
2561 * As a side effect, we make sure to transform only a valid
2562 * existing config file.
2564 if (git_config_from_file(store_aux, config_filename, NULL)) {
2565 error("invalid config file %s", config_filename);
2566 free(store.key);
2567 if (store.value_regex != NULL &&
2568 store.value_regex != CONFIG_REGEX_NONE) {
2569 regfree(store.value_regex);
2570 free(store.value_regex);
2572 ret = CONFIG_INVALID_FILE;
2573 goto out_free;
2576 free(store.key);
2577 if (store.value_regex != NULL &&
2578 store.value_regex != CONFIG_REGEX_NONE) {
2579 regfree(store.value_regex);
2580 free(store.value_regex);
2583 /* if nothing to unset, or too many matches, error out */
2584 if ((store.seen == 0 && value == NULL) ||
2585 (store.seen > 1 && multi_replace == 0)) {
2586 ret = CONFIG_NOTHING_SET;
2587 goto out_free;
2590 if (fstat(in_fd, &st) == -1) {
2591 error_errno(_("fstat on %s failed"), config_filename);
2592 ret = CONFIG_INVALID_FILE;
2593 goto out_free;
2596 contents_sz = xsize_t(st.st_size);
2597 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2598 MAP_PRIVATE, in_fd, 0);
2599 if (contents == MAP_FAILED) {
2600 if (errno == ENODEV && S_ISDIR(st.st_mode))
2601 errno = EISDIR;
2602 error_errno("unable to mmap '%s'", config_filename);
2603 ret = CONFIG_INVALID_FILE;
2604 contents = NULL;
2605 goto out_free;
2607 close(in_fd);
2608 in_fd = -1;
2610 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2611 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2612 ret = CONFIG_NO_WRITE;
2613 goto out_free;
2616 if (store.seen == 0)
2617 store.seen = 1;
2619 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2620 if (store.offset[i] == 0) {
2621 store.offset[i] = copy_end = contents_sz;
2622 } else if (store.state != KEY_SEEN) {
2623 copy_end = store.offset[i];
2624 } else
2625 copy_end = find_beginning_of_line(
2626 contents, contents_sz,
2627 store.offset[i]-2, &new_line);
2629 if (copy_end > 0 && contents[copy_end-1] != '\n')
2630 new_line = 1;
2632 /* write the first part of the config */
2633 if (copy_end > copy_begin) {
2634 if (write_in_full(fd, contents + copy_begin,
2635 copy_end - copy_begin) < 0)
2636 goto write_err_out;
2637 if (new_line &&
2638 write_str_in_full(fd, "\n") < 0)
2639 goto write_err_out;
2641 copy_begin = store.offset[i];
2644 /* write the pair (value == NULL means unset) */
2645 if (value != NULL) {
2646 if (store.state == START) {
2647 if (write_section(fd, key) < 0)
2648 goto write_err_out;
2650 if (write_pair(fd, key, value) < 0)
2651 goto write_err_out;
2654 /* write the rest of the config */
2655 if (copy_begin < contents_sz)
2656 if (write_in_full(fd, contents + copy_begin,
2657 contents_sz - copy_begin) < 0)
2658 goto write_err_out;
2660 munmap(contents, contents_sz);
2661 contents = NULL;
2664 if (commit_lock_file(&lock) < 0) {
2665 error_errno("could not write config file %s", config_filename);
2666 ret = CONFIG_NO_WRITE;
2667 goto out_free;
2670 ret = 0;
2672 /* Invalidate the config cache */
2673 git_config_clear();
2675 out_free:
2676 rollback_lock_file(&lock);
2677 free(filename_buf);
2678 if (contents)
2679 munmap(contents, contents_sz);
2680 if (in_fd >= 0)
2681 close(in_fd);
2682 return ret;
2684 write_err_out:
2685 ret = write_error(get_lock_file_path(&lock));
2686 goto out_free;
2690 void git_config_set_multivar_in_file(const char *config_filename,
2691 const char *key, const char *value,
2692 const char *value_regex, int multi_replace)
2694 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2695 value_regex, multi_replace))
2696 return;
2697 if (value)
2698 die(_("could not set '%s' to '%s'"), key, value);
2699 else
2700 die(_("could not unset '%s'"), key);
2703 int git_config_set_multivar_gently(const char *key, const char *value,
2704 const char *value_regex, int multi_replace)
2706 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2707 multi_replace);
2710 void git_config_set_multivar(const char *key, const char *value,
2711 const char *value_regex, int multi_replace)
2713 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2714 multi_replace);
2717 static int section_name_match (const char *buf, const char *name)
2719 int i = 0, j = 0, dot = 0;
2720 if (buf[i] != '[')
2721 return 0;
2722 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2723 if (!dot && isspace(buf[i])) {
2724 dot = 1;
2725 if (name[j++] != '.')
2726 break;
2727 for (i++; isspace(buf[i]); i++)
2728 ; /* do nothing */
2729 if (buf[i] != '"')
2730 break;
2731 continue;
2733 if (buf[i] == '\\' && dot)
2734 i++;
2735 else if (buf[i] == '"' && dot) {
2736 for (i++; isspace(buf[i]); i++)
2737 ; /* do_nothing */
2738 break;
2740 if (buf[i] != name[j++])
2741 break;
2743 if (buf[i] == ']' && name[j] == 0) {
2745 * We match, now just find the right length offset by
2746 * gobbling up any whitespace after it, as well
2748 i++;
2749 for (; buf[i] && isspace(buf[i]); i++)
2750 ; /* do nothing */
2751 return i;
2753 return 0;
2756 static int section_name_is_ok(const char *name)
2758 /* Empty section names are bogus. */
2759 if (!*name)
2760 return 0;
2763 * Before a dot, we must be alphanumeric or dash. After the first dot,
2764 * anything goes, so we can stop checking.
2766 for (; *name && *name != '.'; name++)
2767 if (*name != '-' && !isalnum(*name))
2768 return 0;
2769 return 1;
2772 /* if new_name == NULL, the section is removed instead */
2773 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
2774 const char *old_name, const char *new_name, int copy)
2776 int ret = 0, remove = 0;
2777 char *filename_buf = NULL;
2778 struct lock_file lock = LOCK_INIT;
2779 int out_fd;
2780 char buf[1024];
2781 FILE *config_file = NULL;
2782 struct stat st;
2783 struct strbuf copystr = STRBUF_INIT;
2785 if (new_name && !section_name_is_ok(new_name)) {
2786 ret = error("invalid section name: %s", new_name);
2787 goto out_no_rollback;
2790 if (!config_filename)
2791 config_filename = filename_buf = git_pathdup("config");
2793 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
2794 if (out_fd < 0) {
2795 ret = error("could not lock config file %s", config_filename);
2796 goto out;
2799 if (!(config_file = fopen(config_filename, "rb"))) {
2800 ret = warn_on_fopen_errors(config_filename);
2801 if (ret)
2802 goto out;
2803 /* no config file means nothing to rename, no error */
2804 goto commit_and_out;
2807 if (fstat(fileno(config_file), &st) == -1) {
2808 ret = error_errno(_("fstat on %s failed"), config_filename);
2809 goto out;
2812 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2813 ret = error_errno("chmod on %s failed",
2814 get_lock_file_path(&lock));
2815 goto out;
2818 while (fgets(buf, sizeof(buf), config_file)) {
2819 int i;
2820 int length;
2821 int is_section = 0;
2822 char *output = buf;
2823 for (i = 0; buf[i] && isspace(buf[i]); i++)
2824 ; /* do nothing */
2825 if (buf[i] == '[') {
2826 /* it's a section */
2827 int offset;
2828 is_section = 1;
2831 * When encountering a new section under -c we
2832 * need to flush out any section we're already
2833 * coping and begin anew. There might be
2834 * multiple [branch "$name"] sections.
2836 if (copystr.len > 0) {
2837 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
2838 ret = write_error(get_lock_file_path(&lock));
2839 goto out;
2841 strbuf_reset(&copystr);
2844 offset = section_name_match(&buf[i], old_name);
2845 if (offset > 0) {
2846 ret++;
2847 if (new_name == NULL) {
2848 remove = 1;
2849 continue;
2851 store.baselen = strlen(new_name);
2852 if (!copy) {
2853 if (write_section(out_fd, new_name) < 0) {
2854 ret = write_error(get_lock_file_path(&lock));
2855 goto out;
2858 * We wrote out the new section, with
2859 * a newline, now skip the old
2860 * section's length
2862 output += offset + i;
2863 if (strlen(output) > 0) {
2865 * More content means there's
2866 * a declaration to put on the
2867 * next line; indent with a
2868 * tab
2870 output -= 1;
2871 output[0] = '\t';
2873 } else {
2874 copystr = store_create_section(new_name);
2877 remove = 0;
2879 if (remove)
2880 continue;
2881 length = strlen(output);
2883 if (!is_section && copystr.len > 0) {
2884 strbuf_add(&copystr, output, length);
2887 if (write_in_full(out_fd, output, length) < 0) {
2888 ret = write_error(get_lock_file_path(&lock));
2889 goto out;
2894 * Copy a trailing section at the end of the config, won't be
2895 * flushed by the usual "flush because we have a new section
2896 * logic in the loop above.
2898 if (copystr.len > 0) {
2899 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
2900 ret = write_error(get_lock_file_path(&lock));
2901 goto out;
2903 strbuf_reset(&copystr);
2906 fclose(config_file);
2907 config_file = NULL;
2908 commit_and_out:
2909 if (commit_lock_file(&lock) < 0)
2910 ret = error_errno("could not write config file %s",
2911 config_filename);
2912 out:
2913 if (config_file)
2914 fclose(config_file);
2915 rollback_lock_file(&lock);
2916 out_no_rollback:
2917 free(filename_buf);
2918 return ret;
2921 int git_config_rename_section_in_file(const char *config_filename,
2922 const char *old_name, const char *new_name)
2924 return git_config_copy_or_rename_section_in_file(config_filename,
2925 old_name, new_name, 0);
2928 int git_config_rename_section(const char *old_name, const char *new_name)
2930 return git_config_rename_section_in_file(NULL, old_name, new_name);
2933 int git_config_copy_section_in_file(const char *config_filename,
2934 const char *old_name, const char *new_name)
2936 return git_config_copy_or_rename_section_in_file(config_filename,
2937 old_name, new_name, 1);
2940 int git_config_copy_section(const char *old_name, const char *new_name)
2942 return git_config_copy_section_in_file(NULL, old_name, new_name);
2946 * Call this to report error for your variable that should not
2947 * get a boolean value (i.e. "[my] var" means "true").
2949 #undef config_error_nonbool
2950 int config_error_nonbool(const char *var)
2952 return error("missing value for '%s'", var);
2955 int parse_config_key(const char *var,
2956 const char *section,
2957 const char **subsection, int *subsection_len,
2958 const char **key)
2960 const char *dot;
2962 /* Does it start with "section." ? */
2963 if (!skip_prefix(var, section, &var) || *var != '.')
2964 return -1;
2967 * Find the key; we don't know yet if we have a subsection, but we must
2968 * parse backwards from the end, since the subsection may have dots in
2969 * it, too.
2971 dot = strrchr(var, '.');
2972 *key = dot + 1;
2974 /* Did we have a subsection at all? */
2975 if (dot == var) {
2976 if (subsection) {
2977 *subsection = NULL;
2978 *subsection_len = 0;
2981 else {
2982 if (!subsection)
2983 return -1;
2984 *subsection = var + 1;
2985 *subsection_len = dot - *subsection;
2988 return 0;
2991 const char *current_config_origin_type(void)
2993 int type;
2994 if (current_config_kvi)
2995 type = current_config_kvi->origin_type;
2996 else if(cf)
2997 type = cf->origin_type;
2998 else
2999 die("BUG: current_config_origin_type called outside config callback");
3001 switch (type) {
3002 case CONFIG_ORIGIN_BLOB:
3003 return "blob";
3004 case CONFIG_ORIGIN_FILE:
3005 return "file";
3006 case CONFIG_ORIGIN_STDIN:
3007 return "standard input";
3008 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3009 return "submodule-blob";
3010 case CONFIG_ORIGIN_CMDLINE:
3011 return "command line";
3012 default:
3013 die("BUG: unknown config origin type");
3017 const char *current_config_name(void)
3019 const char *name;
3020 if (current_config_kvi)
3021 name = current_config_kvi->filename;
3022 else if (cf)
3023 name = cf->name;
3024 else
3025 die("BUG: current_config_name called outside config callback");
3026 return name ? name : "";
3029 enum config_scope current_config_scope(void)
3031 if (current_config_kvi)
3032 return current_config_kvi->scope;
3033 else
3034 return current_parsing_scope;