git-p4: auto-size the block
[git.git] / config.c
blob6f8f1d8c1130f89ccf913cc7f7cafac3dd39e123
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 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 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 if (cf->die_on_error)
813 die("%s", error_msg);
814 else
815 error_return = error("%s", error_msg);
817 free(error_msg);
818 return error_return;
821 static int parse_unit_factor(const char *end, uintmax_t *val)
823 if (!*end)
824 return 1;
825 else if (!strcasecmp(end, "k")) {
826 *val *= 1024;
827 return 1;
829 else if (!strcasecmp(end, "m")) {
830 *val *= 1024 * 1024;
831 return 1;
833 else if (!strcasecmp(end, "g")) {
834 *val *= 1024 * 1024 * 1024;
835 return 1;
837 return 0;
840 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
842 if (value && *value) {
843 char *end;
844 intmax_t val;
845 uintmax_t uval;
846 uintmax_t factor = 1;
848 errno = 0;
849 val = strtoimax(value, &end, 0);
850 if (errno == ERANGE)
851 return 0;
852 if (!parse_unit_factor(end, &factor)) {
853 errno = EINVAL;
854 return 0;
856 uval = labs(val);
857 uval *= factor;
858 if (uval > max || labs(val) > uval) {
859 errno = ERANGE;
860 return 0;
862 val *= factor;
863 *ret = val;
864 return 1;
866 errno = EINVAL;
867 return 0;
870 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
872 if (value && *value) {
873 char *end;
874 uintmax_t val;
875 uintmax_t oldval;
877 errno = 0;
878 val = strtoumax(value, &end, 0);
879 if (errno == ERANGE)
880 return 0;
881 oldval = val;
882 if (!parse_unit_factor(end, &val)) {
883 errno = EINVAL;
884 return 0;
886 if (val > max || oldval > val) {
887 errno = ERANGE;
888 return 0;
890 *ret = val;
891 return 1;
893 errno = EINVAL;
894 return 0;
897 static int git_parse_int(const char *value, int *ret)
899 intmax_t tmp;
900 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
901 return 0;
902 *ret = tmp;
903 return 1;
906 static int git_parse_int64(const char *value, int64_t *ret)
908 intmax_t tmp;
909 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
910 return 0;
911 *ret = tmp;
912 return 1;
915 int git_parse_ulong(const char *value, unsigned long *ret)
917 uintmax_t tmp;
918 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
919 return 0;
920 *ret = tmp;
921 return 1;
924 static int git_parse_ssize_t(const char *value, ssize_t *ret)
926 intmax_t tmp;
927 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
928 return 0;
929 *ret = tmp;
930 return 1;
933 NORETURN
934 static void die_bad_number(const char *name, const char *value)
936 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
938 if (!value)
939 value = "";
941 if (!(cf && cf->name))
942 die(_("bad numeric config value '%s' for '%s': %s"),
943 value, name, error_type);
945 switch (cf->origin_type) {
946 case CONFIG_ORIGIN_BLOB:
947 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
948 value, name, cf->name, error_type);
949 case CONFIG_ORIGIN_FILE:
950 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
951 value, name, cf->name, error_type);
952 case CONFIG_ORIGIN_STDIN:
953 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
954 value, name, error_type);
955 case CONFIG_ORIGIN_SUBMODULE_BLOB:
956 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
957 value, name, cf->name, error_type);
958 case CONFIG_ORIGIN_CMDLINE:
959 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
960 value, name, cf->name, error_type);
961 default:
962 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
963 value, name, cf->name, error_type);
967 int git_config_int(const char *name, const char *value)
969 int ret;
970 if (!git_parse_int(value, &ret))
971 die_bad_number(name, value);
972 return ret;
975 int64_t git_config_int64(const char *name, const char *value)
977 int64_t ret;
978 if (!git_parse_int64(value, &ret))
979 die_bad_number(name, value);
980 return ret;
983 unsigned long git_config_ulong(const char *name, const char *value)
985 unsigned long ret;
986 if (!git_parse_ulong(value, &ret))
987 die_bad_number(name, value);
988 return ret;
991 ssize_t git_config_ssize_t(const char *name, const char *value)
993 ssize_t ret;
994 if (!git_parse_ssize_t(value, &ret))
995 die_bad_number(name, value);
996 return ret;
999 static int git_parse_maybe_bool_text(const char *value)
1001 if (!value)
1002 return 1;
1003 if (!*value)
1004 return 0;
1005 if (!strcasecmp(value, "true")
1006 || !strcasecmp(value, "yes")
1007 || !strcasecmp(value, "on"))
1008 return 1;
1009 if (!strcasecmp(value, "false")
1010 || !strcasecmp(value, "no")
1011 || !strcasecmp(value, "off"))
1012 return 0;
1013 return -1;
1016 int git_parse_maybe_bool(const char *value)
1018 int v = git_parse_maybe_bool_text(value);
1019 if (0 <= v)
1020 return v;
1021 if (git_parse_int(value, &v))
1022 return !!v;
1023 return -1;
1026 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1028 int v = git_parse_maybe_bool_text(value);
1029 if (0 <= v) {
1030 *is_bool = 1;
1031 return v;
1033 *is_bool = 0;
1034 return git_config_int(name, value);
1037 int git_config_bool(const char *name, const char *value)
1039 int discard;
1040 return !!git_config_bool_or_int(name, value, &discard);
1043 int git_config_string(const char **dest, const char *var, const char *value)
1045 if (!value)
1046 return config_error_nonbool(var);
1047 *dest = xstrdup(value);
1048 return 0;
1051 int git_config_pathname(const char **dest, const char *var, const char *value)
1053 if (!value)
1054 return config_error_nonbool(var);
1055 *dest = expand_user_path(value, 0);
1056 if (!*dest)
1057 die(_("failed to expand user dir in: '%s'"), value);
1058 return 0;
1061 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1063 if (!value)
1064 return config_error_nonbool(var);
1065 if (parse_expiry_date(value, timestamp))
1066 return error(_("'%s' for '%s' is not a valid timestamp"),
1067 value, var);
1068 return 0;
1071 int git_config_color(char *dest, const char *var, const char *value)
1073 if (!value)
1074 return config_error_nonbool(var);
1075 if (color_parse(value, dest) < 0)
1076 return -1;
1077 return 0;
1080 static int git_default_core_config(const char *var, const char *value)
1082 /* This needs a better name */
1083 if (!strcmp(var, "core.filemode")) {
1084 trust_executable_bit = git_config_bool(var, value);
1085 return 0;
1087 if (!strcmp(var, "core.trustctime")) {
1088 trust_ctime = git_config_bool(var, value);
1089 return 0;
1091 if (!strcmp(var, "core.checkstat")) {
1092 if (!strcasecmp(value, "default"))
1093 check_stat = 1;
1094 else if (!strcasecmp(value, "minimal"))
1095 check_stat = 0;
1098 if (!strcmp(var, "core.quotepath")) {
1099 quote_path_fully = git_config_bool(var, value);
1100 return 0;
1103 if (!strcmp(var, "core.symlinks")) {
1104 has_symlinks = git_config_bool(var, value);
1105 return 0;
1108 if (!strcmp(var, "core.ignorecase")) {
1109 ignore_case = git_config_bool(var, value);
1110 return 0;
1113 if (!strcmp(var, "core.attributesfile"))
1114 return git_config_pathname(&git_attributes_file, var, value);
1116 if (!strcmp(var, "core.hookspath"))
1117 return git_config_pathname(&git_hooks_path, var, value);
1119 if (!strcmp(var, "core.bare")) {
1120 is_bare_repository_cfg = git_config_bool(var, value);
1121 return 0;
1124 if (!strcmp(var, "core.ignorestat")) {
1125 assume_unchanged = git_config_bool(var, value);
1126 return 0;
1129 if (!strcmp(var, "core.prefersymlinkrefs")) {
1130 prefer_symlink_refs = git_config_bool(var, value);
1131 return 0;
1134 if (!strcmp(var, "core.logallrefupdates")) {
1135 if (value && !strcasecmp(value, "always"))
1136 log_all_ref_updates = LOG_REFS_ALWAYS;
1137 else if (git_config_bool(var, value))
1138 log_all_ref_updates = LOG_REFS_NORMAL;
1139 else
1140 log_all_ref_updates = LOG_REFS_NONE;
1141 return 0;
1144 if (!strcmp(var, "core.warnambiguousrefs")) {
1145 warn_ambiguous_refs = git_config_bool(var, value);
1146 return 0;
1149 if (!strcmp(var, "core.abbrev")) {
1150 if (!value)
1151 return config_error_nonbool(var);
1152 if (!strcasecmp(value, "auto"))
1153 default_abbrev = -1;
1154 else {
1155 int abbrev = git_config_int(var, value);
1156 if (abbrev < minimum_abbrev || abbrev > 40)
1157 return error("abbrev length out of range: %d", abbrev);
1158 default_abbrev = abbrev;
1160 return 0;
1163 if (!strcmp(var, "core.disambiguate"))
1164 return set_disambiguate_hint_config(var, value);
1166 if (!strcmp(var, "core.loosecompression")) {
1167 int level = git_config_int(var, value);
1168 if (level == -1)
1169 level = Z_DEFAULT_COMPRESSION;
1170 else if (level < 0 || level > Z_BEST_COMPRESSION)
1171 die(_("bad zlib compression level %d"), level);
1172 zlib_compression_level = level;
1173 zlib_compression_seen = 1;
1174 return 0;
1177 if (!strcmp(var, "core.compression")) {
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 core_compression_level = level;
1184 core_compression_seen = 1;
1185 if (!zlib_compression_seen)
1186 zlib_compression_level = level;
1187 if (!pack_compression_seen)
1188 pack_compression_level = level;
1189 return 0;
1192 if (!strcmp(var, "core.packedgitwindowsize")) {
1193 int pgsz_x2 = getpagesize() * 2;
1194 packed_git_window_size = git_config_ulong(var, value);
1196 /* This value must be multiple of (pagesize * 2) */
1197 packed_git_window_size /= pgsz_x2;
1198 if (packed_git_window_size < 1)
1199 packed_git_window_size = 1;
1200 packed_git_window_size *= pgsz_x2;
1201 return 0;
1204 if (!strcmp(var, "core.bigfilethreshold")) {
1205 big_file_threshold = git_config_ulong(var, value);
1206 return 0;
1209 if (!strcmp(var, "core.packedgitlimit")) {
1210 packed_git_limit = git_config_ulong(var, value);
1211 return 0;
1214 if (!strcmp(var, "core.deltabasecachelimit")) {
1215 delta_base_cache_limit = git_config_ulong(var, value);
1216 return 0;
1219 if (!strcmp(var, "core.autocrlf")) {
1220 if (value && !strcasecmp(value, "input")) {
1221 auto_crlf = AUTO_CRLF_INPUT;
1222 return 0;
1224 auto_crlf = git_config_bool(var, value);
1225 return 0;
1228 if (!strcmp(var, "core.safecrlf")) {
1229 int eol_rndtrp_die;
1230 if (value && !strcasecmp(value, "warn")) {
1231 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1232 return 0;
1234 eol_rndtrp_die = git_config_bool(var, value);
1235 global_conv_flags_eol = eol_rndtrp_die ?
1236 CONV_EOL_RNDTRP_DIE : CONV_EOL_RNDTRP_WARN;
1237 return 0;
1240 if (!strcmp(var, "core.eol")) {
1241 if (value && !strcasecmp(value, "lf"))
1242 core_eol = EOL_LF;
1243 else if (value && !strcasecmp(value, "crlf"))
1244 core_eol = EOL_CRLF;
1245 else if (value && !strcasecmp(value, "native"))
1246 core_eol = EOL_NATIVE;
1247 else
1248 core_eol = EOL_UNSET;
1249 return 0;
1252 if (!strcmp(var, "core.checkroundtripencoding")) {
1253 check_roundtrip_encoding = xstrdup(value);
1254 return 0;
1257 if (!strcmp(var, "core.notesref")) {
1258 notes_ref_name = xstrdup(value);
1259 return 0;
1262 if (!strcmp(var, "core.editor"))
1263 return git_config_string(&editor_program, var, value);
1265 if (!strcmp(var, "core.commentchar")) {
1266 if (!value)
1267 return config_error_nonbool(var);
1268 else if (!strcasecmp(value, "auto"))
1269 auto_comment_line_char = 1;
1270 else if (value[0] && !value[1]) {
1271 comment_line_char = value[0];
1272 auto_comment_line_char = 0;
1273 } else
1274 return error("core.commentChar should only be one character");
1275 return 0;
1278 if (!strcmp(var, "core.askpass"))
1279 return git_config_string(&askpass_program, var, value);
1281 if (!strcmp(var, "core.excludesfile"))
1282 return git_config_pathname(&excludes_file, var, value);
1284 if (!strcmp(var, "core.whitespace")) {
1285 if (!value)
1286 return config_error_nonbool(var);
1287 whitespace_rule_cfg = parse_whitespace_rule(value);
1288 return 0;
1291 if (!strcmp(var, "core.fsyncobjectfiles")) {
1292 fsync_object_files = git_config_bool(var, value);
1293 return 0;
1296 if (!strcmp(var, "core.preloadindex")) {
1297 core_preload_index = git_config_bool(var, value);
1298 return 0;
1301 if (!strcmp(var, "core.createobject")) {
1302 if (!strcmp(value, "rename"))
1303 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1304 else if (!strcmp(value, "link"))
1305 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1306 else
1307 die(_("invalid mode for object creation: %s"), value);
1308 return 0;
1311 if (!strcmp(var, "core.commitgraph")) {
1312 core_commit_graph = git_config_bool(var, value);
1313 return 0;
1316 if (!strcmp(var, "core.sparsecheckout")) {
1317 core_apply_sparse_checkout = git_config_bool(var, value);
1318 return 0;
1321 if (!strcmp(var, "core.precomposeunicode")) {
1322 precomposed_unicode = git_config_bool(var, value);
1323 return 0;
1326 if (!strcmp(var, "core.protecthfs")) {
1327 protect_hfs = git_config_bool(var, value);
1328 return 0;
1331 if (!strcmp(var, "core.protectntfs")) {
1332 protect_ntfs = git_config_bool(var, value);
1333 return 0;
1336 if (!strcmp(var, "core.hidedotfiles")) {
1337 if (value && !strcasecmp(value, "dotgitonly"))
1338 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1339 else
1340 hide_dotfiles = git_config_bool(var, value);
1341 return 0;
1344 if (!strcmp(var, "core.partialclonefilter")) {
1345 return git_config_string(&core_partial_clone_filter_default,
1346 var, value);
1349 /* Add other config variables here and to Documentation/config.txt. */
1350 return 0;
1353 static int git_default_i18n_config(const char *var, const char *value)
1355 if (!strcmp(var, "i18n.commitencoding"))
1356 return git_config_string(&git_commit_encoding, var, value);
1358 if (!strcmp(var, "i18n.logoutputencoding"))
1359 return git_config_string(&git_log_output_encoding, var, value);
1361 /* Add other config variables here and to Documentation/config.txt. */
1362 return 0;
1365 static int git_default_branch_config(const char *var, const char *value)
1367 if (!strcmp(var, "branch.autosetupmerge")) {
1368 if (value && !strcasecmp(value, "always")) {
1369 git_branch_track = BRANCH_TRACK_ALWAYS;
1370 return 0;
1372 git_branch_track = git_config_bool(var, value);
1373 return 0;
1375 if (!strcmp(var, "branch.autosetuprebase")) {
1376 if (!value)
1377 return config_error_nonbool(var);
1378 else if (!strcmp(value, "never"))
1379 autorebase = AUTOREBASE_NEVER;
1380 else if (!strcmp(value, "local"))
1381 autorebase = AUTOREBASE_LOCAL;
1382 else if (!strcmp(value, "remote"))
1383 autorebase = AUTOREBASE_REMOTE;
1384 else if (!strcmp(value, "always"))
1385 autorebase = AUTOREBASE_ALWAYS;
1386 else
1387 return error("malformed value for %s", var);
1388 return 0;
1391 /* Add other config variables here and to Documentation/config.txt. */
1392 return 0;
1395 static int git_default_push_config(const char *var, const char *value)
1397 if (!strcmp(var, "push.default")) {
1398 if (!value)
1399 return config_error_nonbool(var);
1400 else if (!strcmp(value, "nothing"))
1401 push_default = PUSH_DEFAULT_NOTHING;
1402 else if (!strcmp(value, "matching"))
1403 push_default = PUSH_DEFAULT_MATCHING;
1404 else if (!strcmp(value, "simple"))
1405 push_default = PUSH_DEFAULT_SIMPLE;
1406 else if (!strcmp(value, "upstream"))
1407 push_default = PUSH_DEFAULT_UPSTREAM;
1408 else if (!strcmp(value, "tracking")) /* deprecated */
1409 push_default = PUSH_DEFAULT_UPSTREAM;
1410 else if (!strcmp(value, "current"))
1411 push_default = PUSH_DEFAULT_CURRENT;
1412 else {
1413 error("malformed value for %s: %s", var, value);
1414 return error("Must be one of nothing, matching, simple, "
1415 "upstream or current.");
1417 return 0;
1420 /* Add other config variables here and to Documentation/config.txt. */
1421 return 0;
1424 static int git_default_mailmap_config(const char *var, const char *value)
1426 if (!strcmp(var, "mailmap.file"))
1427 return git_config_pathname(&git_mailmap_file, var, value);
1428 if (!strcmp(var, "mailmap.blob"))
1429 return git_config_string(&git_mailmap_blob, var, value);
1431 /* Add other config variables here and to Documentation/config.txt. */
1432 return 0;
1435 int git_default_config(const char *var, const char *value, void *dummy)
1437 if (starts_with(var, "core."))
1438 return git_default_core_config(var, value);
1440 if (starts_with(var, "user."))
1441 return git_ident_config(var, value, dummy);
1443 if (starts_with(var, "i18n."))
1444 return git_default_i18n_config(var, value);
1446 if (starts_with(var, "branch."))
1447 return git_default_branch_config(var, value);
1449 if (starts_with(var, "push."))
1450 return git_default_push_config(var, value);
1452 if (starts_with(var, "mailmap."))
1453 return git_default_mailmap_config(var, value);
1455 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1456 return git_default_advice_config(var, value);
1458 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1459 pager_use_color = git_config_bool(var,value);
1460 return 0;
1463 if (!strcmp(var, "pack.packsizelimit")) {
1464 pack_size_limit_cfg = git_config_ulong(var, value);
1465 return 0;
1468 if (!strcmp(var, "pack.compression")) {
1469 int level = git_config_int(var, value);
1470 if (level == -1)
1471 level = Z_DEFAULT_COMPRESSION;
1472 else if (level < 0 || level > Z_BEST_COMPRESSION)
1473 die(_("bad pack compression level %d"), level);
1474 pack_compression_level = level;
1475 pack_compression_seen = 1;
1476 return 0;
1479 /* Add other config variables here and to Documentation/config.txt. */
1480 return 0;
1484 * All source specific fields in the union, die_on_error, name and the callbacks
1485 * fgetc, ungetc, ftell of top need to be initialized before calling
1486 * this function.
1488 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1489 const struct config_options *opts)
1491 int ret;
1493 /* push config-file parsing state stack */
1494 top->prev = cf;
1495 top->linenr = 1;
1496 top->eof = 0;
1497 strbuf_init(&top->value, 1024);
1498 strbuf_init(&top->var, 1024);
1499 cf = top;
1501 ret = git_parse_source(fn, data, opts);
1503 /* pop config-file parsing state stack */
1504 strbuf_release(&top->value);
1505 strbuf_release(&top->var);
1506 cf = top->prev;
1508 return ret;
1511 static int do_config_from_file(config_fn_t fn,
1512 const enum config_origin_type origin_type,
1513 const char *name, const char *path, FILE *f,
1514 void *data, const struct config_options *opts)
1516 struct config_source top;
1517 int ret;
1519 top.u.file = f;
1520 top.origin_type = origin_type;
1521 top.name = name;
1522 top.path = path;
1523 top.die_on_error = 1;
1524 top.do_fgetc = config_file_fgetc;
1525 top.do_ungetc = config_file_ungetc;
1526 top.do_ftell = config_file_ftell;
1528 flockfile(f);
1529 ret = do_config_from(&top, fn, data, opts);
1530 funlockfile(f);
1531 return ret;
1534 static int git_config_from_stdin(config_fn_t fn, void *data)
1536 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1537 data, NULL);
1540 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1541 void *data,
1542 const struct config_options *opts)
1544 int ret = -1;
1545 FILE *f;
1547 f = fopen_or_warn(filename, "r");
1548 if (f) {
1549 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1550 filename, f, data, opts);
1551 fclose(f);
1553 return ret;
1556 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1558 return git_config_from_file_with_options(fn, filename, data, NULL);
1561 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1562 const char *name, const char *buf, size_t len, void *data)
1564 struct config_source top;
1566 top.u.buf.buf = buf;
1567 top.u.buf.len = len;
1568 top.u.buf.pos = 0;
1569 top.origin_type = origin_type;
1570 top.name = name;
1571 top.path = NULL;
1572 top.die_on_error = 0;
1573 top.do_fgetc = config_buf_fgetc;
1574 top.do_ungetc = config_buf_ungetc;
1575 top.do_ftell = config_buf_ftell;
1577 return do_config_from(&top, fn, data, NULL);
1580 int git_config_from_blob_oid(config_fn_t fn,
1581 const char *name,
1582 const struct object_id *oid,
1583 void *data)
1585 enum object_type type;
1586 char *buf;
1587 unsigned long size;
1588 int ret;
1590 buf = read_object_file(oid, &type, &size);
1591 if (!buf)
1592 return error("unable to load config blob object '%s'", name);
1593 if (type != OBJ_BLOB) {
1594 free(buf);
1595 return error("reference '%s' does not point to a blob", name);
1598 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1599 free(buf);
1601 return ret;
1604 static int git_config_from_blob_ref(config_fn_t fn,
1605 const char *name,
1606 void *data)
1608 struct object_id oid;
1610 if (get_oid(name, &oid) < 0)
1611 return error("unable to resolve config blob '%s'", name);
1612 return git_config_from_blob_oid(fn, name, &oid, data);
1615 const char *git_etc_gitconfig(void)
1617 static const char *system_wide;
1618 if (!system_wide)
1619 system_wide = system_path(ETC_GITCONFIG);
1620 return system_wide;
1624 * Parse environment variable 'k' as a boolean (in various
1625 * possible spellings); if missing, use the default value 'def'.
1627 int git_env_bool(const char *k, int def)
1629 const char *v = getenv(k);
1630 return v ? git_config_bool(k, v) : def;
1634 * Parse environment variable 'k' as ulong with possibly a unit
1635 * suffix; if missing, use the default value 'val'.
1637 unsigned long git_env_ulong(const char *k, unsigned long val)
1639 const char *v = getenv(k);
1640 if (v && !git_parse_ulong(v, &val))
1641 die("failed to parse %s", k);
1642 return val;
1645 int git_config_system(void)
1647 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1650 static int do_git_config_sequence(const struct config_options *opts,
1651 config_fn_t fn, void *data)
1653 int ret = 0;
1654 char *xdg_config = xdg_config_home("config");
1655 char *user_config = expand_user_path("~/.gitconfig", 0);
1656 char *repo_config;
1658 if (opts->commondir)
1659 repo_config = mkpathdup("%s/config", opts->commondir);
1660 else
1661 repo_config = NULL;
1663 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1664 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1665 ret += git_config_from_file(fn, git_etc_gitconfig(),
1666 data);
1668 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1669 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1670 ret += git_config_from_file(fn, xdg_config, data);
1672 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1673 ret += git_config_from_file(fn, user_config, data);
1675 current_parsing_scope = CONFIG_SCOPE_REPO;
1676 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1677 ret += git_config_from_file(fn, repo_config, data);
1679 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1680 if (git_config_from_parameters(fn, data) < 0)
1681 die(_("unable to parse command-line config"));
1683 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1684 free(xdg_config);
1685 free(user_config);
1686 free(repo_config);
1687 return ret;
1690 int config_with_options(config_fn_t fn, void *data,
1691 struct git_config_source *config_source,
1692 const struct config_options *opts)
1694 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1696 if (opts->respect_includes) {
1697 inc.fn = fn;
1698 inc.data = data;
1699 inc.opts = opts;
1700 fn = git_config_include;
1701 data = &inc;
1705 * If we have a specific filename, use it. Otherwise, follow the
1706 * regular lookup sequence.
1708 if (config_source && config_source->use_stdin)
1709 return git_config_from_stdin(fn, data);
1710 else if (config_source && config_source->file)
1711 return git_config_from_file(fn, config_source->file, data);
1712 else if (config_source && config_source->blob)
1713 return git_config_from_blob_ref(fn, config_source->blob, data);
1715 return do_git_config_sequence(opts, fn, data);
1718 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1720 int i, value_index;
1721 struct string_list *values;
1722 struct config_set_element *entry;
1723 struct configset_list *list = &cs->list;
1725 for (i = 0; i < list->nr; i++) {
1726 entry = list->items[i].e;
1727 value_index = list->items[i].value_index;
1728 values = &entry->value_list;
1730 current_config_kvi = values->items[value_index].util;
1732 if (fn(entry->key, values->items[value_index].string, data) < 0)
1733 git_die_config_linenr(entry->key,
1734 current_config_kvi->filename,
1735 current_config_kvi->linenr);
1737 current_config_kvi = NULL;
1741 void read_early_config(config_fn_t cb, void *data)
1743 struct config_options opts = {0};
1744 struct strbuf commondir = STRBUF_INIT;
1745 struct strbuf gitdir = STRBUF_INIT;
1747 opts.respect_includes = 1;
1749 if (have_git_dir()) {
1750 opts.commondir = get_git_common_dir();
1751 opts.git_dir = get_git_dir();
1753 * When setup_git_directory() was not yet asked to discover the
1754 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1755 * is any repository config we should use (but unlike
1756 * setup_git_directory_gently(), no global state is changed, most
1757 * notably, the current working directory is still the same after the
1758 * call).
1760 } else if (!discover_git_directory(&commondir, &gitdir)) {
1761 opts.commondir = commondir.buf;
1762 opts.git_dir = gitdir.buf;
1765 config_with_options(cb, data, NULL, &opts);
1767 strbuf_release(&commondir);
1768 strbuf_release(&gitdir);
1771 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1773 struct config_set_element k;
1774 struct config_set_element *found_entry;
1775 char *normalized_key;
1777 * `key` may come from the user, so normalize it before using it
1778 * for querying entries from the hashmap.
1780 if (git_config_parse_key(key, &normalized_key, NULL))
1781 return NULL;
1783 hashmap_entry_init(&k, strhash(normalized_key));
1784 k.key = normalized_key;
1785 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1786 free(normalized_key);
1787 return found_entry;
1790 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1792 struct config_set_element *e;
1793 struct string_list_item *si;
1794 struct configset_list_item *l_item;
1795 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1797 e = configset_find_element(cs, key);
1799 * Since the keys are being fed by git_config*() callback mechanism, they
1800 * are already normalized. So simply add them without any further munging.
1802 if (!e) {
1803 e = xmalloc(sizeof(*e));
1804 hashmap_entry_init(e, strhash(key));
1805 e->key = xstrdup(key);
1806 string_list_init(&e->value_list, 1);
1807 hashmap_add(&cs->config_hash, e);
1809 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1811 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1812 l_item = &cs->list.items[cs->list.nr++];
1813 l_item->e = e;
1814 l_item->value_index = e->value_list.nr - 1;
1816 if (!cf)
1817 die("BUG: configset_add_value has no source");
1818 if (cf->name) {
1819 kv_info->filename = strintern(cf->name);
1820 kv_info->linenr = cf->linenr;
1821 kv_info->origin_type = cf->origin_type;
1822 } else {
1823 /* for values read from `git_config_from_parameters()` */
1824 kv_info->filename = NULL;
1825 kv_info->linenr = -1;
1826 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1828 kv_info->scope = current_parsing_scope;
1829 si->util = kv_info;
1831 return 0;
1834 static int config_set_element_cmp(const void *unused_cmp_data,
1835 const void *entry,
1836 const void *entry_or_key,
1837 const void *unused_keydata)
1839 const struct config_set_element *e1 = entry;
1840 const struct config_set_element *e2 = entry_or_key;
1842 return strcmp(e1->key, e2->key);
1845 void git_configset_init(struct config_set *cs)
1847 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1848 cs->hash_initialized = 1;
1849 cs->list.nr = 0;
1850 cs->list.alloc = 0;
1851 cs->list.items = NULL;
1854 void git_configset_clear(struct config_set *cs)
1856 struct config_set_element *entry;
1857 struct hashmap_iter iter;
1858 if (!cs->hash_initialized)
1859 return;
1861 hashmap_iter_init(&cs->config_hash, &iter);
1862 while ((entry = hashmap_iter_next(&iter))) {
1863 free(entry->key);
1864 string_list_clear(&entry->value_list, 1);
1866 hashmap_free(&cs->config_hash, 1);
1867 cs->hash_initialized = 0;
1868 free(cs->list.items);
1869 cs->list.nr = 0;
1870 cs->list.alloc = 0;
1871 cs->list.items = NULL;
1874 static int config_set_callback(const char *key, const char *value, void *cb)
1876 struct config_set *cs = cb;
1877 configset_add_value(cs, key, value);
1878 return 0;
1881 int git_configset_add_file(struct config_set *cs, const char *filename)
1883 return git_config_from_file(config_set_callback, filename, cs);
1886 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1888 const struct string_list *values = NULL;
1890 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1891 * queried key in the files of the configset, the value returned will be the last
1892 * value in the value list for that key.
1894 values = git_configset_get_value_multi(cs, key);
1896 if (!values)
1897 return 1;
1898 assert(values->nr > 0);
1899 *value = values->items[values->nr - 1].string;
1900 return 0;
1903 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1905 struct config_set_element *e = configset_find_element(cs, key);
1906 return e ? &e->value_list : NULL;
1909 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1911 const char *value;
1912 if (!git_configset_get_value(cs, key, &value))
1913 return git_config_string(dest, key, value);
1914 else
1915 return 1;
1918 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1920 return git_configset_get_string_const(cs, key, (const char **)dest);
1923 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1925 const char *value;
1926 if (!git_configset_get_value(cs, key, &value)) {
1927 *dest = git_config_int(key, value);
1928 return 0;
1929 } else
1930 return 1;
1933 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1935 const char *value;
1936 if (!git_configset_get_value(cs, key, &value)) {
1937 *dest = git_config_ulong(key, value);
1938 return 0;
1939 } else
1940 return 1;
1943 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1945 const char *value;
1946 if (!git_configset_get_value(cs, key, &value)) {
1947 *dest = git_config_bool(key, value);
1948 return 0;
1949 } else
1950 return 1;
1953 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1954 int *is_bool, int *dest)
1956 const char *value;
1957 if (!git_configset_get_value(cs, key, &value)) {
1958 *dest = git_config_bool_or_int(key, value, is_bool);
1959 return 0;
1960 } else
1961 return 1;
1964 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1966 const char *value;
1967 if (!git_configset_get_value(cs, key, &value)) {
1968 *dest = git_parse_maybe_bool(value);
1969 if (*dest == -1)
1970 return -1;
1971 return 0;
1972 } else
1973 return 1;
1976 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1978 const char *value;
1979 if (!git_configset_get_value(cs, key, &value))
1980 return git_config_pathname(dest, key, value);
1981 else
1982 return 1;
1985 /* Functions use to read configuration from a repository */
1986 static void repo_read_config(struct repository *repo)
1988 struct config_options opts;
1990 opts.respect_includes = 1;
1991 opts.commondir = repo->commondir;
1992 opts.git_dir = repo->gitdir;
1994 if (!repo->config)
1995 repo->config = xcalloc(1, sizeof(struct config_set));
1996 else
1997 git_configset_clear(repo->config);
1999 git_configset_init(repo->config);
2001 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2003 * config_with_options() normally returns only
2004 * zero, as most errors are fatal, and
2005 * non-fatal potential errors are guarded by "if"
2006 * statements that are entered only when no error is
2007 * possible.
2009 * If we ever encounter a non-fatal error, it means
2010 * something went really wrong and we should stop
2011 * immediately.
2013 die(_("unknown error occurred while reading the configuration files"));
2016 static void git_config_check_init(struct repository *repo)
2018 if (repo->config && repo->config->hash_initialized)
2019 return;
2020 repo_read_config(repo);
2023 static void repo_config_clear(struct repository *repo)
2025 if (!repo->config || !repo->config->hash_initialized)
2026 return;
2027 git_configset_clear(repo->config);
2030 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2032 git_config_check_init(repo);
2033 configset_iter(repo->config, fn, data);
2036 int repo_config_get_value(struct repository *repo,
2037 const char *key, const char **value)
2039 git_config_check_init(repo);
2040 return git_configset_get_value(repo->config, key, value);
2043 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2044 const char *key)
2046 git_config_check_init(repo);
2047 return git_configset_get_value_multi(repo->config, key);
2050 int repo_config_get_string_const(struct repository *repo,
2051 const char *key, const char **dest)
2053 int ret;
2054 git_config_check_init(repo);
2055 ret = git_configset_get_string_const(repo->config, key, dest);
2056 if (ret < 0)
2057 git_die_config(key, NULL);
2058 return ret;
2061 int repo_config_get_string(struct repository *repo,
2062 const char *key, char **dest)
2064 git_config_check_init(repo);
2065 return repo_config_get_string_const(repo, key, (const char **)dest);
2068 int repo_config_get_int(struct repository *repo,
2069 const char *key, int *dest)
2071 git_config_check_init(repo);
2072 return git_configset_get_int(repo->config, key, dest);
2075 int repo_config_get_ulong(struct repository *repo,
2076 const char *key, unsigned long *dest)
2078 git_config_check_init(repo);
2079 return git_configset_get_ulong(repo->config, key, dest);
2082 int repo_config_get_bool(struct repository *repo,
2083 const char *key, int *dest)
2085 git_config_check_init(repo);
2086 return git_configset_get_bool(repo->config, key, dest);
2089 int repo_config_get_bool_or_int(struct repository *repo,
2090 const char *key, int *is_bool, int *dest)
2092 git_config_check_init(repo);
2093 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2096 int repo_config_get_maybe_bool(struct repository *repo,
2097 const char *key, int *dest)
2099 git_config_check_init(repo);
2100 return git_configset_get_maybe_bool(repo->config, key, dest);
2103 int repo_config_get_pathname(struct repository *repo,
2104 const char *key, const char **dest)
2106 int ret;
2107 git_config_check_init(repo);
2108 ret = git_configset_get_pathname(repo->config, key, dest);
2109 if (ret < 0)
2110 git_die_config(key, NULL);
2111 return ret;
2114 /* Functions used historically to read configuration from 'the_repository' */
2115 void git_config(config_fn_t fn, void *data)
2117 repo_config(the_repository, fn, data);
2120 void git_config_clear(void)
2122 repo_config_clear(the_repository);
2125 int git_config_get_value(const char *key, const char **value)
2127 return repo_config_get_value(the_repository, key, value);
2130 const struct string_list *git_config_get_value_multi(const char *key)
2132 return repo_config_get_value_multi(the_repository, key);
2135 int git_config_get_string_const(const char *key, const char **dest)
2137 return repo_config_get_string_const(the_repository, key, dest);
2140 int git_config_get_string(const char *key, char **dest)
2142 return repo_config_get_string(the_repository, key, dest);
2145 int git_config_get_int(const char *key, int *dest)
2147 return repo_config_get_int(the_repository, key, dest);
2150 int git_config_get_ulong(const char *key, unsigned long *dest)
2152 return repo_config_get_ulong(the_repository, key, dest);
2155 int git_config_get_bool(const char *key, int *dest)
2157 return repo_config_get_bool(the_repository, key, dest);
2160 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2162 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2165 int git_config_get_maybe_bool(const char *key, int *dest)
2167 return repo_config_get_maybe_bool(the_repository, key, dest);
2170 int git_config_get_pathname(const char *key, const char **dest)
2172 return repo_config_get_pathname(the_repository, key, dest);
2176 * Note: This function exists solely to maintain backward compatibility with
2177 * 'fetch' and 'update_clone' storing configuration in '.gitmodules' and should
2178 * NOT be used anywhere else.
2180 * Runs the provided config function on the '.gitmodules' file found in the
2181 * working directory.
2183 void config_from_gitmodules(config_fn_t fn, void *data)
2185 if (the_repository->worktree) {
2186 char *file = repo_worktree_path(the_repository, GITMODULES_FILE);
2187 git_config_from_file(fn, file, data);
2188 free(file);
2192 int git_config_get_expiry(const char *key, const char **output)
2194 int ret = git_config_get_string_const(key, output);
2195 if (ret)
2196 return ret;
2197 if (strcmp(*output, "now")) {
2198 timestamp_t now = approxidate("now");
2199 if (approxidate(*output) >= now)
2200 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2202 return ret;
2205 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2207 char *expiry_string;
2208 intmax_t days;
2209 timestamp_t when;
2211 if (git_config_get_string(key, &expiry_string))
2212 return 1; /* no such thing */
2214 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2215 const int scale = 86400;
2216 *expiry = now - days * scale;
2217 return 0;
2220 if (!parse_expiry_date(expiry_string, &when)) {
2221 *expiry = when;
2222 return 0;
2224 return -1; /* thing exists but cannot be parsed */
2227 int git_config_get_untracked_cache(void)
2229 int val = -1;
2230 const char *v;
2232 /* Hack for test programs like test-dump-untracked-cache */
2233 if (ignore_untracked_cache_config)
2234 return -1;
2236 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2237 return val;
2239 if (!git_config_get_value("core.untrackedcache", &v)) {
2240 if (!strcasecmp(v, "keep"))
2241 return -1;
2243 error(_("unknown core.untrackedCache value '%s'; "
2244 "using 'keep' default value"), v);
2245 return -1;
2248 return -1; /* default value */
2251 int git_config_get_split_index(void)
2253 int val;
2255 if (!git_config_get_maybe_bool("core.splitindex", &val))
2256 return val;
2258 return -1; /* default value */
2261 int git_config_get_max_percent_split_change(void)
2263 int val = -1;
2265 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2266 if (0 <= val && val <= 100)
2267 return val;
2269 return error(_("splitIndex.maxPercentChange value '%d' "
2270 "should be between 0 and 100"), val);
2273 return -1; /* default value */
2276 int git_config_get_fsmonitor(void)
2278 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2279 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2281 if (core_fsmonitor && !*core_fsmonitor)
2282 core_fsmonitor = NULL;
2284 if (core_fsmonitor)
2285 return 1;
2287 return 0;
2290 NORETURN
2291 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2293 if (!filename)
2294 die(_("unable to parse '%s' from command-line config"), key);
2295 else
2296 die(_("bad config variable '%s' in file '%s' at line %d"),
2297 key, filename, linenr);
2300 NORETURN __attribute__((format(printf, 2, 3)))
2301 void git_die_config(const char *key, const char *err, ...)
2303 const struct string_list *values;
2304 struct key_value_info *kv_info;
2306 if (err) {
2307 va_list params;
2308 va_start(params, err);
2309 vreportf("error: ", err, params);
2310 va_end(params);
2312 values = git_config_get_value_multi(key);
2313 kv_info = values->items[values->nr - 1].util;
2314 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2318 * Find all the stuff for git_config_set() below.
2321 struct config_store_data {
2322 int baselen;
2323 char *key;
2324 int do_not_match;
2325 regex_t *value_regex;
2326 int multi_replace;
2327 struct {
2328 size_t begin, end;
2329 enum config_event_t type;
2330 int is_keys_section;
2331 } *parsed;
2332 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2333 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2336 static int matches(const char *key, const char *value,
2337 const struct config_store_data *store)
2339 if (strcmp(key, store->key))
2340 return 0; /* not ours */
2341 if (!store->value_regex)
2342 return 1; /* always matches */
2343 if (store->value_regex == CONFIG_REGEX_NONE)
2344 return 0; /* never matches */
2346 return store->do_not_match ^
2347 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2350 static int store_aux_event(enum config_event_t type,
2351 size_t begin, size_t end, void *data)
2353 struct config_store_data *store = data;
2355 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2356 store->parsed[store->parsed_nr].begin = begin;
2357 store->parsed[store->parsed_nr].end = end;
2358 store->parsed[store->parsed_nr].type = type;
2360 if (type == CONFIG_EVENT_SECTION) {
2361 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2362 BUG("Invalid section name '%s'", cf->var.buf);
2364 /* Is this the section we were looking for? */
2365 store->is_keys_section =
2366 store->parsed[store->parsed_nr].is_keys_section =
2367 cf->var.len - 1 == store->baselen &&
2368 !strncasecmp(cf->var.buf, store->key, store->baselen);
2369 if (store->is_keys_section) {
2370 store->section_seen = 1;
2371 ALLOC_GROW(store->seen, store->seen_nr + 1,
2372 store->seen_alloc);
2373 store->seen[store->seen_nr] = store->parsed_nr;
2377 store->parsed_nr++;
2379 return 0;
2382 static int store_aux(const char *key, const char *value, void *cb)
2384 struct config_store_data *store = cb;
2386 if (store->key_seen) {
2387 if (matches(key, value, store)) {
2388 if (store->seen_nr == 1 && store->multi_replace == 0) {
2389 warning(_("%s has multiple values"), key);
2392 ALLOC_GROW(store->seen, store->seen_nr + 1,
2393 store->seen_alloc);
2395 store->seen[store->seen_nr] = store->parsed_nr;
2396 store->seen_nr++;
2398 } else if (store->is_keys_section) {
2400 * Do not increment matches yet: this may not be a match, but we
2401 * are in the desired section.
2403 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2404 store->seen[store->seen_nr] = store->parsed_nr;
2405 store->section_seen = 1;
2407 if (matches(key, value, store)) {
2408 store->seen_nr++;
2409 store->key_seen = 1;
2413 return 0;
2416 static int write_error(const char *filename)
2418 error("failed to write new configuration file %s", filename);
2420 /* Same error code as "failed to rename". */
2421 return 4;
2424 static struct strbuf store_create_section(const char *key,
2425 const struct config_store_data *store)
2427 const char *dot;
2428 int i;
2429 struct strbuf sb = STRBUF_INIT;
2431 dot = memchr(key, '.', store->baselen);
2432 if (dot) {
2433 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2434 for (i = dot - key + 1; i < store->baselen; i++) {
2435 if (key[i] == '"' || key[i] == '\\')
2436 strbuf_addch(&sb, '\\');
2437 strbuf_addch(&sb, key[i]);
2439 strbuf_addstr(&sb, "\"]\n");
2440 } else {
2441 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2444 return sb;
2447 static ssize_t write_section(int fd, const char *key,
2448 const struct config_store_data *store)
2450 struct strbuf sb = store_create_section(key, store);
2451 ssize_t ret;
2453 ret = write_in_full(fd, sb.buf, sb.len);
2454 strbuf_release(&sb);
2456 return ret;
2459 static ssize_t write_pair(int fd, const char *key, const char *value,
2460 const struct config_store_data *store)
2462 int i;
2463 ssize_t ret;
2464 int length = strlen(key + store->baselen + 1);
2465 const char *quote = "";
2466 struct strbuf sb = STRBUF_INIT;
2469 * Check to see if the value needs to be surrounded with a dq pair.
2470 * Note that problematic characters are always backslash-quoted; this
2471 * check is about not losing leading or trailing SP and strings that
2472 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2473 * configuration parser.
2475 if (value[0] == ' ')
2476 quote = "\"";
2477 for (i = 0; value[i]; i++)
2478 if (value[i] == ';' || value[i] == '#')
2479 quote = "\"";
2480 if (i && value[i - 1] == ' ')
2481 quote = "\"";
2483 strbuf_addf(&sb, "\t%.*s = %s",
2484 length, key + store->baselen + 1, quote);
2486 for (i = 0; value[i]; i++)
2487 switch (value[i]) {
2488 case '\n':
2489 strbuf_addstr(&sb, "\\n");
2490 break;
2491 case '\t':
2492 strbuf_addstr(&sb, "\\t");
2493 break;
2494 case '"':
2495 case '\\':
2496 strbuf_addch(&sb, '\\');
2497 /* fallthrough */
2498 default:
2499 strbuf_addch(&sb, value[i]);
2500 break;
2502 strbuf_addf(&sb, "%s\n", quote);
2504 ret = write_in_full(fd, sb.buf, sb.len);
2505 strbuf_release(&sb);
2507 return ret;
2511 * If we are about to unset the last key(s) in a section, and if there are
2512 * no comments surrounding (or included in) the section, we will want to
2513 * extend begin/end to remove the entire section.
2515 * Note: the parameter `seen_ptr` points to the index into the store.seen
2516 * array. * This index may be incremented if a section has more than one
2517 * entry (which all are to be removed).
2519 static void maybe_remove_section(struct config_store_data *store,
2520 const char *contents,
2521 size_t *begin_offset, size_t *end_offset,
2522 int *seen_ptr)
2524 size_t begin;
2525 int i, seen, section_seen = 0;
2528 * First, ensure that this is the first key, and that there are no
2529 * comments before the entry nor before the section header.
2531 seen = *seen_ptr;
2532 for (i = store->seen[seen]; i > 0; i--) {
2533 enum config_event_t type = store->parsed[i - 1].type;
2535 if (type == CONFIG_EVENT_COMMENT)
2536 /* There is a comment before this entry or section */
2537 return;
2538 if (type == CONFIG_EVENT_ENTRY) {
2539 if (!section_seen)
2540 /* This is not the section's first entry. */
2541 return;
2542 /* We encountered no comment before the section. */
2543 break;
2545 if (type == CONFIG_EVENT_SECTION) {
2546 if (!store->parsed[i - 1].is_keys_section)
2547 break;
2548 section_seen = 1;
2551 begin = store->parsed[i].begin;
2554 * Next, make sure that we are removing he last key(s) in the section,
2555 * and that there are no comments that are possibly about the current
2556 * section.
2558 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2559 enum config_event_t type = store->parsed[i].type;
2561 if (type == CONFIG_EVENT_COMMENT)
2562 return;
2563 if (type == CONFIG_EVENT_SECTION) {
2564 if (store->parsed[i].is_keys_section)
2565 continue;
2566 break;
2568 if (type == CONFIG_EVENT_ENTRY) {
2569 if (++seen < store->seen_nr &&
2570 i == store->seen[seen])
2571 /* We want to remove this entry, too */
2572 continue;
2573 /* There is another entry in this section. */
2574 return;
2579 * We are really removing the last entry/entries from this section, and
2580 * there are no enclosed or surrounding comments. Remove the entire,
2581 * now-empty section.
2583 *seen_ptr = seen;
2584 *begin_offset = begin;
2585 if (i < store->parsed_nr)
2586 *end_offset = store->parsed[i].begin;
2587 else
2588 *end_offset = store->parsed[store->parsed_nr - 1].end;
2591 int git_config_set_in_file_gently(const char *config_filename,
2592 const char *key, const char *value)
2594 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2597 void git_config_set_in_file(const char *config_filename,
2598 const char *key, const char *value)
2600 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2603 int git_config_set_gently(const char *key, const char *value)
2605 return git_config_set_multivar_gently(key, value, NULL, 0);
2608 void git_config_set(const char *key, const char *value)
2610 git_config_set_multivar(key, value, NULL, 0);
2614 * If value==NULL, unset in (remove from) config,
2615 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2616 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2617 * (only add a new one)
2618 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2619 * else all matching key/values (regardless how many) are removed,
2620 * before the new pair is written.
2622 * Returns 0 on success.
2624 * This function does this:
2626 * - it locks the config file by creating ".git/config.lock"
2628 * - it then parses the config using store_aux() as validator to find
2629 * the position on the key/value pair to replace. If it is to be unset,
2630 * it must be found exactly once.
2632 * - the config file is mmap()ed and the part before the match (if any) is
2633 * written to the lock file, then the changed part and the rest.
2635 * - the config file is removed and the lock file rename()d to it.
2638 int git_config_set_multivar_in_file_gently(const char *config_filename,
2639 const char *key, const char *value,
2640 const char *value_regex,
2641 int multi_replace)
2643 int fd = -1, in_fd = -1;
2644 int ret;
2645 struct lock_file lock = LOCK_INIT;
2646 char *filename_buf = NULL;
2647 char *contents = NULL;
2648 size_t contents_sz;
2649 struct config_store_data store;
2651 memset(&store, 0, sizeof(store));
2653 /* parse-key returns negative; flip the sign to feed exit(3) */
2654 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2655 if (ret)
2656 goto out_free;
2658 store.multi_replace = multi_replace;
2660 if (!config_filename)
2661 config_filename = filename_buf = git_pathdup("config");
2664 * The lock serves a purpose in addition to locking: the new
2665 * contents of .git/config will be written into it.
2667 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2668 if (fd < 0) {
2669 error_errno("could not lock config file %s", config_filename);
2670 free(store.key);
2671 ret = CONFIG_NO_LOCK;
2672 goto out_free;
2676 * If .git/config does not exist yet, write a minimal version.
2678 in_fd = open(config_filename, O_RDONLY);
2679 if ( in_fd < 0 ) {
2680 free(store.key);
2682 if ( ENOENT != errno ) {
2683 error_errno("opening %s", config_filename);
2684 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2685 goto out_free;
2687 /* if nothing to unset, error out */
2688 if (value == NULL) {
2689 ret = CONFIG_NOTHING_SET;
2690 goto out_free;
2693 store.key = (char *)key;
2694 if (write_section(fd, key, &store) < 0 ||
2695 write_pair(fd, key, value, &store) < 0)
2696 goto write_err_out;
2697 } else {
2698 struct stat st;
2699 size_t copy_begin, copy_end;
2700 int i, new_line = 0;
2701 struct config_options opts;
2703 if (value_regex == NULL)
2704 store.value_regex = NULL;
2705 else if (value_regex == CONFIG_REGEX_NONE)
2706 store.value_regex = CONFIG_REGEX_NONE;
2707 else {
2708 if (value_regex[0] == '!') {
2709 store.do_not_match = 1;
2710 value_regex++;
2711 } else
2712 store.do_not_match = 0;
2714 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2715 if (regcomp(store.value_regex, value_regex,
2716 REG_EXTENDED)) {
2717 error("invalid pattern: %s", value_regex);
2718 free(store.value_regex);
2719 ret = CONFIG_INVALID_PATTERN;
2720 goto out_free;
2724 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2725 store.parsed[0].end = 0;
2727 memset(&opts, 0, sizeof(opts));
2728 opts.event_fn = store_aux_event;
2729 opts.event_fn_data = &store;
2732 * After this, store.parsed will contain offsets of all the
2733 * parsed elements, and store.seen will contain a list of
2734 * matches, as indices into store.parsed.
2736 * As a side effect, we make sure to transform only a valid
2737 * existing config file.
2739 if (git_config_from_file_with_options(store_aux,
2740 config_filename,
2741 &store, &opts)) {
2742 error("invalid config file %s", config_filename);
2743 free(store.key);
2744 if (store.value_regex != NULL &&
2745 store.value_regex != CONFIG_REGEX_NONE) {
2746 regfree(store.value_regex);
2747 free(store.value_regex);
2749 ret = CONFIG_INVALID_FILE;
2750 goto out_free;
2753 free(store.key);
2754 if (store.value_regex != NULL &&
2755 store.value_regex != CONFIG_REGEX_NONE) {
2756 regfree(store.value_regex);
2757 free(store.value_regex);
2760 /* if nothing to unset, or too many matches, error out */
2761 if ((store.seen_nr == 0 && value == NULL) ||
2762 (store.seen_nr > 1 && multi_replace == 0)) {
2763 ret = CONFIG_NOTHING_SET;
2764 goto out_free;
2767 if (fstat(in_fd, &st) == -1) {
2768 error_errno(_("fstat on %s failed"), config_filename);
2769 ret = CONFIG_INVALID_FILE;
2770 goto out_free;
2773 contents_sz = xsize_t(st.st_size);
2774 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2775 MAP_PRIVATE, in_fd, 0);
2776 if (contents == MAP_FAILED) {
2777 if (errno == ENODEV && S_ISDIR(st.st_mode))
2778 errno = EISDIR;
2779 error_errno("unable to mmap '%s'", config_filename);
2780 ret = CONFIG_INVALID_FILE;
2781 contents = NULL;
2782 goto out_free;
2784 close(in_fd);
2785 in_fd = -1;
2787 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2788 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2789 ret = CONFIG_NO_WRITE;
2790 goto out_free;
2793 if (store.seen_nr == 0) {
2794 if (!store.seen_alloc) {
2795 /* Did not see key nor section */
2796 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2797 store.seen[0] = store.parsed_nr
2798 - !!store.parsed_nr;
2800 store.seen_nr = 1;
2803 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2804 size_t replace_end;
2805 int j = store.seen[i];
2807 new_line = 0;
2808 if (!store.key_seen) {
2809 copy_end = store.parsed[j].end;
2810 /* include '\n' when copying section header */
2811 if (copy_end > 0 && copy_end < contents_sz &&
2812 contents[copy_end - 1] != '\n' &&
2813 contents[copy_end] == '\n')
2814 copy_end++;
2815 replace_end = copy_end;
2816 } else {
2817 replace_end = store.parsed[j].end;
2818 copy_end = store.parsed[j].begin;
2819 if (!value)
2820 maybe_remove_section(&store, contents,
2821 &copy_end,
2822 &replace_end, &i);
2824 * Swallow preceding white-space on the same
2825 * line.
2827 while (copy_end > 0 ) {
2828 char c = contents[copy_end - 1];
2830 if (isspace(c) && c != '\n')
2831 copy_end--;
2832 else
2833 break;
2837 if (copy_end > 0 && contents[copy_end-1] != '\n')
2838 new_line = 1;
2840 /* write the first part of the config */
2841 if (copy_end > copy_begin) {
2842 if (write_in_full(fd, contents + copy_begin,
2843 copy_end - copy_begin) < 0)
2844 goto write_err_out;
2845 if (new_line &&
2846 write_str_in_full(fd, "\n") < 0)
2847 goto write_err_out;
2849 copy_begin = replace_end;
2852 /* write the pair (value == NULL means unset) */
2853 if (value != NULL) {
2854 if (!store.section_seen) {
2855 if (write_section(fd, key, &store) < 0)
2856 goto write_err_out;
2858 if (write_pair(fd, key, value, &store) < 0)
2859 goto write_err_out;
2862 /* write the rest of the config */
2863 if (copy_begin < contents_sz)
2864 if (write_in_full(fd, contents + copy_begin,
2865 contents_sz - copy_begin) < 0)
2866 goto write_err_out;
2868 munmap(contents, contents_sz);
2869 contents = NULL;
2872 if (commit_lock_file(&lock) < 0) {
2873 error_errno("could not write config file %s", config_filename);
2874 ret = CONFIG_NO_WRITE;
2875 goto out_free;
2878 ret = 0;
2880 /* Invalidate the config cache */
2881 git_config_clear();
2883 out_free:
2884 rollback_lock_file(&lock);
2885 free(filename_buf);
2886 if (contents)
2887 munmap(contents, contents_sz);
2888 if (in_fd >= 0)
2889 close(in_fd);
2890 return ret;
2892 write_err_out:
2893 ret = write_error(get_lock_file_path(&lock));
2894 goto out_free;
2898 void git_config_set_multivar_in_file(const char *config_filename,
2899 const char *key, const char *value,
2900 const char *value_regex, int multi_replace)
2902 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2903 value_regex, multi_replace))
2904 return;
2905 if (value)
2906 die(_("could not set '%s' to '%s'"), key, value);
2907 else
2908 die(_("could not unset '%s'"), key);
2911 int git_config_set_multivar_gently(const char *key, const char *value,
2912 const char *value_regex, int multi_replace)
2914 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2915 multi_replace);
2918 void git_config_set_multivar(const char *key, const char *value,
2919 const char *value_regex, int multi_replace)
2921 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2922 multi_replace);
2925 static int section_name_match (const char *buf, const char *name)
2927 int i = 0, j = 0, dot = 0;
2928 if (buf[i] != '[')
2929 return 0;
2930 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2931 if (!dot && isspace(buf[i])) {
2932 dot = 1;
2933 if (name[j++] != '.')
2934 break;
2935 for (i++; isspace(buf[i]); i++)
2936 ; /* do nothing */
2937 if (buf[i] != '"')
2938 break;
2939 continue;
2941 if (buf[i] == '\\' && dot)
2942 i++;
2943 else if (buf[i] == '"' && dot) {
2944 for (i++; isspace(buf[i]); i++)
2945 ; /* do_nothing */
2946 break;
2948 if (buf[i] != name[j++])
2949 break;
2951 if (buf[i] == ']' && name[j] == 0) {
2953 * We match, now just find the right length offset by
2954 * gobbling up any whitespace after it, as well
2956 i++;
2957 for (; buf[i] && isspace(buf[i]); i++)
2958 ; /* do nothing */
2959 return i;
2961 return 0;
2964 static int section_name_is_ok(const char *name)
2966 /* Empty section names are bogus. */
2967 if (!*name)
2968 return 0;
2971 * Before a dot, we must be alphanumeric or dash. After the first dot,
2972 * anything goes, so we can stop checking.
2974 for (; *name && *name != '.'; name++)
2975 if (*name != '-' && !isalnum(*name))
2976 return 0;
2977 return 1;
2980 /* if new_name == NULL, the section is removed instead */
2981 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
2982 const char *old_name,
2983 const char *new_name, int copy)
2985 int ret = 0, remove = 0;
2986 char *filename_buf = NULL;
2987 struct lock_file lock = LOCK_INIT;
2988 int out_fd;
2989 char buf[1024];
2990 FILE *config_file = NULL;
2991 struct stat st;
2992 struct strbuf copystr = STRBUF_INIT;
2993 struct config_store_data store;
2995 memset(&store, 0, sizeof(store));
2997 if (new_name && !section_name_is_ok(new_name)) {
2998 ret = error("invalid section name: %s", new_name);
2999 goto out_no_rollback;
3002 if (!config_filename)
3003 config_filename = filename_buf = git_pathdup("config");
3005 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3006 if (out_fd < 0) {
3007 ret = error("could not lock config file %s", config_filename);
3008 goto out;
3011 if (!(config_file = fopen(config_filename, "rb"))) {
3012 ret = warn_on_fopen_errors(config_filename);
3013 if (ret)
3014 goto out;
3015 /* no config file means nothing to rename, no error */
3016 goto commit_and_out;
3019 if (fstat(fileno(config_file), &st) == -1) {
3020 ret = error_errno(_("fstat on %s failed"), config_filename);
3021 goto out;
3024 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3025 ret = error_errno("chmod on %s failed",
3026 get_lock_file_path(&lock));
3027 goto out;
3030 while (fgets(buf, sizeof(buf), config_file)) {
3031 int i;
3032 int length;
3033 int is_section = 0;
3034 char *output = buf;
3035 for (i = 0; buf[i] && isspace(buf[i]); i++)
3036 ; /* do nothing */
3037 if (buf[i] == '[') {
3038 /* it's a section */
3039 int offset;
3040 is_section = 1;
3043 * When encountering a new section under -c we
3044 * need to flush out any section we're already
3045 * coping and begin anew. There might be
3046 * multiple [branch "$name"] sections.
3048 if (copystr.len > 0) {
3049 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3050 ret = write_error(get_lock_file_path(&lock));
3051 goto out;
3053 strbuf_reset(&copystr);
3056 offset = section_name_match(&buf[i], old_name);
3057 if (offset > 0) {
3058 ret++;
3059 if (new_name == NULL) {
3060 remove = 1;
3061 continue;
3063 store.baselen = strlen(new_name);
3064 if (!copy) {
3065 if (write_section(out_fd, new_name, &store) < 0) {
3066 ret = write_error(get_lock_file_path(&lock));
3067 goto out;
3070 * We wrote out the new section, with
3071 * a newline, now skip the old
3072 * section's length
3074 output += offset + i;
3075 if (strlen(output) > 0) {
3077 * More content means there's
3078 * a declaration to put on the
3079 * next line; indent with a
3080 * tab
3082 output -= 1;
3083 output[0] = '\t';
3085 } else {
3086 copystr = store_create_section(new_name, &store);
3089 remove = 0;
3091 if (remove)
3092 continue;
3093 length = strlen(output);
3095 if (!is_section && copystr.len > 0) {
3096 strbuf_add(&copystr, output, length);
3099 if (write_in_full(out_fd, output, length) < 0) {
3100 ret = write_error(get_lock_file_path(&lock));
3101 goto out;
3106 * Copy a trailing section at the end of the config, won't be
3107 * flushed by the usual "flush because we have a new section
3108 * logic in the loop above.
3110 if (copystr.len > 0) {
3111 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3112 ret = write_error(get_lock_file_path(&lock));
3113 goto out;
3115 strbuf_reset(&copystr);
3118 fclose(config_file);
3119 config_file = NULL;
3120 commit_and_out:
3121 if (commit_lock_file(&lock) < 0)
3122 ret = error_errno("could not write config file %s",
3123 config_filename);
3124 out:
3125 if (config_file)
3126 fclose(config_file);
3127 rollback_lock_file(&lock);
3128 out_no_rollback:
3129 free(filename_buf);
3130 return ret;
3133 int git_config_rename_section_in_file(const char *config_filename,
3134 const char *old_name, const char *new_name)
3136 return git_config_copy_or_rename_section_in_file(config_filename,
3137 old_name, new_name, 0);
3140 int git_config_rename_section(const char *old_name, const char *new_name)
3142 return git_config_rename_section_in_file(NULL, old_name, new_name);
3145 int git_config_copy_section_in_file(const char *config_filename,
3146 const char *old_name, const char *new_name)
3148 return git_config_copy_or_rename_section_in_file(config_filename,
3149 old_name, new_name, 1);
3152 int git_config_copy_section(const char *old_name, const char *new_name)
3154 return git_config_copy_section_in_file(NULL, old_name, new_name);
3158 * Call this to report error for your variable that should not
3159 * get a boolean value (i.e. "[my] var" means "true").
3161 #undef config_error_nonbool
3162 int config_error_nonbool(const char *var)
3164 return error("missing value for '%s'", var);
3167 int parse_config_key(const char *var,
3168 const char *section,
3169 const char **subsection, int *subsection_len,
3170 const char **key)
3172 const char *dot;
3174 /* Does it start with "section." ? */
3175 if (!skip_prefix(var, section, &var) || *var != '.')
3176 return -1;
3179 * Find the key; we don't know yet if we have a subsection, but we must
3180 * parse backwards from the end, since the subsection may have dots in
3181 * it, too.
3183 dot = strrchr(var, '.');
3184 *key = dot + 1;
3186 /* Did we have a subsection at all? */
3187 if (dot == var) {
3188 if (subsection) {
3189 *subsection = NULL;
3190 *subsection_len = 0;
3193 else {
3194 if (!subsection)
3195 return -1;
3196 *subsection = var + 1;
3197 *subsection_len = dot - *subsection;
3200 return 0;
3203 const char *current_config_origin_type(void)
3205 int type;
3206 if (current_config_kvi)
3207 type = current_config_kvi->origin_type;
3208 else if(cf)
3209 type = cf->origin_type;
3210 else
3211 die("BUG: current_config_origin_type called outside config callback");
3213 switch (type) {
3214 case CONFIG_ORIGIN_BLOB:
3215 return "blob";
3216 case CONFIG_ORIGIN_FILE:
3217 return "file";
3218 case CONFIG_ORIGIN_STDIN:
3219 return "standard input";
3220 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3221 return "submodule-blob";
3222 case CONFIG_ORIGIN_CMDLINE:
3223 return "command line";
3224 default:
3225 die("BUG: unknown config origin type");
3229 const char *current_config_name(void)
3231 const char *name;
3232 if (current_config_kvi)
3233 name = current_config_kvi->filename;
3234 else if (cf)
3235 name = cf->name;
3236 else
3237 die("BUG: current_config_name called outside config callback");
3238 return name ? name : "";
3241 enum config_scope current_config_scope(void)
3243 if (current_config_kvi)
3244 return current_config_kvi->scope;
3245 else
3246 return current_parsing_scope;