Merge branch 'bw/ls-files-sans-the-index'
[git/gitweb.git] / config.c
blob547daf87d40ebfe67272e913635826441dd97320
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 "lockfile.h"
10 #include "exec_cmd.h"
11 #include "strbuf.h"
12 #include "quote.h"
13 #include "hashmap.h"
14 #include "string-list.h"
15 #include "utf8.h"
16 #include "dir.h"
18 struct config_source {
19 struct config_source *prev;
20 union {
21 FILE *file;
22 struct config_buf {
23 const char *buf;
24 size_t len;
25 size_t pos;
26 } buf;
27 } u;
28 enum config_origin_type origin_type;
29 const char *name;
30 const char *path;
31 int die_on_error;
32 int linenr;
33 int eof;
34 struct strbuf value;
35 struct strbuf var;
37 int (*do_fgetc)(struct config_source *c);
38 int (*do_ungetc)(int c, struct config_source *conf);
39 long (*do_ftell)(struct config_source *c);
43 * These variables record the "current" config source, which
44 * can be accessed by parsing callbacks.
46 * The "cf" variable will be non-NULL only when we are actually parsing a real
47 * config source (file, blob, cmdline, etc).
49 * The "current_config_kvi" variable will be non-NULL only when we are feeding
50 * cached config from a configset into a callback.
52 * They should generally never be non-NULL at the same time. If they are both
53 * NULL, then we aren't parsing anything (and depending on the function looking
54 * at the variables, it's either a bug for it to be called in the first place,
55 * or it's a function which can be reused for non-config purposes, and should
56 * fall back to some sane behavior).
58 static struct config_source *cf;
59 static struct key_value_info *current_config_kvi;
62 * Similar to the variables above, this gives access to the "scope" of the
63 * current value (repo, global, etc). For cached values, it can be found via
64 * the current_config_kvi as above. During parsing, the current value can be
65 * found in this variable. It's not part of "cf" because it transcends a single
66 * file (i.e., a file included from .git/config is still in "repo" scope).
68 static enum config_scope current_parsing_scope;
70 static int core_compression_seen;
71 static int pack_compression_seen;
72 static int zlib_compression_seen;
75 * Default config_set that contains key-value pairs from the usual set of config
76 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
77 * config file and the global /etc/gitconfig)
79 static struct config_set the_config_set;
81 static int config_file_fgetc(struct config_source *conf)
83 return getc_unlocked(conf->u.file);
86 static int config_file_ungetc(int c, struct config_source *conf)
88 return ungetc(c, conf->u.file);
91 static long config_file_ftell(struct config_source *conf)
93 return ftell(conf->u.file);
97 static int config_buf_fgetc(struct config_source *conf)
99 if (conf->u.buf.pos < conf->u.buf.len)
100 return conf->u.buf.buf[conf->u.buf.pos++];
102 return EOF;
105 static int config_buf_ungetc(int c, struct config_source *conf)
107 if (conf->u.buf.pos > 0) {
108 conf->u.buf.pos--;
109 if (conf->u.buf.buf[conf->u.buf.pos] != c)
110 die("BUG: config_buf can only ungetc the same character");
111 return c;
114 return EOF;
117 static long config_buf_ftell(struct config_source *conf)
119 return conf->u.buf.pos;
122 #define MAX_INCLUDE_DEPTH 10
123 static const char include_depth_advice[] =
124 "exceeded maximum include depth (%d) while including\n"
125 " %s\n"
126 "from\n"
127 " %s\n"
128 "Do you have circular includes?";
129 static int handle_path_include(const char *path, struct config_include_data *inc)
131 int ret = 0;
132 struct strbuf buf = STRBUF_INIT;
133 char *expanded;
135 if (!path)
136 return config_error_nonbool("include.path");
138 expanded = expand_user_path(path, 0);
139 if (!expanded)
140 return error("could not expand include path '%s'", path);
141 path = expanded;
144 * Use an absolute path as-is, but interpret relative paths
145 * based on the including config file.
147 if (!is_absolute_path(path)) {
148 char *slash;
150 if (!cf || !cf->path)
151 return error("relative config includes must come from files");
153 slash = find_last_dir_sep(cf->path);
154 if (slash)
155 strbuf_add(&buf, cf->path, slash - cf->path + 1);
156 strbuf_addstr(&buf, path);
157 path = buf.buf;
160 if (!access_or_die(path, R_OK, 0)) {
161 if (++inc->depth > MAX_INCLUDE_DEPTH)
162 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
163 !cf ? "<unknown>" :
164 cf->name ? cf->name :
165 "the command line");
166 ret = git_config_from_file(git_config_include, path, inc);
167 inc->depth--;
169 strbuf_release(&buf);
170 free(expanded);
171 return ret;
174 static int prepare_include_condition_pattern(struct strbuf *pat)
176 struct strbuf path = STRBUF_INIT;
177 char *expanded;
178 int prefix = 0;
180 expanded = expand_user_path(pat->buf, 1);
181 if (expanded) {
182 strbuf_reset(pat);
183 strbuf_addstr(pat, expanded);
184 free(expanded);
187 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
188 const char *slash;
190 if (!cf || !cf->path)
191 return error(_("relative config include "
192 "conditionals must come from files"));
194 strbuf_realpath(&path, cf->path, 1);
195 slash = find_last_dir_sep(path.buf);
196 if (!slash)
197 die("BUG: how is this possible?");
198 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
199 prefix = slash - path.buf + 1 /* slash */;
200 } else if (!is_absolute_path(pat->buf))
201 strbuf_insert(pat, 0, "**/", 3);
203 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
204 strbuf_addstr(pat, "**");
206 strbuf_release(&path);
207 return prefix;
210 static int include_by_gitdir(const struct config_options *opts,
211 const char *cond, size_t cond_len, int icase)
213 struct strbuf text = STRBUF_INIT;
214 struct strbuf pattern = STRBUF_INIT;
215 int ret = 0, prefix;
216 const char *git_dir;
217 int already_tried_absolute = 0;
219 if (opts->git_dir)
220 git_dir = opts->git_dir;
221 else if (have_git_dir())
222 git_dir = get_git_dir();
223 else
224 goto done;
226 strbuf_realpath(&text, git_dir, 1);
227 strbuf_add(&pattern, cond, cond_len);
228 prefix = prepare_include_condition_pattern(&pattern);
230 again:
231 if (prefix < 0)
232 goto done;
234 if (prefix > 0) {
236 * perform literal matching on the prefix part so that
237 * any wildcard character in it can't create side effects.
239 if (text.len < prefix)
240 goto done;
241 if (!icase && strncmp(pattern.buf, text.buf, prefix))
242 goto done;
243 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
244 goto done;
247 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
248 icase ? WM_CASEFOLD : 0, NULL);
250 if (!ret && !already_tried_absolute) {
252 * We've tried e.g. matching gitdir:~/work, but if
253 * ~/work is a symlink to /mnt/storage/work
254 * strbuf_realpath() will expand it, so the rule won't
255 * match. Let's match against a
256 * strbuf_add_absolute_path() version of the path,
257 * which'll do the right thing
259 strbuf_reset(&text);
260 strbuf_add_absolute_path(&text, git_dir);
261 already_tried_absolute = 1;
262 goto again;
264 done:
265 strbuf_release(&pattern);
266 strbuf_release(&text);
267 return ret;
270 static int include_condition_is_true(const struct config_options *opts,
271 const char *cond, size_t cond_len)
274 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
275 return include_by_gitdir(opts, cond, cond_len, 0);
276 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
277 return include_by_gitdir(opts, cond, cond_len, 1);
279 /* unknown conditionals are always false */
280 return 0;
283 int git_config_include(const char *var, const char *value, void *data)
285 struct config_include_data *inc = data;
286 const char *cond, *key;
287 int cond_len;
288 int ret;
291 * Pass along all values, including "include" directives; this makes it
292 * possible to query information on the includes themselves.
294 ret = inc->fn(var, value, inc->data);
295 if (ret < 0)
296 return ret;
298 if (!strcmp(var, "include.path"))
299 ret = handle_path_include(value, inc);
301 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
302 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
303 !strcmp(key, "path"))
304 ret = handle_path_include(value, inc);
306 return ret;
309 void git_config_push_parameter(const char *text)
311 struct strbuf env = STRBUF_INIT;
312 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
313 if (old && *old) {
314 strbuf_addstr(&env, old);
315 strbuf_addch(&env, ' ');
317 sq_quote_buf(&env, text);
318 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
319 strbuf_release(&env);
322 static inline int iskeychar(int c)
324 return isalnum(c) || c == '-';
328 * Auxiliary function to sanity-check and split the key into the section
329 * identifier and variable name.
331 * Returns 0 on success, -1 when there is an invalid character in the key and
332 * -2 if there is no section name in the key.
334 * store_key - pointer to char* which will hold a copy of the key with
335 * lowercase section and variable name
336 * baselen - pointer to int which will hold the length of the
337 * section + subsection part, can be NULL
339 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
341 int i, dot, baselen;
342 const char *last_dot = strrchr(key, '.');
345 * Since "key" actually contains the section name and the real
346 * key name separated by a dot, we have to know where the dot is.
349 if (last_dot == NULL || last_dot == key) {
350 if (!quiet)
351 error("key does not contain a section: %s", key);
352 return -CONFIG_NO_SECTION_OR_NAME;
355 if (!last_dot[1]) {
356 if (!quiet)
357 error("key does not contain variable name: %s", key);
358 return -CONFIG_NO_SECTION_OR_NAME;
361 baselen = last_dot - key;
362 if (baselen_)
363 *baselen_ = baselen;
366 * Validate the key and while at it, lower case it for matching.
368 if (store_key)
369 *store_key = xmallocz(strlen(key));
371 dot = 0;
372 for (i = 0; key[i]; i++) {
373 unsigned char c = key[i];
374 if (c == '.')
375 dot = 1;
376 /* Leave the extended basename untouched.. */
377 if (!dot || i > baselen) {
378 if (!iskeychar(c) ||
379 (i == baselen + 1 && !isalpha(c))) {
380 if (!quiet)
381 error("invalid key: %s", key);
382 goto out_free_ret_1;
384 c = tolower(c);
385 } else if (c == '\n') {
386 if (!quiet)
387 error("invalid key (newline): %s", key);
388 goto out_free_ret_1;
390 if (store_key)
391 (*store_key)[i] = c;
394 return 0;
396 out_free_ret_1:
397 if (store_key) {
398 free(*store_key);
399 *store_key = NULL;
401 return -CONFIG_INVALID_KEY;
404 int git_config_parse_key(const char *key, char **store_key, int *baselen)
406 return git_config_parse_key_1(key, store_key, baselen, 0);
409 int git_config_key_is_valid(const char *key)
411 return !git_config_parse_key_1(key, NULL, NULL, 1);
414 int git_config_parse_parameter(const char *text,
415 config_fn_t fn, void *data)
417 const char *value;
418 char *canonical_name;
419 struct strbuf **pair;
420 int ret;
422 pair = strbuf_split_str(text, '=', 2);
423 if (!pair[0])
424 return error("bogus config parameter: %s", text);
426 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
427 strbuf_setlen(pair[0], pair[0]->len - 1);
428 value = pair[1] ? pair[1]->buf : "";
429 } else {
430 value = NULL;
433 strbuf_trim(pair[0]);
434 if (!pair[0]->len) {
435 strbuf_list_free(pair);
436 return error("bogus config parameter: %s", text);
439 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
440 ret = -1;
441 } else {
442 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
443 free(canonical_name);
445 strbuf_list_free(pair);
446 return ret;
449 int git_config_from_parameters(config_fn_t fn, void *data)
451 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
452 int ret = 0;
453 char *envw;
454 const char **argv = NULL;
455 int nr = 0, alloc = 0;
456 int i;
457 struct config_source source;
459 if (!env)
460 return 0;
462 memset(&source, 0, sizeof(source));
463 source.prev = cf;
464 source.origin_type = CONFIG_ORIGIN_CMDLINE;
465 cf = &source;
467 /* sq_dequote will write over it */
468 envw = xstrdup(env);
470 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
471 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
472 goto out;
475 for (i = 0; i < nr; i++) {
476 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
477 ret = -1;
478 goto out;
482 out:
483 free(argv);
484 free(envw);
485 cf = source.prev;
486 return ret;
489 static int get_next_char(void)
491 int c = cf->do_fgetc(cf);
493 if (c == '\r') {
494 /* DOS like systems */
495 c = cf->do_fgetc(cf);
496 if (c != '\n') {
497 if (c != EOF)
498 cf->do_ungetc(c, cf);
499 c = '\r';
502 if (c == '\n')
503 cf->linenr++;
504 if (c == EOF) {
505 cf->eof = 1;
506 cf->linenr++;
507 c = '\n';
509 return c;
512 static char *parse_value(void)
514 int quote = 0, comment = 0, space = 0;
516 strbuf_reset(&cf->value);
517 for (;;) {
518 int c = get_next_char();
519 if (c == '\n') {
520 if (quote) {
521 cf->linenr--;
522 return NULL;
524 return cf->value.buf;
526 if (comment)
527 continue;
528 if (isspace(c) && !quote) {
529 if (cf->value.len)
530 space++;
531 continue;
533 if (!quote) {
534 if (c == ';' || c == '#') {
535 comment = 1;
536 continue;
539 for (; space; space--)
540 strbuf_addch(&cf->value, ' ');
541 if (c == '\\') {
542 c = get_next_char();
543 switch (c) {
544 case '\n':
545 continue;
546 case 't':
547 c = '\t';
548 break;
549 case 'b':
550 c = '\b';
551 break;
552 case 'n':
553 c = '\n';
554 break;
555 /* Some characters escape as themselves */
556 case '\\': case '"':
557 break;
558 /* Reject unknown escape sequences */
559 default:
560 return NULL;
562 strbuf_addch(&cf->value, c);
563 continue;
565 if (c == '"') {
566 quote = 1-quote;
567 continue;
569 strbuf_addch(&cf->value, c);
573 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
575 int c;
576 char *value;
577 int ret;
579 /* Get the full name */
580 for (;;) {
581 c = get_next_char();
582 if (cf->eof)
583 break;
584 if (!iskeychar(c))
585 break;
586 strbuf_addch(name, tolower(c));
589 while (c == ' ' || c == '\t')
590 c = get_next_char();
592 value = NULL;
593 if (c != '\n') {
594 if (c != '=')
595 return -1;
596 value = parse_value();
597 if (!value)
598 return -1;
601 * We already consumed the \n, but we need linenr to point to
602 * the line we just parsed during the call to fn to get
603 * accurate line number in error messages.
605 cf->linenr--;
606 ret = fn(name->buf, value, data);
607 if (ret >= 0)
608 cf->linenr++;
609 return ret;
612 static int get_extended_base_var(struct strbuf *name, int c)
614 do {
615 if (c == '\n')
616 goto error_incomplete_line;
617 c = get_next_char();
618 } while (isspace(c));
620 /* We require the format to be '[base "extension"]' */
621 if (c != '"')
622 return -1;
623 strbuf_addch(name, '.');
625 for (;;) {
626 int c = get_next_char();
627 if (c == '\n')
628 goto error_incomplete_line;
629 if (c == '"')
630 break;
631 if (c == '\\') {
632 c = get_next_char();
633 if (c == '\n')
634 goto error_incomplete_line;
636 strbuf_addch(name, c);
639 /* Final ']' */
640 if (get_next_char() != ']')
641 return -1;
642 return 0;
643 error_incomplete_line:
644 cf->linenr--;
645 return -1;
648 static int get_base_var(struct strbuf *name)
650 for (;;) {
651 int c = get_next_char();
652 if (cf->eof)
653 return -1;
654 if (c == ']')
655 return 0;
656 if (isspace(c))
657 return get_extended_base_var(name, c);
658 if (!iskeychar(c) && c != '.')
659 return -1;
660 strbuf_addch(name, tolower(c));
664 static int git_parse_source(config_fn_t fn, void *data)
666 int comment = 0;
667 int baselen = 0;
668 struct strbuf *var = &cf->var;
669 int error_return = 0;
670 char *error_msg = NULL;
672 /* U+FEFF Byte Order Mark in UTF8 */
673 const char *bomptr = utf8_bom;
675 for (;;) {
676 int c = get_next_char();
677 if (bomptr && *bomptr) {
678 /* We are at the file beginning; skip UTF8-encoded BOM
679 * if present. Sane editors won't put this in on their
680 * own, but e.g. Windows Notepad will do it happily. */
681 if (c == (*bomptr & 0377)) {
682 bomptr++;
683 continue;
684 } else {
685 /* Do not tolerate partial BOM. */
686 if (bomptr != utf8_bom)
687 break;
688 /* No BOM at file beginning. Cool. */
689 bomptr = NULL;
692 if (c == '\n') {
693 if (cf->eof)
694 return 0;
695 comment = 0;
696 continue;
698 if (comment || isspace(c))
699 continue;
700 if (c == '#' || c == ';') {
701 comment = 1;
702 continue;
704 if (c == '[') {
705 /* Reset prior to determining a new stem */
706 strbuf_reset(var);
707 if (get_base_var(var) < 0 || var->len < 1)
708 break;
709 strbuf_addch(var, '.');
710 baselen = var->len;
711 continue;
713 if (!isalpha(c))
714 break;
716 * Truncate the var name back to the section header
717 * stem prior to grabbing the suffix part of the name
718 * and the value.
720 strbuf_setlen(var, baselen);
721 strbuf_addch(var, tolower(c));
722 if (get_value(fn, data, var) < 0)
723 break;
726 switch (cf->origin_type) {
727 case CONFIG_ORIGIN_BLOB:
728 error_msg = xstrfmt(_("bad config line %d in blob %s"),
729 cf->linenr, cf->name);
730 break;
731 case CONFIG_ORIGIN_FILE:
732 error_msg = xstrfmt(_("bad config line %d in file %s"),
733 cf->linenr, cf->name);
734 break;
735 case CONFIG_ORIGIN_STDIN:
736 error_msg = xstrfmt(_("bad config line %d in standard input"),
737 cf->linenr);
738 break;
739 case CONFIG_ORIGIN_SUBMODULE_BLOB:
740 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
741 cf->linenr, cf->name);
742 break;
743 case CONFIG_ORIGIN_CMDLINE:
744 error_msg = xstrfmt(_("bad config line %d in command line %s"),
745 cf->linenr, cf->name);
746 break;
747 default:
748 error_msg = xstrfmt(_("bad config line %d in %s"),
749 cf->linenr, cf->name);
752 if (cf->die_on_error)
753 die("%s", error_msg);
754 else
755 error_return = error("%s", error_msg);
757 free(error_msg);
758 return error_return;
761 static int parse_unit_factor(const char *end, uintmax_t *val)
763 if (!*end)
764 return 1;
765 else if (!strcasecmp(end, "k")) {
766 *val *= 1024;
767 return 1;
769 else if (!strcasecmp(end, "m")) {
770 *val *= 1024 * 1024;
771 return 1;
773 else if (!strcasecmp(end, "g")) {
774 *val *= 1024 * 1024 * 1024;
775 return 1;
777 return 0;
780 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
782 if (value && *value) {
783 char *end;
784 intmax_t val;
785 uintmax_t uval;
786 uintmax_t factor = 1;
788 errno = 0;
789 val = strtoimax(value, &end, 0);
790 if (errno == ERANGE)
791 return 0;
792 if (!parse_unit_factor(end, &factor)) {
793 errno = EINVAL;
794 return 0;
796 uval = labs(val);
797 uval *= factor;
798 if (uval > max || labs(val) > uval) {
799 errno = ERANGE;
800 return 0;
802 val *= factor;
803 *ret = val;
804 return 1;
806 errno = EINVAL;
807 return 0;
810 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
812 if (value && *value) {
813 char *end;
814 uintmax_t val;
815 uintmax_t oldval;
817 errno = 0;
818 val = strtoumax(value, &end, 0);
819 if (errno == ERANGE)
820 return 0;
821 oldval = val;
822 if (!parse_unit_factor(end, &val)) {
823 errno = EINVAL;
824 return 0;
826 if (val > max || oldval > val) {
827 errno = ERANGE;
828 return 0;
830 *ret = val;
831 return 1;
833 errno = EINVAL;
834 return 0;
837 static int git_parse_int(const char *value, int *ret)
839 intmax_t tmp;
840 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
841 return 0;
842 *ret = tmp;
843 return 1;
846 static int git_parse_int64(const char *value, int64_t *ret)
848 intmax_t tmp;
849 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
850 return 0;
851 *ret = tmp;
852 return 1;
855 int git_parse_ulong(const char *value, unsigned long *ret)
857 uintmax_t tmp;
858 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
859 return 0;
860 *ret = tmp;
861 return 1;
864 static int git_parse_ssize_t(const char *value, ssize_t *ret)
866 intmax_t tmp;
867 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
868 return 0;
869 *ret = tmp;
870 return 1;
873 NORETURN
874 static void die_bad_number(const char *name, const char *value)
876 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
878 if (!value)
879 value = "";
881 if (!(cf && cf->name))
882 die(_("bad numeric config value '%s' for '%s': %s"),
883 value, name, error_type);
885 switch (cf->origin_type) {
886 case CONFIG_ORIGIN_BLOB:
887 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
888 value, name, cf->name, error_type);
889 case CONFIG_ORIGIN_FILE:
890 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
891 value, name, cf->name, error_type);
892 case CONFIG_ORIGIN_STDIN:
893 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
894 value, name, error_type);
895 case CONFIG_ORIGIN_SUBMODULE_BLOB:
896 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
897 value, name, cf->name, error_type);
898 case CONFIG_ORIGIN_CMDLINE:
899 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
900 value, name, cf->name, error_type);
901 default:
902 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
903 value, name, cf->name, error_type);
907 int git_config_int(const char *name, const char *value)
909 int ret;
910 if (!git_parse_int(value, &ret))
911 die_bad_number(name, value);
912 return ret;
915 int64_t git_config_int64(const char *name, const char *value)
917 int64_t ret;
918 if (!git_parse_int64(value, &ret))
919 die_bad_number(name, value);
920 return ret;
923 unsigned long git_config_ulong(const char *name, const char *value)
925 unsigned long ret;
926 if (!git_parse_ulong(value, &ret))
927 die_bad_number(name, value);
928 return ret;
931 ssize_t git_config_ssize_t(const char *name, const char *value)
933 ssize_t ret;
934 if (!git_parse_ssize_t(value, &ret))
935 die_bad_number(name, value);
936 return ret;
939 int git_parse_maybe_bool(const char *value)
941 if (!value)
942 return 1;
943 if (!*value)
944 return 0;
945 if (!strcasecmp(value, "true")
946 || !strcasecmp(value, "yes")
947 || !strcasecmp(value, "on"))
948 return 1;
949 if (!strcasecmp(value, "false")
950 || !strcasecmp(value, "no")
951 || !strcasecmp(value, "off"))
952 return 0;
953 return -1;
956 int git_config_maybe_bool(const char *name, const char *value)
958 int v = git_parse_maybe_bool(value);
959 if (0 <= v)
960 return v;
961 if (git_parse_int(value, &v))
962 return !!v;
963 return -1;
966 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
968 int v = git_parse_maybe_bool(value);
969 if (0 <= v) {
970 *is_bool = 1;
971 return v;
973 *is_bool = 0;
974 return git_config_int(name, value);
977 int git_config_bool(const char *name, const char *value)
979 int discard;
980 return !!git_config_bool_or_int(name, value, &discard);
983 int git_config_string(const char **dest, const char *var, const char *value)
985 if (!value)
986 return config_error_nonbool(var);
987 *dest = xstrdup(value);
988 return 0;
991 int git_config_pathname(const char **dest, const char *var, const char *value)
993 if (!value)
994 return config_error_nonbool(var);
995 *dest = expand_user_path(value, 0);
996 if (!*dest)
997 die(_("failed to expand user dir in: '%s'"), value);
998 return 0;
1001 static int git_default_core_config(const char *var, const char *value)
1003 /* This needs a better name */
1004 if (!strcmp(var, "core.filemode")) {
1005 trust_executable_bit = git_config_bool(var, value);
1006 return 0;
1008 if (!strcmp(var, "core.trustctime")) {
1009 trust_ctime = git_config_bool(var, value);
1010 return 0;
1012 if (!strcmp(var, "core.checkstat")) {
1013 if (!strcasecmp(value, "default"))
1014 check_stat = 1;
1015 else if (!strcasecmp(value, "minimal"))
1016 check_stat = 0;
1019 if (!strcmp(var, "core.quotepath")) {
1020 quote_path_fully = git_config_bool(var, value);
1021 return 0;
1024 if (!strcmp(var, "core.symlinks")) {
1025 has_symlinks = git_config_bool(var, value);
1026 return 0;
1029 if (!strcmp(var, "core.ignorecase")) {
1030 ignore_case = git_config_bool(var, value);
1031 return 0;
1034 if (!strcmp(var, "core.attributesfile"))
1035 return git_config_pathname(&git_attributes_file, var, value);
1037 if (!strcmp(var, "core.hookspath"))
1038 return git_config_pathname(&git_hooks_path, var, value);
1040 if (!strcmp(var, "core.bare")) {
1041 is_bare_repository_cfg = git_config_bool(var, value);
1042 return 0;
1045 if (!strcmp(var, "core.ignorestat")) {
1046 assume_unchanged = git_config_bool(var, value);
1047 return 0;
1050 if (!strcmp(var, "core.prefersymlinkrefs")) {
1051 prefer_symlink_refs = git_config_bool(var, value);
1052 return 0;
1055 if (!strcmp(var, "core.logallrefupdates")) {
1056 if (value && !strcasecmp(value, "always"))
1057 log_all_ref_updates = LOG_REFS_ALWAYS;
1058 else if (git_config_bool(var, value))
1059 log_all_ref_updates = LOG_REFS_NORMAL;
1060 else
1061 log_all_ref_updates = LOG_REFS_NONE;
1062 return 0;
1065 if (!strcmp(var, "core.warnambiguousrefs")) {
1066 warn_ambiguous_refs = git_config_bool(var, value);
1067 return 0;
1070 if (!strcmp(var, "core.abbrev")) {
1071 if (!value)
1072 return config_error_nonbool(var);
1073 if (!strcasecmp(value, "auto"))
1074 default_abbrev = -1;
1075 else {
1076 int abbrev = git_config_int(var, value);
1077 if (abbrev < minimum_abbrev || abbrev > 40)
1078 return error("abbrev length out of range: %d", abbrev);
1079 default_abbrev = abbrev;
1081 return 0;
1084 if (!strcmp(var, "core.disambiguate"))
1085 return set_disambiguate_hint_config(var, value);
1087 if (!strcmp(var, "core.loosecompression")) {
1088 int level = git_config_int(var, value);
1089 if (level == -1)
1090 level = Z_DEFAULT_COMPRESSION;
1091 else if (level < 0 || level > Z_BEST_COMPRESSION)
1092 die(_("bad zlib compression level %d"), level);
1093 zlib_compression_level = level;
1094 zlib_compression_seen = 1;
1095 return 0;
1098 if (!strcmp(var, "core.compression")) {
1099 int level = git_config_int(var, value);
1100 if (level == -1)
1101 level = Z_DEFAULT_COMPRESSION;
1102 else if (level < 0 || level > Z_BEST_COMPRESSION)
1103 die(_("bad zlib compression level %d"), level);
1104 core_compression_level = level;
1105 core_compression_seen = 1;
1106 if (!zlib_compression_seen)
1107 zlib_compression_level = level;
1108 if (!pack_compression_seen)
1109 pack_compression_level = level;
1110 return 0;
1113 if (!strcmp(var, "core.packedgitwindowsize")) {
1114 int pgsz_x2 = getpagesize() * 2;
1115 packed_git_window_size = git_config_ulong(var, value);
1117 /* This value must be multiple of (pagesize * 2) */
1118 packed_git_window_size /= pgsz_x2;
1119 if (packed_git_window_size < 1)
1120 packed_git_window_size = 1;
1121 packed_git_window_size *= pgsz_x2;
1122 return 0;
1125 if (!strcmp(var, "core.bigfilethreshold")) {
1126 big_file_threshold = git_config_ulong(var, value);
1127 return 0;
1130 if (!strcmp(var, "core.packedgitlimit")) {
1131 packed_git_limit = git_config_ulong(var, value);
1132 return 0;
1135 if (!strcmp(var, "core.deltabasecachelimit")) {
1136 delta_base_cache_limit = git_config_ulong(var, value);
1137 return 0;
1140 if (!strcmp(var, "core.autocrlf")) {
1141 if (value && !strcasecmp(value, "input")) {
1142 auto_crlf = AUTO_CRLF_INPUT;
1143 return 0;
1145 auto_crlf = git_config_bool(var, value);
1146 return 0;
1149 if (!strcmp(var, "core.safecrlf")) {
1150 if (value && !strcasecmp(value, "warn")) {
1151 safe_crlf = SAFE_CRLF_WARN;
1152 return 0;
1154 safe_crlf = git_config_bool(var, value);
1155 return 0;
1158 if (!strcmp(var, "core.eol")) {
1159 if (value && !strcasecmp(value, "lf"))
1160 core_eol = EOL_LF;
1161 else if (value && !strcasecmp(value, "crlf"))
1162 core_eol = EOL_CRLF;
1163 else if (value && !strcasecmp(value, "native"))
1164 core_eol = EOL_NATIVE;
1165 else
1166 core_eol = EOL_UNSET;
1167 return 0;
1170 if (!strcmp(var, "core.notesref")) {
1171 notes_ref_name = xstrdup(value);
1172 return 0;
1175 if (!strcmp(var, "core.editor"))
1176 return git_config_string(&editor_program, var, value);
1178 if (!strcmp(var, "core.commentchar")) {
1179 if (!value)
1180 return config_error_nonbool(var);
1181 else if (!strcasecmp(value, "auto"))
1182 auto_comment_line_char = 1;
1183 else if (value[0] && !value[1]) {
1184 comment_line_char = value[0];
1185 auto_comment_line_char = 0;
1186 } else
1187 return error("core.commentChar should only be one character");
1188 return 0;
1191 if (!strcmp(var, "core.askpass"))
1192 return git_config_string(&askpass_program, var, value);
1194 if (!strcmp(var, "core.excludesfile"))
1195 return git_config_pathname(&excludes_file, var, value);
1197 if (!strcmp(var, "core.whitespace")) {
1198 if (!value)
1199 return config_error_nonbool(var);
1200 whitespace_rule_cfg = parse_whitespace_rule(value);
1201 return 0;
1204 if (!strcmp(var, "core.fsyncobjectfiles")) {
1205 fsync_object_files = git_config_bool(var, value);
1206 return 0;
1209 if (!strcmp(var, "core.preloadindex")) {
1210 core_preload_index = git_config_bool(var, value);
1211 return 0;
1214 if (!strcmp(var, "core.createobject")) {
1215 if (!strcmp(value, "rename"))
1216 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1217 else if (!strcmp(value, "link"))
1218 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1219 else
1220 die(_("invalid mode for object creation: %s"), value);
1221 return 0;
1224 if (!strcmp(var, "core.sparsecheckout")) {
1225 core_apply_sparse_checkout = git_config_bool(var, value);
1226 return 0;
1229 if (!strcmp(var, "core.precomposeunicode")) {
1230 precomposed_unicode = git_config_bool(var, value);
1231 return 0;
1234 if (!strcmp(var, "core.protecthfs")) {
1235 protect_hfs = git_config_bool(var, value);
1236 return 0;
1239 if (!strcmp(var, "core.protectntfs")) {
1240 protect_ntfs = git_config_bool(var, value);
1241 return 0;
1244 if (!strcmp(var, "core.hidedotfiles")) {
1245 if (value && !strcasecmp(value, "dotgitonly"))
1246 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1247 else
1248 hide_dotfiles = git_config_bool(var, value);
1249 return 0;
1252 /* Add other config variables here and to Documentation/config.txt. */
1253 return 0;
1256 static int git_default_i18n_config(const char *var, const char *value)
1258 if (!strcmp(var, "i18n.commitencoding"))
1259 return git_config_string(&git_commit_encoding, var, value);
1261 if (!strcmp(var, "i18n.logoutputencoding"))
1262 return git_config_string(&git_log_output_encoding, var, value);
1264 /* Add other config variables here and to Documentation/config.txt. */
1265 return 0;
1268 static int git_default_branch_config(const char *var, const char *value)
1270 if (!strcmp(var, "branch.autosetupmerge")) {
1271 if (value && !strcasecmp(value, "always")) {
1272 git_branch_track = BRANCH_TRACK_ALWAYS;
1273 return 0;
1275 git_branch_track = git_config_bool(var, value);
1276 return 0;
1278 if (!strcmp(var, "branch.autosetuprebase")) {
1279 if (!value)
1280 return config_error_nonbool(var);
1281 else if (!strcmp(value, "never"))
1282 autorebase = AUTOREBASE_NEVER;
1283 else if (!strcmp(value, "local"))
1284 autorebase = AUTOREBASE_LOCAL;
1285 else if (!strcmp(value, "remote"))
1286 autorebase = AUTOREBASE_REMOTE;
1287 else if (!strcmp(value, "always"))
1288 autorebase = AUTOREBASE_ALWAYS;
1289 else
1290 return error("malformed value for %s", var);
1291 return 0;
1294 /* Add other config variables here and to Documentation/config.txt. */
1295 return 0;
1298 static int git_default_push_config(const char *var, const char *value)
1300 if (!strcmp(var, "push.default")) {
1301 if (!value)
1302 return config_error_nonbool(var);
1303 else if (!strcmp(value, "nothing"))
1304 push_default = PUSH_DEFAULT_NOTHING;
1305 else if (!strcmp(value, "matching"))
1306 push_default = PUSH_DEFAULT_MATCHING;
1307 else if (!strcmp(value, "simple"))
1308 push_default = PUSH_DEFAULT_SIMPLE;
1309 else if (!strcmp(value, "upstream"))
1310 push_default = PUSH_DEFAULT_UPSTREAM;
1311 else if (!strcmp(value, "tracking")) /* deprecated */
1312 push_default = PUSH_DEFAULT_UPSTREAM;
1313 else if (!strcmp(value, "current"))
1314 push_default = PUSH_DEFAULT_CURRENT;
1315 else {
1316 error("malformed value for %s: %s", var, value);
1317 return error("Must be one of nothing, matching, simple, "
1318 "upstream or current.");
1320 return 0;
1323 /* Add other config variables here and to Documentation/config.txt. */
1324 return 0;
1327 static int git_default_mailmap_config(const char *var, const char *value)
1329 if (!strcmp(var, "mailmap.file"))
1330 return git_config_pathname(&git_mailmap_file, var, value);
1331 if (!strcmp(var, "mailmap.blob"))
1332 return git_config_string(&git_mailmap_blob, var, value);
1334 /* Add other config variables here and to Documentation/config.txt. */
1335 return 0;
1338 int git_default_config(const char *var, const char *value, void *dummy)
1340 if (starts_with(var, "core."))
1341 return git_default_core_config(var, value);
1343 if (starts_with(var, "user."))
1344 return git_ident_config(var, value, dummy);
1346 if (starts_with(var, "i18n."))
1347 return git_default_i18n_config(var, value);
1349 if (starts_with(var, "branch."))
1350 return git_default_branch_config(var, value);
1352 if (starts_with(var, "push."))
1353 return git_default_push_config(var, value);
1355 if (starts_with(var, "mailmap."))
1356 return git_default_mailmap_config(var, value);
1358 if (starts_with(var, "advice."))
1359 return git_default_advice_config(var, value);
1361 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1362 pager_use_color = git_config_bool(var,value);
1363 return 0;
1366 if (!strcmp(var, "pack.packsizelimit")) {
1367 pack_size_limit_cfg = git_config_ulong(var, value);
1368 return 0;
1371 if (!strcmp(var, "pack.compression")) {
1372 int level = git_config_int(var, value);
1373 if (level == -1)
1374 level = Z_DEFAULT_COMPRESSION;
1375 else if (level < 0 || level > Z_BEST_COMPRESSION)
1376 die(_("bad pack compression level %d"), level);
1377 pack_compression_level = level;
1378 pack_compression_seen = 1;
1379 return 0;
1382 /* Add other config variables here and to Documentation/config.txt. */
1383 return 0;
1387 * All source specific fields in the union, die_on_error, name and the callbacks
1388 * fgetc, ungetc, ftell of top need to be initialized before calling
1389 * this function.
1391 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1393 int ret;
1395 /* push config-file parsing state stack */
1396 top->prev = cf;
1397 top->linenr = 1;
1398 top->eof = 0;
1399 strbuf_init(&top->value, 1024);
1400 strbuf_init(&top->var, 1024);
1401 cf = top;
1403 ret = git_parse_source(fn, data);
1405 /* pop config-file parsing state stack */
1406 strbuf_release(&top->value);
1407 strbuf_release(&top->var);
1408 cf = top->prev;
1410 return ret;
1413 static int do_config_from_file(config_fn_t fn,
1414 const enum config_origin_type origin_type,
1415 const char *name, const char *path, FILE *f,
1416 void *data)
1418 struct config_source top;
1420 top.u.file = f;
1421 top.origin_type = origin_type;
1422 top.name = name;
1423 top.path = path;
1424 top.die_on_error = 1;
1425 top.do_fgetc = config_file_fgetc;
1426 top.do_ungetc = config_file_ungetc;
1427 top.do_ftell = config_file_ftell;
1429 return do_config_from(&top, fn, data);
1432 static int git_config_from_stdin(config_fn_t fn, void *data)
1434 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1437 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1439 int ret = -1;
1440 FILE *f;
1442 f = fopen_or_warn(filename, "r");
1443 if (f) {
1444 flockfile(f);
1445 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1446 funlockfile(f);
1447 fclose(f);
1449 return ret;
1452 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1453 const char *name, const char *buf, size_t len, void *data)
1455 struct config_source top;
1457 top.u.buf.buf = buf;
1458 top.u.buf.len = len;
1459 top.u.buf.pos = 0;
1460 top.origin_type = origin_type;
1461 top.name = name;
1462 top.path = NULL;
1463 top.die_on_error = 0;
1464 top.do_fgetc = config_buf_fgetc;
1465 top.do_ungetc = config_buf_ungetc;
1466 top.do_ftell = config_buf_ftell;
1468 return do_config_from(&top, fn, data);
1471 int git_config_from_blob_sha1(config_fn_t fn,
1472 const char *name,
1473 const unsigned char *sha1,
1474 void *data)
1476 enum object_type type;
1477 char *buf;
1478 unsigned long size;
1479 int ret;
1481 buf = read_sha1_file(sha1, &type, &size);
1482 if (!buf)
1483 return error("unable to load config blob object '%s'", name);
1484 if (type != OBJ_BLOB) {
1485 free(buf);
1486 return error("reference '%s' does not point to a blob", name);
1489 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1490 free(buf);
1492 return ret;
1495 static int git_config_from_blob_ref(config_fn_t fn,
1496 const char *name,
1497 void *data)
1499 unsigned char sha1[20];
1501 if (get_sha1(name, sha1) < 0)
1502 return error("unable to resolve config blob '%s'", name);
1503 return git_config_from_blob_sha1(fn, name, sha1, data);
1506 const char *git_etc_gitconfig(void)
1508 static const char *system_wide;
1509 if (!system_wide)
1510 system_wide = system_path(ETC_GITCONFIG);
1511 return system_wide;
1515 * Parse environment variable 'k' as a boolean (in various
1516 * possible spellings); if missing, use the default value 'def'.
1518 int git_env_bool(const char *k, int def)
1520 const char *v = getenv(k);
1521 return v ? git_config_bool(k, v) : def;
1525 * Parse environment variable 'k' as ulong with possibly a unit
1526 * suffix; if missing, use the default value 'val'.
1528 unsigned long git_env_ulong(const char *k, unsigned long val)
1530 const char *v = getenv(k);
1531 if (v && !git_parse_ulong(v, &val))
1532 die("failed to parse %s", k);
1533 return val;
1536 int git_config_system(void)
1538 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1541 static int do_git_config_sequence(const struct config_options *opts,
1542 config_fn_t fn, void *data)
1544 int ret = 0;
1545 char *xdg_config = xdg_config_home("config");
1546 char *user_config = expand_user_path("~/.gitconfig", 0);
1547 char *repo_config;
1549 if (opts->git_dir)
1550 repo_config = mkpathdup("%s/config", opts->git_dir);
1551 else if (have_git_dir())
1552 repo_config = git_pathdup("config");
1553 else
1554 repo_config = NULL;
1556 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1557 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1558 ret += git_config_from_file(fn, git_etc_gitconfig(),
1559 data);
1561 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1562 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1563 ret += git_config_from_file(fn, xdg_config, data);
1565 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1566 ret += git_config_from_file(fn, user_config, data);
1568 current_parsing_scope = CONFIG_SCOPE_REPO;
1569 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1570 ret += git_config_from_file(fn, repo_config, data);
1572 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1573 if (git_config_from_parameters(fn, data) < 0)
1574 die(_("unable to parse command-line config"));
1576 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1577 free(xdg_config);
1578 free(user_config);
1579 free(repo_config);
1580 return ret;
1583 int git_config_with_options(config_fn_t fn, void *data,
1584 struct git_config_source *config_source,
1585 const struct config_options *opts)
1587 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1589 if (opts->respect_includes) {
1590 inc.fn = fn;
1591 inc.data = data;
1592 inc.opts = opts;
1593 fn = git_config_include;
1594 data = &inc;
1598 * If we have a specific filename, use it. Otherwise, follow the
1599 * regular lookup sequence.
1601 if (config_source && config_source->use_stdin)
1602 return git_config_from_stdin(fn, data);
1603 else if (config_source && config_source->file)
1604 return git_config_from_file(fn, config_source->file, data);
1605 else if (config_source && config_source->blob)
1606 return git_config_from_blob_ref(fn, config_source->blob, data);
1608 return do_git_config_sequence(opts, fn, data);
1611 static void git_config_raw(config_fn_t fn, void *data)
1613 struct config_options opts = {0};
1615 opts.respect_includes = 1;
1616 if (git_config_with_options(fn, data, NULL, &opts) < 0)
1618 * git_config_with_options() normally returns only
1619 * zero, as most errors are fatal, and
1620 * non-fatal potential errors are guarded by "if"
1621 * statements that are entered only when no error is
1622 * possible.
1624 * If we ever encounter a non-fatal error, it means
1625 * something went really wrong and we should stop
1626 * immediately.
1628 die(_("unknown error occurred while reading the configuration files"));
1631 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1633 int i, value_index;
1634 struct string_list *values;
1635 struct config_set_element *entry;
1636 struct configset_list *list = &cs->list;
1638 for (i = 0; i < list->nr; i++) {
1639 entry = list->items[i].e;
1640 value_index = list->items[i].value_index;
1641 values = &entry->value_list;
1643 current_config_kvi = values->items[value_index].util;
1645 if (fn(entry->key, values->items[value_index].string, data) < 0)
1646 git_die_config_linenr(entry->key,
1647 current_config_kvi->filename,
1648 current_config_kvi->linenr);
1650 current_config_kvi = NULL;
1654 void read_early_config(config_fn_t cb, void *data)
1656 struct config_options opts = {0};
1657 struct strbuf buf = STRBUF_INIT;
1659 opts.respect_includes = 1;
1661 if (have_git_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(&buf))
1672 opts.git_dir = buf.buf;
1674 git_config_with_options(cb, data, NULL, &opts);
1676 strbuf_release(&buf);
1679 static void git_config_check_init(void);
1681 void git_config(config_fn_t fn, void *data)
1683 git_config_check_init();
1684 configset_iter(&the_config_set, fn, data);
1687 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1689 struct config_set_element k;
1690 struct config_set_element *found_entry;
1691 char *normalized_key;
1693 * `key` may come from the user, so normalize it before using it
1694 * for querying entries from the hashmap.
1696 if (git_config_parse_key(key, &normalized_key, NULL))
1697 return NULL;
1699 hashmap_entry_init(&k, strhash(normalized_key));
1700 k.key = normalized_key;
1701 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1702 free(normalized_key);
1703 return found_entry;
1706 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1708 struct config_set_element *e;
1709 struct string_list_item *si;
1710 struct configset_list_item *l_item;
1711 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1713 e = configset_find_element(cs, key);
1715 * Since the keys are being fed by git_config*() callback mechanism, they
1716 * are already normalized. So simply add them without any further munging.
1718 if (!e) {
1719 e = xmalloc(sizeof(*e));
1720 hashmap_entry_init(e, strhash(key));
1721 e->key = xstrdup(key);
1722 string_list_init(&e->value_list, 1);
1723 hashmap_add(&cs->config_hash, e);
1725 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1727 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1728 l_item = &cs->list.items[cs->list.nr++];
1729 l_item->e = e;
1730 l_item->value_index = e->value_list.nr - 1;
1732 if (!cf)
1733 die("BUG: configset_add_value has no source");
1734 if (cf->name) {
1735 kv_info->filename = strintern(cf->name);
1736 kv_info->linenr = cf->linenr;
1737 kv_info->origin_type = cf->origin_type;
1738 } else {
1739 /* for values read from `git_config_from_parameters()` */
1740 kv_info->filename = NULL;
1741 kv_info->linenr = -1;
1742 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1744 kv_info->scope = current_parsing_scope;
1745 si->util = kv_info;
1747 return 0;
1750 static int config_set_element_cmp(const struct config_set_element *e1,
1751 const struct config_set_element *e2, const void *unused)
1753 return strcmp(e1->key, e2->key);
1756 void git_configset_init(struct config_set *cs)
1758 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 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_config_maybe_bool(key, 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 static void git_config_check_init(void)
1898 if (the_config_set.hash_initialized)
1899 return;
1900 git_configset_init(&the_config_set);
1901 git_config_raw(config_set_callback, &the_config_set);
1904 void git_config_clear(void)
1906 if (!the_config_set.hash_initialized)
1907 return;
1908 git_configset_clear(&the_config_set);
1911 int git_config_get_value(const char *key, const char **value)
1913 git_config_check_init();
1914 return git_configset_get_value(&the_config_set, key, value);
1917 const struct string_list *git_config_get_value_multi(const char *key)
1919 git_config_check_init();
1920 return git_configset_get_value_multi(&the_config_set, key);
1923 int git_config_get_string_const(const char *key, const char **dest)
1925 int ret;
1926 git_config_check_init();
1927 ret = git_configset_get_string_const(&the_config_set, key, dest);
1928 if (ret < 0)
1929 git_die_config(key, NULL);
1930 return ret;
1933 int git_config_get_string(const char *key, char **dest)
1935 git_config_check_init();
1936 return git_config_get_string_const(key, (const char **)dest);
1939 int git_config_get_int(const char *key, int *dest)
1941 git_config_check_init();
1942 return git_configset_get_int(&the_config_set, key, dest);
1945 int git_config_get_ulong(const char *key, unsigned long *dest)
1947 git_config_check_init();
1948 return git_configset_get_ulong(&the_config_set, key, dest);
1951 int git_config_get_bool(const char *key, int *dest)
1953 git_config_check_init();
1954 return git_configset_get_bool(&the_config_set, key, dest);
1957 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1959 git_config_check_init();
1960 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1963 int git_config_get_maybe_bool(const char *key, int *dest)
1965 git_config_check_init();
1966 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1969 int git_config_get_pathname(const char *key, const char **dest)
1971 int ret;
1972 git_config_check_init();
1973 ret = git_configset_get_pathname(&the_config_set, key, dest);
1974 if (ret < 0)
1975 git_die_config(key, NULL);
1976 return ret;
1979 int git_config_get_expiry(const char *key, const char **output)
1981 int ret = git_config_get_string_const(key, output);
1982 if (ret)
1983 return ret;
1984 if (strcmp(*output, "now")) {
1985 timestamp_t now = approxidate("now");
1986 if (approxidate(*output) >= now)
1987 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
1989 return ret;
1992 int git_config_get_untracked_cache(void)
1994 int val = -1;
1995 const char *v;
1997 /* Hack for test programs like test-dump-untracked-cache */
1998 if (ignore_untracked_cache_config)
1999 return -1;
2001 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2002 return val;
2004 if (!git_config_get_value("core.untrackedcache", &v)) {
2005 if (!strcasecmp(v, "keep"))
2006 return -1;
2008 error(_("unknown core.untrackedCache value '%s'; "
2009 "using 'keep' default value"), v);
2010 return -1;
2013 return -1; /* default value */
2016 int git_config_get_split_index(void)
2018 int val;
2020 if (!git_config_get_maybe_bool("core.splitindex", &val))
2021 return val;
2023 return -1; /* default value */
2026 int git_config_get_max_percent_split_change(void)
2028 int val = -1;
2030 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2031 if (0 <= val && val <= 100)
2032 return val;
2034 return error(_("splitIndex.maxPercentChange value '%d' "
2035 "should be between 0 and 100"), val);
2038 return -1; /* default value */
2041 NORETURN
2042 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2044 if (!filename)
2045 die(_("unable to parse '%s' from command-line config"), key);
2046 else
2047 die(_("bad config variable '%s' in file '%s' at line %d"),
2048 key, filename, linenr);
2051 NORETURN __attribute__((format(printf, 2, 3)))
2052 void git_die_config(const char *key, const char *err, ...)
2054 const struct string_list *values;
2055 struct key_value_info *kv_info;
2057 if (err) {
2058 va_list params;
2059 va_start(params, err);
2060 vreportf("error: ", err, params);
2061 va_end(params);
2063 values = git_config_get_value_multi(key);
2064 kv_info = values->items[values->nr - 1].util;
2065 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2069 * Find all the stuff for git_config_set() below.
2072 static struct {
2073 int baselen;
2074 char *key;
2075 int do_not_match;
2076 regex_t *value_regex;
2077 int multi_replace;
2078 size_t *offset;
2079 unsigned int offset_alloc;
2080 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2081 int seen;
2082 } store;
2084 static int matches(const char *key, const char *value)
2086 if (strcmp(key, store.key))
2087 return 0; /* not ours */
2088 if (!store.value_regex)
2089 return 1; /* always matches */
2090 if (store.value_regex == CONFIG_REGEX_NONE)
2091 return 0; /* never matches */
2093 return store.do_not_match ^
2094 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2097 static int store_aux(const char *key, const char *value, void *cb)
2099 const char *ep;
2100 size_t section_len;
2102 switch (store.state) {
2103 case KEY_SEEN:
2104 if (matches(key, value)) {
2105 if (store.seen == 1 && store.multi_replace == 0) {
2106 warning(_("%s has multiple values"), key);
2109 ALLOC_GROW(store.offset, store.seen + 1,
2110 store.offset_alloc);
2112 store.offset[store.seen] = cf->do_ftell(cf);
2113 store.seen++;
2115 break;
2116 case SECTION_SEEN:
2118 * What we are looking for is in store.key (both
2119 * section and var), and its section part is baselen
2120 * long. We found key (again, both section and var).
2121 * We would want to know if this key is in the same
2122 * section as what we are looking for. We already
2123 * know we are in the same section as what should
2124 * hold store.key.
2126 ep = strrchr(key, '.');
2127 section_len = ep - key;
2129 if ((section_len != store.baselen) ||
2130 memcmp(key, store.key, section_len+1)) {
2131 store.state = SECTION_END_SEEN;
2132 break;
2136 * Do not increment matches: this is no match, but we
2137 * just made sure we are in the desired section.
2139 ALLOC_GROW(store.offset, store.seen + 1,
2140 store.offset_alloc);
2141 store.offset[store.seen] = cf->do_ftell(cf);
2142 /* fallthru */
2143 case SECTION_END_SEEN:
2144 case START:
2145 if (matches(key, value)) {
2146 ALLOC_GROW(store.offset, store.seen + 1,
2147 store.offset_alloc);
2148 store.offset[store.seen] = cf->do_ftell(cf);
2149 store.state = KEY_SEEN;
2150 store.seen++;
2151 } else {
2152 if (strrchr(key, '.') - key == store.baselen &&
2153 !strncmp(key, store.key, store.baselen)) {
2154 store.state = SECTION_SEEN;
2155 ALLOC_GROW(store.offset,
2156 store.seen + 1,
2157 store.offset_alloc);
2158 store.offset[store.seen] = cf->do_ftell(cf);
2162 return 0;
2165 static int write_error(const char *filename)
2167 error("failed to write new configuration file %s", filename);
2169 /* Same error code as "failed to rename". */
2170 return 4;
2173 static int store_write_section(int fd, const char *key)
2175 const char *dot;
2176 int i, success;
2177 struct strbuf sb = STRBUF_INIT;
2179 dot = memchr(key, '.', store.baselen);
2180 if (dot) {
2181 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2182 for (i = dot - key + 1; i < store.baselen; i++) {
2183 if (key[i] == '"' || key[i] == '\\')
2184 strbuf_addch(&sb, '\\');
2185 strbuf_addch(&sb, key[i]);
2187 strbuf_addstr(&sb, "\"]\n");
2188 } else {
2189 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2192 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2193 strbuf_release(&sb);
2195 return success;
2198 static int store_write_pair(int fd, const char *key, const char *value)
2200 int i, success;
2201 int length = strlen(key + store.baselen + 1);
2202 const char *quote = "";
2203 struct strbuf sb = STRBUF_INIT;
2206 * Check to see if the value needs to be surrounded with a dq pair.
2207 * Note that problematic characters are always backslash-quoted; this
2208 * check is about not losing leading or trailing SP and strings that
2209 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2210 * configuration parser.
2212 if (value[0] == ' ')
2213 quote = "\"";
2214 for (i = 0; value[i]; i++)
2215 if (value[i] == ';' || value[i] == '#')
2216 quote = "\"";
2217 if (i && value[i - 1] == ' ')
2218 quote = "\"";
2220 strbuf_addf(&sb, "\t%.*s = %s",
2221 length, key + store.baselen + 1, quote);
2223 for (i = 0; value[i]; i++)
2224 switch (value[i]) {
2225 case '\n':
2226 strbuf_addstr(&sb, "\\n");
2227 break;
2228 case '\t':
2229 strbuf_addstr(&sb, "\\t");
2230 break;
2231 case '"':
2232 case '\\':
2233 strbuf_addch(&sb, '\\');
2234 default:
2235 strbuf_addch(&sb, value[i]);
2236 break;
2238 strbuf_addf(&sb, "%s\n", quote);
2240 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2241 strbuf_release(&sb);
2243 return success;
2246 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2247 size_t offset_, int *found_bracket)
2249 size_t equal_offset = size, bracket_offset = size;
2250 ssize_t offset;
2252 contline:
2253 for (offset = offset_-2; offset > 0
2254 && contents[offset] != '\n'; offset--)
2255 switch (contents[offset]) {
2256 case '=': equal_offset = offset; break;
2257 case ']': bracket_offset = offset; break;
2259 if (offset > 0 && contents[offset-1] == '\\') {
2260 offset_ = offset;
2261 goto contline;
2263 if (bracket_offset < equal_offset) {
2264 *found_bracket = 1;
2265 offset = bracket_offset+1;
2266 } else
2267 offset++;
2269 return offset;
2272 int git_config_set_in_file_gently(const char *config_filename,
2273 const char *key, const char *value)
2275 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2278 void git_config_set_in_file(const char *config_filename,
2279 const char *key, const char *value)
2281 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2284 int git_config_set_gently(const char *key, const char *value)
2286 return git_config_set_multivar_gently(key, value, NULL, 0);
2289 void git_config_set(const char *key, const char *value)
2291 git_config_set_multivar(key, value, NULL, 0);
2295 * If value==NULL, unset in (remove from) config,
2296 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2297 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2298 * (only add a new one)
2299 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2300 * else all matching key/values (regardless how many) are removed,
2301 * before the new pair is written.
2303 * Returns 0 on success.
2305 * This function does this:
2307 * - it locks the config file by creating ".git/config.lock"
2309 * - it then parses the config using store_aux() as validator to find
2310 * the position on the key/value pair to replace. If it is to be unset,
2311 * it must be found exactly once.
2313 * - the config file is mmap()ed and the part before the match (if any) is
2314 * written to the lock file, then the changed part and the rest.
2316 * - the config file is removed and the lock file rename()d to it.
2319 int git_config_set_multivar_in_file_gently(const char *config_filename,
2320 const char *key, const char *value,
2321 const char *value_regex,
2322 int multi_replace)
2324 int fd = -1, in_fd = -1;
2325 int ret;
2326 struct lock_file *lock = NULL;
2327 char *filename_buf = NULL;
2328 char *contents = NULL;
2329 size_t contents_sz;
2331 /* parse-key returns negative; flip the sign to feed exit(3) */
2332 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2333 if (ret)
2334 goto out_free;
2336 store.multi_replace = multi_replace;
2338 if (!config_filename)
2339 config_filename = filename_buf = git_pathdup("config");
2342 * The lock serves a purpose in addition to locking: the new
2343 * contents of .git/config will be written into it.
2345 lock = xcalloc(1, sizeof(struct lock_file));
2346 fd = hold_lock_file_for_update(lock, config_filename, 0);
2347 if (fd < 0) {
2348 error_errno("could not lock config file %s", config_filename);
2349 free(store.key);
2350 ret = CONFIG_NO_LOCK;
2351 goto out_free;
2355 * If .git/config does not exist yet, write a minimal version.
2357 in_fd = open(config_filename, O_RDONLY);
2358 if ( in_fd < 0 ) {
2359 free(store.key);
2361 if ( ENOENT != errno ) {
2362 error_errno("opening %s", config_filename);
2363 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2364 goto out_free;
2366 /* if nothing to unset, error out */
2367 if (value == NULL) {
2368 ret = CONFIG_NOTHING_SET;
2369 goto out_free;
2372 store.key = (char *)key;
2373 if (!store_write_section(fd, key) ||
2374 !store_write_pair(fd, key, value))
2375 goto write_err_out;
2376 } else {
2377 struct stat st;
2378 size_t copy_begin, copy_end;
2379 int i, new_line = 0;
2381 if (value_regex == NULL)
2382 store.value_regex = NULL;
2383 else if (value_regex == CONFIG_REGEX_NONE)
2384 store.value_regex = CONFIG_REGEX_NONE;
2385 else {
2386 if (value_regex[0] == '!') {
2387 store.do_not_match = 1;
2388 value_regex++;
2389 } else
2390 store.do_not_match = 0;
2392 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2393 if (regcomp(store.value_regex, value_regex,
2394 REG_EXTENDED)) {
2395 error("invalid pattern: %s", value_regex);
2396 free(store.value_regex);
2397 ret = CONFIG_INVALID_PATTERN;
2398 goto out_free;
2402 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2403 store.offset[0] = 0;
2404 store.state = START;
2405 store.seen = 0;
2408 * After this, store.offset will contain the *end* offset
2409 * of the last match, or remain at 0 if no match was found.
2410 * As a side effect, we make sure to transform only a valid
2411 * existing config file.
2413 if (git_config_from_file(store_aux, config_filename, NULL)) {
2414 error("invalid config file %s", config_filename);
2415 free(store.key);
2416 if (store.value_regex != NULL &&
2417 store.value_regex != CONFIG_REGEX_NONE) {
2418 regfree(store.value_regex);
2419 free(store.value_regex);
2421 ret = CONFIG_INVALID_FILE;
2422 goto out_free;
2425 free(store.key);
2426 if (store.value_regex != NULL &&
2427 store.value_regex != CONFIG_REGEX_NONE) {
2428 regfree(store.value_regex);
2429 free(store.value_regex);
2432 /* if nothing to unset, or too many matches, error out */
2433 if ((store.seen == 0 && value == NULL) ||
2434 (store.seen > 1 && multi_replace == 0)) {
2435 ret = CONFIG_NOTHING_SET;
2436 goto out_free;
2439 if (fstat(in_fd, &st) == -1) {
2440 error_errno(_("fstat on %s failed"), config_filename);
2441 ret = CONFIG_INVALID_FILE;
2442 goto out_free;
2445 contents_sz = xsize_t(st.st_size);
2446 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2447 MAP_PRIVATE, in_fd, 0);
2448 if (contents == MAP_FAILED) {
2449 if (errno == ENODEV && S_ISDIR(st.st_mode))
2450 errno = EISDIR;
2451 error_errno("unable to mmap '%s'", config_filename);
2452 ret = CONFIG_INVALID_FILE;
2453 contents = NULL;
2454 goto out_free;
2456 close(in_fd);
2457 in_fd = -1;
2459 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2460 error_errno("chmod on %s failed", get_lock_file_path(lock));
2461 ret = CONFIG_NO_WRITE;
2462 goto out_free;
2465 if (store.seen == 0)
2466 store.seen = 1;
2468 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2469 if (store.offset[i] == 0) {
2470 store.offset[i] = copy_end = contents_sz;
2471 } else if (store.state != KEY_SEEN) {
2472 copy_end = store.offset[i];
2473 } else
2474 copy_end = find_beginning_of_line(
2475 contents, contents_sz,
2476 store.offset[i]-2, &new_line);
2478 if (copy_end > 0 && contents[copy_end-1] != '\n')
2479 new_line = 1;
2481 /* write the first part of the config */
2482 if (copy_end > copy_begin) {
2483 if (write_in_full(fd, contents + copy_begin,
2484 copy_end - copy_begin) <
2485 copy_end - copy_begin)
2486 goto write_err_out;
2487 if (new_line &&
2488 write_str_in_full(fd, "\n") != 1)
2489 goto write_err_out;
2491 copy_begin = store.offset[i];
2494 /* write the pair (value == NULL means unset) */
2495 if (value != NULL) {
2496 if (store.state == START) {
2497 if (!store_write_section(fd, key))
2498 goto write_err_out;
2500 if (!store_write_pair(fd, key, value))
2501 goto write_err_out;
2504 /* write the rest of the config */
2505 if (copy_begin < contents_sz)
2506 if (write_in_full(fd, contents + copy_begin,
2507 contents_sz - copy_begin) <
2508 contents_sz - copy_begin)
2509 goto write_err_out;
2511 munmap(contents, contents_sz);
2512 contents = NULL;
2515 if (commit_lock_file(lock) < 0) {
2516 error_errno("could not write config file %s", config_filename);
2517 ret = CONFIG_NO_WRITE;
2518 lock = NULL;
2519 goto out_free;
2523 * lock is committed, so don't try to roll it back below.
2524 * NOTE: Since lockfile.c keeps a linked list of all created
2525 * lock_file structures, it isn't safe to free(lock). It's
2526 * better to just leave it hanging around.
2528 lock = NULL;
2529 ret = 0;
2531 /* Invalidate the config cache */
2532 git_config_clear();
2534 out_free:
2535 if (lock)
2536 rollback_lock_file(lock);
2537 free(filename_buf);
2538 if (contents)
2539 munmap(contents, contents_sz);
2540 if (in_fd >= 0)
2541 close(in_fd);
2542 return ret;
2544 write_err_out:
2545 ret = write_error(get_lock_file_path(lock));
2546 goto out_free;
2550 void git_config_set_multivar_in_file(const char *config_filename,
2551 const char *key, const char *value,
2552 const char *value_regex, int multi_replace)
2554 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2555 value_regex, multi_replace))
2556 return;
2557 if (value)
2558 die(_("could not set '%s' to '%s'"), key, value);
2559 else
2560 die(_("could not unset '%s'"), key);
2563 int git_config_set_multivar_gently(const char *key, const char *value,
2564 const char *value_regex, int multi_replace)
2566 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2567 multi_replace);
2570 void git_config_set_multivar(const char *key, const char *value,
2571 const char *value_regex, int multi_replace)
2573 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2574 multi_replace);
2577 static int section_name_match (const char *buf, const char *name)
2579 int i = 0, j = 0, dot = 0;
2580 if (buf[i] != '[')
2581 return 0;
2582 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2583 if (!dot && isspace(buf[i])) {
2584 dot = 1;
2585 if (name[j++] != '.')
2586 break;
2587 for (i++; isspace(buf[i]); i++)
2588 ; /* do nothing */
2589 if (buf[i] != '"')
2590 break;
2591 continue;
2593 if (buf[i] == '\\' && dot)
2594 i++;
2595 else if (buf[i] == '"' && dot) {
2596 for (i++; isspace(buf[i]); i++)
2597 ; /* do_nothing */
2598 break;
2600 if (buf[i] != name[j++])
2601 break;
2603 if (buf[i] == ']' && name[j] == 0) {
2605 * We match, now just find the right length offset by
2606 * gobbling up any whitespace after it, as well
2608 i++;
2609 for (; buf[i] && isspace(buf[i]); i++)
2610 ; /* do nothing */
2611 return i;
2613 return 0;
2616 static int section_name_is_ok(const char *name)
2618 /* Empty section names are bogus. */
2619 if (!*name)
2620 return 0;
2623 * Before a dot, we must be alphanumeric or dash. After the first dot,
2624 * anything goes, so we can stop checking.
2626 for (; *name && *name != '.'; name++)
2627 if (*name != '-' && !isalnum(*name))
2628 return 0;
2629 return 1;
2632 /* if new_name == NULL, the section is removed instead */
2633 int git_config_rename_section_in_file(const char *config_filename,
2634 const char *old_name, const char *new_name)
2636 int ret = 0, remove = 0;
2637 char *filename_buf = NULL;
2638 struct lock_file *lock;
2639 int out_fd;
2640 char buf[1024];
2641 FILE *config_file = NULL;
2642 struct stat st;
2644 if (new_name && !section_name_is_ok(new_name)) {
2645 ret = error("invalid section name: %s", new_name);
2646 goto out_no_rollback;
2649 if (!config_filename)
2650 config_filename = filename_buf = git_pathdup("config");
2652 lock = xcalloc(1, sizeof(struct lock_file));
2653 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2654 if (out_fd < 0) {
2655 ret = error("could not lock config file %s", config_filename);
2656 goto out;
2659 if (!(config_file = fopen(config_filename, "rb"))) {
2660 ret = warn_on_fopen_errors(config_filename);
2661 if (ret)
2662 goto out;
2663 /* no config file means nothing to rename, no error */
2664 goto commit_and_out;
2667 if (fstat(fileno(config_file), &st) == -1) {
2668 ret = error_errno(_("fstat on %s failed"), config_filename);
2669 goto out;
2672 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2673 ret = error_errno("chmod on %s failed",
2674 get_lock_file_path(lock));
2675 goto out;
2678 while (fgets(buf, sizeof(buf), config_file)) {
2679 int i;
2680 int length;
2681 char *output = buf;
2682 for (i = 0; buf[i] && isspace(buf[i]); i++)
2683 ; /* do nothing */
2684 if (buf[i] == '[') {
2685 /* it's a section */
2686 int offset = section_name_match(&buf[i], old_name);
2687 if (offset > 0) {
2688 ret++;
2689 if (new_name == NULL) {
2690 remove = 1;
2691 continue;
2693 store.baselen = strlen(new_name);
2694 if (!store_write_section(out_fd, new_name)) {
2695 ret = write_error(get_lock_file_path(lock));
2696 goto out;
2699 * We wrote out the new section, with
2700 * a newline, now skip the old
2701 * section's length
2703 output += offset + i;
2704 if (strlen(output) > 0) {
2706 * More content means there's
2707 * a declaration to put on the
2708 * next line; indent with a
2709 * tab
2711 output -= 1;
2712 output[0] = '\t';
2715 remove = 0;
2717 if (remove)
2718 continue;
2719 length = strlen(output);
2720 if (write_in_full(out_fd, output, length) != length) {
2721 ret = write_error(get_lock_file_path(lock));
2722 goto out;
2725 fclose(config_file);
2726 config_file = NULL;
2727 commit_and_out:
2728 if (commit_lock_file(lock) < 0)
2729 ret = error_errno("could not write config file %s",
2730 config_filename);
2731 out:
2732 if (config_file)
2733 fclose(config_file);
2734 rollback_lock_file(lock);
2735 out_no_rollback:
2736 free(filename_buf);
2737 return ret;
2740 int git_config_rename_section(const char *old_name, const char *new_name)
2742 return git_config_rename_section_in_file(NULL, old_name, new_name);
2746 * Call this to report error for your variable that should not
2747 * get a boolean value (i.e. "[my] var" means "true").
2749 #undef config_error_nonbool
2750 int config_error_nonbool(const char *var)
2752 return error("missing value for '%s'", var);
2755 int parse_config_key(const char *var,
2756 const char *section,
2757 const char **subsection, int *subsection_len,
2758 const char **key)
2760 const char *dot;
2762 /* Does it start with "section." ? */
2763 if (!skip_prefix(var, section, &var) || *var != '.')
2764 return -1;
2767 * Find the key; we don't know yet if we have a subsection, but we must
2768 * parse backwards from the end, since the subsection may have dots in
2769 * it, too.
2771 dot = strrchr(var, '.');
2772 *key = dot + 1;
2774 /* Did we have a subsection at all? */
2775 if (dot == var) {
2776 if (subsection) {
2777 *subsection = NULL;
2778 *subsection_len = 0;
2781 else {
2782 if (!subsection)
2783 return -1;
2784 *subsection = var + 1;
2785 *subsection_len = dot - *subsection;
2788 return 0;
2791 const char *current_config_origin_type(void)
2793 int type;
2794 if (current_config_kvi)
2795 type = current_config_kvi->origin_type;
2796 else if(cf)
2797 type = cf->origin_type;
2798 else
2799 die("BUG: current_config_origin_type called outside config callback");
2801 switch (type) {
2802 case CONFIG_ORIGIN_BLOB:
2803 return "blob";
2804 case CONFIG_ORIGIN_FILE:
2805 return "file";
2806 case CONFIG_ORIGIN_STDIN:
2807 return "standard input";
2808 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2809 return "submodule-blob";
2810 case CONFIG_ORIGIN_CMDLINE:
2811 return "command line";
2812 default:
2813 die("BUG: unknown config origin type");
2817 const char *current_config_name(void)
2819 const char *name;
2820 if (current_config_kvi)
2821 name = current_config_kvi->filename;
2822 else if (cf)
2823 name = cf->name;
2824 else
2825 die("BUG: current_config_name called outside config callback");
2826 return name ? name : "";
2829 enum config_scope current_config_scope(void)
2831 if (current_config_kvi)
2832 return current_config_kvi->scope;
2833 else
2834 return current_parsing_scope;