config: add options parameter to git_config_from_mem
[git.git] / config.c
blob60132e3774c281a9ccaa483122d614d3fe4e1460
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "config.h"
10 #include "repository.h"
11 #include "lockfile.h"
12 #include "exec-cmd.h"
13 #include "strbuf.h"
14 #include "quote.h"
15 #include "hashmap.h"
16 #include "string-list.h"
17 #include "utf8.h"
18 #include "dir.h"
19 #include "color.h"
21 struct config_source {
22 struct config_source *prev;
23 union {
24 FILE *file;
25 struct config_buf {
26 const char *buf;
27 size_t len;
28 size_t pos;
29 } buf;
30 } u;
31 enum config_origin_type origin_type;
32 const char *name;
33 const char *path;
34 enum config_error_action default_error_action;
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 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 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 struct parse_event_data {
658 enum config_event_t previous_type;
659 size_t previous_offset;
660 const struct config_options *opts;
663 static int do_event(enum config_event_t type, struct parse_event_data *data)
665 size_t offset;
667 if (!data->opts || !data->opts->event_fn)
668 return 0;
670 if (type == CONFIG_EVENT_WHITESPACE &&
671 data->previous_type == type)
672 return 0;
674 offset = cf->do_ftell(cf);
676 * At EOF, the parser always "inserts" an extra '\n', therefore
677 * the end offset of the event is the current file position, otherwise
678 * we will already have advanced to the next event.
680 if (type != CONFIG_EVENT_EOF)
681 offset--;
683 if (data->previous_type != CONFIG_EVENT_EOF &&
684 data->opts->event_fn(data->previous_type, data->previous_offset,
685 offset, data->opts->event_fn_data) < 0)
686 return -1;
688 data->previous_type = type;
689 data->previous_offset = offset;
691 return 0;
694 static int git_parse_source(config_fn_t fn, void *data,
695 const struct config_options *opts)
697 int comment = 0;
698 int baselen = 0;
699 struct strbuf *var = &cf->var;
700 int error_return = 0;
701 char *error_msg = NULL;
703 /* U+FEFF Byte Order Mark in UTF8 */
704 const char *bomptr = utf8_bom;
706 /* For the parser event callback */
707 struct parse_event_data event_data = {
708 CONFIG_EVENT_EOF, 0, opts
711 for (;;) {
712 int c;
714 c = get_next_char();
715 if (bomptr && *bomptr) {
716 /* We are at the file beginning; skip UTF8-encoded BOM
717 * if present. Sane editors won't put this in on their
718 * own, but e.g. Windows Notepad will do it happily. */
719 if (c == (*bomptr & 0377)) {
720 bomptr++;
721 continue;
722 } else {
723 /* Do not tolerate partial BOM. */
724 if (bomptr != utf8_bom)
725 break;
726 /* No BOM at file beginning. Cool. */
727 bomptr = NULL;
730 if (c == '\n') {
731 if (cf->eof) {
732 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
733 return -1;
734 return 0;
736 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
737 return -1;
738 comment = 0;
739 continue;
741 if (comment)
742 continue;
743 if (isspace(c)) {
744 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
745 return -1;
746 continue;
748 if (c == '#' || c == ';') {
749 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
750 return -1;
751 comment = 1;
752 continue;
754 if (c == '[') {
755 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
756 return -1;
758 /* Reset prior to determining a new stem */
759 strbuf_reset(var);
760 if (get_base_var(var) < 0 || var->len < 1)
761 break;
762 strbuf_addch(var, '.');
763 baselen = var->len;
764 continue;
766 if (!isalpha(c))
767 break;
769 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
770 return -1;
773 * Truncate the var name back to the section header
774 * stem prior to grabbing the suffix part of the name
775 * and the value.
777 strbuf_setlen(var, baselen);
778 strbuf_addch(var, tolower(c));
779 if (get_value(fn, data, var) < 0)
780 break;
783 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
784 return -1;
786 switch (cf->origin_type) {
787 case CONFIG_ORIGIN_BLOB:
788 error_msg = xstrfmt(_("bad config line %d in blob %s"),
789 cf->linenr, cf->name);
790 break;
791 case CONFIG_ORIGIN_FILE:
792 error_msg = xstrfmt(_("bad config line %d in file %s"),
793 cf->linenr, cf->name);
794 break;
795 case CONFIG_ORIGIN_STDIN:
796 error_msg = xstrfmt(_("bad config line %d in standard input"),
797 cf->linenr);
798 break;
799 case CONFIG_ORIGIN_SUBMODULE_BLOB:
800 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
801 cf->linenr, cf->name);
802 break;
803 case CONFIG_ORIGIN_CMDLINE:
804 error_msg = xstrfmt(_("bad config line %d in command line %s"),
805 cf->linenr, cf->name);
806 break;
807 default:
808 error_msg = xstrfmt(_("bad config line %d in %s"),
809 cf->linenr, cf->name);
812 switch (opts && opts->error_action ?
813 opts->error_action :
814 cf->default_error_action) {
815 case CONFIG_ERROR_DIE:
816 die("%s", error_msg);
817 break;
818 case CONFIG_ERROR_ERROR:
819 error_return = error("%s", error_msg);
820 break;
821 case CONFIG_ERROR_SILENT:
822 error_return = -1;
823 break;
824 case CONFIG_ERROR_UNSET:
825 BUG("config error action unset");
828 free(error_msg);
829 return error_return;
832 static int parse_unit_factor(const char *end, uintmax_t *val)
834 if (!*end)
835 return 1;
836 else if (!strcasecmp(end, "k")) {
837 *val *= 1024;
838 return 1;
840 else if (!strcasecmp(end, "m")) {
841 *val *= 1024 * 1024;
842 return 1;
844 else if (!strcasecmp(end, "g")) {
845 *val *= 1024 * 1024 * 1024;
846 return 1;
848 return 0;
851 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
853 if (value && *value) {
854 char *end;
855 intmax_t val;
856 uintmax_t uval;
857 uintmax_t factor = 1;
859 errno = 0;
860 val = strtoimax(value, &end, 0);
861 if (errno == ERANGE)
862 return 0;
863 if (!parse_unit_factor(end, &factor)) {
864 errno = EINVAL;
865 return 0;
867 uval = labs(val);
868 uval *= factor;
869 if (uval > max || labs(val) > uval) {
870 errno = ERANGE;
871 return 0;
873 val *= factor;
874 *ret = val;
875 return 1;
877 errno = EINVAL;
878 return 0;
881 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
883 if (value && *value) {
884 char *end;
885 uintmax_t val;
886 uintmax_t oldval;
888 errno = 0;
889 val = strtoumax(value, &end, 0);
890 if (errno == ERANGE)
891 return 0;
892 oldval = val;
893 if (!parse_unit_factor(end, &val)) {
894 errno = EINVAL;
895 return 0;
897 if (val > max || oldval > val) {
898 errno = ERANGE;
899 return 0;
901 *ret = val;
902 return 1;
904 errno = EINVAL;
905 return 0;
908 static int git_parse_int(const char *value, int *ret)
910 intmax_t tmp;
911 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
912 return 0;
913 *ret = tmp;
914 return 1;
917 static int git_parse_int64(const char *value, int64_t *ret)
919 intmax_t tmp;
920 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
921 return 0;
922 *ret = tmp;
923 return 1;
926 int git_parse_ulong(const char *value, unsigned long *ret)
928 uintmax_t tmp;
929 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
930 return 0;
931 *ret = tmp;
932 return 1;
935 static int git_parse_ssize_t(const char *value, ssize_t *ret)
937 intmax_t tmp;
938 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
939 return 0;
940 *ret = tmp;
941 return 1;
944 NORETURN
945 static void die_bad_number(const char *name, const char *value)
947 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
949 if (!value)
950 value = "";
952 if (!(cf && cf->name))
953 die(_("bad numeric config value '%s' for '%s': %s"),
954 value, name, error_type);
956 switch (cf->origin_type) {
957 case CONFIG_ORIGIN_BLOB:
958 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
959 value, name, cf->name, error_type);
960 case CONFIG_ORIGIN_FILE:
961 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
962 value, name, cf->name, error_type);
963 case CONFIG_ORIGIN_STDIN:
964 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
965 value, name, error_type);
966 case CONFIG_ORIGIN_SUBMODULE_BLOB:
967 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
968 value, name, cf->name, error_type);
969 case CONFIG_ORIGIN_CMDLINE:
970 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
971 value, name, cf->name, error_type);
972 default:
973 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
974 value, name, cf->name, error_type);
978 int git_config_int(const char *name, const char *value)
980 int ret;
981 if (!git_parse_int(value, &ret))
982 die_bad_number(name, value);
983 return ret;
986 int64_t git_config_int64(const char *name, const char *value)
988 int64_t ret;
989 if (!git_parse_int64(value, &ret))
990 die_bad_number(name, value);
991 return ret;
994 unsigned long git_config_ulong(const char *name, const char *value)
996 unsigned long ret;
997 if (!git_parse_ulong(value, &ret))
998 die_bad_number(name, value);
999 return ret;
1002 ssize_t git_config_ssize_t(const char *name, const char *value)
1004 ssize_t ret;
1005 if (!git_parse_ssize_t(value, &ret))
1006 die_bad_number(name, value);
1007 return ret;
1010 static int git_parse_maybe_bool_text(const char *value)
1012 if (!value)
1013 return 1;
1014 if (!*value)
1015 return 0;
1016 if (!strcasecmp(value, "true")
1017 || !strcasecmp(value, "yes")
1018 || !strcasecmp(value, "on"))
1019 return 1;
1020 if (!strcasecmp(value, "false")
1021 || !strcasecmp(value, "no")
1022 || !strcasecmp(value, "off"))
1023 return 0;
1024 return -1;
1027 int git_parse_maybe_bool(const char *value)
1029 int v = git_parse_maybe_bool_text(value);
1030 if (0 <= v)
1031 return v;
1032 if (git_parse_int(value, &v))
1033 return !!v;
1034 return -1;
1037 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1039 int v = git_parse_maybe_bool_text(value);
1040 if (0 <= v) {
1041 *is_bool = 1;
1042 return v;
1044 *is_bool = 0;
1045 return git_config_int(name, value);
1048 int git_config_bool(const char *name, const char *value)
1050 int discard;
1051 return !!git_config_bool_or_int(name, value, &discard);
1054 int git_config_string(const char **dest, const char *var, const char *value)
1056 if (!value)
1057 return config_error_nonbool(var);
1058 *dest = xstrdup(value);
1059 return 0;
1062 int git_config_pathname(const char **dest, const char *var, const char *value)
1064 if (!value)
1065 return config_error_nonbool(var);
1066 *dest = expand_user_path(value, 0);
1067 if (!*dest)
1068 die(_("failed to expand user dir in: '%s'"), value);
1069 return 0;
1072 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1074 if (!value)
1075 return config_error_nonbool(var);
1076 if (parse_expiry_date(value, timestamp))
1077 return error(_("'%s' for '%s' is not a valid timestamp"),
1078 value, var);
1079 return 0;
1082 int git_config_color(char *dest, const char *var, const char *value)
1084 if (!value)
1085 return config_error_nonbool(var);
1086 if (color_parse(value, dest) < 0)
1087 return -1;
1088 return 0;
1091 static int git_default_core_config(const char *var, const char *value)
1093 /* This needs a better name */
1094 if (!strcmp(var, "core.filemode")) {
1095 trust_executable_bit = git_config_bool(var, value);
1096 return 0;
1098 if (!strcmp(var, "core.trustctime")) {
1099 trust_ctime = git_config_bool(var, value);
1100 return 0;
1102 if (!strcmp(var, "core.checkstat")) {
1103 if (!strcasecmp(value, "default"))
1104 check_stat = 1;
1105 else if (!strcasecmp(value, "minimal"))
1106 check_stat = 0;
1109 if (!strcmp(var, "core.quotepath")) {
1110 quote_path_fully = git_config_bool(var, value);
1111 return 0;
1114 if (!strcmp(var, "core.symlinks")) {
1115 has_symlinks = git_config_bool(var, value);
1116 return 0;
1119 if (!strcmp(var, "core.ignorecase")) {
1120 ignore_case = git_config_bool(var, value);
1121 return 0;
1124 if (!strcmp(var, "core.attributesfile"))
1125 return git_config_pathname(&git_attributes_file, var, value);
1127 if (!strcmp(var, "core.hookspath"))
1128 return git_config_pathname(&git_hooks_path, var, value);
1130 if (!strcmp(var, "core.bare")) {
1131 is_bare_repository_cfg = git_config_bool(var, value);
1132 return 0;
1135 if (!strcmp(var, "core.ignorestat")) {
1136 assume_unchanged = git_config_bool(var, value);
1137 return 0;
1140 if (!strcmp(var, "core.prefersymlinkrefs")) {
1141 prefer_symlink_refs = git_config_bool(var, value);
1142 return 0;
1145 if (!strcmp(var, "core.logallrefupdates")) {
1146 if (value && !strcasecmp(value, "always"))
1147 log_all_ref_updates = LOG_REFS_ALWAYS;
1148 else if (git_config_bool(var, value))
1149 log_all_ref_updates = LOG_REFS_NORMAL;
1150 else
1151 log_all_ref_updates = LOG_REFS_NONE;
1152 return 0;
1155 if (!strcmp(var, "core.warnambiguousrefs")) {
1156 warn_ambiguous_refs = git_config_bool(var, value);
1157 return 0;
1160 if (!strcmp(var, "core.abbrev")) {
1161 if (!value)
1162 return config_error_nonbool(var);
1163 if (!strcasecmp(value, "auto"))
1164 default_abbrev = -1;
1165 else {
1166 int abbrev = git_config_int(var, value);
1167 if (abbrev < minimum_abbrev || abbrev > 40)
1168 return error("abbrev length out of range: %d", abbrev);
1169 default_abbrev = abbrev;
1171 return 0;
1174 if (!strcmp(var, "core.disambiguate"))
1175 return set_disambiguate_hint_config(var, value);
1177 if (!strcmp(var, "core.loosecompression")) {
1178 int level = git_config_int(var, value);
1179 if (level == -1)
1180 level = Z_DEFAULT_COMPRESSION;
1181 else if (level < 0 || level > Z_BEST_COMPRESSION)
1182 die(_("bad zlib compression level %d"), level);
1183 zlib_compression_level = level;
1184 zlib_compression_seen = 1;
1185 return 0;
1188 if (!strcmp(var, "core.compression")) {
1189 int level = git_config_int(var, value);
1190 if (level == -1)
1191 level = Z_DEFAULT_COMPRESSION;
1192 else if (level < 0 || level > Z_BEST_COMPRESSION)
1193 die(_("bad zlib compression level %d"), level);
1194 core_compression_level = level;
1195 core_compression_seen = 1;
1196 if (!zlib_compression_seen)
1197 zlib_compression_level = level;
1198 if (!pack_compression_seen)
1199 pack_compression_level = level;
1200 return 0;
1203 if (!strcmp(var, "core.packedgitwindowsize")) {
1204 int pgsz_x2 = getpagesize() * 2;
1205 packed_git_window_size = git_config_ulong(var, value);
1207 /* This value must be multiple of (pagesize * 2) */
1208 packed_git_window_size /= pgsz_x2;
1209 if (packed_git_window_size < 1)
1210 packed_git_window_size = 1;
1211 packed_git_window_size *= pgsz_x2;
1212 return 0;
1215 if (!strcmp(var, "core.bigfilethreshold")) {
1216 big_file_threshold = git_config_ulong(var, value);
1217 return 0;
1220 if (!strcmp(var, "core.packedgitlimit")) {
1221 packed_git_limit = git_config_ulong(var, value);
1222 return 0;
1225 if (!strcmp(var, "core.deltabasecachelimit")) {
1226 delta_base_cache_limit = git_config_ulong(var, value);
1227 return 0;
1230 if (!strcmp(var, "core.autocrlf")) {
1231 if (value && !strcasecmp(value, "input")) {
1232 auto_crlf = AUTO_CRLF_INPUT;
1233 return 0;
1235 auto_crlf = git_config_bool(var, value);
1236 return 0;
1239 if (!strcmp(var, "core.safecrlf")) {
1240 int eol_rndtrp_die;
1241 if (value && !strcasecmp(value, "warn")) {
1242 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1243 return 0;
1245 eol_rndtrp_die = git_config_bool(var, value);
1246 global_conv_flags_eol = eol_rndtrp_die ?
1247 CONV_EOL_RNDTRP_DIE : 0;
1248 return 0;
1251 if (!strcmp(var, "core.eol")) {
1252 if (value && !strcasecmp(value, "lf"))
1253 core_eol = EOL_LF;
1254 else if (value && !strcasecmp(value, "crlf"))
1255 core_eol = EOL_CRLF;
1256 else if (value && !strcasecmp(value, "native"))
1257 core_eol = EOL_NATIVE;
1258 else
1259 core_eol = EOL_UNSET;
1260 return 0;
1263 if (!strcmp(var, "core.checkroundtripencoding")) {
1264 check_roundtrip_encoding = xstrdup(value);
1265 return 0;
1268 if (!strcmp(var, "core.notesref")) {
1269 notes_ref_name = xstrdup(value);
1270 return 0;
1273 if (!strcmp(var, "core.editor"))
1274 return git_config_string(&editor_program, var, value);
1276 if (!strcmp(var, "core.commentchar")) {
1277 if (!value)
1278 return config_error_nonbool(var);
1279 else if (!strcasecmp(value, "auto"))
1280 auto_comment_line_char = 1;
1281 else if (value[0] && !value[1]) {
1282 comment_line_char = value[0];
1283 auto_comment_line_char = 0;
1284 } else
1285 return error("core.commentChar should only be one character");
1286 return 0;
1289 if (!strcmp(var, "core.askpass"))
1290 return git_config_string(&askpass_program, var, value);
1292 if (!strcmp(var, "core.excludesfile"))
1293 return git_config_pathname(&excludes_file, var, value);
1295 if (!strcmp(var, "core.whitespace")) {
1296 if (!value)
1297 return config_error_nonbool(var);
1298 whitespace_rule_cfg = parse_whitespace_rule(value);
1299 return 0;
1302 if (!strcmp(var, "core.fsyncobjectfiles")) {
1303 fsync_object_files = git_config_bool(var, value);
1304 return 0;
1307 if (!strcmp(var, "core.preloadindex")) {
1308 core_preload_index = git_config_bool(var, value);
1309 return 0;
1312 if (!strcmp(var, "core.createobject")) {
1313 if (!strcmp(value, "rename"))
1314 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1315 else if (!strcmp(value, "link"))
1316 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1317 else
1318 die(_("invalid mode for object creation: %s"), value);
1319 return 0;
1322 if (!strcmp(var, "core.commitgraph")) {
1323 core_commit_graph = git_config_bool(var, value);
1324 return 0;
1327 if (!strcmp(var, "core.sparsecheckout")) {
1328 core_apply_sparse_checkout = git_config_bool(var, value);
1329 return 0;
1332 if (!strcmp(var, "core.precomposeunicode")) {
1333 precomposed_unicode = git_config_bool(var, value);
1334 return 0;
1337 if (!strcmp(var, "core.protecthfs")) {
1338 protect_hfs = git_config_bool(var, value);
1339 return 0;
1342 if (!strcmp(var, "core.protectntfs")) {
1343 protect_ntfs = git_config_bool(var, value);
1344 return 0;
1347 if (!strcmp(var, "core.hidedotfiles")) {
1348 if (value && !strcasecmp(value, "dotgitonly"))
1349 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1350 else
1351 hide_dotfiles = git_config_bool(var, value);
1352 return 0;
1355 if (!strcmp(var, "core.partialclonefilter")) {
1356 return git_config_string(&core_partial_clone_filter_default,
1357 var, value);
1360 /* Add other config variables here and to Documentation/config.txt. */
1361 return 0;
1364 static int git_default_i18n_config(const char *var, const char *value)
1366 if (!strcmp(var, "i18n.commitencoding"))
1367 return git_config_string(&git_commit_encoding, var, value);
1369 if (!strcmp(var, "i18n.logoutputencoding"))
1370 return git_config_string(&git_log_output_encoding, var, value);
1372 /* Add other config variables here and to Documentation/config.txt. */
1373 return 0;
1376 static int git_default_branch_config(const char *var, const char *value)
1378 if (!strcmp(var, "branch.autosetupmerge")) {
1379 if (value && !strcasecmp(value, "always")) {
1380 git_branch_track = BRANCH_TRACK_ALWAYS;
1381 return 0;
1383 git_branch_track = git_config_bool(var, value);
1384 return 0;
1386 if (!strcmp(var, "branch.autosetuprebase")) {
1387 if (!value)
1388 return config_error_nonbool(var);
1389 else if (!strcmp(value, "never"))
1390 autorebase = AUTOREBASE_NEVER;
1391 else if (!strcmp(value, "local"))
1392 autorebase = AUTOREBASE_LOCAL;
1393 else if (!strcmp(value, "remote"))
1394 autorebase = AUTOREBASE_REMOTE;
1395 else if (!strcmp(value, "always"))
1396 autorebase = AUTOREBASE_ALWAYS;
1397 else
1398 return error("malformed value for %s", var);
1399 return 0;
1402 /* Add other config variables here and to Documentation/config.txt. */
1403 return 0;
1406 static int git_default_push_config(const char *var, const char *value)
1408 if (!strcmp(var, "push.default")) {
1409 if (!value)
1410 return config_error_nonbool(var);
1411 else if (!strcmp(value, "nothing"))
1412 push_default = PUSH_DEFAULT_NOTHING;
1413 else if (!strcmp(value, "matching"))
1414 push_default = PUSH_DEFAULT_MATCHING;
1415 else if (!strcmp(value, "simple"))
1416 push_default = PUSH_DEFAULT_SIMPLE;
1417 else if (!strcmp(value, "upstream"))
1418 push_default = PUSH_DEFAULT_UPSTREAM;
1419 else if (!strcmp(value, "tracking")) /* deprecated */
1420 push_default = PUSH_DEFAULT_UPSTREAM;
1421 else if (!strcmp(value, "current"))
1422 push_default = PUSH_DEFAULT_CURRENT;
1423 else {
1424 error("malformed value for %s: %s", var, value);
1425 return error("Must be one of nothing, matching, simple, "
1426 "upstream or current.");
1428 return 0;
1431 /* Add other config variables here and to Documentation/config.txt. */
1432 return 0;
1435 static int git_default_mailmap_config(const char *var, const char *value)
1437 if (!strcmp(var, "mailmap.file"))
1438 return git_config_pathname(&git_mailmap_file, var, value);
1439 if (!strcmp(var, "mailmap.blob"))
1440 return git_config_string(&git_mailmap_blob, var, value);
1442 /* Add other config variables here and to Documentation/config.txt. */
1443 return 0;
1446 int git_default_config(const char *var, const char *value, void *dummy)
1448 if (starts_with(var, "core."))
1449 return git_default_core_config(var, value);
1451 if (starts_with(var, "user."))
1452 return git_ident_config(var, value, dummy);
1454 if (starts_with(var, "i18n."))
1455 return git_default_i18n_config(var, value);
1457 if (starts_with(var, "branch."))
1458 return git_default_branch_config(var, value);
1460 if (starts_with(var, "push."))
1461 return git_default_push_config(var, value);
1463 if (starts_with(var, "mailmap."))
1464 return git_default_mailmap_config(var, value);
1466 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1467 return git_default_advice_config(var, value);
1469 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1470 pager_use_color = git_config_bool(var,value);
1471 return 0;
1474 if (!strcmp(var, "pack.packsizelimit")) {
1475 pack_size_limit_cfg = git_config_ulong(var, value);
1476 return 0;
1479 if (!strcmp(var, "pack.compression")) {
1480 int level = git_config_int(var, value);
1481 if (level == -1)
1482 level = Z_DEFAULT_COMPRESSION;
1483 else if (level < 0 || level > Z_BEST_COMPRESSION)
1484 die(_("bad pack compression level %d"), level);
1485 pack_compression_level = level;
1486 pack_compression_seen = 1;
1487 return 0;
1490 /* Add other config variables here and to Documentation/config.txt. */
1491 return 0;
1495 * All source specific fields in the union, die_on_error, name and the callbacks
1496 * fgetc, ungetc, ftell of top need to be initialized before calling
1497 * this function.
1499 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1500 const struct config_options *opts)
1502 int ret;
1504 /* push config-file parsing state stack */
1505 top->prev = cf;
1506 top->linenr = 1;
1507 top->eof = 0;
1508 strbuf_init(&top->value, 1024);
1509 strbuf_init(&top->var, 1024);
1510 cf = top;
1512 ret = git_parse_source(fn, data, opts);
1514 /* pop config-file parsing state stack */
1515 strbuf_release(&top->value);
1516 strbuf_release(&top->var);
1517 cf = top->prev;
1519 return ret;
1522 static int do_config_from_file(config_fn_t fn,
1523 const enum config_origin_type origin_type,
1524 const char *name, const char *path, FILE *f,
1525 void *data, const struct config_options *opts)
1527 struct config_source top;
1528 int ret;
1530 top.u.file = f;
1531 top.origin_type = origin_type;
1532 top.name = name;
1533 top.path = path;
1534 top.default_error_action = CONFIG_ERROR_DIE;
1535 top.do_fgetc = config_file_fgetc;
1536 top.do_ungetc = config_file_ungetc;
1537 top.do_ftell = config_file_ftell;
1539 flockfile(f);
1540 ret = do_config_from(&top, fn, data, opts);
1541 funlockfile(f);
1542 return ret;
1545 static int git_config_from_stdin(config_fn_t fn, void *data)
1547 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1548 data, NULL);
1551 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1552 void *data,
1553 const struct config_options *opts)
1555 int ret = -1;
1556 FILE *f;
1558 f = fopen_or_warn(filename, "r");
1559 if (f) {
1560 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1561 filename, f, data, opts);
1562 fclose(f);
1564 return ret;
1567 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1569 return git_config_from_file_with_options(fn, filename, data, NULL);
1572 int git_config_from_mem(config_fn_t fn,
1573 const enum config_origin_type origin_type,
1574 const char *name, const char *buf, size_t len,
1575 void *data, const struct config_options *opts)
1577 struct config_source top;
1579 top.u.buf.buf = buf;
1580 top.u.buf.len = len;
1581 top.u.buf.pos = 0;
1582 top.origin_type = origin_type;
1583 top.name = name;
1584 top.path = NULL;
1585 top.default_error_action = CONFIG_ERROR_ERROR;
1586 top.do_fgetc = config_buf_fgetc;
1587 top.do_ungetc = config_buf_ungetc;
1588 top.do_ftell = config_buf_ftell;
1590 return do_config_from(&top, fn, data, opts);
1593 int git_config_from_blob_oid(config_fn_t fn,
1594 const char *name,
1595 const struct object_id *oid,
1596 void *data)
1598 enum object_type type;
1599 char *buf;
1600 unsigned long size;
1601 int ret;
1603 buf = read_object_file(oid, &type, &size);
1604 if (!buf)
1605 return error("unable to load config blob object '%s'", name);
1606 if (type != OBJ_BLOB) {
1607 free(buf);
1608 return error("reference '%s' does not point to a blob", name);
1611 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1612 data, NULL);
1613 free(buf);
1615 return ret;
1618 static int git_config_from_blob_ref(config_fn_t fn,
1619 const char *name,
1620 void *data)
1622 struct object_id oid;
1624 if (get_oid(name, &oid) < 0)
1625 return error("unable to resolve config blob '%s'", name);
1626 return git_config_from_blob_oid(fn, name, &oid, data);
1629 const char *git_etc_gitconfig(void)
1631 static const char *system_wide;
1632 if (!system_wide)
1633 system_wide = system_path(ETC_GITCONFIG);
1634 return system_wide;
1638 * Parse environment variable 'k' as a boolean (in various
1639 * possible spellings); if missing, use the default value 'def'.
1641 int git_env_bool(const char *k, int def)
1643 const char *v = getenv(k);
1644 return v ? git_config_bool(k, v) : def;
1648 * Parse environment variable 'k' as ulong with possibly a unit
1649 * suffix; if missing, use the default value 'val'.
1651 unsigned long git_env_ulong(const char *k, unsigned long val)
1653 const char *v = getenv(k);
1654 if (v && !git_parse_ulong(v, &val))
1655 die("failed to parse %s", k);
1656 return val;
1659 int git_config_system(void)
1661 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1664 static int do_git_config_sequence(const struct config_options *opts,
1665 config_fn_t fn, void *data)
1667 int ret = 0;
1668 char *xdg_config = xdg_config_home("config");
1669 char *user_config = expand_user_path("~/.gitconfig", 0);
1670 char *repo_config;
1672 if (opts->commondir)
1673 repo_config = mkpathdup("%s/config", opts->commondir);
1674 else
1675 repo_config = NULL;
1677 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1678 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1679 ret += git_config_from_file(fn, git_etc_gitconfig(),
1680 data);
1682 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1683 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1684 ret += git_config_from_file(fn, xdg_config, data);
1686 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1687 ret += git_config_from_file(fn, user_config, data);
1689 current_parsing_scope = CONFIG_SCOPE_REPO;
1690 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1691 ret += git_config_from_file(fn, repo_config, data);
1693 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1694 if (git_config_from_parameters(fn, data) < 0)
1695 die(_("unable to parse command-line config"));
1697 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1698 free(xdg_config);
1699 free(user_config);
1700 free(repo_config);
1701 return ret;
1704 int config_with_options(config_fn_t fn, void *data,
1705 struct git_config_source *config_source,
1706 const struct config_options *opts)
1708 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1710 if (opts->respect_includes) {
1711 inc.fn = fn;
1712 inc.data = data;
1713 inc.opts = opts;
1714 fn = git_config_include;
1715 data = &inc;
1719 * If we have a specific filename, use it. Otherwise, follow the
1720 * regular lookup sequence.
1722 if (config_source && config_source->use_stdin)
1723 return git_config_from_stdin(fn, data);
1724 else if (config_source && config_source->file)
1725 return git_config_from_file(fn, config_source->file, data);
1726 else if (config_source && config_source->blob)
1727 return git_config_from_blob_ref(fn, config_source->blob, data);
1729 return do_git_config_sequence(opts, fn, data);
1732 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1734 int i, value_index;
1735 struct string_list *values;
1736 struct config_set_element *entry;
1737 struct configset_list *list = &cs->list;
1739 for (i = 0; i < list->nr; i++) {
1740 entry = list->items[i].e;
1741 value_index = list->items[i].value_index;
1742 values = &entry->value_list;
1744 current_config_kvi = values->items[value_index].util;
1746 if (fn(entry->key, values->items[value_index].string, data) < 0)
1747 git_die_config_linenr(entry->key,
1748 current_config_kvi->filename,
1749 current_config_kvi->linenr);
1751 current_config_kvi = NULL;
1755 void read_early_config(config_fn_t cb, void *data)
1757 struct config_options opts = {0};
1758 struct strbuf commondir = STRBUF_INIT;
1759 struct strbuf gitdir = STRBUF_INIT;
1761 opts.respect_includes = 1;
1763 if (have_git_dir()) {
1764 opts.commondir = get_git_common_dir();
1765 opts.git_dir = get_git_dir();
1767 * When setup_git_directory() was not yet asked to discover the
1768 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1769 * is any repository config we should use (but unlike
1770 * setup_git_directory_gently(), no global state is changed, most
1771 * notably, the current working directory is still the same after the
1772 * call).
1774 } else if (!discover_git_directory(&commondir, &gitdir)) {
1775 opts.commondir = commondir.buf;
1776 opts.git_dir = gitdir.buf;
1779 config_with_options(cb, data, NULL, &opts);
1781 strbuf_release(&commondir);
1782 strbuf_release(&gitdir);
1785 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1787 struct config_set_element k;
1788 struct config_set_element *found_entry;
1789 char *normalized_key;
1791 * `key` may come from the user, so normalize it before using it
1792 * for querying entries from the hashmap.
1794 if (git_config_parse_key(key, &normalized_key, NULL))
1795 return NULL;
1797 hashmap_entry_init(&k, strhash(normalized_key));
1798 k.key = normalized_key;
1799 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1800 free(normalized_key);
1801 return found_entry;
1804 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1806 struct config_set_element *e;
1807 struct string_list_item *si;
1808 struct configset_list_item *l_item;
1809 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1811 e = configset_find_element(cs, key);
1813 * Since the keys are being fed by git_config*() callback mechanism, they
1814 * are already normalized. So simply add them without any further munging.
1816 if (!e) {
1817 e = xmalloc(sizeof(*e));
1818 hashmap_entry_init(e, strhash(key));
1819 e->key = xstrdup(key);
1820 string_list_init(&e->value_list, 1);
1821 hashmap_add(&cs->config_hash, e);
1823 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1825 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1826 l_item = &cs->list.items[cs->list.nr++];
1827 l_item->e = e;
1828 l_item->value_index = e->value_list.nr - 1;
1830 if (!cf)
1831 BUG("configset_add_value has no source");
1832 if (cf->name) {
1833 kv_info->filename = strintern(cf->name);
1834 kv_info->linenr = cf->linenr;
1835 kv_info->origin_type = cf->origin_type;
1836 } else {
1837 /* for values read from `git_config_from_parameters()` */
1838 kv_info->filename = NULL;
1839 kv_info->linenr = -1;
1840 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1842 kv_info->scope = current_parsing_scope;
1843 si->util = kv_info;
1845 return 0;
1848 static int config_set_element_cmp(const void *unused_cmp_data,
1849 const void *entry,
1850 const void *entry_or_key,
1851 const void *unused_keydata)
1853 const struct config_set_element *e1 = entry;
1854 const struct config_set_element *e2 = entry_or_key;
1856 return strcmp(e1->key, e2->key);
1859 void git_configset_init(struct config_set *cs)
1861 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1862 cs->hash_initialized = 1;
1863 cs->list.nr = 0;
1864 cs->list.alloc = 0;
1865 cs->list.items = NULL;
1868 void git_configset_clear(struct config_set *cs)
1870 struct config_set_element *entry;
1871 struct hashmap_iter iter;
1872 if (!cs->hash_initialized)
1873 return;
1875 hashmap_iter_init(&cs->config_hash, &iter);
1876 while ((entry = hashmap_iter_next(&iter))) {
1877 free(entry->key);
1878 string_list_clear(&entry->value_list, 1);
1880 hashmap_free(&cs->config_hash, 1);
1881 cs->hash_initialized = 0;
1882 free(cs->list.items);
1883 cs->list.nr = 0;
1884 cs->list.alloc = 0;
1885 cs->list.items = NULL;
1888 static int config_set_callback(const char *key, const char *value, void *cb)
1890 struct config_set *cs = cb;
1891 configset_add_value(cs, key, value);
1892 return 0;
1895 int git_configset_add_file(struct config_set *cs, const char *filename)
1897 return git_config_from_file(config_set_callback, filename, cs);
1900 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1902 const struct string_list *values = NULL;
1904 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1905 * queried key in the files of the configset, the value returned will be the last
1906 * value in the value list for that key.
1908 values = git_configset_get_value_multi(cs, key);
1910 if (!values)
1911 return 1;
1912 assert(values->nr > 0);
1913 *value = values->items[values->nr - 1].string;
1914 return 0;
1917 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1919 struct config_set_element *e = configset_find_element(cs, key);
1920 return e ? &e->value_list : NULL;
1923 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1925 const char *value;
1926 if (!git_configset_get_value(cs, key, &value))
1927 return git_config_string(dest, key, value);
1928 else
1929 return 1;
1932 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1934 return git_configset_get_string_const(cs, key, (const char **)dest);
1937 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1939 const char *value;
1940 if (!git_configset_get_value(cs, key, &value)) {
1941 *dest = git_config_int(key, value);
1942 return 0;
1943 } else
1944 return 1;
1947 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1949 const char *value;
1950 if (!git_configset_get_value(cs, key, &value)) {
1951 *dest = git_config_ulong(key, value);
1952 return 0;
1953 } else
1954 return 1;
1957 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1959 const char *value;
1960 if (!git_configset_get_value(cs, key, &value)) {
1961 *dest = git_config_bool(key, value);
1962 return 0;
1963 } else
1964 return 1;
1967 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1968 int *is_bool, int *dest)
1970 const char *value;
1971 if (!git_configset_get_value(cs, key, &value)) {
1972 *dest = git_config_bool_or_int(key, value, is_bool);
1973 return 0;
1974 } else
1975 return 1;
1978 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1980 const char *value;
1981 if (!git_configset_get_value(cs, key, &value)) {
1982 *dest = git_parse_maybe_bool(value);
1983 if (*dest == -1)
1984 return -1;
1985 return 0;
1986 } else
1987 return 1;
1990 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1992 const char *value;
1993 if (!git_configset_get_value(cs, key, &value))
1994 return git_config_pathname(dest, key, value);
1995 else
1996 return 1;
1999 /* Functions use to read configuration from a repository */
2000 static void repo_read_config(struct repository *repo)
2002 struct config_options opts;
2004 opts.respect_includes = 1;
2005 opts.commondir = repo->commondir;
2006 opts.git_dir = repo->gitdir;
2008 if (!repo->config)
2009 repo->config = xcalloc(1, sizeof(struct config_set));
2010 else
2011 git_configset_clear(repo->config);
2013 git_configset_init(repo->config);
2015 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2017 * config_with_options() normally returns only
2018 * zero, as most errors are fatal, and
2019 * non-fatal potential errors are guarded by "if"
2020 * statements that are entered only when no error is
2021 * possible.
2023 * If we ever encounter a non-fatal error, it means
2024 * something went really wrong and we should stop
2025 * immediately.
2027 die(_("unknown error occurred while reading the configuration files"));
2030 static void git_config_check_init(struct repository *repo)
2032 if (repo->config && repo->config->hash_initialized)
2033 return;
2034 repo_read_config(repo);
2037 static void repo_config_clear(struct repository *repo)
2039 if (!repo->config || !repo->config->hash_initialized)
2040 return;
2041 git_configset_clear(repo->config);
2044 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2046 git_config_check_init(repo);
2047 configset_iter(repo->config, fn, data);
2050 int repo_config_get_value(struct repository *repo,
2051 const char *key, const char **value)
2053 git_config_check_init(repo);
2054 return git_configset_get_value(repo->config, key, value);
2057 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2058 const char *key)
2060 git_config_check_init(repo);
2061 return git_configset_get_value_multi(repo->config, key);
2064 int repo_config_get_string_const(struct repository *repo,
2065 const char *key, const char **dest)
2067 int ret;
2068 git_config_check_init(repo);
2069 ret = git_configset_get_string_const(repo->config, key, dest);
2070 if (ret < 0)
2071 git_die_config(key, NULL);
2072 return ret;
2075 int repo_config_get_string(struct repository *repo,
2076 const char *key, char **dest)
2078 git_config_check_init(repo);
2079 return repo_config_get_string_const(repo, key, (const char **)dest);
2082 int repo_config_get_int(struct repository *repo,
2083 const char *key, int *dest)
2085 git_config_check_init(repo);
2086 return git_configset_get_int(repo->config, key, dest);
2089 int repo_config_get_ulong(struct repository *repo,
2090 const char *key, unsigned long *dest)
2092 git_config_check_init(repo);
2093 return git_configset_get_ulong(repo->config, key, dest);
2096 int repo_config_get_bool(struct repository *repo,
2097 const char *key, int *dest)
2099 git_config_check_init(repo);
2100 return git_configset_get_bool(repo->config, key, dest);
2103 int repo_config_get_bool_or_int(struct repository *repo,
2104 const char *key, int *is_bool, int *dest)
2106 git_config_check_init(repo);
2107 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2110 int repo_config_get_maybe_bool(struct repository *repo,
2111 const char *key, int *dest)
2113 git_config_check_init(repo);
2114 return git_configset_get_maybe_bool(repo->config, key, dest);
2117 int repo_config_get_pathname(struct repository *repo,
2118 const char *key, const char **dest)
2120 int ret;
2121 git_config_check_init(repo);
2122 ret = git_configset_get_pathname(repo->config, key, dest);
2123 if (ret < 0)
2124 git_die_config(key, NULL);
2125 return ret;
2128 /* Functions used historically to read configuration from 'the_repository' */
2129 void git_config(config_fn_t fn, void *data)
2131 repo_config(the_repository, fn, data);
2134 void git_config_clear(void)
2136 repo_config_clear(the_repository);
2139 int git_config_get_value(const char *key, const char **value)
2141 return repo_config_get_value(the_repository, key, value);
2144 const struct string_list *git_config_get_value_multi(const char *key)
2146 return repo_config_get_value_multi(the_repository, key);
2149 int git_config_get_string_const(const char *key, const char **dest)
2151 return repo_config_get_string_const(the_repository, key, dest);
2154 int git_config_get_string(const char *key, char **dest)
2156 return repo_config_get_string(the_repository, key, dest);
2159 int git_config_get_int(const char *key, int *dest)
2161 return repo_config_get_int(the_repository, key, dest);
2164 int git_config_get_ulong(const char *key, unsigned long *dest)
2166 return repo_config_get_ulong(the_repository, key, dest);
2169 int git_config_get_bool(const char *key, int *dest)
2171 return repo_config_get_bool(the_repository, key, dest);
2174 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2176 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2179 int git_config_get_maybe_bool(const char *key, int *dest)
2181 return repo_config_get_maybe_bool(the_repository, key, dest);
2184 int git_config_get_pathname(const char *key, const char **dest)
2186 return repo_config_get_pathname(the_repository, key, dest);
2190 * Note: This function exists solely to maintain backward compatibility with
2191 * 'fetch' and 'update_clone' storing configuration in '.gitmodules' and should
2192 * NOT be used anywhere else.
2194 * Runs the provided config function on the '.gitmodules' file found in the
2195 * working directory.
2197 void config_from_gitmodules(config_fn_t fn, void *data)
2199 if (the_repository->worktree) {
2200 char *file = repo_worktree_path(the_repository, GITMODULES_FILE);
2201 git_config_from_file(fn, file, data);
2202 free(file);
2206 int git_config_get_expiry(const char *key, const char **output)
2208 int ret = git_config_get_string_const(key, output);
2209 if (ret)
2210 return ret;
2211 if (strcmp(*output, "now")) {
2212 timestamp_t now = approxidate("now");
2213 if (approxidate(*output) >= now)
2214 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2216 return ret;
2219 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2221 char *expiry_string;
2222 intmax_t days;
2223 timestamp_t when;
2225 if (git_config_get_string(key, &expiry_string))
2226 return 1; /* no such thing */
2228 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2229 const int scale = 86400;
2230 *expiry = now - days * scale;
2231 return 0;
2234 if (!parse_expiry_date(expiry_string, &when)) {
2235 *expiry = when;
2236 return 0;
2238 return -1; /* thing exists but cannot be parsed */
2241 int git_config_get_untracked_cache(void)
2243 int val = -1;
2244 const char *v;
2246 /* Hack for test programs like test-dump-untracked-cache */
2247 if (ignore_untracked_cache_config)
2248 return -1;
2250 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2251 return val;
2253 if (!git_config_get_value("core.untrackedcache", &v)) {
2254 if (!strcasecmp(v, "keep"))
2255 return -1;
2257 error(_("unknown core.untrackedCache value '%s'; "
2258 "using 'keep' default value"), v);
2259 return -1;
2262 return -1; /* default value */
2265 int git_config_get_split_index(void)
2267 int val;
2269 if (!git_config_get_maybe_bool("core.splitindex", &val))
2270 return val;
2272 return -1; /* default value */
2275 int git_config_get_max_percent_split_change(void)
2277 int val = -1;
2279 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2280 if (0 <= val && val <= 100)
2281 return val;
2283 return error(_("splitIndex.maxPercentChange value '%d' "
2284 "should be between 0 and 100"), val);
2287 return -1; /* default value */
2290 int git_config_get_fsmonitor(void)
2292 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2293 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2295 if (core_fsmonitor && !*core_fsmonitor)
2296 core_fsmonitor = NULL;
2298 if (core_fsmonitor)
2299 return 1;
2301 return 0;
2304 NORETURN
2305 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2307 if (!filename)
2308 die(_("unable to parse '%s' from command-line config"), key);
2309 else
2310 die(_("bad config variable '%s' in file '%s' at line %d"),
2311 key, filename, linenr);
2314 NORETURN __attribute__((format(printf, 2, 3)))
2315 void git_die_config(const char *key, const char *err, ...)
2317 const struct string_list *values;
2318 struct key_value_info *kv_info;
2320 if (err) {
2321 va_list params;
2322 va_start(params, err);
2323 vreportf("error: ", err, params);
2324 va_end(params);
2326 values = git_config_get_value_multi(key);
2327 kv_info = values->items[values->nr - 1].util;
2328 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2332 * Find all the stuff for git_config_set() below.
2335 struct config_store_data {
2336 int baselen;
2337 char *key;
2338 int do_not_match;
2339 regex_t *value_regex;
2340 int multi_replace;
2341 struct {
2342 size_t begin, end;
2343 enum config_event_t type;
2344 int is_keys_section;
2345 } *parsed;
2346 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2347 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2350 static void config_store_data_clear(struct config_store_data *store)
2352 free(store->key);
2353 if (store->value_regex != NULL &&
2354 store->value_regex != CONFIG_REGEX_NONE) {
2355 regfree(store->value_regex);
2356 free(store->value_regex);
2358 free(store->parsed);
2359 free(store->seen);
2360 memset(store, 0, sizeof(*store));
2363 static int matches(const char *key, const char *value,
2364 const struct config_store_data *store)
2366 if (strcmp(key, store->key))
2367 return 0; /* not ours */
2368 if (!store->value_regex)
2369 return 1; /* always matches */
2370 if (store->value_regex == CONFIG_REGEX_NONE)
2371 return 0; /* never matches */
2373 return store->do_not_match ^
2374 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2377 static int store_aux_event(enum config_event_t type,
2378 size_t begin, size_t end, void *data)
2380 struct config_store_data *store = data;
2382 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2383 store->parsed[store->parsed_nr].begin = begin;
2384 store->parsed[store->parsed_nr].end = end;
2385 store->parsed[store->parsed_nr].type = type;
2387 if (type == CONFIG_EVENT_SECTION) {
2388 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2389 return error("invalid section name '%s'", cf->var.buf);
2391 /* Is this the section we were looking for? */
2392 store->is_keys_section =
2393 store->parsed[store->parsed_nr].is_keys_section =
2394 cf->var.len - 1 == store->baselen &&
2395 !strncasecmp(cf->var.buf, store->key, store->baselen);
2396 if (store->is_keys_section) {
2397 store->section_seen = 1;
2398 ALLOC_GROW(store->seen, store->seen_nr + 1,
2399 store->seen_alloc);
2400 store->seen[store->seen_nr] = store->parsed_nr;
2404 store->parsed_nr++;
2406 return 0;
2409 static int store_aux(const char *key, const char *value, void *cb)
2411 struct config_store_data *store = cb;
2413 if (store->key_seen) {
2414 if (matches(key, value, store)) {
2415 if (store->seen_nr == 1 && store->multi_replace == 0) {
2416 warning(_("%s has multiple values"), key);
2419 ALLOC_GROW(store->seen, store->seen_nr + 1,
2420 store->seen_alloc);
2422 store->seen[store->seen_nr] = store->parsed_nr;
2423 store->seen_nr++;
2425 } else if (store->is_keys_section) {
2427 * Do not increment matches yet: this may not be a match, but we
2428 * are in the desired section.
2430 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2431 store->seen[store->seen_nr] = store->parsed_nr;
2432 store->section_seen = 1;
2434 if (matches(key, value, store)) {
2435 store->seen_nr++;
2436 store->key_seen = 1;
2440 return 0;
2443 static int write_error(const char *filename)
2445 error("failed to write new configuration file %s", filename);
2447 /* Same error code as "failed to rename". */
2448 return 4;
2451 static struct strbuf store_create_section(const char *key,
2452 const struct config_store_data *store)
2454 const char *dot;
2455 int i;
2456 struct strbuf sb = STRBUF_INIT;
2458 dot = memchr(key, '.', store->baselen);
2459 if (dot) {
2460 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2461 for (i = dot - key + 1; i < store->baselen; i++) {
2462 if (key[i] == '"' || key[i] == '\\')
2463 strbuf_addch(&sb, '\\');
2464 strbuf_addch(&sb, key[i]);
2466 strbuf_addstr(&sb, "\"]\n");
2467 } else {
2468 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2471 return sb;
2474 static ssize_t write_section(int fd, const char *key,
2475 const struct config_store_data *store)
2477 struct strbuf sb = store_create_section(key, store);
2478 ssize_t ret;
2480 ret = write_in_full(fd, sb.buf, sb.len);
2481 strbuf_release(&sb);
2483 return ret;
2486 static ssize_t write_pair(int fd, const char *key, const char *value,
2487 const struct config_store_data *store)
2489 int i;
2490 ssize_t ret;
2491 int length = strlen(key + store->baselen + 1);
2492 const char *quote = "";
2493 struct strbuf sb = STRBUF_INIT;
2496 * Check to see if the value needs to be surrounded with a dq pair.
2497 * Note that problematic characters are always backslash-quoted; this
2498 * check is about not losing leading or trailing SP and strings that
2499 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2500 * configuration parser.
2502 if (value[0] == ' ')
2503 quote = "\"";
2504 for (i = 0; value[i]; i++)
2505 if (value[i] == ';' || value[i] == '#')
2506 quote = "\"";
2507 if (i && value[i - 1] == ' ')
2508 quote = "\"";
2510 strbuf_addf(&sb, "\t%.*s = %s",
2511 length, key + store->baselen + 1, quote);
2513 for (i = 0; value[i]; i++)
2514 switch (value[i]) {
2515 case '\n':
2516 strbuf_addstr(&sb, "\\n");
2517 break;
2518 case '\t':
2519 strbuf_addstr(&sb, "\\t");
2520 break;
2521 case '"':
2522 case '\\':
2523 strbuf_addch(&sb, '\\');
2524 /* fallthrough */
2525 default:
2526 strbuf_addch(&sb, value[i]);
2527 break;
2529 strbuf_addf(&sb, "%s\n", quote);
2531 ret = write_in_full(fd, sb.buf, sb.len);
2532 strbuf_release(&sb);
2534 return ret;
2538 * If we are about to unset the last key(s) in a section, and if there are
2539 * no comments surrounding (or included in) the section, we will want to
2540 * extend begin/end to remove the entire section.
2542 * Note: the parameter `seen_ptr` points to the index into the store.seen
2543 * array. * This index may be incremented if a section has more than one
2544 * entry (which all are to be removed).
2546 static void maybe_remove_section(struct config_store_data *store,
2547 const char *contents,
2548 size_t *begin_offset, size_t *end_offset,
2549 int *seen_ptr)
2551 size_t begin;
2552 int i, seen, section_seen = 0;
2555 * First, ensure that this is the first key, and that there are no
2556 * comments before the entry nor before the section header.
2558 seen = *seen_ptr;
2559 for (i = store->seen[seen]; i > 0; i--) {
2560 enum config_event_t type = store->parsed[i - 1].type;
2562 if (type == CONFIG_EVENT_COMMENT)
2563 /* There is a comment before this entry or section */
2564 return;
2565 if (type == CONFIG_EVENT_ENTRY) {
2566 if (!section_seen)
2567 /* This is not the section's first entry. */
2568 return;
2569 /* We encountered no comment before the section. */
2570 break;
2572 if (type == CONFIG_EVENT_SECTION) {
2573 if (!store->parsed[i - 1].is_keys_section)
2574 break;
2575 section_seen = 1;
2578 begin = store->parsed[i].begin;
2581 * Next, make sure that we are removing he last key(s) in the section,
2582 * and that there are no comments that are possibly about the current
2583 * section.
2585 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2586 enum config_event_t type = store->parsed[i].type;
2588 if (type == CONFIG_EVENT_COMMENT)
2589 return;
2590 if (type == CONFIG_EVENT_SECTION) {
2591 if (store->parsed[i].is_keys_section)
2592 continue;
2593 break;
2595 if (type == CONFIG_EVENT_ENTRY) {
2596 if (++seen < store->seen_nr &&
2597 i == store->seen[seen])
2598 /* We want to remove this entry, too */
2599 continue;
2600 /* There is another entry in this section. */
2601 return;
2606 * We are really removing the last entry/entries from this section, and
2607 * there are no enclosed or surrounding comments. Remove the entire,
2608 * now-empty section.
2610 *seen_ptr = seen;
2611 *begin_offset = begin;
2612 if (i < store->parsed_nr)
2613 *end_offset = store->parsed[i].begin;
2614 else
2615 *end_offset = store->parsed[store->parsed_nr - 1].end;
2618 int git_config_set_in_file_gently(const char *config_filename,
2619 const char *key, const char *value)
2621 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2624 void git_config_set_in_file(const char *config_filename,
2625 const char *key, const char *value)
2627 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2630 int git_config_set_gently(const char *key, const char *value)
2632 return git_config_set_multivar_gently(key, value, NULL, 0);
2635 void git_config_set(const char *key, const char *value)
2637 git_config_set_multivar(key, value, NULL, 0);
2641 * If value==NULL, unset in (remove from) config,
2642 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2643 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2644 * (only add a new one)
2645 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2646 * else all matching key/values (regardless how many) are removed,
2647 * before the new pair is written.
2649 * Returns 0 on success.
2651 * This function does this:
2653 * - it locks the config file by creating ".git/config.lock"
2655 * - it then parses the config using store_aux() as validator to find
2656 * the position on the key/value pair to replace. If it is to be unset,
2657 * it must be found exactly once.
2659 * - the config file is mmap()ed and the part before the match (if any) is
2660 * written to the lock file, then the changed part and the rest.
2662 * - the config file is removed and the lock file rename()d to it.
2665 int git_config_set_multivar_in_file_gently(const char *config_filename,
2666 const char *key, const char *value,
2667 const char *value_regex,
2668 int multi_replace)
2670 int fd = -1, in_fd = -1;
2671 int ret;
2672 struct lock_file lock = LOCK_INIT;
2673 char *filename_buf = NULL;
2674 char *contents = NULL;
2675 size_t contents_sz;
2676 struct config_store_data store;
2678 memset(&store, 0, sizeof(store));
2680 /* parse-key returns negative; flip the sign to feed exit(3) */
2681 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2682 if (ret)
2683 goto out_free;
2685 store.multi_replace = multi_replace;
2687 if (!config_filename)
2688 config_filename = filename_buf = git_pathdup("config");
2691 * The lock serves a purpose in addition to locking: the new
2692 * contents of .git/config will be written into it.
2694 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2695 if (fd < 0) {
2696 error_errno("could not lock config file %s", config_filename);
2697 ret = CONFIG_NO_LOCK;
2698 goto out_free;
2702 * If .git/config does not exist yet, write a minimal version.
2704 in_fd = open(config_filename, O_RDONLY);
2705 if ( in_fd < 0 ) {
2706 if ( ENOENT != errno ) {
2707 error_errno("opening %s", config_filename);
2708 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2709 goto out_free;
2711 /* if nothing to unset, error out */
2712 if (value == NULL) {
2713 ret = CONFIG_NOTHING_SET;
2714 goto out_free;
2717 free(store.key);
2718 store.key = xstrdup(key);
2719 if (write_section(fd, key, &store) < 0 ||
2720 write_pair(fd, key, value, &store) < 0)
2721 goto write_err_out;
2722 } else {
2723 struct stat st;
2724 size_t copy_begin, copy_end;
2725 int i, new_line = 0;
2726 struct config_options opts;
2728 if (value_regex == NULL)
2729 store.value_regex = NULL;
2730 else if (value_regex == CONFIG_REGEX_NONE)
2731 store.value_regex = CONFIG_REGEX_NONE;
2732 else {
2733 if (value_regex[0] == '!') {
2734 store.do_not_match = 1;
2735 value_regex++;
2736 } else
2737 store.do_not_match = 0;
2739 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2740 if (regcomp(store.value_regex, value_regex,
2741 REG_EXTENDED)) {
2742 error("invalid pattern: %s", value_regex);
2743 FREE_AND_NULL(store.value_regex);
2744 ret = CONFIG_INVALID_PATTERN;
2745 goto out_free;
2749 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2750 store.parsed[0].end = 0;
2752 memset(&opts, 0, sizeof(opts));
2753 opts.event_fn = store_aux_event;
2754 opts.event_fn_data = &store;
2757 * After this, store.parsed will contain offsets of all the
2758 * parsed elements, and store.seen will contain a list of
2759 * matches, as indices into store.parsed.
2761 * As a side effect, we make sure to transform only a valid
2762 * existing config file.
2764 if (git_config_from_file_with_options(store_aux,
2765 config_filename,
2766 &store, &opts)) {
2767 error("invalid config file %s", config_filename);
2768 ret = CONFIG_INVALID_FILE;
2769 goto out_free;
2772 /* if nothing to unset, or too many matches, error out */
2773 if ((store.seen_nr == 0 && value == NULL) ||
2774 (store.seen_nr > 1 && multi_replace == 0)) {
2775 ret = CONFIG_NOTHING_SET;
2776 goto out_free;
2779 if (fstat(in_fd, &st) == -1) {
2780 error_errno(_("fstat on %s failed"), config_filename);
2781 ret = CONFIG_INVALID_FILE;
2782 goto out_free;
2785 contents_sz = xsize_t(st.st_size);
2786 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2787 MAP_PRIVATE, in_fd, 0);
2788 if (contents == MAP_FAILED) {
2789 if (errno == ENODEV && S_ISDIR(st.st_mode))
2790 errno = EISDIR;
2791 error_errno("unable to mmap '%s'", config_filename);
2792 ret = CONFIG_INVALID_FILE;
2793 contents = NULL;
2794 goto out_free;
2796 close(in_fd);
2797 in_fd = -1;
2799 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2800 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2801 ret = CONFIG_NO_WRITE;
2802 goto out_free;
2805 if (store.seen_nr == 0) {
2806 if (!store.seen_alloc) {
2807 /* Did not see key nor section */
2808 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2809 store.seen[0] = store.parsed_nr
2810 - !!store.parsed_nr;
2812 store.seen_nr = 1;
2815 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2816 size_t replace_end;
2817 int j = store.seen[i];
2819 new_line = 0;
2820 if (!store.key_seen) {
2821 copy_end = store.parsed[j].end;
2822 /* include '\n' when copying section header */
2823 if (copy_end > 0 && copy_end < contents_sz &&
2824 contents[copy_end - 1] != '\n' &&
2825 contents[copy_end] == '\n')
2826 copy_end++;
2827 replace_end = copy_end;
2828 } else {
2829 replace_end = store.parsed[j].end;
2830 copy_end = store.parsed[j].begin;
2831 if (!value)
2832 maybe_remove_section(&store, contents,
2833 &copy_end,
2834 &replace_end, &i);
2836 * Swallow preceding white-space on the same
2837 * line.
2839 while (copy_end > 0 ) {
2840 char c = contents[copy_end - 1];
2842 if (isspace(c) && c != '\n')
2843 copy_end--;
2844 else
2845 break;
2849 if (copy_end > 0 && contents[copy_end-1] != '\n')
2850 new_line = 1;
2852 /* write the first part of the config */
2853 if (copy_end > copy_begin) {
2854 if (write_in_full(fd, contents + copy_begin,
2855 copy_end - copy_begin) < 0)
2856 goto write_err_out;
2857 if (new_line &&
2858 write_str_in_full(fd, "\n") < 0)
2859 goto write_err_out;
2861 copy_begin = replace_end;
2864 /* write the pair (value == NULL means unset) */
2865 if (value != NULL) {
2866 if (!store.section_seen) {
2867 if (write_section(fd, key, &store) < 0)
2868 goto write_err_out;
2870 if (write_pair(fd, key, value, &store) < 0)
2871 goto write_err_out;
2874 /* write the rest of the config */
2875 if (copy_begin < contents_sz)
2876 if (write_in_full(fd, contents + copy_begin,
2877 contents_sz - copy_begin) < 0)
2878 goto write_err_out;
2880 munmap(contents, contents_sz);
2881 contents = NULL;
2884 if (commit_lock_file(&lock) < 0) {
2885 error_errno("could not write config file %s", config_filename);
2886 ret = CONFIG_NO_WRITE;
2887 goto out_free;
2890 ret = 0;
2892 /* Invalidate the config cache */
2893 git_config_clear();
2895 out_free:
2896 rollback_lock_file(&lock);
2897 free(filename_buf);
2898 if (contents)
2899 munmap(contents, contents_sz);
2900 if (in_fd >= 0)
2901 close(in_fd);
2902 config_store_data_clear(&store);
2903 return ret;
2905 write_err_out:
2906 ret = write_error(get_lock_file_path(&lock));
2907 goto out_free;
2911 void git_config_set_multivar_in_file(const char *config_filename,
2912 const char *key, const char *value,
2913 const char *value_regex, int multi_replace)
2915 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2916 value_regex, multi_replace))
2917 return;
2918 if (value)
2919 die(_("could not set '%s' to '%s'"), key, value);
2920 else
2921 die(_("could not unset '%s'"), key);
2924 int git_config_set_multivar_gently(const char *key, const char *value,
2925 const char *value_regex, int multi_replace)
2927 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2928 multi_replace);
2931 void git_config_set_multivar(const char *key, const char *value,
2932 const char *value_regex, int multi_replace)
2934 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2935 multi_replace);
2938 static int section_name_match (const char *buf, const char *name)
2940 int i = 0, j = 0, dot = 0;
2941 if (buf[i] != '[')
2942 return 0;
2943 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2944 if (!dot && isspace(buf[i])) {
2945 dot = 1;
2946 if (name[j++] != '.')
2947 break;
2948 for (i++; isspace(buf[i]); i++)
2949 ; /* do nothing */
2950 if (buf[i] != '"')
2951 break;
2952 continue;
2954 if (buf[i] == '\\' && dot)
2955 i++;
2956 else if (buf[i] == '"' && dot) {
2957 for (i++; isspace(buf[i]); i++)
2958 ; /* do_nothing */
2959 break;
2961 if (buf[i] != name[j++])
2962 break;
2964 if (buf[i] == ']' && name[j] == 0) {
2966 * We match, now just find the right length offset by
2967 * gobbling up any whitespace after it, as well
2969 i++;
2970 for (; buf[i] && isspace(buf[i]); i++)
2971 ; /* do nothing */
2972 return i;
2974 return 0;
2977 static int section_name_is_ok(const char *name)
2979 /* Empty section names are bogus. */
2980 if (!*name)
2981 return 0;
2984 * Before a dot, we must be alphanumeric or dash. After the first dot,
2985 * anything goes, so we can stop checking.
2987 for (; *name && *name != '.'; name++)
2988 if (*name != '-' && !isalnum(*name))
2989 return 0;
2990 return 1;
2993 /* if new_name == NULL, the section is removed instead */
2994 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
2995 const char *old_name,
2996 const char *new_name, int copy)
2998 int ret = 0, remove = 0;
2999 char *filename_buf = NULL;
3000 struct lock_file lock = LOCK_INIT;
3001 int out_fd;
3002 char buf[1024];
3003 FILE *config_file = NULL;
3004 struct stat st;
3005 struct strbuf copystr = STRBUF_INIT;
3006 struct config_store_data store;
3008 memset(&store, 0, sizeof(store));
3010 if (new_name && !section_name_is_ok(new_name)) {
3011 ret = error("invalid section name: %s", new_name);
3012 goto out_no_rollback;
3015 if (!config_filename)
3016 config_filename = filename_buf = git_pathdup("config");
3018 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3019 if (out_fd < 0) {
3020 ret = error("could not lock config file %s", config_filename);
3021 goto out;
3024 if (!(config_file = fopen(config_filename, "rb"))) {
3025 ret = warn_on_fopen_errors(config_filename);
3026 if (ret)
3027 goto out;
3028 /* no config file means nothing to rename, no error */
3029 goto commit_and_out;
3032 if (fstat(fileno(config_file), &st) == -1) {
3033 ret = error_errno(_("fstat on %s failed"), config_filename);
3034 goto out;
3037 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3038 ret = error_errno("chmod on %s failed",
3039 get_lock_file_path(&lock));
3040 goto out;
3043 while (fgets(buf, sizeof(buf), config_file)) {
3044 int i;
3045 int length;
3046 int is_section = 0;
3047 char *output = buf;
3048 for (i = 0; buf[i] && isspace(buf[i]); i++)
3049 ; /* do nothing */
3050 if (buf[i] == '[') {
3051 /* it's a section */
3052 int offset;
3053 is_section = 1;
3056 * When encountering a new section under -c we
3057 * need to flush out any section we're already
3058 * coping and begin anew. There might be
3059 * multiple [branch "$name"] sections.
3061 if (copystr.len > 0) {
3062 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3063 ret = write_error(get_lock_file_path(&lock));
3064 goto out;
3066 strbuf_reset(&copystr);
3069 offset = section_name_match(&buf[i], old_name);
3070 if (offset > 0) {
3071 ret++;
3072 if (new_name == NULL) {
3073 remove = 1;
3074 continue;
3076 store.baselen = strlen(new_name);
3077 if (!copy) {
3078 if (write_section(out_fd, new_name, &store) < 0) {
3079 ret = write_error(get_lock_file_path(&lock));
3080 goto out;
3083 * We wrote out the new section, with
3084 * a newline, now skip the old
3085 * section's length
3087 output += offset + i;
3088 if (strlen(output) > 0) {
3090 * More content means there's
3091 * a declaration to put on the
3092 * next line; indent with a
3093 * tab
3095 output -= 1;
3096 output[0] = '\t';
3098 } else {
3099 copystr = store_create_section(new_name, &store);
3102 remove = 0;
3104 if (remove)
3105 continue;
3106 length = strlen(output);
3108 if (!is_section && copystr.len > 0) {
3109 strbuf_add(&copystr, output, length);
3112 if (write_in_full(out_fd, output, length) < 0) {
3113 ret = write_error(get_lock_file_path(&lock));
3114 goto out;
3119 * Copy a trailing section at the end of the config, won't be
3120 * flushed by the usual "flush because we have a new section
3121 * logic in the loop above.
3123 if (copystr.len > 0) {
3124 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3125 ret = write_error(get_lock_file_path(&lock));
3126 goto out;
3128 strbuf_reset(&copystr);
3131 fclose(config_file);
3132 config_file = NULL;
3133 commit_and_out:
3134 if (commit_lock_file(&lock) < 0)
3135 ret = error_errno("could not write config file %s",
3136 config_filename);
3137 out:
3138 if (config_file)
3139 fclose(config_file);
3140 rollback_lock_file(&lock);
3141 out_no_rollback:
3142 free(filename_buf);
3143 config_store_data_clear(&store);
3144 return ret;
3147 int git_config_rename_section_in_file(const char *config_filename,
3148 const char *old_name, const char *new_name)
3150 return git_config_copy_or_rename_section_in_file(config_filename,
3151 old_name, new_name, 0);
3154 int git_config_rename_section(const char *old_name, const char *new_name)
3156 return git_config_rename_section_in_file(NULL, old_name, new_name);
3159 int git_config_copy_section_in_file(const char *config_filename,
3160 const char *old_name, const char *new_name)
3162 return git_config_copy_or_rename_section_in_file(config_filename,
3163 old_name, new_name, 1);
3166 int git_config_copy_section(const char *old_name, const char *new_name)
3168 return git_config_copy_section_in_file(NULL, old_name, new_name);
3172 * Call this to report error for your variable that should not
3173 * get a boolean value (i.e. "[my] var" means "true").
3175 #undef config_error_nonbool
3176 int config_error_nonbool(const char *var)
3178 return error("missing value for '%s'", var);
3181 int parse_config_key(const char *var,
3182 const char *section,
3183 const char **subsection, int *subsection_len,
3184 const char **key)
3186 const char *dot;
3188 /* Does it start with "section." ? */
3189 if (!skip_prefix(var, section, &var) || *var != '.')
3190 return -1;
3193 * Find the key; we don't know yet if we have a subsection, but we must
3194 * parse backwards from the end, since the subsection may have dots in
3195 * it, too.
3197 dot = strrchr(var, '.');
3198 *key = dot + 1;
3200 /* Did we have a subsection at all? */
3201 if (dot == var) {
3202 if (subsection) {
3203 *subsection = NULL;
3204 *subsection_len = 0;
3207 else {
3208 if (!subsection)
3209 return -1;
3210 *subsection = var + 1;
3211 *subsection_len = dot - *subsection;
3214 return 0;
3217 const char *current_config_origin_type(void)
3219 int type;
3220 if (current_config_kvi)
3221 type = current_config_kvi->origin_type;
3222 else if(cf)
3223 type = cf->origin_type;
3224 else
3225 BUG("current_config_origin_type called outside config callback");
3227 switch (type) {
3228 case CONFIG_ORIGIN_BLOB:
3229 return "blob";
3230 case CONFIG_ORIGIN_FILE:
3231 return "file";
3232 case CONFIG_ORIGIN_STDIN:
3233 return "standard input";
3234 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3235 return "submodule-blob";
3236 case CONFIG_ORIGIN_CMDLINE:
3237 return "command line";
3238 default:
3239 BUG("unknown config origin type");
3243 const char *current_config_name(void)
3245 const char *name;
3246 if (current_config_kvi)
3247 name = current_config_kvi->filename;
3248 else if (cf)
3249 name = cf->name;
3250 else
3251 BUG("current_config_name called outside config callback");
3252 return name ? name : "";
3255 enum config_scope current_config_scope(void)
3257 if (current_config_kvi)
3258 return current_config_kvi->scope;
3259 else
3260 return current_parsing_scope;
3263 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3265 int i;
3267 for (i = 0; i < nr_mapping; i++) {
3268 const char *name = mapping[i];
3270 if (name && !strcasecmp(var, name))
3271 return i;
3273 return -1;