builtin/config: work around an unsized array forward declaration
[alt-git.git] / config.c
blob33366b52c7c81a3809cfc57212fbcb8ca205b88d
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"
19 #include "color.h"
21 struct config_source {
22 struct config_source *prev;
23 union {
24 FILE *file;
25 struct config_buf {
26 const char *buf;
27 size_t len;
28 size_t pos;
29 } buf;
30 } u;
31 enum config_origin_type origin_type;
32 const char *name;
33 const char *path;
34 int die_on_error;
35 int linenr;
36 int eof;
37 struct strbuf value;
38 struct strbuf var;
40 int (*do_fgetc)(struct config_source *c);
41 int (*do_ungetc)(int c, struct config_source *conf);
42 long (*do_ftell)(struct config_source *c);
46 * These variables record the "current" config source, which
47 * can be accessed by parsing callbacks.
49 * The "cf" variable will be non-NULL only when we are actually parsing a real
50 * config source (file, blob, cmdline, etc).
52 * The "current_config_kvi" variable will be non-NULL only when we are feeding
53 * cached config from a configset into a callback.
55 * They should generally never be non-NULL at the same time. If they are both
56 * NULL, then we aren't parsing anything (and depending on the function looking
57 * at the variables, it's either a bug for it to be called in the first place,
58 * or it's a function which can be reused for non-config purposes, and should
59 * fall back to some sane behavior).
61 static struct config_source *cf;
62 static struct key_value_info *current_config_kvi;
65 * Similar to the variables above, this gives access to the "scope" of the
66 * current value (repo, global, etc). For cached values, it can be found via
67 * the current_config_kvi as above. During parsing, the current value can be
68 * found in this variable. It's not part of "cf" because it transcends a single
69 * file (i.e., a file included from .git/config is still in "repo" scope).
71 static enum config_scope current_parsing_scope;
73 static int core_compression_seen;
74 static int pack_compression_seen;
75 static int zlib_compression_seen;
77 static int config_file_fgetc(struct config_source *conf)
79 return getc_unlocked(conf->u.file);
82 static int config_file_ungetc(int c, struct config_source *conf)
84 return ungetc(c, conf->u.file);
87 static long config_file_ftell(struct config_source *conf)
89 return ftell(conf->u.file);
93 static int config_buf_fgetc(struct config_source *conf)
95 if (conf->u.buf.pos < conf->u.buf.len)
96 return conf->u.buf.buf[conf->u.buf.pos++];
98 return EOF;
101 static int config_buf_ungetc(int c, struct config_source *conf)
103 if (conf->u.buf.pos > 0) {
104 conf->u.buf.pos--;
105 if (conf->u.buf.buf[conf->u.buf.pos] != c)
106 die("BUG: config_buf can only ungetc the same character");
107 return c;
110 return EOF;
113 static long config_buf_ftell(struct config_source *conf)
115 return conf->u.buf.pos;
118 #define MAX_INCLUDE_DEPTH 10
119 static const char include_depth_advice[] =
120 "exceeded maximum include depth (%d) while including\n"
121 " %s\n"
122 "from\n"
123 " %s\n"
124 "Do you have circular includes?";
125 static int handle_path_include(const char *path, struct config_include_data *inc)
127 int ret = 0;
128 struct strbuf buf = STRBUF_INIT;
129 char *expanded;
131 if (!path)
132 return config_error_nonbool("include.path");
134 expanded = expand_user_path(path, 0);
135 if (!expanded)
136 return error("could not expand include path '%s'", path);
137 path = expanded;
140 * Use an absolute path as-is, but interpret relative paths
141 * based on the including config file.
143 if (!is_absolute_path(path)) {
144 char *slash;
146 if (!cf || !cf->path)
147 return error("relative config includes must come from files");
149 slash = find_last_dir_sep(cf->path);
150 if (slash)
151 strbuf_add(&buf, cf->path, slash - cf->path + 1);
152 strbuf_addstr(&buf, path);
153 path = buf.buf;
156 if (!access_or_die(path, R_OK, 0)) {
157 if (++inc->depth > MAX_INCLUDE_DEPTH)
158 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
159 !cf ? "<unknown>" :
160 cf->name ? cf->name :
161 "the command line");
162 ret = git_config_from_file(git_config_include, path, inc);
163 inc->depth--;
165 strbuf_release(&buf);
166 free(expanded);
167 return ret;
170 static int prepare_include_condition_pattern(struct strbuf *pat)
172 struct strbuf path = STRBUF_INIT;
173 char *expanded;
174 int prefix = 0;
176 expanded = expand_user_path(pat->buf, 1);
177 if (expanded) {
178 strbuf_reset(pat);
179 strbuf_addstr(pat, expanded);
180 free(expanded);
183 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
184 const char *slash;
186 if (!cf || !cf->path)
187 return error(_("relative config include "
188 "conditionals must come from files"));
190 strbuf_realpath(&path, cf->path, 1);
191 slash = find_last_dir_sep(path.buf);
192 if (!slash)
193 die("BUG: how is this possible?");
194 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
195 prefix = slash - path.buf + 1 /* slash */;
196 } else if (!is_absolute_path(pat->buf))
197 strbuf_insert(pat, 0, "**/", 3);
199 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
200 strbuf_addstr(pat, "**");
202 strbuf_release(&path);
203 return prefix;
206 static int include_by_gitdir(const struct config_options *opts,
207 const char *cond, size_t cond_len, int icase)
209 struct strbuf text = STRBUF_INIT;
210 struct strbuf pattern = STRBUF_INIT;
211 int ret = 0, prefix;
212 const char *git_dir;
213 int already_tried_absolute = 0;
215 if (opts->git_dir)
216 git_dir = opts->git_dir;
217 else
218 goto done;
220 strbuf_realpath(&text, git_dir, 1);
221 strbuf_add(&pattern, cond, cond_len);
222 prefix = prepare_include_condition_pattern(&pattern);
224 again:
225 if (prefix < 0)
226 goto done;
228 if (prefix > 0) {
230 * perform literal matching on the prefix part so that
231 * any wildcard character in it can't create side effects.
233 if (text.len < prefix)
234 goto done;
235 if (!icase && strncmp(pattern.buf, text.buf, prefix))
236 goto done;
237 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
238 goto done;
241 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
242 icase ? WM_CASEFOLD : 0);
244 if (!ret && !already_tried_absolute) {
246 * We've tried e.g. matching gitdir:~/work, but if
247 * ~/work is a symlink to /mnt/storage/work
248 * strbuf_realpath() will expand it, so the rule won't
249 * match. Let's match against a
250 * strbuf_add_absolute_path() version of the path,
251 * which'll do the right thing
253 strbuf_reset(&text);
254 strbuf_add_absolute_path(&text, git_dir);
255 already_tried_absolute = 1;
256 goto again;
258 done:
259 strbuf_release(&pattern);
260 strbuf_release(&text);
261 return ret;
264 static int include_condition_is_true(const struct config_options *opts,
265 const char *cond, size_t cond_len)
268 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
269 return include_by_gitdir(opts, cond, cond_len, 0);
270 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
271 return include_by_gitdir(opts, cond, cond_len, 1);
273 /* unknown conditionals are always false */
274 return 0;
277 int git_config_include(const char *var, const char *value, void *data)
279 struct config_include_data *inc = data;
280 const char *cond, *key;
281 int cond_len;
282 int ret;
285 * Pass along all values, including "include" directives; this makes it
286 * possible to query information on the includes themselves.
288 ret = inc->fn(var, value, inc->data);
289 if (ret < 0)
290 return ret;
292 if (!strcmp(var, "include.path"))
293 ret = handle_path_include(value, inc);
295 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
296 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
297 !strcmp(key, "path"))
298 ret = handle_path_include(value, inc);
300 return ret;
303 void git_config_push_parameter(const char *text)
305 struct strbuf env = STRBUF_INIT;
306 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
307 if (old && *old) {
308 strbuf_addstr(&env, old);
309 strbuf_addch(&env, ' ');
311 sq_quote_buf(&env, text);
312 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
313 strbuf_release(&env);
316 static inline int iskeychar(int c)
318 return isalnum(c) || c == '-';
322 * Auxiliary function to sanity-check and split the key into the section
323 * identifier and variable name.
325 * Returns 0 on success, -1 when there is an invalid character in the key and
326 * -2 if there is no section name in the key.
328 * store_key - pointer to char* which will hold a copy of the key with
329 * lowercase section and variable name
330 * baselen - pointer to int which will hold the length of the
331 * section + subsection part, can be NULL
333 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
335 int i, dot, baselen;
336 const char *last_dot = strrchr(key, '.');
339 * Since "key" actually contains the section name and the real
340 * key name separated by a dot, we have to know where the dot is.
343 if (last_dot == NULL || last_dot == key) {
344 if (!quiet)
345 error("key does not contain a section: %s", key);
346 return -CONFIG_NO_SECTION_OR_NAME;
349 if (!last_dot[1]) {
350 if (!quiet)
351 error("key does not contain variable name: %s", key);
352 return -CONFIG_NO_SECTION_OR_NAME;
355 baselen = last_dot - key;
356 if (baselen_)
357 *baselen_ = baselen;
360 * Validate the key and while at it, lower case it for matching.
362 if (store_key)
363 *store_key = xmallocz(strlen(key));
365 dot = 0;
366 for (i = 0; key[i]; i++) {
367 unsigned char c = key[i];
368 if (c == '.')
369 dot = 1;
370 /* Leave the extended basename untouched.. */
371 if (!dot || i > baselen) {
372 if (!iskeychar(c) ||
373 (i == baselen + 1 && !isalpha(c))) {
374 if (!quiet)
375 error("invalid key: %s", key);
376 goto out_free_ret_1;
378 c = tolower(c);
379 } else if (c == '\n') {
380 if (!quiet)
381 error("invalid key (newline): %s", key);
382 goto out_free_ret_1;
384 if (store_key)
385 (*store_key)[i] = c;
388 return 0;
390 out_free_ret_1:
391 if (store_key) {
392 FREE_AND_NULL(*store_key);
394 return -CONFIG_INVALID_KEY;
397 int git_config_parse_key(const char *key, char **store_key, int *baselen)
399 return git_config_parse_key_1(key, store_key, baselen, 0);
402 int git_config_key_is_valid(const char *key)
404 return !git_config_parse_key_1(key, NULL, NULL, 1);
407 int git_config_parse_parameter(const char *text,
408 config_fn_t fn, void *data)
410 const char *value;
411 char *canonical_name;
412 struct strbuf **pair;
413 int ret;
415 pair = strbuf_split_str(text, '=', 2);
416 if (!pair[0])
417 return error("bogus config parameter: %s", text);
419 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
420 strbuf_setlen(pair[0], pair[0]->len - 1);
421 value = pair[1] ? pair[1]->buf : "";
422 } else {
423 value = NULL;
426 strbuf_trim(pair[0]);
427 if (!pair[0]->len) {
428 strbuf_list_free(pair);
429 return error("bogus config parameter: %s", text);
432 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
433 ret = -1;
434 } else {
435 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
436 free(canonical_name);
438 strbuf_list_free(pair);
439 return ret;
442 int git_config_from_parameters(config_fn_t fn, void *data)
444 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
445 int ret = 0;
446 char *envw;
447 const char **argv = NULL;
448 int nr = 0, alloc = 0;
449 int i;
450 struct config_source source;
452 if (!env)
453 return 0;
455 memset(&source, 0, sizeof(source));
456 source.prev = cf;
457 source.origin_type = CONFIG_ORIGIN_CMDLINE;
458 cf = &source;
460 /* sq_dequote will write over it */
461 envw = xstrdup(env);
463 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
464 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
465 goto out;
468 for (i = 0; i < nr; i++) {
469 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
470 ret = -1;
471 goto out;
475 out:
476 free(argv);
477 free(envw);
478 cf = source.prev;
479 return ret;
482 static int get_next_char(void)
484 int c = cf->do_fgetc(cf);
486 if (c == '\r') {
487 /* DOS like systems */
488 c = cf->do_fgetc(cf);
489 if (c != '\n') {
490 if (c != EOF)
491 cf->do_ungetc(c, cf);
492 c = '\r';
495 if (c == '\n')
496 cf->linenr++;
497 if (c == EOF) {
498 cf->eof = 1;
499 cf->linenr++;
500 c = '\n';
502 return c;
505 static char *parse_value(void)
507 int quote = 0, comment = 0, space = 0;
509 strbuf_reset(&cf->value);
510 for (;;) {
511 int c = get_next_char();
512 if (c == '\n') {
513 if (quote) {
514 cf->linenr--;
515 return NULL;
517 return cf->value.buf;
519 if (comment)
520 continue;
521 if (isspace(c) && !quote) {
522 if (cf->value.len)
523 space++;
524 continue;
526 if (!quote) {
527 if (c == ';' || c == '#') {
528 comment = 1;
529 continue;
532 for (; space; space--)
533 strbuf_addch(&cf->value, ' ');
534 if (c == '\\') {
535 c = get_next_char();
536 switch (c) {
537 case '\n':
538 continue;
539 case 't':
540 c = '\t';
541 break;
542 case 'b':
543 c = '\b';
544 break;
545 case 'n':
546 c = '\n';
547 break;
548 /* Some characters escape as themselves */
549 case '\\': case '"':
550 break;
551 /* Reject unknown escape sequences */
552 default:
553 return NULL;
555 strbuf_addch(&cf->value, c);
556 continue;
558 if (c == '"') {
559 quote = 1-quote;
560 continue;
562 strbuf_addch(&cf->value, c);
566 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
568 int c;
569 char *value;
570 int ret;
572 /* Get the full name */
573 for (;;) {
574 c = get_next_char();
575 if (cf->eof)
576 break;
577 if (!iskeychar(c))
578 break;
579 strbuf_addch(name, tolower(c));
582 while (c == ' ' || c == '\t')
583 c = get_next_char();
585 value = NULL;
586 if (c != '\n') {
587 if (c != '=')
588 return -1;
589 value = parse_value();
590 if (!value)
591 return -1;
594 * We already consumed the \n, but we need linenr to point to
595 * the line we just parsed during the call to fn to get
596 * accurate line number in error messages.
598 cf->linenr--;
599 ret = fn(name->buf, value, data);
600 if (ret >= 0)
601 cf->linenr++;
602 return ret;
605 static int get_extended_base_var(struct strbuf *name, int c)
607 do {
608 if (c == '\n')
609 goto error_incomplete_line;
610 c = get_next_char();
611 } while (isspace(c));
613 /* We require the format to be '[base "extension"]' */
614 if (c != '"')
615 return -1;
616 strbuf_addch(name, '.');
618 for (;;) {
619 int c = get_next_char();
620 if (c == '\n')
621 goto error_incomplete_line;
622 if (c == '"')
623 break;
624 if (c == '\\') {
625 c = get_next_char();
626 if (c == '\n')
627 goto error_incomplete_line;
629 strbuf_addch(name, c);
632 /* Final ']' */
633 if (get_next_char() != ']')
634 return -1;
635 return 0;
636 error_incomplete_line:
637 cf->linenr--;
638 return -1;
641 static int get_base_var(struct strbuf *name)
643 for (;;) {
644 int c = get_next_char();
645 if (cf->eof)
646 return -1;
647 if (c == ']')
648 return 0;
649 if (isspace(c))
650 return get_extended_base_var(name, c);
651 if (!iskeychar(c) && c != '.')
652 return -1;
653 strbuf_addch(name, tolower(c));
657 static int git_parse_source(config_fn_t fn, void *data)
659 int comment = 0;
660 int baselen = 0;
661 struct strbuf *var = &cf->var;
662 int error_return = 0;
663 char *error_msg = NULL;
665 /* U+FEFF Byte Order Mark in UTF8 */
666 const char *bomptr = utf8_bom;
668 for (;;) {
669 int c = get_next_char();
670 if (bomptr && *bomptr) {
671 /* We are at the file beginning; skip UTF8-encoded BOM
672 * if present. Sane editors won't put this in on their
673 * own, but e.g. Windows Notepad will do it happily. */
674 if (c == (*bomptr & 0377)) {
675 bomptr++;
676 continue;
677 } else {
678 /* Do not tolerate partial BOM. */
679 if (bomptr != utf8_bom)
680 break;
681 /* No BOM at file beginning. Cool. */
682 bomptr = NULL;
685 if (c == '\n') {
686 if (cf->eof)
687 return 0;
688 comment = 0;
689 continue;
691 if (comment || isspace(c))
692 continue;
693 if (c == '#' || c == ';') {
694 comment = 1;
695 continue;
697 if (c == '[') {
698 /* Reset prior to determining a new stem */
699 strbuf_reset(var);
700 if (get_base_var(var) < 0 || var->len < 1)
701 break;
702 strbuf_addch(var, '.');
703 baselen = var->len;
704 continue;
706 if (!isalpha(c))
707 break;
709 * Truncate the var name back to the section header
710 * stem prior to grabbing the suffix part of the name
711 * and the value.
713 strbuf_setlen(var, baselen);
714 strbuf_addch(var, tolower(c));
715 if (get_value(fn, data, var) < 0)
716 break;
719 switch (cf->origin_type) {
720 case CONFIG_ORIGIN_BLOB:
721 error_msg = xstrfmt(_("bad config line %d in blob %s"),
722 cf->linenr, cf->name);
723 break;
724 case CONFIG_ORIGIN_FILE:
725 error_msg = xstrfmt(_("bad config line %d in file %s"),
726 cf->linenr, cf->name);
727 break;
728 case CONFIG_ORIGIN_STDIN:
729 error_msg = xstrfmt(_("bad config line %d in standard input"),
730 cf->linenr);
731 break;
732 case CONFIG_ORIGIN_SUBMODULE_BLOB:
733 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
734 cf->linenr, cf->name);
735 break;
736 case CONFIG_ORIGIN_CMDLINE:
737 error_msg = xstrfmt(_("bad config line %d in command line %s"),
738 cf->linenr, cf->name);
739 break;
740 default:
741 error_msg = xstrfmt(_("bad config line %d in %s"),
742 cf->linenr, cf->name);
745 if (cf->die_on_error)
746 die("%s", error_msg);
747 else
748 error_return = error("%s", error_msg);
750 free(error_msg);
751 return error_return;
754 static int parse_unit_factor(const char *end, uintmax_t *val)
756 if (!*end)
757 return 1;
758 else if (!strcasecmp(end, "k")) {
759 *val *= 1024;
760 return 1;
762 else if (!strcasecmp(end, "m")) {
763 *val *= 1024 * 1024;
764 return 1;
766 else if (!strcasecmp(end, "g")) {
767 *val *= 1024 * 1024 * 1024;
768 return 1;
770 return 0;
773 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
775 if (value && *value) {
776 char *end;
777 intmax_t val;
778 uintmax_t uval;
779 uintmax_t factor = 1;
781 errno = 0;
782 val = strtoimax(value, &end, 0);
783 if (errno == ERANGE)
784 return 0;
785 if (!parse_unit_factor(end, &factor)) {
786 errno = EINVAL;
787 return 0;
789 uval = labs(val);
790 uval *= factor;
791 if (uval > max || labs(val) > uval) {
792 errno = ERANGE;
793 return 0;
795 val *= factor;
796 *ret = val;
797 return 1;
799 errno = EINVAL;
800 return 0;
803 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
805 if (value && *value) {
806 char *end;
807 uintmax_t val;
808 uintmax_t oldval;
810 errno = 0;
811 val = strtoumax(value, &end, 0);
812 if (errno == ERANGE)
813 return 0;
814 oldval = val;
815 if (!parse_unit_factor(end, &val)) {
816 errno = EINVAL;
817 return 0;
819 if (val > max || oldval > val) {
820 errno = ERANGE;
821 return 0;
823 *ret = val;
824 return 1;
826 errno = EINVAL;
827 return 0;
830 static int git_parse_int(const char *value, int *ret)
832 intmax_t tmp;
833 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
834 return 0;
835 *ret = tmp;
836 return 1;
839 static int git_parse_int64(const char *value, int64_t *ret)
841 intmax_t tmp;
842 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
843 return 0;
844 *ret = tmp;
845 return 1;
848 int git_parse_ulong(const char *value, unsigned long *ret)
850 uintmax_t tmp;
851 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
852 return 0;
853 *ret = tmp;
854 return 1;
857 static int git_parse_ssize_t(const char *value, ssize_t *ret)
859 intmax_t tmp;
860 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
861 return 0;
862 *ret = tmp;
863 return 1;
866 NORETURN
867 static void die_bad_number(const char *name, const char *value)
869 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
871 if (!value)
872 value = "";
874 if (!(cf && cf->name))
875 die(_("bad numeric config value '%s' for '%s': %s"),
876 value, name, error_type);
878 switch (cf->origin_type) {
879 case CONFIG_ORIGIN_BLOB:
880 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
881 value, name, cf->name, error_type);
882 case CONFIG_ORIGIN_FILE:
883 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
884 value, name, cf->name, error_type);
885 case CONFIG_ORIGIN_STDIN:
886 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
887 value, name, error_type);
888 case CONFIG_ORIGIN_SUBMODULE_BLOB:
889 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
890 value, name, cf->name, error_type);
891 case CONFIG_ORIGIN_CMDLINE:
892 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
893 value, name, cf->name, error_type);
894 default:
895 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
896 value, name, cf->name, error_type);
900 int git_config_int(const char *name, const char *value)
902 int ret;
903 if (!git_parse_int(value, &ret))
904 die_bad_number(name, value);
905 return ret;
908 int64_t git_config_int64(const char *name, const char *value)
910 int64_t ret;
911 if (!git_parse_int64(value, &ret))
912 die_bad_number(name, value);
913 return ret;
916 unsigned long git_config_ulong(const char *name, const char *value)
918 unsigned long ret;
919 if (!git_parse_ulong(value, &ret))
920 die_bad_number(name, value);
921 return ret;
924 ssize_t git_config_ssize_t(const char *name, const char *value)
926 ssize_t ret;
927 if (!git_parse_ssize_t(value, &ret))
928 die_bad_number(name, value);
929 return ret;
932 static int git_parse_maybe_bool_text(const char *value)
934 if (!value)
935 return 1;
936 if (!*value)
937 return 0;
938 if (!strcasecmp(value, "true")
939 || !strcasecmp(value, "yes")
940 || !strcasecmp(value, "on"))
941 return 1;
942 if (!strcasecmp(value, "false")
943 || !strcasecmp(value, "no")
944 || !strcasecmp(value, "off"))
945 return 0;
946 return -1;
949 int git_parse_maybe_bool(const char *value)
951 int v = git_parse_maybe_bool_text(value);
952 if (0 <= v)
953 return v;
954 if (git_parse_int(value, &v))
955 return !!v;
956 return -1;
959 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
961 int v = git_parse_maybe_bool_text(value);
962 if (0 <= v) {
963 *is_bool = 1;
964 return v;
966 *is_bool = 0;
967 return git_config_int(name, value);
970 int git_config_bool(const char *name, const char *value)
972 int discard;
973 return !!git_config_bool_or_int(name, value, &discard);
976 int git_config_string(const char **dest, const char *var, const char *value)
978 if (!value)
979 return config_error_nonbool(var);
980 *dest = xstrdup(value);
981 return 0;
984 int git_config_pathname(const char **dest, const char *var, const char *value)
986 if (!value)
987 return config_error_nonbool(var);
988 *dest = expand_user_path(value, 0);
989 if (!*dest)
990 die(_("failed to expand user dir in: '%s'"), value);
991 return 0;
994 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
996 if (!value)
997 return config_error_nonbool(var);
998 if (parse_expiry_date(value, timestamp))
999 return error(_("'%s' for '%s' is not a valid timestamp"),
1000 value, var);
1001 return 0;
1004 int git_config_color(char *dest, const char *var, const char *value)
1006 if (!value)
1007 return config_error_nonbool(var);
1008 if (color_parse(value, dest) < 0)
1009 return -1;
1010 return 0;
1013 static int git_default_core_config(const char *var, const char *value)
1015 /* This needs a better name */
1016 if (!strcmp(var, "core.filemode")) {
1017 trust_executable_bit = git_config_bool(var, value);
1018 return 0;
1020 if (!strcmp(var, "core.trustctime")) {
1021 trust_ctime = git_config_bool(var, value);
1022 return 0;
1024 if (!strcmp(var, "core.checkstat")) {
1025 if (!strcasecmp(value, "default"))
1026 check_stat = 1;
1027 else if (!strcasecmp(value, "minimal"))
1028 check_stat = 0;
1031 if (!strcmp(var, "core.quotepath")) {
1032 quote_path_fully = git_config_bool(var, value);
1033 return 0;
1036 if (!strcmp(var, "core.symlinks")) {
1037 has_symlinks = git_config_bool(var, value);
1038 return 0;
1041 if (!strcmp(var, "core.ignorecase")) {
1042 ignore_case = git_config_bool(var, value);
1043 return 0;
1046 if (!strcmp(var, "core.attributesfile"))
1047 return git_config_pathname(&git_attributes_file, var, value);
1049 if (!strcmp(var, "core.hookspath"))
1050 return git_config_pathname(&git_hooks_path, var, value);
1052 if (!strcmp(var, "core.bare")) {
1053 is_bare_repository_cfg = git_config_bool(var, value);
1054 return 0;
1057 if (!strcmp(var, "core.ignorestat")) {
1058 assume_unchanged = git_config_bool(var, value);
1059 return 0;
1062 if (!strcmp(var, "core.prefersymlinkrefs")) {
1063 prefer_symlink_refs = git_config_bool(var, value);
1064 return 0;
1067 if (!strcmp(var, "core.logallrefupdates")) {
1068 if (value && !strcasecmp(value, "always"))
1069 log_all_ref_updates = LOG_REFS_ALWAYS;
1070 else if (git_config_bool(var, value))
1071 log_all_ref_updates = LOG_REFS_NORMAL;
1072 else
1073 log_all_ref_updates = LOG_REFS_NONE;
1074 return 0;
1077 if (!strcmp(var, "core.warnambiguousrefs")) {
1078 warn_ambiguous_refs = git_config_bool(var, value);
1079 return 0;
1082 if (!strcmp(var, "core.abbrev")) {
1083 if (!value)
1084 return config_error_nonbool(var);
1085 if (!strcasecmp(value, "auto"))
1086 default_abbrev = -1;
1087 else {
1088 int abbrev = git_config_int(var, value);
1089 if (abbrev < minimum_abbrev || abbrev > 40)
1090 return error("abbrev length out of range: %d", abbrev);
1091 default_abbrev = abbrev;
1093 return 0;
1096 if (!strcmp(var, "core.disambiguate"))
1097 return set_disambiguate_hint_config(var, value);
1099 if (!strcmp(var, "core.loosecompression")) {
1100 int level = git_config_int(var, value);
1101 if (level == -1)
1102 level = Z_DEFAULT_COMPRESSION;
1103 else if (level < 0 || level > Z_BEST_COMPRESSION)
1104 die(_("bad zlib compression level %d"), level);
1105 zlib_compression_level = level;
1106 zlib_compression_seen = 1;
1107 return 0;
1110 if (!strcmp(var, "core.compression")) {
1111 int level = git_config_int(var, value);
1112 if (level == -1)
1113 level = Z_DEFAULT_COMPRESSION;
1114 else if (level < 0 || level > Z_BEST_COMPRESSION)
1115 die(_("bad zlib compression level %d"), level);
1116 core_compression_level = level;
1117 core_compression_seen = 1;
1118 if (!zlib_compression_seen)
1119 zlib_compression_level = level;
1120 if (!pack_compression_seen)
1121 pack_compression_level = level;
1122 return 0;
1125 if (!strcmp(var, "core.packedgitwindowsize")) {
1126 int pgsz_x2 = getpagesize() * 2;
1127 packed_git_window_size = git_config_ulong(var, value);
1129 /* This value must be multiple of (pagesize * 2) */
1130 packed_git_window_size /= pgsz_x2;
1131 if (packed_git_window_size < 1)
1132 packed_git_window_size = 1;
1133 packed_git_window_size *= pgsz_x2;
1134 return 0;
1137 if (!strcmp(var, "core.bigfilethreshold")) {
1138 big_file_threshold = git_config_ulong(var, value);
1139 return 0;
1142 if (!strcmp(var, "core.packedgitlimit")) {
1143 packed_git_limit = git_config_ulong(var, value);
1144 return 0;
1147 if (!strcmp(var, "core.deltabasecachelimit")) {
1148 delta_base_cache_limit = git_config_ulong(var, value);
1149 return 0;
1152 if (!strcmp(var, "core.autocrlf")) {
1153 if (value && !strcasecmp(value, "input")) {
1154 auto_crlf = AUTO_CRLF_INPUT;
1155 return 0;
1157 auto_crlf = git_config_bool(var, value);
1158 return 0;
1161 if (!strcmp(var, "core.safecrlf")) {
1162 int eol_rndtrp_die;
1163 if (value && !strcasecmp(value, "warn")) {
1164 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1165 return 0;
1167 eol_rndtrp_die = git_config_bool(var, value);
1168 global_conv_flags_eol = eol_rndtrp_die ?
1169 CONV_EOL_RNDTRP_DIE : CONV_EOL_RNDTRP_WARN;
1170 return 0;
1173 if (!strcmp(var, "core.eol")) {
1174 if (value && !strcasecmp(value, "lf"))
1175 core_eol = EOL_LF;
1176 else if (value && !strcasecmp(value, "crlf"))
1177 core_eol = EOL_CRLF;
1178 else if (value && !strcasecmp(value, "native"))
1179 core_eol = EOL_NATIVE;
1180 else
1181 core_eol = EOL_UNSET;
1182 return 0;
1185 if (!strcmp(var, "core.notesref")) {
1186 notes_ref_name = xstrdup(value);
1187 return 0;
1190 if (!strcmp(var, "core.editor"))
1191 return git_config_string(&editor_program, var, value);
1193 if (!strcmp(var, "core.commentchar")) {
1194 if (!value)
1195 return config_error_nonbool(var);
1196 else if (!strcasecmp(value, "auto"))
1197 auto_comment_line_char = 1;
1198 else if (value[0] && !value[1]) {
1199 comment_line_char = value[0];
1200 auto_comment_line_char = 0;
1201 } else
1202 return error("core.commentChar should only be one character");
1203 return 0;
1206 if (!strcmp(var, "core.askpass"))
1207 return git_config_string(&askpass_program, var, value);
1209 if (!strcmp(var, "core.excludesfile"))
1210 return git_config_pathname(&excludes_file, var, value);
1212 if (!strcmp(var, "core.whitespace")) {
1213 if (!value)
1214 return config_error_nonbool(var);
1215 whitespace_rule_cfg = parse_whitespace_rule(value);
1216 return 0;
1219 if (!strcmp(var, "core.fsyncobjectfiles")) {
1220 fsync_object_files = git_config_bool(var, value);
1221 return 0;
1224 if (!strcmp(var, "core.preloadindex")) {
1225 core_preload_index = git_config_bool(var, value);
1226 return 0;
1229 if (!strcmp(var, "core.createobject")) {
1230 if (!strcmp(value, "rename"))
1231 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1232 else if (!strcmp(value, "link"))
1233 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1234 else
1235 die(_("invalid mode for object creation: %s"), value);
1236 return 0;
1239 if (!strcmp(var, "core.sparsecheckout")) {
1240 core_apply_sparse_checkout = git_config_bool(var, value);
1241 return 0;
1244 if (!strcmp(var, "core.precomposeunicode")) {
1245 precomposed_unicode = git_config_bool(var, value);
1246 return 0;
1249 if (!strcmp(var, "core.protecthfs")) {
1250 protect_hfs = git_config_bool(var, value);
1251 return 0;
1254 if (!strcmp(var, "core.protectntfs")) {
1255 protect_ntfs = git_config_bool(var, value);
1256 return 0;
1259 if (!strcmp(var, "core.hidedotfiles")) {
1260 if (value && !strcasecmp(value, "dotgitonly"))
1261 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1262 else
1263 hide_dotfiles = git_config_bool(var, value);
1264 return 0;
1267 if (!strcmp(var, "core.partialclonefilter")) {
1268 return git_config_string(&core_partial_clone_filter_default,
1269 var, value);
1272 /* Add other config variables here and to Documentation/config.txt. */
1273 return 0;
1276 static int git_default_i18n_config(const char *var, const char *value)
1278 if (!strcmp(var, "i18n.commitencoding"))
1279 return git_config_string(&git_commit_encoding, var, value);
1281 if (!strcmp(var, "i18n.logoutputencoding"))
1282 return git_config_string(&git_log_output_encoding, var, value);
1284 /* Add other config variables here and to Documentation/config.txt. */
1285 return 0;
1288 static int git_default_branch_config(const char *var, const char *value)
1290 if (!strcmp(var, "branch.autosetupmerge")) {
1291 if (value && !strcasecmp(value, "always")) {
1292 git_branch_track = BRANCH_TRACK_ALWAYS;
1293 return 0;
1295 git_branch_track = git_config_bool(var, value);
1296 return 0;
1298 if (!strcmp(var, "branch.autosetuprebase")) {
1299 if (!value)
1300 return config_error_nonbool(var);
1301 else if (!strcmp(value, "never"))
1302 autorebase = AUTOREBASE_NEVER;
1303 else if (!strcmp(value, "local"))
1304 autorebase = AUTOREBASE_LOCAL;
1305 else if (!strcmp(value, "remote"))
1306 autorebase = AUTOREBASE_REMOTE;
1307 else if (!strcmp(value, "always"))
1308 autorebase = AUTOREBASE_ALWAYS;
1309 else
1310 return error("malformed value for %s", var);
1311 return 0;
1314 /* Add other config variables here and to Documentation/config.txt. */
1315 return 0;
1318 static int git_default_push_config(const char *var, const char *value)
1320 if (!strcmp(var, "push.default")) {
1321 if (!value)
1322 return config_error_nonbool(var);
1323 else if (!strcmp(value, "nothing"))
1324 push_default = PUSH_DEFAULT_NOTHING;
1325 else if (!strcmp(value, "matching"))
1326 push_default = PUSH_DEFAULT_MATCHING;
1327 else if (!strcmp(value, "simple"))
1328 push_default = PUSH_DEFAULT_SIMPLE;
1329 else if (!strcmp(value, "upstream"))
1330 push_default = PUSH_DEFAULT_UPSTREAM;
1331 else if (!strcmp(value, "tracking")) /* deprecated */
1332 push_default = PUSH_DEFAULT_UPSTREAM;
1333 else if (!strcmp(value, "current"))
1334 push_default = PUSH_DEFAULT_CURRENT;
1335 else {
1336 error("malformed value for %s: %s", var, value);
1337 return error("Must be one of nothing, matching, simple, "
1338 "upstream or current.");
1340 return 0;
1343 /* Add other config variables here and to Documentation/config.txt. */
1344 return 0;
1347 static int git_default_mailmap_config(const char *var, const char *value)
1349 if (!strcmp(var, "mailmap.file"))
1350 return git_config_pathname(&git_mailmap_file, var, value);
1351 if (!strcmp(var, "mailmap.blob"))
1352 return git_config_string(&git_mailmap_blob, var, value);
1354 /* Add other config variables here and to Documentation/config.txt. */
1355 return 0;
1358 int git_default_config(const char *var, const char *value, void *dummy)
1360 if (starts_with(var, "core."))
1361 return git_default_core_config(var, value);
1363 if (starts_with(var, "user."))
1364 return git_ident_config(var, value, dummy);
1366 if (starts_with(var, "i18n."))
1367 return git_default_i18n_config(var, value);
1369 if (starts_with(var, "branch."))
1370 return git_default_branch_config(var, value);
1372 if (starts_with(var, "push."))
1373 return git_default_push_config(var, value);
1375 if (starts_with(var, "mailmap."))
1376 return git_default_mailmap_config(var, value);
1378 if (starts_with(var, "advice."))
1379 return git_default_advice_config(var, value);
1381 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1382 pager_use_color = git_config_bool(var,value);
1383 return 0;
1386 if (!strcmp(var, "pack.packsizelimit")) {
1387 pack_size_limit_cfg = git_config_ulong(var, value);
1388 return 0;
1391 if (!strcmp(var, "pack.compression")) {
1392 int level = git_config_int(var, value);
1393 if (level == -1)
1394 level = Z_DEFAULT_COMPRESSION;
1395 else if (level < 0 || level > Z_BEST_COMPRESSION)
1396 die(_("bad pack compression level %d"), level);
1397 pack_compression_level = level;
1398 pack_compression_seen = 1;
1399 return 0;
1402 /* Add other config variables here and to Documentation/config.txt. */
1403 return 0;
1407 * All source specific fields in the union, die_on_error, name and the callbacks
1408 * fgetc, ungetc, ftell of top need to be initialized before calling
1409 * this function.
1411 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1413 int ret;
1415 /* push config-file parsing state stack */
1416 top->prev = cf;
1417 top->linenr = 1;
1418 top->eof = 0;
1419 strbuf_init(&top->value, 1024);
1420 strbuf_init(&top->var, 1024);
1421 cf = top;
1423 ret = git_parse_source(fn, data);
1425 /* pop config-file parsing state stack */
1426 strbuf_release(&top->value);
1427 strbuf_release(&top->var);
1428 cf = top->prev;
1430 return ret;
1433 static int do_config_from_file(config_fn_t fn,
1434 const enum config_origin_type origin_type,
1435 const char *name, const char *path, FILE *f,
1436 void *data)
1438 struct config_source top;
1440 top.u.file = f;
1441 top.origin_type = origin_type;
1442 top.name = name;
1443 top.path = path;
1444 top.die_on_error = 1;
1445 top.do_fgetc = config_file_fgetc;
1446 top.do_ungetc = config_file_ungetc;
1447 top.do_ftell = config_file_ftell;
1449 return do_config_from(&top, fn, data);
1452 static int git_config_from_stdin(config_fn_t fn, void *data)
1454 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1457 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1459 int ret = -1;
1460 FILE *f;
1462 f = fopen_or_warn(filename, "r");
1463 if (f) {
1464 flockfile(f);
1465 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1466 funlockfile(f);
1467 fclose(f);
1469 return ret;
1472 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1473 const char *name, const char *buf, size_t len, void *data)
1475 struct config_source top;
1477 top.u.buf.buf = buf;
1478 top.u.buf.len = len;
1479 top.u.buf.pos = 0;
1480 top.origin_type = origin_type;
1481 top.name = name;
1482 top.path = NULL;
1483 top.die_on_error = 0;
1484 top.do_fgetc = config_buf_fgetc;
1485 top.do_ungetc = config_buf_ungetc;
1486 top.do_ftell = config_buf_ftell;
1488 return do_config_from(&top, fn, data);
1491 int git_config_from_blob_oid(config_fn_t fn,
1492 const char *name,
1493 const struct object_id *oid,
1494 void *data)
1496 enum object_type type;
1497 char *buf;
1498 unsigned long size;
1499 int ret;
1501 buf = read_sha1_file(oid->hash, &type, &size);
1502 if (!buf)
1503 return error("unable to load config blob object '%s'", name);
1504 if (type != OBJ_BLOB) {
1505 free(buf);
1506 return error("reference '%s' does not point to a blob", name);
1509 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1510 free(buf);
1512 return ret;
1515 static int git_config_from_blob_ref(config_fn_t fn,
1516 const char *name,
1517 void *data)
1519 struct object_id oid;
1521 if (get_oid(name, &oid) < 0)
1522 return error("unable to resolve config blob '%s'", name);
1523 return git_config_from_blob_oid(fn, name, &oid, data);
1526 const char *git_etc_gitconfig(void)
1528 static const char *system_wide;
1529 if (!system_wide)
1530 system_wide = system_path(ETC_GITCONFIG);
1531 return system_wide;
1535 * Parse environment variable 'k' as a boolean (in various
1536 * possible spellings); if missing, use the default value 'def'.
1538 int git_env_bool(const char *k, int def)
1540 const char *v = getenv(k);
1541 return v ? git_config_bool(k, v) : def;
1545 * Parse environment variable 'k' as ulong with possibly a unit
1546 * suffix; if missing, use the default value 'val'.
1548 unsigned long git_env_ulong(const char *k, unsigned long val)
1550 const char *v = getenv(k);
1551 if (v && !git_parse_ulong(v, &val))
1552 die("failed to parse %s", k);
1553 return val;
1556 int git_config_system(void)
1558 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1561 static int do_git_config_sequence(const struct config_options *opts,
1562 config_fn_t fn, void *data)
1564 int ret = 0;
1565 char *xdg_config = xdg_config_home("config");
1566 char *user_config = expand_user_path("~/.gitconfig", 0);
1567 char *repo_config;
1569 if (opts->commondir)
1570 repo_config = mkpathdup("%s/config", opts->commondir);
1571 else
1572 repo_config = NULL;
1574 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1575 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1576 ret += git_config_from_file(fn, git_etc_gitconfig(),
1577 data);
1579 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1580 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1581 ret += git_config_from_file(fn, xdg_config, data);
1583 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1584 ret += git_config_from_file(fn, user_config, data);
1586 current_parsing_scope = CONFIG_SCOPE_REPO;
1587 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1588 ret += git_config_from_file(fn, repo_config, data);
1590 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1591 if (git_config_from_parameters(fn, data) < 0)
1592 die(_("unable to parse command-line config"));
1594 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1595 free(xdg_config);
1596 free(user_config);
1597 free(repo_config);
1598 return ret;
1601 int config_with_options(config_fn_t fn, void *data,
1602 struct git_config_source *config_source,
1603 const struct config_options *opts)
1605 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1607 if (opts->respect_includes) {
1608 inc.fn = fn;
1609 inc.data = data;
1610 inc.opts = opts;
1611 fn = git_config_include;
1612 data = &inc;
1616 * If we have a specific filename, use it. Otherwise, follow the
1617 * regular lookup sequence.
1619 if (config_source && config_source->use_stdin)
1620 return git_config_from_stdin(fn, data);
1621 else if (config_source && config_source->file)
1622 return git_config_from_file(fn, config_source->file, data);
1623 else if (config_source && config_source->blob)
1624 return git_config_from_blob_ref(fn, config_source->blob, data);
1626 return do_git_config_sequence(opts, fn, data);
1629 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1631 int i, value_index;
1632 struct string_list *values;
1633 struct config_set_element *entry;
1634 struct configset_list *list = &cs->list;
1636 for (i = 0; i < list->nr; i++) {
1637 entry = list->items[i].e;
1638 value_index = list->items[i].value_index;
1639 values = &entry->value_list;
1641 current_config_kvi = values->items[value_index].util;
1643 if (fn(entry->key, values->items[value_index].string, data) < 0)
1644 git_die_config_linenr(entry->key,
1645 current_config_kvi->filename,
1646 current_config_kvi->linenr);
1648 current_config_kvi = NULL;
1652 void read_early_config(config_fn_t cb, void *data)
1654 struct config_options opts = {0};
1655 struct strbuf commondir = STRBUF_INIT;
1656 struct strbuf gitdir = STRBUF_INIT;
1658 opts.respect_includes = 1;
1660 if (have_git_dir()) {
1661 opts.commondir = get_git_common_dir();
1662 opts.git_dir = get_git_dir();
1664 * When setup_git_directory() was not yet asked to discover the
1665 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1666 * is any repository config we should use (but unlike
1667 * setup_git_directory_gently(), no global state is changed, most
1668 * notably, the current working directory is still the same after the
1669 * call).
1671 } else if (!discover_git_directory(&commondir, &gitdir)) {
1672 opts.commondir = commondir.buf;
1673 opts.git_dir = gitdir.buf;
1676 config_with_options(cb, data, NULL, &opts);
1678 strbuf_release(&commondir);
1679 strbuf_release(&gitdir);
1682 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1684 struct config_set_element k;
1685 struct config_set_element *found_entry;
1686 char *normalized_key;
1688 * `key` may come from the user, so normalize it before using it
1689 * for querying entries from the hashmap.
1691 if (git_config_parse_key(key, &normalized_key, NULL))
1692 return NULL;
1694 hashmap_entry_init(&k, strhash(normalized_key));
1695 k.key = normalized_key;
1696 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1697 free(normalized_key);
1698 return found_entry;
1701 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1703 struct config_set_element *e;
1704 struct string_list_item *si;
1705 struct configset_list_item *l_item;
1706 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1708 e = configset_find_element(cs, key);
1710 * Since the keys are being fed by git_config*() callback mechanism, they
1711 * are already normalized. So simply add them without any further munging.
1713 if (!e) {
1714 e = xmalloc(sizeof(*e));
1715 hashmap_entry_init(e, strhash(key));
1716 e->key = xstrdup(key);
1717 string_list_init(&e->value_list, 1);
1718 hashmap_add(&cs->config_hash, e);
1720 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1722 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1723 l_item = &cs->list.items[cs->list.nr++];
1724 l_item->e = e;
1725 l_item->value_index = e->value_list.nr - 1;
1727 if (!cf)
1728 die("BUG: configset_add_value has no source");
1729 if (cf->name) {
1730 kv_info->filename = strintern(cf->name);
1731 kv_info->linenr = cf->linenr;
1732 kv_info->origin_type = cf->origin_type;
1733 } else {
1734 /* for values read from `git_config_from_parameters()` */
1735 kv_info->filename = NULL;
1736 kv_info->linenr = -1;
1737 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1739 kv_info->scope = current_parsing_scope;
1740 si->util = kv_info;
1742 return 0;
1745 static int config_set_element_cmp(const void *unused_cmp_data,
1746 const void *entry,
1747 const void *entry_or_key,
1748 const void *unused_keydata)
1750 const struct config_set_element *e1 = entry;
1751 const struct config_set_element *e2 = entry_or_key;
1753 return strcmp(e1->key, e2->key);
1756 void git_configset_init(struct config_set *cs)
1758 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1759 cs->hash_initialized = 1;
1760 cs->list.nr = 0;
1761 cs->list.alloc = 0;
1762 cs->list.items = NULL;
1765 void git_configset_clear(struct config_set *cs)
1767 struct config_set_element *entry;
1768 struct hashmap_iter iter;
1769 if (!cs->hash_initialized)
1770 return;
1772 hashmap_iter_init(&cs->config_hash, &iter);
1773 while ((entry = hashmap_iter_next(&iter))) {
1774 free(entry->key);
1775 string_list_clear(&entry->value_list, 1);
1777 hashmap_free(&cs->config_hash, 1);
1778 cs->hash_initialized = 0;
1779 free(cs->list.items);
1780 cs->list.nr = 0;
1781 cs->list.alloc = 0;
1782 cs->list.items = NULL;
1785 static int config_set_callback(const char *key, const char *value, void *cb)
1787 struct config_set *cs = cb;
1788 configset_add_value(cs, key, value);
1789 return 0;
1792 int git_configset_add_file(struct config_set *cs, const char *filename)
1794 return git_config_from_file(config_set_callback, filename, cs);
1797 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1799 const struct string_list *values = NULL;
1801 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1802 * queried key in the files of the configset, the value returned will be the last
1803 * value in the value list for that key.
1805 values = git_configset_get_value_multi(cs, key);
1807 if (!values)
1808 return 1;
1809 assert(values->nr > 0);
1810 *value = values->items[values->nr - 1].string;
1811 return 0;
1814 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1816 struct config_set_element *e = configset_find_element(cs, key);
1817 return e ? &e->value_list : NULL;
1820 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1822 const char *value;
1823 if (!git_configset_get_value(cs, key, &value))
1824 return git_config_string(dest, key, value);
1825 else
1826 return 1;
1829 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1831 return git_configset_get_string_const(cs, key, (const char **)dest);
1834 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1836 const char *value;
1837 if (!git_configset_get_value(cs, key, &value)) {
1838 *dest = git_config_int(key, value);
1839 return 0;
1840 } else
1841 return 1;
1844 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1846 const char *value;
1847 if (!git_configset_get_value(cs, key, &value)) {
1848 *dest = git_config_ulong(key, value);
1849 return 0;
1850 } else
1851 return 1;
1854 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1856 const char *value;
1857 if (!git_configset_get_value(cs, key, &value)) {
1858 *dest = git_config_bool(key, value);
1859 return 0;
1860 } else
1861 return 1;
1864 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1865 int *is_bool, int *dest)
1867 const char *value;
1868 if (!git_configset_get_value(cs, key, &value)) {
1869 *dest = git_config_bool_or_int(key, value, is_bool);
1870 return 0;
1871 } else
1872 return 1;
1875 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1877 const char *value;
1878 if (!git_configset_get_value(cs, key, &value)) {
1879 *dest = git_parse_maybe_bool(value);
1880 if (*dest == -1)
1881 return -1;
1882 return 0;
1883 } else
1884 return 1;
1887 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1889 const char *value;
1890 if (!git_configset_get_value(cs, key, &value))
1891 return git_config_pathname(dest, key, value);
1892 else
1893 return 1;
1896 /* Functions use to read configuration from a repository */
1897 static void repo_read_config(struct repository *repo)
1899 struct config_options opts;
1901 opts.respect_includes = 1;
1902 opts.commondir = repo->commondir;
1903 opts.git_dir = repo->gitdir;
1905 if (!repo->config)
1906 repo->config = xcalloc(1, sizeof(struct config_set));
1907 else
1908 git_configset_clear(repo->config);
1910 git_configset_init(repo->config);
1912 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
1914 * config_with_options() normally returns only
1915 * zero, as most errors are fatal, and
1916 * non-fatal potential errors are guarded by "if"
1917 * statements that are entered only when no error is
1918 * possible.
1920 * If we ever encounter a non-fatal error, it means
1921 * something went really wrong and we should stop
1922 * immediately.
1924 die(_("unknown error occurred while reading the configuration files"));
1927 static void git_config_check_init(struct repository *repo)
1929 if (repo->config && repo->config->hash_initialized)
1930 return;
1931 repo_read_config(repo);
1934 static void repo_config_clear(struct repository *repo)
1936 if (!repo->config || !repo->config->hash_initialized)
1937 return;
1938 git_configset_clear(repo->config);
1941 void repo_config(struct repository *repo, config_fn_t fn, void *data)
1943 git_config_check_init(repo);
1944 configset_iter(repo->config, fn, data);
1947 int repo_config_get_value(struct repository *repo,
1948 const char *key, const char **value)
1950 git_config_check_init(repo);
1951 return git_configset_get_value(repo->config, key, value);
1954 const struct string_list *repo_config_get_value_multi(struct repository *repo,
1955 const char *key)
1957 git_config_check_init(repo);
1958 return git_configset_get_value_multi(repo->config, key);
1961 int repo_config_get_string_const(struct repository *repo,
1962 const char *key, const char **dest)
1964 int ret;
1965 git_config_check_init(repo);
1966 ret = git_configset_get_string_const(repo->config, key, dest);
1967 if (ret < 0)
1968 git_die_config(key, NULL);
1969 return ret;
1972 int repo_config_get_string(struct repository *repo,
1973 const char *key, char **dest)
1975 git_config_check_init(repo);
1976 return repo_config_get_string_const(repo, key, (const char **)dest);
1979 int repo_config_get_int(struct repository *repo,
1980 const char *key, int *dest)
1982 git_config_check_init(repo);
1983 return git_configset_get_int(repo->config, key, dest);
1986 int repo_config_get_ulong(struct repository *repo,
1987 const char *key, unsigned long *dest)
1989 git_config_check_init(repo);
1990 return git_configset_get_ulong(repo->config, key, dest);
1993 int repo_config_get_bool(struct repository *repo,
1994 const char *key, int *dest)
1996 git_config_check_init(repo);
1997 return git_configset_get_bool(repo->config, key, dest);
2000 int repo_config_get_bool_or_int(struct repository *repo,
2001 const char *key, int *is_bool, int *dest)
2003 git_config_check_init(repo);
2004 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2007 int repo_config_get_maybe_bool(struct repository *repo,
2008 const char *key, int *dest)
2010 git_config_check_init(repo);
2011 return git_configset_get_maybe_bool(repo->config, key, dest);
2014 int repo_config_get_pathname(struct repository *repo,
2015 const char *key, const char **dest)
2017 int ret;
2018 git_config_check_init(repo);
2019 ret = git_configset_get_pathname(repo->config, key, dest);
2020 if (ret < 0)
2021 git_die_config(key, NULL);
2022 return ret;
2025 /* Functions used historically to read configuration from 'the_repository' */
2026 void git_config(config_fn_t fn, void *data)
2028 repo_config(the_repository, fn, data);
2031 void git_config_clear(void)
2033 repo_config_clear(the_repository);
2036 int git_config_get_value(const char *key, const char **value)
2038 return repo_config_get_value(the_repository, key, value);
2041 const struct string_list *git_config_get_value_multi(const char *key)
2043 return repo_config_get_value_multi(the_repository, key);
2046 int git_config_get_string_const(const char *key, const char **dest)
2048 return repo_config_get_string_const(the_repository, key, dest);
2051 int git_config_get_string(const char *key, char **dest)
2053 return repo_config_get_string(the_repository, key, dest);
2056 int git_config_get_int(const char *key, int *dest)
2058 return repo_config_get_int(the_repository, key, dest);
2061 int git_config_get_ulong(const char *key, unsigned long *dest)
2063 return repo_config_get_ulong(the_repository, key, dest);
2066 int git_config_get_bool(const char *key, int *dest)
2068 return repo_config_get_bool(the_repository, key, dest);
2071 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2073 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2076 int git_config_get_maybe_bool(const char *key, int *dest)
2078 return repo_config_get_maybe_bool(the_repository, key, dest);
2081 int git_config_get_pathname(const char *key, const char **dest)
2083 return repo_config_get_pathname(the_repository, key, dest);
2087 * Note: This function exists solely to maintain backward compatibility with
2088 * 'fetch' and 'update_clone' storing configuration in '.gitmodules' and should
2089 * NOT be used anywhere else.
2091 * Runs the provided config function on the '.gitmodules' file found in the
2092 * working directory.
2094 void config_from_gitmodules(config_fn_t fn, void *data)
2096 if (the_repository->worktree) {
2097 char *file = repo_worktree_path(the_repository, GITMODULES_FILE);
2098 git_config_from_file(fn, file, data);
2099 free(file);
2103 int git_config_get_expiry(const char *key, const char **output)
2105 int ret = git_config_get_string_const(key, output);
2106 if (ret)
2107 return ret;
2108 if (strcmp(*output, "now")) {
2109 timestamp_t now = approxidate("now");
2110 if (approxidate(*output) >= now)
2111 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2113 return ret;
2116 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2118 char *expiry_string;
2119 intmax_t days;
2120 timestamp_t when;
2122 if (git_config_get_string(key, &expiry_string))
2123 return 1; /* no such thing */
2125 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2126 const int scale = 86400;
2127 *expiry = now - days * scale;
2128 return 0;
2131 if (!parse_expiry_date(expiry_string, &when)) {
2132 *expiry = when;
2133 return 0;
2135 return -1; /* thing exists but cannot be parsed */
2138 int git_config_get_untracked_cache(void)
2140 int val = -1;
2141 const char *v;
2143 /* Hack for test programs like test-dump-untracked-cache */
2144 if (ignore_untracked_cache_config)
2145 return -1;
2147 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2148 return val;
2150 if (!git_config_get_value("core.untrackedcache", &v)) {
2151 if (!strcasecmp(v, "keep"))
2152 return -1;
2154 error(_("unknown core.untrackedCache value '%s'; "
2155 "using 'keep' default value"), v);
2156 return -1;
2159 return -1; /* default value */
2162 int git_config_get_split_index(void)
2164 int val;
2166 if (!git_config_get_maybe_bool("core.splitindex", &val))
2167 return val;
2169 return -1; /* default value */
2172 int git_config_get_max_percent_split_change(void)
2174 int val = -1;
2176 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2177 if (0 <= val && val <= 100)
2178 return val;
2180 return error(_("splitIndex.maxPercentChange value '%d' "
2181 "should be between 0 and 100"), val);
2184 return -1; /* default value */
2187 int git_config_get_fsmonitor(void)
2189 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2190 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2192 if (core_fsmonitor && !*core_fsmonitor)
2193 core_fsmonitor = NULL;
2195 if (core_fsmonitor)
2196 return 1;
2198 return 0;
2201 NORETURN
2202 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2204 if (!filename)
2205 die(_("unable to parse '%s' from command-line config"), key);
2206 else
2207 die(_("bad config variable '%s' in file '%s' at line %d"),
2208 key, filename, linenr);
2211 NORETURN __attribute__((format(printf, 2, 3)))
2212 void git_die_config(const char *key, const char *err, ...)
2214 const struct string_list *values;
2215 struct key_value_info *kv_info;
2217 if (err) {
2218 va_list params;
2219 va_start(params, err);
2220 vreportf("error: ", err, params);
2221 va_end(params);
2223 values = git_config_get_value_multi(key);
2224 kv_info = values->items[values->nr - 1].util;
2225 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2229 * Find all the stuff for git_config_set() below.
2232 static struct {
2233 int baselen;
2234 char *key;
2235 int do_not_match;
2236 regex_t *value_regex;
2237 int multi_replace;
2238 size_t *offset;
2239 unsigned int offset_alloc;
2240 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2241 unsigned int seen;
2242 } store;
2244 static int matches(const char *key, const char *value)
2246 if (strcmp(key, store.key))
2247 return 0; /* not ours */
2248 if (!store.value_regex)
2249 return 1; /* always matches */
2250 if (store.value_regex == CONFIG_REGEX_NONE)
2251 return 0; /* never matches */
2253 return store.do_not_match ^
2254 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2257 static int store_aux(const char *key, const char *value, void *cb)
2259 const char *ep;
2260 size_t section_len;
2262 switch (store.state) {
2263 case KEY_SEEN:
2264 if (matches(key, value)) {
2265 if (store.seen == 1 && store.multi_replace == 0) {
2266 warning(_("%s has multiple values"), key);
2269 ALLOC_GROW(store.offset, store.seen + 1,
2270 store.offset_alloc);
2272 store.offset[store.seen] = cf->do_ftell(cf);
2273 store.seen++;
2275 break;
2276 case SECTION_SEEN:
2278 * What we are looking for is in store.key (both
2279 * section and var), and its section part is baselen
2280 * long. We found key (again, both section and var).
2281 * We would want to know if this key is in the same
2282 * section as what we are looking for. We already
2283 * know we are in the same section as what should
2284 * hold store.key.
2286 ep = strrchr(key, '.');
2287 section_len = ep - key;
2289 if ((section_len != store.baselen) ||
2290 memcmp(key, store.key, section_len+1)) {
2291 store.state = SECTION_END_SEEN;
2292 break;
2296 * Do not increment matches: this is no match, but we
2297 * just made sure we are in the desired section.
2299 ALLOC_GROW(store.offset, store.seen + 1,
2300 store.offset_alloc);
2301 store.offset[store.seen] = cf->do_ftell(cf);
2302 /* fallthru */
2303 case SECTION_END_SEEN:
2304 case START:
2305 if (matches(key, value)) {
2306 ALLOC_GROW(store.offset, store.seen + 1,
2307 store.offset_alloc);
2308 store.offset[store.seen] = cf->do_ftell(cf);
2309 store.state = KEY_SEEN;
2310 store.seen++;
2311 } else {
2312 if (strrchr(key, '.') - key == store.baselen &&
2313 !strncmp(key, store.key, store.baselen)) {
2314 store.state = SECTION_SEEN;
2315 ALLOC_GROW(store.offset,
2316 store.seen + 1,
2317 store.offset_alloc);
2318 store.offset[store.seen] = cf->do_ftell(cf);
2322 return 0;
2325 static int write_error(const char *filename)
2327 error("failed to write new configuration file %s", filename);
2329 /* Same error code as "failed to rename". */
2330 return 4;
2333 static struct strbuf store_create_section(const char *key)
2335 const char *dot;
2336 int i;
2337 struct strbuf sb = STRBUF_INIT;
2339 dot = memchr(key, '.', store.baselen);
2340 if (dot) {
2341 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2342 for (i = dot - key + 1; i < store.baselen; i++) {
2343 if (key[i] == '"' || key[i] == '\\')
2344 strbuf_addch(&sb, '\\');
2345 strbuf_addch(&sb, key[i]);
2347 strbuf_addstr(&sb, "\"]\n");
2348 } else {
2349 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2352 return sb;
2355 static ssize_t write_section(int fd, const char *key)
2357 struct strbuf sb = store_create_section(key);
2358 ssize_t ret;
2360 ret = write_in_full(fd, sb.buf, sb.len);
2361 strbuf_release(&sb);
2363 return ret;
2366 static ssize_t write_pair(int fd, const char *key, const char *value)
2368 int i;
2369 ssize_t ret;
2370 int length = strlen(key + store.baselen + 1);
2371 const char *quote = "";
2372 struct strbuf sb = STRBUF_INIT;
2375 * Check to see if the value needs to be surrounded with a dq pair.
2376 * Note that problematic characters are always backslash-quoted; this
2377 * check is about not losing leading or trailing SP and strings that
2378 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2379 * configuration parser.
2381 if (value[0] == ' ')
2382 quote = "\"";
2383 for (i = 0; value[i]; i++)
2384 if (value[i] == ';' || value[i] == '#')
2385 quote = "\"";
2386 if (i && value[i - 1] == ' ')
2387 quote = "\"";
2389 strbuf_addf(&sb, "\t%.*s = %s",
2390 length, key + store.baselen + 1, quote);
2392 for (i = 0; value[i]; i++)
2393 switch (value[i]) {
2394 case '\n':
2395 strbuf_addstr(&sb, "\\n");
2396 break;
2397 case '\t':
2398 strbuf_addstr(&sb, "\\t");
2399 break;
2400 case '"':
2401 case '\\':
2402 strbuf_addch(&sb, '\\');
2403 /* fallthrough */
2404 default:
2405 strbuf_addch(&sb, value[i]);
2406 break;
2408 strbuf_addf(&sb, "%s\n", quote);
2410 ret = write_in_full(fd, sb.buf, sb.len);
2411 strbuf_release(&sb);
2413 return ret;
2416 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2417 size_t offset_, int *found_bracket)
2419 size_t equal_offset = size, bracket_offset = size;
2420 ssize_t offset;
2422 contline:
2423 for (offset = offset_-2; offset > 0
2424 && contents[offset] != '\n'; offset--)
2425 switch (contents[offset]) {
2426 case '=': equal_offset = offset; break;
2427 case ']': bracket_offset = offset; break;
2429 if (offset > 0 && contents[offset-1] == '\\') {
2430 offset_ = offset;
2431 goto contline;
2433 if (bracket_offset < equal_offset) {
2434 *found_bracket = 1;
2435 offset = bracket_offset+1;
2436 } else
2437 offset++;
2439 return offset;
2442 int git_config_set_in_file_gently(const char *config_filename,
2443 const char *key, const char *value)
2445 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2448 void git_config_set_in_file(const char *config_filename,
2449 const char *key, const char *value)
2451 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2454 int git_config_set_gently(const char *key, const char *value)
2456 return git_config_set_multivar_gently(key, value, NULL, 0);
2459 void git_config_set(const char *key, const char *value)
2461 git_config_set_multivar(key, value, NULL, 0);
2465 * If value==NULL, unset in (remove from) config,
2466 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2467 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2468 * (only add a new one)
2469 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2470 * else all matching key/values (regardless how many) are removed,
2471 * before the new pair is written.
2473 * Returns 0 on success.
2475 * This function does this:
2477 * - it locks the config file by creating ".git/config.lock"
2479 * - it then parses the config using store_aux() as validator to find
2480 * the position on the key/value pair to replace. If it is to be unset,
2481 * it must be found exactly once.
2483 * - the config file is mmap()ed and the part before the match (if any) is
2484 * written to the lock file, then the changed part and the rest.
2486 * - the config file is removed and the lock file rename()d to it.
2489 int git_config_set_multivar_in_file_gently(const char *config_filename,
2490 const char *key, const char *value,
2491 const char *value_regex,
2492 int multi_replace)
2494 int fd = -1, in_fd = -1;
2495 int ret;
2496 struct lock_file lock = LOCK_INIT;
2497 char *filename_buf = NULL;
2498 char *contents = NULL;
2499 size_t contents_sz;
2501 /* parse-key returns negative; flip the sign to feed exit(3) */
2502 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2503 if (ret)
2504 goto out_free;
2506 store.multi_replace = multi_replace;
2508 if (!config_filename)
2509 config_filename = filename_buf = git_pathdup("config");
2512 * The lock serves a purpose in addition to locking: the new
2513 * contents of .git/config will be written into it.
2515 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2516 if (fd < 0) {
2517 error_errno("could not lock config file %s", config_filename);
2518 free(store.key);
2519 ret = CONFIG_NO_LOCK;
2520 goto out_free;
2524 * If .git/config does not exist yet, write a minimal version.
2526 in_fd = open(config_filename, O_RDONLY);
2527 if ( in_fd < 0 ) {
2528 free(store.key);
2530 if ( ENOENT != errno ) {
2531 error_errno("opening %s", config_filename);
2532 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2533 goto out_free;
2535 /* if nothing to unset, error out */
2536 if (value == NULL) {
2537 ret = CONFIG_NOTHING_SET;
2538 goto out_free;
2541 store.key = (char *)key;
2542 if (write_section(fd, key) < 0 ||
2543 write_pair(fd, key, value) < 0)
2544 goto write_err_out;
2545 } else {
2546 struct stat st;
2547 size_t copy_begin, copy_end;
2548 int i, new_line = 0;
2550 if (value_regex == NULL)
2551 store.value_regex = NULL;
2552 else if (value_regex == CONFIG_REGEX_NONE)
2553 store.value_regex = CONFIG_REGEX_NONE;
2554 else {
2555 if (value_regex[0] == '!') {
2556 store.do_not_match = 1;
2557 value_regex++;
2558 } else
2559 store.do_not_match = 0;
2561 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2562 if (regcomp(store.value_regex, value_regex,
2563 REG_EXTENDED)) {
2564 error("invalid pattern: %s", value_regex);
2565 free(store.value_regex);
2566 ret = CONFIG_INVALID_PATTERN;
2567 goto out_free;
2571 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2572 store.offset[0] = 0;
2573 store.state = START;
2574 store.seen = 0;
2577 * After this, store.offset will contain the *end* offset
2578 * of the last match, or remain at 0 if no match was found.
2579 * As a side effect, we make sure to transform only a valid
2580 * existing config file.
2582 if (git_config_from_file(store_aux, config_filename, NULL)) {
2583 error("invalid config file %s", config_filename);
2584 free(store.key);
2585 if (store.value_regex != NULL &&
2586 store.value_regex != CONFIG_REGEX_NONE) {
2587 regfree(store.value_regex);
2588 free(store.value_regex);
2590 ret = CONFIG_INVALID_FILE;
2591 goto out_free;
2594 free(store.key);
2595 if (store.value_regex != NULL &&
2596 store.value_regex != CONFIG_REGEX_NONE) {
2597 regfree(store.value_regex);
2598 free(store.value_regex);
2601 /* if nothing to unset, or too many matches, error out */
2602 if ((store.seen == 0 && value == NULL) ||
2603 (store.seen > 1 && multi_replace == 0)) {
2604 ret = CONFIG_NOTHING_SET;
2605 goto out_free;
2608 if (fstat(in_fd, &st) == -1) {
2609 error_errno(_("fstat on %s failed"), config_filename);
2610 ret = CONFIG_INVALID_FILE;
2611 goto out_free;
2614 contents_sz = xsize_t(st.st_size);
2615 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2616 MAP_PRIVATE, in_fd, 0);
2617 if (contents == MAP_FAILED) {
2618 if (errno == ENODEV && S_ISDIR(st.st_mode))
2619 errno = EISDIR;
2620 error_errno("unable to mmap '%s'", config_filename);
2621 ret = CONFIG_INVALID_FILE;
2622 contents = NULL;
2623 goto out_free;
2625 close(in_fd);
2626 in_fd = -1;
2628 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2629 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2630 ret = CONFIG_NO_WRITE;
2631 goto out_free;
2634 if (store.seen == 0)
2635 store.seen = 1;
2637 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2638 if (store.offset[i] == 0) {
2639 store.offset[i] = copy_end = contents_sz;
2640 } else if (store.state != KEY_SEEN) {
2641 copy_end = store.offset[i];
2642 } else
2643 copy_end = find_beginning_of_line(
2644 contents, contents_sz,
2645 store.offset[i]-2, &new_line);
2647 if (copy_end > 0 && contents[copy_end-1] != '\n')
2648 new_line = 1;
2650 /* write the first part of the config */
2651 if (copy_end > copy_begin) {
2652 if (write_in_full(fd, contents + copy_begin,
2653 copy_end - copy_begin) < 0)
2654 goto write_err_out;
2655 if (new_line &&
2656 write_str_in_full(fd, "\n") < 0)
2657 goto write_err_out;
2659 copy_begin = store.offset[i];
2662 /* write the pair (value == NULL means unset) */
2663 if (value != NULL) {
2664 if (store.state == START) {
2665 if (write_section(fd, key) < 0)
2666 goto write_err_out;
2668 if (write_pair(fd, key, value) < 0)
2669 goto write_err_out;
2672 /* write the rest of the config */
2673 if (copy_begin < contents_sz)
2674 if (write_in_full(fd, contents + copy_begin,
2675 contents_sz - copy_begin) < 0)
2676 goto write_err_out;
2678 munmap(contents, contents_sz);
2679 contents = NULL;
2682 if (commit_lock_file(&lock) < 0) {
2683 error_errno("could not write config file %s", config_filename);
2684 ret = CONFIG_NO_WRITE;
2685 goto out_free;
2688 ret = 0;
2690 /* Invalidate the config cache */
2691 git_config_clear();
2693 out_free:
2694 rollback_lock_file(&lock);
2695 free(filename_buf);
2696 if (contents)
2697 munmap(contents, contents_sz);
2698 if (in_fd >= 0)
2699 close(in_fd);
2700 return ret;
2702 write_err_out:
2703 ret = write_error(get_lock_file_path(&lock));
2704 goto out_free;
2708 void git_config_set_multivar_in_file(const char *config_filename,
2709 const char *key, const char *value,
2710 const char *value_regex, int multi_replace)
2712 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2713 value_regex, multi_replace))
2714 return;
2715 if (value)
2716 die(_("could not set '%s' to '%s'"), key, value);
2717 else
2718 die(_("could not unset '%s'"), key);
2721 int git_config_set_multivar_gently(const char *key, const char *value,
2722 const char *value_regex, int multi_replace)
2724 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2725 multi_replace);
2728 void git_config_set_multivar(const char *key, const char *value,
2729 const char *value_regex, int multi_replace)
2731 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2732 multi_replace);
2735 static int section_name_match (const char *buf, const char *name)
2737 int i = 0, j = 0, dot = 0;
2738 if (buf[i] != '[')
2739 return 0;
2740 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2741 if (!dot && isspace(buf[i])) {
2742 dot = 1;
2743 if (name[j++] != '.')
2744 break;
2745 for (i++; isspace(buf[i]); i++)
2746 ; /* do nothing */
2747 if (buf[i] != '"')
2748 break;
2749 continue;
2751 if (buf[i] == '\\' && dot)
2752 i++;
2753 else if (buf[i] == '"' && dot) {
2754 for (i++; isspace(buf[i]); i++)
2755 ; /* do_nothing */
2756 break;
2758 if (buf[i] != name[j++])
2759 break;
2761 if (buf[i] == ']' && name[j] == 0) {
2763 * We match, now just find the right length offset by
2764 * gobbling up any whitespace after it, as well
2766 i++;
2767 for (; buf[i] && isspace(buf[i]); i++)
2768 ; /* do nothing */
2769 return i;
2771 return 0;
2774 static int section_name_is_ok(const char *name)
2776 /* Empty section names are bogus. */
2777 if (!*name)
2778 return 0;
2781 * Before a dot, we must be alphanumeric or dash. After the first dot,
2782 * anything goes, so we can stop checking.
2784 for (; *name && *name != '.'; name++)
2785 if (*name != '-' && !isalnum(*name))
2786 return 0;
2787 return 1;
2790 /* if new_name == NULL, the section is removed instead */
2791 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
2792 const char *old_name, const char *new_name, int copy)
2794 int ret = 0, remove = 0;
2795 char *filename_buf = NULL;
2796 struct lock_file lock = LOCK_INIT;
2797 int out_fd;
2798 char buf[1024];
2799 FILE *config_file = NULL;
2800 struct stat st;
2801 struct strbuf copystr = STRBUF_INIT;
2803 if (new_name && !section_name_is_ok(new_name)) {
2804 ret = error("invalid section name: %s", new_name);
2805 goto out_no_rollback;
2808 if (!config_filename)
2809 config_filename = filename_buf = git_pathdup("config");
2811 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
2812 if (out_fd < 0) {
2813 ret = error("could not lock config file %s", config_filename);
2814 goto out;
2817 if (!(config_file = fopen(config_filename, "rb"))) {
2818 ret = warn_on_fopen_errors(config_filename);
2819 if (ret)
2820 goto out;
2821 /* no config file means nothing to rename, no error */
2822 goto commit_and_out;
2825 if (fstat(fileno(config_file), &st) == -1) {
2826 ret = error_errno(_("fstat on %s failed"), config_filename);
2827 goto out;
2830 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2831 ret = error_errno("chmod on %s failed",
2832 get_lock_file_path(&lock));
2833 goto out;
2836 while (fgets(buf, sizeof(buf), config_file)) {
2837 int i;
2838 int length;
2839 int is_section = 0;
2840 char *output = buf;
2841 for (i = 0; buf[i] && isspace(buf[i]); i++)
2842 ; /* do nothing */
2843 if (buf[i] == '[') {
2844 /* it's a section */
2845 int offset;
2846 is_section = 1;
2849 * When encountering a new section under -c we
2850 * need to flush out any section we're already
2851 * coping and begin anew. There might be
2852 * multiple [branch "$name"] sections.
2854 if (copystr.len > 0) {
2855 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
2856 ret = write_error(get_lock_file_path(&lock));
2857 goto out;
2859 strbuf_reset(&copystr);
2862 offset = section_name_match(&buf[i], old_name);
2863 if (offset > 0) {
2864 ret++;
2865 if (new_name == NULL) {
2866 remove = 1;
2867 continue;
2869 store.baselen = strlen(new_name);
2870 if (!copy) {
2871 if (write_section(out_fd, new_name) < 0) {
2872 ret = write_error(get_lock_file_path(&lock));
2873 goto out;
2876 * We wrote out the new section, with
2877 * a newline, now skip the old
2878 * section's length
2880 output += offset + i;
2881 if (strlen(output) > 0) {
2883 * More content means there's
2884 * a declaration to put on the
2885 * next line; indent with a
2886 * tab
2888 output -= 1;
2889 output[0] = '\t';
2891 } else {
2892 copystr = store_create_section(new_name);
2895 remove = 0;
2897 if (remove)
2898 continue;
2899 length = strlen(output);
2901 if (!is_section && copystr.len > 0) {
2902 strbuf_add(&copystr, output, length);
2905 if (write_in_full(out_fd, output, length) < 0) {
2906 ret = write_error(get_lock_file_path(&lock));
2907 goto out;
2912 * Copy a trailing section at the end of the config, won't be
2913 * flushed by the usual "flush because we have a new section
2914 * logic in the loop above.
2916 if (copystr.len > 0) {
2917 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
2918 ret = write_error(get_lock_file_path(&lock));
2919 goto out;
2921 strbuf_reset(&copystr);
2924 fclose(config_file);
2925 config_file = NULL;
2926 commit_and_out:
2927 if (commit_lock_file(&lock) < 0)
2928 ret = error_errno("could not write config file %s",
2929 config_filename);
2930 out:
2931 if (config_file)
2932 fclose(config_file);
2933 rollback_lock_file(&lock);
2934 out_no_rollback:
2935 free(filename_buf);
2936 return ret;
2939 int git_config_rename_section_in_file(const char *config_filename,
2940 const char *old_name, const char *new_name)
2942 return git_config_copy_or_rename_section_in_file(config_filename,
2943 old_name, new_name, 0);
2946 int git_config_rename_section(const char *old_name, const char *new_name)
2948 return git_config_rename_section_in_file(NULL, old_name, new_name);
2951 int git_config_copy_section_in_file(const char *config_filename,
2952 const char *old_name, const char *new_name)
2954 return git_config_copy_or_rename_section_in_file(config_filename,
2955 old_name, new_name, 1);
2958 int git_config_copy_section(const char *old_name, const char *new_name)
2960 return git_config_copy_section_in_file(NULL, old_name, new_name);
2964 * Call this to report error for your variable that should not
2965 * get a boolean value (i.e. "[my] var" means "true").
2967 #undef config_error_nonbool
2968 int config_error_nonbool(const char *var)
2970 return error("missing value for '%s'", var);
2973 int parse_config_key(const char *var,
2974 const char *section,
2975 const char **subsection, int *subsection_len,
2976 const char **key)
2978 const char *dot;
2980 /* Does it start with "section." ? */
2981 if (!skip_prefix(var, section, &var) || *var != '.')
2982 return -1;
2985 * Find the key; we don't know yet if we have a subsection, but we must
2986 * parse backwards from the end, since the subsection may have dots in
2987 * it, too.
2989 dot = strrchr(var, '.');
2990 *key = dot + 1;
2992 /* Did we have a subsection at all? */
2993 if (dot == var) {
2994 if (subsection) {
2995 *subsection = NULL;
2996 *subsection_len = 0;
2999 else {
3000 if (!subsection)
3001 return -1;
3002 *subsection = var + 1;
3003 *subsection_len = dot - *subsection;
3006 return 0;
3009 const char *current_config_origin_type(void)
3011 int type;
3012 if (current_config_kvi)
3013 type = current_config_kvi->origin_type;
3014 else if(cf)
3015 type = cf->origin_type;
3016 else
3017 die("BUG: current_config_origin_type called outside config callback");
3019 switch (type) {
3020 case CONFIG_ORIGIN_BLOB:
3021 return "blob";
3022 case CONFIG_ORIGIN_FILE:
3023 return "file";
3024 case CONFIG_ORIGIN_STDIN:
3025 return "standard input";
3026 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3027 return "submodule-blob";
3028 case CONFIG_ORIGIN_CMDLINE:
3029 return "command line";
3030 default:
3031 die("BUG: unknown config origin type");
3035 const char *current_config_name(void)
3037 const char *name;
3038 if (current_config_kvi)
3039 name = current_config_kvi->filename;
3040 else if (cf)
3041 name = cf->name;
3042 else
3043 die("BUG: current_config_name called outside config callback");
3044 return name ? name : "";
3047 enum config_scope current_config_scope(void)
3049 if (current_config_kvi)
3050 return current_config_kvi->scope;
3051 else
3052 return current_parsing_scope;