Merge branch 'sb/branch-avoid-repeated-strbuf-release' into maint
[git/debian.git] / config.c
blobc138c0ba055bcec33f3a78a5a2227d2ce6cfa4e3
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 int git_parse_maybe_bool(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_config_maybe_bool(const char *name, const char *value)
951 int v = git_parse_maybe_bool(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(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 static int git_default_core_config(const char *var, const char *value)
996 /* This needs a better name */
997 if (!strcmp(var, "core.filemode")) {
998 trust_executable_bit = git_config_bool(var, value);
999 return 0;
1001 if (!strcmp(var, "core.trustctime")) {
1002 trust_ctime = git_config_bool(var, value);
1003 return 0;
1005 if (!strcmp(var, "core.checkstat")) {
1006 if (!strcasecmp(value, "default"))
1007 check_stat = 1;
1008 else if (!strcasecmp(value, "minimal"))
1009 check_stat = 0;
1012 if (!strcmp(var, "core.quotepath")) {
1013 quote_path_fully = git_config_bool(var, value);
1014 return 0;
1017 if (!strcmp(var, "core.symlinks")) {
1018 has_symlinks = git_config_bool(var, value);
1019 return 0;
1022 if (!strcmp(var, "core.ignorecase")) {
1023 ignore_case = git_config_bool(var, value);
1024 return 0;
1027 if (!strcmp(var, "core.attributesfile"))
1028 return git_config_pathname(&git_attributes_file, var, value);
1030 if (!strcmp(var, "core.hookspath"))
1031 return git_config_pathname(&git_hooks_path, var, value);
1033 if (!strcmp(var, "core.bare")) {
1034 is_bare_repository_cfg = git_config_bool(var, value);
1035 return 0;
1038 if (!strcmp(var, "core.ignorestat")) {
1039 assume_unchanged = git_config_bool(var, value);
1040 return 0;
1043 if (!strcmp(var, "core.prefersymlinkrefs")) {
1044 prefer_symlink_refs = git_config_bool(var, value);
1045 return 0;
1048 if (!strcmp(var, "core.logallrefupdates")) {
1049 if (value && !strcasecmp(value, "always"))
1050 log_all_ref_updates = LOG_REFS_ALWAYS;
1051 else if (git_config_bool(var, value))
1052 log_all_ref_updates = LOG_REFS_NORMAL;
1053 else
1054 log_all_ref_updates = LOG_REFS_NONE;
1055 return 0;
1058 if (!strcmp(var, "core.warnambiguousrefs")) {
1059 warn_ambiguous_refs = git_config_bool(var, value);
1060 return 0;
1063 if (!strcmp(var, "core.abbrev")) {
1064 if (!value)
1065 return config_error_nonbool(var);
1066 if (!strcasecmp(value, "auto"))
1067 default_abbrev = -1;
1068 else {
1069 int abbrev = git_config_int(var, value);
1070 if (abbrev < minimum_abbrev || abbrev > 40)
1071 return error("abbrev length out of range: %d", abbrev);
1072 default_abbrev = abbrev;
1074 return 0;
1077 if (!strcmp(var, "core.disambiguate"))
1078 return set_disambiguate_hint_config(var, value);
1080 if (!strcmp(var, "core.loosecompression")) {
1081 int level = git_config_int(var, value);
1082 if (level == -1)
1083 level = Z_DEFAULT_COMPRESSION;
1084 else if (level < 0 || level > Z_BEST_COMPRESSION)
1085 die(_("bad zlib compression level %d"), level);
1086 zlib_compression_level = level;
1087 zlib_compression_seen = 1;
1088 return 0;
1091 if (!strcmp(var, "core.compression")) {
1092 int level = git_config_int(var, value);
1093 if (level == -1)
1094 level = Z_DEFAULT_COMPRESSION;
1095 else if (level < 0 || level > Z_BEST_COMPRESSION)
1096 die(_("bad zlib compression level %d"), level);
1097 core_compression_level = level;
1098 core_compression_seen = 1;
1099 if (!zlib_compression_seen)
1100 zlib_compression_level = level;
1101 if (!pack_compression_seen)
1102 pack_compression_level = level;
1103 return 0;
1106 if (!strcmp(var, "core.packedgitwindowsize")) {
1107 int pgsz_x2 = getpagesize() * 2;
1108 packed_git_window_size = git_config_ulong(var, value);
1110 /* This value must be multiple of (pagesize * 2) */
1111 packed_git_window_size /= pgsz_x2;
1112 if (packed_git_window_size < 1)
1113 packed_git_window_size = 1;
1114 packed_git_window_size *= pgsz_x2;
1115 return 0;
1118 if (!strcmp(var, "core.bigfilethreshold")) {
1119 big_file_threshold = git_config_ulong(var, value);
1120 return 0;
1123 if (!strcmp(var, "core.packedgitlimit")) {
1124 packed_git_limit = git_config_ulong(var, value);
1125 return 0;
1128 if (!strcmp(var, "core.deltabasecachelimit")) {
1129 delta_base_cache_limit = git_config_ulong(var, value);
1130 return 0;
1133 if (!strcmp(var, "core.autocrlf")) {
1134 if (value && !strcasecmp(value, "input")) {
1135 auto_crlf = AUTO_CRLF_INPUT;
1136 return 0;
1138 auto_crlf = git_config_bool(var, value);
1139 return 0;
1142 if (!strcmp(var, "core.safecrlf")) {
1143 if (value && !strcasecmp(value, "warn")) {
1144 safe_crlf = SAFE_CRLF_WARN;
1145 return 0;
1147 safe_crlf = git_config_bool(var, value);
1148 return 0;
1151 if (!strcmp(var, "core.eol")) {
1152 if (value && !strcasecmp(value, "lf"))
1153 core_eol = EOL_LF;
1154 else if (value && !strcasecmp(value, "crlf"))
1155 core_eol = EOL_CRLF;
1156 else if (value && !strcasecmp(value, "native"))
1157 core_eol = EOL_NATIVE;
1158 else
1159 core_eol = EOL_UNSET;
1160 return 0;
1163 if (!strcmp(var, "core.notesref")) {
1164 notes_ref_name = xstrdup(value);
1165 return 0;
1168 if (!strcmp(var, "core.editor"))
1169 return git_config_string(&editor_program, var, value);
1171 if (!strcmp(var, "core.commentchar")) {
1172 if (!value)
1173 return config_error_nonbool(var);
1174 else if (!strcasecmp(value, "auto"))
1175 auto_comment_line_char = 1;
1176 else if (value[0] && !value[1]) {
1177 comment_line_char = value[0];
1178 auto_comment_line_char = 0;
1179 } else
1180 return error("core.commentChar should only be one character");
1181 return 0;
1184 if (!strcmp(var, "core.askpass"))
1185 return git_config_string(&askpass_program, var, value);
1187 if (!strcmp(var, "core.excludesfile"))
1188 return git_config_pathname(&excludes_file, var, value);
1190 if (!strcmp(var, "core.whitespace")) {
1191 if (!value)
1192 return config_error_nonbool(var);
1193 whitespace_rule_cfg = parse_whitespace_rule(value);
1194 return 0;
1197 if (!strcmp(var, "core.fsyncobjectfiles")) {
1198 fsync_object_files = git_config_bool(var, value);
1199 return 0;
1202 if (!strcmp(var, "core.preloadindex")) {
1203 core_preload_index = git_config_bool(var, value);
1204 return 0;
1207 if (!strcmp(var, "core.createobject")) {
1208 if (!strcmp(value, "rename"))
1209 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1210 else if (!strcmp(value, "link"))
1211 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1212 else
1213 die(_("invalid mode for object creation: %s"), value);
1214 return 0;
1217 if (!strcmp(var, "core.sparsecheckout")) {
1218 core_apply_sparse_checkout = git_config_bool(var, value);
1219 return 0;
1222 if (!strcmp(var, "core.precomposeunicode")) {
1223 precomposed_unicode = git_config_bool(var, value);
1224 return 0;
1227 if (!strcmp(var, "core.protecthfs")) {
1228 protect_hfs = git_config_bool(var, value);
1229 return 0;
1232 if (!strcmp(var, "core.protectntfs")) {
1233 protect_ntfs = git_config_bool(var, value);
1234 return 0;
1237 if (!strcmp(var, "core.hidedotfiles")) {
1238 if (value && !strcasecmp(value, "dotgitonly"))
1239 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1240 else
1241 hide_dotfiles = git_config_bool(var, value);
1242 return 0;
1245 /* Add other config variables here and to Documentation/config.txt. */
1246 return 0;
1249 static int git_default_i18n_config(const char *var, const char *value)
1251 if (!strcmp(var, "i18n.commitencoding"))
1252 return git_config_string(&git_commit_encoding, var, value);
1254 if (!strcmp(var, "i18n.logoutputencoding"))
1255 return git_config_string(&git_log_output_encoding, var, value);
1257 /* Add other config variables here and to Documentation/config.txt. */
1258 return 0;
1261 static int git_default_branch_config(const char *var, const char *value)
1263 if (!strcmp(var, "branch.autosetupmerge")) {
1264 if (value && !strcasecmp(value, "always")) {
1265 git_branch_track = BRANCH_TRACK_ALWAYS;
1266 return 0;
1268 git_branch_track = git_config_bool(var, value);
1269 return 0;
1271 if (!strcmp(var, "branch.autosetuprebase")) {
1272 if (!value)
1273 return config_error_nonbool(var);
1274 else if (!strcmp(value, "never"))
1275 autorebase = AUTOREBASE_NEVER;
1276 else if (!strcmp(value, "local"))
1277 autorebase = AUTOREBASE_LOCAL;
1278 else if (!strcmp(value, "remote"))
1279 autorebase = AUTOREBASE_REMOTE;
1280 else if (!strcmp(value, "always"))
1281 autorebase = AUTOREBASE_ALWAYS;
1282 else
1283 return error("malformed value for %s", var);
1284 return 0;
1287 /* Add other config variables here and to Documentation/config.txt. */
1288 return 0;
1291 static int git_default_push_config(const char *var, const char *value)
1293 if (!strcmp(var, "push.default")) {
1294 if (!value)
1295 return config_error_nonbool(var);
1296 else if (!strcmp(value, "nothing"))
1297 push_default = PUSH_DEFAULT_NOTHING;
1298 else if (!strcmp(value, "matching"))
1299 push_default = PUSH_DEFAULT_MATCHING;
1300 else if (!strcmp(value, "simple"))
1301 push_default = PUSH_DEFAULT_SIMPLE;
1302 else if (!strcmp(value, "upstream"))
1303 push_default = PUSH_DEFAULT_UPSTREAM;
1304 else if (!strcmp(value, "tracking")) /* deprecated */
1305 push_default = PUSH_DEFAULT_UPSTREAM;
1306 else if (!strcmp(value, "current"))
1307 push_default = PUSH_DEFAULT_CURRENT;
1308 else {
1309 error("malformed value for %s: %s", var, value);
1310 return error("Must be one of nothing, matching, simple, "
1311 "upstream or current.");
1313 return 0;
1316 /* Add other config variables here and to Documentation/config.txt. */
1317 return 0;
1320 static int git_default_mailmap_config(const char *var, const char *value)
1322 if (!strcmp(var, "mailmap.file"))
1323 return git_config_pathname(&git_mailmap_file, var, value);
1324 if (!strcmp(var, "mailmap.blob"))
1325 return git_config_string(&git_mailmap_blob, var, value);
1327 /* Add other config variables here and to Documentation/config.txt. */
1328 return 0;
1331 int git_default_config(const char *var, const char *value, void *dummy)
1333 if (starts_with(var, "core."))
1334 return git_default_core_config(var, value);
1336 if (starts_with(var, "user."))
1337 return git_ident_config(var, value, dummy);
1339 if (starts_with(var, "i18n."))
1340 return git_default_i18n_config(var, value);
1342 if (starts_with(var, "branch."))
1343 return git_default_branch_config(var, value);
1345 if (starts_with(var, "push."))
1346 return git_default_push_config(var, value);
1348 if (starts_with(var, "mailmap."))
1349 return git_default_mailmap_config(var, value);
1351 if (starts_with(var, "advice."))
1352 return git_default_advice_config(var, value);
1354 if (git_color_config(var, value, dummy) < 0)
1355 return -1;
1357 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1358 pager_use_color = git_config_bool(var,value);
1359 return 0;
1362 if (!strcmp(var, "pack.packsizelimit")) {
1363 pack_size_limit_cfg = git_config_ulong(var, value);
1364 return 0;
1367 if (!strcmp(var, "pack.compression")) {
1368 int level = git_config_int(var, value);
1369 if (level == -1)
1370 level = Z_DEFAULT_COMPRESSION;
1371 else if (level < 0 || level > Z_BEST_COMPRESSION)
1372 die(_("bad pack compression level %d"), level);
1373 pack_compression_level = level;
1374 pack_compression_seen = 1;
1375 return 0;
1378 /* Add other config variables here and to Documentation/config.txt. */
1379 return 0;
1383 * All source specific fields in the union, die_on_error, name and the callbacks
1384 * fgetc, ungetc, ftell of top need to be initialized before calling
1385 * this function.
1387 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1389 int ret;
1391 /* push config-file parsing state stack */
1392 top->prev = cf;
1393 top->linenr = 1;
1394 top->eof = 0;
1395 strbuf_init(&top->value, 1024);
1396 strbuf_init(&top->var, 1024);
1397 cf = top;
1399 ret = git_parse_source(fn, data);
1401 /* pop config-file parsing state stack */
1402 strbuf_release(&top->value);
1403 strbuf_release(&top->var);
1404 cf = top->prev;
1406 return ret;
1409 static int do_config_from_file(config_fn_t fn,
1410 const enum config_origin_type origin_type,
1411 const char *name, const char *path, FILE *f,
1412 void *data)
1414 struct config_source top;
1416 top.u.file = f;
1417 top.origin_type = origin_type;
1418 top.name = name;
1419 top.path = path;
1420 top.die_on_error = 1;
1421 top.do_fgetc = config_file_fgetc;
1422 top.do_ungetc = config_file_ungetc;
1423 top.do_ftell = config_file_ftell;
1425 return do_config_from(&top, fn, data);
1428 static int git_config_from_stdin(config_fn_t fn, void *data)
1430 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1433 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1435 int ret = -1;
1436 FILE *f;
1438 f = fopen_or_warn(filename, "r");
1439 if (f) {
1440 flockfile(f);
1441 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1442 funlockfile(f);
1443 fclose(f);
1445 return ret;
1448 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1449 const char *name, const char *buf, size_t len, void *data)
1451 struct config_source top;
1453 top.u.buf.buf = buf;
1454 top.u.buf.len = len;
1455 top.u.buf.pos = 0;
1456 top.origin_type = origin_type;
1457 top.name = name;
1458 top.path = NULL;
1459 top.die_on_error = 0;
1460 top.do_fgetc = config_buf_fgetc;
1461 top.do_ungetc = config_buf_ungetc;
1462 top.do_ftell = config_buf_ftell;
1464 return do_config_from(&top, fn, data);
1467 int git_config_from_blob_sha1(config_fn_t fn,
1468 const char *name,
1469 const unsigned char *sha1,
1470 void *data)
1472 enum object_type type;
1473 char *buf;
1474 unsigned long size;
1475 int ret;
1477 buf = read_sha1_file(sha1, &type, &size);
1478 if (!buf)
1479 return error("unable to load config blob object '%s'", name);
1480 if (type != OBJ_BLOB) {
1481 free(buf);
1482 return error("reference '%s' does not point to a blob", name);
1485 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1486 free(buf);
1488 return ret;
1491 static int git_config_from_blob_ref(config_fn_t fn,
1492 const char *name,
1493 void *data)
1495 unsigned char sha1[20];
1497 if (get_sha1(name, sha1) < 0)
1498 return error("unable to resolve config blob '%s'", name);
1499 return git_config_from_blob_sha1(fn, name, sha1, data);
1502 const char *git_etc_gitconfig(void)
1504 static const char *system_wide;
1505 if (!system_wide)
1506 system_wide = system_path(ETC_GITCONFIG);
1507 return system_wide;
1511 * Parse environment variable 'k' as a boolean (in various
1512 * possible spellings); if missing, use the default value 'def'.
1514 int git_env_bool(const char *k, int def)
1516 const char *v = getenv(k);
1517 return v ? git_config_bool(k, v) : def;
1521 * Parse environment variable 'k' as ulong with possibly a unit
1522 * suffix; if missing, use the default value 'val'.
1524 unsigned long git_env_ulong(const char *k, unsigned long val)
1526 const char *v = getenv(k);
1527 if (v && !git_parse_ulong(v, &val))
1528 die("failed to parse %s", k);
1529 return val;
1532 int git_config_system(void)
1534 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1537 static int do_git_config_sequence(const struct config_options *opts,
1538 config_fn_t fn, void *data)
1540 int ret = 0;
1541 char *xdg_config = xdg_config_home("config");
1542 char *user_config = expand_user_path("~/.gitconfig", 0);
1543 char *repo_config;
1545 if (opts->commondir)
1546 repo_config = mkpathdup("%s/config", opts->commondir);
1547 else
1548 repo_config = NULL;
1550 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1551 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1552 ret += git_config_from_file(fn, git_etc_gitconfig(),
1553 data);
1555 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1556 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1557 ret += git_config_from_file(fn, xdg_config, data);
1559 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1560 ret += git_config_from_file(fn, user_config, data);
1562 current_parsing_scope = CONFIG_SCOPE_REPO;
1563 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1564 ret += git_config_from_file(fn, repo_config, data);
1566 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1567 if (git_config_from_parameters(fn, data) < 0)
1568 die(_("unable to parse command-line config"));
1570 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1571 free(xdg_config);
1572 free(user_config);
1573 free(repo_config);
1574 return ret;
1577 int config_with_options(config_fn_t fn, void *data,
1578 struct git_config_source *config_source,
1579 const struct config_options *opts)
1581 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1583 if (opts->respect_includes) {
1584 inc.fn = fn;
1585 inc.data = data;
1586 inc.opts = opts;
1587 fn = git_config_include;
1588 data = &inc;
1592 * If we have a specific filename, use it. Otherwise, follow the
1593 * regular lookup sequence.
1595 if (config_source && config_source->use_stdin)
1596 return git_config_from_stdin(fn, data);
1597 else if (config_source && config_source->file)
1598 return git_config_from_file(fn, config_source->file, data);
1599 else if (config_source && config_source->blob)
1600 return git_config_from_blob_ref(fn, config_source->blob, data);
1602 return do_git_config_sequence(opts, fn, data);
1605 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1607 int i, value_index;
1608 struct string_list *values;
1609 struct config_set_element *entry;
1610 struct configset_list *list = &cs->list;
1612 for (i = 0; i < list->nr; i++) {
1613 entry = list->items[i].e;
1614 value_index = list->items[i].value_index;
1615 values = &entry->value_list;
1617 current_config_kvi = values->items[value_index].util;
1619 if (fn(entry->key, values->items[value_index].string, data) < 0)
1620 git_die_config_linenr(entry->key,
1621 current_config_kvi->filename,
1622 current_config_kvi->linenr);
1624 current_config_kvi = NULL;
1628 void read_early_config(config_fn_t cb, void *data)
1630 struct config_options opts = {0};
1631 struct strbuf commondir = STRBUF_INIT;
1632 struct strbuf gitdir = STRBUF_INIT;
1634 opts.respect_includes = 1;
1636 if (have_git_dir()) {
1637 opts.commondir = get_git_common_dir();
1638 opts.git_dir = get_git_dir();
1640 * When setup_git_directory() was not yet asked to discover the
1641 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1642 * is any repository config we should use (but unlike
1643 * setup_git_directory_gently(), no global state is changed, most
1644 * notably, the current working directory is still the same after the
1645 * call).
1647 } else if (!discover_git_directory(&commondir, &gitdir)) {
1648 opts.commondir = commondir.buf;
1649 opts.git_dir = gitdir.buf;
1652 config_with_options(cb, data, NULL, &opts);
1654 strbuf_release(&commondir);
1655 strbuf_release(&gitdir);
1658 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1660 struct config_set_element k;
1661 struct config_set_element *found_entry;
1662 char *normalized_key;
1664 * `key` may come from the user, so normalize it before using it
1665 * for querying entries from the hashmap.
1667 if (git_config_parse_key(key, &normalized_key, NULL))
1668 return NULL;
1670 hashmap_entry_init(&k, strhash(normalized_key));
1671 k.key = normalized_key;
1672 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1673 free(normalized_key);
1674 return found_entry;
1677 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1679 struct config_set_element *e;
1680 struct string_list_item *si;
1681 struct configset_list_item *l_item;
1682 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1684 e = configset_find_element(cs, key);
1686 * Since the keys are being fed by git_config*() callback mechanism, they
1687 * are already normalized. So simply add them without any further munging.
1689 if (!e) {
1690 e = xmalloc(sizeof(*e));
1691 hashmap_entry_init(e, strhash(key));
1692 e->key = xstrdup(key);
1693 string_list_init(&e->value_list, 1);
1694 hashmap_add(&cs->config_hash, e);
1696 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1698 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1699 l_item = &cs->list.items[cs->list.nr++];
1700 l_item->e = e;
1701 l_item->value_index = e->value_list.nr - 1;
1703 if (!cf)
1704 die("BUG: configset_add_value has no source");
1705 if (cf->name) {
1706 kv_info->filename = strintern(cf->name);
1707 kv_info->linenr = cf->linenr;
1708 kv_info->origin_type = cf->origin_type;
1709 } else {
1710 /* for values read from `git_config_from_parameters()` */
1711 kv_info->filename = NULL;
1712 kv_info->linenr = -1;
1713 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1715 kv_info->scope = current_parsing_scope;
1716 si->util = kv_info;
1718 return 0;
1721 static int config_set_element_cmp(const void *unused_cmp_data,
1722 const struct config_set_element *e1,
1723 const struct config_set_element *e2,
1724 const void *unused_keydata)
1726 return strcmp(e1->key, e2->key);
1729 void git_configset_init(struct config_set *cs)
1731 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp,
1732 NULL, 0);
1733 cs->hash_initialized = 1;
1734 cs->list.nr = 0;
1735 cs->list.alloc = 0;
1736 cs->list.items = NULL;
1739 void git_configset_clear(struct config_set *cs)
1741 struct config_set_element *entry;
1742 struct hashmap_iter iter;
1743 if (!cs->hash_initialized)
1744 return;
1746 hashmap_iter_init(&cs->config_hash, &iter);
1747 while ((entry = hashmap_iter_next(&iter))) {
1748 free(entry->key);
1749 string_list_clear(&entry->value_list, 1);
1751 hashmap_free(&cs->config_hash, 1);
1752 cs->hash_initialized = 0;
1753 free(cs->list.items);
1754 cs->list.nr = 0;
1755 cs->list.alloc = 0;
1756 cs->list.items = NULL;
1759 static int config_set_callback(const char *key, const char *value, void *cb)
1761 struct config_set *cs = cb;
1762 configset_add_value(cs, key, value);
1763 return 0;
1766 int git_configset_add_file(struct config_set *cs, const char *filename)
1768 return git_config_from_file(config_set_callback, filename, cs);
1771 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1773 const struct string_list *values = NULL;
1775 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1776 * queried key in the files of the configset, the value returned will be the last
1777 * value in the value list for that key.
1779 values = git_configset_get_value_multi(cs, key);
1781 if (!values)
1782 return 1;
1783 assert(values->nr > 0);
1784 *value = values->items[values->nr - 1].string;
1785 return 0;
1788 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1790 struct config_set_element *e = configset_find_element(cs, key);
1791 return e ? &e->value_list : NULL;
1794 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1796 const char *value;
1797 if (!git_configset_get_value(cs, key, &value))
1798 return git_config_string(dest, key, value);
1799 else
1800 return 1;
1803 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1805 return git_configset_get_string_const(cs, key, (const char **)dest);
1808 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1810 const char *value;
1811 if (!git_configset_get_value(cs, key, &value)) {
1812 *dest = git_config_int(key, value);
1813 return 0;
1814 } else
1815 return 1;
1818 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1820 const char *value;
1821 if (!git_configset_get_value(cs, key, &value)) {
1822 *dest = git_config_ulong(key, value);
1823 return 0;
1824 } else
1825 return 1;
1828 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1830 const char *value;
1831 if (!git_configset_get_value(cs, key, &value)) {
1832 *dest = git_config_bool(key, value);
1833 return 0;
1834 } else
1835 return 1;
1838 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1839 int *is_bool, int *dest)
1841 const char *value;
1842 if (!git_configset_get_value(cs, key, &value)) {
1843 *dest = git_config_bool_or_int(key, value, is_bool);
1844 return 0;
1845 } else
1846 return 1;
1849 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1851 const char *value;
1852 if (!git_configset_get_value(cs, key, &value)) {
1853 *dest = git_config_maybe_bool(key, value);
1854 if (*dest == -1)
1855 return -1;
1856 return 0;
1857 } else
1858 return 1;
1861 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1863 const char *value;
1864 if (!git_configset_get_value(cs, key, &value))
1865 return git_config_pathname(dest, key, value);
1866 else
1867 return 1;
1870 /* Functions use to read configuration from a repository */
1871 static void repo_read_config(struct repository *repo)
1873 struct config_options opts;
1875 opts.respect_includes = 1;
1876 opts.commondir = repo->commondir;
1877 opts.git_dir = repo->gitdir;
1879 if (!repo->config)
1880 repo->config = xcalloc(1, sizeof(struct config_set));
1881 else
1882 git_configset_clear(repo->config);
1884 git_configset_init(repo->config);
1886 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
1888 * config_with_options() normally returns only
1889 * zero, as most errors are fatal, and
1890 * non-fatal potential errors are guarded by "if"
1891 * statements that are entered only when no error is
1892 * possible.
1894 * If we ever encounter a non-fatal error, it means
1895 * something went really wrong and we should stop
1896 * immediately.
1898 die(_("unknown error occurred while reading the configuration files"));
1901 static void git_config_check_init(struct repository *repo)
1903 if (repo->config && repo->config->hash_initialized)
1904 return;
1905 repo_read_config(repo);
1908 static void repo_config_clear(struct repository *repo)
1910 if (!repo->config || !repo->config->hash_initialized)
1911 return;
1912 git_configset_clear(repo->config);
1915 void repo_config(struct repository *repo, config_fn_t fn, void *data)
1917 git_config_check_init(repo);
1918 configset_iter(repo->config, fn, data);
1921 int repo_config_get_value(struct repository *repo,
1922 const char *key, const char **value)
1924 git_config_check_init(repo);
1925 return git_configset_get_value(repo->config, key, value);
1928 const struct string_list *repo_config_get_value_multi(struct repository *repo,
1929 const char *key)
1931 git_config_check_init(repo);
1932 return git_configset_get_value_multi(repo->config, key);
1935 int repo_config_get_string_const(struct repository *repo,
1936 const char *key, const char **dest)
1938 int ret;
1939 git_config_check_init(repo);
1940 ret = git_configset_get_string_const(repo->config, key, dest);
1941 if (ret < 0)
1942 git_die_config(key, NULL);
1943 return ret;
1946 int repo_config_get_string(struct repository *repo,
1947 const char *key, char **dest)
1949 git_config_check_init(repo);
1950 return repo_config_get_string_const(repo, key, (const char **)dest);
1953 int repo_config_get_int(struct repository *repo,
1954 const char *key, int *dest)
1956 git_config_check_init(repo);
1957 return git_configset_get_int(repo->config, key, dest);
1960 int repo_config_get_ulong(struct repository *repo,
1961 const char *key, unsigned long *dest)
1963 git_config_check_init(repo);
1964 return git_configset_get_ulong(repo->config, key, dest);
1967 int repo_config_get_bool(struct repository *repo,
1968 const char *key, int *dest)
1970 git_config_check_init(repo);
1971 return git_configset_get_bool(repo->config, key, dest);
1974 int repo_config_get_bool_or_int(struct repository *repo,
1975 const char *key, int *is_bool, int *dest)
1977 git_config_check_init(repo);
1978 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
1981 int repo_config_get_maybe_bool(struct repository *repo,
1982 const char *key, int *dest)
1984 git_config_check_init(repo);
1985 return git_configset_get_maybe_bool(repo->config, key, dest);
1988 int repo_config_get_pathname(struct repository *repo,
1989 const char *key, const char **dest)
1991 int ret;
1992 git_config_check_init(repo);
1993 ret = git_configset_get_pathname(repo->config, key, dest);
1994 if (ret < 0)
1995 git_die_config(key, NULL);
1996 return ret;
1999 /* Functions used historically to read configuration from 'the_repository' */
2000 void git_config(config_fn_t fn, void *data)
2002 repo_config(the_repository, fn, data);
2005 void git_config_clear(void)
2007 repo_config_clear(the_repository);
2010 int git_config_get_value(const char *key, const char **value)
2012 return repo_config_get_value(the_repository, key, value);
2015 const struct string_list *git_config_get_value_multi(const char *key)
2017 return repo_config_get_value_multi(the_repository, key);
2020 int git_config_get_string_const(const char *key, const char **dest)
2022 return repo_config_get_string_const(the_repository, key, dest);
2025 int git_config_get_string(const char *key, char **dest)
2027 return repo_config_get_string(the_repository, key, dest);
2030 int git_config_get_int(const char *key, int *dest)
2032 return repo_config_get_int(the_repository, key, dest);
2035 int git_config_get_ulong(const char *key, unsigned long *dest)
2037 return repo_config_get_ulong(the_repository, key, dest);
2040 int git_config_get_bool(const char *key, int *dest)
2042 return repo_config_get_bool(the_repository, key, dest);
2045 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2047 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2050 int git_config_get_maybe_bool(const char *key, int *dest)
2052 return repo_config_get_maybe_bool(the_repository, key, dest);
2055 int git_config_get_pathname(const char *key, const char **dest)
2057 return repo_config_get_pathname(the_repository, key, dest);
2060 int git_config_get_expiry(const char *key, const char **output)
2062 int ret = git_config_get_string_const(key, output);
2063 if (ret)
2064 return ret;
2065 if (strcmp(*output, "now")) {
2066 timestamp_t now = approxidate("now");
2067 if (approxidate(*output) >= now)
2068 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2070 return ret;
2073 int git_config_get_untracked_cache(void)
2075 int val = -1;
2076 const char *v;
2078 /* Hack for test programs like test-dump-untracked-cache */
2079 if (ignore_untracked_cache_config)
2080 return -1;
2082 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2083 return val;
2085 if (!git_config_get_value("core.untrackedcache", &v)) {
2086 if (!strcasecmp(v, "keep"))
2087 return -1;
2089 error(_("unknown core.untrackedCache value '%s'; "
2090 "using 'keep' default value"), v);
2091 return -1;
2094 return -1; /* default value */
2097 int git_config_get_split_index(void)
2099 int val;
2101 if (!git_config_get_maybe_bool("core.splitindex", &val))
2102 return val;
2104 return -1; /* default value */
2107 int git_config_get_max_percent_split_change(void)
2109 int val = -1;
2111 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2112 if (0 <= val && val <= 100)
2113 return val;
2115 return error(_("splitIndex.maxPercentChange value '%d' "
2116 "should be between 0 and 100"), val);
2119 return -1; /* default value */
2122 NORETURN
2123 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2125 if (!filename)
2126 die(_("unable to parse '%s' from command-line config"), key);
2127 else
2128 die(_("bad config variable '%s' in file '%s' at line %d"),
2129 key, filename, linenr);
2132 NORETURN __attribute__((format(printf, 2, 3)))
2133 void git_die_config(const char *key, const char *err, ...)
2135 const struct string_list *values;
2136 struct key_value_info *kv_info;
2138 if (err) {
2139 va_list params;
2140 va_start(params, err);
2141 vreportf("error: ", err, params);
2142 va_end(params);
2144 values = git_config_get_value_multi(key);
2145 kv_info = values->items[values->nr - 1].util;
2146 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2150 * Find all the stuff for git_config_set() below.
2153 static struct {
2154 int baselen;
2155 char *key;
2156 int do_not_match;
2157 regex_t *value_regex;
2158 int multi_replace;
2159 size_t *offset;
2160 unsigned int offset_alloc;
2161 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2162 int seen;
2163 } store;
2165 static int matches(const char *key, const char *value)
2167 if (strcmp(key, store.key))
2168 return 0; /* not ours */
2169 if (!store.value_regex)
2170 return 1; /* always matches */
2171 if (store.value_regex == CONFIG_REGEX_NONE)
2172 return 0; /* never matches */
2174 return store.do_not_match ^
2175 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2178 static int store_aux(const char *key, const char *value, void *cb)
2180 const char *ep;
2181 size_t section_len;
2183 switch (store.state) {
2184 case KEY_SEEN:
2185 if (matches(key, value)) {
2186 if (store.seen == 1 && store.multi_replace == 0) {
2187 warning(_("%s has multiple values"), key);
2190 ALLOC_GROW(store.offset, store.seen + 1,
2191 store.offset_alloc);
2193 store.offset[store.seen] = cf->do_ftell(cf);
2194 store.seen++;
2196 break;
2197 case SECTION_SEEN:
2199 * What we are looking for is in store.key (both
2200 * section and var), and its section part is baselen
2201 * long. We found key (again, both section and var).
2202 * We would want to know if this key is in the same
2203 * section as what we are looking for. We already
2204 * know we are in the same section as what should
2205 * hold store.key.
2207 ep = strrchr(key, '.');
2208 section_len = ep - key;
2210 if ((section_len != store.baselen) ||
2211 memcmp(key, store.key, section_len+1)) {
2212 store.state = SECTION_END_SEEN;
2213 break;
2217 * Do not increment matches: this is no match, but we
2218 * just made sure we are in the desired section.
2220 ALLOC_GROW(store.offset, store.seen + 1,
2221 store.offset_alloc);
2222 store.offset[store.seen] = cf->do_ftell(cf);
2223 /* fallthru */
2224 case SECTION_END_SEEN:
2225 case START:
2226 if (matches(key, value)) {
2227 ALLOC_GROW(store.offset, store.seen + 1,
2228 store.offset_alloc);
2229 store.offset[store.seen] = cf->do_ftell(cf);
2230 store.state = KEY_SEEN;
2231 store.seen++;
2232 } else {
2233 if (strrchr(key, '.') - key == store.baselen &&
2234 !strncmp(key, store.key, store.baselen)) {
2235 store.state = SECTION_SEEN;
2236 ALLOC_GROW(store.offset,
2237 store.seen + 1,
2238 store.offset_alloc);
2239 store.offset[store.seen] = cf->do_ftell(cf);
2243 return 0;
2246 static int write_error(const char *filename)
2248 error("failed to write new configuration file %s", filename);
2250 /* Same error code as "failed to rename". */
2251 return 4;
2254 static int store_write_section(int fd, const char *key)
2256 const char *dot;
2257 int i, success;
2258 struct strbuf sb = STRBUF_INIT;
2260 dot = memchr(key, '.', store.baselen);
2261 if (dot) {
2262 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2263 for (i = dot - key + 1; i < store.baselen; i++) {
2264 if (key[i] == '"' || key[i] == '\\')
2265 strbuf_addch(&sb, '\\');
2266 strbuf_addch(&sb, key[i]);
2268 strbuf_addstr(&sb, "\"]\n");
2269 } else {
2270 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2273 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2274 strbuf_release(&sb);
2276 return success;
2279 static int store_write_pair(int fd, const char *key, const char *value)
2281 int i, success;
2282 int length = strlen(key + store.baselen + 1);
2283 const char *quote = "";
2284 struct strbuf sb = STRBUF_INIT;
2287 * Check to see if the value needs to be surrounded with a dq pair.
2288 * Note that problematic characters are always backslash-quoted; this
2289 * check is about not losing leading or trailing SP and strings that
2290 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2291 * configuration parser.
2293 if (value[0] == ' ')
2294 quote = "\"";
2295 for (i = 0; value[i]; i++)
2296 if (value[i] == ';' || value[i] == '#')
2297 quote = "\"";
2298 if (i && value[i - 1] == ' ')
2299 quote = "\"";
2301 strbuf_addf(&sb, "\t%.*s = %s",
2302 length, key + store.baselen + 1, quote);
2304 for (i = 0; value[i]; i++)
2305 switch (value[i]) {
2306 case '\n':
2307 strbuf_addstr(&sb, "\\n");
2308 break;
2309 case '\t':
2310 strbuf_addstr(&sb, "\\t");
2311 break;
2312 case '"':
2313 case '\\':
2314 strbuf_addch(&sb, '\\');
2315 default:
2316 strbuf_addch(&sb, value[i]);
2317 break;
2319 strbuf_addf(&sb, "%s\n", quote);
2321 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2322 strbuf_release(&sb);
2324 return success;
2327 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2328 size_t offset_, int *found_bracket)
2330 size_t equal_offset = size, bracket_offset = size;
2331 ssize_t offset;
2333 contline:
2334 for (offset = offset_-2; offset > 0
2335 && contents[offset] != '\n'; offset--)
2336 switch (contents[offset]) {
2337 case '=': equal_offset = offset; break;
2338 case ']': bracket_offset = offset; break;
2340 if (offset > 0 && contents[offset-1] == '\\') {
2341 offset_ = offset;
2342 goto contline;
2344 if (bracket_offset < equal_offset) {
2345 *found_bracket = 1;
2346 offset = bracket_offset+1;
2347 } else
2348 offset++;
2350 return offset;
2353 int git_config_set_in_file_gently(const char *config_filename,
2354 const char *key, const char *value)
2356 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2359 void git_config_set_in_file(const char *config_filename,
2360 const char *key, const char *value)
2362 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2365 int git_config_set_gently(const char *key, const char *value)
2367 return git_config_set_multivar_gently(key, value, NULL, 0);
2370 void git_config_set(const char *key, const char *value)
2372 git_config_set_multivar(key, value, NULL, 0);
2376 * If value==NULL, unset in (remove from) config,
2377 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2378 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2379 * (only add a new one)
2380 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2381 * else all matching key/values (regardless how many) are removed,
2382 * before the new pair is written.
2384 * Returns 0 on success.
2386 * This function does this:
2388 * - it locks the config file by creating ".git/config.lock"
2390 * - it then parses the config using store_aux() as validator to find
2391 * the position on the key/value pair to replace. If it is to be unset,
2392 * it must be found exactly once.
2394 * - the config file is mmap()ed and the part before the match (if any) is
2395 * written to the lock file, then the changed part and the rest.
2397 * - the config file is removed and the lock file rename()d to it.
2400 int git_config_set_multivar_in_file_gently(const char *config_filename,
2401 const char *key, const char *value,
2402 const char *value_regex,
2403 int multi_replace)
2405 int fd = -1, in_fd = -1;
2406 int ret;
2407 static struct lock_file lock;
2408 char *filename_buf = NULL;
2409 char *contents = NULL;
2410 size_t contents_sz;
2412 /* parse-key returns negative; flip the sign to feed exit(3) */
2413 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2414 if (ret)
2415 goto out_free;
2417 store.multi_replace = multi_replace;
2419 if (!config_filename)
2420 config_filename = filename_buf = git_pathdup("config");
2423 * The lock serves a purpose in addition to locking: the new
2424 * contents of .git/config will be written into it.
2426 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2427 if (fd < 0) {
2428 error_errno("could not lock config file %s", config_filename);
2429 free(store.key);
2430 ret = CONFIG_NO_LOCK;
2431 goto out_free;
2435 * If .git/config does not exist yet, write a minimal version.
2437 in_fd = open(config_filename, O_RDONLY);
2438 if ( in_fd < 0 ) {
2439 free(store.key);
2441 if ( ENOENT != errno ) {
2442 error_errno("opening %s", config_filename);
2443 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2444 goto out_free;
2446 /* if nothing to unset, error out */
2447 if (value == NULL) {
2448 ret = CONFIG_NOTHING_SET;
2449 goto out_free;
2452 store.key = (char *)key;
2453 if (!store_write_section(fd, key) ||
2454 !store_write_pair(fd, key, value))
2455 goto write_err_out;
2456 } else {
2457 struct stat st;
2458 size_t copy_begin, copy_end;
2459 int i, new_line = 0;
2461 if (value_regex == NULL)
2462 store.value_regex = NULL;
2463 else if (value_regex == CONFIG_REGEX_NONE)
2464 store.value_regex = CONFIG_REGEX_NONE;
2465 else {
2466 if (value_regex[0] == '!') {
2467 store.do_not_match = 1;
2468 value_regex++;
2469 } else
2470 store.do_not_match = 0;
2472 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2473 if (regcomp(store.value_regex, value_regex,
2474 REG_EXTENDED)) {
2475 error("invalid pattern: %s", value_regex);
2476 free(store.value_regex);
2477 ret = CONFIG_INVALID_PATTERN;
2478 goto out_free;
2482 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2483 store.offset[0] = 0;
2484 store.state = START;
2485 store.seen = 0;
2488 * After this, store.offset will contain the *end* offset
2489 * of the last match, or remain at 0 if no match was found.
2490 * As a side effect, we make sure to transform only a valid
2491 * existing config file.
2493 if (git_config_from_file(store_aux, config_filename, NULL)) {
2494 error("invalid config file %s", config_filename);
2495 free(store.key);
2496 if (store.value_regex != NULL &&
2497 store.value_regex != CONFIG_REGEX_NONE) {
2498 regfree(store.value_regex);
2499 free(store.value_regex);
2501 ret = CONFIG_INVALID_FILE;
2502 goto out_free;
2505 free(store.key);
2506 if (store.value_regex != NULL &&
2507 store.value_regex != CONFIG_REGEX_NONE) {
2508 regfree(store.value_regex);
2509 free(store.value_regex);
2512 /* if nothing to unset, or too many matches, error out */
2513 if ((store.seen == 0 && value == NULL) ||
2514 (store.seen > 1 && multi_replace == 0)) {
2515 ret = CONFIG_NOTHING_SET;
2516 goto out_free;
2519 if (fstat(in_fd, &st) == -1) {
2520 error_errno(_("fstat on %s failed"), config_filename);
2521 ret = CONFIG_INVALID_FILE;
2522 goto out_free;
2525 contents_sz = xsize_t(st.st_size);
2526 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2527 MAP_PRIVATE, in_fd, 0);
2528 if (contents == MAP_FAILED) {
2529 if (errno == ENODEV && S_ISDIR(st.st_mode))
2530 errno = EISDIR;
2531 error_errno("unable to mmap '%s'", config_filename);
2532 ret = CONFIG_INVALID_FILE;
2533 contents = NULL;
2534 goto out_free;
2536 close(in_fd);
2537 in_fd = -1;
2539 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2540 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2541 ret = CONFIG_NO_WRITE;
2542 goto out_free;
2545 if (store.seen == 0)
2546 store.seen = 1;
2548 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2549 if (store.offset[i] == 0) {
2550 store.offset[i] = copy_end = contents_sz;
2551 } else if (store.state != KEY_SEEN) {
2552 copy_end = store.offset[i];
2553 } else
2554 copy_end = find_beginning_of_line(
2555 contents, contents_sz,
2556 store.offset[i]-2, &new_line);
2558 if (copy_end > 0 && contents[copy_end-1] != '\n')
2559 new_line = 1;
2561 /* write the first part of the config */
2562 if (copy_end > copy_begin) {
2563 if (write_in_full(fd, contents + copy_begin,
2564 copy_end - copy_begin) <
2565 copy_end - copy_begin)
2566 goto write_err_out;
2567 if (new_line &&
2568 write_str_in_full(fd, "\n") != 1)
2569 goto write_err_out;
2571 copy_begin = store.offset[i];
2574 /* write the pair (value == NULL means unset) */
2575 if (value != NULL) {
2576 if (store.state == START) {
2577 if (!store_write_section(fd, key))
2578 goto write_err_out;
2580 if (!store_write_pair(fd, key, value))
2581 goto write_err_out;
2584 /* write the rest of the config */
2585 if (copy_begin < contents_sz)
2586 if (write_in_full(fd, contents + copy_begin,
2587 contents_sz - copy_begin) <
2588 contents_sz - copy_begin)
2589 goto write_err_out;
2591 munmap(contents, contents_sz);
2592 contents = NULL;
2595 if (commit_lock_file(&lock) < 0) {
2596 error_errno("could not write config file %s", config_filename);
2597 ret = CONFIG_NO_WRITE;
2598 goto out_free;
2601 ret = 0;
2603 /* Invalidate the config cache */
2604 git_config_clear();
2606 out_free:
2607 rollback_lock_file(&lock);
2608 free(filename_buf);
2609 if (contents)
2610 munmap(contents, contents_sz);
2611 if (in_fd >= 0)
2612 close(in_fd);
2613 return ret;
2615 write_err_out:
2616 ret = write_error(get_lock_file_path(&lock));
2617 goto out_free;
2621 void git_config_set_multivar_in_file(const char *config_filename,
2622 const char *key, const char *value,
2623 const char *value_regex, int multi_replace)
2625 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2626 value_regex, multi_replace))
2627 return;
2628 if (value)
2629 die(_("could not set '%s' to '%s'"), key, value);
2630 else
2631 die(_("could not unset '%s'"), key);
2634 int git_config_set_multivar_gently(const char *key, const char *value,
2635 const char *value_regex, int multi_replace)
2637 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2638 multi_replace);
2641 void git_config_set_multivar(const char *key, const char *value,
2642 const char *value_regex, int multi_replace)
2644 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2645 multi_replace);
2648 static int section_name_match (const char *buf, const char *name)
2650 int i = 0, j = 0, dot = 0;
2651 if (buf[i] != '[')
2652 return 0;
2653 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2654 if (!dot && isspace(buf[i])) {
2655 dot = 1;
2656 if (name[j++] != '.')
2657 break;
2658 for (i++; isspace(buf[i]); i++)
2659 ; /* do nothing */
2660 if (buf[i] != '"')
2661 break;
2662 continue;
2664 if (buf[i] == '\\' && dot)
2665 i++;
2666 else if (buf[i] == '"' && dot) {
2667 for (i++; isspace(buf[i]); i++)
2668 ; /* do_nothing */
2669 break;
2671 if (buf[i] != name[j++])
2672 break;
2674 if (buf[i] == ']' && name[j] == 0) {
2676 * We match, now just find the right length offset by
2677 * gobbling up any whitespace after it, as well
2679 i++;
2680 for (; buf[i] && isspace(buf[i]); i++)
2681 ; /* do nothing */
2682 return i;
2684 return 0;
2687 static int section_name_is_ok(const char *name)
2689 /* Empty section names are bogus. */
2690 if (!*name)
2691 return 0;
2694 * Before a dot, we must be alphanumeric or dash. After the first dot,
2695 * anything goes, so we can stop checking.
2697 for (; *name && *name != '.'; name++)
2698 if (*name != '-' && !isalnum(*name))
2699 return 0;
2700 return 1;
2703 /* if new_name == NULL, the section is removed instead */
2704 int git_config_rename_section_in_file(const char *config_filename,
2705 const char *old_name, const char *new_name)
2707 int ret = 0, remove = 0;
2708 char *filename_buf = NULL;
2709 struct lock_file *lock;
2710 int out_fd;
2711 char buf[1024];
2712 FILE *config_file = NULL;
2713 struct stat st;
2715 if (new_name && !section_name_is_ok(new_name)) {
2716 ret = error("invalid section name: %s", new_name);
2717 goto out_no_rollback;
2720 if (!config_filename)
2721 config_filename = filename_buf = git_pathdup("config");
2723 lock = xcalloc(1, sizeof(struct lock_file));
2724 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2725 if (out_fd < 0) {
2726 ret = error("could not lock config file %s", config_filename);
2727 goto out;
2730 if (!(config_file = fopen(config_filename, "rb"))) {
2731 ret = warn_on_fopen_errors(config_filename);
2732 if (ret)
2733 goto out;
2734 /* no config file means nothing to rename, no error */
2735 goto commit_and_out;
2738 if (fstat(fileno(config_file), &st) == -1) {
2739 ret = error_errno(_("fstat on %s failed"), config_filename);
2740 goto out;
2743 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2744 ret = error_errno("chmod on %s failed",
2745 get_lock_file_path(lock));
2746 goto out;
2749 while (fgets(buf, sizeof(buf), config_file)) {
2750 int i;
2751 int length;
2752 char *output = buf;
2753 for (i = 0; buf[i] && isspace(buf[i]); i++)
2754 ; /* do nothing */
2755 if (buf[i] == '[') {
2756 /* it's a section */
2757 int offset = section_name_match(&buf[i], old_name);
2758 if (offset > 0) {
2759 ret++;
2760 if (new_name == NULL) {
2761 remove = 1;
2762 continue;
2764 store.baselen = strlen(new_name);
2765 if (!store_write_section(out_fd, new_name)) {
2766 ret = write_error(get_lock_file_path(lock));
2767 goto out;
2770 * We wrote out the new section, with
2771 * a newline, now skip the old
2772 * section's length
2774 output += offset + i;
2775 if (strlen(output) > 0) {
2777 * More content means there's
2778 * a declaration to put on the
2779 * next line; indent with a
2780 * tab
2782 output -= 1;
2783 output[0] = '\t';
2786 remove = 0;
2788 if (remove)
2789 continue;
2790 length = strlen(output);
2791 if (write_in_full(out_fd, output, length) != length) {
2792 ret = write_error(get_lock_file_path(lock));
2793 goto out;
2796 fclose(config_file);
2797 config_file = NULL;
2798 commit_and_out:
2799 if (commit_lock_file(lock) < 0)
2800 ret = error_errno("could not write config file %s",
2801 config_filename);
2802 out:
2803 if (config_file)
2804 fclose(config_file);
2805 rollback_lock_file(lock);
2806 out_no_rollback:
2807 free(filename_buf);
2808 return ret;
2811 int git_config_rename_section(const char *old_name, const char *new_name)
2813 return git_config_rename_section_in_file(NULL, old_name, new_name);
2817 * Call this to report error for your variable that should not
2818 * get a boolean value (i.e. "[my] var" means "true").
2820 #undef config_error_nonbool
2821 int config_error_nonbool(const char *var)
2823 return error("missing value for '%s'", var);
2826 int parse_config_key(const char *var,
2827 const char *section,
2828 const char **subsection, int *subsection_len,
2829 const char **key)
2831 const char *dot;
2833 /* Does it start with "section." ? */
2834 if (!skip_prefix(var, section, &var) || *var != '.')
2835 return -1;
2838 * Find the key; we don't know yet if we have a subsection, but we must
2839 * parse backwards from the end, since the subsection may have dots in
2840 * it, too.
2842 dot = strrchr(var, '.');
2843 *key = dot + 1;
2845 /* Did we have a subsection at all? */
2846 if (dot == var) {
2847 if (subsection) {
2848 *subsection = NULL;
2849 *subsection_len = 0;
2852 else {
2853 if (!subsection)
2854 return -1;
2855 *subsection = var + 1;
2856 *subsection_len = dot - *subsection;
2859 return 0;
2862 const char *current_config_origin_type(void)
2864 int type;
2865 if (current_config_kvi)
2866 type = current_config_kvi->origin_type;
2867 else if(cf)
2868 type = cf->origin_type;
2869 else
2870 die("BUG: current_config_origin_type called outside config callback");
2872 switch (type) {
2873 case CONFIG_ORIGIN_BLOB:
2874 return "blob";
2875 case CONFIG_ORIGIN_FILE:
2876 return "file";
2877 case CONFIG_ORIGIN_STDIN:
2878 return "standard input";
2879 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2880 return "submodule-blob";
2881 case CONFIG_ORIGIN_CMDLINE:
2882 return "command line";
2883 default:
2884 die("BUG: unknown config origin type");
2888 const char *current_config_name(void)
2890 const char *name;
2891 if (current_config_kvi)
2892 name = current_config_kvi->filename;
2893 else if (cf)
2894 name = cf->name;
2895 else
2896 die("BUG: current_config_name called outside config callback");
2897 return name ? name : "";
2900 enum config_scope current_config_scope(void)
2902 if (current_config_kvi)
2903 return current_config_kvi->scope;
2904 else
2905 return current_parsing_scope;