doc: describe git svn init --ignore-refs
[git/git-svn.git] / config.c
blob146cb3452adab3115f15d30c2b0f9f5480344279
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 cf->linenr++;
608 return ret;
611 static int get_extended_base_var(struct strbuf *name, int c)
613 do {
614 if (c == '\n')
615 goto error_incomplete_line;
616 c = get_next_char();
617 } while (isspace(c));
619 /* We require the format to be '[base "extension"]' */
620 if (c != '"')
621 return -1;
622 strbuf_addch(name, '.');
624 for (;;) {
625 int c = get_next_char();
626 if (c == '\n')
627 goto error_incomplete_line;
628 if (c == '"')
629 break;
630 if (c == '\\') {
631 c = get_next_char();
632 if (c == '\n')
633 goto error_incomplete_line;
635 strbuf_addch(name, c);
638 /* Final ']' */
639 if (get_next_char() != ']')
640 return -1;
641 return 0;
642 error_incomplete_line:
643 cf->linenr--;
644 return -1;
647 static int get_base_var(struct strbuf *name)
649 for (;;) {
650 int c = get_next_char();
651 if (cf->eof)
652 return -1;
653 if (c == ']')
654 return 0;
655 if (isspace(c))
656 return get_extended_base_var(name, c);
657 if (!iskeychar(c) && c != '.')
658 return -1;
659 strbuf_addch(name, tolower(c));
663 static int git_parse_source(config_fn_t fn, void *data)
665 int comment = 0;
666 int baselen = 0;
667 struct strbuf *var = &cf->var;
668 int error_return = 0;
669 char *error_msg = NULL;
671 /* U+FEFF Byte Order Mark in UTF8 */
672 const char *bomptr = utf8_bom;
674 for (;;) {
675 int c = get_next_char();
676 if (bomptr && *bomptr) {
677 /* We are at the file beginning; skip UTF8-encoded BOM
678 * if present. Sane editors won't put this in on their
679 * own, but e.g. Windows Notepad will do it happily. */
680 if (c == (*bomptr & 0377)) {
681 bomptr++;
682 continue;
683 } else {
684 /* Do not tolerate partial BOM. */
685 if (bomptr != utf8_bom)
686 break;
687 /* No BOM at file beginning. Cool. */
688 bomptr = NULL;
691 if (c == '\n') {
692 if (cf->eof)
693 return 0;
694 comment = 0;
695 continue;
697 if (comment || isspace(c))
698 continue;
699 if (c == '#' || c == ';') {
700 comment = 1;
701 continue;
703 if (c == '[') {
704 /* Reset prior to determining a new stem */
705 strbuf_reset(var);
706 if (get_base_var(var) < 0 || var->len < 1)
707 break;
708 strbuf_addch(var, '.');
709 baselen = var->len;
710 continue;
712 if (!isalpha(c))
713 break;
715 * Truncate the var name back to the section header
716 * stem prior to grabbing the suffix part of the name
717 * and the value.
719 strbuf_setlen(var, baselen);
720 strbuf_addch(var, tolower(c));
721 if (get_value(fn, data, var) < 0)
722 break;
725 switch (cf->origin_type) {
726 case CONFIG_ORIGIN_BLOB:
727 error_msg = xstrfmt(_("bad config line %d in blob %s"),
728 cf->linenr, cf->name);
729 break;
730 case CONFIG_ORIGIN_FILE:
731 error_msg = xstrfmt(_("bad config line %d in file %s"),
732 cf->linenr, cf->name);
733 break;
734 case CONFIG_ORIGIN_STDIN:
735 error_msg = xstrfmt(_("bad config line %d in standard input"),
736 cf->linenr);
737 break;
738 case CONFIG_ORIGIN_SUBMODULE_BLOB:
739 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
740 cf->linenr, cf->name);
741 break;
742 case CONFIG_ORIGIN_CMDLINE:
743 error_msg = xstrfmt(_("bad config line %d in command line %s"),
744 cf->linenr, cf->name);
745 break;
746 default:
747 error_msg = xstrfmt(_("bad config line %d in %s"),
748 cf->linenr, cf->name);
751 if (cf->die_on_error)
752 die("%s", error_msg);
753 else
754 error_return = error("%s", error_msg);
756 free(error_msg);
757 return error_return;
760 static int parse_unit_factor(const char *end, uintmax_t *val)
762 if (!*end)
763 return 1;
764 else if (!strcasecmp(end, "k")) {
765 *val *= 1024;
766 return 1;
768 else if (!strcasecmp(end, "m")) {
769 *val *= 1024 * 1024;
770 return 1;
772 else if (!strcasecmp(end, "g")) {
773 *val *= 1024 * 1024 * 1024;
774 return 1;
776 return 0;
779 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
781 if (value && *value) {
782 char *end;
783 intmax_t val;
784 uintmax_t uval;
785 uintmax_t factor = 1;
787 errno = 0;
788 val = strtoimax(value, &end, 0);
789 if (errno == ERANGE)
790 return 0;
791 if (!parse_unit_factor(end, &factor)) {
792 errno = EINVAL;
793 return 0;
795 uval = labs(val);
796 uval *= factor;
797 if (uval > max || labs(val) > uval) {
798 errno = ERANGE;
799 return 0;
801 val *= factor;
802 *ret = val;
803 return 1;
805 errno = EINVAL;
806 return 0;
809 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
811 if (value && *value) {
812 char *end;
813 uintmax_t val;
814 uintmax_t oldval;
816 errno = 0;
817 val = strtoumax(value, &end, 0);
818 if (errno == ERANGE)
819 return 0;
820 oldval = val;
821 if (!parse_unit_factor(end, &val)) {
822 errno = EINVAL;
823 return 0;
825 if (val > max || oldval > val) {
826 errno = ERANGE;
827 return 0;
829 *ret = val;
830 return 1;
832 errno = EINVAL;
833 return 0;
836 static int git_parse_int(const char *value, int *ret)
838 intmax_t tmp;
839 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
840 return 0;
841 *ret = tmp;
842 return 1;
845 static int git_parse_int64(const char *value, int64_t *ret)
847 intmax_t tmp;
848 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
849 return 0;
850 *ret = tmp;
851 return 1;
854 int git_parse_ulong(const char *value, unsigned long *ret)
856 uintmax_t tmp;
857 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
858 return 0;
859 *ret = tmp;
860 return 1;
863 static int git_parse_ssize_t(const char *value, ssize_t *ret)
865 intmax_t tmp;
866 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
867 return 0;
868 *ret = tmp;
869 return 1;
872 NORETURN
873 static void die_bad_number(const char *name, const char *value)
875 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
877 if (!value)
878 value = "";
880 if (!(cf && cf->name))
881 die(_("bad numeric config value '%s' for '%s': %s"),
882 value, name, error_type);
884 switch (cf->origin_type) {
885 case CONFIG_ORIGIN_BLOB:
886 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
887 value, name, cf->name, error_type);
888 case CONFIG_ORIGIN_FILE:
889 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
890 value, name, cf->name, error_type);
891 case CONFIG_ORIGIN_STDIN:
892 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
893 value, name, error_type);
894 case CONFIG_ORIGIN_SUBMODULE_BLOB:
895 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
896 value, name, cf->name, error_type);
897 case CONFIG_ORIGIN_CMDLINE:
898 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
899 value, name, cf->name, error_type);
900 default:
901 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
902 value, name, cf->name, error_type);
906 int git_config_int(const char *name, const char *value)
908 int ret;
909 if (!git_parse_int(value, &ret))
910 die_bad_number(name, value);
911 return ret;
914 int64_t git_config_int64(const char *name, const char *value)
916 int64_t ret;
917 if (!git_parse_int64(value, &ret))
918 die_bad_number(name, value);
919 return ret;
922 unsigned long git_config_ulong(const char *name, const char *value)
924 unsigned long ret;
925 if (!git_parse_ulong(value, &ret))
926 die_bad_number(name, value);
927 return ret;
930 ssize_t git_config_ssize_t(const char *name, const char *value)
932 ssize_t ret;
933 if (!git_parse_ssize_t(value, &ret))
934 die_bad_number(name, value);
935 return ret;
938 int git_parse_maybe_bool(const char *value)
940 if (!value)
941 return 1;
942 if (!*value)
943 return 0;
944 if (!strcasecmp(value, "true")
945 || !strcasecmp(value, "yes")
946 || !strcasecmp(value, "on"))
947 return 1;
948 if (!strcasecmp(value, "false")
949 || !strcasecmp(value, "no")
950 || !strcasecmp(value, "off"))
951 return 0;
952 return -1;
955 int git_config_maybe_bool(const char *name, const char *value)
957 int v = git_parse_maybe_bool(value);
958 if (0 <= v)
959 return v;
960 if (git_parse_int(value, &v))
961 return !!v;
962 return -1;
965 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
967 int v = git_parse_maybe_bool(value);
968 if (0 <= v) {
969 *is_bool = 1;
970 return v;
972 *is_bool = 0;
973 return git_config_int(name, value);
976 int git_config_bool(const char *name, const char *value)
978 int discard;
979 return !!git_config_bool_or_int(name, value, &discard);
982 int git_config_string(const char **dest, const char *var, const char *value)
984 if (!value)
985 return config_error_nonbool(var);
986 *dest = xstrdup(value);
987 return 0;
990 int git_config_pathname(const char **dest, const char *var, const char *value)
992 if (!value)
993 return config_error_nonbool(var);
994 *dest = expand_user_path(value, 0);
995 if (!*dest)
996 die(_("failed to expand user dir in: '%s'"), value);
997 return 0;
1000 static int git_default_core_config(const char *var, const char *value)
1002 /* This needs a better name */
1003 if (!strcmp(var, "core.filemode")) {
1004 trust_executable_bit = git_config_bool(var, value);
1005 return 0;
1007 if (!strcmp(var, "core.trustctime")) {
1008 trust_ctime = git_config_bool(var, value);
1009 return 0;
1011 if (!strcmp(var, "core.checkstat")) {
1012 if (!strcasecmp(value, "default"))
1013 check_stat = 1;
1014 else if (!strcasecmp(value, "minimal"))
1015 check_stat = 0;
1018 if (!strcmp(var, "core.quotepath")) {
1019 quote_path_fully = git_config_bool(var, value);
1020 return 0;
1023 if (!strcmp(var, "core.symlinks")) {
1024 has_symlinks = git_config_bool(var, value);
1025 return 0;
1028 if (!strcmp(var, "core.ignorecase")) {
1029 ignore_case = git_config_bool(var, value);
1030 return 0;
1033 if (!strcmp(var, "core.attributesfile"))
1034 return git_config_pathname(&git_attributes_file, var, value);
1036 if (!strcmp(var, "core.hookspath"))
1037 return git_config_pathname(&git_hooks_path, var, value);
1039 if (!strcmp(var, "core.bare")) {
1040 is_bare_repository_cfg = git_config_bool(var, value);
1041 return 0;
1044 if (!strcmp(var, "core.ignorestat")) {
1045 assume_unchanged = git_config_bool(var, value);
1046 return 0;
1049 if (!strcmp(var, "core.prefersymlinkrefs")) {
1050 prefer_symlink_refs = git_config_bool(var, value);
1051 return 0;
1054 if (!strcmp(var, "core.logallrefupdates")) {
1055 if (value && !strcasecmp(value, "always"))
1056 log_all_ref_updates = LOG_REFS_ALWAYS;
1057 else if (git_config_bool(var, value))
1058 log_all_ref_updates = LOG_REFS_NORMAL;
1059 else
1060 log_all_ref_updates = LOG_REFS_NONE;
1061 return 0;
1064 if (!strcmp(var, "core.warnambiguousrefs")) {
1065 warn_ambiguous_refs = git_config_bool(var, value);
1066 return 0;
1069 if (!strcmp(var, "core.abbrev")) {
1070 if (!value)
1071 return config_error_nonbool(var);
1072 if (!strcasecmp(value, "auto"))
1073 default_abbrev = -1;
1074 else {
1075 int abbrev = git_config_int(var, value);
1076 if (abbrev < minimum_abbrev || abbrev > 40)
1077 return error("abbrev length out of range: %d", abbrev);
1078 default_abbrev = abbrev;
1080 return 0;
1083 if (!strcmp(var, "core.disambiguate"))
1084 return set_disambiguate_hint_config(var, value);
1086 if (!strcmp(var, "core.loosecompression")) {
1087 int level = git_config_int(var, value);
1088 if (level == -1)
1089 level = Z_DEFAULT_COMPRESSION;
1090 else if (level < 0 || level > Z_BEST_COMPRESSION)
1091 die(_("bad zlib compression level %d"), level);
1092 zlib_compression_level = level;
1093 zlib_compression_seen = 1;
1094 return 0;
1097 if (!strcmp(var, "core.compression")) {
1098 int level = git_config_int(var, value);
1099 if (level == -1)
1100 level = Z_DEFAULT_COMPRESSION;
1101 else if (level < 0 || level > Z_BEST_COMPRESSION)
1102 die(_("bad zlib compression level %d"), level);
1103 core_compression_level = level;
1104 core_compression_seen = 1;
1105 if (!zlib_compression_seen)
1106 zlib_compression_level = level;
1107 if (!pack_compression_seen)
1108 pack_compression_level = level;
1109 return 0;
1112 if (!strcmp(var, "core.packedgitwindowsize")) {
1113 int pgsz_x2 = getpagesize() * 2;
1114 packed_git_window_size = git_config_ulong(var, value);
1116 /* This value must be multiple of (pagesize * 2) */
1117 packed_git_window_size /= pgsz_x2;
1118 if (packed_git_window_size < 1)
1119 packed_git_window_size = 1;
1120 packed_git_window_size *= pgsz_x2;
1121 return 0;
1124 if (!strcmp(var, "core.bigfilethreshold")) {
1125 big_file_threshold = git_config_ulong(var, value);
1126 return 0;
1129 if (!strcmp(var, "core.packedgitlimit")) {
1130 packed_git_limit = git_config_ulong(var, value);
1131 return 0;
1134 if (!strcmp(var, "core.deltabasecachelimit")) {
1135 delta_base_cache_limit = git_config_ulong(var, value);
1136 return 0;
1139 if (!strcmp(var, "core.autocrlf")) {
1140 if (value && !strcasecmp(value, "input")) {
1141 auto_crlf = AUTO_CRLF_INPUT;
1142 return 0;
1144 auto_crlf = git_config_bool(var, value);
1145 return 0;
1148 if (!strcmp(var, "core.safecrlf")) {
1149 if (value && !strcasecmp(value, "warn")) {
1150 safe_crlf = SAFE_CRLF_WARN;
1151 return 0;
1153 safe_crlf = git_config_bool(var, value);
1154 return 0;
1157 if (!strcmp(var, "core.eol")) {
1158 if (value && !strcasecmp(value, "lf"))
1159 core_eol = EOL_LF;
1160 else if (value && !strcasecmp(value, "crlf"))
1161 core_eol = EOL_CRLF;
1162 else if (value && !strcasecmp(value, "native"))
1163 core_eol = EOL_NATIVE;
1164 else
1165 core_eol = EOL_UNSET;
1166 return 0;
1169 if (!strcmp(var, "core.notesref")) {
1170 notes_ref_name = xstrdup(value);
1171 return 0;
1174 if (!strcmp(var, "core.editor"))
1175 return git_config_string(&editor_program, var, value);
1177 if (!strcmp(var, "core.commentchar")) {
1178 if (!value)
1179 return config_error_nonbool(var);
1180 else if (!strcasecmp(value, "auto"))
1181 auto_comment_line_char = 1;
1182 else if (value[0] && !value[1]) {
1183 comment_line_char = value[0];
1184 auto_comment_line_char = 0;
1185 } else
1186 return error("core.commentChar should only be one character");
1187 return 0;
1190 if (!strcmp(var, "core.askpass"))
1191 return git_config_string(&askpass_program, var, value);
1193 if (!strcmp(var, "core.excludesfile"))
1194 return git_config_pathname(&excludes_file, var, value);
1196 if (!strcmp(var, "core.whitespace")) {
1197 if (!value)
1198 return config_error_nonbool(var);
1199 whitespace_rule_cfg = parse_whitespace_rule(value);
1200 return 0;
1203 if (!strcmp(var, "core.fsyncobjectfiles")) {
1204 fsync_object_files = git_config_bool(var, value);
1205 return 0;
1208 if (!strcmp(var, "core.preloadindex")) {
1209 core_preload_index = git_config_bool(var, value);
1210 return 0;
1213 if (!strcmp(var, "core.createobject")) {
1214 if (!strcmp(value, "rename"))
1215 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1216 else if (!strcmp(value, "link"))
1217 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1218 else
1219 die(_("invalid mode for object creation: %s"), value);
1220 return 0;
1223 if (!strcmp(var, "core.sparsecheckout")) {
1224 core_apply_sparse_checkout = git_config_bool(var, value);
1225 return 0;
1228 if (!strcmp(var, "core.precomposeunicode")) {
1229 precomposed_unicode = git_config_bool(var, value);
1230 return 0;
1233 if (!strcmp(var, "core.protecthfs")) {
1234 protect_hfs = git_config_bool(var, value);
1235 return 0;
1238 if (!strcmp(var, "core.protectntfs")) {
1239 protect_ntfs = git_config_bool(var, value);
1240 return 0;
1243 if (!strcmp(var, "core.hidedotfiles")) {
1244 if (value && !strcasecmp(value, "dotgitonly"))
1245 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1246 else
1247 hide_dotfiles = git_config_bool(var, value);
1248 return 0;
1251 /* Add other config variables here and to Documentation/config.txt. */
1252 return 0;
1255 static int git_default_i18n_config(const char *var, const char *value)
1257 if (!strcmp(var, "i18n.commitencoding"))
1258 return git_config_string(&git_commit_encoding, var, value);
1260 if (!strcmp(var, "i18n.logoutputencoding"))
1261 return git_config_string(&git_log_output_encoding, var, value);
1263 /* Add other config variables here and to Documentation/config.txt. */
1264 return 0;
1267 static int git_default_branch_config(const char *var, const char *value)
1269 if (!strcmp(var, "branch.autosetupmerge")) {
1270 if (value && !strcasecmp(value, "always")) {
1271 git_branch_track = BRANCH_TRACK_ALWAYS;
1272 return 0;
1274 git_branch_track = git_config_bool(var, value);
1275 return 0;
1277 if (!strcmp(var, "branch.autosetuprebase")) {
1278 if (!value)
1279 return config_error_nonbool(var);
1280 else if (!strcmp(value, "never"))
1281 autorebase = AUTOREBASE_NEVER;
1282 else if (!strcmp(value, "local"))
1283 autorebase = AUTOREBASE_LOCAL;
1284 else if (!strcmp(value, "remote"))
1285 autorebase = AUTOREBASE_REMOTE;
1286 else if (!strcmp(value, "always"))
1287 autorebase = AUTOREBASE_ALWAYS;
1288 else
1289 return error("malformed value for %s", var);
1290 return 0;
1293 /* Add other config variables here and to Documentation/config.txt. */
1294 return 0;
1297 static int git_default_push_config(const char *var, const char *value)
1299 if (!strcmp(var, "push.default")) {
1300 if (!value)
1301 return config_error_nonbool(var);
1302 else if (!strcmp(value, "nothing"))
1303 push_default = PUSH_DEFAULT_NOTHING;
1304 else if (!strcmp(value, "matching"))
1305 push_default = PUSH_DEFAULT_MATCHING;
1306 else if (!strcmp(value, "simple"))
1307 push_default = PUSH_DEFAULT_SIMPLE;
1308 else if (!strcmp(value, "upstream"))
1309 push_default = PUSH_DEFAULT_UPSTREAM;
1310 else if (!strcmp(value, "tracking")) /* deprecated */
1311 push_default = PUSH_DEFAULT_UPSTREAM;
1312 else if (!strcmp(value, "current"))
1313 push_default = PUSH_DEFAULT_CURRENT;
1314 else {
1315 error("malformed value for %s: %s", var, value);
1316 return error("Must be one of nothing, matching, simple, "
1317 "upstream or current.");
1319 return 0;
1322 /* Add other config variables here and to Documentation/config.txt. */
1323 return 0;
1326 static int git_default_mailmap_config(const char *var, const char *value)
1328 if (!strcmp(var, "mailmap.file"))
1329 return git_config_pathname(&git_mailmap_file, var, value);
1330 if (!strcmp(var, "mailmap.blob"))
1331 return git_config_string(&git_mailmap_blob, var, value);
1333 /* Add other config variables here and to Documentation/config.txt. */
1334 return 0;
1337 int git_default_config(const char *var, const char *value, void *dummy)
1339 if (starts_with(var, "core."))
1340 return git_default_core_config(var, value);
1342 if (starts_with(var, "user."))
1343 return git_ident_config(var, value, dummy);
1345 if (starts_with(var, "i18n."))
1346 return git_default_i18n_config(var, value);
1348 if (starts_with(var, "branch."))
1349 return git_default_branch_config(var, value);
1351 if (starts_with(var, "push."))
1352 return git_default_push_config(var, value);
1354 if (starts_with(var, "mailmap."))
1355 return git_default_mailmap_config(var, value);
1357 if (starts_with(var, "advice."))
1358 return git_default_advice_config(var, value);
1360 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1361 pager_use_color = git_config_bool(var,value);
1362 return 0;
1365 if (!strcmp(var, "pack.packsizelimit")) {
1366 pack_size_limit_cfg = git_config_ulong(var, value);
1367 return 0;
1370 if (!strcmp(var, "pack.compression")) {
1371 int level = git_config_int(var, value);
1372 if (level == -1)
1373 level = Z_DEFAULT_COMPRESSION;
1374 else if (level < 0 || level > Z_BEST_COMPRESSION)
1375 die(_("bad pack compression level %d"), level);
1376 pack_compression_level = level;
1377 pack_compression_seen = 1;
1378 return 0;
1381 /* Add other config variables here and to Documentation/config.txt. */
1382 return 0;
1386 * All source specific fields in the union, die_on_error, name and the callbacks
1387 * fgetc, ungetc, ftell of top need to be initialized before calling
1388 * this function.
1390 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1392 int ret;
1394 /* push config-file parsing state stack */
1395 top->prev = cf;
1396 top->linenr = 1;
1397 top->eof = 0;
1398 strbuf_init(&top->value, 1024);
1399 strbuf_init(&top->var, 1024);
1400 cf = top;
1402 ret = git_parse_source(fn, data);
1404 /* pop config-file parsing state stack */
1405 strbuf_release(&top->value);
1406 strbuf_release(&top->var);
1407 cf = top->prev;
1409 return ret;
1412 static int do_config_from_file(config_fn_t fn,
1413 const enum config_origin_type origin_type,
1414 const char *name, const char *path, FILE *f,
1415 void *data)
1417 struct config_source top;
1419 top.u.file = f;
1420 top.origin_type = origin_type;
1421 top.name = name;
1422 top.path = path;
1423 top.die_on_error = 1;
1424 top.do_fgetc = config_file_fgetc;
1425 top.do_ungetc = config_file_ungetc;
1426 top.do_ftell = config_file_ftell;
1428 return do_config_from(&top, fn, data);
1431 static int git_config_from_stdin(config_fn_t fn, void *data)
1433 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1436 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1438 int ret = -1;
1439 FILE *f;
1441 f = fopen(filename, "r");
1442 if (f) {
1443 flockfile(f);
1444 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1445 funlockfile(f);
1446 fclose(f);
1448 return ret;
1451 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1452 const char *name, const char *buf, size_t len, void *data)
1454 struct config_source top;
1456 top.u.buf.buf = buf;
1457 top.u.buf.len = len;
1458 top.u.buf.pos = 0;
1459 top.origin_type = origin_type;
1460 top.name = name;
1461 top.path = NULL;
1462 top.die_on_error = 0;
1463 top.do_fgetc = config_buf_fgetc;
1464 top.do_ungetc = config_buf_ungetc;
1465 top.do_ftell = config_buf_ftell;
1467 return do_config_from(&top, fn, data);
1470 int git_config_from_blob_sha1(config_fn_t fn,
1471 const char *name,
1472 const unsigned char *sha1,
1473 void *data)
1475 enum object_type type;
1476 char *buf;
1477 unsigned long size;
1478 int ret;
1480 buf = read_sha1_file(sha1, &type, &size);
1481 if (!buf)
1482 return error("unable to load config blob object '%s'", name);
1483 if (type != OBJ_BLOB) {
1484 free(buf);
1485 return error("reference '%s' does not point to a blob", name);
1488 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1489 free(buf);
1491 return ret;
1494 static int git_config_from_blob_ref(config_fn_t fn,
1495 const char *name,
1496 void *data)
1498 unsigned char sha1[20];
1500 if (get_sha1(name, sha1) < 0)
1501 return error("unable to resolve config blob '%s'", name);
1502 return git_config_from_blob_sha1(fn, name, sha1, data);
1505 const char *git_etc_gitconfig(void)
1507 static const char *system_wide;
1508 if (!system_wide)
1509 system_wide = system_path(ETC_GITCONFIG);
1510 return system_wide;
1514 * Parse environment variable 'k' as a boolean (in various
1515 * possible spellings); if missing, use the default value 'def'.
1517 int git_env_bool(const char *k, int def)
1519 const char *v = getenv(k);
1520 return v ? git_config_bool(k, v) : def;
1524 * Parse environment variable 'k' as ulong with possibly a unit
1525 * suffix; if missing, use the default value 'val'.
1527 unsigned long git_env_ulong(const char *k, unsigned long val)
1529 const char *v = getenv(k);
1530 if (v && !git_parse_ulong(v, &val))
1531 die("failed to parse %s", k);
1532 return val;
1535 int git_config_system(void)
1537 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1540 static int do_git_config_sequence(const struct config_options *opts,
1541 config_fn_t fn, void *data)
1543 int ret = 0;
1544 char *xdg_config = xdg_config_home("config");
1545 char *user_config = expand_user_path("~/.gitconfig", 0);
1546 char *repo_config;
1548 if (opts->git_dir)
1549 repo_config = mkpathdup("%s/config", opts->git_dir);
1550 else if (have_git_dir())
1551 repo_config = git_pathdup("config");
1552 else
1553 repo_config = NULL;
1555 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1556 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1557 ret += git_config_from_file(fn, git_etc_gitconfig(),
1558 data);
1560 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1561 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1562 ret += git_config_from_file(fn, xdg_config, data);
1564 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1565 ret += git_config_from_file(fn, user_config, data);
1567 current_parsing_scope = CONFIG_SCOPE_REPO;
1568 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1569 ret += git_config_from_file(fn, repo_config, data);
1571 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1572 if (git_config_from_parameters(fn, data) < 0)
1573 die(_("unable to parse command-line config"));
1575 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1576 free(xdg_config);
1577 free(user_config);
1578 free(repo_config);
1579 return ret;
1582 int git_config_with_options(config_fn_t fn, void *data,
1583 struct git_config_source *config_source,
1584 const struct config_options *opts)
1586 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1588 if (opts->respect_includes) {
1589 inc.fn = fn;
1590 inc.data = data;
1591 inc.opts = opts;
1592 fn = git_config_include;
1593 data = &inc;
1597 * If we have a specific filename, use it. Otherwise, follow the
1598 * regular lookup sequence.
1600 if (config_source && config_source->use_stdin)
1601 return git_config_from_stdin(fn, data);
1602 else if (config_source && config_source->file)
1603 return git_config_from_file(fn, config_source->file, data);
1604 else if (config_source && config_source->blob)
1605 return git_config_from_blob_ref(fn, config_source->blob, data);
1607 return do_git_config_sequence(opts, fn, data);
1610 static void git_config_raw(config_fn_t fn, void *data)
1612 struct config_options opts = {0};
1614 opts.respect_includes = 1;
1615 if (git_config_with_options(fn, data, NULL, &opts) < 0)
1617 * git_config_with_options() normally returns only
1618 * zero, as most errors are fatal, and
1619 * non-fatal potential errors are guarded by "if"
1620 * statements that are entered only when no error is
1621 * possible.
1623 * If we ever encounter a non-fatal error, it means
1624 * something went really wrong and we should stop
1625 * immediately.
1627 die(_("unknown error occurred while reading the configuration files"));
1630 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1632 int i, value_index;
1633 struct string_list *values;
1634 struct config_set_element *entry;
1635 struct configset_list *list = &cs->list;
1637 for (i = 0; i < list->nr; i++) {
1638 entry = list->items[i].e;
1639 value_index = list->items[i].value_index;
1640 values = &entry->value_list;
1642 current_config_kvi = values->items[value_index].util;
1644 if (fn(entry->key, values->items[value_index].string, data) < 0)
1645 git_die_config_linenr(entry->key,
1646 current_config_kvi->filename,
1647 current_config_kvi->linenr);
1649 current_config_kvi = NULL;
1653 void read_early_config(config_fn_t cb, void *data)
1655 struct config_options opts = {0};
1656 struct strbuf buf = STRBUF_INIT;
1658 opts.respect_includes = 1;
1660 if (have_git_dir())
1661 opts.git_dir = get_git_dir();
1663 * When setup_git_directory() was not yet asked to discover the
1664 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1665 * is any repository config we should use (but unlike
1666 * setup_git_directory_gently(), no global state is changed, most
1667 * notably, the current working directory is still the same after the
1668 * call).
1670 else if (discover_git_directory(&buf))
1671 opts.git_dir = buf.buf;
1673 git_config_with_options(cb, data, NULL, &opts);
1675 strbuf_release(&buf);
1678 static void git_config_check_init(void);
1680 void git_config(config_fn_t fn, void *data)
1682 git_config_check_init();
1683 configset_iter(&the_config_set, fn, data);
1686 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1688 struct config_set_element k;
1689 struct config_set_element *found_entry;
1690 char *normalized_key;
1692 * `key` may come from the user, so normalize it before using it
1693 * for querying entries from the hashmap.
1695 if (git_config_parse_key(key, &normalized_key, NULL))
1696 return NULL;
1698 hashmap_entry_init(&k, strhash(normalized_key));
1699 k.key = normalized_key;
1700 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1701 free(normalized_key);
1702 return found_entry;
1705 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1707 struct config_set_element *e;
1708 struct string_list_item *si;
1709 struct configset_list_item *l_item;
1710 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1712 e = configset_find_element(cs, key);
1714 * Since the keys are being fed by git_config*() callback mechanism, they
1715 * are already normalized. So simply add them without any further munging.
1717 if (!e) {
1718 e = xmalloc(sizeof(*e));
1719 hashmap_entry_init(e, strhash(key));
1720 e->key = xstrdup(key);
1721 string_list_init(&e->value_list, 1);
1722 hashmap_add(&cs->config_hash, e);
1724 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1726 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1727 l_item = &cs->list.items[cs->list.nr++];
1728 l_item->e = e;
1729 l_item->value_index = e->value_list.nr - 1;
1731 if (!cf)
1732 die("BUG: configset_add_value has no source");
1733 if (cf->name) {
1734 kv_info->filename = strintern(cf->name);
1735 kv_info->linenr = cf->linenr;
1736 kv_info->origin_type = cf->origin_type;
1737 } else {
1738 /* for values read from `git_config_from_parameters()` */
1739 kv_info->filename = NULL;
1740 kv_info->linenr = -1;
1741 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1743 kv_info->scope = current_parsing_scope;
1744 si->util = kv_info;
1746 return 0;
1749 static int config_set_element_cmp(const struct config_set_element *e1,
1750 const struct config_set_element *e2, const void *unused)
1752 return strcmp(e1->key, e2->key);
1755 void git_configset_init(struct config_set *cs)
1757 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1758 cs->hash_initialized = 1;
1759 cs->list.nr = 0;
1760 cs->list.alloc = 0;
1761 cs->list.items = NULL;
1764 void git_configset_clear(struct config_set *cs)
1766 struct config_set_element *entry;
1767 struct hashmap_iter iter;
1768 if (!cs->hash_initialized)
1769 return;
1771 hashmap_iter_init(&cs->config_hash, &iter);
1772 while ((entry = hashmap_iter_next(&iter))) {
1773 free(entry->key);
1774 string_list_clear(&entry->value_list, 1);
1776 hashmap_free(&cs->config_hash, 1);
1777 cs->hash_initialized = 0;
1778 free(cs->list.items);
1779 cs->list.nr = 0;
1780 cs->list.alloc = 0;
1781 cs->list.items = NULL;
1784 static int config_set_callback(const char *key, const char *value, void *cb)
1786 struct config_set *cs = cb;
1787 configset_add_value(cs, key, value);
1788 return 0;
1791 int git_configset_add_file(struct config_set *cs, const char *filename)
1793 return git_config_from_file(config_set_callback, filename, cs);
1796 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1798 const struct string_list *values = NULL;
1800 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1801 * queried key in the files of the configset, the value returned will be the last
1802 * value in the value list for that key.
1804 values = git_configset_get_value_multi(cs, key);
1806 if (!values)
1807 return 1;
1808 assert(values->nr > 0);
1809 *value = values->items[values->nr - 1].string;
1810 return 0;
1813 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1815 struct config_set_element *e = configset_find_element(cs, key);
1816 return e ? &e->value_list : NULL;
1819 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1821 const char *value;
1822 if (!git_configset_get_value(cs, key, &value))
1823 return git_config_string(dest, key, value);
1824 else
1825 return 1;
1828 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1830 return git_configset_get_string_const(cs, key, (const char **)dest);
1833 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1835 const char *value;
1836 if (!git_configset_get_value(cs, key, &value)) {
1837 *dest = git_config_int(key, value);
1838 return 0;
1839 } else
1840 return 1;
1843 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1845 const char *value;
1846 if (!git_configset_get_value(cs, key, &value)) {
1847 *dest = git_config_ulong(key, value);
1848 return 0;
1849 } else
1850 return 1;
1853 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1855 const char *value;
1856 if (!git_configset_get_value(cs, key, &value)) {
1857 *dest = git_config_bool(key, value);
1858 return 0;
1859 } else
1860 return 1;
1863 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1864 int *is_bool, int *dest)
1866 const char *value;
1867 if (!git_configset_get_value(cs, key, &value)) {
1868 *dest = git_config_bool_or_int(key, value, is_bool);
1869 return 0;
1870 } else
1871 return 1;
1874 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1876 const char *value;
1877 if (!git_configset_get_value(cs, key, &value)) {
1878 *dest = git_config_maybe_bool(key, value);
1879 if (*dest == -1)
1880 return -1;
1881 return 0;
1882 } else
1883 return 1;
1886 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1888 const char *value;
1889 if (!git_configset_get_value(cs, key, &value))
1890 return git_config_pathname(dest, key, value);
1891 else
1892 return 1;
1895 static void git_config_check_init(void)
1897 if (the_config_set.hash_initialized)
1898 return;
1899 git_configset_init(&the_config_set);
1900 git_config_raw(config_set_callback, &the_config_set);
1903 void git_config_clear(void)
1905 if (!the_config_set.hash_initialized)
1906 return;
1907 git_configset_clear(&the_config_set);
1910 int git_config_get_value(const char *key, const char **value)
1912 git_config_check_init();
1913 return git_configset_get_value(&the_config_set, key, value);
1916 const struct string_list *git_config_get_value_multi(const char *key)
1918 git_config_check_init();
1919 return git_configset_get_value_multi(&the_config_set, key);
1922 int git_config_get_string_const(const char *key, const char **dest)
1924 int ret;
1925 git_config_check_init();
1926 ret = git_configset_get_string_const(&the_config_set, key, dest);
1927 if (ret < 0)
1928 git_die_config(key, NULL);
1929 return ret;
1932 int git_config_get_string(const char *key, char **dest)
1934 git_config_check_init();
1935 return git_config_get_string_const(key, (const char **)dest);
1938 int git_config_get_int(const char *key, int *dest)
1940 git_config_check_init();
1941 return git_configset_get_int(&the_config_set, key, dest);
1944 int git_config_get_ulong(const char *key, unsigned long *dest)
1946 git_config_check_init();
1947 return git_configset_get_ulong(&the_config_set, key, dest);
1950 int git_config_get_bool(const char *key, int *dest)
1952 git_config_check_init();
1953 return git_configset_get_bool(&the_config_set, key, dest);
1956 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1958 git_config_check_init();
1959 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1962 int git_config_get_maybe_bool(const char *key, int *dest)
1964 git_config_check_init();
1965 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1968 int git_config_get_pathname(const char *key, const char **dest)
1970 int ret;
1971 git_config_check_init();
1972 ret = git_configset_get_pathname(&the_config_set, key, dest);
1973 if (ret < 0)
1974 git_die_config(key, NULL);
1975 return ret;
1978 int git_config_get_expiry(const char *key, const char **output)
1980 int ret = git_config_get_string_const(key, output);
1981 if (ret)
1982 return ret;
1983 if (strcmp(*output, "now")) {
1984 timestamp_t now = approxidate("now");
1985 if (approxidate(*output) >= now)
1986 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
1988 return ret;
1991 int git_config_get_untracked_cache(void)
1993 int val = -1;
1994 const char *v;
1996 /* Hack for test programs like test-dump-untracked-cache */
1997 if (ignore_untracked_cache_config)
1998 return -1;
2000 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2001 return val;
2003 if (!git_config_get_value("core.untrackedcache", &v)) {
2004 if (!strcasecmp(v, "keep"))
2005 return -1;
2007 error(_("unknown core.untrackedCache value '%s'; "
2008 "using 'keep' default value"), v);
2009 return -1;
2012 return -1; /* default value */
2015 int git_config_get_split_index(void)
2017 int val;
2019 if (!git_config_get_maybe_bool("core.splitindex", &val))
2020 return val;
2022 return -1; /* default value */
2025 int git_config_get_max_percent_split_change(void)
2027 int val = -1;
2029 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2030 if (0 <= val && val <= 100)
2031 return val;
2033 return error(_("splitIndex.maxPercentChange value '%d' "
2034 "should be between 0 and 100"), val);
2037 return -1; /* default value */
2040 NORETURN
2041 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2043 if (!filename)
2044 die(_("unable to parse '%s' from command-line config"), key);
2045 else
2046 die(_("bad config variable '%s' in file '%s' at line %d"),
2047 key, filename, linenr);
2050 NORETURN __attribute__((format(printf, 2, 3)))
2051 void git_die_config(const char *key, const char *err, ...)
2053 const struct string_list *values;
2054 struct key_value_info *kv_info;
2056 if (err) {
2057 va_list params;
2058 va_start(params, err);
2059 vreportf("error: ", err, params);
2060 va_end(params);
2062 values = git_config_get_value_multi(key);
2063 kv_info = values->items[values->nr - 1].util;
2064 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2068 * Find all the stuff for git_config_set() below.
2071 static struct {
2072 int baselen;
2073 char *key;
2074 int do_not_match;
2075 regex_t *value_regex;
2076 int multi_replace;
2077 size_t *offset;
2078 unsigned int offset_alloc;
2079 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2080 int seen;
2081 } store;
2083 static int matches(const char *key, const char *value)
2085 if (strcmp(key, store.key))
2086 return 0; /* not ours */
2087 if (!store.value_regex)
2088 return 1; /* always matches */
2089 if (store.value_regex == CONFIG_REGEX_NONE)
2090 return 0; /* never matches */
2092 return store.do_not_match ^
2093 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2096 static int store_aux(const char *key, const char *value, void *cb)
2098 const char *ep;
2099 size_t section_len;
2101 switch (store.state) {
2102 case KEY_SEEN:
2103 if (matches(key, value)) {
2104 if (store.seen == 1 && store.multi_replace == 0) {
2105 warning(_("%s has multiple values"), key);
2108 ALLOC_GROW(store.offset, store.seen + 1,
2109 store.offset_alloc);
2111 store.offset[store.seen] = cf->do_ftell(cf);
2112 store.seen++;
2114 break;
2115 case SECTION_SEEN:
2117 * What we are looking for is in store.key (both
2118 * section and var), and its section part is baselen
2119 * long. We found key (again, both section and var).
2120 * We would want to know if this key is in the same
2121 * section as what we are looking for. We already
2122 * know we are in the same section as what should
2123 * hold store.key.
2125 ep = strrchr(key, '.');
2126 section_len = ep - key;
2128 if ((section_len != store.baselen) ||
2129 memcmp(key, store.key, section_len+1)) {
2130 store.state = SECTION_END_SEEN;
2131 break;
2135 * Do not increment matches: this is no match, but we
2136 * just made sure we are in the desired section.
2138 ALLOC_GROW(store.offset, store.seen + 1,
2139 store.offset_alloc);
2140 store.offset[store.seen] = cf->do_ftell(cf);
2141 /* fallthru */
2142 case SECTION_END_SEEN:
2143 case START:
2144 if (matches(key, value)) {
2145 ALLOC_GROW(store.offset, store.seen + 1,
2146 store.offset_alloc);
2147 store.offset[store.seen] = cf->do_ftell(cf);
2148 store.state = KEY_SEEN;
2149 store.seen++;
2150 } else {
2151 if (strrchr(key, '.') - key == store.baselen &&
2152 !strncmp(key, store.key, store.baselen)) {
2153 store.state = SECTION_SEEN;
2154 ALLOC_GROW(store.offset,
2155 store.seen + 1,
2156 store.offset_alloc);
2157 store.offset[store.seen] = cf->do_ftell(cf);
2161 return 0;
2164 static int write_error(const char *filename)
2166 error("failed to write new configuration file %s", filename);
2168 /* Same error code as "failed to rename". */
2169 return 4;
2172 static int store_write_section(int fd, const char *key)
2174 const char *dot;
2175 int i, success;
2176 struct strbuf sb = STRBUF_INIT;
2178 dot = memchr(key, '.', store.baselen);
2179 if (dot) {
2180 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2181 for (i = dot - key + 1; i < store.baselen; i++) {
2182 if (key[i] == '"' || key[i] == '\\')
2183 strbuf_addch(&sb, '\\');
2184 strbuf_addch(&sb, key[i]);
2186 strbuf_addstr(&sb, "\"]\n");
2187 } else {
2188 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2191 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2192 strbuf_release(&sb);
2194 return success;
2197 static int store_write_pair(int fd, const char *key, const char *value)
2199 int i, success;
2200 int length = strlen(key + store.baselen + 1);
2201 const char *quote = "";
2202 struct strbuf sb = STRBUF_INIT;
2205 * Check to see if the value needs to be surrounded with a dq pair.
2206 * Note that problematic characters are always backslash-quoted; this
2207 * check is about not losing leading or trailing SP and strings that
2208 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2209 * configuration parser.
2211 if (value[0] == ' ')
2212 quote = "\"";
2213 for (i = 0; value[i]; i++)
2214 if (value[i] == ';' || value[i] == '#')
2215 quote = "\"";
2216 if (i && value[i - 1] == ' ')
2217 quote = "\"";
2219 strbuf_addf(&sb, "\t%.*s = %s",
2220 length, key + store.baselen + 1, quote);
2222 for (i = 0; value[i]; i++)
2223 switch (value[i]) {
2224 case '\n':
2225 strbuf_addstr(&sb, "\\n");
2226 break;
2227 case '\t':
2228 strbuf_addstr(&sb, "\\t");
2229 break;
2230 case '"':
2231 case '\\':
2232 strbuf_addch(&sb, '\\');
2233 default:
2234 strbuf_addch(&sb, value[i]);
2235 break;
2237 strbuf_addf(&sb, "%s\n", quote);
2239 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2240 strbuf_release(&sb);
2242 return success;
2245 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2246 size_t offset_, int *found_bracket)
2248 size_t equal_offset = size, bracket_offset = size;
2249 ssize_t offset;
2251 contline:
2252 for (offset = offset_-2; offset > 0
2253 && contents[offset] != '\n'; offset--)
2254 switch (contents[offset]) {
2255 case '=': equal_offset = offset; break;
2256 case ']': bracket_offset = offset; break;
2258 if (offset > 0 && contents[offset-1] == '\\') {
2259 offset_ = offset;
2260 goto contline;
2262 if (bracket_offset < equal_offset) {
2263 *found_bracket = 1;
2264 offset = bracket_offset+1;
2265 } else
2266 offset++;
2268 return offset;
2271 int git_config_set_in_file_gently(const char *config_filename,
2272 const char *key, const char *value)
2274 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2277 void git_config_set_in_file(const char *config_filename,
2278 const char *key, const char *value)
2280 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2283 int git_config_set_gently(const char *key, const char *value)
2285 return git_config_set_multivar_gently(key, value, NULL, 0);
2288 void git_config_set(const char *key, const char *value)
2290 git_config_set_multivar(key, value, NULL, 0);
2294 * If value==NULL, unset in (remove from) config,
2295 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2296 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2297 * (only add a new one)
2298 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2299 * else all matching key/values (regardless how many) are removed,
2300 * before the new pair is written.
2302 * Returns 0 on success.
2304 * This function does this:
2306 * - it locks the config file by creating ".git/config.lock"
2308 * - it then parses the config using store_aux() as validator to find
2309 * the position on the key/value pair to replace. If it is to be unset,
2310 * it must be found exactly once.
2312 * - the config file is mmap()ed and the part before the match (if any) is
2313 * written to the lock file, then the changed part and the rest.
2315 * - the config file is removed and the lock file rename()d to it.
2318 int git_config_set_multivar_in_file_gently(const char *config_filename,
2319 const char *key, const char *value,
2320 const char *value_regex,
2321 int multi_replace)
2323 int fd = -1, in_fd = -1;
2324 int ret;
2325 struct lock_file *lock = NULL;
2326 char *filename_buf = NULL;
2327 char *contents = NULL;
2328 size_t contents_sz;
2330 /* parse-key returns negative; flip the sign to feed exit(3) */
2331 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2332 if (ret)
2333 goto out_free;
2335 store.multi_replace = multi_replace;
2337 if (!config_filename)
2338 config_filename = filename_buf = git_pathdup("config");
2341 * The lock serves a purpose in addition to locking: the new
2342 * contents of .git/config will be written into it.
2344 lock = xcalloc(1, sizeof(struct lock_file));
2345 fd = hold_lock_file_for_update(lock, config_filename, 0);
2346 if (fd < 0) {
2347 error_errno("could not lock config file %s", config_filename);
2348 free(store.key);
2349 ret = CONFIG_NO_LOCK;
2350 goto out_free;
2354 * If .git/config does not exist yet, write a minimal version.
2356 in_fd = open(config_filename, O_RDONLY);
2357 if ( in_fd < 0 ) {
2358 free(store.key);
2360 if ( ENOENT != errno ) {
2361 error_errno("opening %s", config_filename);
2362 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2363 goto out_free;
2365 /* if nothing to unset, error out */
2366 if (value == NULL) {
2367 ret = CONFIG_NOTHING_SET;
2368 goto out_free;
2371 store.key = (char *)key;
2372 if (!store_write_section(fd, key) ||
2373 !store_write_pair(fd, key, value))
2374 goto write_err_out;
2375 } else {
2376 struct stat st;
2377 size_t copy_begin, copy_end;
2378 int i, new_line = 0;
2380 if (value_regex == NULL)
2381 store.value_regex = NULL;
2382 else if (value_regex == CONFIG_REGEX_NONE)
2383 store.value_regex = CONFIG_REGEX_NONE;
2384 else {
2385 if (value_regex[0] == '!') {
2386 store.do_not_match = 1;
2387 value_regex++;
2388 } else
2389 store.do_not_match = 0;
2391 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2392 if (regcomp(store.value_regex, value_regex,
2393 REG_EXTENDED)) {
2394 error("invalid pattern: %s", value_regex);
2395 free(store.value_regex);
2396 ret = CONFIG_INVALID_PATTERN;
2397 goto out_free;
2401 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2402 store.offset[0] = 0;
2403 store.state = START;
2404 store.seen = 0;
2407 * After this, store.offset will contain the *end* offset
2408 * of the last match, or remain at 0 if no match was found.
2409 * As a side effect, we make sure to transform only a valid
2410 * existing config file.
2412 if (git_config_from_file(store_aux, config_filename, NULL)) {
2413 error("invalid config file %s", config_filename);
2414 free(store.key);
2415 if (store.value_regex != NULL &&
2416 store.value_regex != CONFIG_REGEX_NONE) {
2417 regfree(store.value_regex);
2418 free(store.value_regex);
2420 ret = CONFIG_INVALID_FILE;
2421 goto out_free;
2424 free(store.key);
2425 if (store.value_regex != NULL &&
2426 store.value_regex != CONFIG_REGEX_NONE) {
2427 regfree(store.value_regex);
2428 free(store.value_regex);
2431 /* if nothing to unset, or too many matches, error out */
2432 if ((store.seen == 0 && value == NULL) ||
2433 (store.seen > 1 && multi_replace == 0)) {
2434 ret = CONFIG_NOTHING_SET;
2435 goto out_free;
2438 if (fstat(in_fd, &st) == -1) {
2439 error_errno(_("fstat on %s failed"), config_filename);
2440 ret = CONFIG_INVALID_FILE;
2441 goto out_free;
2444 contents_sz = xsize_t(st.st_size);
2445 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2446 MAP_PRIVATE, in_fd, 0);
2447 if (contents == MAP_FAILED) {
2448 if (errno == ENODEV && S_ISDIR(st.st_mode))
2449 errno = EISDIR;
2450 error_errno("unable to mmap '%s'", config_filename);
2451 ret = CONFIG_INVALID_FILE;
2452 contents = NULL;
2453 goto out_free;
2455 close(in_fd);
2456 in_fd = -1;
2458 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2459 error_errno("chmod on %s failed", get_lock_file_path(lock));
2460 ret = CONFIG_NO_WRITE;
2461 goto out_free;
2464 if (store.seen == 0)
2465 store.seen = 1;
2467 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2468 if (store.offset[i] == 0) {
2469 store.offset[i] = copy_end = contents_sz;
2470 } else if (store.state != KEY_SEEN) {
2471 copy_end = store.offset[i];
2472 } else
2473 copy_end = find_beginning_of_line(
2474 contents, contents_sz,
2475 store.offset[i]-2, &new_line);
2477 if (copy_end > 0 && contents[copy_end-1] != '\n')
2478 new_line = 1;
2480 /* write the first part of the config */
2481 if (copy_end > copy_begin) {
2482 if (write_in_full(fd, contents + copy_begin,
2483 copy_end - copy_begin) <
2484 copy_end - copy_begin)
2485 goto write_err_out;
2486 if (new_line &&
2487 write_str_in_full(fd, "\n") != 1)
2488 goto write_err_out;
2490 copy_begin = store.offset[i];
2493 /* write the pair (value == NULL means unset) */
2494 if (value != NULL) {
2495 if (store.state == START) {
2496 if (!store_write_section(fd, key))
2497 goto write_err_out;
2499 if (!store_write_pair(fd, key, value))
2500 goto write_err_out;
2503 /* write the rest of the config */
2504 if (copy_begin < contents_sz)
2505 if (write_in_full(fd, contents + copy_begin,
2506 contents_sz - copy_begin) <
2507 contents_sz - copy_begin)
2508 goto write_err_out;
2510 munmap(contents, contents_sz);
2511 contents = NULL;
2514 if (commit_lock_file(lock) < 0) {
2515 error_errno("could not write config file %s", config_filename);
2516 ret = CONFIG_NO_WRITE;
2517 lock = NULL;
2518 goto out_free;
2522 * lock is committed, so don't try to roll it back below.
2523 * NOTE: Since lockfile.c keeps a linked list of all created
2524 * lock_file structures, it isn't safe to free(lock). It's
2525 * better to just leave it hanging around.
2527 lock = NULL;
2528 ret = 0;
2530 /* Invalidate the config cache */
2531 git_config_clear();
2533 out_free:
2534 if (lock)
2535 rollback_lock_file(lock);
2536 free(filename_buf);
2537 if (contents)
2538 munmap(contents, contents_sz);
2539 if (in_fd >= 0)
2540 close(in_fd);
2541 return ret;
2543 write_err_out:
2544 ret = write_error(get_lock_file_path(lock));
2545 goto out_free;
2549 void git_config_set_multivar_in_file(const char *config_filename,
2550 const char *key, const char *value,
2551 const char *value_regex, int multi_replace)
2553 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2554 value_regex, multi_replace))
2555 return;
2556 if (value)
2557 die(_("could not set '%s' to '%s'"), key, value);
2558 else
2559 die(_("could not unset '%s'"), key);
2562 int git_config_set_multivar_gently(const char *key, const char *value,
2563 const char *value_regex, int multi_replace)
2565 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2566 multi_replace);
2569 void git_config_set_multivar(const char *key, const char *value,
2570 const char *value_regex, int multi_replace)
2572 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2573 multi_replace);
2576 static int section_name_match (const char *buf, const char *name)
2578 int i = 0, j = 0, dot = 0;
2579 if (buf[i] != '[')
2580 return 0;
2581 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2582 if (!dot && isspace(buf[i])) {
2583 dot = 1;
2584 if (name[j++] != '.')
2585 break;
2586 for (i++; isspace(buf[i]); i++)
2587 ; /* do nothing */
2588 if (buf[i] != '"')
2589 break;
2590 continue;
2592 if (buf[i] == '\\' && dot)
2593 i++;
2594 else if (buf[i] == '"' && dot) {
2595 for (i++; isspace(buf[i]); i++)
2596 ; /* do_nothing */
2597 break;
2599 if (buf[i] != name[j++])
2600 break;
2602 if (buf[i] == ']' && name[j] == 0) {
2604 * We match, now just find the right length offset by
2605 * gobbling up any whitespace after it, as well
2607 i++;
2608 for (; buf[i] && isspace(buf[i]); i++)
2609 ; /* do nothing */
2610 return i;
2612 return 0;
2615 static int section_name_is_ok(const char *name)
2617 /* Empty section names are bogus. */
2618 if (!*name)
2619 return 0;
2622 * Before a dot, we must be alphanumeric or dash. After the first dot,
2623 * anything goes, so we can stop checking.
2625 for (; *name && *name != '.'; name++)
2626 if (*name != '-' && !isalnum(*name))
2627 return 0;
2628 return 1;
2631 /* if new_name == NULL, the section is removed instead */
2632 int git_config_rename_section_in_file(const char *config_filename,
2633 const char *old_name, const char *new_name)
2635 int ret = 0, remove = 0;
2636 char *filename_buf = NULL;
2637 struct lock_file *lock;
2638 int out_fd;
2639 char buf[1024];
2640 FILE *config_file = NULL;
2641 struct stat st;
2643 if (new_name && !section_name_is_ok(new_name)) {
2644 ret = error("invalid section name: %s", new_name);
2645 goto out_no_rollback;
2648 if (!config_filename)
2649 config_filename = filename_buf = git_pathdup("config");
2651 lock = xcalloc(1, sizeof(struct lock_file));
2652 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2653 if (out_fd < 0) {
2654 ret = error("could not lock config file %s", config_filename);
2655 goto out;
2658 if (!(config_file = fopen(config_filename, "rb"))) {
2659 /* no config file means nothing to rename, no error */
2660 goto commit_and_out;
2663 if (fstat(fileno(config_file), &st) == -1) {
2664 ret = error_errno(_("fstat on %s failed"), config_filename);
2665 goto out;
2668 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2669 ret = error_errno("chmod on %s failed",
2670 get_lock_file_path(lock));
2671 goto out;
2674 while (fgets(buf, sizeof(buf), config_file)) {
2675 int i;
2676 int length;
2677 char *output = buf;
2678 for (i = 0; buf[i] && isspace(buf[i]); i++)
2679 ; /* do nothing */
2680 if (buf[i] == '[') {
2681 /* it's a section */
2682 int offset = section_name_match(&buf[i], old_name);
2683 if (offset > 0) {
2684 ret++;
2685 if (new_name == NULL) {
2686 remove = 1;
2687 continue;
2689 store.baselen = strlen(new_name);
2690 if (!store_write_section(out_fd, new_name)) {
2691 ret = write_error(get_lock_file_path(lock));
2692 goto out;
2695 * We wrote out the new section, with
2696 * a newline, now skip the old
2697 * section's length
2699 output += offset + i;
2700 if (strlen(output) > 0) {
2702 * More content means there's
2703 * a declaration to put on the
2704 * next line; indent with a
2705 * tab
2707 output -= 1;
2708 output[0] = '\t';
2711 remove = 0;
2713 if (remove)
2714 continue;
2715 length = strlen(output);
2716 if (write_in_full(out_fd, output, length) != length) {
2717 ret = write_error(get_lock_file_path(lock));
2718 goto out;
2721 fclose(config_file);
2722 config_file = NULL;
2723 commit_and_out:
2724 if (commit_lock_file(lock) < 0)
2725 ret = error_errno("could not write config file %s",
2726 config_filename);
2727 out:
2728 if (config_file)
2729 fclose(config_file);
2730 rollback_lock_file(lock);
2731 out_no_rollback:
2732 free(filename_buf);
2733 return ret;
2736 int git_config_rename_section(const char *old_name, const char *new_name)
2738 return git_config_rename_section_in_file(NULL, old_name, new_name);
2742 * Call this to report error for your variable that should not
2743 * get a boolean value (i.e. "[my] var" means "true").
2745 #undef config_error_nonbool
2746 int config_error_nonbool(const char *var)
2748 return error("missing value for '%s'", var);
2751 int parse_config_key(const char *var,
2752 const char *section,
2753 const char **subsection, int *subsection_len,
2754 const char **key)
2756 const char *dot;
2758 /* Does it start with "section." ? */
2759 if (!skip_prefix(var, section, &var) || *var != '.')
2760 return -1;
2763 * Find the key; we don't know yet if we have a subsection, but we must
2764 * parse backwards from the end, since the subsection may have dots in
2765 * it, too.
2767 dot = strrchr(var, '.');
2768 *key = dot + 1;
2770 /* Did we have a subsection at all? */
2771 if (dot == var) {
2772 if (subsection) {
2773 *subsection = NULL;
2774 *subsection_len = 0;
2777 else {
2778 if (!subsection)
2779 return -1;
2780 *subsection = var + 1;
2781 *subsection_len = dot - *subsection;
2784 return 0;
2787 const char *current_config_origin_type(void)
2789 int type;
2790 if (current_config_kvi)
2791 type = current_config_kvi->origin_type;
2792 else if(cf)
2793 type = cf->origin_type;
2794 else
2795 die("BUG: current_config_origin_type called outside config callback");
2797 switch (type) {
2798 case CONFIG_ORIGIN_BLOB:
2799 return "blob";
2800 case CONFIG_ORIGIN_FILE:
2801 return "file";
2802 case CONFIG_ORIGIN_STDIN:
2803 return "standard input";
2804 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2805 return "submodule-blob";
2806 case CONFIG_ORIGIN_CMDLINE:
2807 return "command line";
2808 default:
2809 die("BUG: unknown config origin type");
2813 const char *current_config_name(void)
2815 const char *name;
2816 if (current_config_kvi)
2817 name = current_config_kvi->filename;
2818 else if (cf)
2819 name = cf->name;
2820 else
2821 die("BUG: current_config_name called outside config callback");
2822 return name ? name : "";
2825 enum config_scope current_config_scope(void)
2827 if (current_config_kvi)
2828 return current_config_kvi->scope;
2829 else
2830 return current_parsing_scope;