t5702: offer an object-format capability in the test
[git/raj.git] / config.c
blob8db9c77098f01bec5178751c8b4e64880d473619
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 "branch.h"
10 #include "config.h"
11 #include "repository.h"
12 #include "lockfile.h"
13 #include "exec-cmd.h"
14 #include "strbuf.h"
15 #include "quote.h"
16 #include "hashmap.h"
17 #include "string-list.h"
18 #include "object-store.h"
19 #include "utf8.h"
20 #include "dir.h"
21 #include "color.h"
22 #include "refs.h"
24 struct config_source {
25 struct config_source *prev;
26 union {
27 FILE *file;
28 struct config_buf {
29 const char *buf;
30 size_t len;
31 size_t pos;
32 } buf;
33 } u;
34 enum config_origin_type origin_type;
35 const char *name;
36 const char *path;
37 enum config_error_action default_error_action;
38 int linenr;
39 int eof;
40 size_t total_len;
41 struct strbuf value;
42 struct strbuf var;
43 unsigned subsection_case_sensitive : 1;
45 int (*do_fgetc)(struct config_source *c);
46 int (*do_ungetc)(int c, struct config_source *conf);
47 long (*do_ftell)(struct config_source *c);
51 * These variables record the "current" config source, which
52 * can be accessed by parsing callbacks.
54 * The "cf" variable will be non-NULL only when we are actually parsing a real
55 * config source (file, blob, cmdline, etc).
57 * The "current_config_kvi" variable will be non-NULL only when we are feeding
58 * cached config from a configset into a callback.
60 * They should generally never be non-NULL at the same time. If they are both
61 * NULL, then we aren't parsing anything (and depending on the function looking
62 * at the variables, it's either a bug for it to be called in the first place,
63 * or it's a function which can be reused for non-config purposes, and should
64 * fall back to some sane behavior).
66 static struct config_source *cf;
67 static struct key_value_info *current_config_kvi;
70 * Similar to the variables above, this gives access to the "scope" of the
71 * current value (repo, global, etc). For cached values, it can be found via
72 * the current_config_kvi as above. During parsing, the current value can be
73 * found in this variable. It's not part of "cf" because it transcends a single
74 * file (i.e., a file included from .git/config is still in "repo" scope).
76 static enum config_scope current_parsing_scope;
78 static int core_compression_seen;
79 static int pack_compression_seen;
80 static int zlib_compression_seen;
82 static int config_file_fgetc(struct config_source *conf)
84 return getc_unlocked(conf->u.file);
87 static int config_file_ungetc(int c, struct config_source *conf)
89 return ungetc(c, conf->u.file);
92 static long config_file_ftell(struct config_source *conf)
94 return ftell(conf->u.file);
98 static int config_buf_fgetc(struct config_source *conf)
100 if (conf->u.buf.pos < conf->u.buf.len)
101 return conf->u.buf.buf[conf->u.buf.pos++];
103 return EOF;
106 static int config_buf_ungetc(int c, struct config_source *conf)
108 if (conf->u.buf.pos > 0) {
109 conf->u.buf.pos--;
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
111 BUG("config_buf can only ungetc the same character");
112 return c;
115 return EOF;
118 static long config_buf_ftell(struct config_source *conf)
120 return conf->u.buf.pos;
123 #define MAX_INCLUDE_DEPTH 10
124 static const char include_depth_advice[] = N_(
125 "exceeded maximum include depth (%d) while including\n"
126 " %s\n"
127 "from\n"
128 " %s\n"
129 "This might be due to circular includes.");
130 static int handle_path_include(const char *path, struct config_include_data *inc)
132 int ret = 0;
133 struct strbuf buf = STRBUF_INIT;
134 char *expanded;
136 if (!path)
137 return config_error_nonbool("include.path");
139 expanded = expand_user_path(path, 0);
140 if (!expanded)
141 return error(_("could not expand include path '%s'"), path);
142 path = expanded;
145 * Use an absolute path as-is, but interpret relative paths
146 * based on the including config file.
148 if (!is_absolute_path(path)) {
149 char *slash;
151 if (!cf || !cf->path)
152 return error(_("relative config includes must come from files"));
154 slash = find_last_dir_sep(cf->path);
155 if (slash)
156 strbuf_add(&buf, cf->path, slash - cf->path + 1);
157 strbuf_addstr(&buf, path);
158 path = buf.buf;
161 if (!access_or_die(path, R_OK, 0)) {
162 if (++inc->depth > MAX_INCLUDE_DEPTH)
163 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
164 !cf ? "<unknown>" :
165 cf->name ? cf->name :
166 "the command line");
167 ret = git_config_from_file(git_config_include, path, inc);
168 inc->depth--;
170 strbuf_release(&buf);
171 free(expanded);
172 return ret;
175 static void add_trailing_starstar_for_dir(struct strbuf *pat)
177 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
178 strbuf_addstr(pat, "**");
181 static int prepare_include_condition_pattern(struct strbuf *pat)
183 struct strbuf path = STRBUF_INIT;
184 char *expanded;
185 int prefix = 0;
187 expanded = expand_user_path(pat->buf, 1);
188 if (expanded) {
189 strbuf_reset(pat);
190 strbuf_addstr(pat, expanded);
191 free(expanded);
194 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
195 const char *slash;
197 if (!cf || !cf->path)
198 return error(_("relative config include "
199 "conditionals must come from files"));
201 strbuf_realpath(&path, cf->path, 1);
202 slash = find_last_dir_sep(path.buf);
203 if (!slash)
204 BUG("how is this possible?");
205 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
206 prefix = slash - path.buf + 1 /* slash */;
207 } else if (!is_absolute_path(pat->buf))
208 strbuf_insertstr(pat, 0, "**/");
210 add_trailing_starstar_for_dir(pat);
212 strbuf_release(&path);
213 return prefix;
216 static int include_by_gitdir(const struct config_options *opts,
217 const char *cond, size_t cond_len, int icase)
219 struct strbuf text = STRBUF_INIT;
220 struct strbuf pattern = STRBUF_INIT;
221 int ret = 0, prefix;
222 const char *git_dir;
223 int already_tried_absolute = 0;
225 if (opts->git_dir)
226 git_dir = opts->git_dir;
227 else
228 goto done;
230 strbuf_realpath(&text, git_dir, 1);
231 strbuf_add(&pattern, cond, cond_len);
232 prefix = prepare_include_condition_pattern(&pattern);
234 again:
235 if (prefix < 0)
236 goto done;
238 if (prefix > 0) {
240 * perform literal matching on the prefix part so that
241 * any wildcard character in it can't create side effects.
243 if (text.len < prefix)
244 goto done;
245 if (!icase && strncmp(pattern.buf, text.buf, prefix))
246 goto done;
247 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
248 goto done;
251 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
252 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
254 if (!ret && !already_tried_absolute) {
256 * We've tried e.g. matching gitdir:~/work, but if
257 * ~/work is a symlink to /mnt/storage/work
258 * strbuf_realpath() will expand it, so the rule won't
259 * match. Let's match against a
260 * strbuf_add_absolute_path() version of the path,
261 * which'll do the right thing
263 strbuf_reset(&text);
264 strbuf_add_absolute_path(&text, git_dir);
265 already_tried_absolute = 1;
266 goto again;
268 done:
269 strbuf_release(&pattern);
270 strbuf_release(&text);
271 return ret;
274 static int include_by_branch(const char *cond, size_t cond_len)
276 int flags;
277 int ret;
278 struct strbuf pattern = STRBUF_INIT;
279 const char *refname = !the_repository->gitdir ?
280 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
281 const char *shortname;
283 if (!refname || !(flags & REF_ISSYMREF) ||
284 !skip_prefix(refname, "refs/heads/", &shortname))
285 return 0;
287 strbuf_add(&pattern, cond, cond_len);
288 add_trailing_starstar_for_dir(&pattern);
289 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
290 strbuf_release(&pattern);
291 return ret;
294 static int include_condition_is_true(const struct config_options *opts,
295 const char *cond, size_t cond_len)
298 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
299 return include_by_gitdir(opts, cond, cond_len, 0);
300 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
301 return include_by_gitdir(opts, cond, cond_len, 1);
302 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
303 return include_by_branch(cond, cond_len);
305 /* unknown conditionals are always false */
306 return 0;
309 int git_config_include(const char *var, const char *value, void *data)
311 struct config_include_data *inc = data;
312 const char *cond, *key;
313 size_t cond_len;
314 int ret;
317 * Pass along all values, including "include" directives; this makes it
318 * possible to query information on the includes themselves.
320 ret = inc->fn(var, value, inc->data);
321 if (ret < 0)
322 return ret;
324 if (!strcmp(var, "include.path"))
325 ret = handle_path_include(value, inc);
327 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
328 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
329 !strcmp(key, "path"))
330 ret = handle_path_include(value, inc);
332 return ret;
335 void git_config_push_parameter(const char *text)
337 struct strbuf env = STRBUF_INIT;
338 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
339 if (old && *old) {
340 strbuf_addstr(&env, old);
341 strbuf_addch(&env, ' ');
343 sq_quote_buf(&env, text);
344 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
345 strbuf_release(&env);
348 static inline int iskeychar(int c)
350 return isalnum(c) || c == '-';
354 * Auxiliary function to sanity-check and split the key into the section
355 * identifier and variable name.
357 * Returns 0 on success, -1 when there is an invalid character in the key and
358 * -2 if there is no section name in the key.
360 * store_key - pointer to char* which will hold a copy of the key with
361 * lowercase section and variable name
362 * baselen - pointer to size_t which will hold the length of the
363 * section + subsection part, can be NULL
365 static int git_config_parse_key_1(const char *key, char **store_key, size_t *baselen_, int quiet)
367 size_t i, baselen;
368 int dot;
369 const char *last_dot = strrchr(key, '.');
372 * Since "key" actually contains the section name and the real
373 * key name separated by a dot, we have to know where the dot is.
376 if (last_dot == NULL || last_dot == key) {
377 if (!quiet)
378 error(_("key does not contain a section: %s"), key);
379 return -CONFIG_NO_SECTION_OR_NAME;
382 if (!last_dot[1]) {
383 if (!quiet)
384 error(_("key does not contain variable name: %s"), key);
385 return -CONFIG_NO_SECTION_OR_NAME;
388 baselen = last_dot - key;
389 if (baselen_)
390 *baselen_ = baselen;
393 * Validate the key and while at it, lower case it for matching.
395 if (store_key)
396 *store_key = xmallocz(strlen(key));
398 dot = 0;
399 for (i = 0; key[i]; i++) {
400 unsigned char c = key[i];
401 if (c == '.')
402 dot = 1;
403 /* Leave the extended basename untouched.. */
404 if (!dot || i > baselen) {
405 if (!iskeychar(c) ||
406 (i == baselen + 1 && !isalpha(c))) {
407 if (!quiet)
408 error(_("invalid key: %s"), key);
409 goto out_free_ret_1;
411 c = tolower(c);
412 } else if (c == '\n') {
413 if (!quiet)
414 error(_("invalid key (newline): %s"), key);
415 goto out_free_ret_1;
417 if (store_key)
418 (*store_key)[i] = c;
421 return 0;
423 out_free_ret_1:
424 if (store_key) {
425 FREE_AND_NULL(*store_key);
427 return -CONFIG_INVALID_KEY;
430 int git_config_parse_key(const char *key, char **store_key, size_t *baselen)
432 return git_config_parse_key_1(key, store_key, baselen, 0);
435 int git_config_key_is_valid(const char *key)
437 return !git_config_parse_key_1(key, NULL, NULL, 1);
440 int git_config_parse_parameter(const char *text,
441 config_fn_t fn, void *data)
443 const char *value;
444 char *canonical_name;
445 struct strbuf **pair;
446 int ret;
448 pair = strbuf_split_str(text, '=', 2);
449 if (!pair[0])
450 return error(_("bogus config parameter: %s"), text);
452 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
453 strbuf_setlen(pair[0], pair[0]->len - 1);
454 value = pair[1] ? pair[1]->buf : "";
455 } else {
456 value = NULL;
459 strbuf_trim(pair[0]);
460 if (!pair[0]->len) {
461 strbuf_list_free(pair);
462 return error(_("bogus config parameter: %s"), text);
465 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
466 ret = -1;
467 } else {
468 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
469 free(canonical_name);
471 strbuf_list_free(pair);
472 return ret;
475 int git_config_from_parameters(config_fn_t fn, void *data)
477 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
478 int ret = 0;
479 char *envw;
480 const char **argv = NULL;
481 int nr = 0, alloc = 0;
482 int i;
483 struct config_source source;
485 if (!env)
486 return 0;
488 memset(&source, 0, sizeof(source));
489 source.prev = cf;
490 source.origin_type = CONFIG_ORIGIN_CMDLINE;
491 cf = &source;
493 /* sq_dequote will write over it */
494 envw = xstrdup(env);
496 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
497 ret = error(_("bogus format in %s"), CONFIG_DATA_ENVIRONMENT);
498 goto out;
501 for (i = 0; i < nr; i++) {
502 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
503 ret = -1;
504 goto out;
508 out:
509 free(argv);
510 free(envw);
511 cf = source.prev;
512 return ret;
515 static int get_next_char(void)
517 int c = cf->do_fgetc(cf);
519 if (c == '\r') {
520 /* DOS like systems */
521 c = cf->do_fgetc(cf);
522 if (c != '\n') {
523 if (c != EOF)
524 cf->do_ungetc(c, cf);
525 c = '\r';
529 if (c != EOF && ++cf->total_len > INT_MAX) {
531 * This is an absurdly long config file; refuse to parse
532 * further in order to protect downstream code from integer
533 * overflows. Note that we can't return an error specifically,
534 * but we can mark EOF and put trash in the return value,
535 * which will trigger a parse error.
537 cf->eof = 1;
538 return 0;
541 if (c == '\n')
542 cf->linenr++;
543 if (c == EOF) {
544 cf->eof = 1;
545 cf->linenr++;
546 c = '\n';
548 return c;
551 static char *parse_value(void)
553 int quote = 0, comment = 0, space = 0;
555 strbuf_reset(&cf->value);
556 for (;;) {
557 int c = get_next_char();
558 if (c == '\n') {
559 if (quote) {
560 cf->linenr--;
561 return NULL;
563 return cf->value.buf;
565 if (comment)
566 continue;
567 if (isspace(c) && !quote) {
568 if (cf->value.len)
569 space++;
570 continue;
572 if (!quote) {
573 if (c == ';' || c == '#') {
574 comment = 1;
575 continue;
578 for (; space; space--)
579 strbuf_addch(&cf->value, ' ');
580 if (c == '\\') {
581 c = get_next_char();
582 switch (c) {
583 case '\n':
584 continue;
585 case 't':
586 c = '\t';
587 break;
588 case 'b':
589 c = '\b';
590 break;
591 case 'n':
592 c = '\n';
593 break;
594 /* Some characters escape as themselves */
595 case '\\': case '"':
596 break;
597 /* Reject unknown escape sequences */
598 default:
599 return NULL;
601 strbuf_addch(&cf->value, c);
602 continue;
604 if (c == '"') {
605 quote = 1-quote;
606 continue;
608 strbuf_addch(&cf->value, c);
612 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
614 int c;
615 char *value;
616 int ret;
618 /* Get the full name */
619 for (;;) {
620 c = get_next_char();
621 if (cf->eof)
622 break;
623 if (!iskeychar(c))
624 break;
625 strbuf_addch(name, tolower(c));
628 while (c == ' ' || c == '\t')
629 c = get_next_char();
631 value = NULL;
632 if (c != '\n') {
633 if (c != '=')
634 return -1;
635 value = parse_value();
636 if (!value)
637 return -1;
640 * We already consumed the \n, but we need linenr to point to
641 * the line we just parsed during the call to fn to get
642 * accurate line number in error messages.
644 cf->linenr--;
645 ret = fn(name->buf, value, data);
646 if (ret >= 0)
647 cf->linenr++;
648 return ret;
651 static int get_extended_base_var(struct strbuf *name, int c)
653 cf->subsection_case_sensitive = 0;
654 do {
655 if (c == '\n')
656 goto error_incomplete_line;
657 c = get_next_char();
658 } while (isspace(c));
660 /* We require the format to be '[base "extension"]' */
661 if (c != '"')
662 return -1;
663 strbuf_addch(name, '.');
665 for (;;) {
666 int c = get_next_char();
667 if (c == '\n')
668 goto error_incomplete_line;
669 if (c == '"')
670 break;
671 if (c == '\\') {
672 c = get_next_char();
673 if (c == '\n')
674 goto error_incomplete_line;
676 strbuf_addch(name, c);
679 /* Final ']' */
680 if (get_next_char() != ']')
681 return -1;
682 return 0;
683 error_incomplete_line:
684 cf->linenr--;
685 return -1;
688 static int get_base_var(struct strbuf *name)
690 cf->subsection_case_sensitive = 1;
691 for (;;) {
692 int c = get_next_char();
693 if (cf->eof)
694 return -1;
695 if (c == ']')
696 return 0;
697 if (isspace(c))
698 return get_extended_base_var(name, c);
699 if (!iskeychar(c) && c != '.')
700 return -1;
701 strbuf_addch(name, tolower(c));
705 struct parse_event_data {
706 enum config_event_t previous_type;
707 size_t previous_offset;
708 const struct config_options *opts;
711 static int do_event(enum config_event_t type, struct parse_event_data *data)
713 size_t offset;
715 if (!data->opts || !data->opts->event_fn)
716 return 0;
718 if (type == CONFIG_EVENT_WHITESPACE &&
719 data->previous_type == type)
720 return 0;
722 offset = cf->do_ftell(cf);
724 * At EOF, the parser always "inserts" an extra '\n', therefore
725 * the end offset of the event is the current file position, otherwise
726 * we will already have advanced to the next event.
728 if (type != CONFIG_EVENT_EOF)
729 offset--;
731 if (data->previous_type != CONFIG_EVENT_EOF &&
732 data->opts->event_fn(data->previous_type, data->previous_offset,
733 offset, data->opts->event_fn_data) < 0)
734 return -1;
736 data->previous_type = type;
737 data->previous_offset = offset;
739 return 0;
742 static int git_parse_source(config_fn_t fn, void *data,
743 const struct config_options *opts)
745 int comment = 0;
746 size_t baselen = 0;
747 struct strbuf *var = &cf->var;
748 int error_return = 0;
749 char *error_msg = NULL;
751 /* U+FEFF Byte Order Mark in UTF8 */
752 const char *bomptr = utf8_bom;
754 /* For the parser event callback */
755 struct parse_event_data event_data = {
756 CONFIG_EVENT_EOF, 0, opts
759 for (;;) {
760 int c;
762 c = get_next_char();
763 if (bomptr && *bomptr) {
764 /* We are at the file beginning; skip UTF8-encoded BOM
765 * if present. Sane editors won't put this in on their
766 * own, but e.g. Windows Notepad will do it happily. */
767 if (c == (*bomptr & 0377)) {
768 bomptr++;
769 continue;
770 } else {
771 /* Do not tolerate partial BOM. */
772 if (bomptr != utf8_bom)
773 break;
774 /* No BOM at file beginning. Cool. */
775 bomptr = NULL;
778 if (c == '\n') {
779 if (cf->eof) {
780 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
781 return -1;
782 return 0;
784 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
785 return -1;
786 comment = 0;
787 continue;
789 if (comment)
790 continue;
791 if (isspace(c)) {
792 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
793 return -1;
794 continue;
796 if (c == '#' || c == ';') {
797 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
798 return -1;
799 comment = 1;
800 continue;
802 if (c == '[') {
803 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
804 return -1;
806 /* Reset prior to determining a new stem */
807 strbuf_reset(var);
808 if (get_base_var(var) < 0 || var->len < 1)
809 break;
810 strbuf_addch(var, '.');
811 baselen = var->len;
812 continue;
814 if (!isalpha(c))
815 break;
817 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
818 return -1;
821 * Truncate the var name back to the section header
822 * stem prior to grabbing the suffix part of the name
823 * and the value.
825 strbuf_setlen(var, baselen);
826 strbuf_addch(var, tolower(c));
827 if (get_value(fn, data, var) < 0)
828 break;
831 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
832 return -1;
834 switch (cf->origin_type) {
835 case CONFIG_ORIGIN_BLOB:
836 error_msg = xstrfmt(_("bad config line %d in blob %s"),
837 cf->linenr, cf->name);
838 break;
839 case CONFIG_ORIGIN_FILE:
840 error_msg = xstrfmt(_("bad config line %d in file %s"),
841 cf->linenr, cf->name);
842 break;
843 case CONFIG_ORIGIN_STDIN:
844 error_msg = xstrfmt(_("bad config line %d in standard input"),
845 cf->linenr);
846 break;
847 case CONFIG_ORIGIN_SUBMODULE_BLOB:
848 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
849 cf->linenr, cf->name);
850 break;
851 case CONFIG_ORIGIN_CMDLINE:
852 error_msg = xstrfmt(_("bad config line %d in command line %s"),
853 cf->linenr, cf->name);
854 break;
855 default:
856 error_msg = xstrfmt(_("bad config line %d in %s"),
857 cf->linenr, cf->name);
860 switch (opts && opts->error_action ?
861 opts->error_action :
862 cf->default_error_action) {
863 case CONFIG_ERROR_DIE:
864 die("%s", error_msg);
865 break;
866 case CONFIG_ERROR_ERROR:
867 error_return = error("%s", error_msg);
868 break;
869 case CONFIG_ERROR_SILENT:
870 error_return = -1;
871 break;
872 case CONFIG_ERROR_UNSET:
873 BUG("config error action unset");
876 free(error_msg);
877 return error_return;
880 static uintmax_t get_unit_factor(const char *end)
882 if (!*end)
883 return 1;
884 else if (!strcasecmp(end, "k"))
885 return 1024;
886 else if (!strcasecmp(end, "m"))
887 return 1024 * 1024;
888 else if (!strcasecmp(end, "g"))
889 return 1024 * 1024 * 1024;
890 return 0;
893 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
895 if (value && *value) {
896 char *end;
897 intmax_t val;
898 uintmax_t uval;
899 uintmax_t factor;
901 errno = 0;
902 val = strtoimax(value, &end, 0);
903 if (errno == ERANGE)
904 return 0;
905 factor = get_unit_factor(end);
906 if (!factor) {
907 errno = EINVAL;
908 return 0;
910 uval = val < 0 ? -val : val;
911 if (unsigned_mult_overflows(factor, uval) ||
912 factor * uval > max) {
913 errno = ERANGE;
914 return 0;
916 val *= factor;
917 *ret = val;
918 return 1;
920 errno = EINVAL;
921 return 0;
924 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
926 if (value && *value) {
927 char *end;
928 uintmax_t val;
929 uintmax_t factor;
931 errno = 0;
932 val = strtoumax(value, &end, 0);
933 if (errno == ERANGE)
934 return 0;
935 factor = get_unit_factor(end);
936 if (!factor) {
937 errno = EINVAL;
938 return 0;
940 if (unsigned_mult_overflows(factor, val) ||
941 factor * val > max) {
942 errno = ERANGE;
943 return 0;
945 val *= factor;
946 *ret = val;
947 return 1;
949 errno = EINVAL;
950 return 0;
953 static int git_parse_int(const char *value, int *ret)
955 intmax_t tmp;
956 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
957 return 0;
958 *ret = tmp;
959 return 1;
962 static int git_parse_int64(const char *value, int64_t *ret)
964 intmax_t tmp;
965 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
966 return 0;
967 *ret = tmp;
968 return 1;
971 int git_parse_ulong(const char *value, unsigned long *ret)
973 uintmax_t tmp;
974 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
975 return 0;
976 *ret = tmp;
977 return 1;
980 int git_parse_ssize_t(const char *value, ssize_t *ret)
982 intmax_t tmp;
983 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
984 return 0;
985 *ret = tmp;
986 return 1;
989 NORETURN
990 static void die_bad_number(const char *name, const char *value)
992 const char *error_type = (errno == ERANGE) ?
993 N_("out of range") : N_("invalid unit");
994 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
996 if (!value)
997 value = "";
999 if (!strcmp(name, "GIT_TEST_GETTEXT_POISON"))
1001 * We explicitly *don't* use _() here since it would
1002 * cause an infinite loop with _() needing to call
1003 * use_gettext_poison(). This is why marked up
1004 * translations with N_() above.
1006 die(bad_numeric, value, name, error_type);
1008 if (!(cf && cf->name))
1009 die(_(bad_numeric), value, name, _(error_type));
1011 switch (cf->origin_type) {
1012 case CONFIG_ORIGIN_BLOB:
1013 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1014 value, name, cf->name, _(error_type));
1015 case CONFIG_ORIGIN_FILE:
1016 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1017 value, name, cf->name, _(error_type));
1018 case CONFIG_ORIGIN_STDIN:
1019 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1020 value, name, _(error_type));
1021 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1022 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1023 value, name, cf->name, _(error_type));
1024 case CONFIG_ORIGIN_CMDLINE:
1025 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1026 value, name, cf->name, _(error_type));
1027 default:
1028 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1029 value, name, cf->name, _(error_type));
1033 int git_config_int(const char *name, const char *value)
1035 int ret;
1036 if (!git_parse_int(value, &ret))
1037 die_bad_number(name, value);
1038 return ret;
1041 int64_t git_config_int64(const char *name, const char *value)
1043 int64_t ret;
1044 if (!git_parse_int64(value, &ret))
1045 die_bad_number(name, value);
1046 return ret;
1049 unsigned long git_config_ulong(const char *name, const char *value)
1051 unsigned long ret;
1052 if (!git_parse_ulong(value, &ret))
1053 die_bad_number(name, value);
1054 return ret;
1057 ssize_t git_config_ssize_t(const char *name, const char *value)
1059 ssize_t ret;
1060 if (!git_parse_ssize_t(value, &ret))
1061 die_bad_number(name, value);
1062 return ret;
1065 static int git_parse_maybe_bool_text(const char *value)
1067 if (!value)
1068 return 1;
1069 if (!*value)
1070 return 0;
1071 if (!strcasecmp(value, "true")
1072 || !strcasecmp(value, "yes")
1073 || !strcasecmp(value, "on"))
1074 return 1;
1075 if (!strcasecmp(value, "false")
1076 || !strcasecmp(value, "no")
1077 || !strcasecmp(value, "off"))
1078 return 0;
1079 return -1;
1082 int git_parse_maybe_bool(const char *value)
1084 int v = git_parse_maybe_bool_text(value);
1085 if (0 <= v)
1086 return v;
1087 if (git_parse_int(value, &v))
1088 return !!v;
1089 return -1;
1092 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1094 int v = git_parse_maybe_bool_text(value);
1095 if (0 <= v) {
1096 *is_bool = 1;
1097 return v;
1099 *is_bool = 0;
1100 return git_config_int(name, value);
1103 int git_config_bool(const char *name, const char *value)
1105 int discard;
1106 return !!git_config_bool_or_int(name, value, &discard);
1109 int git_config_string(const char **dest, const char *var, const char *value)
1111 if (!value)
1112 return config_error_nonbool(var);
1113 *dest = xstrdup(value);
1114 return 0;
1117 int git_config_pathname(const char **dest, const char *var, const char *value)
1119 if (!value)
1120 return config_error_nonbool(var);
1121 *dest = expand_user_path(value, 0);
1122 if (!*dest)
1123 die(_("failed to expand user dir in: '%s'"), value);
1124 return 0;
1127 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1129 if (!value)
1130 return config_error_nonbool(var);
1131 if (parse_expiry_date(value, timestamp))
1132 return error(_("'%s' for '%s' is not a valid timestamp"),
1133 value, var);
1134 return 0;
1137 int git_config_color(char *dest, const char *var, const char *value)
1139 if (!value)
1140 return config_error_nonbool(var);
1141 if (color_parse(value, dest) < 0)
1142 return -1;
1143 return 0;
1146 static int git_default_core_config(const char *var, const char *value, void *cb)
1148 /* This needs a better name */
1149 if (!strcmp(var, "core.filemode")) {
1150 trust_executable_bit = git_config_bool(var, value);
1151 return 0;
1153 if (!strcmp(var, "core.trustctime")) {
1154 trust_ctime = git_config_bool(var, value);
1155 return 0;
1157 if (!strcmp(var, "core.checkstat")) {
1158 if (!strcasecmp(value, "default"))
1159 check_stat = 1;
1160 else if (!strcasecmp(value, "minimal"))
1161 check_stat = 0;
1164 if (!strcmp(var, "core.quotepath")) {
1165 quote_path_fully = git_config_bool(var, value);
1166 return 0;
1169 if (!strcmp(var, "core.symlinks")) {
1170 has_symlinks = git_config_bool(var, value);
1171 return 0;
1174 if (!strcmp(var, "core.ignorecase")) {
1175 ignore_case = git_config_bool(var, value);
1176 return 0;
1179 if (!strcmp(var, "core.attributesfile"))
1180 return git_config_pathname(&git_attributes_file, var, value);
1182 if (!strcmp(var, "core.hookspath"))
1183 return git_config_pathname(&git_hooks_path, var, value);
1185 if (!strcmp(var, "core.bare")) {
1186 is_bare_repository_cfg = git_config_bool(var, value);
1187 return 0;
1190 if (!strcmp(var, "core.ignorestat")) {
1191 assume_unchanged = git_config_bool(var, value);
1192 return 0;
1195 if (!strcmp(var, "core.prefersymlinkrefs")) {
1196 prefer_symlink_refs = git_config_bool(var, value);
1197 return 0;
1200 if (!strcmp(var, "core.logallrefupdates")) {
1201 if (value && !strcasecmp(value, "always"))
1202 log_all_ref_updates = LOG_REFS_ALWAYS;
1203 else if (git_config_bool(var, value))
1204 log_all_ref_updates = LOG_REFS_NORMAL;
1205 else
1206 log_all_ref_updates = LOG_REFS_NONE;
1207 return 0;
1210 if (!strcmp(var, "core.warnambiguousrefs")) {
1211 warn_ambiguous_refs = git_config_bool(var, value);
1212 return 0;
1215 if (!strcmp(var, "core.abbrev")) {
1216 if (!value)
1217 return config_error_nonbool(var);
1218 if (!strcasecmp(value, "auto"))
1219 default_abbrev = -1;
1220 else {
1221 int abbrev = git_config_int(var, value);
1222 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1223 return error(_("abbrev length out of range: %d"), abbrev);
1224 default_abbrev = abbrev;
1226 return 0;
1229 if (!strcmp(var, "core.disambiguate"))
1230 return set_disambiguate_hint_config(var, value);
1232 if (!strcmp(var, "core.loosecompression")) {
1233 int level = git_config_int(var, value);
1234 if (level == -1)
1235 level = Z_DEFAULT_COMPRESSION;
1236 else if (level < 0 || level > Z_BEST_COMPRESSION)
1237 die(_("bad zlib compression level %d"), level);
1238 zlib_compression_level = level;
1239 zlib_compression_seen = 1;
1240 return 0;
1243 if (!strcmp(var, "core.compression")) {
1244 int level = git_config_int(var, value);
1245 if (level == -1)
1246 level = Z_DEFAULT_COMPRESSION;
1247 else if (level < 0 || level > Z_BEST_COMPRESSION)
1248 die(_("bad zlib compression level %d"), level);
1249 core_compression_level = level;
1250 core_compression_seen = 1;
1251 if (!zlib_compression_seen)
1252 zlib_compression_level = level;
1253 if (!pack_compression_seen)
1254 pack_compression_level = level;
1255 return 0;
1258 if (!strcmp(var, "core.packedgitwindowsize")) {
1259 int pgsz_x2 = getpagesize() * 2;
1260 packed_git_window_size = git_config_ulong(var, value);
1262 /* This value must be multiple of (pagesize * 2) */
1263 packed_git_window_size /= pgsz_x2;
1264 if (packed_git_window_size < 1)
1265 packed_git_window_size = 1;
1266 packed_git_window_size *= pgsz_x2;
1267 return 0;
1270 if (!strcmp(var, "core.bigfilethreshold")) {
1271 big_file_threshold = git_config_ulong(var, value);
1272 return 0;
1275 if (!strcmp(var, "core.packedgitlimit")) {
1276 packed_git_limit = git_config_ulong(var, value);
1277 return 0;
1280 if (!strcmp(var, "core.deltabasecachelimit")) {
1281 delta_base_cache_limit = git_config_ulong(var, value);
1282 return 0;
1285 if (!strcmp(var, "core.autocrlf")) {
1286 if (value && !strcasecmp(value, "input")) {
1287 auto_crlf = AUTO_CRLF_INPUT;
1288 return 0;
1290 auto_crlf = git_config_bool(var, value);
1291 return 0;
1294 if (!strcmp(var, "core.safecrlf")) {
1295 int eol_rndtrp_die;
1296 if (value && !strcasecmp(value, "warn")) {
1297 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1298 return 0;
1300 eol_rndtrp_die = git_config_bool(var, value);
1301 global_conv_flags_eol = eol_rndtrp_die ?
1302 CONV_EOL_RNDTRP_DIE : 0;
1303 return 0;
1306 if (!strcmp(var, "core.eol")) {
1307 if (value && !strcasecmp(value, "lf"))
1308 core_eol = EOL_LF;
1309 else if (value && !strcasecmp(value, "crlf"))
1310 core_eol = EOL_CRLF;
1311 else if (value && !strcasecmp(value, "native"))
1312 core_eol = EOL_NATIVE;
1313 else
1314 core_eol = EOL_UNSET;
1315 return 0;
1318 if (!strcmp(var, "core.checkroundtripencoding")) {
1319 check_roundtrip_encoding = xstrdup(value);
1320 return 0;
1323 if (!strcmp(var, "core.notesref")) {
1324 notes_ref_name = xstrdup(value);
1325 return 0;
1328 if (!strcmp(var, "core.editor"))
1329 return git_config_string(&editor_program, var, value);
1331 if (!strcmp(var, "core.commentchar")) {
1332 if (!value)
1333 return config_error_nonbool(var);
1334 else if (!strcasecmp(value, "auto"))
1335 auto_comment_line_char = 1;
1336 else if (value[0] && !value[1]) {
1337 comment_line_char = value[0];
1338 auto_comment_line_char = 0;
1339 } else
1340 return error(_("core.commentChar should only be one character"));
1341 return 0;
1344 if (!strcmp(var, "core.askpass"))
1345 return git_config_string(&askpass_program, var, value);
1347 if (!strcmp(var, "core.excludesfile"))
1348 return git_config_pathname(&excludes_file, var, value);
1350 if (!strcmp(var, "core.whitespace")) {
1351 if (!value)
1352 return config_error_nonbool(var);
1353 whitespace_rule_cfg = parse_whitespace_rule(value);
1354 return 0;
1357 if (!strcmp(var, "core.fsyncobjectfiles")) {
1358 fsync_object_files = git_config_bool(var, value);
1359 return 0;
1362 if (!strcmp(var, "core.preloadindex")) {
1363 core_preload_index = git_config_bool(var, value);
1364 return 0;
1367 if (!strcmp(var, "core.createobject")) {
1368 if (!strcmp(value, "rename"))
1369 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1370 else if (!strcmp(value, "link"))
1371 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1372 else
1373 die(_("invalid mode for object creation: %s"), value);
1374 return 0;
1377 if (!strcmp(var, "core.sparsecheckout")) {
1378 core_apply_sparse_checkout = git_config_bool(var, value);
1379 return 0;
1382 if (!strcmp(var, "core.sparsecheckoutcone")) {
1383 core_sparse_checkout_cone = git_config_bool(var, value);
1384 return 0;
1387 if (!strcmp(var, "core.precomposeunicode")) {
1388 precomposed_unicode = git_config_bool(var, value);
1389 return 0;
1392 if (!strcmp(var, "core.protecthfs")) {
1393 protect_hfs = git_config_bool(var, value);
1394 return 0;
1397 if (!strcmp(var, "core.protectntfs")) {
1398 protect_ntfs = git_config_bool(var, value);
1399 return 0;
1402 if (!strcmp(var, "core.usereplacerefs")) {
1403 read_replace_refs = git_config_bool(var, value);
1404 return 0;
1407 /* Add other config variables here and to Documentation/config.txt. */
1408 return platform_core_config(var, value, cb);
1411 static int git_default_i18n_config(const char *var, const char *value)
1413 if (!strcmp(var, "i18n.commitencoding"))
1414 return git_config_string(&git_commit_encoding, var, value);
1416 if (!strcmp(var, "i18n.logoutputencoding"))
1417 return git_config_string(&git_log_output_encoding, var, value);
1419 /* Add other config variables here and to Documentation/config.txt. */
1420 return 0;
1423 static int git_default_branch_config(const char *var, const char *value)
1425 if (!strcmp(var, "branch.autosetupmerge")) {
1426 if (value && !strcasecmp(value, "always")) {
1427 git_branch_track = BRANCH_TRACK_ALWAYS;
1428 return 0;
1430 git_branch_track = git_config_bool(var, value);
1431 return 0;
1433 if (!strcmp(var, "branch.autosetuprebase")) {
1434 if (!value)
1435 return config_error_nonbool(var);
1436 else if (!strcmp(value, "never"))
1437 autorebase = AUTOREBASE_NEVER;
1438 else if (!strcmp(value, "local"))
1439 autorebase = AUTOREBASE_LOCAL;
1440 else if (!strcmp(value, "remote"))
1441 autorebase = AUTOREBASE_REMOTE;
1442 else if (!strcmp(value, "always"))
1443 autorebase = AUTOREBASE_ALWAYS;
1444 else
1445 return error(_("malformed value for %s"), var);
1446 return 0;
1449 /* Add other config variables here and to Documentation/config.txt. */
1450 return 0;
1453 static int git_default_push_config(const char *var, const char *value)
1455 if (!strcmp(var, "push.default")) {
1456 if (!value)
1457 return config_error_nonbool(var);
1458 else if (!strcmp(value, "nothing"))
1459 push_default = PUSH_DEFAULT_NOTHING;
1460 else if (!strcmp(value, "matching"))
1461 push_default = PUSH_DEFAULT_MATCHING;
1462 else if (!strcmp(value, "simple"))
1463 push_default = PUSH_DEFAULT_SIMPLE;
1464 else if (!strcmp(value, "upstream"))
1465 push_default = PUSH_DEFAULT_UPSTREAM;
1466 else if (!strcmp(value, "tracking")) /* deprecated */
1467 push_default = PUSH_DEFAULT_UPSTREAM;
1468 else if (!strcmp(value, "current"))
1469 push_default = PUSH_DEFAULT_CURRENT;
1470 else {
1471 error(_("malformed value for %s: %s"), var, value);
1472 return error(_("must be one of nothing, matching, simple, "
1473 "upstream or current"));
1475 return 0;
1478 /* Add other config variables here and to Documentation/config.txt. */
1479 return 0;
1482 static int git_default_mailmap_config(const char *var, const char *value)
1484 if (!strcmp(var, "mailmap.file"))
1485 return git_config_pathname(&git_mailmap_file, var, value);
1486 if (!strcmp(var, "mailmap.blob"))
1487 return git_config_string(&git_mailmap_blob, var, value);
1489 /* Add other config variables here and to Documentation/config.txt. */
1490 return 0;
1493 int git_default_config(const char *var, const char *value, void *cb)
1495 if (starts_with(var, "core."))
1496 return git_default_core_config(var, value, cb);
1498 if (starts_with(var, "user.") ||
1499 starts_with(var, "author.") ||
1500 starts_with(var, "committer."))
1501 return git_ident_config(var, value, cb);
1503 if (starts_with(var, "i18n."))
1504 return git_default_i18n_config(var, value);
1506 if (starts_with(var, "branch."))
1507 return git_default_branch_config(var, value);
1509 if (starts_with(var, "push."))
1510 return git_default_push_config(var, value);
1512 if (starts_with(var, "mailmap."))
1513 return git_default_mailmap_config(var, value);
1515 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1516 return git_default_advice_config(var, value);
1518 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1519 pager_use_color = git_config_bool(var,value);
1520 return 0;
1523 if (!strcmp(var, "pack.packsizelimit")) {
1524 pack_size_limit_cfg = git_config_ulong(var, value);
1525 return 0;
1528 if (!strcmp(var, "pack.compression")) {
1529 int level = git_config_int(var, value);
1530 if (level == -1)
1531 level = Z_DEFAULT_COMPRESSION;
1532 else if (level < 0 || level > Z_BEST_COMPRESSION)
1533 die(_("bad pack compression level %d"), level);
1534 pack_compression_level = level;
1535 pack_compression_seen = 1;
1536 return 0;
1539 /* Add other config variables here and to Documentation/config.txt. */
1540 return 0;
1544 * All source specific fields in the union, die_on_error, name and the callbacks
1545 * fgetc, ungetc, ftell of top need to be initialized before calling
1546 * this function.
1548 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1549 const struct config_options *opts)
1551 int ret;
1553 /* push config-file parsing state stack */
1554 top->prev = cf;
1555 top->linenr = 1;
1556 top->eof = 0;
1557 top->total_len = 0;
1558 strbuf_init(&top->value, 1024);
1559 strbuf_init(&top->var, 1024);
1560 cf = top;
1562 ret = git_parse_source(fn, data, opts);
1564 /* pop config-file parsing state stack */
1565 strbuf_release(&top->value);
1566 strbuf_release(&top->var);
1567 cf = top->prev;
1569 return ret;
1572 static int do_config_from_file(config_fn_t fn,
1573 const enum config_origin_type origin_type,
1574 const char *name, const char *path, FILE *f,
1575 void *data, const struct config_options *opts)
1577 struct config_source top;
1578 int ret;
1580 top.u.file = f;
1581 top.origin_type = origin_type;
1582 top.name = name;
1583 top.path = path;
1584 top.default_error_action = CONFIG_ERROR_DIE;
1585 top.do_fgetc = config_file_fgetc;
1586 top.do_ungetc = config_file_ungetc;
1587 top.do_ftell = config_file_ftell;
1589 flockfile(f);
1590 ret = do_config_from(&top, fn, data, opts);
1591 funlockfile(f);
1592 return ret;
1595 static int git_config_from_stdin(config_fn_t fn, void *data)
1597 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1598 data, NULL);
1601 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1602 void *data,
1603 const struct config_options *opts)
1605 int ret = -1;
1606 FILE *f;
1608 f = fopen_or_warn(filename, "r");
1609 if (f) {
1610 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1611 filename, f, data, opts);
1612 fclose(f);
1614 return ret;
1617 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1619 return git_config_from_file_with_options(fn, filename, data, NULL);
1622 int git_config_from_mem(config_fn_t fn,
1623 const enum config_origin_type origin_type,
1624 const char *name, const char *buf, size_t len,
1625 void *data, const struct config_options *opts)
1627 struct config_source top;
1629 top.u.buf.buf = buf;
1630 top.u.buf.len = len;
1631 top.u.buf.pos = 0;
1632 top.origin_type = origin_type;
1633 top.name = name;
1634 top.path = NULL;
1635 top.default_error_action = CONFIG_ERROR_ERROR;
1636 top.do_fgetc = config_buf_fgetc;
1637 top.do_ungetc = config_buf_ungetc;
1638 top.do_ftell = config_buf_ftell;
1640 return do_config_from(&top, fn, data, opts);
1643 int git_config_from_blob_oid(config_fn_t fn,
1644 const char *name,
1645 const struct object_id *oid,
1646 void *data)
1648 enum object_type type;
1649 char *buf;
1650 unsigned long size;
1651 int ret;
1653 buf = read_object_file(oid, &type, &size);
1654 if (!buf)
1655 return error(_("unable to load config blob object '%s'"), name);
1656 if (type != OBJ_BLOB) {
1657 free(buf);
1658 return error(_("reference '%s' does not point to a blob"), name);
1661 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1662 data, NULL);
1663 free(buf);
1665 return ret;
1668 static int git_config_from_blob_ref(config_fn_t fn,
1669 const char *name,
1670 void *data)
1672 struct object_id oid;
1674 if (get_oid(name, &oid) < 0)
1675 return error(_("unable to resolve config blob '%s'"), name);
1676 return git_config_from_blob_oid(fn, name, &oid, data);
1679 const char *git_etc_gitconfig(void)
1681 static const char *system_wide;
1682 if (!system_wide)
1683 system_wide = system_path(ETC_GITCONFIG);
1684 return system_wide;
1688 * Parse environment variable 'k' as a boolean (in various
1689 * possible spellings); if missing, use the default value 'def'.
1691 int git_env_bool(const char *k, int def)
1693 const char *v = getenv(k);
1694 return v ? git_config_bool(k, v) : def;
1698 * Parse environment variable 'k' as ulong with possibly a unit
1699 * suffix; if missing, use the default value 'val'.
1701 unsigned long git_env_ulong(const char *k, unsigned long val)
1703 const char *v = getenv(k);
1704 if (v && !git_parse_ulong(v, &val))
1705 die(_("failed to parse %s"), k);
1706 return val;
1709 int git_config_system(void)
1711 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1714 static int do_git_config_sequence(const struct config_options *opts,
1715 config_fn_t fn, void *data)
1717 int ret = 0;
1718 char *xdg_config = xdg_config_home("config");
1719 char *user_config = expand_user_path("~/.gitconfig", 0);
1720 char *repo_config;
1721 enum config_scope prev_parsing_scope = current_parsing_scope;
1723 if (opts->commondir)
1724 repo_config = mkpathdup("%s/config", opts->commondir);
1725 else if (opts->git_dir)
1726 BUG("git_dir without commondir");
1727 else
1728 repo_config = NULL;
1730 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1731 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK,
1732 opts->system_gently ?
1733 ACCESS_EACCES_OK : 0))
1734 ret += git_config_from_file(fn, git_etc_gitconfig(),
1735 data);
1737 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1738 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1739 ret += git_config_from_file(fn, xdg_config, data);
1741 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1742 ret += git_config_from_file(fn, user_config, data);
1744 current_parsing_scope = CONFIG_SCOPE_LOCAL;
1745 if (!opts->ignore_repo && repo_config &&
1746 !access_or_die(repo_config, R_OK, 0))
1747 ret += git_config_from_file(fn, repo_config, data);
1749 current_parsing_scope = CONFIG_SCOPE_WORKTREE;
1750 if (!opts->ignore_worktree && repository_format_worktree_config) {
1751 char *path = git_pathdup("config.worktree");
1752 if (!access_or_die(path, R_OK, 0))
1753 ret += git_config_from_file(fn, path, data);
1754 free(path);
1757 current_parsing_scope = CONFIG_SCOPE_COMMAND;
1758 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
1759 die(_("unable to parse command-line config"));
1761 current_parsing_scope = prev_parsing_scope;
1762 free(xdg_config);
1763 free(user_config);
1764 free(repo_config);
1765 return ret;
1768 int config_with_options(config_fn_t fn, void *data,
1769 struct git_config_source *config_source,
1770 const struct config_options *opts)
1772 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1774 if (opts->respect_includes) {
1775 inc.fn = fn;
1776 inc.data = data;
1777 inc.opts = opts;
1778 fn = git_config_include;
1779 data = &inc;
1782 if (config_source)
1783 current_parsing_scope = config_source->scope;
1786 * If we have a specific filename, use it. Otherwise, follow the
1787 * regular lookup sequence.
1789 if (config_source && config_source->use_stdin)
1790 return git_config_from_stdin(fn, data);
1791 else if (config_source && config_source->file)
1792 return git_config_from_file(fn, config_source->file, data);
1793 else if (config_source && config_source->blob)
1794 return git_config_from_blob_ref(fn, config_source->blob, data);
1796 return do_git_config_sequence(opts, fn, data);
1799 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1801 int i, value_index;
1802 struct string_list *values;
1803 struct config_set_element *entry;
1804 struct configset_list *list = &cs->list;
1806 for (i = 0; i < list->nr; i++) {
1807 entry = list->items[i].e;
1808 value_index = list->items[i].value_index;
1809 values = &entry->value_list;
1811 current_config_kvi = values->items[value_index].util;
1813 if (fn(entry->key, values->items[value_index].string, data) < 0)
1814 git_die_config_linenr(entry->key,
1815 current_config_kvi->filename,
1816 current_config_kvi->linenr);
1818 current_config_kvi = NULL;
1822 void read_early_config(config_fn_t cb, void *data)
1824 struct config_options opts = {0};
1825 struct strbuf commondir = STRBUF_INIT;
1826 struct strbuf gitdir = STRBUF_INIT;
1828 opts.respect_includes = 1;
1830 if (have_git_dir()) {
1831 opts.commondir = get_git_common_dir();
1832 opts.git_dir = get_git_dir();
1834 * When setup_git_directory() was not yet asked to discover the
1835 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1836 * is any repository config we should use (but unlike
1837 * setup_git_directory_gently(), no global state is changed, most
1838 * notably, the current working directory is still the same after the
1839 * call).
1841 } else if (!discover_git_directory(&commondir, &gitdir)) {
1842 opts.commondir = commondir.buf;
1843 opts.git_dir = gitdir.buf;
1846 config_with_options(cb, data, NULL, &opts);
1848 strbuf_release(&commondir);
1849 strbuf_release(&gitdir);
1853 * Read config but only enumerate system and global settings.
1854 * Omit any repo-local, worktree-local, or command-line settings.
1856 void read_very_early_config(config_fn_t cb, void *data)
1858 struct config_options opts = { 0 };
1860 opts.respect_includes = 1;
1861 opts.ignore_repo = 1;
1862 opts.ignore_worktree = 1;
1863 opts.ignore_cmdline = 1;
1864 opts.system_gently = 1;
1866 config_with_options(cb, data, NULL, &opts);
1869 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1871 struct config_set_element k;
1872 struct config_set_element *found_entry;
1873 char *normalized_key;
1875 * `key` may come from the user, so normalize it before using it
1876 * for querying entries from the hashmap.
1878 if (git_config_parse_key(key, &normalized_key, NULL))
1879 return NULL;
1881 hashmap_entry_init(&k.ent, strhash(normalized_key));
1882 k.key = normalized_key;
1883 found_entry = hashmap_get_entry(&cs->config_hash, &k, ent, NULL);
1884 free(normalized_key);
1885 return found_entry;
1888 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1890 struct config_set_element *e;
1891 struct string_list_item *si;
1892 struct configset_list_item *l_item;
1893 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1895 e = configset_find_element(cs, key);
1897 * Since the keys are being fed by git_config*() callback mechanism, they
1898 * are already normalized. So simply add them without any further munging.
1900 if (!e) {
1901 e = xmalloc(sizeof(*e));
1902 hashmap_entry_init(&e->ent, strhash(key));
1903 e->key = xstrdup(key);
1904 string_list_init(&e->value_list, 1);
1905 hashmap_add(&cs->config_hash, &e->ent);
1907 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1909 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1910 l_item = &cs->list.items[cs->list.nr++];
1911 l_item->e = e;
1912 l_item->value_index = e->value_list.nr - 1;
1914 if (!cf)
1915 BUG("configset_add_value has no source");
1916 if (cf->name) {
1917 kv_info->filename = strintern(cf->name);
1918 kv_info->linenr = cf->linenr;
1919 kv_info->origin_type = cf->origin_type;
1920 } else {
1921 /* for values read from `git_config_from_parameters()` */
1922 kv_info->filename = NULL;
1923 kv_info->linenr = -1;
1924 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1926 kv_info->scope = current_parsing_scope;
1927 si->util = kv_info;
1929 return 0;
1932 static int config_set_element_cmp(const void *unused_cmp_data,
1933 const struct hashmap_entry *eptr,
1934 const struct hashmap_entry *entry_or_key,
1935 const void *unused_keydata)
1937 const struct config_set_element *e1, *e2;
1939 e1 = container_of(eptr, const struct config_set_element, ent);
1940 e2 = container_of(entry_or_key, const struct config_set_element, ent);
1942 return strcmp(e1->key, e2->key);
1945 void git_configset_init(struct config_set *cs)
1947 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1948 cs->hash_initialized = 1;
1949 cs->list.nr = 0;
1950 cs->list.alloc = 0;
1951 cs->list.items = NULL;
1954 void git_configset_clear(struct config_set *cs)
1956 struct config_set_element *entry;
1957 struct hashmap_iter iter;
1958 if (!cs->hash_initialized)
1959 return;
1961 hashmap_for_each_entry(&cs->config_hash, &iter, entry,
1962 ent /* member name */) {
1963 free(entry->key);
1964 string_list_clear(&entry->value_list, 1);
1966 hashmap_free_entries(&cs->config_hash, struct config_set_element, ent);
1967 cs->hash_initialized = 0;
1968 free(cs->list.items);
1969 cs->list.nr = 0;
1970 cs->list.alloc = 0;
1971 cs->list.items = NULL;
1974 static int config_set_callback(const char *key, const char *value, void *cb)
1976 struct config_set *cs = cb;
1977 configset_add_value(cs, key, value);
1978 return 0;
1981 int git_configset_add_file(struct config_set *cs, const char *filename)
1983 return git_config_from_file(config_set_callback, filename, cs);
1986 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1988 const struct string_list *values = NULL;
1990 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1991 * queried key in the files of the configset, the value returned will be the last
1992 * value in the value list for that key.
1994 values = git_configset_get_value_multi(cs, key);
1996 if (!values)
1997 return 1;
1998 assert(values->nr > 0);
1999 *value = values->items[values->nr - 1].string;
2000 return 0;
2003 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
2005 struct config_set_element *e = configset_find_element(cs, key);
2006 return e ? &e->value_list : NULL;
2009 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
2011 const char *value;
2012 if (!git_configset_get_value(cs, key, &value))
2013 return git_config_string(dest, key, value);
2014 else
2015 return 1;
2018 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
2020 return git_configset_get_string_const(cs, key, (const char **)dest);
2023 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
2025 const char *value;
2026 if (!git_configset_get_value(cs, key, &value)) {
2027 *dest = git_config_int(key, value);
2028 return 0;
2029 } else
2030 return 1;
2033 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
2035 const char *value;
2036 if (!git_configset_get_value(cs, key, &value)) {
2037 *dest = git_config_ulong(key, value);
2038 return 0;
2039 } else
2040 return 1;
2043 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
2045 const char *value;
2046 if (!git_configset_get_value(cs, key, &value)) {
2047 *dest = git_config_bool(key, value);
2048 return 0;
2049 } else
2050 return 1;
2053 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
2054 int *is_bool, int *dest)
2056 const char *value;
2057 if (!git_configset_get_value(cs, key, &value)) {
2058 *dest = git_config_bool_or_int(key, value, is_bool);
2059 return 0;
2060 } else
2061 return 1;
2064 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2066 const char *value;
2067 if (!git_configset_get_value(cs, key, &value)) {
2068 *dest = git_parse_maybe_bool(value);
2069 if (*dest == -1)
2070 return -1;
2071 return 0;
2072 } else
2073 return 1;
2076 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2078 const char *value;
2079 if (!git_configset_get_value(cs, key, &value))
2080 return git_config_pathname(dest, key, value);
2081 else
2082 return 1;
2085 /* Functions use to read configuration from a repository */
2086 static void repo_read_config(struct repository *repo)
2088 struct config_options opts = { 0 };
2090 opts.respect_includes = 1;
2091 opts.commondir = repo->commondir;
2092 opts.git_dir = repo->gitdir;
2094 if (!repo->config)
2095 repo->config = xcalloc(1, sizeof(struct config_set));
2096 else
2097 git_configset_clear(repo->config);
2099 git_configset_init(repo->config);
2101 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2103 * config_with_options() normally returns only
2104 * zero, as most errors are fatal, and
2105 * non-fatal potential errors are guarded by "if"
2106 * statements that are entered only when no error is
2107 * possible.
2109 * If we ever encounter a non-fatal error, it means
2110 * something went really wrong and we should stop
2111 * immediately.
2113 die(_("unknown error occurred while reading the configuration files"));
2116 static void git_config_check_init(struct repository *repo)
2118 if (repo->config && repo->config->hash_initialized)
2119 return;
2120 repo_read_config(repo);
2123 static void repo_config_clear(struct repository *repo)
2125 if (!repo->config || !repo->config->hash_initialized)
2126 return;
2127 git_configset_clear(repo->config);
2130 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2132 git_config_check_init(repo);
2133 configset_iter(repo->config, fn, data);
2136 int repo_config_get_value(struct repository *repo,
2137 const char *key, const char **value)
2139 git_config_check_init(repo);
2140 return git_configset_get_value(repo->config, key, value);
2143 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2144 const char *key)
2146 git_config_check_init(repo);
2147 return git_configset_get_value_multi(repo->config, key);
2150 int repo_config_get_string_const(struct repository *repo,
2151 const char *key, const char **dest)
2153 int ret;
2154 git_config_check_init(repo);
2155 ret = git_configset_get_string_const(repo->config, key, dest);
2156 if (ret < 0)
2157 git_die_config(key, NULL);
2158 return ret;
2161 int repo_config_get_string(struct repository *repo,
2162 const char *key, char **dest)
2164 git_config_check_init(repo);
2165 return repo_config_get_string_const(repo, key, (const char **)dest);
2168 int repo_config_get_int(struct repository *repo,
2169 const char *key, int *dest)
2171 git_config_check_init(repo);
2172 return git_configset_get_int(repo->config, key, dest);
2175 int repo_config_get_ulong(struct repository *repo,
2176 const char *key, unsigned long *dest)
2178 git_config_check_init(repo);
2179 return git_configset_get_ulong(repo->config, key, dest);
2182 int repo_config_get_bool(struct repository *repo,
2183 const char *key, int *dest)
2185 git_config_check_init(repo);
2186 return git_configset_get_bool(repo->config, key, dest);
2189 int repo_config_get_bool_or_int(struct repository *repo,
2190 const char *key, int *is_bool, int *dest)
2192 git_config_check_init(repo);
2193 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2196 int repo_config_get_maybe_bool(struct repository *repo,
2197 const char *key, int *dest)
2199 git_config_check_init(repo);
2200 return git_configset_get_maybe_bool(repo->config, key, dest);
2203 int repo_config_get_pathname(struct repository *repo,
2204 const char *key, const char **dest)
2206 int ret;
2207 git_config_check_init(repo);
2208 ret = git_configset_get_pathname(repo->config, key, dest);
2209 if (ret < 0)
2210 git_die_config(key, NULL);
2211 return ret;
2214 /* Functions used historically to read configuration from 'the_repository' */
2215 void git_config(config_fn_t fn, void *data)
2217 repo_config(the_repository, fn, data);
2220 void git_config_clear(void)
2222 repo_config_clear(the_repository);
2225 int git_config_get_value(const char *key, const char **value)
2227 return repo_config_get_value(the_repository, key, value);
2230 const struct string_list *git_config_get_value_multi(const char *key)
2232 return repo_config_get_value_multi(the_repository, key);
2235 int git_config_get_string_const(const char *key, const char **dest)
2237 return repo_config_get_string_const(the_repository, key, dest);
2240 int git_config_get_string(const char *key, char **dest)
2242 return repo_config_get_string(the_repository, key, dest);
2245 int git_config_get_int(const char *key, int *dest)
2247 return repo_config_get_int(the_repository, key, dest);
2250 int git_config_get_ulong(const char *key, unsigned long *dest)
2252 return repo_config_get_ulong(the_repository, key, dest);
2255 int git_config_get_bool(const char *key, int *dest)
2257 return repo_config_get_bool(the_repository, key, dest);
2260 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2262 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2265 int git_config_get_maybe_bool(const char *key, int *dest)
2267 return repo_config_get_maybe_bool(the_repository, key, dest);
2270 int git_config_get_pathname(const char *key, const char **dest)
2272 return repo_config_get_pathname(the_repository, key, dest);
2275 int git_config_get_expiry(const char *key, const char **output)
2277 int ret = git_config_get_string_const(key, output);
2278 if (ret)
2279 return ret;
2280 if (strcmp(*output, "now")) {
2281 timestamp_t now = approxidate("now");
2282 if (approxidate(*output) >= now)
2283 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2285 return ret;
2288 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2290 char *expiry_string;
2291 intmax_t days;
2292 timestamp_t when;
2294 if (git_config_get_string(key, &expiry_string))
2295 return 1; /* no such thing */
2297 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2298 const int scale = 86400;
2299 *expiry = now - days * scale;
2300 return 0;
2303 if (!parse_expiry_date(expiry_string, &when)) {
2304 *expiry = when;
2305 return 0;
2307 return -1; /* thing exists but cannot be parsed */
2310 int git_config_get_split_index(void)
2312 int val;
2314 if (!git_config_get_maybe_bool("core.splitindex", &val))
2315 return val;
2317 return -1; /* default value */
2320 int git_config_get_max_percent_split_change(void)
2322 int val = -1;
2324 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2325 if (0 <= val && val <= 100)
2326 return val;
2328 return error(_("splitIndex.maxPercentChange value '%d' "
2329 "should be between 0 and 100"), val);
2332 return -1; /* default value */
2335 int git_config_get_fsmonitor(void)
2337 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2338 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2340 if (core_fsmonitor && !*core_fsmonitor)
2341 core_fsmonitor = NULL;
2343 if (core_fsmonitor)
2344 return 1;
2346 return 0;
2349 int git_config_get_index_threads(int *dest)
2351 int is_bool, val;
2353 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2354 if (val) {
2355 *dest = val;
2356 return 0;
2359 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2360 if (is_bool)
2361 *dest = val ? 0 : 1;
2362 else
2363 *dest = val;
2364 return 0;
2367 return 1;
2370 NORETURN
2371 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2373 if (!filename)
2374 die(_("unable to parse '%s' from command-line config"), key);
2375 else
2376 die(_("bad config variable '%s' in file '%s' at line %d"),
2377 key, filename, linenr);
2380 NORETURN __attribute__((format(printf, 2, 3)))
2381 void git_die_config(const char *key, const char *err, ...)
2383 const struct string_list *values;
2384 struct key_value_info *kv_info;
2386 if (err) {
2387 va_list params;
2388 va_start(params, err);
2389 vreportf("error: ", err, params);
2390 va_end(params);
2392 values = git_config_get_value_multi(key);
2393 kv_info = values->items[values->nr - 1].util;
2394 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2398 * Find all the stuff for git_config_set() below.
2401 struct config_store_data {
2402 size_t baselen;
2403 char *key;
2404 int do_not_match;
2405 regex_t *value_regex;
2406 int multi_replace;
2407 struct {
2408 size_t begin, end;
2409 enum config_event_t type;
2410 int is_keys_section;
2411 } *parsed;
2412 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2413 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2416 static void config_store_data_clear(struct config_store_data *store)
2418 free(store->key);
2419 if (store->value_regex != NULL &&
2420 store->value_regex != CONFIG_REGEX_NONE) {
2421 regfree(store->value_regex);
2422 free(store->value_regex);
2424 free(store->parsed);
2425 free(store->seen);
2426 memset(store, 0, sizeof(*store));
2429 static int matches(const char *key, const char *value,
2430 const struct config_store_data *store)
2432 if (strcmp(key, store->key))
2433 return 0; /* not ours */
2434 if (!store->value_regex)
2435 return 1; /* always matches */
2436 if (store->value_regex == CONFIG_REGEX_NONE)
2437 return 0; /* never matches */
2439 return store->do_not_match ^
2440 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2443 static int store_aux_event(enum config_event_t type,
2444 size_t begin, size_t end, void *data)
2446 struct config_store_data *store = data;
2448 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2449 store->parsed[store->parsed_nr].begin = begin;
2450 store->parsed[store->parsed_nr].end = end;
2451 store->parsed[store->parsed_nr].type = type;
2453 if (type == CONFIG_EVENT_SECTION) {
2454 int (*cmpfn)(const char *, const char *, size_t);
2456 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2457 return error(_("invalid section name '%s'"), cf->var.buf);
2459 if (cf->subsection_case_sensitive)
2460 cmpfn = strncasecmp;
2461 else
2462 cmpfn = strncmp;
2464 /* Is this the section we were looking for? */
2465 store->is_keys_section =
2466 store->parsed[store->parsed_nr].is_keys_section =
2467 cf->var.len - 1 == store->baselen &&
2468 !cmpfn(cf->var.buf, store->key, store->baselen);
2469 if (store->is_keys_section) {
2470 store->section_seen = 1;
2471 ALLOC_GROW(store->seen, store->seen_nr + 1,
2472 store->seen_alloc);
2473 store->seen[store->seen_nr] = store->parsed_nr;
2477 store->parsed_nr++;
2479 return 0;
2482 static int store_aux(const char *key, const char *value, void *cb)
2484 struct config_store_data *store = cb;
2486 if (store->key_seen) {
2487 if (matches(key, value, store)) {
2488 if (store->seen_nr == 1 && store->multi_replace == 0) {
2489 warning(_("%s has multiple values"), key);
2492 ALLOC_GROW(store->seen, store->seen_nr + 1,
2493 store->seen_alloc);
2495 store->seen[store->seen_nr] = store->parsed_nr;
2496 store->seen_nr++;
2498 } else if (store->is_keys_section) {
2500 * Do not increment matches yet: this may not be a match, but we
2501 * are in the desired section.
2503 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2504 store->seen[store->seen_nr] = store->parsed_nr;
2505 store->section_seen = 1;
2507 if (matches(key, value, store)) {
2508 store->seen_nr++;
2509 store->key_seen = 1;
2513 return 0;
2516 static int write_error(const char *filename)
2518 error(_("failed to write new configuration file %s"), filename);
2520 /* Same error code as "failed to rename". */
2521 return 4;
2524 static struct strbuf store_create_section(const char *key,
2525 const struct config_store_data *store)
2527 const char *dot;
2528 size_t i;
2529 struct strbuf sb = STRBUF_INIT;
2531 dot = memchr(key, '.', store->baselen);
2532 if (dot) {
2533 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2534 for (i = dot - key + 1; i < store->baselen; i++) {
2535 if (key[i] == '"' || key[i] == '\\')
2536 strbuf_addch(&sb, '\\');
2537 strbuf_addch(&sb, key[i]);
2539 strbuf_addstr(&sb, "\"]\n");
2540 } else {
2541 strbuf_addch(&sb, '[');
2542 strbuf_add(&sb, key, store->baselen);
2543 strbuf_addstr(&sb, "]\n");
2546 return sb;
2549 static ssize_t write_section(int fd, const char *key,
2550 const struct config_store_data *store)
2552 struct strbuf sb = store_create_section(key, store);
2553 ssize_t ret;
2555 ret = write_in_full(fd, sb.buf, sb.len);
2556 strbuf_release(&sb);
2558 return ret;
2561 static ssize_t write_pair(int fd, const char *key, const char *value,
2562 const struct config_store_data *store)
2564 int i;
2565 ssize_t ret;
2566 const char *quote = "";
2567 struct strbuf sb = STRBUF_INIT;
2570 * Check to see if the value needs to be surrounded with a dq pair.
2571 * Note that problematic characters are always backslash-quoted; this
2572 * check is about not losing leading or trailing SP and strings that
2573 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2574 * configuration parser.
2576 if (value[0] == ' ')
2577 quote = "\"";
2578 for (i = 0; value[i]; i++)
2579 if (value[i] == ';' || value[i] == '#')
2580 quote = "\"";
2581 if (i && value[i - 1] == ' ')
2582 quote = "\"";
2584 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
2586 for (i = 0; value[i]; i++)
2587 switch (value[i]) {
2588 case '\n':
2589 strbuf_addstr(&sb, "\\n");
2590 break;
2591 case '\t':
2592 strbuf_addstr(&sb, "\\t");
2593 break;
2594 case '"':
2595 case '\\':
2596 strbuf_addch(&sb, '\\');
2597 /* fallthrough */
2598 default:
2599 strbuf_addch(&sb, value[i]);
2600 break;
2602 strbuf_addf(&sb, "%s\n", quote);
2604 ret = write_in_full(fd, sb.buf, sb.len);
2605 strbuf_release(&sb);
2607 return ret;
2611 * If we are about to unset the last key(s) in a section, and if there are
2612 * no comments surrounding (or included in) the section, we will want to
2613 * extend begin/end to remove the entire section.
2615 * Note: the parameter `seen_ptr` points to the index into the store.seen
2616 * array. * This index may be incremented if a section has more than one
2617 * entry (which all are to be removed).
2619 static void maybe_remove_section(struct config_store_data *store,
2620 size_t *begin_offset, size_t *end_offset,
2621 int *seen_ptr)
2623 size_t begin;
2624 int i, seen, section_seen = 0;
2627 * First, ensure that this is the first key, and that there are no
2628 * comments before the entry nor before the section header.
2630 seen = *seen_ptr;
2631 for (i = store->seen[seen]; i > 0; i--) {
2632 enum config_event_t type = store->parsed[i - 1].type;
2634 if (type == CONFIG_EVENT_COMMENT)
2635 /* There is a comment before this entry or section */
2636 return;
2637 if (type == CONFIG_EVENT_ENTRY) {
2638 if (!section_seen)
2639 /* This is not the section's first entry. */
2640 return;
2641 /* We encountered no comment before the section. */
2642 break;
2644 if (type == CONFIG_EVENT_SECTION) {
2645 if (!store->parsed[i - 1].is_keys_section)
2646 break;
2647 section_seen = 1;
2650 begin = store->parsed[i].begin;
2653 * Next, make sure that we are removing he last key(s) in the section,
2654 * and that there are no comments that are possibly about the current
2655 * section.
2657 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2658 enum config_event_t type = store->parsed[i].type;
2660 if (type == CONFIG_EVENT_COMMENT)
2661 return;
2662 if (type == CONFIG_EVENT_SECTION) {
2663 if (store->parsed[i].is_keys_section)
2664 continue;
2665 break;
2667 if (type == CONFIG_EVENT_ENTRY) {
2668 if (++seen < store->seen_nr &&
2669 i == store->seen[seen])
2670 /* We want to remove this entry, too */
2671 continue;
2672 /* There is another entry in this section. */
2673 return;
2678 * We are really removing the last entry/entries from this section, and
2679 * there are no enclosed or surrounding comments. Remove the entire,
2680 * now-empty section.
2682 *seen_ptr = seen;
2683 *begin_offset = begin;
2684 if (i < store->parsed_nr)
2685 *end_offset = store->parsed[i].begin;
2686 else
2687 *end_offset = store->parsed[store->parsed_nr - 1].end;
2690 int git_config_set_in_file_gently(const char *config_filename,
2691 const char *key, const char *value)
2693 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2696 void git_config_set_in_file(const char *config_filename,
2697 const char *key, const char *value)
2699 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2702 int git_config_set_gently(const char *key, const char *value)
2704 return git_config_set_multivar_gently(key, value, NULL, 0);
2707 void git_config_set(const char *key, const char *value)
2709 git_config_set_multivar(key, value, NULL, 0);
2711 trace2_cmd_set_config(key, value);
2715 * If value==NULL, unset in (remove from) config,
2716 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2717 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2718 * (only add a new one)
2719 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2720 * else all matching key/values (regardless how many) are removed,
2721 * before the new pair is written.
2723 * Returns 0 on success.
2725 * This function does this:
2727 * - it locks the config file by creating ".git/config.lock"
2729 * - it then parses the config using store_aux() as validator to find
2730 * the position on the key/value pair to replace. If it is to be unset,
2731 * it must be found exactly once.
2733 * - the config file is mmap()ed and the part before the match (if any) is
2734 * written to the lock file, then the changed part and the rest.
2736 * - the config file is removed and the lock file rename()d to it.
2739 int git_config_set_multivar_in_file_gently(const char *config_filename,
2740 const char *key, const char *value,
2741 const char *value_regex,
2742 int multi_replace)
2744 int fd = -1, in_fd = -1;
2745 int ret;
2746 struct lock_file lock = LOCK_INIT;
2747 char *filename_buf = NULL;
2748 char *contents = NULL;
2749 size_t contents_sz;
2750 struct config_store_data store;
2752 memset(&store, 0, sizeof(store));
2754 /* parse-key returns negative; flip the sign to feed exit(3) */
2755 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2756 if (ret)
2757 goto out_free;
2759 store.multi_replace = multi_replace;
2761 if (!config_filename)
2762 config_filename = filename_buf = git_pathdup("config");
2765 * The lock serves a purpose in addition to locking: the new
2766 * contents of .git/config will be written into it.
2768 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2769 if (fd < 0) {
2770 error_errno(_("could not lock config file %s"), config_filename);
2771 ret = CONFIG_NO_LOCK;
2772 goto out_free;
2776 * If .git/config does not exist yet, write a minimal version.
2778 in_fd = open(config_filename, O_RDONLY);
2779 if ( in_fd < 0 ) {
2780 if ( ENOENT != errno ) {
2781 error_errno(_("opening %s"), config_filename);
2782 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2783 goto out_free;
2785 /* if nothing to unset, error out */
2786 if (value == NULL) {
2787 ret = CONFIG_NOTHING_SET;
2788 goto out_free;
2791 free(store.key);
2792 store.key = xstrdup(key);
2793 if (write_section(fd, key, &store) < 0 ||
2794 write_pair(fd, key, value, &store) < 0)
2795 goto write_err_out;
2796 } else {
2797 struct stat st;
2798 size_t copy_begin, copy_end;
2799 int i, new_line = 0;
2800 struct config_options opts;
2802 if (value_regex == NULL)
2803 store.value_regex = NULL;
2804 else if (value_regex == CONFIG_REGEX_NONE)
2805 store.value_regex = CONFIG_REGEX_NONE;
2806 else {
2807 if (value_regex[0] == '!') {
2808 store.do_not_match = 1;
2809 value_regex++;
2810 } else
2811 store.do_not_match = 0;
2813 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2814 if (regcomp(store.value_regex, value_regex,
2815 REG_EXTENDED)) {
2816 error(_("invalid pattern: %s"), value_regex);
2817 FREE_AND_NULL(store.value_regex);
2818 ret = CONFIG_INVALID_PATTERN;
2819 goto out_free;
2823 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2824 store.parsed[0].end = 0;
2826 memset(&opts, 0, sizeof(opts));
2827 opts.event_fn = store_aux_event;
2828 opts.event_fn_data = &store;
2831 * After this, store.parsed will contain offsets of all the
2832 * parsed elements, and store.seen will contain a list of
2833 * matches, as indices into store.parsed.
2835 * As a side effect, we make sure to transform only a valid
2836 * existing config file.
2838 if (git_config_from_file_with_options(store_aux,
2839 config_filename,
2840 &store, &opts)) {
2841 error(_("invalid config file %s"), config_filename);
2842 ret = CONFIG_INVALID_FILE;
2843 goto out_free;
2846 /* if nothing to unset, or too many matches, error out */
2847 if ((store.seen_nr == 0 && value == NULL) ||
2848 (store.seen_nr > 1 && multi_replace == 0)) {
2849 ret = CONFIG_NOTHING_SET;
2850 goto out_free;
2853 if (fstat(in_fd, &st) == -1) {
2854 error_errno(_("fstat on %s failed"), config_filename);
2855 ret = CONFIG_INVALID_FILE;
2856 goto out_free;
2859 contents_sz = xsize_t(st.st_size);
2860 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2861 MAP_PRIVATE, in_fd, 0);
2862 if (contents == MAP_FAILED) {
2863 if (errno == ENODEV && S_ISDIR(st.st_mode))
2864 errno = EISDIR;
2865 error_errno(_("unable to mmap '%s'"), config_filename);
2866 ret = CONFIG_INVALID_FILE;
2867 contents = NULL;
2868 goto out_free;
2870 close(in_fd);
2871 in_fd = -1;
2873 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2874 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
2875 ret = CONFIG_NO_WRITE;
2876 goto out_free;
2879 if (store.seen_nr == 0) {
2880 if (!store.seen_alloc) {
2881 /* Did not see key nor section */
2882 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2883 store.seen[0] = store.parsed_nr
2884 - !!store.parsed_nr;
2886 store.seen_nr = 1;
2889 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2890 size_t replace_end;
2891 int j = store.seen[i];
2893 new_line = 0;
2894 if (!store.key_seen) {
2895 copy_end = store.parsed[j].end;
2896 /* include '\n' when copying section header */
2897 if (copy_end > 0 && copy_end < contents_sz &&
2898 contents[copy_end - 1] != '\n' &&
2899 contents[copy_end] == '\n')
2900 copy_end++;
2901 replace_end = copy_end;
2902 } else {
2903 replace_end = store.parsed[j].end;
2904 copy_end = store.parsed[j].begin;
2905 if (!value)
2906 maybe_remove_section(&store,
2907 &copy_end,
2908 &replace_end, &i);
2910 * Swallow preceding white-space on the same
2911 * line.
2913 while (copy_end > 0 ) {
2914 char c = contents[copy_end - 1];
2916 if (isspace(c) && c != '\n')
2917 copy_end--;
2918 else
2919 break;
2923 if (copy_end > 0 && contents[copy_end-1] != '\n')
2924 new_line = 1;
2926 /* write the first part of the config */
2927 if (copy_end > copy_begin) {
2928 if (write_in_full(fd, contents + copy_begin,
2929 copy_end - copy_begin) < 0)
2930 goto write_err_out;
2931 if (new_line &&
2932 write_str_in_full(fd, "\n") < 0)
2933 goto write_err_out;
2935 copy_begin = replace_end;
2938 /* write the pair (value == NULL means unset) */
2939 if (value != NULL) {
2940 if (!store.section_seen) {
2941 if (write_section(fd, key, &store) < 0)
2942 goto write_err_out;
2944 if (write_pair(fd, key, value, &store) < 0)
2945 goto write_err_out;
2948 /* write the rest of the config */
2949 if (copy_begin < contents_sz)
2950 if (write_in_full(fd, contents + copy_begin,
2951 contents_sz - copy_begin) < 0)
2952 goto write_err_out;
2954 munmap(contents, contents_sz);
2955 contents = NULL;
2958 if (commit_lock_file(&lock) < 0) {
2959 error_errno(_("could not write config file %s"), config_filename);
2960 ret = CONFIG_NO_WRITE;
2961 goto out_free;
2964 ret = 0;
2966 /* Invalidate the config cache */
2967 git_config_clear();
2969 out_free:
2970 rollback_lock_file(&lock);
2971 free(filename_buf);
2972 if (contents)
2973 munmap(contents, contents_sz);
2974 if (in_fd >= 0)
2975 close(in_fd);
2976 config_store_data_clear(&store);
2977 return ret;
2979 write_err_out:
2980 ret = write_error(get_lock_file_path(&lock));
2981 goto out_free;
2985 void git_config_set_multivar_in_file(const char *config_filename,
2986 const char *key, const char *value,
2987 const char *value_regex, int multi_replace)
2989 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2990 value_regex, multi_replace))
2991 return;
2992 if (value)
2993 die(_("could not set '%s' to '%s'"), key, value);
2994 else
2995 die(_("could not unset '%s'"), key);
2998 int git_config_set_multivar_gently(const char *key, const char *value,
2999 const char *value_regex, int multi_replace)
3001 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
3002 multi_replace);
3005 void git_config_set_multivar(const char *key, const char *value,
3006 const char *value_regex, int multi_replace)
3008 git_config_set_multivar_in_file(NULL, key, value, value_regex,
3009 multi_replace);
3012 static int section_name_match (const char *buf, const char *name)
3014 int i = 0, j = 0, dot = 0;
3015 if (buf[i] != '[')
3016 return 0;
3017 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3018 if (!dot && isspace(buf[i])) {
3019 dot = 1;
3020 if (name[j++] != '.')
3021 break;
3022 for (i++; isspace(buf[i]); i++)
3023 ; /* do nothing */
3024 if (buf[i] != '"')
3025 break;
3026 continue;
3028 if (buf[i] == '\\' && dot)
3029 i++;
3030 else if (buf[i] == '"' && dot) {
3031 for (i++; isspace(buf[i]); i++)
3032 ; /* do_nothing */
3033 break;
3035 if (buf[i] != name[j++])
3036 break;
3038 if (buf[i] == ']' && name[j] == 0) {
3040 * We match, now just find the right length offset by
3041 * gobbling up any whitespace after it, as well
3043 i++;
3044 for (; buf[i] && isspace(buf[i]); i++)
3045 ; /* do nothing */
3046 return i;
3048 return 0;
3051 static int section_name_is_ok(const char *name)
3053 /* Empty section names are bogus. */
3054 if (!*name)
3055 return 0;
3058 * Before a dot, we must be alphanumeric or dash. After the first dot,
3059 * anything goes, so we can stop checking.
3061 for (; *name && *name != '.'; name++)
3062 if (*name != '-' && !isalnum(*name))
3063 return 0;
3064 return 1;
3067 /* if new_name == NULL, the section is removed instead */
3068 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3069 const char *old_name,
3070 const char *new_name, int copy)
3072 int ret = 0, remove = 0;
3073 char *filename_buf = NULL;
3074 struct lock_file lock = LOCK_INIT;
3075 int out_fd;
3076 char buf[1024];
3077 FILE *config_file = NULL;
3078 struct stat st;
3079 struct strbuf copystr = STRBUF_INIT;
3080 struct config_store_data store;
3082 memset(&store, 0, sizeof(store));
3084 if (new_name && !section_name_is_ok(new_name)) {
3085 ret = error(_("invalid section name: %s"), new_name);
3086 goto out_no_rollback;
3089 if (!config_filename)
3090 config_filename = filename_buf = git_pathdup("config");
3092 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3093 if (out_fd < 0) {
3094 ret = error(_("could not lock config file %s"), config_filename);
3095 goto out;
3098 if (!(config_file = fopen(config_filename, "rb"))) {
3099 ret = warn_on_fopen_errors(config_filename);
3100 if (ret)
3101 goto out;
3102 /* no config file means nothing to rename, no error */
3103 goto commit_and_out;
3106 if (fstat(fileno(config_file), &st) == -1) {
3107 ret = error_errno(_("fstat on %s failed"), config_filename);
3108 goto out;
3111 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3112 ret = error_errno(_("chmod on %s failed"),
3113 get_lock_file_path(&lock));
3114 goto out;
3117 while (fgets(buf, sizeof(buf), config_file)) {
3118 int i;
3119 int length;
3120 int is_section = 0;
3121 char *output = buf;
3122 for (i = 0; buf[i] && isspace(buf[i]); i++)
3123 ; /* do nothing */
3124 if (buf[i] == '[') {
3125 /* it's a section */
3126 int offset;
3127 is_section = 1;
3130 * When encountering a new section under -c we
3131 * need to flush out any section we're already
3132 * coping and begin anew. There might be
3133 * multiple [branch "$name"] sections.
3135 if (copystr.len > 0) {
3136 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3137 ret = write_error(get_lock_file_path(&lock));
3138 goto out;
3140 strbuf_reset(&copystr);
3143 offset = section_name_match(&buf[i], old_name);
3144 if (offset > 0) {
3145 ret++;
3146 if (new_name == NULL) {
3147 remove = 1;
3148 continue;
3150 store.baselen = strlen(new_name);
3151 if (!copy) {
3152 if (write_section(out_fd, new_name, &store) < 0) {
3153 ret = write_error(get_lock_file_path(&lock));
3154 goto out;
3157 * We wrote out the new section, with
3158 * a newline, now skip the old
3159 * section's length
3161 output += offset + i;
3162 if (strlen(output) > 0) {
3164 * More content means there's
3165 * a declaration to put on the
3166 * next line; indent with a
3167 * tab
3169 output -= 1;
3170 output[0] = '\t';
3172 } else {
3173 copystr = store_create_section(new_name, &store);
3176 remove = 0;
3178 if (remove)
3179 continue;
3180 length = strlen(output);
3182 if (!is_section && copystr.len > 0) {
3183 strbuf_add(&copystr, output, length);
3186 if (write_in_full(out_fd, output, length) < 0) {
3187 ret = write_error(get_lock_file_path(&lock));
3188 goto out;
3193 * Copy a trailing section at the end of the config, won't be
3194 * flushed by the usual "flush because we have a new section
3195 * logic in the loop above.
3197 if (copystr.len > 0) {
3198 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3199 ret = write_error(get_lock_file_path(&lock));
3200 goto out;
3202 strbuf_reset(&copystr);
3205 fclose(config_file);
3206 config_file = NULL;
3207 commit_and_out:
3208 if (commit_lock_file(&lock) < 0)
3209 ret = error_errno(_("could not write config file %s"),
3210 config_filename);
3211 out:
3212 if (config_file)
3213 fclose(config_file);
3214 rollback_lock_file(&lock);
3215 out_no_rollback:
3216 free(filename_buf);
3217 config_store_data_clear(&store);
3218 return ret;
3221 int git_config_rename_section_in_file(const char *config_filename,
3222 const char *old_name, const char *new_name)
3224 return git_config_copy_or_rename_section_in_file(config_filename,
3225 old_name, new_name, 0);
3228 int git_config_rename_section(const char *old_name, const char *new_name)
3230 return git_config_rename_section_in_file(NULL, old_name, new_name);
3233 int git_config_copy_section_in_file(const char *config_filename,
3234 const char *old_name, const char *new_name)
3236 return git_config_copy_or_rename_section_in_file(config_filename,
3237 old_name, new_name, 1);
3240 int git_config_copy_section(const char *old_name, const char *new_name)
3242 return git_config_copy_section_in_file(NULL, old_name, new_name);
3246 * Call this to report error for your variable that should not
3247 * get a boolean value (i.e. "[my] var" means "true").
3249 #undef config_error_nonbool
3250 int config_error_nonbool(const char *var)
3252 return error(_("missing value for '%s'"), var);
3255 int parse_config_key(const char *var,
3256 const char *section,
3257 const char **subsection, size_t *subsection_len,
3258 const char **key)
3260 const char *dot;
3262 /* Does it start with "section." ? */
3263 if (!skip_prefix(var, section, &var) || *var != '.')
3264 return -1;
3267 * Find the key; we don't know yet if we have a subsection, but we must
3268 * parse backwards from the end, since the subsection may have dots in
3269 * it, too.
3271 dot = strrchr(var, '.');
3272 *key = dot + 1;
3274 /* Did we have a subsection at all? */
3275 if (dot == var) {
3276 if (subsection) {
3277 *subsection = NULL;
3278 *subsection_len = 0;
3281 else {
3282 if (!subsection)
3283 return -1;
3284 *subsection = var + 1;
3285 *subsection_len = dot - *subsection;
3288 return 0;
3291 const char *current_config_origin_type(void)
3293 int type;
3294 if (current_config_kvi)
3295 type = current_config_kvi->origin_type;
3296 else if(cf)
3297 type = cf->origin_type;
3298 else
3299 BUG("current_config_origin_type called outside config callback");
3301 switch (type) {
3302 case CONFIG_ORIGIN_BLOB:
3303 return "blob";
3304 case CONFIG_ORIGIN_FILE:
3305 return "file";
3306 case CONFIG_ORIGIN_STDIN:
3307 return "standard input";
3308 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3309 return "submodule-blob";
3310 case CONFIG_ORIGIN_CMDLINE:
3311 return "command line";
3312 default:
3313 BUG("unknown config origin type");
3317 const char *config_scope_name(enum config_scope scope)
3319 switch (scope) {
3320 case CONFIG_SCOPE_SYSTEM:
3321 return "system";
3322 case CONFIG_SCOPE_GLOBAL:
3323 return "global";
3324 case CONFIG_SCOPE_LOCAL:
3325 return "local";
3326 case CONFIG_SCOPE_WORKTREE:
3327 return "worktree";
3328 case CONFIG_SCOPE_COMMAND:
3329 return "command";
3330 case CONFIG_SCOPE_SUBMODULE:
3331 return "submodule";
3332 default:
3333 return "unknown";
3337 const char *current_config_name(void)
3339 const char *name;
3340 if (current_config_kvi)
3341 name = current_config_kvi->filename;
3342 else if (cf)
3343 name = cf->name;
3344 else
3345 BUG("current_config_name called outside config callback");
3346 return name ? name : "";
3349 enum config_scope current_config_scope(void)
3351 if (current_config_kvi)
3352 return current_config_kvi->scope;
3353 else
3354 return current_parsing_scope;
3357 int current_config_line(void)
3359 if (current_config_kvi)
3360 return current_config_kvi->linenr;
3361 else
3362 return cf->linenr;
3365 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3367 int i;
3369 for (i = 0; i < nr_mapping; i++) {
3370 const char *name = mapping[i];
3372 if (name && !strcasecmp(var, name))
3373 return i;
3375 return -1;