commit: add repository argument to lookup_commit_graft
[git.git] / config.c
blob041db3ce7d43af6d9b216cb707bb8c2af41ca79e
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "config.h"
10 #include "repository.h"
11 #include "lockfile.h"
12 #include "exec_cmd.h"
13 #include "strbuf.h"
14 #include "quote.h"
15 #include "hashmap.h"
16 #include "string-list.h"
17 #include "object-store.h"
18 #include "utf8.h"
19 #include "dir.h"
21 struct config_source {
22 struct config_source *prev;
23 union {
24 FILE *file;
25 struct config_buf {
26 const char *buf;
27 size_t len;
28 size_t pos;
29 } buf;
30 } u;
31 enum config_origin_type origin_type;
32 const char *name;
33 const char *path;
34 int die_on_error;
35 int linenr;
36 int eof;
37 struct strbuf value;
38 struct strbuf var;
40 int (*do_fgetc)(struct config_source *c);
41 int (*do_ungetc)(int c, struct config_source *conf);
42 long (*do_ftell)(struct config_source *c);
46 * These variables record the "current" config source, which
47 * can be accessed by parsing callbacks.
49 * The "cf" variable will be non-NULL only when we are actually parsing a real
50 * config source (file, blob, cmdline, etc).
52 * The "current_config_kvi" variable will be non-NULL only when we are feeding
53 * cached config from a configset into a callback.
55 * They should generally never be non-NULL at the same time. If they are both
56 * NULL, then we aren't parsing anything (and depending on the function looking
57 * at the variables, it's either a bug for it to be called in the first place,
58 * or it's a function which can be reused for non-config purposes, and should
59 * fall back to some sane behavior).
61 static struct config_source *cf;
62 static struct key_value_info *current_config_kvi;
65 * Similar to the variables above, this gives access to the "scope" of the
66 * current value (repo, global, etc). For cached values, it can be found via
67 * the current_config_kvi as above. During parsing, the current value can be
68 * found in this variable. It's not part of "cf" because it transcends a single
69 * file (i.e., a file included from .git/config is still in "repo" scope).
71 static enum config_scope current_parsing_scope;
73 static int core_compression_seen;
74 static int pack_compression_seen;
75 static int zlib_compression_seen;
77 static int config_file_fgetc(struct config_source *conf)
79 return getc_unlocked(conf->u.file);
82 static int config_file_ungetc(int c, struct config_source *conf)
84 return ungetc(c, conf->u.file);
87 static long config_file_ftell(struct config_source *conf)
89 return ftell(conf->u.file);
93 static int config_buf_fgetc(struct config_source *conf)
95 if (conf->u.buf.pos < conf->u.buf.len)
96 return conf->u.buf.buf[conf->u.buf.pos++];
98 return EOF;
101 static int config_buf_ungetc(int c, struct config_source *conf)
103 if (conf->u.buf.pos > 0) {
104 conf->u.buf.pos--;
105 if (conf->u.buf.buf[conf->u.buf.pos] != c)
106 die("BUG: config_buf can only ungetc the same character");
107 return c;
110 return EOF;
113 static long config_buf_ftell(struct config_source *conf)
115 return conf->u.buf.pos;
118 #define MAX_INCLUDE_DEPTH 10
119 static const char include_depth_advice[] =
120 "exceeded maximum include depth (%d) while including\n"
121 " %s\n"
122 "from\n"
123 " %s\n"
124 "Do you have circular includes?";
125 static int handle_path_include(const char *path, struct config_include_data *inc)
127 int ret = 0;
128 struct strbuf buf = STRBUF_INIT;
129 char *expanded;
131 if (!path)
132 return config_error_nonbool("include.path");
134 expanded = expand_user_path(path, 0);
135 if (!expanded)
136 return error("could not expand include path '%s'", path);
137 path = expanded;
140 * Use an absolute path as-is, but interpret relative paths
141 * based on the including config file.
143 if (!is_absolute_path(path)) {
144 char *slash;
146 if (!cf || !cf->path)
147 return error("relative config includes must come from files");
149 slash = find_last_dir_sep(cf->path);
150 if (slash)
151 strbuf_add(&buf, cf->path, slash - cf->path + 1);
152 strbuf_addstr(&buf, path);
153 path = buf.buf;
156 if (!access_or_die(path, R_OK, 0)) {
157 if (++inc->depth > MAX_INCLUDE_DEPTH)
158 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
159 !cf ? "<unknown>" :
160 cf->name ? cf->name :
161 "the command line");
162 ret = git_config_from_file(git_config_include, path, inc);
163 inc->depth--;
165 strbuf_release(&buf);
166 free(expanded);
167 return ret;
170 static int prepare_include_condition_pattern(struct strbuf *pat)
172 struct strbuf path = STRBUF_INIT;
173 char *expanded;
174 int prefix = 0;
176 expanded = expand_user_path(pat->buf, 1);
177 if (expanded) {
178 strbuf_reset(pat);
179 strbuf_addstr(pat, expanded);
180 free(expanded);
183 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
184 const char *slash;
186 if (!cf || !cf->path)
187 return error(_("relative config include "
188 "conditionals must come from files"));
190 strbuf_realpath(&path, cf->path, 1);
191 slash = find_last_dir_sep(path.buf);
192 if (!slash)
193 die("BUG: how is this possible?");
194 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
195 prefix = slash - path.buf + 1 /* slash */;
196 } else if (!is_absolute_path(pat->buf))
197 strbuf_insert(pat, 0, "**/", 3);
199 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
200 strbuf_addstr(pat, "**");
202 strbuf_release(&path);
203 return prefix;
206 static int include_by_gitdir(const struct config_options *opts,
207 const char *cond, size_t cond_len, int icase)
209 struct strbuf text = STRBUF_INIT;
210 struct strbuf pattern = STRBUF_INIT;
211 int ret = 0, prefix;
212 const char *git_dir;
213 int already_tried_absolute = 0;
215 if (opts->git_dir)
216 git_dir = opts->git_dir;
217 else
218 goto done;
220 strbuf_realpath(&text, git_dir, 1);
221 strbuf_add(&pattern, cond, cond_len);
222 prefix = prepare_include_condition_pattern(&pattern);
224 again:
225 if (prefix < 0)
226 goto done;
228 if (prefix > 0) {
230 * perform literal matching on the prefix part so that
231 * any wildcard character in it can't create side effects.
233 if (text.len < prefix)
234 goto done;
235 if (!icase && strncmp(pattern.buf, text.buf, prefix))
236 goto done;
237 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
238 goto done;
241 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
242 icase ? WM_CASEFOLD : 0);
244 if (!ret && !already_tried_absolute) {
246 * We've tried e.g. matching gitdir:~/work, but if
247 * ~/work is a symlink to /mnt/storage/work
248 * strbuf_realpath() will expand it, so the rule won't
249 * match. Let's match against a
250 * strbuf_add_absolute_path() version of the path,
251 * which'll do the right thing
253 strbuf_reset(&text);
254 strbuf_add_absolute_path(&text, git_dir);
255 already_tried_absolute = 1;
256 goto again;
258 done:
259 strbuf_release(&pattern);
260 strbuf_release(&text);
261 return ret;
264 static int include_condition_is_true(const struct config_options *opts,
265 const char *cond, size_t cond_len)
268 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
269 return include_by_gitdir(opts, cond, cond_len, 0);
270 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
271 return include_by_gitdir(opts, cond, cond_len, 1);
273 /* unknown conditionals are always false */
274 return 0;
277 int git_config_include(const char *var, const char *value, void *data)
279 struct config_include_data *inc = data;
280 const char *cond, *key;
281 int cond_len;
282 int ret;
285 * Pass along all values, including "include" directives; this makes it
286 * possible to query information on the includes themselves.
288 ret = inc->fn(var, value, inc->data);
289 if (ret < 0)
290 return ret;
292 if (!strcmp(var, "include.path"))
293 ret = handle_path_include(value, inc);
295 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
296 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
297 !strcmp(key, "path"))
298 ret = handle_path_include(value, inc);
300 return ret;
303 void git_config_push_parameter(const char *text)
305 struct strbuf env = STRBUF_INIT;
306 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
307 if (old && *old) {
308 strbuf_addstr(&env, old);
309 strbuf_addch(&env, ' ');
311 sq_quote_buf(&env, text);
312 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
313 strbuf_release(&env);
316 static inline int iskeychar(int c)
318 return isalnum(c) || c == '-';
322 * Auxiliary function to sanity-check and split the key into the section
323 * identifier and variable name.
325 * Returns 0 on success, -1 when there is an invalid character in the key and
326 * -2 if there is no section name in the key.
328 * store_key - pointer to char* which will hold a copy of the key with
329 * lowercase section and variable name
330 * baselen - pointer to int which will hold the length of the
331 * section + subsection part, can be NULL
333 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
335 int i, dot, baselen;
336 const char *last_dot = strrchr(key, '.');
339 * Since "key" actually contains the section name and the real
340 * key name separated by a dot, we have to know where the dot is.
343 if (last_dot == NULL || last_dot == key) {
344 if (!quiet)
345 error("key does not contain a section: %s", key);
346 return -CONFIG_NO_SECTION_OR_NAME;
349 if (!last_dot[1]) {
350 if (!quiet)
351 error("key does not contain variable name: %s", key);
352 return -CONFIG_NO_SECTION_OR_NAME;
355 baselen = last_dot - key;
356 if (baselen_)
357 *baselen_ = baselen;
360 * Validate the key and while at it, lower case it for matching.
362 if (store_key)
363 *store_key = xmallocz(strlen(key));
365 dot = 0;
366 for (i = 0; key[i]; i++) {
367 unsigned char c = key[i];
368 if (c == '.')
369 dot = 1;
370 /* Leave the extended basename untouched.. */
371 if (!dot || i > baselen) {
372 if (!iskeychar(c) ||
373 (i == baselen + 1 && !isalpha(c))) {
374 if (!quiet)
375 error("invalid key: %s", key);
376 goto out_free_ret_1;
378 c = tolower(c);
379 } else if (c == '\n') {
380 if (!quiet)
381 error("invalid key (newline): %s", key);
382 goto out_free_ret_1;
384 if (store_key)
385 (*store_key)[i] = c;
388 return 0;
390 out_free_ret_1:
391 if (store_key) {
392 FREE_AND_NULL(*store_key);
394 return -CONFIG_INVALID_KEY;
397 int git_config_parse_key(const char *key, char **store_key, int *baselen)
399 return git_config_parse_key_1(key, store_key, baselen, 0);
402 int git_config_key_is_valid(const char *key)
404 return !git_config_parse_key_1(key, NULL, NULL, 1);
407 int git_config_parse_parameter(const char *text,
408 config_fn_t fn, void *data)
410 const char *value;
411 char *canonical_name;
412 struct strbuf **pair;
413 int ret;
415 pair = strbuf_split_str(text, '=', 2);
416 if (!pair[0])
417 return error("bogus config parameter: %s", text);
419 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
420 strbuf_setlen(pair[0], pair[0]->len - 1);
421 value = pair[1] ? pair[1]->buf : "";
422 } else {
423 value = NULL;
426 strbuf_trim(pair[0]);
427 if (!pair[0]->len) {
428 strbuf_list_free(pair);
429 return error("bogus config parameter: %s", text);
432 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
433 ret = -1;
434 } else {
435 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
436 free(canonical_name);
438 strbuf_list_free(pair);
439 return ret;
442 int git_config_from_parameters(config_fn_t fn, void *data)
444 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
445 int ret = 0;
446 char *envw;
447 const char **argv = NULL;
448 int nr = 0, alloc = 0;
449 int i;
450 struct config_source source;
452 if (!env)
453 return 0;
455 memset(&source, 0, sizeof(source));
456 source.prev = cf;
457 source.origin_type = CONFIG_ORIGIN_CMDLINE;
458 cf = &source;
460 /* sq_dequote will write over it */
461 envw = xstrdup(env);
463 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
464 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
465 goto out;
468 for (i = 0; i < nr; i++) {
469 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
470 ret = -1;
471 goto out;
475 out:
476 free(argv);
477 free(envw);
478 cf = source.prev;
479 return ret;
482 static int get_next_char(void)
484 int c = cf->do_fgetc(cf);
486 if (c == '\r') {
487 /* DOS like systems */
488 c = cf->do_fgetc(cf);
489 if (c != '\n') {
490 if (c != EOF)
491 cf->do_ungetc(c, cf);
492 c = '\r';
495 if (c == '\n')
496 cf->linenr++;
497 if (c == EOF) {
498 cf->eof = 1;
499 cf->linenr++;
500 c = '\n';
502 return c;
505 static char *parse_value(void)
507 int quote = 0, comment = 0, space = 0;
509 strbuf_reset(&cf->value);
510 for (;;) {
511 int c = get_next_char();
512 if (c == '\n') {
513 if (quote) {
514 cf->linenr--;
515 return NULL;
517 return cf->value.buf;
519 if (comment)
520 continue;
521 if (isspace(c) && !quote) {
522 if (cf->value.len)
523 space++;
524 continue;
526 if (!quote) {
527 if (c == ';' || c == '#') {
528 comment = 1;
529 continue;
532 for (; space; space--)
533 strbuf_addch(&cf->value, ' ');
534 if (c == '\\') {
535 c = get_next_char();
536 switch (c) {
537 case '\n':
538 continue;
539 case 't':
540 c = '\t';
541 break;
542 case 'b':
543 c = '\b';
544 break;
545 case 'n':
546 c = '\n';
547 break;
548 /* Some characters escape as themselves */
549 case '\\': case '"':
550 break;
551 /* Reject unknown escape sequences */
552 default:
553 return NULL;
555 strbuf_addch(&cf->value, c);
556 continue;
558 if (c == '"') {
559 quote = 1-quote;
560 continue;
562 strbuf_addch(&cf->value, c);
566 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
568 int c;
569 char *value;
570 int ret;
572 /* Get the full name */
573 for (;;) {
574 c = get_next_char();
575 if (cf->eof)
576 break;
577 if (!iskeychar(c))
578 break;
579 strbuf_addch(name, tolower(c));
582 while (c == ' ' || c == '\t')
583 c = get_next_char();
585 value = NULL;
586 if (c != '\n') {
587 if (c != '=')
588 return -1;
589 value = parse_value();
590 if (!value)
591 return -1;
594 * We already consumed the \n, but we need linenr to point to
595 * the line we just parsed during the call to fn to get
596 * accurate line number in error messages.
598 cf->linenr--;
599 ret = fn(name->buf, value, data);
600 if (ret >= 0)
601 cf->linenr++;
602 return ret;
605 static int get_extended_base_var(struct strbuf *name, int c)
607 do {
608 if (c == '\n')
609 goto error_incomplete_line;
610 c = get_next_char();
611 } while (isspace(c));
613 /* We require the format to be '[base "extension"]' */
614 if (c != '"')
615 return -1;
616 strbuf_addch(name, '.');
618 for (;;) {
619 int c = get_next_char();
620 if (c == '\n')
621 goto error_incomplete_line;
622 if (c == '"')
623 break;
624 if (c == '\\') {
625 c = get_next_char();
626 if (c == '\n')
627 goto error_incomplete_line;
629 strbuf_addch(name, c);
632 /* Final ']' */
633 if (get_next_char() != ']')
634 return -1;
635 return 0;
636 error_incomplete_line:
637 cf->linenr--;
638 return -1;
641 static int get_base_var(struct strbuf *name)
643 for (;;) {
644 int c = get_next_char();
645 if (cf->eof)
646 return -1;
647 if (c == ']')
648 return 0;
649 if (isspace(c))
650 return get_extended_base_var(name, c);
651 if (!iskeychar(c) && c != '.')
652 return -1;
653 strbuf_addch(name, tolower(c));
657 static int git_parse_source(config_fn_t fn, void *data)
659 int comment = 0;
660 int baselen = 0;
661 struct strbuf *var = &cf->var;
662 int error_return = 0;
663 char *error_msg = NULL;
665 /* U+FEFF Byte Order Mark in UTF8 */
666 const char *bomptr = utf8_bom;
668 for (;;) {
669 int c = get_next_char();
670 if (bomptr && *bomptr) {
671 /* We are at the file beginning; skip UTF8-encoded BOM
672 * if present. Sane editors won't put this in on their
673 * own, but e.g. Windows Notepad will do it happily. */
674 if (c == (*bomptr & 0377)) {
675 bomptr++;
676 continue;
677 } else {
678 /* Do not tolerate partial BOM. */
679 if (bomptr != utf8_bom)
680 break;
681 /* No BOM at file beginning. Cool. */
682 bomptr = NULL;
685 if (c == '\n') {
686 if (cf->eof)
687 return 0;
688 comment = 0;
689 continue;
691 if (comment || isspace(c))
692 continue;
693 if (c == '#' || c == ';') {
694 comment = 1;
695 continue;
697 if (c == '[') {
698 /* Reset prior to determining a new stem */
699 strbuf_reset(var);
700 if (get_base_var(var) < 0 || var->len < 1)
701 break;
702 strbuf_addch(var, '.');
703 baselen = var->len;
704 continue;
706 if (!isalpha(c))
707 break;
709 * Truncate the var name back to the section header
710 * stem prior to grabbing the suffix part of the name
711 * and the value.
713 strbuf_setlen(var, baselen);
714 strbuf_addch(var, tolower(c));
715 if (get_value(fn, data, var) < 0)
716 break;
719 switch (cf->origin_type) {
720 case CONFIG_ORIGIN_BLOB:
721 error_msg = xstrfmt(_("bad config line %d in blob %s"),
722 cf->linenr, cf->name);
723 break;
724 case CONFIG_ORIGIN_FILE:
725 error_msg = xstrfmt(_("bad config line %d in file %s"),
726 cf->linenr, cf->name);
727 break;
728 case CONFIG_ORIGIN_STDIN:
729 error_msg = xstrfmt(_("bad config line %d in standard input"),
730 cf->linenr);
731 break;
732 case CONFIG_ORIGIN_SUBMODULE_BLOB:
733 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
734 cf->linenr, cf->name);
735 break;
736 case CONFIG_ORIGIN_CMDLINE:
737 error_msg = xstrfmt(_("bad config line %d in command line %s"),
738 cf->linenr, cf->name);
739 break;
740 default:
741 error_msg = xstrfmt(_("bad config line %d in %s"),
742 cf->linenr, cf->name);
745 if (cf->die_on_error)
746 die("%s", error_msg);
747 else
748 error_return = error("%s", error_msg);
750 free(error_msg);
751 return error_return;
754 static int parse_unit_factor(const char *end, uintmax_t *val)
756 if (!*end)
757 return 1;
758 else if (!strcasecmp(end, "k")) {
759 *val *= 1024;
760 return 1;
762 else if (!strcasecmp(end, "m")) {
763 *val *= 1024 * 1024;
764 return 1;
766 else if (!strcasecmp(end, "g")) {
767 *val *= 1024 * 1024 * 1024;
768 return 1;
770 return 0;
773 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
775 if (value && *value) {
776 char *end;
777 intmax_t val;
778 uintmax_t uval;
779 uintmax_t factor = 1;
781 errno = 0;
782 val = strtoimax(value, &end, 0);
783 if (errno == ERANGE)
784 return 0;
785 if (!parse_unit_factor(end, &factor)) {
786 errno = EINVAL;
787 return 0;
789 uval = labs(val);
790 uval *= factor;
791 if (uval > max || labs(val) > uval) {
792 errno = ERANGE;
793 return 0;
795 val *= factor;
796 *ret = val;
797 return 1;
799 errno = EINVAL;
800 return 0;
803 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
805 if (value && *value) {
806 char *end;
807 uintmax_t val;
808 uintmax_t oldval;
810 errno = 0;
811 val = strtoumax(value, &end, 0);
812 if (errno == ERANGE)
813 return 0;
814 oldval = val;
815 if (!parse_unit_factor(end, &val)) {
816 errno = EINVAL;
817 return 0;
819 if (val > max || oldval > val) {
820 errno = ERANGE;
821 return 0;
823 *ret = val;
824 return 1;
826 errno = EINVAL;
827 return 0;
830 static int git_parse_int(const char *value, int *ret)
832 intmax_t tmp;
833 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
834 return 0;
835 *ret = tmp;
836 return 1;
839 static int git_parse_int64(const char *value, int64_t *ret)
841 intmax_t tmp;
842 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
843 return 0;
844 *ret = tmp;
845 return 1;
848 int git_parse_ulong(const char *value, unsigned long *ret)
850 uintmax_t tmp;
851 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
852 return 0;
853 *ret = tmp;
854 return 1;
857 static int git_parse_ssize_t(const char *value, ssize_t *ret)
859 intmax_t tmp;
860 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
861 return 0;
862 *ret = tmp;
863 return 1;
866 NORETURN
867 static void die_bad_number(const char *name, const char *value)
869 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
871 if (!value)
872 value = "";
874 if (!(cf && cf->name))
875 die(_("bad numeric config value '%s' for '%s': %s"),
876 value, name, error_type);
878 switch (cf->origin_type) {
879 case CONFIG_ORIGIN_BLOB:
880 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
881 value, name, cf->name, error_type);
882 case CONFIG_ORIGIN_FILE:
883 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
884 value, name, cf->name, error_type);
885 case CONFIG_ORIGIN_STDIN:
886 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
887 value, name, error_type);
888 case CONFIG_ORIGIN_SUBMODULE_BLOB:
889 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
890 value, name, cf->name, error_type);
891 case CONFIG_ORIGIN_CMDLINE:
892 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
893 value, name, cf->name, error_type);
894 default:
895 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
896 value, name, cf->name, error_type);
900 int git_config_int(const char *name, const char *value)
902 int ret;
903 if (!git_parse_int(value, &ret))
904 die_bad_number(name, value);
905 return ret;
908 int64_t git_config_int64(const char *name, const char *value)
910 int64_t ret;
911 if (!git_parse_int64(value, &ret))
912 die_bad_number(name, value);
913 return ret;
916 unsigned long git_config_ulong(const char *name, const char *value)
918 unsigned long ret;
919 if (!git_parse_ulong(value, &ret))
920 die_bad_number(name, value);
921 return ret;
924 ssize_t git_config_ssize_t(const char *name, const char *value)
926 ssize_t ret;
927 if (!git_parse_ssize_t(value, &ret))
928 die_bad_number(name, value);
929 return ret;
932 static int git_parse_maybe_bool_text(const char *value)
934 if (!value)
935 return 1;
936 if (!*value)
937 return 0;
938 if (!strcasecmp(value, "true")
939 || !strcasecmp(value, "yes")
940 || !strcasecmp(value, "on"))
941 return 1;
942 if (!strcasecmp(value, "false")
943 || !strcasecmp(value, "no")
944 || !strcasecmp(value, "off"))
945 return 0;
946 return -1;
949 int git_parse_maybe_bool(const char *value)
951 int v = git_parse_maybe_bool_text(value);
952 if (0 <= v)
953 return v;
954 if (git_parse_int(value, &v))
955 return !!v;
956 return -1;
959 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
961 int v = git_parse_maybe_bool_text(value);
962 if (0 <= v) {
963 *is_bool = 1;
964 return v;
966 *is_bool = 0;
967 return git_config_int(name, value);
970 int git_config_bool(const char *name, const char *value)
972 int discard;
973 return !!git_config_bool_or_int(name, value, &discard);
976 int git_config_string(const char **dest, const char *var, const char *value)
978 if (!value)
979 return config_error_nonbool(var);
980 *dest = xstrdup(value);
981 return 0;
984 int git_config_pathname(const char **dest, const char *var, const char *value)
986 if (!value)
987 return config_error_nonbool(var);
988 *dest = expand_user_path(value, 0);
989 if (!*dest)
990 die(_("failed to expand user dir in: '%s'"), value);
991 return 0;
994 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
996 if (!value)
997 return config_error_nonbool(var);
998 if (parse_expiry_date(value, timestamp))
999 return error(_("'%s' for '%s' is not a valid timestamp"),
1000 value, var);
1001 return 0;
1004 static int git_default_core_config(const char *var, const char *value)
1006 /* This needs a better name */
1007 if (!strcmp(var, "core.filemode")) {
1008 trust_executable_bit = git_config_bool(var, value);
1009 return 0;
1011 if (!strcmp(var, "core.trustctime")) {
1012 trust_ctime = git_config_bool(var, value);
1013 return 0;
1015 if (!strcmp(var, "core.checkstat")) {
1016 if (!strcasecmp(value, "default"))
1017 check_stat = 1;
1018 else if (!strcasecmp(value, "minimal"))
1019 check_stat = 0;
1022 if (!strcmp(var, "core.quotepath")) {
1023 quote_path_fully = git_config_bool(var, value);
1024 return 0;
1027 if (!strcmp(var, "core.symlinks")) {
1028 has_symlinks = git_config_bool(var, value);
1029 return 0;
1032 if (!strcmp(var, "core.ignorecase")) {
1033 ignore_case = git_config_bool(var, value);
1034 return 0;
1037 if (!strcmp(var, "core.attributesfile"))
1038 return git_config_pathname(&git_attributes_file, var, value);
1040 if (!strcmp(var, "core.hookspath"))
1041 return git_config_pathname(&git_hooks_path, var, value);
1043 if (!strcmp(var, "core.bare")) {
1044 is_bare_repository_cfg = git_config_bool(var, value);
1045 return 0;
1048 if (!strcmp(var, "core.ignorestat")) {
1049 assume_unchanged = git_config_bool(var, value);
1050 return 0;
1053 if (!strcmp(var, "core.prefersymlinkrefs")) {
1054 prefer_symlink_refs = git_config_bool(var, value);
1055 return 0;
1058 if (!strcmp(var, "core.logallrefupdates")) {
1059 if (value && !strcasecmp(value, "always"))
1060 log_all_ref_updates = LOG_REFS_ALWAYS;
1061 else if (git_config_bool(var, value))
1062 log_all_ref_updates = LOG_REFS_NORMAL;
1063 else
1064 log_all_ref_updates = LOG_REFS_NONE;
1065 return 0;
1068 if (!strcmp(var, "core.warnambiguousrefs")) {
1069 warn_ambiguous_refs = git_config_bool(var, value);
1070 return 0;
1073 if (!strcmp(var, "core.abbrev")) {
1074 if (!value)
1075 return config_error_nonbool(var);
1076 if (!strcasecmp(value, "auto"))
1077 default_abbrev = -1;
1078 else {
1079 int abbrev = git_config_int(var, value);
1080 if (abbrev < minimum_abbrev || abbrev > 40)
1081 return error("abbrev length out of range: %d", abbrev);
1082 default_abbrev = abbrev;
1084 return 0;
1087 if (!strcmp(var, "core.disambiguate"))
1088 return set_disambiguate_hint_config(var, value);
1090 if (!strcmp(var, "core.loosecompression")) {
1091 int level = git_config_int(var, value);
1092 if (level == -1)
1093 level = Z_DEFAULT_COMPRESSION;
1094 else if (level < 0 || level > Z_BEST_COMPRESSION)
1095 die(_("bad zlib compression level %d"), level);
1096 zlib_compression_level = level;
1097 zlib_compression_seen = 1;
1098 return 0;
1101 if (!strcmp(var, "core.compression")) {
1102 int level = git_config_int(var, value);
1103 if (level == -1)
1104 level = Z_DEFAULT_COMPRESSION;
1105 else if (level < 0 || level > Z_BEST_COMPRESSION)
1106 die(_("bad zlib compression level %d"), level);
1107 core_compression_level = level;
1108 core_compression_seen = 1;
1109 if (!zlib_compression_seen)
1110 zlib_compression_level = level;
1111 if (!pack_compression_seen)
1112 pack_compression_level = level;
1113 return 0;
1116 if (!strcmp(var, "core.packedgitwindowsize")) {
1117 int pgsz_x2 = getpagesize() * 2;
1118 packed_git_window_size = git_config_ulong(var, value);
1120 /* This value must be multiple of (pagesize * 2) */
1121 packed_git_window_size /= pgsz_x2;
1122 if (packed_git_window_size < 1)
1123 packed_git_window_size = 1;
1124 packed_git_window_size *= pgsz_x2;
1125 return 0;
1128 if (!strcmp(var, "core.bigfilethreshold")) {
1129 big_file_threshold = git_config_ulong(var, value);
1130 return 0;
1133 if (!strcmp(var, "core.packedgitlimit")) {
1134 packed_git_limit = git_config_ulong(var, value);
1135 return 0;
1138 if (!strcmp(var, "core.deltabasecachelimit")) {
1139 delta_base_cache_limit = git_config_ulong(var, value);
1140 return 0;
1143 if (!strcmp(var, "core.autocrlf")) {
1144 if (value && !strcasecmp(value, "input")) {
1145 auto_crlf = AUTO_CRLF_INPUT;
1146 return 0;
1148 auto_crlf = git_config_bool(var, value);
1149 return 0;
1152 if (!strcmp(var, "core.safecrlf")) {
1153 int eol_rndtrp_die;
1154 if (value && !strcasecmp(value, "warn")) {
1155 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1156 return 0;
1158 eol_rndtrp_die = git_config_bool(var, value);
1159 global_conv_flags_eol = eol_rndtrp_die ?
1160 CONV_EOL_RNDTRP_DIE : CONV_EOL_RNDTRP_WARN;
1161 return 0;
1164 if (!strcmp(var, "core.eol")) {
1165 if (value && !strcasecmp(value, "lf"))
1166 core_eol = EOL_LF;
1167 else if (value && !strcasecmp(value, "crlf"))
1168 core_eol = EOL_CRLF;
1169 else if (value && !strcasecmp(value, "native"))
1170 core_eol = EOL_NATIVE;
1171 else
1172 core_eol = EOL_UNSET;
1173 return 0;
1176 if (!strcmp(var, "core.notesref")) {
1177 notes_ref_name = xstrdup(value);
1178 return 0;
1181 if (!strcmp(var, "core.editor"))
1182 return git_config_string(&editor_program, var, value);
1184 if (!strcmp(var, "core.commentchar")) {
1185 if (!value)
1186 return config_error_nonbool(var);
1187 else if (!strcasecmp(value, "auto"))
1188 auto_comment_line_char = 1;
1189 else if (value[0] && !value[1]) {
1190 comment_line_char = value[0];
1191 auto_comment_line_char = 0;
1192 } else
1193 return error("core.commentChar should only be one character");
1194 return 0;
1197 if (!strcmp(var, "core.askpass"))
1198 return git_config_string(&askpass_program, var, value);
1200 if (!strcmp(var, "core.excludesfile"))
1201 return git_config_pathname(&excludes_file, var, value);
1203 if (!strcmp(var, "core.whitespace")) {
1204 if (!value)
1205 return config_error_nonbool(var);
1206 whitespace_rule_cfg = parse_whitespace_rule(value);
1207 return 0;
1210 if (!strcmp(var, "core.fsyncobjectfiles")) {
1211 fsync_object_files = git_config_bool(var, value);
1212 return 0;
1215 if (!strcmp(var, "core.preloadindex")) {
1216 core_preload_index = git_config_bool(var, value);
1217 return 0;
1220 if (!strcmp(var, "core.createobject")) {
1221 if (!strcmp(value, "rename"))
1222 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1223 else if (!strcmp(value, "link"))
1224 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1225 else
1226 die(_("invalid mode for object creation: %s"), value);
1227 return 0;
1230 if (!strcmp(var, "core.sparsecheckout")) {
1231 core_apply_sparse_checkout = git_config_bool(var, value);
1232 return 0;
1235 if (!strcmp(var, "core.precomposeunicode")) {
1236 precomposed_unicode = git_config_bool(var, value);
1237 return 0;
1240 if (!strcmp(var, "core.protecthfs")) {
1241 protect_hfs = git_config_bool(var, value);
1242 return 0;
1245 if (!strcmp(var, "core.protectntfs")) {
1246 protect_ntfs = git_config_bool(var, value);
1247 return 0;
1250 if (!strcmp(var, "core.hidedotfiles")) {
1251 if (value && !strcasecmp(value, "dotgitonly"))
1252 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1253 else
1254 hide_dotfiles = git_config_bool(var, value);
1255 return 0;
1258 if (!strcmp(var, "core.partialclonefilter")) {
1259 return git_config_string(&core_partial_clone_filter_default,
1260 var, value);
1263 /* Add other config variables here and to Documentation/config.txt. */
1264 return 0;
1267 static int git_default_i18n_config(const char *var, const char *value)
1269 if (!strcmp(var, "i18n.commitencoding"))
1270 return git_config_string(&git_commit_encoding, var, value);
1272 if (!strcmp(var, "i18n.logoutputencoding"))
1273 return git_config_string(&git_log_output_encoding, var, value);
1275 /* Add other config variables here and to Documentation/config.txt. */
1276 return 0;
1279 static int git_default_branch_config(const char *var, const char *value)
1281 if (!strcmp(var, "branch.autosetupmerge")) {
1282 if (value && !strcasecmp(value, "always")) {
1283 git_branch_track = BRANCH_TRACK_ALWAYS;
1284 return 0;
1286 git_branch_track = git_config_bool(var, value);
1287 return 0;
1289 if (!strcmp(var, "branch.autosetuprebase")) {
1290 if (!value)
1291 return config_error_nonbool(var);
1292 else if (!strcmp(value, "never"))
1293 autorebase = AUTOREBASE_NEVER;
1294 else if (!strcmp(value, "local"))
1295 autorebase = AUTOREBASE_LOCAL;
1296 else if (!strcmp(value, "remote"))
1297 autorebase = AUTOREBASE_REMOTE;
1298 else if (!strcmp(value, "always"))
1299 autorebase = AUTOREBASE_ALWAYS;
1300 else
1301 return error("malformed value for %s", var);
1302 return 0;
1305 /* Add other config variables here and to Documentation/config.txt. */
1306 return 0;
1309 static int git_default_push_config(const char *var, const char *value)
1311 if (!strcmp(var, "push.default")) {
1312 if (!value)
1313 return config_error_nonbool(var);
1314 else if (!strcmp(value, "nothing"))
1315 push_default = PUSH_DEFAULT_NOTHING;
1316 else if (!strcmp(value, "matching"))
1317 push_default = PUSH_DEFAULT_MATCHING;
1318 else if (!strcmp(value, "simple"))
1319 push_default = PUSH_DEFAULT_SIMPLE;
1320 else if (!strcmp(value, "upstream"))
1321 push_default = PUSH_DEFAULT_UPSTREAM;
1322 else if (!strcmp(value, "tracking")) /* deprecated */
1323 push_default = PUSH_DEFAULT_UPSTREAM;
1324 else if (!strcmp(value, "current"))
1325 push_default = PUSH_DEFAULT_CURRENT;
1326 else {
1327 error("malformed value for %s: %s", var, value);
1328 return error("Must be one of nothing, matching, simple, "
1329 "upstream or current.");
1331 return 0;
1334 /* Add other config variables here and to Documentation/config.txt. */
1335 return 0;
1338 static int git_default_mailmap_config(const char *var, const char *value)
1340 if (!strcmp(var, "mailmap.file"))
1341 return git_config_pathname(&git_mailmap_file, var, value);
1342 if (!strcmp(var, "mailmap.blob"))
1343 return git_config_string(&git_mailmap_blob, var, value);
1345 /* Add other config variables here and to Documentation/config.txt. */
1346 return 0;
1349 int git_default_config(const char *var, const char *value, void *dummy)
1351 if (starts_with(var, "core."))
1352 return git_default_core_config(var, value);
1354 if (starts_with(var, "user."))
1355 return git_ident_config(var, value, dummy);
1357 if (starts_with(var, "i18n."))
1358 return git_default_i18n_config(var, value);
1360 if (starts_with(var, "branch."))
1361 return git_default_branch_config(var, value);
1363 if (starts_with(var, "push."))
1364 return git_default_push_config(var, value);
1366 if (starts_with(var, "mailmap."))
1367 return git_default_mailmap_config(var, value);
1369 if (starts_with(var, "advice."))
1370 return git_default_advice_config(var, value);
1372 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1373 pager_use_color = git_config_bool(var,value);
1374 return 0;
1377 if (!strcmp(var, "pack.packsizelimit")) {
1378 pack_size_limit_cfg = git_config_ulong(var, value);
1379 return 0;
1382 if (!strcmp(var, "pack.compression")) {
1383 int level = git_config_int(var, value);
1384 if (level == -1)
1385 level = Z_DEFAULT_COMPRESSION;
1386 else if (level < 0 || level > Z_BEST_COMPRESSION)
1387 die(_("bad pack compression level %d"), level);
1388 pack_compression_level = level;
1389 pack_compression_seen = 1;
1390 return 0;
1393 /* Add other config variables here and to Documentation/config.txt. */
1394 return 0;
1398 * All source specific fields in the union, die_on_error, name and the callbacks
1399 * fgetc, ungetc, ftell of top need to be initialized before calling
1400 * this function.
1402 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1404 int ret;
1406 /* push config-file parsing state stack */
1407 top->prev = cf;
1408 top->linenr = 1;
1409 top->eof = 0;
1410 strbuf_init(&top->value, 1024);
1411 strbuf_init(&top->var, 1024);
1412 cf = top;
1414 ret = git_parse_source(fn, data);
1416 /* pop config-file parsing state stack */
1417 strbuf_release(&top->value);
1418 strbuf_release(&top->var);
1419 cf = top->prev;
1421 return ret;
1424 static int do_config_from_file(config_fn_t fn,
1425 const enum config_origin_type origin_type,
1426 const char *name, const char *path, FILE *f,
1427 void *data)
1429 struct config_source top;
1431 top.u.file = f;
1432 top.origin_type = origin_type;
1433 top.name = name;
1434 top.path = path;
1435 top.die_on_error = 1;
1436 top.do_fgetc = config_file_fgetc;
1437 top.do_ungetc = config_file_ungetc;
1438 top.do_ftell = config_file_ftell;
1440 return do_config_from(&top, fn, data);
1443 static int git_config_from_stdin(config_fn_t fn, void *data)
1445 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1448 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1450 int ret = -1;
1451 FILE *f;
1453 f = fopen_or_warn(filename, "r");
1454 if (f) {
1455 flockfile(f);
1456 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1457 funlockfile(f);
1458 fclose(f);
1460 return ret;
1463 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1464 const char *name, const char *buf, size_t len, void *data)
1466 struct config_source top;
1468 top.u.buf.buf = buf;
1469 top.u.buf.len = len;
1470 top.u.buf.pos = 0;
1471 top.origin_type = origin_type;
1472 top.name = name;
1473 top.path = NULL;
1474 top.die_on_error = 0;
1475 top.do_fgetc = config_buf_fgetc;
1476 top.do_ungetc = config_buf_ungetc;
1477 top.do_ftell = config_buf_ftell;
1479 return do_config_from(&top, fn, data);
1482 int git_config_from_blob_oid(config_fn_t fn,
1483 const char *name,
1484 const struct object_id *oid,
1485 void *data)
1487 enum object_type type;
1488 char *buf;
1489 unsigned long size;
1490 int ret;
1492 buf = read_object_file(oid, &type, &size);
1493 if (!buf)
1494 return error("unable to load config blob object '%s'", name);
1495 if (type != OBJ_BLOB) {
1496 free(buf);
1497 return error("reference '%s' does not point to a blob", name);
1500 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1501 free(buf);
1503 return ret;
1506 static int git_config_from_blob_ref(config_fn_t fn,
1507 const char *name,
1508 void *data)
1510 struct object_id oid;
1512 if (get_oid(name, &oid) < 0)
1513 return error("unable to resolve config blob '%s'", name);
1514 return git_config_from_blob_oid(fn, name, &oid, data);
1517 const char *git_etc_gitconfig(void)
1519 static const char *system_wide;
1520 if (!system_wide)
1521 system_wide = system_path(ETC_GITCONFIG);
1522 return system_wide;
1526 * Parse environment variable 'k' as a boolean (in various
1527 * possible spellings); if missing, use the default value 'def'.
1529 int git_env_bool(const char *k, int def)
1531 const char *v = getenv(k);
1532 return v ? git_config_bool(k, v) : def;
1536 * Parse environment variable 'k' as ulong with possibly a unit
1537 * suffix; if missing, use the default value 'val'.
1539 unsigned long git_env_ulong(const char *k, unsigned long val)
1541 const char *v = getenv(k);
1542 if (v && !git_parse_ulong(v, &val))
1543 die("failed to parse %s", k);
1544 return val;
1547 int git_config_system(void)
1549 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1552 static int do_git_config_sequence(const struct config_options *opts,
1553 config_fn_t fn, void *data)
1555 int ret = 0;
1556 char *xdg_config = xdg_config_home("config");
1557 char *user_config = expand_user_path("~/.gitconfig", 0);
1558 char *repo_config;
1560 if (opts->commondir)
1561 repo_config = mkpathdup("%s/config", opts->commondir);
1562 else
1563 repo_config = NULL;
1565 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1566 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1567 ret += git_config_from_file(fn, git_etc_gitconfig(),
1568 data);
1570 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1571 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1572 ret += git_config_from_file(fn, xdg_config, data);
1574 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1575 ret += git_config_from_file(fn, user_config, data);
1577 current_parsing_scope = CONFIG_SCOPE_REPO;
1578 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1579 ret += git_config_from_file(fn, repo_config, data);
1581 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1582 if (git_config_from_parameters(fn, data) < 0)
1583 die(_("unable to parse command-line config"));
1585 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1586 free(xdg_config);
1587 free(user_config);
1588 free(repo_config);
1589 return ret;
1592 int config_with_options(config_fn_t fn, void *data,
1593 struct git_config_source *config_source,
1594 const struct config_options *opts)
1596 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1598 if (opts->respect_includes) {
1599 inc.fn = fn;
1600 inc.data = data;
1601 inc.opts = opts;
1602 fn = git_config_include;
1603 data = &inc;
1607 * If we have a specific filename, use it. Otherwise, follow the
1608 * regular lookup sequence.
1610 if (config_source && config_source->use_stdin)
1611 return git_config_from_stdin(fn, data);
1612 else if (config_source && config_source->file)
1613 return git_config_from_file(fn, config_source->file, data);
1614 else if (config_source && config_source->blob)
1615 return git_config_from_blob_ref(fn, config_source->blob, data);
1617 return do_git_config_sequence(opts, fn, data);
1620 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1622 int i, value_index;
1623 struct string_list *values;
1624 struct config_set_element *entry;
1625 struct configset_list *list = &cs->list;
1627 for (i = 0; i < list->nr; i++) {
1628 entry = list->items[i].e;
1629 value_index = list->items[i].value_index;
1630 values = &entry->value_list;
1632 current_config_kvi = values->items[value_index].util;
1634 if (fn(entry->key, values->items[value_index].string, data) < 0)
1635 git_die_config_linenr(entry->key,
1636 current_config_kvi->filename,
1637 current_config_kvi->linenr);
1639 current_config_kvi = NULL;
1643 void read_early_config(config_fn_t cb, void *data)
1645 struct config_options opts = {0};
1646 struct strbuf commondir = STRBUF_INIT;
1647 struct strbuf gitdir = STRBUF_INIT;
1649 opts.respect_includes = 1;
1651 if (have_git_dir()) {
1652 opts.commondir = get_git_common_dir();
1653 opts.git_dir = get_git_dir();
1655 * When setup_git_directory() was not yet asked to discover the
1656 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1657 * is any repository config we should use (but unlike
1658 * setup_git_directory_gently(), no global state is changed, most
1659 * notably, the current working directory is still the same after the
1660 * call).
1662 } else if (!discover_git_directory(&commondir, &gitdir)) {
1663 opts.commondir = commondir.buf;
1664 opts.git_dir = gitdir.buf;
1667 config_with_options(cb, data, NULL, &opts);
1669 strbuf_release(&commondir);
1670 strbuf_release(&gitdir);
1673 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1675 struct config_set_element k;
1676 struct config_set_element *found_entry;
1677 char *normalized_key;
1679 * `key` may come from the user, so normalize it before using it
1680 * for querying entries from the hashmap.
1682 if (git_config_parse_key(key, &normalized_key, NULL))
1683 return NULL;
1685 hashmap_entry_init(&k, strhash(normalized_key));
1686 k.key = normalized_key;
1687 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1688 free(normalized_key);
1689 return found_entry;
1692 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1694 struct config_set_element *e;
1695 struct string_list_item *si;
1696 struct configset_list_item *l_item;
1697 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1699 e = configset_find_element(cs, key);
1701 * Since the keys are being fed by git_config*() callback mechanism, they
1702 * are already normalized. So simply add them without any further munging.
1704 if (!e) {
1705 e = xmalloc(sizeof(*e));
1706 hashmap_entry_init(e, strhash(key));
1707 e->key = xstrdup(key);
1708 string_list_init(&e->value_list, 1);
1709 hashmap_add(&cs->config_hash, e);
1711 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1713 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1714 l_item = &cs->list.items[cs->list.nr++];
1715 l_item->e = e;
1716 l_item->value_index = e->value_list.nr - 1;
1718 if (!cf)
1719 die("BUG: configset_add_value has no source");
1720 if (cf->name) {
1721 kv_info->filename = strintern(cf->name);
1722 kv_info->linenr = cf->linenr;
1723 kv_info->origin_type = cf->origin_type;
1724 } else {
1725 /* for values read from `git_config_from_parameters()` */
1726 kv_info->filename = NULL;
1727 kv_info->linenr = -1;
1728 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1730 kv_info->scope = current_parsing_scope;
1731 si->util = kv_info;
1733 return 0;
1736 static int config_set_element_cmp(const void *unused_cmp_data,
1737 const void *entry,
1738 const void *entry_or_key,
1739 const void *unused_keydata)
1741 const struct config_set_element *e1 = entry;
1742 const struct config_set_element *e2 = entry_or_key;
1744 return strcmp(e1->key, e2->key);
1747 void git_configset_init(struct config_set *cs)
1749 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1750 cs->hash_initialized = 1;
1751 cs->list.nr = 0;
1752 cs->list.alloc = 0;
1753 cs->list.items = NULL;
1756 void git_configset_clear(struct config_set *cs)
1758 struct config_set_element *entry;
1759 struct hashmap_iter iter;
1760 if (!cs->hash_initialized)
1761 return;
1763 hashmap_iter_init(&cs->config_hash, &iter);
1764 while ((entry = hashmap_iter_next(&iter))) {
1765 free(entry->key);
1766 string_list_clear(&entry->value_list, 1);
1768 hashmap_free(&cs->config_hash, 1);
1769 cs->hash_initialized = 0;
1770 free(cs->list.items);
1771 cs->list.nr = 0;
1772 cs->list.alloc = 0;
1773 cs->list.items = NULL;
1776 static int config_set_callback(const char *key, const char *value, void *cb)
1778 struct config_set *cs = cb;
1779 configset_add_value(cs, key, value);
1780 return 0;
1783 int git_configset_add_file(struct config_set *cs, const char *filename)
1785 return git_config_from_file(config_set_callback, filename, cs);
1788 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1790 const struct string_list *values = NULL;
1792 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1793 * queried key in the files of the configset, the value returned will be the last
1794 * value in the value list for that key.
1796 values = git_configset_get_value_multi(cs, key);
1798 if (!values)
1799 return 1;
1800 assert(values->nr > 0);
1801 *value = values->items[values->nr - 1].string;
1802 return 0;
1805 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1807 struct config_set_element *e = configset_find_element(cs, key);
1808 return e ? &e->value_list : NULL;
1811 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1813 const char *value;
1814 if (!git_configset_get_value(cs, key, &value))
1815 return git_config_string(dest, key, value);
1816 else
1817 return 1;
1820 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1822 return git_configset_get_string_const(cs, key, (const char **)dest);
1825 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1827 const char *value;
1828 if (!git_configset_get_value(cs, key, &value)) {
1829 *dest = git_config_int(key, value);
1830 return 0;
1831 } else
1832 return 1;
1835 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1837 const char *value;
1838 if (!git_configset_get_value(cs, key, &value)) {
1839 *dest = git_config_ulong(key, value);
1840 return 0;
1841 } else
1842 return 1;
1845 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1847 const char *value;
1848 if (!git_configset_get_value(cs, key, &value)) {
1849 *dest = git_config_bool(key, value);
1850 return 0;
1851 } else
1852 return 1;
1855 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1856 int *is_bool, int *dest)
1858 const char *value;
1859 if (!git_configset_get_value(cs, key, &value)) {
1860 *dest = git_config_bool_or_int(key, value, is_bool);
1861 return 0;
1862 } else
1863 return 1;
1866 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1868 const char *value;
1869 if (!git_configset_get_value(cs, key, &value)) {
1870 *dest = git_parse_maybe_bool(value);
1871 if (*dest == -1)
1872 return -1;
1873 return 0;
1874 } else
1875 return 1;
1878 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1880 const char *value;
1881 if (!git_configset_get_value(cs, key, &value))
1882 return git_config_pathname(dest, key, value);
1883 else
1884 return 1;
1887 /* Functions use to read configuration from a repository */
1888 static void repo_read_config(struct repository *repo)
1890 struct config_options opts;
1892 opts.respect_includes = 1;
1893 opts.commondir = repo->commondir;
1894 opts.git_dir = repo->gitdir;
1896 if (!repo->config)
1897 repo->config = xcalloc(1, sizeof(struct config_set));
1898 else
1899 git_configset_clear(repo->config);
1901 git_configset_init(repo->config);
1903 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
1905 * config_with_options() normally returns only
1906 * zero, as most errors are fatal, and
1907 * non-fatal potential errors are guarded by "if"
1908 * statements that are entered only when no error is
1909 * possible.
1911 * If we ever encounter a non-fatal error, it means
1912 * something went really wrong and we should stop
1913 * immediately.
1915 die(_("unknown error occurred while reading the configuration files"));
1918 static void git_config_check_init(struct repository *repo)
1920 if (repo->config && repo->config->hash_initialized)
1921 return;
1922 repo_read_config(repo);
1925 static void repo_config_clear(struct repository *repo)
1927 if (!repo->config || !repo->config->hash_initialized)
1928 return;
1929 git_configset_clear(repo->config);
1932 void repo_config(struct repository *repo, config_fn_t fn, void *data)
1934 git_config_check_init(repo);
1935 configset_iter(repo->config, fn, data);
1938 int repo_config_get_value(struct repository *repo,
1939 const char *key, const char **value)
1941 git_config_check_init(repo);
1942 return git_configset_get_value(repo->config, key, value);
1945 const struct string_list *repo_config_get_value_multi(struct repository *repo,
1946 const char *key)
1948 git_config_check_init(repo);
1949 return git_configset_get_value_multi(repo->config, key);
1952 int repo_config_get_string_const(struct repository *repo,
1953 const char *key, const char **dest)
1955 int ret;
1956 git_config_check_init(repo);
1957 ret = git_configset_get_string_const(repo->config, key, dest);
1958 if (ret < 0)
1959 git_die_config(key, NULL);
1960 return ret;
1963 int repo_config_get_string(struct repository *repo,
1964 const char *key, char **dest)
1966 git_config_check_init(repo);
1967 return repo_config_get_string_const(repo, key, (const char **)dest);
1970 int repo_config_get_int(struct repository *repo,
1971 const char *key, int *dest)
1973 git_config_check_init(repo);
1974 return git_configset_get_int(repo->config, key, dest);
1977 int repo_config_get_ulong(struct repository *repo,
1978 const char *key, unsigned long *dest)
1980 git_config_check_init(repo);
1981 return git_configset_get_ulong(repo->config, key, dest);
1984 int repo_config_get_bool(struct repository *repo,
1985 const char *key, int *dest)
1987 git_config_check_init(repo);
1988 return git_configset_get_bool(repo->config, key, dest);
1991 int repo_config_get_bool_or_int(struct repository *repo,
1992 const char *key, int *is_bool, int *dest)
1994 git_config_check_init(repo);
1995 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
1998 int repo_config_get_maybe_bool(struct repository *repo,
1999 const char *key, int *dest)
2001 git_config_check_init(repo);
2002 return git_configset_get_maybe_bool(repo->config, key, dest);
2005 int repo_config_get_pathname(struct repository *repo,
2006 const char *key, const char **dest)
2008 int ret;
2009 git_config_check_init(repo);
2010 ret = git_configset_get_pathname(repo->config, key, dest);
2011 if (ret < 0)
2012 git_die_config(key, NULL);
2013 return ret;
2016 /* Functions used historically to read configuration from 'the_repository' */
2017 void git_config(config_fn_t fn, void *data)
2019 repo_config(the_repository, fn, data);
2022 void git_config_clear(void)
2024 repo_config_clear(the_repository);
2027 int git_config_get_value(const char *key, const char **value)
2029 return repo_config_get_value(the_repository, key, value);
2032 const struct string_list *git_config_get_value_multi(const char *key)
2034 return repo_config_get_value_multi(the_repository, key);
2037 int git_config_get_string_const(const char *key, const char **dest)
2039 return repo_config_get_string_const(the_repository, key, dest);
2042 int git_config_get_string(const char *key, char **dest)
2044 return repo_config_get_string(the_repository, key, dest);
2047 int git_config_get_int(const char *key, int *dest)
2049 return repo_config_get_int(the_repository, key, dest);
2052 int git_config_get_ulong(const char *key, unsigned long *dest)
2054 return repo_config_get_ulong(the_repository, key, dest);
2057 int git_config_get_bool(const char *key, int *dest)
2059 return repo_config_get_bool(the_repository, key, dest);
2062 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2064 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2067 int git_config_get_maybe_bool(const char *key, int *dest)
2069 return repo_config_get_maybe_bool(the_repository, key, dest);
2072 int git_config_get_pathname(const char *key, const char **dest)
2074 return repo_config_get_pathname(the_repository, key, dest);
2078 * Note: This function exists solely to maintain backward compatibility with
2079 * 'fetch' and 'update_clone' storing configuration in '.gitmodules' and should
2080 * NOT be used anywhere else.
2082 * Runs the provided config function on the '.gitmodules' file found in the
2083 * working directory.
2085 void config_from_gitmodules(config_fn_t fn, void *data)
2087 if (the_repository->worktree) {
2088 char *file = repo_worktree_path(the_repository, GITMODULES_FILE);
2089 git_config_from_file(fn, file, data);
2090 free(file);
2094 int git_config_get_expiry(const char *key, const char **output)
2096 int ret = git_config_get_string_const(key, output);
2097 if (ret)
2098 return ret;
2099 if (strcmp(*output, "now")) {
2100 timestamp_t now = approxidate("now");
2101 if (approxidate(*output) >= now)
2102 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2104 return ret;
2107 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2109 char *expiry_string;
2110 intmax_t days;
2111 timestamp_t when;
2113 if (git_config_get_string(key, &expiry_string))
2114 return 1; /* no such thing */
2116 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2117 const int scale = 86400;
2118 *expiry = now - days * scale;
2119 return 0;
2122 if (!parse_expiry_date(expiry_string, &when)) {
2123 *expiry = when;
2124 return 0;
2126 return -1; /* thing exists but cannot be parsed */
2129 int git_config_get_untracked_cache(void)
2131 int val = -1;
2132 const char *v;
2134 /* Hack for test programs like test-dump-untracked-cache */
2135 if (ignore_untracked_cache_config)
2136 return -1;
2138 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2139 return val;
2141 if (!git_config_get_value("core.untrackedcache", &v)) {
2142 if (!strcasecmp(v, "keep"))
2143 return -1;
2145 error(_("unknown core.untrackedCache value '%s'; "
2146 "using 'keep' default value"), v);
2147 return -1;
2150 return -1; /* default value */
2153 int git_config_get_split_index(void)
2155 int val;
2157 if (!git_config_get_maybe_bool("core.splitindex", &val))
2158 return val;
2160 return -1; /* default value */
2163 int git_config_get_max_percent_split_change(void)
2165 int val = -1;
2167 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2168 if (0 <= val && val <= 100)
2169 return val;
2171 return error(_("splitIndex.maxPercentChange value '%d' "
2172 "should be between 0 and 100"), val);
2175 return -1; /* default value */
2178 int git_config_get_fsmonitor(void)
2180 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2181 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2183 if (core_fsmonitor && !*core_fsmonitor)
2184 core_fsmonitor = NULL;
2186 if (core_fsmonitor)
2187 return 1;
2189 return 0;
2192 NORETURN
2193 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2195 if (!filename)
2196 die(_("unable to parse '%s' from command-line config"), key);
2197 else
2198 die(_("bad config variable '%s' in file '%s' at line %d"),
2199 key, filename, linenr);
2202 NORETURN __attribute__((format(printf, 2, 3)))
2203 void git_die_config(const char *key, const char *err, ...)
2205 const struct string_list *values;
2206 struct key_value_info *kv_info;
2208 if (err) {
2209 va_list params;
2210 va_start(params, err);
2211 vreportf("error: ", err, params);
2212 va_end(params);
2214 values = git_config_get_value_multi(key);
2215 kv_info = values->items[values->nr - 1].util;
2216 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2220 * Find all the stuff for git_config_set() below.
2223 static struct {
2224 int baselen;
2225 char *key;
2226 int do_not_match;
2227 regex_t *value_regex;
2228 int multi_replace;
2229 size_t *offset;
2230 unsigned int offset_alloc;
2231 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2232 unsigned int seen;
2233 } store;
2235 static int matches(const char *key, const char *value)
2237 if (strcmp(key, store.key))
2238 return 0; /* not ours */
2239 if (!store.value_regex)
2240 return 1; /* always matches */
2241 if (store.value_regex == CONFIG_REGEX_NONE)
2242 return 0; /* never matches */
2244 return store.do_not_match ^
2245 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2248 static int store_aux(const char *key, const char *value, void *cb)
2250 const char *ep;
2251 size_t section_len;
2253 switch (store.state) {
2254 case KEY_SEEN:
2255 if (matches(key, value)) {
2256 if (store.seen == 1 && store.multi_replace == 0) {
2257 warning(_("%s has multiple values"), key);
2260 ALLOC_GROW(store.offset, store.seen + 1,
2261 store.offset_alloc);
2263 store.offset[store.seen] = cf->do_ftell(cf);
2264 store.seen++;
2266 break;
2267 case SECTION_SEEN:
2269 * What we are looking for is in store.key (both
2270 * section and var), and its section part is baselen
2271 * long. We found key (again, both section and var).
2272 * We would want to know if this key is in the same
2273 * section as what we are looking for. We already
2274 * know we are in the same section as what should
2275 * hold store.key.
2277 ep = strrchr(key, '.');
2278 section_len = ep - key;
2280 if ((section_len != store.baselen) ||
2281 memcmp(key, store.key, section_len+1)) {
2282 store.state = SECTION_END_SEEN;
2283 break;
2287 * Do not increment matches: this is no match, but we
2288 * just made sure we are in the desired section.
2290 ALLOC_GROW(store.offset, store.seen + 1,
2291 store.offset_alloc);
2292 store.offset[store.seen] = cf->do_ftell(cf);
2293 /* fallthru */
2294 case SECTION_END_SEEN:
2295 case START:
2296 if (matches(key, value)) {
2297 ALLOC_GROW(store.offset, store.seen + 1,
2298 store.offset_alloc);
2299 store.offset[store.seen] = cf->do_ftell(cf);
2300 store.state = KEY_SEEN;
2301 store.seen++;
2302 } else {
2303 if (strrchr(key, '.') - key == store.baselen &&
2304 !strncmp(key, store.key, store.baselen)) {
2305 store.state = SECTION_SEEN;
2306 ALLOC_GROW(store.offset,
2307 store.seen + 1,
2308 store.offset_alloc);
2309 store.offset[store.seen] = cf->do_ftell(cf);
2313 return 0;
2316 static int write_error(const char *filename)
2318 error("failed to write new configuration file %s", filename);
2320 /* Same error code as "failed to rename". */
2321 return 4;
2324 static struct strbuf store_create_section(const char *key)
2326 const char *dot;
2327 int i;
2328 struct strbuf sb = STRBUF_INIT;
2330 dot = memchr(key, '.', store.baselen);
2331 if (dot) {
2332 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2333 for (i = dot - key + 1; i < store.baselen; i++) {
2334 if (key[i] == '"' || key[i] == '\\')
2335 strbuf_addch(&sb, '\\');
2336 strbuf_addch(&sb, key[i]);
2338 strbuf_addstr(&sb, "\"]\n");
2339 } else {
2340 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2343 return sb;
2346 static ssize_t write_section(int fd, const char *key)
2348 struct strbuf sb = store_create_section(key);
2349 ssize_t ret;
2351 ret = write_in_full(fd, sb.buf, sb.len);
2352 strbuf_release(&sb);
2354 return ret;
2357 static ssize_t write_pair(int fd, const char *key, const char *value)
2359 int i;
2360 ssize_t ret;
2361 int length = strlen(key + store.baselen + 1);
2362 const char *quote = "";
2363 struct strbuf sb = STRBUF_INIT;
2366 * Check to see if the value needs to be surrounded with a dq pair.
2367 * Note that problematic characters are always backslash-quoted; this
2368 * check is about not losing leading or trailing SP and strings that
2369 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2370 * configuration parser.
2372 if (value[0] == ' ')
2373 quote = "\"";
2374 for (i = 0; value[i]; i++)
2375 if (value[i] == ';' || value[i] == '#')
2376 quote = "\"";
2377 if (i && value[i - 1] == ' ')
2378 quote = "\"";
2380 strbuf_addf(&sb, "\t%.*s = %s",
2381 length, key + store.baselen + 1, quote);
2383 for (i = 0; value[i]; i++)
2384 switch (value[i]) {
2385 case '\n':
2386 strbuf_addstr(&sb, "\\n");
2387 break;
2388 case '\t':
2389 strbuf_addstr(&sb, "\\t");
2390 break;
2391 case '"':
2392 case '\\':
2393 strbuf_addch(&sb, '\\');
2394 /* fallthrough */
2395 default:
2396 strbuf_addch(&sb, value[i]);
2397 break;
2399 strbuf_addf(&sb, "%s\n", quote);
2401 ret = write_in_full(fd, sb.buf, sb.len);
2402 strbuf_release(&sb);
2404 return ret;
2407 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2408 size_t offset_, int *found_bracket)
2410 size_t equal_offset = size, bracket_offset = size;
2411 ssize_t offset;
2413 contline:
2414 for (offset = offset_-2; offset > 0
2415 && contents[offset] != '\n'; offset--)
2416 switch (contents[offset]) {
2417 case '=': equal_offset = offset; break;
2418 case ']': bracket_offset = offset; break;
2420 if (offset > 0 && contents[offset-1] == '\\') {
2421 offset_ = offset;
2422 goto contline;
2424 if (bracket_offset < equal_offset) {
2425 *found_bracket = 1;
2426 offset = bracket_offset+1;
2427 } else
2428 offset++;
2430 return offset;
2433 int git_config_set_in_file_gently(const char *config_filename,
2434 const char *key, const char *value)
2436 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2439 void git_config_set_in_file(const char *config_filename,
2440 const char *key, const char *value)
2442 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2445 int git_config_set_gently(const char *key, const char *value)
2447 return git_config_set_multivar_gently(key, value, NULL, 0);
2450 void git_config_set(const char *key, const char *value)
2452 git_config_set_multivar(key, value, NULL, 0);
2456 * If value==NULL, unset in (remove from) config,
2457 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2458 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2459 * (only add a new one)
2460 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2461 * else all matching key/values (regardless how many) are removed,
2462 * before the new pair is written.
2464 * Returns 0 on success.
2466 * This function does this:
2468 * - it locks the config file by creating ".git/config.lock"
2470 * - it then parses the config using store_aux() as validator to find
2471 * the position on the key/value pair to replace. If it is to be unset,
2472 * it must be found exactly once.
2474 * - the config file is mmap()ed and the part before the match (if any) is
2475 * written to the lock file, then the changed part and the rest.
2477 * - the config file is removed and the lock file rename()d to it.
2480 int git_config_set_multivar_in_file_gently(const char *config_filename,
2481 const char *key, const char *value,
2482 const char *value_regex,
2483 int multi_replace)
2485 int fd = -1, in_fd = -1;
2486 int ret;
2487 struct lock_file lock = LOCK_INIT;
2488 char *filename_buf = NULL;
2489 char *contents = NULL;
2490 size_t contents_sz;
2492 /* parse-key returns negative; flip the sign to feed exit(3) */
2493 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2494 if (ret)
2495 goto out_free;
2497 store.multi_replace = multi_replace;
2499 if (!config_filename)
2500 config_filename = filename_buf = git_pathdup("config");
2503 * The lock serves a purpose in addition to locking: the new
2504 * contents of .git/config will be written into it.
2506 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2507 if (fd < 0) {
2508 error_errno("could not lock config file %s", config_filename);
2509 free(store.key);
2510 ret = CONFIG_NO_LOCK;
2511 goto out_free;
2515 * If .git/config does not exist yet, write a minimal version.
2517 in_fd = open(config_filename, O_RDONLY);
2518 if ( in_fd < 0 ) {
2519 free(store.key);
2521 if ( ENOENT != errno ) {
2522 error_errno("opening %s", config_filename);
2523 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2524 goto out_free;
2526 /* if nothing to unset, error out */
2527 if (value == NULL) {
2528 ret = CONFIG_NOTHING_SET;
2529 goto out_free;
2532 store.key = (char *)key;
2533 if (write_section(fd, key) < 0 ||
2534 write_pair(fd, key, value) < 0)
2535 goto write_err_out;
2536 } else {
2537 struct stat st;
2538 size_t copy_begin, copy_end;
2539 int i, new_line = 0;
2541 if (value_regex == NULL)
2542 store.value_regex = NULL;
2543 else if (value_regex == CONFIG_REGEX_NONE)
2544 store.value_regex = CONFIG_REGEX_NONE;
2545 else {
2546 if (value_regex[0] == '!') {
2547 store.do_not_match = 1;
2548 value_regex++;
2549 } else
2550 store.do_not_match = 0;
2552 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2553 if (regcomp(store.value_regex, value_regex,
2554 REG_EXTENDED)) {
2555 error("invalid pattern: %s", value_regex);
2556 free(store.value_regex);
2557 ret = CONFIG_INVALID_PATTERN;
2558 goto out_free;
2562 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2563 store.offset[0] = 0;
2564 store.state = START;
2565 store.seen = 0;
2568 * After this, store.offset will contain the *end* offset
2569 * of the last match, or remain at 0 if no match was found.
2570 * As a side effect, we make sure to transform only a valid
2571 * existing config file.
2573 if (git_config_from_file(store_aux, config_filename, NULL)) {
2574 error("invalid config file %s", config_filename);
2575 free(store.key);
2576 if (store.value_regex != NULL &&
2577 store.value_regex != CONFIG_REGEX_NONE) {
2578 regfree(store.value_regex);
2579 free(store.value_regex);
2581 ret = CONFIG_INVALID_FILE;
2582 goto out_free;
2585 free(store.key);
2586 if (store.value_regex != NULL &&
2587 store.value_regex != CONFIG_REGEX_NONE) {
2588 regfree(store.value_regex);
2589 free(store.value_regex);
2592 /* if nothing to unset, or too many matches, error out */
2593 if ((store.seen == 0 && value == NULL) ||
2594 (store.seen > 1 && multi_replace == 0)) {
2595 ret = CONFIG_NOTHING_SET;
2596 goto out_free;
2599 if (fstat(in_fd, &st) == -1) {
2600 error_errno(_("fstat on %s failed"), config_filename);
2601 ret = CONFIG_INVALID_FILE;
2602 goto out_free;
2605 contents_sz = xsize_t(st.st_size);
2606 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2607 MAP_PRIVATE, in_fd, 0);
2608 if (contents == MAP_FAILED) {
2609 if (errno == ENODEV && S_ISDIR(st.st_mode))
2610 errno = EISDIR;
2611 error_errno("unable to mmap '%s'", config_filename);
2612 ret = CONFIG_INVALID_FILE;
2613 contents = NULL;
2614 goto out_free;
2616 close(in_fd);
2617 in_fd = -1;
2619 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2620 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2621 ret = CONFIG_NO_WRITE;
2622 goto out_free;
2625 if (store.seen == 0)
2626 store.seen = 1;
2628 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2629 if (store.offset[i] == 0) {
2630 store.offset[i] = copy_end = contents_sz;
2631 } else if (store.state != KEY_SEEN) {
2632 copy_end = store.offset[i];
2633 } else
2634 copy_end = find_beginning_of_line(
2635 contents, contents_sz,
2636 store.offset[i]-2, &new_line);
2638 if (copy_end > 0 && contents[copy_end-1] != '\n')
2639 new_line = 1;
2641 /* write the first part of the config */
2642 if (copy_end > copy_begin) {
2643 if (write_in_full(fd, contents + copy_begin,
2644 copy_end - copy_begin) < 0)
2645 goto write_err_out;
2646 if (new_line &&
2647 write_str_in_full(fd, "\n") < 0)
2648 goto write_err_out;
2650 copy_begin = store.offset[i];
2653 /* write the pair (value == NULL means unset) */
2654 if (value != NULL) {
2655 if (store.state == START) {
2656 if (write_section(fd, key) < 0)
2657 goto write_err_out;
2659 if (write_pair(fd, key, value) < 0)
2660 goto write_err_out;
2663 /* write the rest of the config */
2664 if (copy_begin < contents_sz)
2665 if (write_in_full(fd, contents + copy_begin,
2666 contents_sz - copy_begin) < 0)
2667 goto write_err_out;
2669 munmap(contents, contents_sz);
2670 contents = NULL;
2673 if (commit_lock_file(&lock) < 0) {
2674 error_errno("could not write config file %s", config_filename);
2675 ret = CONFIG_NO_WRITE;
2676 goto out_free;
2679 ret = 0;
2681 /* Invalidate the config cache */
2682 git_config_clear();
2684 out_free:
2685 rollback_lock_file(&lock);
2686 free(filename_buf);
2687 if (contents)
2688 munmap(contents, contents_sz);
2689 if (in_fd >= 0)
2690 close(in_fd);
2691 return ret;
2693 write_err_out:
2694 ret = write_error(get_lock_file_path(&lock));
2695 goto out_free;
2699 void git_config_set_multivar_in_file(const char *config_filename,
2700 const char *key, const char *value,
2701 const char *value_regex, int multi_replace)
2703 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2704 value_regex, multi_replace))
2705 return;
2706 if (value)
2707 die(_("could not set '%s' to '%s'"), key, value);
2708 else
2709 die(_("could not unset '%s'"), key);
2712 int git_config_set_multivar_gently(const char *key, const char *value,
2713 const char *value_regex, int multi_replace)
2715 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2716 multi_replace);
2719 void git_config_set_multivar(const char *key, const char *value,
2720 const char *value_regex, int multi_replace)
2722 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2723 multi_replace);
2726 static int section_name_match (const char *buf, const char *name)
2728 int i = 0, j = 0, dot = 0;
2729 if (buf[i] != '[')
2730 return 0;
2731 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2732 if (!dot && isspace(buf[i])) {
2733 dot = 1;
2734 if (name[j++] != '.')
2735 break;
2736 for (i++; isspace(buf[i]); i++)
2737 ; /* do nothing */
2738 if (buf[i] != '"')
2739 break;
2740 continue;
2742 if (buf[i] == '\\' && dot)
2743 i++;
2744 else if (buf[i] == '"' && dot) {
2745 for (i++; isspace(buf[i]); i++)
2746 ; /* do_nothing */
2747 break;
2749 if (buf[i] != name[j++])
2750 break;
2752 if (buf[i] == ']' && name[j] == 0) {
2754 * We match, now just find the right length offset by
2755 * gobbling up any whitespace after it, as well
2757 i++;
2758 for (; buf[i] && isspace(buf[i]); i++)
2759 ; /* do nothing */
2760 return i;
2762 return 0;
2765 static int section_name_is_ok(const char *name)
2767 /* Empty section names are bogus. */
2768 if (!*name)
2769 return 0;
2772 * Before a dot, we must be alphanumeric or dash. After the first dot,
2773 * anything goes, so we can stop checking.
2775 for (; *name && *name != '.'; name++)
2776 if (*name != '-' && !isalnum(*name))
2777 return 0;
2778 return 1;
2781 /* if new_name == NULL, the section is removed instead */
2782 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
2783 const char *old_name, const char *new_name, int copy)
2785 int ret = 0, remove = 0;
2786 char *filename_buf = NULL;
2787 struct lock_file lock = LOCK_INIT;
2788 int out_fd;
2789 char buf[1024];
2790 FILE *config_file = NULL;
2791 struct stat st;
2792 struct strbuf copystr = STRBUF_INIT;
2794 if (new_name && !section_name_is_ok(new_name)) {
2795 ret = error("invalid section name: %s", new_name);
2796 goto out_no_rollback;
2799 if (!config_filename)
2800 config_filename = filename_buf = git_pathdup("config");
2802 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
2803 if (out_fd < 0) {
2804 ret = error("could not lock config file %s", config_filename);
2805 goto out;
2808 if (!(config_file = fopen(config_filename, "rb"))) {
2809 ret = warn_on_fopen_errors(config_filename);
2810 if (ret)
2811 goto out;
2812 /* no config file means nothing to rename, no error */
2813 goto commit_and_out;
2816 if (fstat(fileno(config_file), &st) == -1) {
2817 ret = error_errno(_("fstat on %s failed"), config_filename);
2818 goto out;
2821 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2822 ret = error_errno("chmod on %s failed",
2823 get_lock_file_path(&lock));
2824 goto out;
2827 while (fgets(buf, sizeof(buf), config_file)) {
2828 int i;
2829 int length;
2830 int is_section = 0;
2831 char *output = buf;
2832 for (i = 0; buf[i] && isspace(buf[i]); i++)
2833 ; /* do nothing */
2834 if (buf[i] == '[') {
2835 /* it's a section */
2836 int offset;
2837 is_section = 1;
2840 * When encountering a new section under -c we
2841 * need to flush out any section we're already
2842 * coping and begin anew. There might be
2843 * multiple [branch "$name"] sections.
2845 if (copystr.len > 0) {
2846 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
2847 ret = write_error(get_lock_file_path(&lock));
2848 goto out;
2850 strbuf_reset(&copystr);
2853 offset = section_name_match(&buf[i], old_name);
2854 if (offset > 0) {
2855 ret++;
2856 if (new_name == NULL) {
2857 remove = 1;
2858 continue;
2860 store.baselen = strlen(new_name);
2861 if (!copy) {
2862 if (write_section(out_fd, new_name) < 0) {
2863 ret = write_error(get_lock_file_path(&lock));
2864 goto out;
2867 * We wrote out the new section, with
2868 * a newline, now skip the old
2869 * section's length
2871 output += offset + i;
2872 if (strlen(output) > 0) {
2874 * More content means there's
2875 * a declaration to put on the
2876 * next line; indent with a
2877 * tab
2879 output -= 1;
2880 output[0] = '\t';
2882 } else {
2883 copystr = store_create_section(new_name);
2886 remove = 0;
2888 if (remove)
2889 continue;
2890 length = strlen(output);
2892 if (!is_section && copystr.len > 0) {
2893 strbuf_add(&copystr, output, length);
2896 if (write_in_full(out_fd, output, length) < 0) {
2897 ret = write_error(get_lock_file_path(&lock));
2898 goto out;
2903 * Copy a trailing section at the end of the config, won't be
2904 * flushed by the usual "flush because we have a new section
2905 * logic in the loop above.
2907 if (copystr.len > 0) {
2908 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
2909 ret = write_error(get_lock_file_path(&lock));
2910 goto out;
2912 strbuf_reset(&copystr);
2915 fclose(config_file);
2916 config_file = NULL;
2917 commit_and_out:
2918 if (commit_lock_file(&lock) < 0)
2919 ret = error_errno("could not write config file %s",
2920 config_filename);
2921 out:
2922 if (config_file)
2923 fclose(config_file);
2924 rollback_lock_file(&lock);
2925 out_no_rollback:
2926 free(filename_buf);
2927 return ret;
2930 int git_config_rename_section_in_file(const char *config_filename,
2931 const char *old_name, const char *new_name)
2933 return git_config_copy_or_rename_section_in_file(config_filename,
2934 old_name, new_name, 0);
2937 int git_config_rename_section(const char *old_name, const char *new_name)
2939 return git_config_rename_section_in_file(NULL, old_name, new_name);
2942 int git_config_copy_section_in_file(const char *config_filename,
2943 const char *old_name, const char *new_name)
2945 return git_config_copy_or_rename_section_in_file(config_filename,
2946 old_name, new_name, 1);
2949 int git_config_copy_section(const char *old_name, const char *new_name)
2951 return git_config_copy_section_in_file(NULL, old_name, new_name);
2955 * Call this to report error for your variable that should not
2956 * get a boolean value (i.e. "[my] var" means "true").
2958 #undef config_error_nonbool
2959 int config_error_nonbool(const char *var)
2961 return error("missing value for '%s'", var);
2964 int parse_config_key(const char *var,
2965 const char *section,
2966 const char **subsection, int *subsection_len,
2967 const char **key)
2969 const char *dot;
2971 /* Does it start with "section." ? */
2972 if (!skip_prefix(var, section, &var) || *var != '.')
2973 return -1;
2976 * Find the key; we don't know yet if we have a subsection, but we must
2977 * parse backwards from the end, since the subsection may have dots in
2978 * it, too.
2980 dot = strrchr(var, '.');
2981 *key = dot + 1;
2983 /* Did we have a subsection at all? */
2984 if (dot == var) {
2985 if (subsection) {
2986 *subsection = NULL;
2987 *subsection_len = 0;
2990 else {
2991 if (!subsection)
2992 return -1;
2993 *subsection = var + 1;
2994 *subsection_len = dot - *subsection;
2997 return 0;
3000 const char *current_config_origin_type(void)
3002 int type;
3003 if (current_config_kvi)
3004 type = current_config_kvi->origin_type;
3005 else if(cf)
3006 type = cf->origin_type;
3007 else
3008 die("BUG: current_config_origin_type called outside config callback");
3010 switch (type) {
3011 case CONFIG_ORIGIN_BLOB:
3012 return "blob";
3013 case CONFIG_ORIGIN_FILE:
3014 return "file";
3015 case CONFIG_ORIGIN_STDIN:
3016 return "standard input";
3017 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3018 return "submodule-blob";
3019 case CONFIG_ORIGIN_CMDLINE:
3020 return "command line";
3021 default:
3022 die("BUG: unknown config origin type");
3026 const char *current_config_name(void)
3028 const char *name;
3029 if (current_config_kvi)
3030 name = current_config_kvi->filename;
3031 else if (cf)
3032 name = cf->name;
3033 else
3034 die("BUG: current_config_name called outside config callback");
3035 return name ? name : "";
3038 enum config_scope current_config_scope(void)
3040 if (current_config_kvi)
3041 return current_config_kvi->scope;
3042 else
3043 return current_parsing_scope;