Merge branch 'tq/t1510'
[git/raj.git] / config.c
blob9f8ca18f7b2b6f5423c2833df690ff4c3da1a4d9
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"
20 struct config_source {
21 struct config_source *prev;
22 union {
23 FILE *file;
24 struct config_buf {
25 const char *buf;
26 size_t len;
27 size_t pos;
28 } buf;
29 } u;
30 enum config_origin_type origin_type;
31 const char *name;
32 const char *path;
33 int die_on_error;
34 int linenr;
35 int eof;
36 struct strbuf value;
37 struct strbuf var;
39 int (*do_fgetc)(struct config_source *c);
40 int (*do_ungetc)(int c, struct config_source *conf);
41 long (*do_ftell)(struct config_source *c);
45 * These variables record the "current" config source, which
46 * can be accessed by parsing callbacks.
48 * The "cf" variable will be non-NULL only when we are actually parsing a real
49 * config source (file, blob, cmdline, etc).
51 * The "current_config_kvi" variable will be non-NULL only when we are feeding
52 * cached config from a configset into a callback.
54 * They should generally never be non-NULL at the same time. If they are both
55 * NULL, then we aren't parsing anything (and depending on the function looking
56 * at the variables, it's either a bug for it to be called in the first place,
57 * or it's a function which can be reused for non-config purposes, and should
58 * fall back to some sane behavior).
60 static struct config_source *cf;
61 static struct key_value_info *current_config_kvi;
64 * Similar to the variables above, this gives access to the "scope" of the
65 * current value (repo, global, etc). For cached values, it can be found via
66 * the current_config_kvi as above. During parsing, the current value can be
67 * found in this variable. It's not part of "cf" because it transcends a single
68 * file (i.e., a file included from .git/config is still in "repo" scope).
70 static enum config_scope current_parsing_scope;
72 static int core_compression_seen;
73 static int pack_compression_seen;
74 static int zlib_compression_seen;
76 static int config_file_fgetc(struct config_source *conf)
78 return getc_unlocked(conf->u.file);
81 static int config_file_ungetc(int c, struct config_source *conf)
83 return ungetc(c, conf->u.file);
86 static long config_file_ftell(struct config_source *conf)
88 return ftell(conf->u.file);
92 static int config_buf_fgetc(struct config_source *conf)
94 if (conf->u.buf.pos < conf->u.buf.len)
95 return conf->u.buf.buf[conf->u.buf.pos++];
97 return EOF;
100 static int config_buf_ungetc(int c, struct config_source *conf)
102 if (conf->u.buf.pos > 0) {
103 conf->u.buf.pos--;
104 if (conf->u.buf.buf[conf->u.buf.pos] != c)
105 die("BUG: config_buf can only ungetc the same character");
106 return c;
109 return EOF;
112 static long config_buf_ftell(struct config_source *conf)
114 return conf->u.buf.pos;
117 #define MAX_INCLUDE_DEPTH 10
118 static const char include_depth_advice[] =
119 "exceeded maximum include depth (%d) while including\n"
120 " %s\n"
121 "from\n"
122 " %s\n"
123 "Do you have circular includes?";
124 static int handle_path_include(const char *path, struct config_include_data *inc)
126 int ret = 0;
127 struct strbuf buf = STRBUF_INIT;
128 char *expanded;
130 if (!path)
131 return config_error_nonbool("include.path");
133 expanded = expand_user_path(path, 0);
134 if (!expanded)
135 return error("could not expand include path '%s'", path);
136 path = expanded;
139 * Use an absolute path as-is, but interpret relative paths
140 * based on the including config file.
142 if (!is_absolute_path(path)) {
143 char *slash;
145 if (!cf || !cf->path)
146 return error("relative config includes must come from files");
148 slash = find_last_dir_sep(cf->path);
149 if (slash)
150 strbuf_add(&buf, cf->path, slash - cf->path + 1);
151 strbuf_addstr(&buf, path);
152 path = buf.buf;
155 if (!access_or_die(path, R_OK, 0)) {
156 if (++inc->depth > MAX_INCLUDE_DEPTH)
157 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
158 !cf ? "<unknown>" :
159 cf->name ? cf->name :
160 "the command line");
161 ret = git_config_from_file(git_config_include, path, inc);
162 inc->depth--;
164 strbuf_release(&buf);
165 free(expanded);
166 return ret;
169 static int prepare_include_condition_pattern(struct strbuf *pat)
171 struct strbuf path = STRBUF_INIT;
172 char *expanded;
173 int prefix = 0;
175 expanded = expand_user_path(pat->buf, 1);
176 if (expanded) {
177 strbuf_reset(pat);
178 strbuf_addstr(pat, expanded);
179 free(expanded);
182 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
183 const char *slash;
185 if (!cf || !cf->path)
186 return error(_("relative config include "
187 "conditionals must come from files"));
189 strbuf_realpath(&path, cf->path, 1);
190 slash = find_last_dir_sep(path.buf);
191 if (!slash)
192 die("BUG: how is this possible?");
193 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
194 prefix = slash - path.buf + 1 /* slash */;
195 } else if (!is_absolute_path(pat->buf))
196 strbuf_insert(pat, 0, "**/", 3);
198 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
199 strbuf_addstr(pat, "**");
201 strbuf_release(&path);
202 return prefix;
205 static int include_by_gitdir(const struct config_options *opts,
206 const char *cond, size_t cond_len, int icase)
208 struct strbuf text = STRBUF_INIT;
209 struct strbuf pattern = STRBUF_INIT;
210 int ret = 0, prefix;
211 const char *git_dir;
212 int already_tried_absolute = 0;
214 if (opts->git_dir)
215 git_dir = opts->git_dir;
216 else
217 goto done;
219 strbuf_realpath(&text, git_dir, 1);
220 strbuf_add(&pattern, cond, cond_len);
221 prefix = prepare_include_condition_pattern(&pattern);
223 again:
224 if (prefix < 0)
225 goto done;
227 if (prefix > 0) {
229 * perform literal matching on the prefix part so that
230 * any wildcard character in it can't create side effects.
232 if (text.len < prefix)
233 goto done;
234 if (!icase && strncmp(pattern.buf, text.buf, prefix))
235 goto done;
236 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
237 goto done;
240 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
241 icase ? WM_CASEFOLD : 0);
243 if (!ret && !already_tried_absolute) {
245 * We've tried e.g. matching gitdir:~/work, but if
246 * ~/work is a symlink to /mnt/storage/work
247 * strbuf_realpath() will expand it, so the rule won't
248 * match. Let's match against a
249 * strbuf_add_absolute_path() version of the path,
250 * which'll do the right thing
252 strbuf_reset(&text);
253 strbuf_add_absolute_path(&text, git_dir);
254 already_tried_absolute = 1;
255 goto again;
257 done:
258 strbuf_release(&pattern);
259 strbuf_release(&text);
260 return ret;
263 static int include_condition_is_true(const struct config_options *opts,
264 const char *cond, size_t cond_len)
267 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
268 return include_by_gitdir(opts, cond, cond_len, 0);
269 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
270 return include_by_gitdir(opts, cond, cond_len, 1);
272 /* unknown conditionals are always false */
273 return 0;
276 int git_config_include(const char *var, const char *value, void *data)
278 struct config_include_data *inc = data;
279 const char *cond, *key;
280 int cond_len;
281 int ret;
284 * Pass along all values, including "include" directives; this makes it
285 * possible to query information on the includes themselves.
287 ret = inc->fn(var, value, inc->data);
288 if (ret < 0)
289 return ret;
291 if (!strcmp(var, "include.path"))
292 ret = handle_path_include(value, inc);
294 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
295 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
296 !strcmp(key, "path"))
297 ret = handle_path_include(value, inc);
299 return ret;
302 void git_config_push_parameter(const char *text)
304 struct strbuf env = STRBUF_INIT;
305 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
306 if (old && *old) {
307 strbuf_addstr(&env, old);
308 strbuf_addch(&env, ' ');
310 sq_quote_buf(&env, text);
311 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
312 strbuf_release(&env);
315 static inline int iskeychar(int c)
317 return isalnum(c) || c == '-';
321 * Auxiliary function to sanity-check and split the key into the section
322 * identifier and variable name.
324 * Returns 0 on success, -1 when there is an invalid character in the key and
325 * -2 if there is no section name in the key.
327 * store_key - pointer to char* which will hold a copy of the key with
328 * lowercase section and variable name
329 * baselen - pointer to int which will hold the length of the
330 * section + subsection part, can be NULL
332 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
334 int i, dot, baselen;
335 const char *last_dot = strrchr(key, '.');
338 * Since "key" actually contains the section name and the real
339 * key name separated by a dot, we have to know where the dot is.
342 if (last_dot == NULL || last_dot == key) {
343 if (!quiet)
344 error("key does not contain a section: %s", key);
345 return -CONFIG_NO_SECTION_OR_NAME;
348 if (!last_dot[1]) {
349 if (!quiet)
350 error("key does not contain variable name: %s", key);
351 return -CONFIG_NO_SECTION_OR_NAME;
354 baselen = last_dot - key;
355 if (baselen_)
356 *baselen_ = baselen;
359 * Validate the key and while at it, lower case it for matching.
361 if (store_key)
362 *store_key = xmallocz(strlen(key));
364 dot = 0;
365 for (i = 0; key[i]; i++) {
366 unsigned char c = key[i];
367 if (c == '.')
368 dot = 1;
369 /* Leave the extended basename untouched.. */
370 if (!dot || i > baselen) {
371 if (!iskeychar(c) ||
372 (i == baselen + 1 && !isalpha(c))) {
373 if (!quiet)
374 error("invalid key: %s", key);
375 goto out_free_ret_1;
377 c = tolower(c);
378 } else if (c == '\n') {
379 if (!quiet)
380 error("invalid key (newline): %s", key);
381 goto out_free_ret_1;
383 if (store_key)
384 (*store_key)[i] = c;
387 return 0;
389 out_free_ret_1:
390 if (store_key) {
391 FREE_AND_NULL(*store_key);
393 return -CONFIG_INVALID_KEY;
396 int git_config_parse_key(const char *key, char **store_key, int *baselen)
398 return git_config_parse_key_1(key, store_key, baselen, 0);
401 int git_config_key_is_valid(const char *key)
403 return !git_config_parse_key_1(key, NULL, NULL, 1);
406 int git_config_parse_parameter(const char *text,
407 config_fn_t fn, void *data)
409 const char *value;
410 char *canonical_name;
411 struct strbuf **pair;
412 int ret;
414 pair = strbuf_split_str(text, '=', 2);
415 if (!pair[0])
416 return error("bogus config parameter: %s", text);
418 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
419 strbuf_setlen(pair[0], pair[0]->len - 1);
420 value = pair[1] ? pair[1]->buf : "";
421 } else {
422 value = NULL;
425 strbuf_trim(pair[0]);
426 if (!pair[0]->len) {
427 strbuf_list_free(pair);
428 return error("bogus config parameter: %s", text);
431 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
432 ret = -1;
433 } else {
434 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
435 free(canonical_name);
437 strbuf_list_free(pair);
438 return ret;
441 int git_config_from_parameters(config_fn_t fn, void *data)
443 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
444 int ret = 0;
445 char *envw;
446 const char **argv = NULL;
447 int nr = 0, alloc = 0;
448 int i;
449 struct config_source source;
451 if (!env)
452 return 0;
454 memset(&source, 0, sizeof(source));
455 source.prev = cf;
456 source.origin_type = CONFIG_ORIGIN_CMDLINE;
457 cf = &source;
459 /* sq_dequote will write over it */
460 envw = xstrdup(env);
462 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
463 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
464 goto out;
467 for (i = 0; i < nr; i++) {
468 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
469 ret = -1;
470 goto out;
474 out:
475 free(argv);
476 free(envw);
477 cf = source.prev;
478 return ret;
481 static int get_next_char(void)
483 int c = cf->do_fgetc(cf);
485 if (c == '\r') {
486 /* DOS like systems */
487 c = cf->do_fgetc(cf);
488 if (c != '\n') {
489 if (c != EOF)
490 cf->do_ungetc(c, cf);
491 c = '\r';
494 if (c == '\n')
495 cf->linenr++;
496 if (c == EOF) {
497 cf->eof = 1;
498 cf->linenr++;
499 c = '\n';
501 return c;
504 static char *parse_value(void)
506 int quote = 0, comment = 0, space = 0;
508 strbuf_reset(&cf->value);
509 for (;;) {
510 int c = get_next_char();
511 if (c == '\n') {
512 if (quote) {
513 cf->linenr--;
514 return NULL;
516 return cf->value.buf;
518 if (comment)
519 continue;
520 if (isspace(c) && !quote) {
521 if (cf->value.len)
522 space++;
523 continue;
525 if (!quote) {
526 if (c == ';' || c == '#') {
527 comment = 1;
528 continue;
531 for (; space; space--)
532 strbuf_addch(&cf->value, ' ');
533 if (c == '\\') {
534 c = get_next_char();
535 switch (c) {
536 case '\n':
537 continue;
538 case 't':
539 c = '\t';
540 break;
541 case 'b':
542 c = '\b';
543 break;
544 case 'n':
545 c = '\n';
546 break;
547 /* Some characters escape as themselves */
548 case '\\': case '"':
549 break;
550 /* Reject unknown escape sequences */
551 default:
552 return NULL;
554 strbuf_addch(&cf->value, c);
555 continue;
557 if (c == '"') {
558 quote = 1-quote;
559 continue;
561 strbuf_addch(&cf->value, c);
565 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
567 int c;
568 char *value;
569 int ret;
571 /* Get the full name */
572 for (;;) {
573 c = get_next_char();
574 if (cf->eof)
575 break;
576 if (!iskeychar(c))
577 break;
578 strbuf_addch(name, tolower(c));
581 while (c == ' ' || c == '\t')
582 c = get_next_char();
584 value = NULL;
585 if (c != '\n') {
586 if (c != '=')
587 return -1;
588 value = parse_value();
589 if (!value)
590 return -1;
593 * We already consumed the \n, but we need linenr to point to
594 * the line we just parsed during the call to fn to get
595 * accurate line number in error messages.
597 cf->linenr--;
598 ret = fn(name->buf, value, data);
599 if (ret >= 0)
600 cf->linenr++;
601 return ret;
604 static int get_extended_base_var(struct strbuf *name, int c)
606 do {
607 if (c == '\n')
608 goto error_incomplete_line;
609 c = get_next_char();
610 } while (isspace(c));
612 /* We require the format to be '[base "extension"]' */
613 if (c != '"')
614 return -1;
615 strbuf_addch(name, '.');
617 for (;;) {
618 int c = get_next_char();
619 if (c == '\n')
620 goto error_incomplete_line;
621 if (c == '"')
622 break;
623 if (c == '\\') {
624 c = get_next_char();
625 if (c == '\n')
626 goto error_incomplete_line;
628 strbuf_addch(name, c);
631 /* Final ']' */
632 if (get_next_char() != ']')
633 return -1;
634 return 0;
635 error_incomplete_line:
636 cf->linenr--;
637 return -1;
640 static int get_base_var(struct strbuf *name)
642 for (;;) {
643 int c = get_next_char();
644 if (cf->eof)
645 return -1;
646 if (c == ']')
647 return 0;
648 if (isspace(c))
649 return get_extended_base_var(name, c);
650 if (!iskeychar(c) && c != '.')
651 return -1;
652 strbuf_addch(name, tolower(c));
656 struct parse_event_data {
657 enum config_event_t previous_type;
658 size_t previous_offset;
659 const struct config_options *opts;
662 static int do_event(enum config_event_t type, struct parse_event_data *data)
664 size_t offset;
666 if (!data->opts || !data->opts->event_fn)
667 return 0;
669 if (type == CONFIG_EVENT_WHITESPACE &&
670 data->previous_type == type)
671 return 0;
673 offset = cf->do_ftell(cf);
675 * At EOF, the parser always "inserts" an extra '\n', therefore
676 * the end offset of the event is the current file position, otherwise
677 * we will already have advanced to the next event.
679 if (type != CONFIG_EVENT_EOF)
680 offset--;
682 if (data->previous_type != CONFIG_EVENT_EOF &&
683 data->opts->event_fn(data->previous_type, data->previous_offset,
684 offset, data->opts->event_fn_data) < 0)
685 return -1;
687 data->previous_type = type;
688 data->previous_offset = offset;
690 return 0;
693 static int git_parse_source(config_fn_t fn, void *data,
694 const struct config_options *opts)
696 int comment = 0;
697 int baselen = 0;
698 struct strbuf *var = &cf->var;
699 int error_return = 0;
700 char *error_msg = NULL;
702 /* U+FEFF Byte Order Mark in UTF8 */
703 const char *bomptr = utf8_bom;
705 /* For the parser event callback */
706 struct parse_event_data event_data = {
707 CONFIG_EVENT_EOF, 0, opts
710 for (;;) {
711 int c;
713 c = get_next_char();
714 if (bomptr && *bomptr) {
715 /* We are at the file beginning; skip UTF8-encoded BOM
716 * if present. Sane editors won't put this in on their
717 * own, but e.g. Windows Notepad will do it happily. */
718 if (c == (*bomptr & 0377)) {
719 bomptr++;
720 continue;
721 } else {
722 /* Do not tolerate partial BOM. */
723 if (bomptr != utf8_bom)
724 break;
725 /* No BOM at file beginning. Cool. */
726 bomptr = NULL;
729 if (c == '\n') {
730 if (cf->eof) {
731 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
732 return -1;
733 return 0;
735 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
736 return -1;
737 comment = 0;
738 continue;
740 if (comment)
741 continue;
742 if (isspace(c)) {
743 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
744 return -1;
745 continue;
747 if (c == '#' || c == ';') {
748 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
749 return -1;
750 comment = 1;
751 continue;
753 if (c == '[') {
754 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
755 return -1;
757 /* Reset prior to determining a new stem */
758 strbuf_reset(var);
759 if (get_base_var(var) < 0 || var->len < 1)
760 break;
761 strbuf_addch(var, '.');
762 baselen = var->len;
763 continue;
765 if (!isalpha(c))
766 break;
768 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
769 return -1;
772 * Truncate the var name back to the section header
773 * stem prior to grabbing the suffix part of the name
774 * and the value.
776 strbuf_setlen(var, baselen);
777 strbuf_addch(var, tolower(c));
778 if (get_value(fn, data, var) < 0)
779 break;
782 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
783 return -1;
785 switch (cf->origin_type) {
786 case CONFIG_ORIGIN_BLOB:
787 error_msg = xstrfmt(_("bad config line %d in blob %s"),
788 cf->linenr, cf->name);
789 break;
790 case CONFIG_ORIGIN_FILE:
791 error_msg = xstrfmt(_("bad config line %d in file %s"),
792 cf->linenr, cf->name);
793 break;
794 case CONFIG_ORIGIN_STDIN:
795 error_msg = xstrfmt(_("bad config line %d in standard input"),
796 cf->linenr);
797 break;
798 case CONFIG_ORIGIN_SUBMODULE_BLOB:
799 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
800 cf->linenr, cf->name);
801 break;
802 case CONFIG_ORIGIN_CMDLINE:
803 error_msg = xstrfmt(_("bad config line %d in command line %s"),
804 cf->linenr, cf->name);
805 break;
806 default:
807 error_msg = xstrfmt(_("bad config line %d in %s"),
808 cf->linenr, cf->name);
811 if (cf->die_on_error)
812 die("%s", error_msg);
813 else
814 error_return = error("%s", error_msg);
816 free(error_msg);
817 return error_return;
820 static int parse_unit_factor(const char *end, uintmax_t *val)
822 if (!*end)
823 return 1;
824 else if (!strcasecmp(end, "k")) {
825 *val *= 1024;
826 return 1;
828 else if (!strcasecmp(end, "m")) {
829 *val *= 1024 * 1024;
830 return 1;
832 else if (!strcasecmp(end, "g")) {
833 *val *= 1024 * 1024 * 1024;
834 return 1;
836 return 0;
839 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
841 if (value && *value) {
842 char *end;
843 intmax_t val;
844 uintmax_t uval;
845 uintmax_t factor = 1;
847 errno = 0;
848 val = strtoimax(value, &end, 0);
849 if (errno == ERANGE)
850 return 0;
851 if (!parse_unit_factor(end, &factor)) {
852 errno = EINVAL;
853 return 0;
855 uval = labs(val);
856 uval *= factor;
857 if (uval > max || labs(val) > uval) {
858 errno = ERANGE;
859 return 0;
861 val *= factor;
862 *ret = val;
863 return 1;
865 errno = EINVAL;
866 return 0;
869 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
871 if (value && *value) {
872 char *end;
873 uintmax_t val;
874 uintmax_t oldval;
876 errno = 0;
877 val = strtoumax(value, &end, 0);
878 if (errno == ERANGE)
879 return 0;
880 oldval = val;
881 if (!parse_unit_factor(end, &val)) {
882 errno = EINVAL;
883 return 0;
885 if (val > max || oldval > val) {
886 errno = ERANGE;
887 return 0;
889 *ret = val;
890 return 1;
892 errno = EINVAL;
893 return 0;
896 static int git_parse_int(const char *value, int *ret)
898 intmax_t tmp;
899 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
900 return 0;
901 *ret = tmp;
902 return 1;
905 static int git_parse_int64(const char *value, int64_t *ret)
907 intmax_t tmp;
908 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
909 return 0;
910 *ret = tmp;
911 return 1;
914 int git_parse_ulong(const char *value, unsigned long *ret)
916 uintmax_t tmp;
917 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
918 return 0;
919 *ret = tmp;
920 return 1;
923 static int git_parse_ssize_t(const char *value, ssize_t *ret)
925 intmax_t tmp;
926 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
927 return 0;
928 *ret = tmp;
929 return 1;
932 NORETURN
933 static void die_bad_number(const char *name, const char *value)
935 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
937 if (!value)
938 value = "";
940 if (!(cf && cf->name))
941 die(_("bad numeric config value '%s' for '%s': %s"),
942 value, name, error_type);
944 switch (cf->origin_type) {
945 case CONFIG_ORIGIN_BLOB:
946 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
947 value, name, cf->name, error_type);
948 case CONFIG_ORIGIN_FILE:
949 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
950 value, name, cf->name, error_type);
951 case CONFIG_ORIGIN_STDIN:
952 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
953 value, name, error_type);
954 case CONFIG_ORIGIN_SUBMODULE_BLOB:
955 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
956 value, name, cf->name, error_type);
957 case CONFIG_ORIGIN_CMDLINE:
958 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
959 value, name, cf->name, error_type);
960 default:
961 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
962 value, name, cf->name, error_type);
966 int git_config_int(const char *name, const char *value)
968 int ret;
969 if (!git_parse_int(value, &ret))
970 die_bad_number(name, value);
971 return ret;
974 int64_t git_config_int64(const char *name, const char *value)
976 int64_t ret;
977 if (!git_parse_int64(value, &ret))
978 die_bad_number(name, value);
979 return ret;
982 unsigned long git_config_ulong(const char *name, const char *value)
984 unsigned long ret;
985 if (!git_parse_ulong(value, &ret))
986 die_bad_number(name, value);
987 return ret;
990 ssize_t git_config_ssize_t(const char *name, const char *value)
992 ssize_t ret;
993 if (!git_parse_ssize_t(value, &ret))
994 die_bad_number(name, value);
995 return ret;
998 static int git_parse_maybe_bool_text(const char *value)
1000 if (!value)
1001 return 1;
1002 if (!*value)
1003 return 0;
1004 if (!strcasecmp(value, "true")
1005 || !strcasecmp(value, "yes")
1006 || !strcasecmp(value, "on"))
1007 return 1;
1008 if (!strcasecmp(value, "false")
1009 || !strcasecmp(value, "no")
1010 || !strcasecmp(value, "off"))
1011 return 0;
1012 return -1;
1015 int git_parse_maybe_bool(const char *value)
1017 int v = git_parse_maybe_bool_text(value);
1018 if (0 <= v)
1019 return v;
1020 if (git_parse_int(value, &v))
1021 return !!v;
1022 return -1;
1025 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1027 int v = git_parse_maybe_bool_text(value);
1028 if (0 <= v) {
1029 *is_bool = 1;
1030 return v;
1032 *is_bool = 0;
1033 return git_config_int(name, value);
1036 int git_config_bool(const char *name, const char *value)
1038 int discard;
1039 return !!git_config_bool_or_int(name, value, &discard);
1042 int git_config_string(const char **dest, const char *var, const char *value)
1044 if (!value)
1045 return config_error_nonbool(var);
1046 *dest = xstrdup(value);
1047 return 0;
1050 int git_config_pathname(const char **dest, const char *var, const char *value)
1052 if (!value)
1053 return config_error_nonbool(var);
1054 *dest = expand_user_path(value, 0);
1055 if (!*dest)
1056 die(_("failed to expand user dir in: '%s'"), value);
1057 return 0;
1060 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1062 if (!value)
1063 return config_error_nonbool(var);
1064 if (parse_expiry_date(value, timestamp))
1065 return error(_("'%s' for '%s' is not a valid timestamp"),
1066 value, var);
1067 return 0;
1070 static int git_default_core_config(const char *var, const char *value)
1072 /* This needs a better name */
1073 if (!strcmp(var, "core.filemode")) {
1074 trust_executable_bit = git_config_bool(var, value);
1075 return 0;
1077 if (!strcmp(var, "core.trustctime")) {
1078 trust_ctime = git_config_bool(var, value);
1079 return 0;
1081 if (!strcmp(var, "core.checkstat")) {
1082 if (!strcasecmp(value, "default"))
1083 check_stat = 1;
1084 else if (!strcasecmp(value, "minimal"))
1085 check_stat = 0;
1088 if (!strcmp(var, "core.quotepath")) {
1089 quote_path_fully = git_config_bool(var, value);
1090 return 0;
1093 if (!strcmp(var, "core.symlinks")) {
1094 has_symlinks = git_config_bool(var, value);
1095 return 0;
1098 if (!strcmp(var, "core.ignorecase")) {
1099 ignore_case = git_config_bool(var, value);
1100 return 0;
1103 if (!strcmp(var, "core.attributesfile"))
1104 return git_config_pathname(&git_attributes_file, var, value);
1106 if (!strcmp(var, "core.hookspath"))
1107 return git_config_pathname(&git_hooks_path, var, value);
1109 if (!strcmp(var, "core.bare")) {
1110 is_bare_repository_cfg = git_config_bool(var, value);
1111 return 0;
1114 if (!strcmp(var, "core.ignorestat")) {
1115 assume_unchanged = git_config_bool(var, value);
1116 return 0;
1119 if (!strcmp(var, "core.prefersymlinkrefs")) {
1120 prefer_symlink_refs = git_config_bool(var, value);
1121 return 0;
1124 if (!strcmp(var, "core.logallrefupdates")) {
1125 if (value && !strcasecmp(value, "always"))
1126 log_all_ref_updates = LOG_REFS_ALWAYS;
1127 else if (git_config_bool(var, value))
1128 log_all_ref_updates = LOG_REFS_NORMAL;
1129 else
1130 log_all_ref_updates = LOG_REFS_NONE;
1131 return 0;
1134 if (!strcmp(var, "core.warnambiguousrefs")) {
1135 warn_ambiguous_refs = git_config_bool(var, value);
1136 return 0;
1139 if (!strcmp(var, "core.abbrev")) {
1140 if (!value)
1141 return config_error_nonbool(var);
1142 if (!strcasecmp(value, "auto"))
1143 default_abbrev = -1;
1144 else {
1145 int abbrev = git_config_int(var, value);
1146 if (abbrev < minimum_abbrev || abbrev > 40)
1147 return error("abbrev length out of range: %d", abbrev);
1148 default_abbrev = abbrev;
1150 return 0;
1153 if (!strcmp(var, "core.disambiguate"))
1154 return set_disambiguate_hint_config(var, value);
1156 if (!strcmp(var, "core.loosecompression")) {
1157 int level = git_config_int(var, value);
1158 if (level == -1)
1159 level = Z_DEFAULT_COMPRESSION;
1160 else if (level < 0 || level > Z_BEST_COMPRESSION)
1161 die(_("bad zlib compression level %d"), level);
1162 zlib_compression_level = level;
1163 zlib_compression_seen = 1;
1164 return 0;
1167 if (!strcmp(var, "core.compression")) {
1168 int level = git_config_int(var, value);
1169 if (level == -1)
1170 level = Z_DEFAULT_COMPRESSION;
1171 else if (level < 0 || level > Z_BEST_COMPRESSION)
1172 die(_("bad zlib compression level %d"), level);
1173 core_compression_level = level;
1174 core_compression_seen = 1;
1175 if (!zlib_compression_seen)
1176 zlib_compression_level = level;
1177 if (!pack_compression_seen)
1178 pack_compression_level = level;
1179 return 0;
1182 if (!strcmp(var, "core.packedgitwindowsize")) {
1183 int pgsz_x2 = getpagesize() * 2;
1184 packed_git_window_size = git_config_ulong(var, value);
1186 /* This value must be multiple of (pagesize * 2) */
1187 packed_git_window_size /= pgsz_x2;
1188 if (packed_git_window_size < 1)
1189 packed_git_window_size = 1;
1190 packed_git_window_size *= pgsz_x2;
1191 return 0;
1194 if (!strcmp(var, "core.bigfilethreshold")) {
1195 big_file_threshold = git_config_ulong(var, value);
1196 return 0;
1199 if (!strcmp(var, "core.packedgitlimit")) {
1200 packed_git_limit = git_config_ulong(var, value);
1201 return 0;
1204 if (!strcmp(var, "core.deltabasecachelimit")) {
1205 delta_base_cache_limit = git_config_ulong(var, value);
1206 return 0;
1209 if (!strcmp(var, "core.autocrlf")) {
1210 if (value && !strcasecmp(value, "input")) {
1211 auto_crlf = AUTO_CRLF_INPUT;
1212 return 0;
1214 auto_crlf = git_config_bool(var, value);
1215 return 0;
1218 if (!strcmp(var, "core.safecrlf")) {
1219 int eol_rndtrp_die;
1220 if (value && !strcasecmp(value, "warn")) {
1221 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1222 return 0;
1224 eol_rndtrp_die = git_config_bool(var, value);
1225 global_conv_flags_eol = eol_rndtrp_die ?
1226 CONV_EOL_RNDTRP_DIE : CONV_EOL_RNDTRP_WARN;
1227 return 0;
1230 if (!strcmp(var, "core.eol")) {
1231 if (value && !strcasecmp(value, "lf"))
1232 core_eol = EOL_LF;
1233 else if (value && !strcasecmp(value, "crlf"))
1234 core_eol = EOL_CRLF;
1235 else if (value && !strcasecmp(value, "native"))
1236 core_eol = EOL_NATIVE;
1237 else
1238 core_eol = EOL_UNSET;
1239 return 0;
1242 if (!strcmp(var, "core.checkroundtripencoding")) {
1243 check_roundtrip_encoding = xstrdup(value);
1244 return 0;
1247 if (!strcmp(var, "core.notesref")) {
1248 notes_ref_name = xstrdup(value);
1249 return 0;
1252 if (!strcmp(var, "core.editor"))
1253 return git_config_string(&editor_program, var, value);
1255 if (!strcmp(var, "core.commentchar")) {
1256 if (!value)
1257 return config_error_nonbool(var);
1258 else if (!strcasecmp(value, "auto"))
1259 auto_comment_line_char = 1;
1260 else if (value[0] && !value[1]) {
1261 comment_line_char = value[0];
1262 auto_comment_line_char = 0;
1263 } else
1264 return error("core.commentChar should only be one character");
1265 return 0;
1268 if (!strcmp(var, "core.askpass"))
1269 return git_config_string(&askpass_program, var, value);
1271 if (!strcmp(var, "core.excludesfile"))
1272 return git_config_pathname(&excludes_file, var, value);
1274 if (!strcmp(var, "core.whitespace")) {
1275 if (!value)
1276 return config_error_nonbool(var);
1277 whitespace_rule_cfg = parse_whitespace_rule(value);
1278 return 0;
1281 if (!strcmp(var, "core.fsyncobjectfiles")) {
1282 fsync_object_files = git_config_bool(var, value);
1283 return 0;
1286 if (!strcmp(var, "core.preloadindex")) {
1287 core_preload_index = git_config_bool(var, value);
1288 return 0;
1291 if (!strcmp(var, "core.createobject")) {
1292 if (!strcmp(value, "rename"))
1293 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1294 else if (!strcmp(value, "link"))
1295 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1296 else
1297 die(_("invalid mode for object creation: %s"), value);
1298 return 0;
1301 if (!strcmp(var, "core.commitgraph")) {
1302 core_commit_graph = git_config_bool(var, value);
1303 return 0;
1306 if (!strcmp(var, "core.sparsecheckout")) {
1307 core_apply_sparse_checkout = git_config_bool(var, value);
1308 return 0;
1311 if (!strcmp(var, "core.precomposeunicode")) {
1312 precomposed_unicode = git_config_bool(var, value);
1313 return 0;
1316 if (!strcmp(var, "core.protecthfs")) {
1317 protect_hfs = git_config_bool(var, value);
1318 return 0;
1321 if (!strcmp(var, "core.protectntfs")) {
1322 protect_ntfs = git_config_bool(var, value);
1323 return 0;
1326 if (!strcmp(var, "core.hidedotfiles")) {
1327 if (value && !strcasecmp(value, "dotgitonly"))
1328 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1329 else
1330 hide_dotfiles = git_config_bool(var, value);
1331 return 0;
1334 if (!strcmp(var, "core.partialclonefilter")) {
1335 return git_config_string(&core_partial_clone_filter_default,
1336 var, value);
1339 /* Add other config variables here and to Documentation/config.txt. */
1340 return 0;
1343 static int git_default_i18n_config(const char *var, const char *value)
1345 if (!strcmp(var, "i18n.commitencoding"))
1346 return git_config_string(&git_commit_encoding, var, value);
1348 if (!strcmp(var, "i18n.logoutputencoding"))
1349 return git_config_string(&git_log_output_encoding, var, value);
1351 /* Add other config variables here and to Documentation/config.txt. */
1352 return 0;
1355 static int git_default_branch_config(const char *var, const char *value)
1357 if (!strcmp(var, "branch.autosetupmerge")) {
1358 if (value && !strcasecmp(value, "always")) {
1359 git_branch_track = BRANCH_TRACK_ALWAYS;
1360 return 0;
1362 git_branch_track = git_config_bool(var, value);
1363 return 0;
1365 if (!strcmp(var, "branch.autosetuprebase")) {
1366 if (!value)
1367 return config_error_nonbool(var);
1368 else if (!strcmp(value, "never"))
1369 autorebase = AUTOREBASE_NEVER;
1370 else if (!strcmp(value, "local"))
1371 autorebase = AUTOREBASE_LOCAL;
1372 else if (!strcmp(value, "remote"))
1373 autorebase = AUTOREBASE_REMOTE;
1374 else if (!strcmp(value, "always"))
1375 autorebase = AUTOREBASE_ALWAYS;
1376 else
1377 return error("malformed value for %s", var);
1378 return 0;
1381 /* Add other config variables here and to Documentation/config.txt. */
1382 return 0;
1385 static int git_default_push_config(const char *var, const char *value)
1387 if (!strcmp(var, "push.default")) {
1388 if (!value)
1389 return config_error_nonbool(var);
1390 else if (!strcmp(value, "nothing"))
1391 push_default = PUSH_DEFAULT_NOTHING;
1392 else if (!strcmp(value, "matching"))
1393 push_default = PUSH_DEFAULT_MATCHING;
1394 else if (!strcmp(value, "simple"))
1395 push_default = PUSH_DEFAULT_SIMPLE;
1396 else if (!strcmp(value, "upstream"))
1397 push_default = PUSH_DEFAULT_UPSTREAM;
1398 else if (!strcmp(value, "tracking")) /* deprecated */
1399 push_default = PUSH_DEFAULT_UPSTREAM;
1400 else if (!strcmp(value, "current"))
1401 push_default = PUSH_DEFAULT_CURRENT;
1402 else {
1403 error("malformed value for %s: %s", var, value);
1404 return error("Must be one of nothing, matching, simple, "
1405 "upstream or current.");
1407 return 0;
1410 /* Add other config variables here and to Documentation/config.txt. */
1411 return 0;
1414 static int git_default_mailmap_config(const char *var, const char *value)
1416 if (!strcmp(var, "mailmap.file"))
1417 return git_config_pathname(&git_mailmap_file, var, value);
1418 if (!strcmp(var, "mailmap.blob"))
1419 return git_config_string(&git_mailmap_blob, var, value);
1421 /* Add other config variables here and to Documentation/config.txt. */
1422 return 0;
1425 int git_default_config(const char *var, const char *value, void *dummy)
1427 if (starts_with(var, "core."))
1428 return git_default_core_config(var, value);
1430 if (starts_with(var, "user."))
1431 return git_ident_config(var, value, dummy);
1433 if (starts_with(var, "i18n."))
1434 return git_default_i18n_config(var, value);
1436 if (starts_with(var, "branch."))
1437 return git_default_branch_config(var, value);
1439 if (starts_with(var, "push."))
1440 return git_default_push_config(var, value);
1442 if (starts_with(var, "mailmap."))
1443 return git_default_mailmap_config(var, value);
1445 if (starts_with(var, "advice."))
1446 return git_default_advice_config(var, value);
1448 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1449 pager_use_color = git_config_bool(var,value);
1450 return 0;
1453 if (!strcmp(var, "pack.packsizelimit")) {
1454 pack_size_limit_cfg = git_config_ulong(var, value);
1455 return 0;
1458 if (!strcmp(var, "pack.compression")) {
1459 int level = git_config_int(var, value);
1460 if (level == -1)
1461 level = Z_DEFAULT_COMPRESSION;
1462 else if (level < 0 || level > Z_BEST_COMPRESSION)
1463 die(_("bad pack compression level %d"), level);
1464 pack_compression_level = level;
1465 pack_compression_seen = 1;
1466 return 0;
1469 /* Add other config variables here and to Documentation/config.txt. */
1470 return 0;
1474 * All source specific fields in the union, die_on_error, name and the callbacks
1475 * fgetc, ungetc, ftell of top need to be initialized before calling
1476 * this function.
1478 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1479 const struct config_options *opts)
1481 int ret;
1483 /* push config-file parsing state stack */
1484 top->prev = cf;
1485 top->linenr = 1;
1486 top->eof = 0;
1487 strbuf_init(&top->value, 1024);
1488 strbuf_init(&top->var, 1024);
1489 cf = top;
1491 ret = git_parse_source(fn, data, opts);
1493 /* pop config-file parsing state stack */
1494 strbuf_release(&top->value);
1495 strbuf_release(&top->var);
1496 cf = top->prev;
1498 return ret;
1501 static int do_config_from_file(config_fn_t fn,
1502 const enum config_origin_type origin_type,
1503 const char *name, const char *path, FILE *f,
1504 void *data, const struct config_options *opts)
1506 struct config_source top;
1507 int ret;
1509 top.u.file = f;
1510 top.origin_type = origin_type;
1511 top.name = name;
1512 top.path = path;
1513 top.die_on_error = 1;
1514 top.do_fgetc = config_file_fgetc;
1515 top.do_ungetc = config_file_ungetc;
1516 top.do_ftell = config_file_ftell;
1518 flockfile(f);
1519 ret = do_config_from(&top, fn, data, opts);
1520 funlockfile(f);
1521 return ret;
1524 static int git_config_from_stdin(config_fn_t fn, void *data)
1526 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1527 data, NULL);
1530 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1531 void *data,
1532 const struct config_options *opts)
1534 int ret = -1;
1535 FILE *f;
1537 f = fopen_or_warn(filename, "r");
1538 if (f) {
1539 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1540 filename, f, data, opts);
1541 fclose(f);
1543 return ret;
1546 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1548 return git_config_from_file_with_options(fn, filename, data, NULL);
1551 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1552 const char *name, const char *buf, size_t len, void *data)
1554 struct config_source top;
1556 top.u.buf.buf = buf;
1557 top.u.buf.len = len;
1558 top.u.buf.pos = 0;
1559 top.origin_type = origin_type;
1560 top.name = name;
1561 top.path = NULL;
1562 top.die_on_error = 0;
1563 top.do_fgetc = config_buf_fgetc;
1564 top.do_ungetc = config_buf_ungetc;
1565 top.do_ftell = config_buf_ftell;
1567 return do_config_from(&top, fn, data, NULL);
1570 int git_config_from_blob_oid(config_fn_t fn,
1571 const char *name,
1572 const struct object_id *oid,
1573 void *data)
1575 enum object_type type;
1576 char *buf;
1577 unsigned long size;
1578 int ret;
1580 buf = read_object_file(oid, &type, &size);
1581 if (!buf)
1582 return error("unable to load config blob object '%s'", name);
1583 if (type != OBJ_BLOB) {
1584 free(buf);
1585 return error("reference '%s' does not point to a blob", name);
1588 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1589 free(buf);
1591 return ret;
1594 static int git_config_from_blob_ref(config_fn_t fn,
1595 const char *name,
1596 void *data)
1598 struct object_id oid;
1600 if (get_oid(name, &oid) < 0)
1601 return error("unable to resolve config blob '%s'", name);
1602 return git_config_from_blob_oid(fn, name, &oid, data);
1605 const char *git_etc_gitconfig(void)
1607 static const char *system_wide;
1608 if (!system_wide)
1609 system_wide = system_path(ETC_GITCONFIG);
1610 return system_wide;
1614 * Parse environment variable 'k' as a boolean (in various
1615 * possible spellings); if missing, use the default value 'def'.
1617 int git_env_bool(const char *k, int def)
1619 const char *v = getenv(k);
1620 return v ? git_config_bool(k, v) : def;
1624 * Parse environment variable 'k' as ulong with possibly a unit
1625 * suffix; if missing, use the default value 'val'.
1627 unsigned long git_env_ulong(const char *k, unsigned long val)
1629 const char *v = getenv(k);
1630 if (v && !git_parse_ulong(v, &val))
1631 die("failed to parse %s", k);
1632 return val;
1635 int git_config_system(void)
1637 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1640 static int do_git_config_sequence(const struct config_options *opts,
1641 config_fn_t fn, void *data)
1643 int ret = 0;
1644 char *xdg_config = xdg_config_home("config");
1645 char *user_config = expand_user_path("~/.gitconfig", 0);
1646 char *repo_config;
1648 if (opts->commondir)
1649 repo_config = mkpathdup("%s/config", opts->commondir);
1650 else
1651 repo_config = NULL;
1653 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1654 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1655 ret += git_config_from_file(fn, git_etc_gitconfig(),
1656 data);
1658 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1659 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1660 ret += git_config_from_file(fn, xdg_config, data);
1662 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1663 ret += git_config_from_file(fn, user_config, data);
1665 current_parsing_scope = CONFIG_SCOPE_REPO;
1666 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1667 ret += git_config_from_file(fn, repo_config, data);
1669 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1670 if (git_config_from_parameters(fn, data) < 0)
1671 die(_("unable to parse command-line config"));
1673 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1674 free(xdg_config);
1675 free(user_config);
1676 free(repo_config);
1677 return ret;
1680 int config_with_options(config_fn_t fn, void *data,
1681 struct git_config_source *config_source,
1682 const struct config_options *opts)
1684 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1686 if (opts->respect_includes) {
1687 inc.fn = fn;
1688 inc.data = data;
1689 inc.opts = opts;
1690 fn = git_config_include;
1691 data = &inc;
1695 * If we have a specific filename, use it. Otherwise, follow the
1696 * regular lookup sequence.
1698 if (config_source && config_source->use_stdin)
1699 return git_config_from_stdin(fn, data);
1700 else if (config_source && config_source->file)
1701 return git_config_from_file(fn, config_source->file, data);
1702 else if (config_source && config_source->blob)
1703 return git_config_from_blob_ref(fn, config_source->blob, data);
1705 return do_git_config_sequence(opts, fn, data);
1708 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1710 int i, value_index;
1711 struct string_list *values;
1712 struct config_set_element *entry;
1713 struct configset_list *list = &cs->list;
1715 for (i = 0; i < list->nr; i++) {
1716 entry = list->items[i].e;
1717 value_index = list->items[i].value_index;
1718 values = &entry->value_list;
1720 current_config_kvi = values->items[value_index].util;
1722 if (fn(entry->key, values->items[value_index].string, data) < 0)
1723 git_die_config_linenr(entry->key,
1724 current_config_kvi->filename,
1725 current_config_kvi->linenr);
1727 current_config_kvi = NULL;
1731 void read_early_config(config_fn_t cb, void *data)
1733 struct config_options opts = {0};
1734 struct strbuf commondir = STRBUF_INIT;
1735 struct strbuf gitdir = STRBUF_INIT;
1737 opts.respect_includes = 1;
1739 if (have_git_dir()) {
1740 opts.commondir = get_git_common_dir();
1741 opts.git_dir = get_git_dir();
1743 * When setup_git_directory() was not yet asked to discover the
1744 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1745 * is any repository config we should use (but unlike
1746 * setup_git_directory_gently(), no global state is changed, most
1747 * notably, the current working directory is still the same after the
1748 * call).
1750 } else if (!discover_git_directory(&commondir, &gitdir)) {
1751 opts.commondir = commondir.buf;
1752 opts.git_dir = gitdir.buf;
1755 config_with_options(cb, data, NULL, &opts);
1757 strbuf_release(&commondir);
1758 strbuf_release(&gitdir);
1761 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1763 struct config_set_element k;
1764 struct config_set_element *found_entry;
1765 char *normalized_key;
1767 * `key` may come from the user, so normalize it before using it
1768 * for querying entries from the hashmap.
1770 if (git_config_parse_key(key, &normalized_key, NULL))
1771 return NULL;
1773 hashmap_entry_init(&k, strhash(normalized_key));
1774 k.key = normalized_key;
1775 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1776 free(normalized_key);
1777 return found_entry;
1780 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1782 struct config_set_element *e;
1783 struct string_list_item *si;
1784 struct configset_list_item *l_item;
1785 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1787 e = configset_find_element(cs, key);
1789 * Since the keys are being fed by git_config*() callback mechanism, they
1790 * are already normalized. So simply add them without any further munging.
1792 if (!e) {
1793 e = xmalloc(sizeof(*e));
1794 hashmap_entry_init(e, strhash(key));
1795 e->key = xstrdup(key);
1796 string_list_init(&e->value_list, 1);
1797 hashmap_add(&cs->config_hash, e);
1799 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1801 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1802 l_item = &cs->list.items[cs->list.nr++];
1803 l_item->e = e;
1804 l_item->value_index = e->value_list.nr - 1;
1806 if (!cf)
1807 die("BUG: configset_add_value has no source");
1808 if (cf->name) {
1809 kv_info->filename = strintern(cf->name);
1810 kv_info->linenr = cf->linenr;
1811 kv_info->origin_type = cf->origin_type;
1812 } else {
1813 /* for values read from `git_config_from_parameters()` */
1814 kv_info->filename = NULL;
1815 kv_info->linenr = -1;
1816 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1818 kv_info->scope = current_parsing_scope;
1819 si->util = kv_info;
1821 return 0;
1824 static int config_set_element_cmp(const void *unused_cmp_data,
1825 const void *entry,
1826 const void *entry_or_key,
1827 const void *unused_keydata)
1829 const struct config_set_element *e1 = entry;
1830 const struct config_set_element *e2 = entry_or_key;
1832 return strcmp(e1->key, e2->key);
1835 void git_configset_init(struct config_set *cs)
1837 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1838 cs->hash_initialized = 1;
1839 cs->list.nr = 0;
1840 cs->list.alloc = 0;
1841 cs->list.items = NULL;
1844 void git_configset_clear(struct config_set *cs)
1846 struct config_set_element *entry;
1847 struct hashmap_iter iter;
1848 if (!cs->hash_initialized)
1849 return;
1851 hashmap_iter_init(&cs->config_hash, &iter);
1852 while ((entry = hashmap_iter_next(&iter))) {
1853 free(entry->key);
1854 string_list_clear(&entry->value_list, 1);
1856 hashmap_free(&cs->config_hash, 1);
1857 cs->hash_initialized = 0;
1858 free(cs->list.items);
1859 cs->list.nr = 0;
1860 cs->list.alloc = 0;
1861 cs->list.items = NULL;
1864 static int config_set_callback(const char *key, const char *value, void *cb)
1866 struct config_set *cs = cb;
1867 configset_add_value(cs, key, value);
1868 return 0;
1871 int git_configset_add_file(struct config_set *cs, const char *filename)
1873 return git_config_from_file(config_set_callback, filename, cs);
1876 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1878 const struct string_list *values = NULL;
1880 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1881 * queried key in the files of the configset, the value returned will be the last
1882 * value in the value list for that key.
1884 values = git_configset_get_value_multi(cs, key);
1886 if (!values)
1887 return 1;
1888 assert(values->nr > 0);
1889 *value = values->items[values->nr - 1].string;
1890 return 0;
1893 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1895 struct config_set_element *e = configset_find_element(cs, key);
1896 return e ? &e->value_list : NULL;
1899 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1901 const char *value;
1902 if (!git_configset_get_value(cs, key, &value))
1903 return git_config_string(dest, key, value);
1904 else
1905 return 1;
1908 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1910 return git_configset_get_string_const(cs, key, (const char **)dest);
1913 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1915 const char *value;
1916 if (!git_configset_get_value(cs, key, &value)) {
1917 *dest = git_config_int(key, value);
1918 return 0;
1919 } else
1920 return 1;
1923 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1925 const char *value;
1926 if (!git_configset_get_value(cs, key, &value)) {
1927 *dest = git_config_ulong(key, value);
1928 return 0;
1929 } else
1930 return 1;
1933 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1935 const char *value;
1936 if (!git_configset_get_value(cs, key, &value)) {
1937 *dest = git_config_bool(key, value);
1938 return 0;
1939 } else
1940 return 1;
1943 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1944 int *is_bool, int *dest)
1946 const char *value;
1947 if (!git_configset_get_value(cs, key, &value)) {
1948 *dest = git_config_bool_or_int(key, value, is_bool);
1949 return 0;
1950 } else
1951 return 1;
1954 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1956 const char *value;
1957 if (!git_configset_get_value(cs, key, &value)) {
1958 *dest = git_parse_maybe_bool(value);
1959 if (*dest == -1)
1960 return -1;
1961 return 0;
1962 } else
1963 return 1;
1966 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1968 const char *value;
1969 if (!git_configset_get_value(cs, key, &value))
1970 return git_config_pathname(dest, key, value);
1971 else
1972 return 1;
1975 /* Functions use to read configuration from a repository */
1976 static void repo_read_config(struct repository *repo)
1978 struct config_options opts;
1980 opts.respect_includes = 1;
1981 opts.commondir = repo->commondir;
1982 opts.git_dir = repo->gitdir;
1984 if (!repo->config)
1985 repo->config = xcalloc(1, sizeof(struct config_set));
1986 else
1987 git_configset_clear(repo->config);
1989 git_configset_init(repo->config);
1991 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
1993 * config_with_options() normally returns only
1994 * zero, as most errors are fatal, and
1995 * non-fatal potential errors are guarded by "if"
1996 * statements that are entered only when no error is
1997 * possible.
1999 * If we ever encounter a non-fatal error, it means
2000 * something went really wrong and we should stop
2001 * immediately.
2003 die(_("unknown error occurred while reading the configuration files"));
2006 static void git_config_check_init(struct repository *repo)
2008 if (repo->config && repo->config->hash_initialized)
2009 return;
2010 repo_read_config(repo);
2013 static void repo_config_clear(struct repository *repo)
2015 if (!repo->config || !repo->config->hash_initialized)
2016 return;
2017 git_configset_clear(repo->config);
2020 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2022 git_config_check_init(repo);
2023 configset_iter(repo->config, fn, data);
2026 int repo_config_get_value(struct repository *repo,
2027 const char *key, const char **value)
2029 git_config_check_init(repo);
2030 return git_configset_get_value(repo->config, key, value);
2033 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2034 const char *key)
2036 git_config_check_init(repo);
2037 return git_configset_get_value_multi(repo->config, key);
2040 int repo_config_get_string_const(struct repository *repo,
2041 const char *key, const char **dest)
2043 int ret;
2044 git_config_check_init(repo);
2045 ret = git_configset_get_string_const(repo->config, key, dest);
2046 if (ret < 0)
2047 git_die_config(key, NULL);
2048 return ret;
2051 int repo_config_get_string(struct repository *repo,
2052 const char *key, char **dest)
2054 git_config_check_init(repo);
2055 return repo_config_get_string_const(repo, key, (const char **)dest);
2058 int repo_config_get_int(struct repository *repo,
2059 const char *key, int *dest)
2061 git_config_check_init(repo);
2062 return git_configset_get_int(repo->config, key, dest);
2065 int repo_config_get_ulong(struct repository *repo,
2066 const char *key, unsigned long *dest)
2068 git_config_check_init(repo);
2069 return git_configset_get_ulong(repo->config, key, dest);
2072 int repo_config_get_bool(struct repository *repo,
2073 const char *key, int *dest)
2075 git_config_check_init(repo);
2076 return git_configset_get_bool(repo->config, key, dest);
2079 int repo_config_get_bool_or_int(struct repository *repo,
2080 const char *key, int *is_bool, int *dest)
2082 git_config_check_init(repo);
2083 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2086 int repo_config_get_maybe_bool(struct repository *repo,
2087 const char *key, int *dest)
2089 git_config_check_init(repo);
2090 return git_configset_get_maybe_bool(repo->config, key, dest);
2093 int repo_config_get_pathname(struct repository *repo,
2094 const char *key, const char **dest)
2096 int ret;
2097 git_config_check_init(repo);
2098 ret = git_configset_get_pathname(repo->config, key, dest);
2099 if (ret < 0)
2100 git_die_config(key, NULL);
2101 return ret;
2104 /* Functions used historically to read configuration from 'the_repository' */
2105 void git_config(config_fn_t fn, void *data)
2107 repo_config(the_repository, fn, data);
2110 void git_config_clear(void)
2112 repo_config_clear(the_repository);
2115 int git_config_get_value(const char *key, const char **value)
2117 return repo_config_get_value(the_repository, key, value);
2120 const struct string_list *git_config_get_value_multi(const char *key)
2122 return repo_config_get_value_multi(the_repository, key);
2125 int git_config_get_string_const(const char *key, const char **dest)
2127 return repo_config_get_string_const(the_repository, key, dest);
2130 int git_config_get_string(const char *key, char **dest)
2132 return repo_config_get_string(the_repository, key, dest);
2135 int git_config_get_int(const char *key, int *dest)
2137 return repo_config_get_int(the_repository, key, dest);
2140 int git_config_get_ulong(const char *key, unsigned long *dest)
2142 return repo_config_get_ulong(the_repository, key, dest);
2145 int git_config_get_bool(const char *key, int *dest)
2147 return repo_config_get_bool(the_repository, key, dest);
2150 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2152 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2155 int git_config_get_maybe_bool(const char *key, int *dest)
2157 return repo_config_get_maybe_bool(the_repository, key, dest);
2160 int git_config_get_pathname(const char *key, const char **dest)
2162 return repo_config_get_pathname(the_repository, key, dest);
2166 * Note: This function exists solely to maintain backward compatibility with
2167 * 'fetch' and 'update_clone' storing configuration in '.gitmodules' and should
2168 * NOT be used anywhere else.
2170 * Runs the provided config function on the '.gitmodules' file found in the
2171 * working directory.
2173 void config_from_gitmodules(config_fn_t fn, void *data)
2175 if (the_repository->worktree) {
2176 char *file = repo_worktree_path(the_repository, GITMODULES_FILE);
2177 git_config_from_file(fn, file, data);
2178 free(file);
2182 int git_config_get_expiry(const char *key, const char **output)
2184 int ret = git_config_get_string_const(key, output);
2185 if (ret)
2186 return ret;
2187 if (strcmp(*output, "now")) {
2188 timestamp_t now = approxidate("now");
2189 if (approxidate(*output) >= now)
2190 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2192 return ret;
2195 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2197 char *expiry_string;
2198 intmax_t days;
2199 timestamp_t when;
2201 if (git_config_get_string(key, &expiry_string))
2202 return 1; /* no such thing */
2204 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2205 const int scale = 86400;
2206 *expiry = now - days * scale;
2207 return 0;
2210 if (!parse_expiry_date(expiry_string, &when)) {
2211 *expiry = when;
2212 return 0;
2214 return -1; /* thing exists but cannot be parsed */
2217 int git_config_get_untracked_cache(void)
2219 int val = -1;
2220 const char *v;
2222 /* Hack for test programs like test-dump-untracked-cache */
2223 if (ignore_untracked_cache_config)
2224 return -1;
2226 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2227 return val;
2229 if (!git_config_get_value("core.untrackedcache", &v)) {
2230 if (!strcasecmp(v, "keep"))
2231 return -1;
2233 error(_("unknown core.untrackedCache value '%s'; "
2234 "using 'keep' default value"), v);
2235 return -1;
2238 return -1; /* default value */
2241 int git_config_get_split_index(void)
2243 int val;
2245 if (!git_config_get_maybe_bool("core.splitindex", &val))
2246 return val;
2248 return -1; /* default value */
2251 int git_config_get_max_percent_split_change(void)
2253 int val = -1;
2255 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2256 if (0 <= val && val <= 100)
2257 return val;
2259 return error(_("splitIndex.maxPercentChange value '%d' "
2260 "should be between 0 and 100"), val);
2263 return -1; /* default value */
2266 int git_config_get_fsmonitor(void)
2268 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2269 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2271 if (core_fsmonitor && !*core_fsmonitor)
2272 core_fsmonitor = NULL;
2274 if (core_fsmonitor)
2275 return 1;
2277 return 0;
2280 NORETURN
2281 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2283 if (!filename)
2284 die(_("unable to parse '%s' from command-line config"), key);
2285 else
2286 die(_("bad config variable '%s' in file '%s' at line %d"),
2287 key, filename, linenr);
2290 NORETURN __attribute__((format(printf, 2, 3)))
2291 void git_die_config(const char *key, const char *err, ...)
2293 const struct string_list *values;
2294 struct key_value_info *kv_info;
2296 if (err) {
2297 va_list params;
2298 va_start(params, err);
2299 vreportf("error: ", err, params);
2300 va_end(params);
2302 values = git_config_get_value_multi(key);
2303 kv_info = values->items[values->nr - 1].util;
2304 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2308 * Find all the stuff for git_config_set() below.
2311 struct config_store_data {
2312 int baselen;
2313 char *key;
2314 int do_not_match;
2315 regex_t *value_regex;
2316 int multi_replace;
2317 struct {
2318 size_t begin, end;
2319 enum config_event_t type;
2320 int is_keys_section;
2321 } *parsed;
2322 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2323 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2326 static int matches(const char *key, const char *value,
2327 const struct config_store_data *store)
2329 if (strcmp(key, store->key))
2330 return 0; /* not ours */
2331 if (!store->value_regex)
2332 return 1; /* always matches */
2333 if (store->value_regex == CONFIG_REGEX_NONE)
2334 return 0; /* never matches */
2336 return store->do_not_match ^
2337 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2340 static int store_aux_event(enum config_event_t type,
2341 size_t begin, size_t end, void *data)
2343 struct config_store_data *store = data;
2345 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2346 store->parsed[store->parsed_nr].begin = begin;
2347 store->parsed[store->parsed_nr].end = end;
2348 store->parsed[store->parsed_nr].type = type;
2350 if (type == CONFIG_EVENT_SECTION) {
2351 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2352 BUG("Invalid section name '%s'", cf->var.buf);
2354 /* Is this the section we were looking for? */
2355 store->is_keys_section =
2356 store->parsed[store->parsed_nr].is_keys_section =
2357 cf->var.len - 1 == store->baselen &&
2358 !strncasecmp(cf->var.buf, store->key, store->baselen);
2359 if (store->is_keys_section) {
2360 store->section_seen = 1;
2361 ALLOC_GROW(store->seen, store->seen_nr + 1,
2362 store->seen_alloc);
2363 store->seen[store->seen_nr] = store->parsed_nr;
2367 store->parsed_nr++;
2369 return 0;
2372 static int store_aux(const char *key, const char *value, void *cb)
2374 struct config_store_data *store = cb;
2376 if (store->key_seen) {
2377 if (matches(key, value, store)) {
2378 if (store->seen_nr == 1 && store->multi_replace == 0) {
2379 warning(_("%s has multiple values"), key);
2382 ALLOC_GROW(store->seen, store->seen_nr + 1,
2383 store->seen_alloc);
2385 store->seen[store->seen_nr] = store->parsed_nr;
2386 store->seen_nr++;
2388 } else if (store->is_keys_section) {
2390 * Do not increment matches yet: this may not be a match, but we
2391 * are in the desired section.
2393 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2394 store->seen[store->seen_nr] = store->parsed_nr;
2395 store->section_seen = 1;
2397 if (matches(key, value, store)) {
2398 store->seen_nr++;
2399 store->key_seen = 1;
2403 return 0;
2406 static int write_error(const char *filename)
2408 error("failed to write new configuration file %s", filename);
2410 /* Same error code as "failed to rename". */
2411 return 4;
2414 static struct strbuf store_create_section(const char *key,
2415 const struct config_store_data *store)
2417 const char *dot;
2418 int i;
2419 struct strbuf sb = STRBUF_INIT;
2421 dot = memchr(key, '.', store->baselen);
2422 if (dot) {
2423 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2424 for (i = dot - key + 1; i < store->baselen; i++) {
2425 if (key[i] == '"' || key[i] == '\\')
2426 strbuf_addch(&sb, '\\');
2427 strbuf_addch(&sb, key[i]);
2429 strbuf_addstr(&sb, "\"]\n");
2430 } else {
2431 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2434 return sb;
2437 static ssize_t write_section(int fd, const char *key,
2438 const struct config_store_data *store)
2440 struct strbuf sb = store_create_section(key, store);
2441 ssize_t ret;
2443 ret = write_in_full(fd, sb.buf, sb.len);
2444 strbuf_release(&sb);
2446 return ret;
2449 static ssize_t write_pair(int fd, const char *key, const char *value,
2450 const struct config_store_data *store)
2452 int i;
2453 ssize_t ret;
2454 int length = strlen(key + store->baselen + 1);
2455 const char *quote = "";
2456 struct strbuf sb = STRBUF_INIT;
2459 * Check to see if the value needs to be surrounded with a dq pair.
2460 * Note that problematic characters are always backslash-quoted; this
2461 * check is about not losing leading or trailing SP and strings that
2462 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2463 * configuration parser.
2465 if (value[0] == ' ')
2466 quote = "\"";
2467 for (i = 0; value[i]; i++)
2468 if (value[i] == ';' || value[i] == '#')
2469 quote = "\"";
2470 if (i && value[i - 1] == ' ')
2471 quote = "\"";
2473 strbuf_addf(&sb, "\t%.*s = %s",
2474 length, key + store->baselen + 1, quote);
2476 for (i = 0; value[i]; i++)
2477 switch (value[i]) {
2478 case '\n':
2479 strbuf_addstr(&sb, "\\n");
2480 break;
2481 case '\t':
2482 strbuf_addstr(&sb, "\\t");
2483 break;
2484 case '"':
2485 case '\\':
2486 strbuf_addch(&sb, '\\');
2487 /* fallthrough */
2488 default:
2489 strbuf_addch(&sb, value[i]);
2490 break;
2492 strbuf_addf(&sb, "%s\n", quote);
2494 ret = write_in_full(fd, sb.buf, sb.len);
2495 strbuf_release(&sb);
2497 return ret;
2501 * If we are about to unset the last key(s) in a section, and if there are
2502 * no comments surrounding (or included in) the section, we will want to
2503 * extend begin/end to remove the entire section.
2505 * Note: the parameter `seen_ptr` points to the index into the store.seen
2506 * array. * This index may be incremented if a section has more than one
2507 * entry (which all are to be removed).
2509 static void maybe_remove_section(struct config_store_data *store,
2510 const char *contents,
2511 size_t *begin_offset, size_t *end_offset,
2512 int *seen_ptr)
2514 size_t begin;
2515 int i, seen, section_seen = 0;
2518 * First, ensure that this is the first key, and that there are no
2519 * comments before the entry nor before the section header.
2521 seen = *seen_ptr;
2522 for (i = store->seen[seen]; i > 0; i--) {
2523 enum config_event_t type = store->parsed[i - 1].type;
2525 if (type == CONFIG_EVENT_COMMENT)
2526 /* There is a comment before this entry or section */
2527 return;
2528 if (type == CONFIG_EVENT_ENTRY) {
2529 if (!section_seen)
2530 /* This is not the section's first entry. */
2531 return;
2532 /* We encountered no comment before the section. */
2533 break;
2535 if (type == CONFIG_EVENT_SECTION) {
2536 if (!store->parsed[i - 1].is_keys_section)
2537 break;
2538 section_seen = 1;
2541 begin = store->parsed[i].begin;
2544 * Next, make sure that we are removing he last key(s) in the section,
2545 * and that there are no comments that are possibly about the current
2546 * section.
2548 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2549 enum config_event_t type = store->parsed[i].type;
2551 if (type == CONFIG_EVENT_COMMENT)
2552 return;
2553 if (type == CONFIG_EVENT_SECTION) {
2554 if (store->parsed[i].is_keys_section)
2555 continue;
2556 break;
2558 if (type == CONFIG_EVENT_ENTRY) {
2559 if (++seen < store->seen_nr &&
2560 i == store->seen[seen])
2561 /* We want to remove this entry, too */
2562 continue;
2563 /* There is another entry in this section. */
2564 return;
2569 * We are really removing the last entry/entries from this section, and
2570 * there are no enclosed or surrounding comments. Remove the entire,
2571 * now-empty section.
2573 *seen_ptr = seen;
2574 *begin_offset = begin;
2575 if (i < store->parsed_nr)
2576 *end_offset = store->parsed[i].begin;
2577 else
2578 *end_offset = store->parsed[store->parsed_nr - 1].end;
2581 int git_config_set_in_file_gently(const char *config_filename,
2582 const char *key, const char *value)
2584 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2587 void git_config_set_in_file(const char *config_filename,
2588 const char *key, const char *value)
2590 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2593 int git_config_set_gently(const char *key, const char *value)
2595 return git_config_set_multivar_gently(key, value, NULL, 0);
2598 void git_config_set(const char *key, const char *value)
2600 git_config_set_multivar(key, value, NULL, 0);
2604 * If value==NULL, unset in (remove from) config,
2605 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2606 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2607 * (only add a new one)
2608 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2609 * else all matching key/values (regardless how many) are removed,
2610 * before the new pair is written.
2612 * Returns 0 on success.
2614 * This function does this:
2616 * - it locks the config file by creating ".git/config.lock"
2618 * - it then parses the config using store_aux() as validator to find
2619 * the position on the key/value pair to replace. If it is to be unset,
2620 * it must be found exactly once.
2622 * - the config file is mmap()ed and the part before the match (if any) is
2623 * written to the lock file, then the changed part and the rest.
2625 * - the config file is removed and the lock file rename()d to it.
2628 int git_config_set_multivar_in_file_gently(const char *config_filename,
2629 const char *key, const char *value,
2630 const char *value_regex,
2631 int multi_replace)
2633 int fd = -1, in_fd = -1;
2634 int ret;
2635 struct lock_file lock = LOCK_INIT;
2636 char *filename_buf = NULL;
2637 char *contents = NULL;
2638 size_t contents_sz;
2639 struct config_store_data store;
2641 memset(&store, 0, sizeof(store));
2643 /* parse-key returns negative; flip the sign to feed exit(3) */
2644 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2645 if (ret)
2646 goto out_free;
2648 store.multi_replace = multi_replace;
2650 if (!config_filename)
2651 config_filename = filename_buf = git_pathdup("config");
2654 * The lock serves a purpose in addition to locking: the new
2655 * contents of .git/config will be written into it.
2657 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2658 if (fd < 0) {
2659 error_errno("could not lock config file %s", config_filename);
2660 free(store.key);
2661 ret = CONFIG_NO_LOCK;
2662 goto out_free;
2666 * If .git/config does not exist yet, write a minimal version.
2668 in_fd = open(config_filename, O_RDONLY);
2669 if ( in_fd < 0 ) {
2670 free(store.key);
2672 if ( ENOENT != errno ) {
2673 error_errno("opening %s", config_filename);
2674 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2675 goto out_free;
2677 /* if nothing to unset, error out */
2678 if (value == NULL) {
2679 ret = CONFIG_NOTHING_SET;
2680 goto out_free;
2683 store.key = (char *)key;
2684 if (write_section(fd, key, &store) < 0 ||
2685 write_pair(fd, key, value, &store) < 0)
2686 goto write_err_out;
2687 } else {
2688 struct stat st;
2689 size_t copy_begin, copy_end;
2690 int i, new_line = 0;
2691 struct config_options opts;
2693 if (value_regex == NULL)
2694 store.value_regex = NULL;
2695 else if (value_regex == CONFIG_REGEX_NONE)
2696 store.value_regex = CONFIG_REGEX_NONE;
2697 else {
2698 if (value_regex[0] == '!') {
2699 store.do_not_match = 1;
2700 value_regex++;
2701 } else
2702 store.do_not_match = 0;
2704 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2705 if (regcomp(store.value_regex, value_regex,
2706 REG_EXTENDED)) {
2707 error("invalid pattern: %s", value_regex);
2708 free(store.value_regex);
2709 ret = CONFIG_INVALID_PATTERN;
2710 goto out_free;
2714 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2715 store.parsed[0].end = 0;
2717 memset(&opts, 0, sizeof(opts));
2718 opts.event_fn = store_aux_event;
2719 opts.event_fn_data = &store;
2722 * After this, store.parsed will contain offsets of all the
2723 * parsed elements, and store.seen will contain a list of
2724 * matches, as indices into store.parsed.
2726 * As a side effect, we make sure to transform only a valid
2727 * existing config file.
2729 if (git_config_from_file_with_options(store_aux,
2730 config_filename,
2731 &store, &opts)) {
2732 error("invalid config file %s", config_filename);
2733 free(store.key);
2734 if (store.value_regex != NULL &&
2735 store.value_regex != CONFIG_REGEX_NONE) {
2736 regfree(store.value_regex);
2737 free(store.value_regex);
2739 ret = CONFIG_INVALID_FILE;
2740 goto out_free;
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);
2750 /* if nothing to unset, or too many matches, error out */
2751 if ((store.seen_nr == 0 && value == NULL) ||
2752 (store.seen_nr > 1 && multi_replace == 0)) {
2753 ret = CONFIG_NOTHING_SET;
2754 goto out_free;
2757 if (fstat(in_fd, &st) == -1) {
2758 error_errno(_("fstat on %s failed"), config_filename);
2759 ret = CONFIG_INVALID_FILE;
2760 goto out_free;
2763 contents_sz = xsize_t(st.st_size);
2764 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2765 MAP_PRIVATE, in_fd, 0);
2766 if (contents == MAP_FAILED) {
2767 if (errno == ENODEV && S_ISDIR(st.st_mode))
2768 errno = EISDIR;
2769 error_errno("unable to mmap '%s'", config_filename);
2770 ret = CONFIG_INVALID_FILE;
2771 contents = NULL;
2772 goto out_free;
2774 close(in_fd);
2775 in_fd = -1;
2777 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2778 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2779 ret = CONFIG_NO_WRITE;
2780 goto out_free;
2783 if (store.seen_nr == 0) {
2784 if (!store.seen_alloc) {
2785 /* Did not see key nor section */
2786 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2787 store.seen[0] = store.parsed_nr
2788 - !!store.parsed_nr;
2790 store.seen_nr = 1;
2793 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2794 size_t replace_end;
2795 int j = store.seen[i];
2797 new_line = 0;
2798 if (!store.key_seen) {
2799 copy_end = store.parsed[j].end;
2800 /* include '\n' when copying section header */
2801 if (copy_end > 0 && copy_end < contents_sz &&
2802 contents[copy_end - 1] != '\n' &&
2803 contents[copy_end] == '\n')
2804 copy_end++;
2805 replace_end = copy_end;
2806 } else {
2807 replace_end = store.parsed[j].end;
2808 copy_end = store.parsed[j].begin;
2809 if (!value)
2810 maybe_remove_section(&store, contents,
2811 &copy_end,
2812 &replace_end, &i);
2814 * Swallow preceding white-space on the same
2815 * line.
2817 while (copy_end > 0 ) {
2818 char c = contents[copy_end - 1];
2820 if (isspace(c) && c != '\n')
2821 copy_end--;
2822 else
2823 break;
2827 if (copy_end > 0 && contents[copy_end-1] != '\n')
2828 new_line = 1;
2830 /* write the first part of the config */
2831 if (copy_end > copy_begin) {
2832 if (write_in_full(fd, contents + copy_begin,
2833 copy_end - copy_begin) < 0)
2834 goto write_err_out;
2835 if (new_line &&
2836 write_str_in_full(fd, "\n") < 0)
2837 goto write_err_out;
2839 copy_begin = replace_end;
2842 /* write the pair (value == NULL means unset) */
2843 if (value != NULL) {
2844 if (!store.section_seen) {
2845 if (write_section(fd, key, &store) < 0)
2846 goto write_err_out;
2848 if (write_pair(fd, key, value, &store) < 0)
2849 goto write_err_out;
2852 /* write the rest of the config */
2853 if (copy_begin < contents_sz)
2854 if (write_in_full(fd, contents + copy_begin,
2855 contents_sz - copy_begin) < 0)
2856 goto write_err_out;
2858 munmap(contents, contents_sz);
2859 contents = NULL;
2862 if (commit_lock_file(&lock) < 0) {
2863 error_errno("could not write config file %s", config_filename);
2864 ret = CONFIG_NO_WRITE;
2865 goto out_free;
2868 ret = 0;
2870 /* Invalidate the config cache */
2871 git_config_clear();
2873 out_free:
2874 rollback_lock_file(&lock);
2875 free(filename_buf);
2876 if (contents)
2877 munmap(contents, contents_sz);
2878 if (in_fd >= 0)
2879 close(in_fd);
2880 return ret;
2882 write_err_out:
2883 ret = write_error(get_lock_file_path(&lock));
2884 goto out_free;
2888 void git_config_set_multivar_in_file(const char *config_filename,
2889 const char *key, const char *value,
2890 const char *value_regex, int multi_replace)
2892 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2893 value_regex, multi_replace))
2894 return;
2895 if (value)
2896 die(_("could not set '%s' to '%s'"), key, value);
2897 else
2898 die(_("could not unset '%s'"), key);
2901 int git_config_set_multivar_gently(const char *key, const char *value,
2902 const char *value_regex, int multi_replace)
2904 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2905 multi_replace);
2908 void git_config_set_multivar(const char *key, const char *value,
2909 const char *value_regex, int multi_replace)
2911 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2912 multi_replace);
2915 static int section_name_match (const char *buf, const char *name)
2917 int i = 0, j = 0, dot = 0;
2918 if (buf[i] != '[')
2919 return 0;
2920 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2921 if (!dot && isspace(buf[i])) {
2922 dot = 1;
2923 if (name[j++] != '.')
2924 break;
2925 for (i++; isspace(buf[i]); i++)
2926 ; /* do nothing */
2927 if (buf[i] != '"')
2928 break;
2929 continue;
2931 if (buf[i] == '\\' && dot)
2932 i++;
2933 else if (buf[i] == '"' && dot) {
2934 for (i++; isspace(buf[i]); i++)
2935 ; /* do_nothing */
2936 break;
2938 if (buf[i] != name[j++])
2939 break;
2941 if (buf[i] == ']' && name[j] == 0) {
2943 * We match, now just find the right length offset by
2944 * gobbling up any whitespace after it, as well
2946 i++;
2947 for (; buf[i] && isspace(buf[i]); i++)
2948 ; /* do nothing */
2949 return i;
2951 return 0;
2954 static int section_name_is_ok(const char *name)
2956 /* Empty section names are bogus. */
2957 if (!*name)
2958 return 0;
2961 * Before a dot, we must be alphanumeric or dash. After the first dot,
2962 * anything goes, so we can stop checking.
2964 for (; *name && *name != '.'; name++)
2965 if (*name != '-' && !isalnum(*name))
2966 return 0;
2967 return 1;
2970 /* if new_name == NULL, the section is removed instead */
2971 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
2972 const char *old_name,
2973 const char *new_name, int copy)
2975 int ret = 0, remove = 0;
2976 char *filename_buf = NULL;
2977 struct lock_file lock = LOCK_INIT;
2978 int out_fd;
2979 char buf[1024];
2980 FILE *config_file = NULL;
2981 struct stat st;
2982 struct strbuf copystr = STRBUF_INIT;
2983 struct config_store_data store;
2985 memset(&store, 0, sizeof(store));
2987 if (new_name && !section_name_is_ok(new_name)) {
2988 ret = error("invalid section name: %s", new_name);
2989 goto out_no_rollback;
2992 if (!config_filename)
2993 config_filename = filename_buf = git_pathdup("config");
2995 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
2996 if (out_fd < 0) {
2997 ret = error("could not lock config file %s", config_filename);
2998 goto out;
3001 if (!(config_file = fopen(config_filename, "rb"))) {
3002 ret = warn_on_fopen_errors(config_filename);
3003 if (ret)
3004 goto out;
3005 /* no config file means nothing to rename, no error */
3006 goto commit_and_out;
3009 if (fstat(fileno(config_file), &st) == -1) {
3010 ret = error_errno(_("fstat on %s failed"), config_filename);
3011 goto out;
3014 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3015 ret = error_errno("chmod on %s failed",
3016 get_lock_file_path(&lock));
3017 goto out;
3020 while (fgets(buf, sizeof(buf), config_file)) {
3021 int i;
3022 int length;
3023 int is_section = 0;
3024 char *output = buf;
3025 for (i = 0; buf[i] && isspace(buf[i]); i++)
3026 ; /* do nothing */
3027 if (buf[i] == '[') {
3028 /* it's a section */
3029 int offset;
3030 is_section = 1;
3033 * When encountering a new section under -c we
3034 * need to flush out any section we're already
3035 * coping and begin anew. There might be
3036 * multiple [branch "$name"] sections.
3038 if (copystr.len > 0) {
3039 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3040 ret = write_error(get_lock_file_path(&lock));
3041 goto out;
3043 strbuf_reset(&copystr);
3046 offset = section_name_match(&buf[i], old_name);
3047 if (offset > 0) {
3048 ret++;
3049 if (new_name == NULL) {
3050 remove = 1;
3051 continue;
3053 store.baselen = strlen(new_name);
3054 if (!copy) {
3055 if (write_section(out_fd, new_name, &store) < 0) {
3056 ret = write_error(get_lock_file_path(&lock));
3057 goto out;
3060 * We wrote out the new section, with
3061 * a newline, now skip the old
3062 * section's length
3064 output += offset + i;
3065 if (strlen(output) > 0) {
3067 * More content means there's
3068 * a declaration to put on the
3069 * next line; indent with a
3070 * tab
3072 output -= 1;
3073 output[0] = '\t';
3075 } else {
3076 copystr = store_create_section(new_name, &store);
3079 remove = 0;
3081 if (remove)
3082 continue;
3083 length = strlen(output);
3085 if (!is_section && copystr.len > 0) {
3086 strbuf_add(&copystr, output, length);
3089 if (write_in_full(out_fd, output, length) < 0) {
3090 ret = write_error(get_lock_file_path(&lock));
3091 goto out;
3096 * Copy a trailing section at the end of the config, won't be
3097 * flushed by the usual "flush because we have a new section
3098 * logic in the loop above.
3100 if (copystr.len > 0) {
3101 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3102 ret = write_error(get_lock_file_path(&lock));
3103 goto out;
3105 strbuf_reset(&copystr);
3108 fclose(config_file);
3109 config_file = NULL;
3110 commit_and_out:
3111 if (commit_lock_file(&lock) < 0)
3112 ret = error_errno("could not write config file %s",
3113 config_filename);
3114 out:
3115 if (config_file)
3116 fclose(config_file);
3117 rollback_lock_file(&lock);
3118 out_no_rollback:
3119 free(filename_buf);
3120 return ret;
3123 int git_config_rename_section_in_file(const char *config_filename,
3124 const char *old_name, const char *new_name)
3126 return git_config_copy_or_rename_section_in_file(config_filename,
3127 old_name, new_name, 0);
3130 int git_config_rename_section(const char *old_name, const char *new_name)
3132 return git_config_rename_section_in_file(NULL, old_name, new_name);
3135 int git_config_copy_section_in_file(const char *config_filename,
3136 const char *old_name, const char *new_name)
3138 return git_config_copy_or_rename_section_in_file(config_filename,
3139 old_name, new_name, 1);
3142 int git_config_copy_section(const char *old_name, const char *new_name)
3144 return git_config_copy_section_in_file(NULL, old_name, new_name);
3148 * Call this to report error for your variable that should not
3149 * get a boolean value (i.e. "[my] var" means "true").
3151 #undef config_error_nonbool
3152 int config_error_nonbool(const char *var)
3154 return error("missing value for '%s'", var);
3157 int parse_config_key(const char *var,
3158 const char *section,
3159 const char **subsection, int *subsection_len,
3160 const char **key)
3162 const char *dot;
3164 /* Does it start with "section." ? */
3165 if (!skip_prefix(var, section, &var) || *var != '.')
3166 return -1;
3169 * Find the key; we don't know yet if we have a subsection, but we must
3170 * parse backwards from the end, since the subsection may have dots in
3171 * it, too.
3173 dot = strrchr(var, '.');
3174 *key = dot + 1;
3176 /* Did we have a subsection at all? */
3177 if (dot == var) {
3178 if (subsection) {
3179 *subsection = NULL;
3180 *subsection_len = 0;
3183 else {
3184 if (!subsection)
3185 return -1;
3186 *subsection = var + 1;
3187 *subsection_len = dot - *subsection;
3190 return 0;
3193 const char *current_config_origin_type(void)
3195 int type;
3196 if (current_config_kvi)
3197 type = current_config_kvi->origin_type;
3198 else if(cf)
3199 type = cf->origin_type;
3200 else
3201 die("BUG: current_config_origin_type called outside config callback");
3203 switch (type) {
3204 case CONFIG_ORIGIN_BLOB:
3205 return "blob";
3206 case CONFIG_ORIGIN_FILE:
3207 return "file";
3208 case CONFIG_ORIGIN_STDIN:
3209 return "standard input";
3210 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3211 return "submodule-blob";
3212 case CONFIG_ORIGIN_CMDLINE:
3213 return "command line";
3214 default:
3215 die("BUG: unknown config origin type");
3219 const char *current_config_name(void)
3221 const char *name;
3222 if (current_config_kvi)
3223 name = current_config_kvi->filename;
3224 else if (cf)
3225 name = cf->name;
3226 else
3227 die("BUG: current_config_name called outside config callback");
3228 return name ? name : "";
3231 enum config_scope current_config_scope(void)
3233 if (current_config_kvi)
3234 return current_config_kvi->scope;
3235 else
3236 return current_parsing_scope;