hashmap: migrate documentation from Documentation/technical into header
[git.git] / config.c
blob4a31e31ac30f8552e5116f319fecb8cf76182938
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "config.h"
10 #include "lockfile.h"
11 #include "exec_cmd.h"
12 #include "strbuf.h"
13 #include "quote.h"
14 #include "hashmap.h"
15 #include "string-list.h"
16 #include "utf8.h"
17 #include "dir.h"
19 struct config_source {
20 struct config_source *prev;
21 union {
22 FILE *file;
23 struct config_buf {
24 const char *buf;
25 size_t len;
26 size_t pos;
27 } buf;
28 } u;
29 enum config_origin_type origin_type;
30 const char *name;
31 const char *path;
32 int die_on_error;
33 int linenr;
34 int eof;
35 struct strbuf value;
36 struct strbuf var;
38 int (*do_fgetc)(struct config_source *c);
39 int (*do_ungetc)(int c, struct config_source *conf);
40 long (*do_ftell)(struct config_source *c);
44 * These variables record the "current" config source, which
45 * can be accessed by parsing callbacks.
47 * The "cf" variable will be non-NULL only when we are actually parsing a real
48 * config source (file, blob, cmdline, etc).
50 * The "current_config_kvi" variable will be non-NULL only when we are feeding
51 * cached config from a configset into a callback.
53 * They should generally never be non-NULL at the same time. If they are both
54 * NULL, then we aren't parsing anything (and depending on the function looking
55 * at the variables, it's either a bug for it to be called in the first place,
56 * or it's a function which can be reused for non-config purposes, and should
57 * fall back to some sane behavior).
59 static struct config_source *cf;
60 static struct key_value_info *current_config_kvi;
63 * Similar to the variables above, this gives access to the "scope" of the
64 * current value (repo, global, etc). For cached values, it can be found via
65 * the current_config_kvi as above. During parsing, the current value can be
66 * found in this variable. It's not part of "cf" because it transcends a single
67 * file (i.e., a file included from .git/config is still in "repo" scope).
69 static enum config_scope current_parsing_scope;
71 static int core_compression_seen;
72 static int pack_compression_seen;
73 static int zlib_compression_seen;
76 * Default config_set that contains key-value pairs from the usual set of config
77 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
78 * config file and the global /etc/gitconfig)
80 static struct config_set the_config_set;
82 static int config_file_fgetc(struct config_source *conf)
84 return getc_unlocked(conf->u.file);
87 static int config_file_ungetc(int c, struct config_source *conf)
89 return ungetc(c, conf->u.file);
92 static long config_file_ftell(struct config_source *conf)
94 return ftell(conf->u.file);
98 static int config_buf_fgetc(struct config_source *conf)
100 if (conf->u.buf.pos < conf->u.buf.len)
101 return conf->u.buf.buf[conf->u.buf.pos++];
103 return EOF;
106 static int config_buf_ungetc(int c, struct config_source *conf)
108 if (conf->u.buf.pos > 0) {
109 conf->u.buf.pos--;
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
111 die("BUG: config_buf can only ungetc the same character");
112 return c;
115 return EOF;
118 static long config_buf_ftell(struct config_source *conf)
120 return conf->u.buf.pos;
123 #define MAX_INCLUDE_DEPTH 10
124 static const char include_depth_advice[] =
125 "exceeded maximum include depth (%d) while including\n"
126 " %s\n"
127 "from\n"
128 " %s\n"
129 "Do you have circular includes?";
130 static int handle_path_include(const char *path, struct config_include_data *inc)
132 int ret = 0;
133 struct strbuf buf = STRBUF_INIT;
134 char *expanded;
136 if (!path)
137 return config_error_nonbool("include.path");
139 expanded = expand_user_path(path, 0);
140 if (!expanded)
141 return error("could not expand include path '%s'", path);
142 path = expanded;
145 * Use an absolute path as-is, but interpret relative paths
146 * based on the including config file.
148 if (!is_absolute_path(path)) {
149 char *slash;
151 if (!cf || !cf->path)
152 return error("relative config includes must come from files");
154 slash = find_last_dir_sep(cf->path);
155 if (slash)
156 strbuf_add(&buf, cf->path, slash - cf->path + 1);
157 strbuf_addstr(&buf, path);
158 path = buf.buf;
161 if (!access_or_die(path, R_OK, 0)) {
162 if (++inc->depth > MAX_INCLUDE_DEPTH)
163 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
164 !cf ? "<unknown>" :
165 cf->name ? cf->name :
166 "the command line");
167 ret = git_config_from_file(git_config_include, path, inc);
168 inc->depth--;
170 strbuf_release(&buf);
171 free(expanded);
172 return ret;
175 static int prepare_include_condition_pattern(struct strbuf *pat)
177 struct strbuf path = STRBUF_INIT;
178 char *expanded;
179 int prefix = 0;
181 expanded = expand_user_path(pat->buf, 1);
182 if (expanded) {
183 strbuf_reset(pat);
184 strbuf_addstr(pat, expanded);
185 free(expanded);
188 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
189 const char *slash;
191 if (!cf || !cf->path)
192 return error(_("relative config include "
193 "conditionals must come from files"));
195 strbuf_realpath(&path, cf->path, 1);
196 slash = find_last_dir_sep(path.buf);
197 if (!slash)
198 die("BUG: how is this possible?");
199 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
200 prefix = slash - path.buf + 1 /* slash */;
201 } else if (!is_absolute_path(pat->buf))
202 strbuf_insert(pat, 0, "**/", 3);
204 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
205 strbuf_addstr(pat, "**");
207 strbuf_release(&path);
208 return prefix;
211 static int include_by_gitdir(const struct config_options *opts,
212 const char *cond, size_t cond_len, int icase)
214 struct strbuf text = STRBUF_INIT;
215 struct strbuf pattern = STRBUF_INIT;
216 int ret = 0, prefix;
217 const char *git_dir;
218 int already_tried_absolute = 0;
220 if (opts->git_dir)
221 git_dir = opts->git_dir;
222 else
223 goto done;
225 strbuf_realpath(&text, git_dir, 1);
226 strbuf_add(&pattern, cond, cond_len);
227 prefix = prepare_include_condition_pattern(&pattern);
229 again:
230 if (prefix < 0)
231 goto done;
233 if (prefix > 0) {
235 * perform literal matching on the prefix part so that
236 * any wildcard character in it can't create side effects.
238 if (text.len < prefix)
239 goto done;
240 if (!icase && strncmp(pattern.buf, text.buf, prefix))
241 goto done;
242 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
243 goto done;
246 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
247 icase ? WM_CASEFOLD : 0, NULL);
249 if (!ret && !already_tried_absolute) {
251 * We've tried e.g. matching gitdir:~/work, but if
252 * ~/work is a symlink to /mnt/storage/work
253 * strbuf_realpath() will expand it, so the rule won't
254 * match. Let's match against a
255 * strbuf_add_absolute_path() version of the path,
256 * which'll do the right thing
258 strbuf_reset(&text);
259 strbuf_add_absolute_path(&text, git_dir);
260 already_tried_absolute = 1;
261 goto again;
263 done:
264 strbuf_release(&pattern);
265 strbuf_release(&text);
266 return ret;
269 static int include_condition_is_true(const struct config_options *opts,
270 const char *cond, size_t cond_len)
273 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
274 return include_by_gitdir(opts, cond, cond_len, 0);
275 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
276 return include_by_gitdir(opts, cond, cond_len, 1);
278 /* unknown conditionals are always false */
279 return 0;
282 int git_config_include(const char *var, const char *value, void *data)
284 struct config_include_data *inc = data;
285 const char *cond, *key;
286 int cond_len;
287 int ret;
290 * Pass along all values, including "include" directives; this makes it
291 * possible to query information on the includes themselves.
293 ret = inc->fn(var, value, inc->data);
294 if (ret < 0)
295 return ret;
297 if (!strcmp(var, "include.path"))
298 ret = handle_path_include(value, inc);
300 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
301 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
302 !strcmp(key, "path"))
303 ret = handle_path_include(value, inc);
305 return ret;
308 void git_config_push_parameter(const char *text)
310 struct strbuf env = STRBUF_INIT;
311 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
312 if (old && *old) {
313 strbuf_addstr(&env, old);
314 strbuf_addch(&env, ' ');
316 sq_quote_buf(&env, text);
317 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
318 strbuf_release(&env);
321 static inline int iskeychar(int c)
323 return isalnum(c) || c == '-';
327 * Auxiliary function to sanity-check and split the key into the section
328 * identifier and variable name.
330 * Returns 0 on success, -1 when there is an invalid character in the key and
331 * -2 if there is no section name in the key.
333 * store_key - pointer to char* which will hold a copy of the key with
334 * lowercase section and variable name
335 * baselen - pointer to int which will hold the length of the
336 * section + subsection part, can be NULL
338 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
340 int i, dot, baselen;
341 const char *last_dot = strrchr(key, '.');
344 * Since "key" actually contains the section name and the real
345 * key name separated by a dot, we have to know where the dot is.
348 if (last_dot == NULL || last_dot == key) {
349 if (!quiet)
350 error("key does not contain a section: %s", key);
351 return -CONFIG_NO_SECTION_OR_NAME;
354 if (!last_dot[1]) {
355 if (!quiet)
356 error("key does not contain variable name: %s", key);
357 return -CONFIG_NO_SECTION_OR_NAME;
360 baselen = last_dot - key;
361 if (baselen_)
362 *baselen_ = baselen;
365 * Validate the key and while at it, lower case it for matching.
367 if (store_key)
368 *store_key = xmallocz(strlen(key));
370 dot = 0;
371 for (i = 0; key[i]; i++) {
372 unsigned char c = key[i];
373 if (c == '.')
374 dot = 1;
375 /* Leave the extended basename untouched.. */
376 if (!dot || i > baselen) {
377 if (!iskeychar(c) ||
378 (i == baselen + 1 && !isalpha(c))) {
379 if (!quiet)
380 error("invalid key: %s", key);
381 goto out_free_ret_1;
383 c = tolower(c);
384 } else if (c == '\n') {
385 if (!quiet)
386 error("invalid key (newline): %s", key);
387 goto out_free_ret_1;
389 if (store_key)
390 (*store_key)[i] = c;
393 return 0;
395 out_free_ret_1:
396 if (store_key) {
397 FREE_AND_NULL(*store_key);
399 return -CONFIG_INVALID_KEY;
402 int git_config_parse_key(const char *key, char **store_key, int *baselen)
404 return git_config_parse_key_1(key, store_key, baselen, 0);
407 int git_config_key_is_valid(const char *key)
409 return !git_config_parse_key_1(key, NULL, NULL, 1);
412 int git_config_parse_parameter(const char *text,
413 config_fn_t fn, void *data)
415 const char *value;
416 char *canonical_name;
417 struct strbuf **pair;
418 int ret;
420 pair = strbuf_split_str(text, '=', 2);
421 if (!pair[0])
422 return error("bogus config parameter: %s", text);
424 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
425 strbuf_setlen(pair[0], pair[0]->len - 1);
426 value = pair[1] ? pair[1]->buf : "";
427 } else {
428 value = NULL;
431 strbuf_trim(pair[0]);
432 if (!pair[0]->len) {
433 strbuf_list_free(pair);
434 return error("bogus config parameter: %s", text);
437 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
438 ret = -1;
439 } else {
440 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
441 free(canonical_name);
443 strbuf_list_free(pair);
444 return ret;
447 int git_config_from_parameters(config_fn_t fn, void *data)
449 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
450 int ret = 0;
451 char *envw;
452 const char **argv = NULL;
453 int nr = 0, alloc = 0;
454 int i;
455 struct config_source source;
457 if (!env)
458 return 0;
460 memset(&source, 0, sizeof(source));
461 source.prev = cf;
462 source.origin_type = CONFIG_ORIGIN_CMDLINE;
463 cf = &source;
465 /* sq_dequote will write over it */
466 envw = xstrdup(env);
468 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
469 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
470 goto out;
473 for (i = 0; i < nr; i++) {
474 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
475 ret = -1;
476 goto out;
480 out:
481 free(argv);
482 free(envw);
483 cf = source.prev;
484 return ret;
487 static int get_next_char(void)
489 int c = cf->do_fgetc(cf);
491 if (c == '\r') {
492 /* DOS like systems */
493 c = cf->do_fgetc(cf);
494 if (c != '\n') {
495 if (c != EOF)
496 cf->do_ungetc(c, cf);
497 c = '\r';
500 if (c == '\n')
501 cf->linenr++;
502 if (c == EOF) {
503 cf->eof = 1;
504 cf->linenr++;
505 c = '\n';
507 return c;
510 static char *parse_value(void)
512 int quote = 0, comment = 0, space = 0;
514 strbuf_reset(&cf->value);
515 for (;;) {
516 int c = get_next_char();
517 if (c == '\n') {
518 if (quote) {
519 cf->linenr--;
520 return NULL;
522 return cf->value.buf;
524 if (comment)
525 continue;
526 if (isspace(c) && !quote) {
527 if (cf->value.len)
528 space++;
529 continue;
531 if (!quote) {
532 if (c == ';' || c == '#') {
533 comment = 1;
534 continue;
537 for (; space; space--)
538 strbuf_addch(&cf->value, ' ');
539 if (c == '\\') {
540 c = get_next_char();
541 switch (c) {
542 case '\n':
543 continue;
544 case 't':
545 c = '\t';
546 break;
547 case 'b':
548 c = '\b';
549 break;
550 case 'n':
551 c = '\n';
552 break;
553 /* Some characters escape as themselves */
554 case '\\': case '"':
555 break;
556 /* Reject unknown escape sequences */
557 default:
558 return NULL;
560 strbuf_addch(&cf->value, c);
561 continue;
563 if (c == '"') {
564 quote = 1-quote;
565 continue;
567 strbuf_addch(&cf->value, c);
571 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
573 int c;
574 char *value;
575 int ret;
577 /* Get the full name */
578 for (;;) {
579 c = get_next_char();
580 if (cf->eof)
581 break;
582 if (!iskeychar(c))
583 break;
584 strbuf_addch(name, tolower(c));
587 while (c == ' ' || c == '\t')
588 c = get_next_char();
590 value = NULL;
591 if (c != '\n') {
592 if (c != '=')
593 return -1;
594 value = parse_value();
595 if (!value)
596 return -1;
599 * We already consumed the \n, but we need linenr to point to
600 * the line we just parsed during the call to fn to get
601 * accurate line number in error messages.
603 cf->linenr--;
604 ret = fn(name->buf, value, data);
605 if (ret >= 0)
606 cf->linenr++;
607 return ret;
610 static int get_extended_base_var(struct strbuf *name, int c)
612 do {
613 if (c == '\n')
614 goto error_incomplete_line;
615 c = get_next_char();
616 } while (isspace(c));
618 /* We require the format to be '[base "extension"]' */
619 if (c != '"')
620 return -1;
621 strbuf_addch(name, '.');
623 for (;;) {
624 int c = get_next_char();
625 if (c == '\n')
626 goto error_incomplete_line;
627 if (c == '"')
628 break;
629 if (c == '\\') {
630 c = get_next_char();
631 if (c == '\n')
632 goto error_incomplete_line;
634 strbuf_addch(name, c);
637 /* Final ']' */
638 if (get_next_char() != ']')
639 return -1;
640 return 0;
641 error_incomplete_line:
642 cf->linenr--;
643 return -1;
646 static int get_base_var(struct strbuf *name)
648 for (;;) {
649 int c = get_next_char();
650 if (cf->eof)
651 return -1;
652 if (c == ']')
653 return 0;
654 if (isspace(c))
655 return get_extended_base_var(name, c);
656 if (!iskeychar(c) && c != '.')
657 return -1;
658 strbuf_addch(name, tolower(c));
662 static int git_parse_source(config_fn_t fn, void *data)
664 int comment = 0;
665 int baselen = 0;
666 struct strbuf *var = &cf->var;
667 int error_return = 0;
668 char *error_msg = NULL;
670 /* U+FEFF Byte Order Mark in UTF8 */
671 const char *bomptr = utf8_bom;
673 for (;;) {
674 int c = get_next_char();
675 if (bomptr && *bomptr) {
676 /* We are at the file beginning; skip UTF8-encoded BOM
677 * if present. Sane editors won't put this in on their
678 * own, but e.g. Windows Notepad will do it happily. */
679 if (c == (*bomptr & 0377)) {
680 bomptr++;
681 continue;
682 } else {
683 /* Do not tolerate partial BOM. */
684 if (bomptr != utf8_bom)
685 break;
686 /* No BOM at file beginning. Cool. */
687 bomptr = NULL;
690 if (c == '\n') {
691 if (cf->eof)
692 return 0;
693 comment = 0;
694 continue;
696 if (comment || isspace(c))
697 continue;
698 if (c == '#' || c == ';') {
699 comment = 1;
700 continue;
702 if (c == '[') {
703 /* Reset prior to determining a new stem */
704 strbuf_reset(var);
705 if (get_base_var(var) < 0 || var->len < 1)
706 break;
707 strbuf_addch(var, '.');
708 baselen = var->len;
709 continue;
711 if (!isalpha(c))
712 break;
714 * Truncate the var name back to the section header
715 * stem prior to grabbing the suffix part of the name
716 * and the value.
718 strbuf_setlen(var, baselen);
719 strbuf_addch(var, tolower(c));
720 if (get_value(fn, data, var) < 0)
721 break;
724 switch (cf->origin_type) {
725 case CONFIG_ORIGIN_BLOB:
726 error_msg = xstrfmt(_("bad config line %d in blob %s"),
727 cf->linenr, cf->name);
728 break;
729 case CONFIG_ORIGIN_FILE:
730 error_msg = xstrfmt(_("bad config line %d in file %s"),
731 cf->linenr, cf->name);
732 break;
733 case CONFIG_ORIGIN_STDIN:
734 error_msg = xstrfmt(_("bad config line %d in standard input"),
735 cf->linenr);
736 break;
737 case CONFIG_ORIGIN_SUBMODULE_BLOB:
738 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
739 cf->linenr, cf->name);
740 break;
741 case CONFIG_ORIGIN_CMDLINE:
742 error_msg = xstrfmt(_("bad config line %d in command line %s"),
743 cf->linenr, cf->name);
744 break;
745 default:
746 error_msg = xstrfmt(_("bad config line %d in %s"),
747 cf->linenr, cf->name);
750 if (cf->die_on_error)
751 die("%s", error_msg);
752 else
753 error_return = error("%s", error_msg);
755 free(error_msg);
756 return error_return;
759 static int parse_unit_factor(const char *end, uintmax_t *val)
761 if (!*end)
762 return 1;
763 else if (!strcasecmp(end, "k")) {
764 *val *= 1024;
765 return 1;
767 else if (!strcasecmp(end, "m")) {
768 *val *= 1024 * 1024;
769 return 1;
771 else if (!strcasecmp(end, "g")) {
772 *val *= 1024 * 1024 * 1024;
773 return 1;
775 return 0;
778 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
780 if (value && *value) {
781 char *end;
782 intmax_t val;
783 uintmax_t uval;
784 uintmax_t factor = 1;
786 errno = 0;
787 val = strtoimax(value, &end, 0);
788 if (errno == ERANGE)
789 return 0;
790 if (!parse_unit_factor(end, &factor)) {
791 errno = EINVAL;
792 return 0;
794 uval = labs(val);
795 uval *= factor;
796 if (uval > max || labs(val) > uval) {
797 errno = ERANGE;
798 return 0;
800 val *= factor;
801 *ret = val;
802 return 1;
804 errno = EINVAL;
805 return 0;
808 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
810 if (value && *value) {
811 char *end;
812 uintmax_t val;
813 uintmax_t oldval;
815 errno = 0;
816 val = strtoumax(value, &end, 0);
817 if (errno == ERANGE)
818 return 0;
819 oldval = val;
820 if (!parse_unit_factor(end, &val)) {
821 errno = EINVAL;
822 return 0;
824 if (val > max || oldval > val) {
825 errno = ERANGE;
826 return 0;
828 *ret = val;
829 return 1;
831 errno = EINVAL;
832 return 0;
835 static int git_parse_int(const char *value, int *ret)
837 intmax_t tmp;
838 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
839 return 0;
840 *ret = tmp;
841 return 1;
844 static int git_parse_int64(const char *value, int64_t *ret)
846 intmax_t tmp;
847 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
848 return 0;
849 *ret = tmp;
850 return 1;
853 int git_parse_ulong(const char *value, unsigned long *ret)
855 uintmax_t tmp;
856 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
857 return 0;
858 *ret = tmp;
859 return 1;
862 static int git_parse_ssize_t(const char *value, ssize_t *ret)
864 intmax_t tmp;
865 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
866 return 0;
867 *ret = tmp;
868 return 1;
871 NORETURN
872 static void die_bad_number(const char *name, const char *value)
874 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
876 if (!value)
877 value = "";
879 if (!(cf && cf->name))
880 die(_("bad numeric config value '%s' for '%s': %s"),
881 value, name, error_type);
883 switch (cf->origin_type) {
884 case CONFIG_ORIGIN_BLOB:
885 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
886 value, name, cf->name, error_type);
887 case CONFIG_ORIGIN_FILE:
888 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
889 value, name, cf->name, error_type);
890 case CONFIG_ORIGIN_STDIN:
891 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
892 value, name, error_type);
893 case CONFIG_ORIGIN_SUBMODULE_BLOB:
894 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
895 value, name, cf->name, error_type);
896 case CONFIG_ORIGIN_CMDLINE:
897 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
898 value, name, cf->name, error_type);
899 default:
900 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
901 value, name, cf->name, error_type);
905 int git_config_int(const char *name, const char *value)
907 int ret;
908 if (!git_parse_int(value, &ret))
909 die_bad_number(name, value);
910 return ret;
913 int64_t git_config_int64(const char *name, const char *value)
915 int64_t ret;
916 if (!git_parse_int64(value, &ret))
917 die_bad_number(name, value);
918 return ret;
921 unsigned long git_config_ulong(const char *name, const char *value)
923 unsigned long ret;
924 if (!git_parse_ulong(value, &ret))
925 die_bad_number(name, value);
926 return ret;
929 ssize_t git_config_ssize_t(const char *name, const char *value)
931 ssize_t ret;
932 if (!git_parse_ssize_t(value, &ret))
933 die_bad_number(name, value);
934 return ret;
937 int git_parse_maybe_bool(const char *value)
939 if (!value)
940 return 1;
941 if (!*value)
942 return 0;
943 if (!strcasecmp(value, "true")
944 || !strcasecmp(value, "yes")
945 || !strcasecmp(value, "on"))
946 return 1;
947 if (!strcasecmp(value, "false")
948 || !strcasecmp(value, "no")
949 || !strcasecmp(value, "off"))
950 return 0;
951 return -1;
954 int git_config_maybe_bool(const char *name, const char *value)
956 int v = git_parse_maybe_bool(value);
957 if (0 <= v)
958 return v;
959 if (git_parse_int(value, &v))
960 return !!v;
961 return -1;
964 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
966 int v = git_parse_maybe_bool(value);
967 if (0 <= v) {
968 *is_bool = 1;
969 return v;
971 *is_bool = 0;
972 return git_config_int(name, value);
975 int git_config_bool(const char *name, const char *value)
977 int discard;
978 return !!git_config_bool_or_int(name, value, &discard);
981 int git_config_string(const char **dest, const char *var, const char *value)
983 if (!value)
984 return config_error_nonbool(var);
985 *dest = xstrdup(value);
986 return 0;
989 int git_config_pathname(const char **dest, const char *var, const char *value)
991 if (!value)
992 return config_error_nonbool(var);
993 *dest = expand_user_path(value, 0);
994 if (!*dest)
995 die(_("failed to expand user dir in: '%s'"), value);
996 return 0;
999 static int git_default_core_config(const char *var, const char *value)
1001 /* This needs a better name */
1002 if (!strcmp(var, "core.filemode")) {
1003 trust_executable_bit = git_config_bool(var, value);
1004 return 0;
1006 if (!strcmp(var, "core.trustctime")) {
1007 trust_ctime = git_config_bool(var, value);
1008 return 0;
1010 if (!strcmp(var, "core.checkstat")) {
1011 if (!strcasecmp(value, "default"))
1012 check_stat = 1;
1013 else if (!strcasecmp(value, "minimal"))
1014 check_stat = 0;
1017 if (!strcmp(var, "core.quotepath")) {
1018 quote_path_fully = git_config_bool(var, value);
1019 return 0;
1022 if (!strcmp(var, "core.symlinks")) {
1023 has_symlinks = git_config_bool(var, value);
1024 return 0;
1027 if (!strcmp(var, "core.ignorecase")) {
1028 ignore_case = git_config_bool(var, value);
1029 return 0;
1032 if (!strcmp(var, "core.attributesfile"))
1033 return git_config_pathname(&git_attributes_file, var, value);
1035 if (!strcmp(var, "core.hookspath"))
1036 return git_config_pathname(&git_hooks_path, var, value);
1038 if (!strcmp(var, "core.bare")) {
1039 is_bare_repository_cfg = git_config_bool(var, value);
1040 return 0;
1043 if (!strcmp(var, "core.ignorestat")) {
1044 assume_unchanged = git_config_bool(var, value);
1045 return 0;
1048 if (!strcmp(var, "core.prefersymlinkrefs")) {
1049 prefer_symlink_refs = git_config_bool(var, value);
1050 return 0;
1053 if (!strcmp(var, "core.logallrefupdates")) {
1054 if (value && !strcasecmp(value, "always"))
1055 log_all_ref_updates = LOG_REFS_ALWAYS;
1056 else if (git_config_bool(var, value))
1057 log_all_ref_updates = LOG_REFS_NORMAL;
1058 else
1059 log_all_ref_updates = LOG_REFS_NONE;
1060 return 0;
1063 if (!strcmp(var, "core.warnambiguousrefs")) {
1064 warn_ambiguous_refs = git_config_bool(var, value);
1065 return 0;
1068 if (!strcmp(var, "core.abbrev")) {
1069 if (!value)
1070 return config_error_nonbool(var);
1071 if (!strcasecmp(value, "auto"))
1072 default_abbrev = -1;
1073 else {
1074 int abbrev = git_config_int(var, value);
1075 if (abbrev < minimum_abbrev || abbrev > 40)
1076 return error("abbrev length out of range: %d", abbrev);
1077 default_abbrev = abbrev;
1079 return 0;
1082 if (!strcmp(var, "core.disambiguate"))
1083 return set_disambiguate_hint_config(var, value);
1085 if (!strcmp(var, "core.loosecompression")) {
1086 int level = git_config_int(var, value);
1087 if (level == -1)
1088 level = Z_DEFAULT_COMPRESSION;
1089 else if (level < 0 || level > Z_BEST_COMPRESSION)
1090 die(_("bad zlib compression level %d"), level);
1091 zlib_compression_level = level;
1092 zlib_compression_seen = 1;
1093 return 0;
1096 if (!strcmp(var, "core.compression")) {
1097 int level = git_config_int(var, value);
1098 if (level == -1)
1099 level = Z_DEFAULT_COMPRESSION;
1100 else if (level < 0 || level > Z_BEST_COMPRESSION)
1101 die(_("bad zlib compression level %d"), level);
1102 core_compression_level = level;
1103 core_compression_seen = 1;
1104 if (!zlib_compression_seen)
1105 zlib_compression_level = level;
1106 if (!pack_compression_seen)
1107 pack_compression_level = level;
1108 return 0;
1111 if (!strcmp(var, "core.packedgitwindowsize")) {
1112 int pgsz_x2 = getpagesize() * 2;
1113 packed_git_window_size = git_config_ulong(var, value);
1115 /* This value must be multiple of (pagesize * 2) */
1116 packed_git_window_size /= pgsz_x2;
1117 if (packed_git_window_size < 1)
1118 packed_git_window_size = 1;
1119 packed_git_window_size *= pgsz_x2;
1120 return 0;
1123 if (!strcmp(var, "core.bigfilethreshold")) {
1124 big_file_threshold = git_config_ulong(var, value);
1125 return 0;
1128 if (!strcmp(var, "core.packedgitlimit")) {
1129 packed_git_limit = git_config_ulong(var, value);
1130 return 0;
1133 if (!strcmp(var, "core.deltabasecachelimit")) {
1134 delta_base_cache_limit = git_config_ulong(var, value);
1135 return 0;
1138 if (!strcmp(var, "core.autocrlf")) {
1139 if (value && !strcasecmp(value, "input")) {
1140 auto_crlf = AUTO_CRLF_INPUT;
1141 return 0;
1143 auto_crlf = git_config_bool(var, value);
1144 return 0;
1147 if (!strcmp(var, "core.safecrlf")) {
1148 if (value && !strcasecmp(value, "warn")) {
1149 safe_crlf = SAFE_CRLF_WARN;
1150 return 0;
1152 safe_crlf = git_config_bool(var, value);
1153 return 0;
1156 if (!strcmp(var, "core.eol")) {
1157 if (value && !strcasecmp(value, "lf"))
1158 core_eol = EOL_LF;
1159 else if (value && !strcasecmp(value, "crlf"))
1160 core_eol = EOL_CRLF;
1161 else if (value && !strcasecmp(value, "native"))
1162 core_eol = EOL_NATIVE;
1163 else
1164 core_eol = EOL_UNSET;
1165 return 0;
1168 if (!strcmp(var, "core.notesref")) {
1169 notes_ref_name = xstrdup(value);
1170 return 0;
1173 if (!strcmp(var, "core.editor"))
1174 return git_config_string(&editor_program, var, value);
1176 if (!strcmp(var, "core.commentchar")) {
1177 if (!value)
1178 return config_error_nonbool(var);
1179 else if (!strcasecmp(value, "auto"))
1180 auto_comment_line_char = 1;
1181 else if (value[0] && !value[1]) {
1182 comment_line_char = value[0];
1183 auto_comment_line_char = 0;
1184 } else
1185 return error("core.commentChar should only be one character");
1186 return 0;
1189 if (!strcmp(var, "core.askpass"))
1190 return git_config_string(&askpass_program, var, value);
1192 if (!strcmp(var, "core.excludesfile"))
1193 return git_config_pathname(&excludes_file, var, value);
1195 if (!strcmp(var, "core.whitespace")) {
1196 if (!value)
1197 return config_error_nonbool(var);
1198 whitespace_rule_cfg = parse_whitespace_rule(value);
1199 return 0;
1202 if (!strcmp(var, "core.fsyncobjectfiles")) {
1203 fsync_object_files = git_config_bool(var, value);
1204 return 0;
1207 if (!strcmp(var, "core.preloadindex")) {
1208 core_preload_index = git_config_bool(var, value);
1209 return 0;
1212 if (!strcmp(var, "core.createobject")) {
1213 if (!strcmp(value, "rename"))
1214 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1215 else if (!strcmp(value, "link"))
1216 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1217 else
1218 die(_("invalid mode for object creation: %s"), value);
1219 return 0;
1222 if (!strcmp(var, "core.sparsecheckout")) {
1223 core_apply_sparse_checkout = git_config_bool(var, value);
1224 return 0;
1227 if (!strcmp(var, "core.precomposeunicode")) {
1228 precomposed_unicode = git_config_bool(var, value);
1229 return 0;
1232 if (!strcmp(var, "core.protecthfs")) {
1233 protect_hfs = git_config_bool(var, value);
1234 return 0;
1237 if (!strcmp(var, "core.protectntfs")) {
1238 protect_ntfs = git_config_bool(var, value);
1239 return 0;
1242 if (!strcmp(var, "core.hidedotfiles")) {
1243 if (value && !strcasecmp(value, "dotgitonly"))
1244 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1245 else
1246 hide_dotfiles = git_config_bool(var, value);
1247 return 0;
1250 /* Add other config variables here and to Documentation/config.txt. */
1251 return 0;
1254 static int git_default_i18n_config(const char *var, const char *value)
1256 if (!strcmp(var, "i18n.commitencoding"))
1257 return git_config_string(&git_commit_encoding, var, value);
1259 if (!strcmp(var, "i18n.logoutputencoding"))
1260 return git_config_string(&git_log_output_encoding, var, value);
1262 /* Add other config variables here and to Documentation/config.txt. */
1263 return 0;
1266 static int git_default_branch_config(const char *var, const char *value)
1268 if (!strcmp(var, "branch.autosetupmerge")) {
1269 if (value && !strcasecmp(value, "always")) {
1270 git_branch_track = BRANCH_TRACK_ALWAYS;
1271 return 0;
1273 git_branch_track = git_config_bool(var, value);
1274 return 0;
1276 if (!strcmp(var, "branch.autosetuprebase")) {
1277 if (!value)
1278 return config_error_nonbool(var);
1279 else if (!strcmp(value, "never"))
1280 autorebase = AUTOREBASE_NEVER;
1281 else if (!strcmp(value, "local"))
1282 autorebase = AUTOREBASE_LOCAL;
1283 else if (!strcmp(value, "remote"))
1284 autorebase = AUTOREBASE_REMOTE;
1285 else if (!strcmp(value, "always"))
1286 autorebase = AUTOREBASE_ALWAYS;
1287 else
1288 return error("malformed value for %s", var);
1289 return 0;
1292 /* Add other config variables here and to Documentation/config.txt. */
1293 return 0;
1296 static int git_default_push_config(const char *var, const char *value)
1298 if (!strcmp(var, "push.default")) {
1299 if (!value)
1300 return config_error_nonbool(var);
1301 else if (!strcmp(value, "nothing"))
1302 push_default = PUSH_DEFAULT_NOTHING;
1303 else if (!strcmp(value, "matching"))
1304 push_default = PUSH_DEFAULT_MATCHING;
1305 else if (!strcmp(value, "simple"))
1306 push_default = PUSH_DEFAULT_SIMPLE;
1307 else if (!strcmp(value, "upstream"))
1308 push_default = PUSH_DEFAULT_UPSTREAM;
1309 else if (!strcmp(value, "tracking")) /* deprecated */
1310 push_default = PUSH_DEFAULT_UPSTREAM;
1311 else if (!strcmp(value, "current"))
1312 push_default = PUSH_DEFAULT_CURRENT;
1313 else {
1314 error("malformed value for %s: %s", var, value);
1315 return error("Must be one of nothing, matching, simple, "
1316 "upstream or current.");
1318 return 0;
1321 /* Add other config variables here and to Documentation/config.txt. */
1322 return 0;
1325 static int git_default_mailmap_config(const char *var, const char *value)
1327 if (!strcmp(var, "mailmap.file"))
1328 return git_config_pathname(&git_mailmap_file, var, value);
1329 if (!strcmp(var, "mailmap.blob"))
1330 return git_config_string(&git_mailmap_blob, var, value);
1332 /* Add other config variables here and to Documentation/config.txt. */
1333 return 0;
1336 int git_default_config(const char *var, const char *value, void *dummy)
1338 if (starts_with(var, "core."))
1339 return git_default_core_config(var, value);
1341 if (starts_with(var, "user."))
1342 return git_ident_config(var, value, dummy);
1344 if (starts_with(var, "i18n."))
1345 return git_default_i18n_config(var, value);
1347 if (starts_with(var, "branch."))
1348 return git_default_branch_config(var, value);
1350 if (starts_with(var, "push."))
1351 return git_default_push_config(var, value);
1353 if (starts_with(var, "mailmap."))
1354 return git_default_mailmap_config(var, value);
1356 if (starts_with(var, "advice."))
1357 return git_default_advice_config(var, value);
1359 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1360 pager_use_color = git_config_bool(var,value);
1361 return 0;
1364 if (!strcmp(var, "pack.packsizelimit")) {
1365 pack_size_limit_cfg = git_config_ulong(var, value);
1366 return 0;
1369 if (!strcmp(var, "pack.compression")) {
1370 int level = git_config_int(var, value);
1371 if (level == -1)
1372 level = Z_DEFAULT_COMPRESSION;
1373 else if (level < 0 || level > Z_BEST_COMPRESSION)
1374 die(_("bad pack compression level %d"), level);
1375 pack_compression_level = level;
1376 pack_compression_seen = 1;
1377 return 0;
1380 /* Add other config variables here and to Documentation/config.txt. */
1381 return 0;
1385 * All source specific fields in the union, die_on_error, name and the callbacks
1386 * fgetc, ungetc, ftell of top need to be initialized before calling
1387 * this function.
1389 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1391 int ret;
1393 /* push config-file parsing state stack */
1394 top->prev = cf;
1395 top->linenr = 1;
1396 top->eof = 0;
1397 strbuf_init(&top->value, 1024);
1398 strbuf_init(&top->var, 1024);
1399 cf = top;
1401 ret = git_parse_source(fn, data);
1403 /* pop config-file parsing state stack */
1404 strbuf_release(&top->value);
1405 strbuf_release(&top->var);
1406 cf = top->prev;
1408 return ret;
1411 static int do_config_from_file(config_fn_t fn,
1412 const enum config_origin_type origin_type,
1413 const char *name, const char *path, FILE *f,
1414 void *data)
1416 struct config_source top;
1418 top.u.file = f;
1419 top.origin_type = origin_type;
1420 top.name = name;
1421 top.path = path;
1422 top.die_on_error = 1;
1423 top.do_fgetc = config_file_fgetc;
1424 top.do_ungetc = config_file_ungetc;
1425 top.do_ftell = config_file_ftell;
1427 return do_config_from(&top, fn, data);
1430 static int git_config_from_stdin(config_fn_t fn, void *data)
1432 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1435 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1437 int ret = -1;
1438 FILE *f;
1440 f = fopen_or_warn(filename, "r");
1441 if (f) {
1442 flockfile(f);
1443 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1444 funlockfile(f);
1445 fclose(f);
1447 return ret;
1450 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1451 const char *name, const char *buf, size_t len, void *data)
1453 struct config_source top;
1455 top.u.buf.buf = buf;
1456 top.u.buf.len = len;
1457 top.u.buf.pos = 0;
1458 top.origin_type = origin_type;
1459 top.name = name;
1460 top.path = NULL;
1461 top.die_on_error = 0;
1462 top.do_fgetc = config_buf_fgetc;
1463 top.do_ungetc = config_buf_ungetc;
1464 top.do_ftell = config_buf_ftell;
1466 return do_config_from(&top, fn, data);
1469 int git_config_from_blob_sha1(config_fn_t fn,
1470 const char *name,
1471 const unsigned char *sha1,
1472 void *data)
1474 enum object_type type;
1475 char *buf;
1476 unsigned long size;
1477 int ret;
1479 buf = read_sha1_file(sha1, &type, &size);
1480 if (!buf)
1481 return error("unable to load config blob object '%s'", name);
1482 if (type != OBJ_BLOB) {
1483 free(buf);
1484 return error("reference '%s' does not point to a blob", name);
1487 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1488 free(buf);
1490 return ret;
1493 static int git_config_from_blob_ref(config_fn_t fn,
1494 const char *name,
1495 void *data)
1497 unsigned char sha1[20];
1499 if (get_sha1(name, sha1) < 0)
1500 return error("unable to resolve config blob '%s'", name);
1501 return git_config_from_blob_sha1(fn, name, sha1, data);
1504 const char *git_etc_gitconfig(void)
1506 static const char *system_wide;
1507 if (!system_wide)
1508 system_wide = system_path(ETC_GITCONFIG);
1509 return system_wide;
1513 * Parse environment variable 'k' as a boolean (in various
1514 * possible spellings); if missing, use the default value 'def'.
1516 int git_env_bool(const char *k, int def)
1518 const char *v = getenv(k);
1519 return v ? git_config_bool(k, v) : def;
1523 * Parse environment variable 'k' as ulong with possibly a unit
1524 * suffix; if missing, use the default value 'val'.
1526 unsigned long git_env_ulong(const char *k, unsigned long val)
1528 const char *v = getenv(k);
1529 if (v && !git_parse_ulong(v, &val))
1530 die("failed to parse %s", k);
1531 return val;
1534 int git_config_system(void)
1536 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1539 static int do_git_config_sequence(const struct config_options *opts,
1540 config_fn_t fn, void *data)
1542 int ret = 0;
1543 char *xdg_config = xdg_config_home("config");
1544 char *user_config = expand_user_path("~/.gitconfig", 0);
1545 char *repo_config;
1547 if (opts->commondir)
1548 repo_config = mkpathdup("%s/config", opts->commondir);
1549 else
1550 repo_config = NULL;
1552 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1553 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1554 ret += git_config_from_file(fn, git_etc_gitconfig(),
1555 data);
1557 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1558 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1559 ret += git_config_from_file(fn, xdg_config, data);
1561 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1562 ret += git_config_from_file(fn, user_config, data);
1564 current_parsing_scope = CONFIG_SCOPE_REPO;
1565 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1566 ret += git_config_from_file(fn, repo_config, data);
1568 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1569 if (git_config_from_parameters(fn, data) < 0)
1570 die(_("unable to parse command-line config"));
1572 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1573 free(xdg_config);
1574 free(user_config);
1575 free(repo_config);
1576 return ret;
1579 int config_with_options(config_fn_t fn, void *data,
1580 struct git_config_source *config_source,
1581 const struct config_options *opts)
1583 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1585 if (opts->respect_includes) {
1586 inc.fn = fn;
1587 inc.data = data;
1588 inc.opts = opts;
1589 fn = git_config_include;
1590 data = &inc;
1594 * If we have a specific filename, use it. Otherwise, follow the
1595 * regular lookup sequence.
1597 if (config_source && config_source->use_stdin)
1598 return git_config_from_stdin(fn, data);
1599 else if (config_source && config_source->file)
1600 return git_config_from_file(fn, config_source->file, data);
1601 else if (config_source && config_source->blob)
1602 return git_config_from_blob_ref(fn, config_source->blob, data);
1604 return do_git_config_sequence(opts, fn, data);
1607 static void git_config_raw(config_fn_t fn, void *data)
1609 struct config_options opts = {0};
1611 opts.respect_includes = 1;
1612 if (have_git_dir()) {
1613 opts.commondir = get_git_common_dir();
1614 opts.git_dir = get_git_dir();
1617 if (config_with_options(fn, data, NULL, &opts) < 0)
1619 * config_with_options() normally returns only
1620 * zero, as most errors are fatal, and
1621 * non-fatal potential errors are guarded by "if"
1622 * statements that are entered only when no error is
1623 * possible.
1625 * If we ever encounter a non-fatal error, it means
1626 * something went really wrong and we should stop
1627 * immediately.
1629 die(_("unknown error occurred while reading the configuration files"));
1632 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1634 int i, value_index;
1635 struct string_list *values;
1636 struct config_set_element *entry;
1637 struct configset_list *list = &cs->list;
1639 for (i = 0; i < list->nr; i++) {
1640 entry = list->items[i].e;
1641 value_index = list->items[i].value_index;
1642 values = &entry->value_list;
1644 current_config_kvi = values->items[value_index].util;
1646 if (fn(entry->key, values->items[value_index].string, data) < 0)
1647 git_die_config_linenr(entry->key,
1648 current_config_kvi->filename,
1649 current_config_kvi->linenr);
1651 current_config_kvi = NULL;
1655 void read_early_config(config_fn_t cb, void *data)
1657 struct config_options opts = {0};
1658 struct strbuf commondir = STRBUF_INIT;
1659 struct strbuf gitdir = STRBUF_INIT;
1661 opts.respect_includes = 1;
1663 if (have_git_dir()) {
1664 opts.commondir = get_git_common_dir();
1665 opts.git_dir = get_git_dir();
1667 * When setup_git_directory() was not yet asked to discover the
1668 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1669 * is any repository config we should use (but unlike
1670 * setup_git_directory_gently(), no global state is changed, most
1671 * notably, the current working directory is still the same after the
1672 * call).
1674 } else if (!discover_git_directory(&commondir, &gitdir)) {
1675 opts.commondir = commondir.buf;
1676 opts.git_dir = gitdir.buf;
1679 config_with_options(cb, data, NULL, &opts);
1681 strbuf_release(&commondir);
1682 strbuf_release(&gitdir);
1685 static void git_config_check_init(void);
1687 void git_config(config_fn_t fn, void *data)
1689 git_config_check_init();
1690 configset_iter(&the_config_set, fn, data);
1693 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1695 struct config_set_element k;
1696 struct config_set_element *found_entry;
1697 char *normalized_key;
1699 * `key` may come from the user, so normalize it before using it
1700 * for querying entries from the hashmap.
1702 if (git_config_parse_key(key, &normalized_key, NULL))
1703 return NULL;
1705 hashmap_entry_init(&k, strhash(normalized_key));
1706 k.key = normalized_key;
1707 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1708 free(normalized_key);
1709 return found_entry;
1712 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1714 struct config_set_element *e;
1715 struct string_list_item *si;
1716 struct configset_list_item *l_item;
1717 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1719 e = configset_find_element(cs, key);
1721 * Since the keys are being fed by git_config*() callback mechanism, they
1722 * are already normalized. So simply add them without any further munging.
1724 if (!e) {
1725 e = xmalloc(sizeof(*e));
1726 hashmap_entry_init(e, strhash(key));
1727 e->key = xstrdup(key);
1728 string_list_init(&e->value_list, 1);
1729 hashmap_add(&cs->config_hash, e);
1731 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1733 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1734 l_item = &cs->list.items[cs->list.nr++];
1735 l_item->e = e;
1736 l_item->value_index = e->value_list.nr - 1;
1738 if (!cf)
1739 die("BUG: configset_add_value has no source");
1740 if (cf->name) {
1741 kv_info->filename = strintern(cf->name);
1742 kv_info->linenr = cf->linenr;
1743 kv_info->origin_type = cf->origin_type;
1744 } else {
1745 /* for values read from `git_config_from_parameters()` */
1746 kv_info->filename = NULL;
1747 kv_info->linenr = -1;
1748 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1750 kv_info->scope = current_parsing_scope;
1751 si->util = kv_info;
1753 return 0;
1756 static int config_set_element_cmp(const void *unused_cmp_data,
1757 const struct config_set_element *e1,
1758 const struct config_set_element *e2,
1759 const void *unused_keydata)
1761 return strcmp(e1->key, e2->key);
1764 void git_configset_init(struct config_set *cs)
1766 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp,
1767 NULL, 0);
1768 cs->hash_initialized = 1;
1769 cs->list.nr = 0;
1770 cs->list.alloc = 0;
1771 cs->list.items = NULL;
1774 void git_configset_clear(struct config_set *cs)
1776 struct config_set_element *entry;
1777 struct hashmap_iter iter;
1778 if (!cs->hash_initialized)
1779 return;
1781 hashmap_iter_init(&cs->config_hash, &iter);
1782 while ((entry = hashmap_iter_next(&iter))) {
1783 free(entry->key);
1784 string_list_clear(&entry->value_list, 1);
1786 hashmap_free(&cs->config_hash, 1);
1787 cs->hash_initialized = 0;
1788 free(cs->list.items);
1789 cs->list.nr = 0;
1790 cs->list.alloc = 0;
1791 cs->list.items = NULL;
1794 static int config_set_callback(const char *key, const char *value, void *cb)
1796 struct config_set *cs = cb;
1797 configset_add_value(cs, key, value);
1798 return 0;
1801 int git_configset_add_file(struct config_set *cs, const char *filename)
1803 return git_config_from_file(config_set_callback, filename, cs);
1806 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1808 const struct string_list *values = NULL;
1810 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1811 * queried key in the files of the configset, the value returned will be the last
1812 * value in the value list for that key.
1814 values = git_configset_get_value_multi(cs, key);
1816 if (!values)
1817 return 1;
1818 assert(values->nr > 0);
1819 *value = values->items[values->nr - 1].string;
1820 return 0;
1823 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1825 struct config_set_element *e = configset_find_element(cs, key);
1826 return e ? &e->value_list : NULL;
1829 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1831 const char *value;
1832 if (!git_configset_get_value(cs, key, &value))
1833 return git_config_string(dest, key, value);
1834 else
1835 return 1;
1838 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1840 return git_configset_get_string_const(cs, key, (const char **)dest);
1843 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1845 const char *value;
1846 if (!git_configset_get_value(cs, key, &value)) {
1847 *dest = git_config_int(key, value);
1848 return 0;
1849 } else
1850 return 1;
1853 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1855 const char *value;
1856 if (!git_configset_get_value(cs, key, &value)) {
1857 *dest = git_config_ulong(key, value);
1858 return 0;
1859 } else
1860 return 1;
1863 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1865 const char *value;
1866 if (!git_configset_get_value(cs, key, &value)) {
1867 *dest = git_config_bool(key, value);
1868 return 0;
1869 } else
1870 return 1;
1873 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1874 int *is_bool, int *dest)
1876 const char *value;
1877 if (!git_configset_get_value(cs, key, &value)) {
1878 *dest = git_config_bool_or_int(key, value, is_bool);
1879 return 0;
1880 } else
1881 return 1;
1884 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1886 const char *value;
1887 if (!git_configset_get_value(cs, key, &value)) {
1888 *dest = git_config_maybe_bool(key, value);
1889 if (*dest == -1)
1890 return -1;
1891 return 0;
1892 } else
1893 return 1;
1896 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1898 const char *value;
1899 if (!git_configset_get_value(cs, key, &value))
1900 return git_config_pathname(dest, key, value);
1901 else
1902 return 1;
1905 static void git_config_check_init(void)
1907 if (the_config_set.hash_initialized)
1908 return;
1909 git_configset_init(&the_config_set);
1910 git_config_raw(config_set_callback, &the_config_set);
1913 void git_config_clear(void)
1915 if (!the_config_set.hash_initialized)
1916 return;
1917 git_configset_clear(&the_config_set);
1920 int git_config_get_value(const char *key, const char **value)
1922 git_config_check_init();
1923 return git_configset_get_value(&the_config_set, key, value);
1926 const struct string_list *git_config_get_value_multi(const char *key)
1928 git_config_check_init();
1929 return git_configset_get_value_multi(&the_config_set, key);
1932 int git_config_get_string_const(const char *key, const char **dest)
1934 int ret;
1935 git_config_check_init();
1936 ret = git_configset_get_string_const(&the_config_set, key, dest);
1937 if (ret < 0)
1938 git_die_config(key, NULL);
1939 return ret;
1942 int git_config_get_string(const char *key, char **dest)
1944 git_config_check_init();
1945 return git_config_get_string_const(key, (const char **)dest);
1948 int git_config_get_int(const char *key, int *dest)
1950 git_config_check_init();
1951 return git_configset_get_int(&the_config_set, key, dest);
1954 int git_config_get_ulong(const char *key, unsigned long *dest)
1956 git_config_check_init();
1957 return git_configset_get_ulong(&the_config_set, key, dest);
1960 int git_config_get_bool(const char *key, int *dest)
1962 git_config_check_init();
1963 return git_configset_get_bool(&the_config_set, key, dest);
1966 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1968 git_config_check_init();
1969 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1972 int git_config_get_maybe_bool(const char *key, int *dest)
1974 git_config_check_init();
1975 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1978 int git_config_get_pathname(const char *key, const char **dest)
1980 int ret;
1981 git_config_check_init();
1982 ret = git_configset_get_pathname(&the_config_set, key, dest);
1983 if (ret < 0)
1984 git_die_config(key, NULL);
1985 return ret;
1988 int git_config_get_expiry(const char *key, const char **output)
1990 int ret = git_config_get_string_const(key, output);
1991 if (ret)
1992 return ret;
1993 if (strcmp(*output, "now")) {
1994 timestamp_t now = approxidate("now");
1995 if (approxidate(*output) >= now)
1996 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
1998 return ret;
2001 int git_config_get_untracked_cache(void)
2003 int val = -1;
2004 const char *v;
2006 /* Hack for test programs like test-dump-untracked-cache */
2007 if (ignore_untracked_cache_config)
2008 return -1;
2010 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2011 return val;
2013 if (!git_config_get_value("core.untrackedcache", &v)) {
2014 if (!strcasecmp(v, "keep"))
2015 return -1;
2017 error(_("unknown core.untrackedCache value '%s'; "
2018 "using 'keep' default value"), v);
2019 return -1;
2022 return -1; /* default value */
2025 int git_config_get_split_index(void)
2027 int val;
2029 if (!git_config_get_maybe_bool("core.splitindex", &val))
2030 return val;
2032 return -1; /* default value */
2035 int git_config_get_max_percent_split_change(void)
2037 int val = -1;
2039 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2040 if (0 <= val && val <= 100)
2041 return val;
2043 return error(_("splitIndex.maxPercentChange value '%d' "
2044 "should be between 0 and 100"), val);
2047 return -1; /* default value */
2050 NORETURN
2051 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2053 if (!filename)
2054 die(_("unable to parse '%s' from command-line config"), key);
2055 else
2056 die(_("bad config variable '%s' in file '%s' at line %d"),
2057 key, filename, linenr);
2060 NORETURN __attribute__((format(printf, 2, 3)))
2061 void git_die_config(const char *key, const char *err, ...)
2063 const struct string_list *values;
2064 struct key_value_info *kv_info;
2066 if (err) {
2067 va_list params;
2068 va_start(params, err);
2069 vreportf("error: ", err, params);
2070 va_end(params);
2072 values = git_config_get_value_multi(key);
2073 kv_info = values->items[values->nr - 1].util;
2074 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2078 * Find all the stuff for git_config_set() below.
2081 static struct {
2082 int baselen;
2083 char *key;
2084 int do_not_match;
2085 regex_t *value_regex;
2086 int multi_replace;
2087 size_t *offset;
2088 unsigned int offset_alloc;
2089 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2090 int seen;
2091 } store;
2093 static int matches(const char *key, const char *value)
2095 if (strcmp(key, store.key))
2096 return 0; /* not ours */
2097 if (!store.value_regex)
2098 return 1; /* always matches */
2099 if (store.value_regex == CONFIG_REGEX_NONE)
2100 return 0; /* never matches */
2102 return store.do_not_match ^
2103 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2106 static int store_aux(const char *key, const char *value, void *cb)
2108 const char *ep;
2109 size_t section_len;
2111 switch (store.state) {
2112 case KEY_SEEN:
2113 if (matches(key, value)) {
2114 if (store.seen == 1 && store.multi_replace == 0) {
2115 warning(_("%s has multiple values"), key);
2118 ALLOC_GROW(store.offset, store.seen + 1,
2119 store.offset_alloc);
2121 store.offset[store.seen] = cf->do_ftell(cf);
2122 store.seen++;
2124 break;
2125 case SECTION_SEEN:
2127 * What we are looking for is in store.key (both
2128 * section and var), and its section part is baselen
2129 * long. We found key (again, both section and var).
2130 * We would want to know if this key is in the same
2131 * section as what we are looking for. We already
2132 * know we are in the same section as what should
2133 * hold store.key.
2135 ep = strrchr(key, '.');
2136 section_len = ep - key;
2138 if ((section_len != store.baselen) ||
2139 memcmp(key, store.key, section_len+1)) {
2140 store.state = SECTION_END_SEEN;
2141 break;
2145 * Do not increment matches: this is no match, but we
2146 * just made sure we are in the desired section.
2148 ALLOC_GROW(store.offset, store.seen + 1,
2149 store.offset_alloc);
2150 store.offset[store.seen] = cf->do_ftell(cf);
2151 /* fallthru */
2152 case SECTION_END_SEEN:
2153 case START:
2154 if (matches(key, value)) {
2155 ALLOC_GROW(store.offset, store.seen + 1,
2156 store.offset_alloc);
2157 store.offset[store.seen] = cf->do_ftell(cf);
2158 store.state = KEY_SEEN;
2159 store.seen++;
2160 } else {
2161 if (strrchr(key, '.') - key == store.baselen &&
2162 !strncmp(key, store.key, store.baselen)) {
2163 store.state = SECTION_SEEN;
2164 ALLOC_GROW(store.offset,
2165 store.seen + 1,
2166 store.offset_alloc);
2167 store.offset[store.seen] = cf->do_ftell(cf);
2171 return 0;
2174 static int write_error(const char *filename)
2176 error("failed to write new configuration file %s", filename);
2178 /* Same error code as "failed to rename". */
2179 return 4;
2182 static int store_write_section(int fd, const char *key)
2184 const char *dot;
2185 int i, success;
2186 struct strbuf sb = STRBUF_INIT;
2188 dot = memchr(key, '.', store.baselen);
2189 if (dot) {
2190 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2191 for (i = dot - key + 1; i < store.baselen; i++) {
2192 if (key[i] == '"' || key[i] == '\\')
2193 strbuf_addch(&sb, '\\');
2194 strbuf_addch(&sb, key[i]);
2196 strbuf_addstr(&sb, "\"]\n");
2197 } else {
2198 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2201 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2202 strbuf_release(&sb);
2204 return success;
2207 static int store_write_pair(int fd, const char *key, const char *value)
2209 int i, success;
2210 int length = strlen(key + store.baselen + 1);
2211 const char *quote = "";
2212 struct strbuf sb = STRBUF_INIT;
2215 * Check to see if the value needs to be surrounded with a dq pair.
2216 * Note that problematic characters are always backslash-quoted; this
2217 * check is about not losing leading or trailing SP and strings that
2218 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2219 * configuration parser.
2221 if (value[0] == ' ')
2222 quote = "\"";
2223 for (i = 0; value[i]; i++)
2224 if (value[i] == ';' || value[i] == '#')
2225 quote = "\"";
2226 if (i && value[i - 1] == ' ')
2227 quote = "\"";
2229 strbuf_addf(&sb, "\t%.*s = %s",
2230 length, key + store.baselen + 1, quote);
2232 for (i = 0; value[i]; i++)
2233 switch (value[i]) {
2234 case '\n':
2235 strbuf_addstr(&sb, "\\n");
2236 break;
2237 case '\t':
2238 strbuf_addstr(&sb, "\\t");
2239 break;
2240 case '"':
2241 case '\\':
2242 strbuf_addch(&sb, '\\');
2243 default:
2244 strbuf_addch(&sb, value[i]);
2245 break;
2247 strbuf_addf(&sb, "%s\n", quote);
2249 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2250 strbuf_release(&sb);
2252 return success;
2255 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2256 size_t offset_, int *found_bracket)
2258 size_t equal_offset = size, bracket_offset = size;
2259 ssize_t offset;
2261 contline:
2262 for (offset = offset_-2; offset > 0
2263 && contents[offset] != '\n'; offset--)
2264 switch (contents[offset]) {
2265 case '=': equal_offset = offset; break;
2266 case ']': bracket_offset = offset; break;
2268 if (offset > 0 && contents[offset-1] == '\\') {
2269 offset_ = offset;
2270 goto contline;
2272 if (bracket_offset < equal_offset) {
2273 *found_bracket = 1;
2274 offset = bracket_offset+1;
2275 } else
2276 offset++;
2278 return offset;
2281 int git_config_set_in_file_gently(const char *config_filename,
2282 const char *key, const char *value)
2284 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2287 void git_config_set_in_file(const char *config_filename,
2288 const char *key, const char *value)
2290 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2293 int git_config_set_gently(const char *key, const char *value)
2295 return git_config_set_multivar_gently(key, value, NULL, 0);
2298 void git_config_set(const char *key, const char *value)
2300 git_config_set_multivar(key, value, NULL, 0);
2304 * If value==NULL, unset in (remove from) config,
2305 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2306 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2307 * (only add a new one)
2308 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2309 * else all matching key/values (regardless how many) are removed,
2310 * before the new pair is written.
2312 * Returns 0 on success.
2314 * This function does this:
2316 * - it locks the config file by creating ".git/config.lock"
2318 * - it then parses the config using store_aux() as validator to find
2319 * the position on the key/value pair to replace. If it is to be unset,
2320 * it must be found exactly once.
2322 * - the config file is mmap()ed and the part before the match (if any) is
2323 * written to the lock file, then the changed part and the rest.
2325 * - the config file is removed and the lock file rename()d to it.
2328 int git_config_set_multivar_in_file_gently(const char *config_filename,
2329 const char *key, const char *value,
2330 const char *value_regex,
2331 int multi_replace)
2333 int fd = -1, in_fd = -1;
2334 int ret;
2335 struct lock_file *lock = NULL;
2336 char *filename_buf = NULL;
2337 char *contents = NULL;
2338 size_t contents_sz;
2340 /* parse-key returns negative; flip the sign to feed exit(3) */
2341 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2342 if (ret)
2343 goto out_free;
2345 store.multi_replace = multi_replace;
2347 if (!config_filename)
2348 config_filename = filename_buf = git_pathdup("config");
2351 * The lock serves a purpose in addition to locking: the new
2352 * contents of .git/config will be written into it.
2354 lock = xcalloc(1, sizeof(struct lock_file));
2355 fd = hold_lock_file_for_update(lock, config_filename, 0);
2356 if (fd < 0) {
2357 error_errno("could not lock config file %s", config_filename);
2358 free(store.key);
2359 ret = CONFIG_NO_LOCK;
2360 goto out_free;
2364 * If .git/config does not exist yet, write a minimal version.
2366 in_fd = open(config_filename, O_RDONLY);
2367 if ( in_fd < 0 ) {
2368 free(store.key);
2370 if ( ENOENT != errno ) {
2371 error_errno("opening %s", config_filename);
2372 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2373 goto out_free;
2375 /* if nothing to unset, error out */
2376 if (value == NULL) {
2377 ret = CONFIG_NOTHING_SET;
2378 goto out_free;
2381 store.key = (char *)key;
2382 if (!store_write_section(fd, key) ||
2383 !store_write_pair(fd, key, value))
2384 goto write_err_out;
2385 } else {
2386 struct stat st;
2387 size_t copy_begin, copy_end;
2388 int i, new_line = 0;
2390 if (value_regex == NULL)
2391 store.value_regex = NULL;
2392 else if (value_regex == CONFIG_REGEX_NONE)
2393 store.value_regex = CONFIG_REGEX_NONE;
2394 else {
2395 if (value_regex[0] == '!') {
2396 store.do_not_match = 1;
2397 value_regex++;
2398 } else
2399 store.do_not_match = 0;
2401 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2402 if (regcomp(store.value_regex, value_regex,
2403 REG_EXTENDED)) {
2404 error("invalid pattern: %s", value_regex);
2405 free(store.value_regex);
2406 ret = CONFIG_INVALID_PATTERN;
2407 goto out_free;
2411 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2412 store.offset[0] = 0;
2413 store.state = START;
2414 store.seen = 0;
2417 * After this, store.offset will contain the *end* offset
2418 * of the last match, or remain at 0 if no match was found.
2419 * As a side effect, we make sure to transform only a valid
2420 * existing config file.
2422 if (git_config_from_file(store_aux, config_filename, NULL)) {
2423 error("invalid config file %s", config_filename);
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);
2430 ret = CONFIG_INVALID_FILE;
2431 goto out_free;
2434 free(store.key);
2435 if (store.value_regex != NULL &&
2436 store.value_regex != CONFIG_REGEX_NONE) {
2437 regfree(store.value_regex);
2438 free(store.value_regex);
2441 /* if nothing to unset, or too many matches, error out */
2442 if ((store.seen == 0 && value == NULL) ||
2443 (store.seen > 1 && multi_replace == 0)) {
2444 ret = CONFIG_NOTHING_SET;
2445 goto out_free;
2448 if (fstat(in_fd, &st) == -1) {
2449 error_errno(_("fstat on %s failed"), config_filename);
2450 ret = CONFIG_INVALID_FILE;
2451 goto out_free;
2454 contents_sz = xsize_t(st.st_size);
2455 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2456 MAP_PRIVATE, in_fd, 0);
2457 if (contents == MAP_FAILED) {
2458 if (errno == ENODEV && S_ISDIR(st.st_mode))
2459 errno = EISDIR;
2460 error_errno("unable to mmap '%s'", config_filename);
2461 ret = CONFIG_INVALID_FILE;
2462 contents = NULL;
2463 goto out_free;
2465 close(in_fd);
2466 in_fd = -1;
2468 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2469 error_errno("chmod on %s failed", get_lock_file_path(lock));
2470 ret = CONFIG_NO_WRITE;
2471 goto out_free;
2474 if (store.seen == 0)
2475 store.seen = 1;
2477 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2478 if (store.offset[i] == 0) {
2479 store.offset[i] = copy_end = contents_sz;
2480 } else if (store.state != KEY_SEEN) {
2481 copy_end = store.offset[i];
2482 } else
2483 copy_end = find_beginning_of_line(
2484 contents, contents_sz,
2485 store.offset[i]-2, &new_line);
2487 if (copy_end > 0 && contents[copy_end-1] != '\n')
2488 new_line = 1;
2490 /* write the first part of the config */
2491 if (copy_end > copy_begin) {
2492 if (write_in_full(fd, contents + copy_begin,
2493 copy_end - copy_begin) <
2494 copy_end - copy_begin)
2495 goto write_err_out;
2496 if (new_line &&
2497 write_str_in_full(fd, "\n") != 1)
2498 goto write_err_out;
2500 copy_begin = store.offset[i];
2503 /* write the pair (value == NULL means unset) */
2504 if (value != NULL) {
2505 if (store.state == START) {
2506 if (!store_write_section(fd, key))
2507 goto write_err_out;
2509 if (!store_write_pair(fd, key, value))
2510 goto write_err_out;
2513 /* write the rest of the config */
2514 if (copy_begin < contents_sz)
2515 if (write_in_full(fd, contents + copy_begin,
2516 contents_sz - copy_begin) <
2517 contents_sz - copy_begin)
2518 goto write_err_out;
2520 munmap(contents, contents_sz);
2521 contents = NULL;
2524 if (commit_lock_file(lock) < 0) {
2525 error_errno("could not write config file %s", config_filename);
2526 ret = CONFIG_NO_WRITE;
2527 lock = NULL;
2528 goto out_free;
2532 * lock is committed, so don't try to roll it back below.
2533 * NOTE: Since lockfile.c keeps a linked list of all created
2534 * lock_file structures, it isn't safe to free(lock). It's
2535 * better to just leave it hanging around.
2537 lock = NULL;
2538 ret = 0;
2540 /* Invalidate the config cache */
2541 git_config_clear();
2543 out_free:
2544 if (lock)
2545 rollback_lock_file(lock);
2546 free(filename_buf);
2547 if (contents)
2548 munmap(contents, contents_sz);
2549 if (in_fd >= 0)
2550 close(in_fd);
2551 return ret;
2553 write_err_out:
2554 ret = write_error(get_lock_file_path(lock));
2555 goto out_free;
2559 void git_config_set_multivar_in_file(const char *config_filename,
2560 const char *key, const char *value,
2561 const char *value_regex, int multi_replace)
2563 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2564 value_regex, multi_replace))
2565 return;
2566 if (value)
2567 die(_("could not set '%s' to '%s'"), key, value);
2568 else
2569 die(_("could not unset '%s'"), key);
2572 int git_config_set_multivar_gently(const char *key, const char *value,
2573 const char *value_regex, int multi_replace)
2575 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2576 multi_replace);
2579 void git_config_set_multivar(const char *key, const char *value,
2580 const char *value_regex, int multi_replace)
2582 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2583 multi_replace);
2586 static int section_name_match (const char *buf, const char *name)
2588 int i = 0, j = 0, dot = 0;
2589 if (buf[i] != '[')
2590 return 0;
2591 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2592 if (!dot && isspace(buf[i])) {
2593 dot = 1;
2594 if (name[j++] != '.')
2595 break;
2596 for (i++; isspace(buf[i]); i++)
2597 ; /* do nothing */
2598 if (buf[i] != '"')
2599 break;
2600 continue;
2602 if (buf[i] == '\\' && dot)
2603 i++;
2604 else if (buf[i] == '"' && dot) {
2605 for (i++; isspace(buf[i]); i++)
2606 ; /* do_nothing */
2607 break;
2609 if (buf[i] != name[j++])
2610 break;
2612 if (buf[i] == ']' && name[j] == 0) {
2614 * We match, now just find the right length offset by
2615 * gobbling up any whitespace after it, as well
2617 i++;
2618 for (; buf[i] && isspace(buf[i]); i++)
2619 ; /* do nothing */
2620 return i;
2622 return 0;
2625 static int section_name_is_ok(const char *name)
2627 /* Empty section names are bogus. */
2628 if (!*name)
2629 return 0;
2632 * Before a dot, we must be alphanumeric or dash. After the first dot,
2633 * anything goes, so we can stop checking.
2635 for (; *name && *name != '.'; name++)
2636 if (*name != '-' && !isalnum(*name))
2637 return 0;
2638 return 1;
2641 /* if new_name == NULL, the section is removed instead */
2642 int git_config_rename_section_in_file(const char *config_filename,
2643 const char *old_name, const char *new_name)
2645 int ret = 0, remove = 0;
2646 char *filename_buf = NULL;
2647 struct lock_file *lock;
2648 int out_fd;
2649 char buf[1024];
2650 FILE *config_file = NULL;
2651 struct stat st;
2653 if (new_name && !section_name_is_ok(new_name)) {
2654 ret = error("invalid section name: %s", new_name);
2655 goto out_no_rollback;
2658 if (!config_filename)
2659 config_filename = filename_buf = git_pathdup("config");
2661 lock = xcalloc(1, sizeof(struct lock_file));
2662 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2663 if (out_fd < 0) {
2664 ret = error("could not lock config file %s", config_filename);
2665 goto out;
2668 if (!(config_file = fopen(config_filename, "rb"))) {
2669 ret = warn_on_fopen_errors(config_filename);
2670 if (ret)
2671 goto out;
2672 /* no config file means nothing to rename, no error */
2673 goto commit_and_out;
2676 if (fstat(fileno(config_file), &st) == -1) {
2677 ret = error_errno(_("fstat on %s failed"), config_filename);
2678 goto out;
2681 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2682 ret = error_errno("chmod on %s failed",
2683 get_lock_file_path(lock));
2684 goto out;
2687 while (fgets(buf, sizeof(buf), config_file)) {
2688 int i;
2689 int length;
2690 char *output = buf;
2691 for (i = 0; buf[i] && isspace(buf[i]); i++)
2692 ; /* do nothing */
2693 if (buf[i] == '[') {
2694 /* it's a section */
2695 int offset = section_name_match(&buf[i], old_name);
2696 if (offset > 0) {
2697 ret++;
2698 if (new_name == NULL) {
2699 remove = 1;
2700 continue;
2702 store.baselen = strlen(new_name);
2703 if (!store_write_section(out_fd, new_name)) {
2704 ret = write_error(get_lock_file_path(lock));
2705 goto out;
2708 * We wrote out the new section, with
2709 * a newline, now skip the old
2710 * section's length
2712 output += offset + i;
2713 if (strlen(output) > 0) {
2715 * More content means there's
2716 * a declaration to put on the
2717 * next line; indent with a
2718 * tab
2720 output -= 1;
2721 output[0] = '\t';
2724 remove = 0;
2726 if (remove)
2727 continue;
2728 length = strlen(output);
2729 if (write_in_full(out_fd, output, length) != length) {
2730 ret = write_error(get_lock_file_path(lock));
2731 goto out;
2734 fclose(config_file);
2735 config_file = NULL;
2736 commit_and_out:
2737 if (commit_lock_file(lock) < 0)
2738 ret = error_errno("could not write config file %s",
2739 config_filename);
2740 out:
2741 if (config_file)
2742 fclose(config_file);
2743 rollback_lock_file(lock);
2744 out_no_rollback:
2745 free(filename_buf);
2746 return ret;
2749 int git_config_rename_section(const char *old_name, const char *new_name)
2751 return git_config_rename_section_in_file(NULL, old_name, new_name);
2755 * Call this to report error for your variable that should not
2756 * get a boolean value (i.e. "[my] var" means "true").
2758 #undef config_error_nonbool
2759 int config_error_nonbool(const char *var)
2761 return error("missing value for '%s'", var);
2764 int parse_config_key(const char *var,
2765 const char *section,
2766 const char **subsection, int *subsection_len,
2767 const char **key)
2769 const char *dot;
2771 /* Does it start with "section." ? */
2772 if (!skip_prefix(var, section, &var) || *var != '.')
2773 return -1;
2776 * Find the key; we don't know yet if we have a subsection, but we must
2777 * parse backwards from the end, since the subsection may have dots in
2778 * it, too.
2780 dot = strrchr(var, '.');
2781 *key = dot + 1;
2783 /* Did we have a subsection at all? */
2784 if (dot == var) {
2785 if (subsection) {
2786 *subsection = NULL;
2787 *subsection_len = 0;
2790 else {
2791 if (!subsection)
2792 return -1;
2793 *subsection = var + 1;
2794 *subsection_len = dot - *subsection;
2797 return 0;
2800 const char *current_config_origin_type(void)
2802 int type;
2803 if (current_config_kvi)
2804 type = current_config_kvi->origin_type;
2805 else if(cf)
2806 type = cf->origin_type;
2807 else
2808 die("BUG: current_config_origin_type called outside config callback");
2810 switch (type) {
2811 case CONFIG_ORIGIN_BLOB:
2812 return "blob";
2813 case CONFIG_ORIGIN_FILE:
2814 return "file";
2815 case CONFIG_ORIGIN_STDIN:
2816 return "standard input";
2817 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2818 return "submodule-blob";
2819 case CONFIG_ORIGIN_CMDLINE:
2820 return "command line";
2821 default:
2822 die("BUG: unknown config origin type");
2826 const char *current_config_name(void)
2828 const char *name;
2829 if (current_config_kvi)
2830 name = current_config_kvi->filename;
2831 else if (cf)
2832 name = cf->name;
2833 else
2834 die("BUG: current_config_name called outside config callback");
2835 return name ? name : "";
2838 enum config_scope current_config_scope(void)
2840 if (current_config_kvi)
2841 return current_config_kvi->scope;
2842 else
2843 return current_parsing_scope;