Merge branch 'bw/protocol-v2'
[git.git] / config.c
blob139c903f6b3f1f35f2a443ebcd8b09b74ffcb7b5
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "config.h"
10 #include "repository.h"
11 #include "lockfile.h"
12 #include "exec-cmd.h"
13 #include "strbuf.h"
14 #include "quote.h"
15 #include "hashmap.h"
16 #include "string-list.h"
17 #include "object-store.h"
18 #include "utf8.h"
19 #include "dir.h"
20 #include "color.h"
22 struct config_source {
23 struct config_source *prev;
24 union {
25 FILE *file;
26 struct config_buf {
27 const char *buf;
28 size_t len;
29 size_t pos;
30 } buf;
31 } u;
32 enum config_origin_type origin_type;
33 const char *name;
34 const char *path;
35 int die_on_error;
36 int linenr;
37 int eof;
38 struct strbuf value;
39 struct strbuf var;
41 int (*do_fgetc)(struct config_source *c);
42 int (*do_ungetc)(int c, struct config_source *conf);
43 long (*do_ftell)(struct config_source *c);
47 * These variables record the "current" config source, which
48 * can be accessed by parsing callbacks.
50 * The "cf" variable will be non-NULL only when we are actually parsing a real
51 * config source (file, blob, cmdline, etc).
53 * The "current_config_kvi" variable will be non-NULL only when we are feeding
54 * cached config from a configset into a callback.
56 * They should generally never be non-NULL at the same time. If they are both
57 * NULL, then we aren't parsing anything (and depending on the function looking
58 * at the variables, it's either a bug for it to be called in the first place,
59 * or it's a function which can be reused for non-config purposes, and should
60 * fall back to some sane behavior).
62 static struct config_source *cf;
63 static struct key_value_info *current_config_kvi;
66 * Similar to the variables above, this gives access to the "scope" of the
67 * current value (repo, global, etc). For cached values, it can be found via
68 * the current_config_kvi as above. During parsing, the current value can be
69 * found in this variable. It's not part of "cf" because it transcends a single
70 * file (i.e., a file included from .git/config is still in "repo" scope).
72 static enum config_scope current_parsing_scope;
74 static int core_compression_seen;
75 static int pack_compression_seen;
76 static int zlib_compression_seen;
78 static int config_file_fgetc(struct config_source *conf)
80 return getc_unlocked(conf->u.file);
83 static int config_file_ungetc(int c, struct config_source *conf)
85 return ungetc(c, conf->u.file);
88 static long config_file_ftell(struct config_source *conf)
90 return ftell(conf->u.file);
94 static int config_buf_fgetc(struct config_source *conf)
96 if (conf->u.buf.pos < conf->u.buf.len)
97 return conf->u.buf.buf[conf->u.buf.pos++];
99 return EOF;
102 static int config_buf_ungetc(int c, struct config_source *conf)
104 if (conf->u.buf.pos > 0) {
105 conf->u.buf.pos--;
106 if (conf->u.buf.buf[conf->u.buf.pos] != c)
107 BUG("config_buf can only ungetc the same character");
108 return c;
111 return EOF;
114 static long config_buf_ftell(struct config_source *conf)
116 return conf->u.buf.pos;
119 #define MAX_INCLUDE_DEPTH 10
120 static const char include_depth_advice[] =
121 "exceeded maximum include depth (%d) while including\n"
122 " %s\n"
123 "from\n"
124 " %s\n"
125 "Do you have circular includes?";
126 static int handle_path_include(const char *path, struct config_include_data *inc)
128 int ret = 0;
129 struct strbuf buf = STRBUF_INIT;
130 char *expanded;
132 if (!path)
133 return config_error_nonbool("include.path");
135 expanded = expand_user_path(path, 0);
136 if (!expanded)
137 return error("could not expand include path '%s'", path);
138 path = expanded;
141 * Use an absolute path as-is, but interpret relative paths
142 * based on the including config file.
144 if (!is_absolute_path(path)) {
145 char *slash;
147 if (!cf || !cf->path)
148 return error("relative config includes must come from files");
150 slash = find_last_dir_sep(cf->path);
151 if (slash)
152 strbuf_add(&buf, cf->path, slash - cf->path + 1);
153 strbuf_addstr(&buf, path);
154 path = buf.buf;
157 if (!access_or_die(path, R_OK, 0)) {
158 if (++inc->depth > MAX_INCLUDE_DEPTH)
159 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
160 !cf ? "<unknown>" :
161 cf->name ? cf->name :
162 "the command line");
163 ret = git_config_from_file(git_config_include, path, inc);
164 inc->depth--;
166 strbuf_release(&buf);
167 free(expanded);
168 return ret;
171 static int prepare_include_condition_pattern(struct strbuf *pat)
173 struct strbuf path = STRBUF_INIT;
174 char *expanded;
175 int prefix = 0;
177 expanded = expand_user_path(pat->buf, 1);
178 if (expanded) {
179 strbuf_reset(pat);
180 strbuf_addstr(pat, expanded);
181 free(expanded);
184 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
185 const char *slash;
187 if (!cf || !cf->path)
188 return error(_("relative config include "
189 "conditionals must come from files"));
191 strbuf_realpath(&path, cf->path, 1);
192 slash = find_last_dir_sep(path.buf);
193 if (!slash)
194 BUG("how is this possible?");
195 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
196 prefix = slash - path.buf + 1 /* slash */;
197 } else if (!is_absolute_path(pat->buf))
198 strbuf_insert(pat, 0, "**/", 3);
200 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
201 strbuf_addstr(pat, "**");
203 strbuf_release(&path);
204 return prefix;
207 static int include_by_gitdir(const struct config_options *opts,
208 const char *cond, size_t cond_len, int icase)
210 struct strbuf text = STRBUF_INIT;
211 struct strbuf pattern = STRBUF_INIT;
212 int ret = 0, prefix;
213 const char *git_dir;
214 int already_tried_absolute = 0;
216 if (opts->git_dir)
217 git_dir = opts->git_dir;
218 else
219 goto done;
221 strbuf_realpath(&text, git_dir, 1);
222 strbuf_add(&pattern, cond, cond_len);
223 prefix = prepare_include_condition_pattern(&pattern);
225 again:
226 if (prefix < 0)
227 goto done;
229 if (prefix > 0) {
231 * perform literal matching on the prefix part so that
232 * any wildcard character in it can't create side effects.
234 if (text.len < prefix)
235 goto done;
236 if (!icase && strncmp(pattern.buf, text.buf, prefix))
237 goto done;
238 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
239 goto done;
242 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
243 icase ? WM_CASEFOLD : 0);
245 if (!ret && !already_tried_absolute) {
247 * We've tried e.g. matching gitdir:~/work, but if
248 * ~/work is a symlink to /mnt/storage/work
249 * strbuf_realpath() will expand it, so the rule won't
250 * match. Let's match against a
251 * strbuf_add_absolute_path() version of the path,
252 * which'll do the right thing
254 strbuf_reset(&text);
255 strbuf_add_absolute_path(&text, git_dir);
256 already_tried_absolute = 1;
257 goto again;
259 done:
260 strbuf_release(&pattern);
261 strbuf_release(&text);
262 return ret;
265 static int include_condition_is_true(const struct config_options *opts,
266 const char *cond, size_t cond_len)
269 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
270 return include_by_gitdir(opts, cond, cond_len, 0);
271 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
272 return include_by_gitdir(opts, cond, cond_len, 1);
274 /* unknown conditionals are always false */
275 return 0;
278 int git_config_include(const char *var, const char *value, void *data)
280 struct config_include_data *inc = data;
281 const char *cond, *key;
282 int cond_len;
283 int ret;
286 * Pass along all values, including "include" directives; this makes it
287 * possible to query information on the includes themselves.
289 ret = inc->fn(var, value, inc->data);
290 if (ret < 0)
291 return ret;
293 if (!strcmp(var, "include.path"))
294 ret = handle_path_include(value, inc);
296 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
297 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
298 !strcmp(key, "path"))
299 ret = handle_path_include(value, inc);
301 return ret;
304 void git_config_push_parameter(const char *text)
306 struct strbuf env = STRBUF_INIT;
307 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
308 if (old && *old) {
309 strbuf_addstr(&env, old);
310 strbuf_addch(&env, ' ');
312 sq_quote_buf(&env, text);
313 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
314 strbuf_release(&env);
317 static inline int iskeychar(int c)
319 return isalnum(c) || c == '-';
323 * Auxiliary function to sanity-check and split the key into the section
324 * identifier and variable name.
326 * Returns 0 on success, -1 when there is an invalid character in the key and
327 * -2 if there is no section name in the key.
329 * store_key - pointer to char* which will hold a copy of the key with
330 * lowercase section and variable name
331 * baselen - pointer to int which will hold the length of the
332 * section + subsection part, can be NULL
334 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
336 int i, dot, baselen;
337 const char *last_dot = strrchr(key, '.');
340 * Since "key" actually contains the section name and the real
341 * key name separated by a dot, we have to know where the dot is.
344 if (last_dot == NULL || last_dot == key) {
345 if (!quiet)
346 error("key does not contain a section: %s", key);
347 return -CONFIG_NO_SECTION_OR_NAME;
350 if (!last_dot[1]) {
351 if (!quiet)
352 error("key does not contain variable name: %s", key);
353 return -CONFIG_NO_SECTION_OR_NAME;
356 baselen = last_dot - key;
357 if (baselen_)
358 *baselen_ = baselen;
361 * Validate the key and while at it, lower case it for matching.
363 if (store_key)
364 *store_key = xmallocz(strlen(key));
366 dot = 0;
367 for (i = 0; key[i]; i++) {
368 unsigned char c = key[i];
369 if (c == '.')
370 dot = 1;
371 /* Leave the extended basename untouched.. */
372 if (!dot || i > baselen) {
373 if (!iskeychar(c) ||
374 (i == baselen + 1 && !isalpha(c))) {
375 if (!quiet)
376 error("invalid key: %s", key);
377 goto out_free_ret_1;
379 c = tolower(c);
380 } else if (c == '\n') {
381 if (!quiet)
382 error("invalid key (newline): %s", key);
383 goto out_free_ret_1;
385 if (store_key)
386 (*store_key)[i] = c;
389 return 0;
391 out_free_ret_1:
392 if (store_key) {
393 FREE_AND_NULL(*store_key);
395 return -CONFIG_INVALID_KEY;
398 int git_config_parse_key(const char *key, char **store_key, int *baselen)
400 return git_config_parse_key_1(key, store_key, baselen, 0);
403 int git_config_key_is_valid(const char *key)
405 return !git_config_parse_key_1(key, NULL, NULL, 1);
408 int git_config_parse_parameter(const char *text,
409 config_fn_t fn, void *data)
411 const char *value;
412 char *canonical_name;
413 struct strbuf **pair;
414 int ret;
416 pair = strbuf_split_str(text, '=', 2);
417 if (!pair[0])
418 return error("bogus config parameter: %s", text);
420 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
421 strbuf_setlen(pair[0], pair[0]->len - 1);
422 value = pair[1] ? pair[1]->buf : "";
423 } else {
424 value = NULL;
427 strbuf_trim(pair[0]);
428 if (!pair[0]->len) {
429 strbuf_list_free(pair);
430 return error("bogus config parameter: %s", text);
433 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
434 ret = -1;
435 } else {
436 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
437 free(canonical_name);
439 strbuf_list_free(pair);
440 return ret;
443 int git_config_from_parameters(config_fn_t fn, void *data)
445 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
446 int ret = 0;
447 char *envw;
448 const char **argv = NULL;
449 int nr = 0, alloc = 0;
450 int i;
451 struct config_source source;
453 if (!env)
454 return 0;
456 memset(&source, 0, sizeof(source));
457 source.prev = cf;
458 source.origin_type = CONFIG_ORIGIN_CMDLINE;
459 cf = &source;
461 /* sq_dequote will write over it */
462 envw = xstrdup(env);
464 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
465 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
466 goto out;
469 for (i = 0; i < nr; i++) {
470 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
471 ret = -1;
472 goto out;
476 out:
477 free(argv);
478 free(envw);
479 cf = source.prev;
480 return ret;
483 static int get_next_char(void)
485 int c = cf->do_fgetc(cf);
487 if (c == '\r') {
488 /* DOS like systems */
489 c = cf->do_fgetc(cf);
490 if (c != '\n') {
491 if (c != EOF)
492 cf->do_ungetc(c, cf);
493 c = '\r';
496 if (c == '\n')
497 cf->linenr++;
498 if (c == EOF) {
499 cf->eof = 1;
500 cf->linenr++;
501 c = '\n';
503 return c;
506 static char *parse_value(void)
508 int quote = 0, comment = 0, space = 0;
510 strbuf_reset(&cf->value);
511 for (;;) {
512 int c = get_next_char();
513 if (c == '\n') {
514 if (quote) {
515 cf->linenr--;
516 return NULL;
518 return cf->value.buf;
520 if (comment)
521 continue;
522 if (isspace(c) && !quote) {
523 if (cf->value.len)
524 space++;
525 continue;
527 if (!quote) {
528 if (c == ';' || c == '#') {
529 comment = 1;
530 continue;
533 for (; space; space--)
534 strbuf_addch(&cf->value, ' ');
535 if (c == '\\') {
536 c = get_next_char();
537 switch (c) {
538 case '\n':
539 continue;
540 case 't':
541 c = '\t';
542 break;
543 case 'b':
544 c = '\b';
545 break;
546 case 'n':
547 c = '\n';
548 break;
549 /* Some characters escape as themselves */
550 case '\\': case '"':
551 break;
552 /* Reject unknown escape sequences */
553 default:
554 return NULL;
556 strbuf_addch(&cf->value, c);
557 continue;
559 if (c == '"') {
560 quote = 1-quote;
561 continue;
563 strbuf_addch(&cf->value, c);
567 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
569 int c;
570 char *value;
571 int ret;
573 /* Get the full name */
574 for (;;) {
575 c = get_next_char();
576 if (cf->eof)
577 break;
578 if (!iskeychar(c))
579 break;
580 strbuf_addch(name, tolower(c));
583 while (c == ' ' || c == '\t')
584 c = get_next_char();
586 value = NULL;
587 if (c != '\n') {
588 if (c != '=')
589 return -1;
590 value = parse_value();
591 if (!value)
592 return -1;
595 * We already consumed the \n, but we need linenr to point to
596 * the line we just parsed during the call to fn to get
597 * accurate line number in error messages.
599 cf->linenr--;
600 ret = fn(name->buf, value, data);
601 if (ret >= 0)
602 cf->linenr++;
603 return ret;
606 static int get_extended_base_var(struct strbuf *name, int c)
608 do {
609 if (c == '\n')
610 goto error_incomplete_line;
611 c = get_next_char();
612 } while (isspace(c));
614 /* We require the format to be '[base "extension"]' */
615 if (c != '"')
616 return -1;
617 strbuf_addch(name, '.');
619 for (;;) {
620 int c = get_next_char();
621 if (c == '\n')
622 goto error_incomplete_line;
623 if (c == '"')
624 break;
625 if (c == '\\') {
626 c = get_next_char();
627 if (c == '\n')
628 goto error_incomplete_line;
630 strbuf_addch(name, c);
633 /* Final ']' */
634 if (get_next_char() != ']')
635 return -1;
636 return 0;
637 error_incomplete_line:
638 cf->linenr--;
639 return -1;
642 static int get_base_var(struct strbuf *name)
644 for (;;) {
645 int c = get_next_char();
646 if (cf->eof)
647 return -1;
648 if (c == ']')
649 return 0;
650 if (isspace(c))
651 return get_extended_base_var(name, c);
652 if (!iskeychar(c) && c != '.')
653 return -1;
654 strbuf_addch(name, tolower(c));
658 struct parse_event_data {
659 enum config_event_t previous_type;
660 size_t previous_offset;
661 const struct config_options *opts;
664 static int do_event(enum config_event_t type, struct parse_event_data *data)
666 size_t offset;
668 if (!data->opts || !data->opts->event_fn)
669 return 0;
671 if (type == CONFIG_EVENT_WHITESPACE &&
672 data->previous_type == type)
673 return 0;
675 offset = cf->do_ftell(cf);
677 * At EOF, the parser always "inserts" an extra '\n', therefore
678 * the end offset of the event is the current file position, otherwise
679 * we will already have advanced to the next event.
681 if (type != CONFIG_EVENT_EOF)
682 offset--;
684 if (data->previous_type != CONFIG_EVENT_EOF &&
685 data->opts->event_fn(data->previous_type, data->previous_offset,
686 offset, data->opts->event_fn_data) < 0)
687 return -1;
689 data->previous_type = type;
690 data->previous_offset = offset;
692 return 0;
695 static int git_parse_source(config_fn_t fn, void *data,
696 const struct config_options *opts)
698 int comment = 0;
699 int baselen = 0;
700 struct strbuf *var = &cf->var;
701 int error_return = 0;
702 char *error_msg = NULL;
704 /* U+FEFF Byte Order Mark in UTF8 */
705 const char *bomptr = utf8_bom;
707 /* For the parser event callback */
708 struct parse_event_data event_data = {
709 CONFIG_EVENT_EOF, 0, opts
712 for (;;) {
713 int c;
715 c = get_next_char();
716 if (bomptr && *bomptr) {
717 /* We are at the file beginning; skip UTF8-encoded BOM
718 * if present. Sane editors won't put this in on their
719 * own, but e.g. Windows Notepad will do it happily. */
720 if (c == (*bomptr & 0377)) {
721 bomptr++;
722 continue;
723 } else {
724 /* Do not tolerate partial BOM. */
725 if (bomptr != utf8_bom)
726 break;
727 /* No BOM at file beginning. Cool. */
728 bomptr = NULL;
731 if (c == '\n') {
732 if (cf->eof) {
733 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
734 return -1;
735 return 0;
737 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
738 return -1;
739 comment = 0;
740 continue;
742 if (comment)
743 continue;
744 if (isspace(c)) {
745 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
746 return -1;
747 continue;
749 if (c == '#' || c == ';') {
750 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
751 return -1;
752 comment = 1;
753 continue;
755 if (c == '[') {
756 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
757 return -1;
759 /* Reset prior to determining a new stem */
760 strbuf_reset(var);
761 if (get_base_var(var) < 0 || var->len < 1)
762 break;
763 strbuf_addch(var, '.');
764 baselen = var->len;
765 continue;
767 if (!isalpha(c))
768 break;
770 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
771 return -1;
774 * Truncate the var name back to the section header
775 * stem prior to grabbing the suffix part of the name
776 * and the value.
778 strbuf_setlen(var, baselen);
779 strbuf_addch(var, tolower(c));
780 if (get_value(fn, data, var) < 0)
781 break;
784 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
785 return -1;
787 switch (cf->origin_type) {
788 case CONFIG_ORIGIN_BLOB:
789 error_msg = xstrfmt(_("bad config line %d in blob %s"),
790 cf->linenr, cf->name);
791 break;
792 case CONFIG_ORIGIN_FILE:
793 error_msg = xstrfmt(_("bad config line %d in file %s"),
794 cf->linenr, cf->name);
795 break;
796 case CONFIG_ORIGIN_STDIN:
797 error_msg = xstrfmt(_("bad config line %d in standard input"),
798 cf->linenr);
799 break;
800 case CONFIG_ORIGIN_SUBMODULE_BLOB:
801 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
802 cf->linenr, cf->name);
803 break;
804 case CONFIG_ORIGIN_CMDLINE:
805 error_msg = xstrfmt(_("bad config line %d in command line %s"),
806 cf->linenr, cf->name);
807 break;
808 default:
809 error_msg = xstrfmt(_("bad config line %d in %s"),
810 cf->linenr, cf->name);
813 if (cf->die_on_error)
814 die("%s", error_msg);
815 else
816 error_return = error("%s", error_msg);
818 free(error_msg);
819 return error_return;
822 static int parse_unit_factor(const char *end, uintmax_t *val)
824 if (!*end)
825 return 1;
826 else if (!strcasecmp(end, "k")) {
827 *val *= 1024;
828 return 1;
830 else if (!strcasecmp(end, "m")) {
831 *val *= 1024 * 1024;
832 return 1;
834 else if (!strcasecmp(end, "g")) {
835 *val *= 1024 * 1024 * 1024;
836 return 1;
838 return 0;
841 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
843 if (value && *value) {
844 char *end;
845 intmax_t val;
846 uintmax_t uval;
847 uintmax_t factor = 1;
849 errno = 0;
850 val = strtoimax(value, &end, 0);
851 if (errno == ERANGE)
852 return 0;
853 if (!parse_unit_factor(end, &factor)) {
854 errno = EINVAL;
855 return 0;
857 uval = labs(val);
858 uval *= factor;
859 if (uval > max || labs(val) > uval) {
860 errno = ERANGE;
861 return 0;
863 val *= factor;
864 *ret = val;
865 return 1;
867 errno = EINVAL;
868 return 0;
871 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
873 if (value && *value) {
874 char *end;
875 uintmax_t val;
876 uintmax_t oldval;
878 errno = 0;
879 val = strtoumax(value, &end, 0);
880 if (errno == ERANGE)
881 return 0;
882 oldval = val;
883 if (!parse_unit_factor(end, &val)) {
884 errno = EINVAL;
885 return 0;
887 if (val > max || oldval > val) {
888 errno = ERANGE;
889 return 0;
891 *ret = val;
892 return 1;
894 errno = EINVAL;
895 return 0;
898 static int git_parse_int(const char *value, int *ret)
900 intmax_t tmp;
901 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
902 return 0;
903 *ret = tmp;
904 return 1;
907 static int git_parse_int64(const char *value, int64_t *ret)
909 intmax_t tmp;
910 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
911 return 0;
912 *ret = tmp;
913 return 1;
916 int git_parse_ulong(const char *value, unsigned long *ret)
918 uintmax_t tmp;
919 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
920 return 0;
921 *ret = tmp;
922 return 1;
925 static int git_parse_ssize_t(const char *value, ssize_t *ret)
927 intmax_t tmp;
928 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
929 return 0;
930 *ret = tmp;
931 return 1;
934 NORETURN
935 static void die_bad_number(const char *name, const char *value)
937 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
939 if (!value)
940 value = "";
942 if (!(cf && cf->name))
943 die(_("bad numeric config value '%s' for '%s': %s"),
944 value, name, error_type);
946 switch (cf->origin_type) {
947 case CONFIG_ORIGIN_BLOB:
948 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
949 value, name, cf->name, error_type);
950 case CONFIG_ORIGIN_FILE:
951 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
952 value, name, cf->name, error_type);
953 case CONFIG_ORIGIN_STDIN:
954 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
955 value, name, error_type);
956 case CONFIG_ORIGIN_SUBMODULE_BLOB:
957 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
958 value, name, cf->name, error_type);
959 case CONFIG_ORIGIN_CMDLINE:
960 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
961 value, name, cf->name, error_type);
962 default:
963 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
964 value, name, cf->name, error_type);
968 int git_config_int(const char *name, const char *value)
970 int ret;
971 if (!git_parse_int(value, &ret))
972 die_bad_number(name, value);
973 return ret;
976 int64_t git_config_int64(const char *name, const char *value)
978 int64_t ret;
979 if (!git_parse_int64(value, &ret))
980 die_bad_number(name, value);
981 return ret;
984 unsigned long git_config_ulong(const char *name, const char *value)
986 unsigned long ret;
987 if (!git_parse_ulong(value, &ret))
988 die_bad_number(name, value);
989 return ret;
992 ssize_t git_config_ssize_t(const char *name, const char *value)
994 ssize_t ret;
995 if (!git_parse_ssize_t(value, &ret))
996 die_bad_number(name, value);
997 return ret;
1000 static int git_parse_maybe_bool_text(const char *value)
1002 if (!value)
1003 return 1;
1004 if (!*value)
1005 return 0;
1006 if (!strcasecmp(value, "true")
1007 || !strcasecmp(value, "yes")
1008 || !strcasecmp(value, "on"))
1009 return 1;
1010 if (!strcasecmp(value, "false")
1011 || !strcasecmp(value, "no")
1012 || !strcasecmp(value, "off"))
1013 return 0;
1014 return -1;
1017 int git_parse_maybe_bool(const char *value)
1019 int v = git_parse_maybe_bool_text(value);
1020 if (0 <= v)
1021 return v;
1022 if (git_parse_int(value, &v))
1023 return !!v;
1024 return -1;
1027 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1029 int v = git_parse_maybe_bool_text(value);
1030 if (0 <= v) {
1031 *is_bool = 1;
1032 return v;
1034 *is_bool = 0;
1035 return git_config_int(name, value);
1038 int git_config_bool(const char *name, const char *value)
1040 int discard;
1041 return !!git_config_bool_or_int(name, value, &discard);
1044 int git_config_string(const char **dest, const char *var, const char *value)
1046 if (!value)
1047 return config_error_nonbool(var);
1048 *dest = xstrdup(value);
1049 return 0;
1052 int git_config_pathname(const char **dest, const char *var, const char *value)
1054 if (!value)
1055 return config_error_nonbool(var);
1056 *dest = expand_user_path(value, 0);
1057 if (!*dest)
1058 die(_("failed to expand user dir in: '%s'"), value);
1059 return 0;
1062 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1064 if (!value)
1065 return config_error_nonbool(var);
1066 if (parse_expiry_date(value, timestamp))
1067 return error(_("'%s' for '%s' is not a valid timestamp"),
1068 value, var);
1069 return 0;
1072 int git_config_color(char *dest, const char *var, const char *value)
1074 if (!value)
1075 return config_error_nonbool(var);
1076 if (color_parse(value, dest) < 0)
1077 return -1;
1078 return 0;
1081 static int git_default_core_config(const char *var, const char *value)
1083 /* This needs a better name */
1084 if (!strcmp(var, "core.filemode")) {
1085 trust_executable_bit = git_config_bool(var, value);
1086 return 0;
1088 if (!strcmp(var, "core.trustctime")) {
1089 trust_ctime = git_config_bool(var, value);
1090 return 0;
1092 if (!strcmp(var, "core.checkstat")) {
1093 if (!strcasecmp(value, "default"))
1094 check_stat = 1;
1095 else if (!strcasecmp(value, "minimal"))
1096 check_stat = 0;
1099 if (!strcmp(var, "core.quotepath")) {
1100 quote_path_fully = git_config_bool(var, value);
1101 return 0;
1104 if (!strcmp(var, "core.symlinks")) {
1105 has_symlinks = git_config_bool(var, value);
1106 return 0;
1109 if (!strcmp(var, "core.ignorecase")) {
1110 ignore_case = git_config_bool(var, value);
1111 return 0;
1114 if (!strcmp(var, "core.attributesfile"))
1115 return git_config_pathname(&git_attributes_file, var, value);
1117 if (!strcmp(var, "core.hookspath"))
1118 return git_config_pathname(&git_hooks_path, var, value);
1120 if (!strcmp(var, "core.bare")) {
1121 is_bare_repository_cfg = git_config_bool(var, value);
1122 return 0;
1125 if (!strcmp(var, "core.ignorestat")) {
1126 assume_unchanged = git_config_bool(var, value);
1127 return 0;
1130 if (!strcmp(var, "core.prefersymlinkrefs")) {
1131 prefer_symlink_refs = git_config_bool(var, value);
1132 return 0;
1135 if (!strcmp(var, "core.logallrefupdates")) {
1136 if (value && !strcasecmp(value, "always"))
1137 log_all_ref_updates = LOG_REFS_ALWAYS;
1138 else if (git_config_bool(var, value))
1139 log_all_ref_updates = LOG_REFS_NORMAL;
1140 else
1141 log_all_ref_updates = LOG_REFS_NONE;
1142 return 0;
1145 if (!strcmp(var, "core.warnambiguousrefs")) {
1146 warn_ambiguous_refs = git_config_bool(var, value);
1147 return 0;
1150 if (!strcmp(var, "core.abbrev")) {
1151 if (!value)
1152 return config_error_nonbool(var);
1153 if (!strcasecmp(value, "auto"))
1154 default_abbrev = -1;
1155 else {
1156 int abbrev = git_config_int(var, value);
1157 if (abbrev < minimum_abbrev || abbrev > 40)
1158 return error("abbrev length out of range: %d", abbrev);
1159 default_abbrev = abbrev;
1161 return 0;
1164 if (!strcmp(var, "core.disambiguate"))
1165 return set_disambiguate_hint_config(var, value);
1167 if (!strcmp(var, "core.loosecompression")) {
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 zlib_compression_level = level;
1174 zlib_compression_seen = 1;
1175 return 0;
1178 if (!strcmp(var, "core.compression")) {
1179 int level = git_config_int(var, value);
1180 if (level == -1)
1181 level = Z_DEFAULT_COMPRESSION;
1182 else if (level < 0 || level > Z_BEST_COMPRESSION)
1183 die(_("bad zlib compression level %d"), level);
1184 core_compression_level = level;
1185 core_compression_seen = 1;
1186 if (!zlib_compression_seen)
1187 zlib_compression_level = level;
1188 if (!pack_compression_seen)
1189 pack_compression_level = level;
1190 return 0;
1193 if (!strcmp(var, "core.packedgitwindowsize")) {
1194 int pgsz_x2 = getpagesize() * 2;
1195 packed_git_window_size = git_config_ulong(var, value);
1197 /* This value must be multiple of (pagesize * 2) */
1198 packed_git_window_size /= pgsz_x2;
1199 if (packed_git_window_size < 1)
1200 packed_git_window_size = 1;
1201 packed_git_window_size *= pgsz_x2;
1202 return 0;
1205 if (!strcmp(var, "core.bigfilethreshold")) {
1206 big_file_threshold = git_config_ulong(var, value);
1207 return 0;
1210 if (!strcmp(var, "core.packedgitlimit")) {
1211 packed_git_limit = git_config_ulong(var, value);
1212 return 0;
1215 if (!strcmp(var, "core.deltabasecachelimit")) {
1216 delta_base_cache_limit = git_config_ulong(var, value);
1217 return 0;
1220 if (!strcmp(var, "core.autocrlf")) {
1221 if (value && !strcasecmp(value, "input")) {
1222 auto_crlf = AUTO_CRLF_INPUT;
1223 return 0;
1225 auto_crlf = git_config_bool(var, value);
1226 return 0;
1229 if (!strcmp(var, "core.safecrlf")) {
1230 int eol_rndtrp_die;
1231 if (value && !strcasecmp(value, "warn")) {
1232 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1233 return 0;
1235 eol_rndtrp_die = git_config_bool(var, value);
1236 global_conv_flags_eol = eol_rndtrp_die ?
1237 CONV_EOL_RNDTRP_DIE : 0;
1238 return 0;
1241 if (!strcmp(var, "core.eol")) {
1242 if (value && !strcasecmp(value, "lf"))
1243 core_eol = EOL_LF;
1244 else if (value && !strcasecmp(value, "crlf"))
1245 core_eol = EOL_CRLF;
1246 else if (value && !strcasecmp(value, "native"))
1247 core_eol = EOL_NATIVE;
1248 else
1249 core_eol = EOL_UNSET;
1250 return 0;
1253 if (!strcmp(var, "core.checkroundtripencoding")) {
1254 check_roundtrip_encoding = xstrdup(value);
1255 return 0;
1258 if (!strcmp(var, "core.notesref")) {
1259 notes_ref_name = xstrdup(value);
1260 return 0;
1263 if (!strcmp(var, "core.editor"))
1264 return git_config_string(&editor_program, var, value);
1266 if (!strcmp(var, "core.commentchar")) {
1267 if (!value)
1268 return config_error_nonbool(var);
1269 else if (!strcasecmp(value, "auto"))
1270 auto_comment_line_char = 1;
1271 else if (value[0] && !value[1]) {
1272 comment_line_char = value[0];
1273 auto_comment_line_char = 0;
1274 } else
1275 return error("core.commentChar should only be one character");
1276 return 0;
1279 if (!strcmp(var, "core.askpass"))
1280 return git_config_string(&askpass_program, var, value);
1282 if (!strcmp(var, "core.excludesfile"))
1283 return git_config_pathname(&excludes_file, var, value);
1285 if (!strcmp(var, "core.whitespace")) {
1286 if (!value)
1287 return config_error_nonbool(var);
1288 whitespace_rule_cfg = parse_whitespace_rule(value);
1289 return 0;
1292 if (!strcmp(var, "core.fsyncobjectfiles")) {
1293 fsync_object_files = git_config_bool(var, value);
1294 return 0;
1297 if (!strcmp(var, "core.preloadindex")) {
1298 core_preload_index = git_config_bool(var, value);
1299 return 0;
1302 if (!strcmp(var, "core.createobject")) {
1303 if (!strcmp(value, "rename"))
1304 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1305 else if (!strcmp(value, "link"))
1306 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1307 else
1308 die(_("invalid mode for object creation: %s"), value);
1309 return 0;
1312 if (!strcmp(var, "core.commitgraph")) {
1313 core_commit_graph = git_config_bool(var, value);
1314 return 0;
1317 if (!strcmp(var, "core.sparsecheckout")) {
1318 core_apply_sparse_checkout = git_config_bool(var, value);
1319 return 0;
1322 if (!strcmp(var, "core.precomposeunicode")) {
1323 precomposed_unicode = git_config_bool(var, value);
1324 return 0;
1327 if (!strcmp(var, "core.protecthfs")) {
1328 protect_hfs = git_config_bool(var, value);
1329 return 0;
1332 if (!strcmp(var, "core.protectntfs")) {
1333 protect_ntfs = git_config_bool(var, value);
1334 return 0;
1337 if (!strcmp(var, "core.hidedotfiles")) {
1338 if (value && !strcasecmp(value, "dotgitonly"))
1339 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1340 else
1341 hide_dotfiles = git_config_bool(var, value);
1342 return 0;
1345 if (!strcmp(var, "core.partialclonefilter")) {
1346 return git_config_string(&core_partial_clone_filter_default,
1347 var, value);
1350 /* Add other config variables here and to Documentation/config.txt. */
1351 return 0;
1354 static int git_default_i18n_config(const char *var, const char *value)
1356 if (!strcmp(var, "i18n.commitencoding"))
1357 return git_config_string(&git_commit_encoding, var, value);
1359 if (!strcmp(var, "i18n.logoutputencoding"))
1360 return git_config_string(&git_log_output_encoding, var, value);
1362 /* Add other config variables here and to Documentation/config.txt. */
1363 return 0;
1366 static int git_default_branch_config(const char *var, const char *value)
1368 if (!strcmp(var, "branch.autosetupmerge")) {
1369 if (value && !strcasecmp(value, "always")) {
1370 git_branch_track = BRANCH_TRACK_ALWAYS;
1371 return 0;
1373 git_branch_track = git_config_bool(var, value);
1374 return 0;
1376 if (!strcmp(var, "branch.autosetuprebase")) {
1377 if (!value)
1378 return config_error_nonbool(var);
1379 else if (!strcmp(value, "never"))
1380 autorebase = AUTOREBASE_NEVER;
1381 else if (!strcmp(value, "local"))
1382 autorebase = AUTOREBASE_LOCAL;
1383 else if (!strcmp(value, "remote"))
1384 autorebase = AUTOREBASE_REMOTE;
1385 else if (!strcmp(value, "always"))
1386 autorebase = AUTOREBASE_ALWAYS;
1387 else
1388 return error("malformed value for %s", var);
1389 return 0;
1392 /* Add other config variables here and to Documentation/config.txt. */
1393 return 0;
1396 static int git_default_push_config(const char *var, const char *value)
1398 if (!strcmp(var, "push.default")) {
1399 if (!value)
1400 return config_error_nonbool(var);
1401 else if (!strcmp(value, "nothing"))
1402 push_default = PUSH_DEFAULT_NOTHING;
1403 else if (!strcmp(value, "matching"))
1404 push_default = PUSH_DEFAULT_MATCHING;
1405 else if (!strcmp(value, "simple"))
1406 push_default = PUSH_DEFAULT_SIMPLE;
1407 else if (!strcmp(value, "upstream"))
1408 push_default = PUSH_DEFAULT_UPSTREAM;
1409 else if (!strcmp(value, "tracking")) /* deprecated */
1410 push_default = PUSH_DEFAULT_UPSTREAM;
1411 else if (!strcmp(value, "current"))
1412 push_default = PUSH_DEFAULT_CURRENT;
1413 else {
1414 error("malformed value for %s: %s", var, value);
1415 return error("Must be one of nothing, matching, simple, "
1416 "upstream or current.");
1418 return 0;
1421 /* Add other config variables here and to Documentation/config.txt. */
1422 return 0;
1425 static int git_default_mailmap_config(const char *var, const char *value)
1427 if (!strcmp(var, "mailmap.file"))
1428 return git_config_pathname(&git_mailmap_file, var, value);
1429 if (!strcmp(var, "mailmap.blob"))
1430 return git_config_string(&git_mailmap_blob, var, value);
1432 /* Add other config variables here and to Documentation/config.txt. */
1433 return 0;
1436 int git_default_config(const char *var, const char *value, void *dummy)
1438 if (starts_with(var, "core."))
1439 return git_default_core_config(var, value);
1441 if (starts_with(var, "user."))
1442 return git_ident_config(var, value, dummy);
1444 if (starts_with(var, "i18n."))
1445 return git_default_i18n_config(var, value);
1447 if (starts_with(var, "branch."))
1448 return git_default_branch_config(var, value);
1450 if (starts_with(var, "push."))
1451 return git_default_push_config(var, value);
1453 if (starts_with(var, "mailmap."))
1454 return git_default_mailmap_config(var, value);
1456 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1457 return git_default_advice_config(var, value);
1459 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1460 pager_use_color = git_config_bool(var,value);
1461 return 0;
1464 if (!strcmp(var, "pack.packsizelimit")) {
1465 pack_size_limit_cfg = git_config_ulong(var, value);
1466 return 0;
1469 if (!strcmp(var, "pack.compression")) {
1470 int level = git_config_int(var, value);
1471 if (level == -1)
1472 level = Z_DEFAULT_COMPRESSION;
1473 else if (level < 0 || level > Z_BEST_COMPRESSION)
1474 die(_("bad pack compression level %d"), level);
1475 pack_compression_level = level;
1476 pack_compression_seen = 1;
1477 return 0;
1480 /* Add other config variables here and to Documentation/config.txt. */
1481 return 0;
1485 * All source specific fields in the union, die_on_error, name and the callbacks
1486 * fgetc, ungetc, ftell of top need to be initialized before calling
1487 * this function.
1489 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1490 const struct config_options *opts)
1492 int ret;
1494 /* push config-file parsing state stack */
1495 top->prev = cf;
1496 top->linenr = 1;
1497 top->eof = 0;
1498 strbuf_init(&top->value, 1024);
1499 strbuf_init(&top->var, 1024);
1500 cf = top;
1502 ret = git_parse_source(fn, data, opts);
1504 /* pop config-file parsing state stack */
1505 strbuf_release(&top->value);
1506 strbuf_release(&top->var);
1507 cf = top->prev;
1509 return ret;
1512 static int do_config_from_file(config_fn_t fn,
1513 const enum config_origin_type origin_type,
1514 const char *name, const char *path, FILE *f,
1515 void *data, const struct config_options *opts)
1517 struct config_source top;
1518 int ret;
1520 top.u.file = f;
1521 top.origin_type = origin_type;
1522 top.name = name;
1523 top.path = path;
1524 top.die_on_error = 1;
1525 top.do_fgetc = config_file_fgetc;
1526 top.do_ungetc = config_file_ungetc;
1527 top.do_ftell = config_file_ftell;
1529 flockfile(f);
1530 ret = do_config_from(&top, fn, data, opts);
1531 funlockfile(f);
1532 return ret;
1535 static int git_config_from_stdin(config_fn_t fn, void *data)
1537 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1538 data, NULL);
1541 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1542 void *data,
1543 const struct config_options *opts)
1545 int ret = -1;
1546 FILE *f;
1548 f = fopen_or_warn(filename, "r");
1549 if (f) {
1550 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1551 filename, f, data, opts);
1552 fclose(f);
1554 return ret;
1557 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1559 return git_config_from_file_with_options(fn, filename, data, NULL);
1562 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1563 const char *name, const char *buf, size_t len, void *data)
1565 struct config_source top;
1567 top.u.buf.buf = buf;
1568 top.u.buf.len = len;
1569 top.u.buf.pos = 0;
1570 top.origin_type = origin_type;
1571 top.name = name;
1572 top.path = NULL;
1573 top.die_on_error = 0;
1574 top.do_fgetc = config_buf_fgetc;
1575 top.do_ungetc = config_buf_ungetc;
1576 top.do_ftell = config_buf_ftell;
1578 return do_config_from(&top, fn, data, NULL);
1581 int git_config_from_blob_oid(config_fn_t fn,
1582 const char *name,
1583 const struct object_id *oid,
1584 void *data)
1586 enum object_type type;
1587 char *buf;
1588 unsigned long size;
1589 int ret;
1591 buf = read_object_file(oid, &type, &size);
1592 if (!buf)
1593 return error("unable to load config blob object '%s'", name);
1594 if (type != OBJ_BLOB) {
1595 free(buf);
1596 return error("reference '%s' does not point to a blob", name);
1599 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1600 free(buf);
1602 return ret;
1605 static int git_config_from_blob_ref(config_fn_t fn,
1606 const char *name,
1607 void *data)
1609 struct object_id oid;
1611 if (get_oid(name, &oid) < 0)
1612 return error("unable to resolve config blob '%s'", name);
1613 return git_config_from_blob_oid(fn, name, &oid, data);
1616 const char *git_etc_gitconfig(void)
1618 static const char *system_wide;
1619 if (!system_wide)
1620 system_wide = system_path(ETC_GITCONFIG);
1621 return system_wide;
1625 * Parse environment variable 'k' as a boolean (in various
1626 * possible spellings); if missing, use the default value 'def'.
1628 int git_env_bool(const char *k, int def)
1630 const char *v = getenv(k);
1631 return v ? git_config_bool(k, v) : def;
1635 * Parse environment variable 'k' as ulong with possibly a unit
1636 * suffix; if missing, use the default value 'val'.
1638 unsigned long git_env_ulong(const char *k, unsigned long val)
1640 const char *v = getenv(k);
1641 if (v && !git_parse_ulong(v, &val))
1642 die("failed to parse %s", k);
1643 return val;
1646 int git_config_system(void)
1648 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1651 static int do_git_config_sequence(const struct config_options *opts,
1652 config_fn_t fn, void *data)
1654 int ret = 0;
1655 char *xdg_config = xdg_config_home("config");
1656 char *user_config = expand_user_path("~/.gitconfig", 0);
1657 char *repo_config;
1659 if (opts->commondir)
1660 repo_config = mkpathdup("%s/config", opts->commondir);
1661 else
1662 repo_config = NULL;
1664 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1665 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1666 ret += git_config_from_file(fn, git_etc_gitconfig(),
1667 data);
1669 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1670 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1671 ret += git_config_from_file(fn, xdg_config, data);
1673 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1674 ret += git_config_from_file(fn, user_config, data);
1676 current_parsing_scope = CONFIG_SCOPE_REPO;
1677 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1678 ret += git_config_from_file(fn, repo_config, data);
1680 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1681 if (git_config_from_parameters(fn, data) < 0)
1682 die(_("unable to parse command-line config"));
1684 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1685 free(xdg_config);
1686 free(user_config);
1687 free(repo_config);
1688 return ret;
1691 int config_with_options(config_fn_t fn, void *data,
1692 struct git_config_source *config_source,
1693 const struct config_options *opts)
1695 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1697 if (opts->respect_includes) {
1698 inc.fn = fn;
1699 inc.data = data;
1700 inc.opts = opts;
1701 fn = git_config_include;
1702 data = &inc;
1706 * If we have a specific filename, use it. Otherwise, follow the
1707 * regular lookup sequence.
1709 if (config_source && config_source->use_stdin)
1710 return git_config_from_stdin(fn, data);
1711 else if (config_source && config_source->file)
1712 return git_config_from_file(fn, config_source->file, data);
1713 else if (config_source && config_source->blob)
1714 return git_config_from_blob_ref(fn, config_source->blob, data);
1716 return do_git_config_sequence(opts, fn, data);
1719 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1721 int i, value_index;
1722 struct string_list *values;
1723 struct config_set_element *entry;
1724 struct configset_list *list = &cs->list;
1726 for (i = 0; i < list->nr; i++) {
1727 entry = list->items[i].e;
1728 value_index = list->items[i].value_index;
1729 values = &entry->value_list;
1731 current_config_kvi = values->items[value_index].util;
1733 if (fn(entry->key, values->items[value_index].string, data) < 0)
1734 git_die_config_linenr(entry->key,
1735 current_config_kvi->filename,
1736 current_config_kvi->linenr);
1738 current_config_kvi = NULL;
1742 void read_early_config(config_fn_t cb, void *data)
1744 struct config_options opts = {0};
1745 struct strbuf commondir = STRBUF_INIT;
1746 struct strbuf gitdir = STRBUF_INIT;
1748 opts.respect_includes = 1;
1750 if (have_git_dir()) {
1751 opts.commondir = get_git_common_dir();
1752 opts.git_dir = get_git_dir();
1754 * When setup_git_directory() was not yet asked to discover the
1755 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1756 * is any repository config we should use (but unlike
1757 * setup_git_directory_gently(), no global state is changed, most
1758 * notably, the current working directory is still the same after the
1759 * call).
1761 } else if (!discover_git_directory(&commondir, &gitdir)) {
1762 opts.commondir = commondir.buf;
1763 opts.git_dir = gitdir.buf;
1766 config_with_options(cb, data, NULL, &opts);
1768 strbuf_release(&commondir);
1769 strbuf_release(&gitdir);
1772 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1774 struct config_set_element k;
1775 struct config_set_element *found_entry;
1776 char *normalized_key;
1778 * `key` may come from the user, so normalize it before using it
1779 * for querying entries from the hashmap.
1781 if (git_config_parse_key(key, &normalized_key, NULL))
1782 return NULL;
1784 hashmap_entry_init(&k, strhash(normalized_key));
1785 k.key = normalized_key;
1786 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1787 free(normalized_key);
1788 return found_entry;
1791 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1793 struct config_set_element *e;
1794 struct string_list_item *si;
1795 struct configset_list_item *l_item;
1796 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1798 e = configset_find_element(cs, key);
1800 * Since the keys are being fed by git_config*() callback mechanism, they
1801 * are already normalized. So simply add them without any further munging.
1803 if (!e) {
1804 e = xmalloc(sizeof(*e));
1805 hashmap_entry_init(e, strhash(key));
1806 e->key = xstrdup(key);
1807 string_list_init(&e->value_list, 1);
1808 hashmap_add(&cs->config_hash, e);
1810 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1812 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1813 l_item = &cs->list.items[cs->list.nr++];
1814 l_item->e = e;
1815 l_item->value_index = e->value_list.nr - 1;
1817 if (!cf)
1818 BUG("configset_add_value has no source");
1819 if (cf->name) {
1820 kv_info->filename = strintern(cf->name);
1821 kv_info->linenr = cf->linenr;
1822 kv_info->origin_type = cf->origin_type;
1823 } else {
1824 /* for values read from `git_config_from_parameters()` */
1825 kv_info->filename = NULL;
1826 kv_info->linenr = -1;
1827 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1829 kv_info->scope = current_parsing_scope;
1830 si->util = kv_info;
1832 return 0;
1835 static int config_set_element_cmp(const void *unused_cmp_data,
1836 const void *entry,
1837 const void *entry_or_key,
1838 const void *unused_keydata)
1840 const struct config_set_element *e1 = entry;
1841 const struct config_set_element *e2 = entry_or_key;
1843 return strcmp(e1->key, e2->key);
1846 void git_configset_init(struct config_set *cs)
1848 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1849 cs->hash_initialized = 1;
1850 cs->list.nr = 0;
1851 cs->list.alloc = 0;
1852 cs->list.items = NULL;
1855 void git_configset_clear(struct config_set *cs)
1857 struct config_set_element *entry;
1858 struct hashmap_iter iter;
1859 if (!cs->hash_initialized)
1860 return;
1862 hashmap_iter_init(&cs->config_hash, &iter);
1863 while ((entry = hashmap_iter_next(&iter))) {
1864 free(entry->key);
1865 string_list_clear(&entry->value_list, 1);
1867 hashmap_free(&cs->config_hash, 1);
1868 cs->hash_initialized = 0;
1869 free(cs->list.items);
1870 cs->list.nr = 0;
1871 cs->list.alloc = 0;
1872 cs->list.items = NULL;
1875 static int config_set_callback(const char *key, const char *value, void *cb)
1877 struct config_set *cs = cb;
1878 configset_add_value(cs, key, value);
1879 return 0;
1882 int git_configset_add_file(struct config_set *cs, const char *filename)
1884 return git_config_from_file(config_set_callback, filename, cs);
1887 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1889 const struct string_list *values = NULL;
1891 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1892 * queried key in the files of the configset, the value returned will be the last
1893 * value in the value list for that key.
1895 values = git_configset_get_value_multi(cs, key);
1897 if (!values)
1898 return 1;
1899 assert(values->nr > 0);
1900 *value = values->items[values->nr - 1].string;
1901 return 0;
1904 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1906 struct config_set_element *e = configset_find_element(cs, key);
1907 return e ? &e->value_list : NULL;
1910 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1912 const char *value;
1913 if (!git_configset_get_value(cs, key, &value))
1914 return git_config_string(dest, key, value);
1915 else
1916 return 1;
1919 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1921 return git_configset_get_string_const(cs, key, (const char **)dest);
1924 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1926 const char *value;
1927 if (!git_configset_get_value(cs, key, &value)) {
1928 *dest = git_config_int(key, value);
1929 return 0;
1930 } else
1931 return 1;
1934 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1936 const char *value;
1937 if (!git_configset_get_value(cs, key, &value)) {
1938 *dest = git_config_ulong(key, value);
1939 return 0;
1940 } else
1941 return 1;
1944 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1946 const char *value;
1947 if (!git_configset_get_value(cs, key, &value)) {
1948 *dest = git_config_bool(key, value);
1949 return 0;
1950 } else
1951 return 1;
1954 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1955 int *is_bool, int *dest)
1957 const char *value;
1958 if (!git_configset_get_value(cs, key, &value)) {
1959 *dest = git_config_bool_or_int(key, value, is_bool);
1960 return 0;
1961 } else
1962 return 1;
1965 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1967 const char *value;
1968 if (!git_configset_get_value(cs, key, &value)) {
1969 *dest = git_parse_maybe_bool(value);
1970 if (*dest == -1)
1971 return -1;
1972 return 0;
1973 } else
1974 return 1;
1977 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1979 const char *value;
1980 if (!git_configset_get_value(cs, key, &value))
1981 return git_config_pathname(dest, key, value);
1982 else
1983 return 1;
1986 /* Functions use to read configuration from a repository */
1987 static void repo_read_config(struct repository *repo)
1989 struct config_options opts;
1991 opts.respect_includes = 1;
1992 opts.commondir = repo->commondir;
1993 opts.git_dir = repo->gitdir;
1995 if (!repo->config)
1996 repo->config = xcalloc(1, sizeof(struct config_set));
1997 else
1998 git_configset_clear(repo->config);
2000 git_configset_init(repo->config);
2002 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2004 * config_with_options() normally returns only
2005 * zero, as most errors are fatal, and
2006 * non-fatal potential errors are guarded by "if"
2007 * statements that are entered only when no error is
2008 * possible.
2010 * If we ever encounter a non-fatal error, it means
2011 * something went really wrong and we should stop
2012 * immediately.
2014 die(_("unknown error occurred while reading the configuration files"));
2017 static void git_config_check_init(struct repository *repo)
2019 if (repo->config && repo->config->hash_initialized)
2020 return;
2021 repo_read_config(repo);
2024 static void repo_config_clear(struct repository *repo)
2026 if (!repo->config || !repo->config->hash_initialized)
2027 return;
2028 git_configset_clear(repo->config);
2031 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2033 git_config_check_init(repo);
2034 configset_iter(repo->config, fn, data);
2037 int repo_config_get_value(struct repository *repo,
2038 const char *key, const char **value)
2040 git_config_check_init(repo);
2041 return git_configset_get_value(repo->config, key, value);
2044 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2045 const char *key)
2047 git_config_check_init(repo);
2048 return git_configset_get_value_multi(repo->config, key);
2051 int repo_config_get_string_const(struct repository *repo,
2052 const char *key, const char **dest)
2054 int ret;
2055 git_config_check_init(repo);
2056 ret = git_configset_get_string_const(repo->config, key, dest);
2057 if (ret < 0)
2058 git_die_config(key, NULL);
2059 return ret;
2062 int repo_config_get_string(struct repository *repo,
2063 const char *key, char **dest)
2065 git_config_check_init(repo);
2066 return repo_config_get_string_const(repo, key, (const char **)dest);
2069 int repo_config_get_int(struct repository *repo,
2070 const char *key, int *dest)
2072 git_config_check_init(repo);
2073 return git_configset_get_int(repo->config, key, dest);
2076 int repo_config_get_ulong(struct repository *repo,
2077 const char *key, unsigned long *dest)
2079 git_config_check_init(repo);
2080 return git_configset_get_ulong(repo->config, key, dest);
2083 int repo_config_get_bool(struct repository *repo,
2084 const char *key, int *dest)
2086 git_config_check_init(repo);
2087 return git_configset_get_bool(repo->config, key, dest);
2090 int repo_config_get_bool_or_int(struct repository *repo,
2091 const char *key, int *is_bool, int *dest)
2093 git_config_check_init(repo);
2094 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2097 int repo_config_get_maybe_bool(struct repository *repo,
2098 const char *key, int *dest)
2100 git_config_check_init(repo);
2101 return git_configset_get_maybe_bool(repo->config, key, dest);
2104 int repo_config_get_pathname(struct repository *repo,
2105 const char *key, const char **dest)
2107 int ret;
2108 git_config_check_init(repo);
2109 ret = git_configset_get_pathname(repo->config, key, dest);
2110 if (ret < 0)
2111 git_die_config(key, NULL);
2112 return ret;
2115 /* Functions used historically to read configuration from 'the_repository' */
2116 void git_config(config_fn_t fn, void *data)
2118 repo_config(the_repository, fn, data);
2121 void git_config_clear(void)
2123 repo_config_clear(the_repository);
2126 int git_config_get_value(const char *key, const char **value)
2128 return repo_config_get_value(the_repository, key, value);
2131 const struct string_list *git_config_get_value_multi(const char *key)
2133 return repo_config_get_value_multi(the_repository, key);
2136 int git_config_get_string_const(const char *key, const char **dest)
2138 return repo_config_get_string_const(the_repository, key, dest);
2141 int git_config_get_string(const char *key, char **dest)
2143 return repo_config_get_string(the_repository, key, dest);
2146 int git_config_get_int(const char *key, int *dest)
2148 return repo_config_get_int(the_repository, key, dest);
2151 int git_config_get_ulong(const char *key, unsigned long *dest)
2153 return repo_config_get_ulong(the_repository, key, dest);
2156 int git_config_get_bool(const char *key, int *dest)
2158 return repo_config_get_bool(the_repository, key, dest);
2161 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2163 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2166 int git_config_get_maybe_bool(const char *key, int *dest)
2168 return repo_config_get_maybe_bool(the_repository, key, dest);
2171 int git_config_get_pathname(const char *key, const char **dest)
2173 return repo_config_get_pathname(the_repository, key, dest);
2177 * Note: This function exists solely to maintain backward compatibility with
2178 * 'fetch' and 'update_clone' storing configuration in '.gitmodules' and should
2179 * NOT be used anywhere else.
2181 * Runs the provided config function on the '.gitmodules' file found in the
2182 * working directory.
2184 void config_from_gitmodules(config_fn_t fn, void *data)
2186 if (the_repository->worktree) {
2187 char *file = repo_worktree_path(the_repository, GITMODULES_FILE);
2188 git_config_from_file(fn, file, data);
2189 free(file);
2193 int git_config_get_expiry(const char *key, const char **output)
2195 int ret = git_config_get_string_const(key, output);
2196 if (ret)
2197 return ret;
2198 if (strcmp(*output, "now")) {
2199 timestamp_t now = approxidate("now");
2200 if (approxidate(*output) >= now)
2201 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2203 return ret;
2206 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2208 char *expiry_string;
2209 intmax_t days;
2210 timestamp_t when;
2212 if (git_config_get_string(key, &expiry_string))
2213 return 1; /* no such thing */
2215 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2216 const int scale = 86400;
2217 *expiry = now - days * scale;
2218 return 0;
2221 if (!parse_expiry_date(expiry_string, &when)) {
2222 *expiry = when;
2223 return 0;
2225 return -1; /* thing exists but cannot be parsed */
2228 int git_config_get_untracked_cache(void)
2230 int val = -1;
2231 const char *v;
2233 /* Hack for test programs like test-dump-untracked-cache */
2234 if (ignore_untracked_cache_config)
2235 return -1;
2237 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2238 return val;
2240 if (!git_config_get_value("core.untrackedcache", &v)) {
2241 if (!strcasecmp(v, "keep"))
2242 return -1;
2244 error(_("unknown core.untrackedCache value '%s'; "
2245 "using 'keep' default value"), v);
2246 return -1;
2249 return -1; /* default value */
2252 int git_config_get_split_index(void)
2254 int val;
2256 if (!git_config_get_maybe_bool("core.splitindex", &val))
2257 return val;
2259 return -1; /* default value */
2262 int git_config_get_max_percent_split_change(void)
2264 int val = -1;
2266 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2267 if (0 <= val && val <= 100)
2268 return val;
2270 return error(_("splitIndex.maxPercentChange value '%d' "
2271 "should be between 0 and 100"), val);
2274 return -1; /* default value */
2277 int git_config_get_fsmonitor(void)
2279 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2280 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2282 if (core_fsmonitor && !*core_fsmonitor)
2283 core_fsmonitor = NULL;
2285 if (core_fsmonitor)
2286 return 1;
2288 return 0;
2291 NORETURN
2292 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2294 if (!filename)
2295 die(_("unable to parse '%s' from command-line config"), key);
2296 else
2297 die(_("bad config variable '%s' in file '%s' at line %d"),
2298 key, filename, linenr);
2301 NORETURN __attribute__((format(printf, 2, 3)))
2302 void git_die_config(const char *key, const char *err, ...)
2304 const struct string_list *values;
2305 struct key_value_info *kv_info;
2307 if (err) {
2308 va_list params;
2309 va_start(params, err);
2310 vreportf("error: ", err, params);
2311 va_end(params);
2313 values = git_config_get_value_multi(key);
2314 kv_info = values->items[values->nr - 1].util;
2315 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2319 * Find all the stuff for git_config_set() below.
2322 struct config_store_data {
2323 int baselen;
2324 char *key;
2325 int do_not_match;
2326 regex_t *value_regex;
2327 int multi_replace;
2328 struct {
2329 size_t begin, end;
2330 enum config_event_t type;
2331 int is_keys_section;
2332 } *parsed;
2333 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2334 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2337 static void config_store_data_clear(struct config_store_data *store)
2339 free(store->key);
2340 if (store->value_regex != NULL &&
2341 store->value_regex != CONFIG_REGEX_NONE) {
2342 regfree(store->value_regex);
2343 free(store->value_regex);
2345 free(store->parsed);
2346 free(store->seen);
2347 memset(store, 0, sizeof(*store));
2350 static int matches(const char *key, const char *value,
2351 const struct config_store_data *store)
2353 if (strcmp(key, store->key))
2354 return 0; /* not ours */
2355 if (!store->value_regex)
2356 return 1; /* always matches */
2357 if (store->value_regex == CONFIG_REGEX_NONE)
2358 return 0; /* never matches */
2360 return store->do_not_match ^
2361 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2364 static int store_aux_event(enum config_event_t type,
2365 size_t begin, size_t end, void *data)
2367 struct config_store_data *store = data;
2369 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2370 store->parsed[store->parsed_nr].begin = begin;
2371 store->parsed[store->parsed_nr].end = end;
2372 store->parsed[store->parsed_nr].type = type;
2374 if (type == CONFIG_EVENT_SECTION) {
2375 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2376 return error("invalid section name '%s'", cf->var.buf);
2378 /* Is this the section we were looking for? */
2379 store->is_keys_section =
2380 store->parsed[store->parsed_nr].is_keys_section =
2381 cf->var.len - 1 == store->baselen &&
2382 !strncasecmp(cf->var.buf, store->key, store->baselen);
2383 if (store->is_keys_section) {
2384 store->section_seen = 1;
2385 ALLOC_GROW(store->seen, store->seen_nr + 1,
2386 store->seen_alloc);
2387 store->seen[store->seen_nr] = store->parsed_nr;
2391 store->parsed_nr++;
2393 return 0;
2396 static int store_aux(const char *key, const char *value, void *cb)
2398 struct config_store_data *store = cb;
2400 if (store->key_seen) {
2401 if (matches(key, value, store)) {
2402 if (store->seen_nr == 1 && store->multi_replace == 0) {
2403 warning(_("%s has multiple values"), key);
2406 ALLOC_GROW(store->seen, store->seen_nr + 1,
2407 store->seen_alloc);
2409 store->seen[store->seen_nr] = store->parsed_nr;
2410 store->seen_nr++;
2412 } else if (store->is_keys_section) {
2414 * Do not increment matches yet: this may not be a match, but we
2415 * are in the desired section.
2417 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2418 store->seen[store->seen_nr] = store->parsed_nr;
2419 store->section_seen = 1;
2421 if (matches(key, value, store)) {
2422 store->seen_nr++;
2423 store->key_seen = 1;
2427 return 0;
2430 static int write_error(const char *filename)
2432 error("failed to write new configuration file %s", filename);
2434 /* Same error code as "failed to rename". */
2435 return 4;
2438 static struct strbuf store_create_section(const char *key,
2439 const struct config_store_data *store)
2441 const char *dot;
2442 int i;
2443 struct strbuf sb = STRBUF_INIT;
2445 dot = memchr(key, '.', store->baselen);
2446 if (dot) {
2447 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2448 for (i = dot - key + 1; i < store->baselen; i++) {
2449 if (key[i] == '"' || key[i] == '\\')
2450 strbuf_addch(&sb, '\\');
2451 strbuf_addch(&sb, key[i]);
2453 strbuf_addstr(&sb, "\"]\n");
2454 } else {
2455 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2458 return sb;
2461 static ssize_t write_section(int fd, const char *key,
2462 const struct config_store_data *store)
2464 struct strbuf sb = store_create_section(key, store);
2465 ssize_t ret;
2467 ret = write_in_full(fd, sb.buf, sb.len);
2468 strbuf_release(&sb);
2470 return ret;
2473 static ssize_t write_pair(int fd, const char *key, const char *value,
2474 const struct config_store_data *store)
2476 int i;
2477 ssize_t ret;
2478 int length = strlen(key + store->baselen + 1);
2479 const char *quote = "";
2480 struct strbuf sb = STRBUF_INIT;
2483 * Check to see if the value needs to be surrounded with a dq pair.
2484 * Note that problematic characters are always backslash-quoted; this
2485 * check is about not losing leading or trailing SP and strings that
2486 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2487 * configuration parser.
2489 if (value[0] == ' ')
2490 quote = "\"";
2491 for (i = 0; value[i]; i++)
2492 if (value[i] == ';' || value[i] == '#')
2493 quote = "\"";
2494 if (i && value[i - 1] == ' ')
2495 quote = "\"";
2497 strbuf_addf(&sb, "\t%.*s = %s",
2498 length, key + store->baselen + 1, quote);
2500 for (i = 0; value[i]; i++)
2501 switch (value[i]) {
2502 case '\n':
2503 strbuf_addstr(&sb, "\\n");
2504 break;
2505 case '\t':
2506 strbuf_addstr(&sb, "\\t");
2507 break;
2508 case '"':
2509 case '\\':
2510 strbuf_addch(&sb, '\\');
2511 /* fallthrough */
2512 default:
2513 strbuf_addch(&sb, value[i]);
2514 break;
2516 strbuf_addf(&sb, "%s\n", quote);
2518 ret = write_in_full(fd, sb.buf, sb.len);
2519 strbuf_release(&sb);
2521 return ret;
2525 * If we are about to unset the last key(s) in a section, and if there are
2526 * no comments surrounding (or included in) the section, we will want to
2527 * extend begin/end to remove the entire section.
2529 * Note: the parameter `seen_ptr` points to the index into the store.seen
2530 * array. * This index may be incremented if a section has more than one
2531 * entry (which all are to be removed).
2533 static void maybe_remove_section(struct config_store_data *store,
2534 const char *contents,
2535 size_t *begin_offset, size_t *end_offset,
2536 int *seen_ptr)
2538 size_t begin;
2539 int i, seen, section_seen = 0;
2542 * First, ensure that this is the first key, and that there are no
2543 * comments before the entry nor before the section header.
2545 seen = *seen_ptr;
2546 for (i = store->seen[seen]; i > 0; i--) {
2547 enum config_event_t type = store->parsed[i - 1].type;
2549 if (type == CONFIG_EVENT_COMMENT)
2550 /* There is a comment before this entry or section */
2551 return;
2552 if (type == CONFIG_EVENT_ENTRY) {
2553 if (!section_seen)
2554 /* This is not the section's first entry. */
2555 return;
2556 /* We encountered no comment before the section. */
2557 break;
2559 if (type == CONFIG_EVENT_SECTION) {
2560 if (!store->parsed[i - 1].is_keys_section)
2561 break;
2562 section_seen = 1;
2565 begin = store->parsed[i].begin;
2568 * Next, make sure that we are removing he last key(s) in the section,
2569 * and that there are no comments that are possibly about the current
2570 * section.
2572 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2573 enum config_event_t type = store->parsed[i].type;
2575 if (type == CONFIG_EVENT_COMMENT)
2576 return;
2577 if (type == CONFIG_EVENT_SECTION) {
2578 if (store->parsed[i].is_keys_section)
2579 continue;
2580 break;
2582 if (type == CONFIG_EVENT_ENTRY) {
2583 if (++seen < store->seen_nr &&
2584 i == store->seen[seen])
2585 /* We want to remove this entry, too */
2586 continue;
2587 /* There is another entry in this section. */
2588 return;
2593 * We are really removing the last entry/entries from this section, and
2594 * there are no enclosed or surrounding comments. Remove the entire,
2595 * now-empty section.
2597 *seen_ptr = seen;
2598 *begin_offset = begin;
2599 if (i < store->parsed_nr)
2600 *end_offset = store->parsed[i].begin;
2601 else
2602 *end_offset = store->parsed[store->parsed_nr - 1].end;
2605 int git_config_set_in_file_gently(const char *config_filename,
2606 const char *key, const char *value)
2608 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2611 void git_config_set_in_file(const char *config_filename,
2612 const char *key, const char *value)
2614 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2617 int git_config_set_gently(const char *key, const char *value)
2619 return git_config_set_multivar_gently(key, value, NULL, 0);
2622 void git_config_set(const char *key, const char *value)
2624 git_config_set_multivar(key, value, NULL, 0);
2628 * If value==NULL, unset in (remove from) config,
2629 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2630 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2631 * (only add a new one)
2632 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2633 * else all matching key/values (regardless how many) are removed,
2634 * before the new pair is written.
2636 * Returns 0 on success.
2638 * This function does this:
2640 * - it locks the config file by creating ".git/config.lock"
2642 * - it then parses the config using store_aux() as validator to find
2643 * the position on the key/value pair to replace. If it is to be unset,
2644 * it must be found exactly once.
2646 * - the config file is mmap()ed and the part before the match (if any) is
2647 * written to the lock file, then the changed part and the rest.
2649 * - the config file is removed and the lock file rename()d to it.
2652 int git_config_set_multivar_in_file_gently(const char *config_filename,
2653 const char *key, const char *value,
2654 const char *value_regex,
2655 int multi_replace)
2657 int fd = -1, in_fd = -1;
2658 int ret;
2659 struct lock_file lock = LOCK_INIT;
2660 char *filename_buf = NULL;
2661 char *contents = NULL;
2662 size_t contents_sz;
2663 struct config_store_data store;
2665 memset(&store, 0, sizeof(store));
2667 /* parse-key returns negative; flip the sign to feed exit(3) */
2668 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2669 if (ret)
2670 goto out_free;
2672 store.multi_replace = multi_replace;
2674 if (!config_filename)
2675 config_filename = filename_buf = git_pathdup("config");
2678 * The lock serves a purpose in addition to locking: the new
2679 * contents of .git/config will be written into it.
2681 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2682 if (fd < 0) {
2683 error_errno("could not lock config file %s", config_filename);
2684 ret = CONFIG_NO_LOCK;
2685 goto out_free;
2689 * If .git/config does not exist yet, write a minimal version.
2691 in_fd = open(config_filename, O_RDONLY);
2692 if ( in_fd < 0 ) {
2693 if ( ENOENT != errno ) {
2694 error_errno("opening %s", config_filename);
2695 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2696 goto out_free;
2698 /* if nothing to unset, error out */
2699 if (value == NULL) {
2700 ret = CONFIG_NOTHING_SET;
2701 goto out_free;
2704 free(store.key);
2705 store.key = xstrdup(key);
2706 if (write_section(fd, key, &store) < 0 ||
2707 write_pair(fd, key, value, &store) < 0)
2708 goto write_err_out;
2709 } else {
2710 struct stat st;
2711 size_t copy_begin, copy_end;
2712 int i, new_line = 0;
2713 struct config_options opts;
2715 if (value_regex == NULL)
2716 store.value_regex = NULL;
2717 else if (value_regex == CONFIG_REGEX_NONE)
2718 store.value_regex = CONFIG_REGEX_NONE;
2719 else {
2720 if (value_regex[0] == '!') {
2721 store.do_not_match = 1;
2722 value_regex++;
2723 } else
2724 store.do_not_match = 0;
2726 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2727 if (regcomp(store.value_regex, value_regex,
2728 REG_EXTENDED)) {
2729 error("invalid pattern: %s", value_regex);
2730 FREE_AND_NULL(store.value_regex);
2731 ret = CONFIG_INVALID_PATTERN;
2732 goto out_free;
2736 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2737 store.parsed[0].end = 0;
2739 memset(&opts, 0, sizeof(opts));
2740 opts.event_fn = store_aux_event;
2741 opts.event_fn_data = &store;
2744 * After this, store.parsed will contain offsets of all the
2745 * parsed elements, and store.seen will contain a list of
2746 * matches, as indices into store.parsed.
2748 * As a side effect, we make sure to transform only a valid
2749 * existing config file.
2751 if (git_config_from_file_with_options(store_aux,
2752 config_filename,
2753 &store, &opts)) {
2754 error("invalid config file %s", config_filename);
2755 ret = CONFIG_INVALID_FILE;
2756 goto out_free;
2759 /* if nothing to unset, or too many matches, error out */
2760 if ((store.seen_nr == 0 && value == NULL) ||
2761 (store.seen_nr > 1 && multi_replace == 0)) {
2762 ret = CONFIG_NOTHING_SET;
2763 goto out_free;
2766 if (fstat(in_fd, &st) == -1) {
2767 error_errno(_("fstat on %s failed"), config_filename);
2768 ret = CONFIG_INVALID_FILE;
2769 goto out_free;
2772 contents_sz = xsize_t(st.st_size);
2773 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2774 MAP_PRIVATE, in_fd, 0);
2775 if (contents == MAP_FAILED) {
2776 if (errno == ENODEV && S_ISDIR(st.st_mode))
2777 errno = EISDIR;
2778 error_errno("unable to mmap '%s'", config_filename);
2779 ret = CONFIG_INVALID_FILE;
2780 contents = NULL;
2781 goto out_free;
2783 close(in_fd);
2784 in_fd = -1;
2786 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2787 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2788 ret = CONFIG_NO_WRITE;
2789 goto out_free;
2792 if (store.seen_nr == 0) {
2793 if (!store.seen_alloc) {
2794 /* Did not see key nor section */
2795 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2796 store.seen[0] = store.parsed_nr
2797 - !!store.parsed_nr;
2799 store.seen_nr = 1;
2802 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2803 size_t replace_end;
2804 int j = store.seen[i];
2806 new_line = 0;
2807 if (!store.key_seen) {
2808 copy_end = store.parsed[j].end;
2809 /* include '\n' when copying section header */
2810 if (copy_end > 0 && copy_end < contents_sz &&
2811 contents[copy_end - 1] != '\n' &&
2812 contents[copy_end] == '\n')
2813 copy_end++;
2814 replace_end = copy_end;
2815 } else {
2816 replace_end = store.parsed[j].end;
2817 copy_end = store.parsed[j].begin;
2818 if (!value)
2819 maybe_remove_section(&store, contents,
2820 &copy_end,
2821 &replace_end, &i);
2823 * Swallow preceding white-space on the same
2824 * line.
2826 while (copy_end > 0 ) {
2827 char c = contents[copy_end - 1];
2829 if (isspace(c) && c != '\n')
2830 copy_end--;
2831 else
2832 break;
2836 if (copy_end > 0 && contents[copy_end-1] != '\n')
2837 new_line = 1;
2839 /* write the first part of the config */
2840 if (copy_end > copy_begin) {
2841 if (write_in_full(fd, contents + copy_begin,
2842 copy_end - copy_begin) < 0)
2843 goto write_err_out;
2844 if (new_line &&
2845 write_str_in_full(fd, "\n") < 0)
2846 goto write_err_out;
2848 copy_begin = replace_end;
2851 /* write the pair (value == NULL means unset) */
2852 if (value != NULL) {
2853 if (!store.section_seen) {
2854 if (write_section(fd, key, &store) < 0)
2855 goto write_err_out;
2857 if (write_pair(fd, key, value, &store) < 0)
2858 goto write_err_out;
2861 /* write the rest of the config */
2862 if (copy_begin < contents_sz)
2863 if (write_in_full(fd, contents + copy_begin,
2864 contents_sz - copy_begin) < 0)
2865 goto write_err_out;
2867 munmap(contents, contents_sz);
2868 contents = NULL;
2871 if (commit_lock_file(&lock) < 0) {
2872 error_errno("could not write config file %s", config_filename);
2873 ret = CONFIG_NO_WRITE;
2874 goto out_free;
2877 ret = 0;
2879 /* Invalidate the config cache */
2880 git_config_clear();
2882 out_free:
2883 rollback_lock_file(&lock);
2884 free(filename_buf);
2885 if (contents)
2886 munmap(contents, contents_sz);
2887 if (in_fd >= 0)
2888 close(in_fd);
2889 config_store_data_clear(&store);
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 config_store_data_clear(&store);
3131 return ret;
3134 int git_config_rename_section_in_file(const char *config_filename,
3135 const char *old_name, const char *new_name)
3137 return git_config_copy_or_rename_section_in_file(config_filename,
3138 old_name, new_name, 0);
3141 int git_config_rename_section(const char *old_name, const char *new_name)
3143 return git_config_rename_section_in_file(NULL, old_name, new_name);
3146 int git_config_copy_section_in_file(const char *config_filename,
3147 const char *old_name, const char *new_name)
3149 return git_config_copy_or_rename_section_in_file(config_filename,
3150 old_name, new_name, 1);
3153 int git_config_copy_section(const char *old_name, const char *new_name)
3155 return git_config_copy_section_in_file(NULL, old_name, new_name);
3159 * Call this to report error for your variable that should not
3160 * get a boolean value (i.e. "[my] var" means "true").
3162 #undef config_error_nonbool
3163 int config_error_nonbool(const char *var)
3165 return error("missing value for '%s'", var);
3168 int parse_config_key(const char *var,
3169 const char *section,
3170 const char **subsection, int *subsection_len,
3171 const char **key)
3173 const char *dot;
3175 /* Does it start with "section." ? */
3176 if (!skip_prefix(var, section, &var) || *var != '.')
3177 return -1;
3180 * Find the key; we don't know yet if we have a subsection, but we must
3181 * parse backwards from the end, since the subsection may have dots in
3182 * it, too.
3184 dot = strrchr(var, '.');
3185 *key = dot + 1;
3187 /* Did we have a subsection at all? */
3188 if (dot == var) {
3189 if (subsection) {
3190 *subsection = NULL;
3191 *subsection_len = 0;
3194 else {
3195 if (!subsection)
3196 return -1;
3197 *subsection = var + 1;
3198 *subsection_len = dot - *subsection;
3201 return 0;
3204 const char *current_config_origin_type(void)
3206 int type;
3207 if (current_config_kvi)
3208 type = current_config_kvi->origin_type;
3209 else if(cf)
3210 type = cf->origin_type;
3211 else
3212 BUG("current_config_origin_type called outside config callback");
3214 switch (type) {
3215 case CONFIG_ORIGIN_BLOB:
3216 return "blob";
3217 case CONFIG_ORIGIN_FILE:
3218 return "file";
3219 case CONFIG_ORIGIN_STDIN:
3220 return "standard input";
3221 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3222 return "submodule-blob";
3223 case CONFIG_ORIGIN_CMDLINE:
3224 return "command line";
3225 default:
3226 BUG("unknown config origin type");
3230 const char *current_config_name(void)
3232 const char *name;
3233 if (current_config_kvi)
3234 name = current_config_kvi->filename;
3235 else if (cf)
3236 name = cf->name;
3237 else
3238 BUG("current_config_name called outside config callback");
3239 return name ? name : "";
3242 enum config_scope current_config_scope(void)
3244 if (current_config_kvi)
3245 return current_config_kvi->scope;
3246 else
3247 return current_parsing_scope;
3250 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3252 int i;
3254 for (i = 0; i < nr_mapping; i++) {
3255 const char *name = mapping[i];
3257 if (name && !strcasecmp(var, name))
3258 return i;
3260 return -1;