2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
13 #include "string-list.h"
15 struct config_source {
16 struct config_source *prev;
33 int (*do_fgetc)(struct config_source *c);
34 int (*do_ungetc)(int c, struct config_source *conf);
35 long (*do_ftell)(struct config_source *c);
38 struct config_set_element {
39 struct hashmap_entry ent;
41 struct string_list value_list;
44 static struct config_source *cf;
46 static int zlib_compression_seen;
49 * Default config_set that contains key-value pairs from the usual set of config
50 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
51 * config file and the global /etc/gitconfig)
53 static struct config_set the_config_set;
55 static int config_file_fgetc(struct config_source *conf)
57 return fgetc(conf->u.file);
60 static int config_file_ungetc(int c, struct config_source *conf)
62 return ungetc(c, conf->u.file);
65 static long config_file_ftell(struct config_source *conf)
67 return ftell(conf->u.file);
71 static int config_buf_fgetc(struct config_source *conf)
73 if (conf->u.buf.pos < conf->u.buf.len)
74 return conf->u.buf.buf[conf->u.buf.pos++];
79 static int config_buf_ungetc(int c, struct config_source *conf)
81 if (conf->u.buf.pos > 0)
82 return conf->u.buf.buf[--conf->u.buf.pos];
87 static long config_buf_ftell(struct config_source *conf)
89 return conf->u.buf.pos;
92 #define MAX_INCLUDE_DEPTH 10
93 static const char include_depth_advice[] =
94 "exceeded maximum include depth (%d) while including\n"
98 "Do you have circular includes?";
99 static int handle_path_include(const char *path, struct config_include_data *inc)
102 struct strbuf buf = STRBUF_INIT;
106 return config_error_nonbool("include.path");
108 expanded = expand_user_path(path);
110 return error("Could not expand include path '%s'", path);
114 * Use an absolute path as-is, but interpret relative paths
115 * based on the including config file.
117 if (!is_absolute_path(path)) {
120 if (!cf || !cf->path)
121 return error("relative config includes must come from files");
123 slash = find_last_dir_sep(cf->path);
125 strbuf_add(&buf, cf->path, slash - cf->path + 1);
126 strbuf_addstr(&buf, path);
130 if (!access_or_die(path, R_OK, 0)) {
131 if (++inc->depth > MAX_INCLUDE_DEPTH)
132 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
133 cf && cf->name ? cf->name : "the command line");
134 ret = git_config_from_file(git_config_include, path, inc);
137 strbuf_release(&buf);
142 int git_config_include(const char *var, const char *value, void *data)
144 struct config_include_data *inc = data;
149 * Pass along all values, including "include" directives; this makes it
150 * possible to query information on the includes themselves.
152 ret = inc->fn(var, value, inc->data);
156 if (!skip_prefix(var, "include.", &type))
159 if (!strcmp(type, "path"))
160 ret = handle_path_include(value, inc);
164 void git_config_push_parameter(const char *text)
166 struct strbuf env = STRBUF_INIT;
167 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
169 strbuf_addstr(&env, old);
170 strbuf_addch(&env, ' ');
172 sq_quote_buf(&env, text);
173 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
174 strbuf_release(&env);
177 int git_config_parse_parameter(const char *text,
178 config_fn_t fn, void *data)
180 struct strbuf **pair;
181 pair = strbuf_split_str(text, '=', 2);
183 return error("bogus config parameter: %s", text);
184 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
185 strbuf_setlen(pair[0], pair[0]->len - 1);
186 strbuf_trim(pair[0]);
188 strbuf_list_free(pair);
189 return error("bogus config parameter: %s", text);
191 strbuf_tolower(pair[0]);
192 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
193 strbuf_list_free(pair);
196 strbuf_list_free(pair);
200 int git_config_from_parameters(config_fn_t fn, void *data)
202 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
204 const char **argv = NULL;
205 int nr = 0, alloc = 0;
210 /* sq_dequote will write over it */
213 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
215 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
218 for (i = 0; i < nr; i++) {
219 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
231 static int get_next_char(void)
233 int c = cf->do_fgetc(cf);
236 /* DOS like systems */
237 c = cf->do_fgetc(cf);
239 cf->do_ungetc(c, cf);
253 static char *parse_value(void)
255 int quote = 0, comment = 0, space = 0;
257 strbuf_reset(&cf->value);
259 int c = get_next_char();
265 return cf->value.buf;
269 if (isspace(c) && !quote) {
275 if (c == ';' || c == '#') {
280 for (; space; space--)
281 strbuf_addch(&cf->value, ' ');
296 /* Some characters escape as themselves */
299 /* Reject unknown escape sequences */
303 strbuf_addch(&cf->value, c);
310 strbuf_addch(&cf->value, c);
314 static inline int iskeychar(int c)
316 return isalnum(c) || c == '-';
319 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
325 /* Get the full name */
332 strbuf_addch(name, tolower(c));
335 while (c == ' ' || c == '\t')
342 value = parse_value();
347 * We already consumed the \n, but we need linenr to point to
348 * the line we just parsed during the call to fn to get
349 * accurate line number in error messages.
352 ret = fn(name->buf, value, data);
357 static int get_extended_base_var(struct strbuf *name, int c)
361 goto error_incomplete_line;
363 } while (isspace(c));
365 /* We require the format to be '[base "extension"]' */
368 strbuf_addch(name, '.');
371 int c = get_next_char();
373 goto error_incomplete_line;
379 goto error_incomplete_line;
381 strbuf_addch(name, c);
385 if (get_next_char() != ']')
388 error_incomplete_line:
393 static int get_base_var(struct strbuf *name)
396 int c = get_next_char();
402 return get_extended_base_var(name, c);
403 if (!iskeychar(c) && c != '.')
405 strbuf_addch(name, tolower(c));
409 static int git_parse_source(config_fn_t fn, void *data)
413 struct strbuf *var = &cf->var;
415 /* U+FEFF Byte Order Mark in UTF8 */
416 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
417 const unsigned char *bomptr = utf8_bom;
420 int c = get_next_char();
421 if (bomptr && *bomptr) {
422 /* We are at the file beginning; skip UTF8-encoded BOM
423 * if present. Sane editors won't put this in on their
424 * own, but e.g. Windows Notepad will do it happily. */
425 if ((unsigned char) c == *bomptr) {
429 /* Do not tolerate partial BOM. */
430 if (bomptr != utf8_bom)
432 /* No BOM at file beginning. Cool. */
442 if (comment || isspace(c))
444 if (c == '#' || c == ';') {
449 /* Reset prior to determining a new stem */
451 if (get_base_var(var) < 0 || var->len < 1)
453 strbuf_addch(var, '.');
460 * Truncate the var name back to the section header
461 * stem prior to grabbing the suffix part of the name
464 strbuf_setlen(var, baselen);
465 strbuf_addch(var, tolower(c));
466 if (get_value(fn, data, var) < 0)
469 if (cf->die_on_error)
470 die(_("bad config file line %d in %s"), cf->linenr, cf->name);
472 return error(_("bad config file line %d in %s"), cf->linenr, cf->name);
475 static int parse_unit_factor(const char *end, uintmax_t *val)
479 else if (!strcasecmp(end, "k")) {
483 else if (!strcasecmp(end, "m")) {
487 else if (!strcasecmp(end, "g")) {
488 *val *= 1024 * 1024 * 1024;
494 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
496 if (value && *value) {
500 uintmax_t factor = 1;
503 val = strtoimax(value, &end, 0);
506 if (!parse_unit_factor(end, &factor)) {
512 if (uval > max || abs(val) > uval) {
524 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
526 if (value && *value) {
532 val = strtoumax(value, &end, 0);
536 if (!parse_unit_factor(end, &val)) {
540 if (val > max || oldval > val) {
551 static int git_parse_int(const char *value, int *ret)
554 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
560 static int git_parse_int64(const char *value, int64_t *ret)
563 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
569 int git_parse_ulong(const char *value, unsigned long *ret)
572 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
579 static void die_bad_number(const char *name, const char *value)
581 const char *reason = errno == ERANGE ?
588 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
589 value, name, cf->name, reason);
590 die(_("bad numeric config value '%s' for '%s': %s"), value, name, reason);
593 int git_config_int(const char *name, const char *value)
596 if (!git_parse_int(value, &ret))
597 die_bad_number(name, value);
601 int64_t git_config_int64(const char *name, const char *value)
604 if (!git_parse_int64(value, &ret))
605 die_bad_number(name, value);
609 unsigned long git_config_ulong(const char *name, const char *value)
612 if (!git_parse_ulong(value, &ret))
613 die_bad_number(name, value);
617 static int git_config_maybe_bool_text(const char *name, const char *value)
623 if (!strcasecmp(value, "true")
624 || !strcasecmp(value, "yes")
625 || !strcasecmp(value, "on"))
627 if (!strcasecmp(value, "false")
628 || !strcasecmp(value, "no")
629 || !strcasecmp(value, "off"))
634 int git_config_maybe_bool(const char *name, const char *value)
636 int v = git_config_maybe_bool_text(name, value);
639 if (git_parse_int(value, &v))
644 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
646 int v = git_config_maybe_bool_text(name, value);
652 return git_config_int(name, value);
655 int git_config_bool(const char *name, const char *value)
658 return !!git_config_bool_or_int(name, value, &discard);
661 int git_config_string(const char **dest, const char *var, const char *value)
664 return config_error_nonbool(var);
665 *dest = xstrdup(value);
669 int git_config_pathname(const char **dest, const char *var, const char *value)
672 return config_error_nonbool(var);
673 *dest = expand_user_path(value);
675 die(_("failed to expand user dir in: '%s'"), value);
679 static int git_default_core_config(const char *var, const char *value)
681 /* This needs a better name */
682 if (!strcmp(var, "core.filemode")) {
683 trust_executable_bit = git_config_bool(var, value);
686 if (!strcmp(var, "core.trustctime")) {
687 trust_ctime = git_config_bool(var, value);
690 if (!strcmp(var, "core.checkstat")) {
691 if (!strcasecmp(value, "default"))
693 else if (!strcasecmp(value, "minimal"))
697 if (!strcmp(var, "core.quotepath")) {
698 quote_path_fully = git_config_bool(var, value);
702 if (!strcmp(var, "core.symlinks")) {
703 has_symlinks = git_config_bool(var, value);
707 if (!strcmp(var, "core.ignorecase")) {
708 ignore_case = git_config_bool(var, value);
712 if (!strcmp(var, "core.attributesfile"))
713 return git_config_pathname(&git_attributes_file, var, value);
715 if (!strcmp(var, "core.bare")) {
716 is_bare_repository_cfg = git_config_bool(var, value);
720 if (!strcmp(var, "core.ignorestat")) {
721 assume_unchanged = git_config_bool(var, value);
725 if (!strcmp(var, "core.prefersymlinkrefs")) {
726 prefer_symlink_refs = git_config_bool(var, value);
730 if (!strcmp(var, "core.logallrefupdates")) {
731 log_all_ref_updates = git_config_bool(var, value);
735 if (!strcmp(var, "core.warnambiguousrefs")) {
736 warn_ambiguous_refs = git_config_bool(var, value);
740 if (!strcmp(var, "core.abbrev")) {
741 int abbrev = git_config_int(var, value);
742 if (abbrev < minimum_abbrev || abbrev > 40)
744 default_abbrev = abbrev;
748 if (!strcmp(var, "core.loosecompression")) {
749 int level = git_config_int(var, value);
751 level = Z_DEFAULT_COMPRESSION;
752 else if (level < 0 || level > Z_BEST_COMPRESSION)
753 die(_("bad zlib compression level %d"), level);
754 zlib_compression_level = level;
755 zlib_compression_seen = 1;
759 if (!strcmp(var, "core.compression")) {
760 int level = git_config_int(var, value);
762 level = Z_DEFAULT_COMPRESSION;
763 else if (level < 0 || level > Z_BEST_COMPRESSION)
764 die(_("bad zlib compression level %d"), level);
765 core_compression_level = level;
766 core_compression_seen = 1;
767 if (!zlib_compression_seen)
768 zlib_compression_level = level;
772 if (!strcmp(var, "core.packedgitwindowsize")) {
773 int pgsz_x2 = getpagesize() * 2;
774 packed_git_window_size = git_config_ulong(var, value);
776 /* This value must be multiple of (pagesize * 2) */
777 packed_git_window_size /= pgsz_x2;
778 if (packed_git_window_size < 1)
779 packed_git_window_size = 1;
780 packed_git_window_size *= pgsz_x2;
784 if (!strcmp(var, "core.bigfilethreshold")) {
785 big_file_threshold = git_config_ulong(var, value);
789 if (!strcmp(var, "core.packedgitlimit")) {
790 packed_git_limit = git_config_ulong(var, value);
794 if (!strcmp(var, "core.deltabasecachelimit")) {
795 delta_base_cache_limit = git_config_ulong(var, value);
799 if (!strcmp(var, "core.autocrlf")) {
800 if (value && !strcasecmp(value, "input")) {
801 if (core_eol == EOL_CRLF)
802 return error("core.autocrlf=input conflicts with core.eol=crlf");
803 auto_crlf = AUTO_CRLF_INPUT;
806 auto_crlf = git_config_bool(var, value);
810 if (!strcmp(var, "core.safecrlf")) {
811 if (value && !strcasecmp(value, "warn")) {
812 safe_crlf = SAFE_CRLF_WARN;
815 safe_crlf = git_config_bool(var, value);
819 if (!strcmp(var, "core.eol")) {
820 if (value && !strcasecmp(value, "lf"))
822 else if (value && !strcasecmp(value, "crlf"))
824 else if (value && !strcasecmp(value, "native"))
825 core_eol = EOL_NATIVE;
827 core_eol = EOL_UNSET;
828 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
829 return error("core.autocrlf=input conflicts with core.eol=crlf");
833 if (!strcmp(var, "core.notesref")) {
834 notes_ref_name = xstrdup(value);
838 if (!strcmp(var, "core.pager"))
839 return git_config_string(&pager_program, var, value);
841 if (!strcmp(var, "core.editor"))
842 return git_config_string(&editor_program, var, value);
844 if (!strcmp(var, "core.commentchar")) {
846 int ret = git_config_string(&comment, var, value);
849 else if (!strcasecmp(comment, "auto"))
850 auto_comment_line_char = 1;
851 else if (comment[0] && !comment[1]) {
852 comment_line_char = comment[0];
853 auto_comment_line_char = 0;
855 return error("core.commentChar should only be one character");
859 if (!strcmp(var, "core.askpass"))
860 return git_config_string(&askpass_program, var, value);
862 if (!strcmp(var, "core.excludesfile"))
863 return git_config_pathname(&excludes_file, var, value);
865 if (!strcmp(var, "core.whitespace")) {
867 return config_error_nonbool(var);
868 whitespace_rule_cfg = parse_whitespace_rule(value);
872 if (!strcmp(var, "core.fsyncobjectfiles")) {
873 fsync_object_files = git_config_bool(var, value);
877 if (!strcmp(var, "core.preloadindex")) {
878 core_preload_index = git_config_bool(var, value);
882 if (!strcmp(var, "core.createobject")) {
883 if (!strcmp(value, "rename"))
884 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
885 else if (!strcmp(value, "link"))
886 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
888 die(_("invalid mode for object creation: %s"), value);
892 if (!strcmp(var, "core.sparsecheckout")) {
893 core_apply_sparse_checkout = git_config_bool(var, value);
897 if (!strcmp(var, "core.precomposeunicode")) {
898 precomposed_unicode = git_config_bool(var, value);
902 /* Add other config variables here and to Documentation/config.txt. */
906 static int git_default_i18n_config(const char *var, const char *value)
908 if (!strcmp(var, "i18n.commitencoding"))
909 return git_config_string(&git_commit_encoding, var, value);
911 if (!strcmp(var, "i18n.logoutputencoding"))
912 return git_config_string(&git_log_output_encoding, var, value);
914 /* Add other config variables here and to Documentation/config.txt. */
918 static int git_default_branch_config(const char *var, const char *value)
920 if (!strcmp(var, "branch.autosetupmerge")) {
921 if (value && !strcasecmp(value, "always")) {
922 git_branch_track = BRANCH_TRACK_ALWAYS;
925 git_branch_track = git_config_bool(var, value);
928 if (!strcmp(var, "branch.autosetuprebase")) {
930 return config_error_nonbool(var);
931 else if (!strcmp(value, "never"))
932 autorebase = AUTOREBASE_NEVER;
933 else if (!strcmp(value, "local"))
934 autorebase = AUTOREBASE_LOCAL;
935 else if (!strcmp(value, "remote"))
936 autorebase = AUTOREBASE_REMOTE;
937 else if (!strcmp(value, "always"))
938 autorebase = AUTOREBASE_ALWAYS;
940 return error("Malformed value for %s", var);
944 /* Add other config variables here and to Documentation/config.txt. */
948 static int git_default_push_config(const char *var, const char *value)
950 if (!strcmp(var, "push.default")) {
952 return config_error_nonbool(var);
953 else if (!strcmp(value, "nothing"))
954 push_default = PUSH_DEFAULT_NOTHING;
955 else if (!strcmp(value, "matching"))
956 push_default = PUSH_DEFAULT_MATCHING;
957 else if (!strcmp(value, "simple"))
958 push_default = PUSH_DEFAULT_SIMPLE;
959 else if (!strcmp(value, "upstream"))
960 push_default = PUSH_DEFAULT_UPSTREAM;
961 else if (!strcmp(value, "tracking")) /* deprecated */
962 push_default = PUSH_DEFAULT_UPSTREAM;
963 else if (!strcmp(value, "current"))
964 push_default = PUSH_DEFAULT_CURRENT;
966 error("Malformed value for %s: %s", var, value);
967 return error("Must be one of nothing, matching, simple, "
968 "upstream or current.");
973 /* Add other config variables here and to Documentation/config.txt. */
977 static int git_default_mailmap_config(const char *var, const char *value)
979 if (!strcmp(var, "mailmap.file"))
980 return git_config_pathname(&git_mailmap_file, var, value);
981 if (!strcmp(var, "mailmap.blob"))
982 return git_config_string(&git_mailmap_blob, var, value);
984 /* Add other config variables here and to Documentation/config.txt. */
988 int git_default_config(const char *var, const char *value, void *dummy)
990 if (starts_with(var, "core."))
991 return git_default_core_config(var, value);
993 if (starts_with(var, "user."))
994 return git_ident_config(var, value, dummy);
996 if (starts_with(var, "i18n."))
997 return git_default_i18n_config(var, value);
999 if (starts_with(var, "branch."))
1000 return git_default_branch_config(var, value);
1002 if (starts_with(var, "push."))
1003 return git_default_push_config(var, value);
1005 if (starts_with(var, "mailmap."))
1006 return git_default_mailmap_config(var, value);
1008 if (starts_with(var, "advice."))
1009 return git_default_advice_config(var, value);
1011 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1012 pager_use_color = git_config_bool(var,value);
1016 if (!strcmp(var, "pack.packsizelimit")) {
1017 pack_size_limit_cfg = git_config_ulong(var, value);
1020 /* Add other config variables here and to Documentation/config.txt. */
1025 * All source specific fields in the union, die_on_error, name and the callbacks
1026 * fgetc, ungetc, ftell of top need to be initialized before calling
1029 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1033 /* push config-file parsing state stack */
1037 strbuf_init(&top->value, 1024);
1038 strbuf_init(&top->var, 1024);
1041 ret = git_parse_source(fn, data);
1043 /* pop config-file parsing state stack */
1044 strbuf_release(&top->value);
1045 strbuf_release(&top->var);
1051 static int do_config_from_file(config_fn_t fn,
1052 const char *name, const char *path, FILE *f, void *data)
1054 struct config_source top;
1059 top.die_on_error = 1;
1060 top.do_fgetc = config_file_fgetc;
1061 top.do_ungetc = config_file_ungetc;
1062 top.do_ftell = config_file_ftell;
1064 return do_config_from(&top, fn, data);
1067 static int git_config_from_stdin(config_fn_t fn, void *data)
1069 return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
1072 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1077 f = fopen(filename, "r");
1079 ret = do_config_from_file(fn, filename, filename, f, data);
1085 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1086 size_t len, void *data)
1088 struct config_source top;
1090 top.u.buf.buf = buf;
1091 top.u.buf.len = len;
1095 top.die_on_error = 0;
1096 top.do_fgetc = config_buf_fgetc;
1097 top.do_ungetc = config_buf_ungetc;
1098 top.do_ftell = config_buf_ftell;
1100 return do_config_from(&top, fn, data);
1103 static int git_config_from_blob_sha1(config_fn_t fn,
1105 const unsigned char *sha1,
1108 enum object_type type;
1113 buf = read_sha1_file(sha1, &type, &size);
1115 return error("unable to load config blob object '%s'", name);
1116 if (type != OBJ_BLOB) {
1118 return error("reference '%s' does not point to a blob", name);
1121 ret = git_config_from_buf(fn, name, buf, size, data);
1127 static int git_config_from_blob_ref(config_fn_t fn,
1131 unsigned char sha1[20];
1133 if (get_sha1(name, sha1) < 0)
1134 return error("unable to resolve config blob '%s'", name);
1135 return git_config_from_blob_sha1(fn, name, sha1, data);
1138 const char *git_etc_gitconfig(void)
1140 static const char *system_wide;
1142 system_wide = system_path(ETC_GITCONFIG);
1146 int git_env_bool(const char *k, int def)
1148 const char *v = getenv(k);
1149 return v ? git_config_bool(k, v) : def;
1152 int git_config_system(void)
1154 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1157 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1159 int ret = 0, found = 0;
1160 char *xdg_config = NULL;
1161 char *user_config = NULL;
1163 home_config_paths(&user_config, &xdg_config, "config");
1165 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1166 ret += git_config_from_file(fn, git_etc_gitconfig(),
1171 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1172 ret += git_config_from_file(fn, xdg_config, data);
1176 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1177 ret += git_config_from_file(fn, user_config, data);
1181 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1182 ret += git_config_from_file(fn, repo_config, data);
1186 switch (git_config_from_parameters(fn, data)) {
1187 case -1: /* error */
1188 die(_("unable to parse command-line config"));
1190 case 0: /* found nothing */
1192 default: /* found at least one item */
1199 return ret == 0 ? found : ret;
1202 int git_config_with_options(config_fn_t fn, void *data,
1203 struct git_config_source *config_source,
1204 int respect_includes)
1206 char *repo_config = NULL;
1208 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1210 if (respect_includes) {
1213 fn = git_config_include;
1218 * If we have a specific filename, use it. Otherwise, follow the
1219 * regular lookup sequence.
1221 if (config_source && config_source->use_stdin)
1222 return git_config_from_stdin(fn, data);
1223 else if (config_source && config_source->file)
1224 return git_config_from_file(fn, config_source->file, data);
1225 else if (config_source && config_source->blob)
1226 return git_config_from_blob_ref(fn, config_source->blob, data);
1228 repo_config = git_pathdup("config");
1229 ret = git_config_early(fn, data, repo_config);
1235 int git_config(config_fn_t fn, void *data)
1237 return git_config_with_options(fn, data, NULL, 1);
1240 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1242 struct config_set_element k;
1243 struct config_set_element *found_entry;
1244 char *normalized_key;
1247 * `key` may come from the user, so normalize it before using it
1248 * for querying entries from the hashmap.
1250 ret = git_config_parse_key(key, &normalized_key, NULL);
1255 hashmap_entry_init(&k, strhash(normalized_key));
1256 k.key = normalized_key;
1257 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1258 free(normalized_key);
1262 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1264 struct config_set_element *e;
1265 struct string_list_item *si;
1266 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1268 e = configset_find_element(cs, key);
1270 * Since the keys are being fed by git_config*() callback mechanism, they
1271 * are already normalized. So simply add them without any further munging.
1274 e = xmalloc(sizeof(*e));
1275 hashmap_entry_init(e, strhash(key));
1276 e->key = xstrdup(key);
1277 string_list_init(&e->value_list, 1);
1278 hashmap_add(&cs->config_hash, e);
1280 si = string_list_append_nodup(&e->value_list, value ? xstrdup(value) : NULL);
1282 kv_info->filename = strintern(cf->name);
1283 kv_info->linenr = cf->linenr;
1285 /* for values read from `git_config_from_parameters()` */
1286 kv_info->filename = NULL;
1287 kv_info->linenr = -1;
1294 static int config_set_element_cmp(const struct config_set_element *e1,
1295 const struct config_set_element *e2, const void *unused)
1297 return strcmp(e1->key, e2->key);
1300 void git_configset_init(struct config_set *cs)
1302 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1303 cs->hash_initialized = 1;
1306 void git_configset_clear(struct config_set *cs)
1308 struct config_set_element *entry;
1309 struct hashmap_iter iter;
1310 if (!cs->hash_initialized)
1313 hashmap_iter_init(&cs->config_hash, &iter);
1314 while ((entry = hashmap_iter_next(&iter))) {
1316 string_list_clear(&entry->value_list, 1);
1318 hashmap_free(&cs->config_hash, 1);
1319 cs->hash_initialized = 0;
1322 static int config_set_callback(const char *key, const char *value, void *cb)
1324 struct config_set *cs = cb;
1325 configset_add_value(cs, key, value);
1329 int git_configset_add_file(struct config_set *cs, const char *filename)
1331 return git_config_from_file(config_set_callback, filename, cs);
1334 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1336 const struct string_list *values = NULL;
1338 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1339 * queried key in the files of the configset, the value returned will be the last
1340 * value in the value list for that key.
1342 values = git_configset_get_value_multi(cs, key);
1346 assert(values->nr > 0);
1347 *value = values->items[values->nr - 1].string;
1351 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1353 struct config_set_element *e = configset_find_element(cs, key);
1354 return e ? &e->value_list : NULL;
1357 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1360 if (!git_configset_get_value(cs, key, &value))
1361 return git_config_string(dest, key, value);
1366 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1368 return git_configset_get_string_const(cs, key, (const char **)dest);
1371 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1374 if (!git_configset_get_value(cs, key, &value)) {
1375 *dest = git_config_int(key, value);
1381 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1384 if (!git_configset_get_value(cs, key, &value)) {
1385 *dest = git_config_ulong(key, value);
1391 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1394 if (!git_configset_get_value(cs, key, &value)) {
1395 *dest = git_config_bool(key, value);
1401 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1402 int *is_bool, int *dest)
1405 if (!git_configset_get_value(cs, key, &value)) {
1406 *dest = git_config_bool_or_int(key, value, is_bool);
1412 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1415 if (!git_configset_get_value(cs, key, &value)) {
1416 *dest = git_config_maybe_bool(key, value);
1424 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1427 if (!git_configset_get_value(cs, key, &value))
1428 return git_config_pathname(dest, key, value);
1433 static void git_config_check_init(void)
1435 if (the_config_set.hash_initialized)
1437 git_configset_init(&the_config_set);
1438 git_config(config_set_callback, &the_config_set);
1441 void git_config_clear(void)
1443 if (!the_config_set.hash_initialized)
1445 git_configset_clear(&the_config_set);
1448 int git_config_get_value(const char *key, const char **value)
1450 git_config_check_init();
1451 return git_configset_get_value(&the_config_set, key, value);
1454 const struct string_list *git_config_get_value_multi(const char *key)
1456 git_config_check_init();
1457 return git_configset_get_value_multi(&the_config_set, key);
1460 int git_config_get_string_const(const char *key, const char **dest)
1462 git_config_check_init();
1463 return git_configset_get_string_const(&the_config_set, key, dest);
1466 int git_config_get_string(const char *key, char **dest)
1468 git_config_check_init();
1469 return git_config_get_string_const(key, (const char **)dest);
1472 int git_config_get_int(const char *key, int *dest)
1474 git_config_check_init();
1475 return git_configset_get_int(&the_config_set, key, dest);
1478 int git_config_get_ulong(const char *key, unsigned long *dest)
1480 git_config_check_init();
1481 return git_configset_get_ulong(&the_config_set, key, dest);
1484 int git_config_get_bool(const char *key, int *dest)
1486 git_config_check_init();
1487 return git_configset_get_bool(&the_config_set, key, dest);
1490 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1492 git_config_check_init();
1493 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1496 int git_config_get_maybe_bool(const char *key, int *dest)
1498 git_config_check_init();
1499 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1502 int git_config_get_pathname(const char *key, const char **dest)
1504 git_config_check_init();
1505 return git_configset_get_pathname(&the_config_set, key, dest);
1509 * Find all the stuff for git_config_set() below.
1516 regex_t *value_regex;
1519 unsigned int offset_alloc;
1520 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1524 static int matches(const char *key, const char *value)
1526 return !strcmp(key, store.key) &&
1527 (store.value_regex == NULL ||
1528 (store.do_not_match ^
1529 !regexec(store.value_regex, value, 0, NULL, 0)));
1532 static int store_aux(const char *key, const char *value, void *cb)
1537 switch (store.state) {
1539 if (matches(key, value)) {
1540 if (store.seen == 1 && store.multi_replace == 0) {
1541 warning(_("%s has multiple values"), key);
1544 ALLOC_GROW(store.offset, store.seen + 1,
1545 store.offset_alloc);
1547 store.offset[store.seen] = cf->do_ftell(cf);
1553 * What we are looking for is in store.key (both
1554 * section and var), and its section part is baselen
1555 * long. We found key (again, both section and var).
1556 * We would want to know if this key is in the same
1557 * section as what we are looking for. We already
1558 * know we are in the same section as what should
1561 ep = strrchr(key, '.');
1562 section_len = ep - key;
1564 if ((section_len != store.baselen) ||
1565 memcmp(key, store.key, section_len+1)) {
1566 store.state = SECTION_END_SEEN;
1571 * Do not increment matches: this is no match, but we
1572 * just made sure we are in the desired section.
1574 ALLOC_GROW(store.offset, store.seen + 1,
1575 store.offset_alloc);
1576 store.offset[store.seen] = cf->do_ftell(cf);
1578 case SECTION_END_SEEN:
1580 if (matches(key, value)) {
1581 ALLOC_GROW(store.offset, store.seen + 1,
1582 store.offset_alloc);
1583 store.offset[store.seen] = cf->do_ftell(cf);
1584 store.state = KEY_SEEN;
1587 if (strrchr(key, '.') - key == store.baselen &&
1588 !strncmp(key, store.key, store.baselen)) {
1589 store.state = SECTION_SEEN;
1590 ALLOC_GROW(store.offset,
1592 store.offset_alloc);
1593 store.offset[store.seen] = cf->do_ftell(cf);
1600 static int write_error(const char *filename)
1602 error("failed to write new configuration file %s", filename);
1604 /* Same error code as "failed to rename". */
1608 static int store_write_section(int fd, const char *key)
1612 struct strbuf sb = STRBUF_INIT;
1614 dot = memchr(key, '.', store.baselen);
1616 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1617 for (i = dot - key + 1; i < store.baselen; i++) {
1618 if (key[i] == '"' || key[i] == '\\')
1619 strbuf_addch(&sb, '\\');
1620 strbuf_addch(&sb, key[i]);
1622 strbuf_addstr(&sb, "\"]\n");
1624 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1627 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1628 strbuf_release(&sb);
1633 static int store_write_pair(int fd, const char *key, const char *value)
1636 int length = strlen(key + store.baselen + 1);
1637 const char *quote = "";
1638 struct strbuf sb = STRBUF_INIT;
1641 * Check to see if the value needs to be surrounded with a dq pair.
1642 * Note that problematic characters are always backslash-quoted; this
1643 * check is about not losing leading or trailing SP and strings that
1644 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1645 * configuration parser.
1647 if (value[0] == ' ')
1649 for (i = 0; value[i]; i++)
1650 if (value[i] == ';' || value[i] == '#')
1652 if (i && value[i - 1] == ' ')
1655 strbuf_addf(&sb, "\t%.*s = %s",
1656 length, key + store.baselen + 1, quote);
1658 for (i = 0; value[i]; i++)
1661 strbuf_addstr(&sb, "\\n");
1664 strbuf_addstr(&sb, "\\t");
1668 strbuf_addch(&sb, '\\');
1670 strbuf_addch(&sb, value[i]);
1673 strbuf_addf(&sb, "%s\n", quote);
1675 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1676 strbuf_release(&sb);
1681 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1682 size_t offset_, int *found_bracket)
1684 size_t equal_offset = size, bracket_offset = size;
1688 for (offset = offset_-2; offset > 0
1689 && contents[offset] != '\n'; offset--)
1690 switch (contents[offset]) {
1691 case '=': equal_offset = offset; break;
1692 case ']': bracket_offset = offset; break;
1694 if (offset > 0 && contents[offset-1] == '\\') {
1698 if (bracket_offset < equal_offset) {
1700 offset = bracket_offset+1;
1707 int git_config_set_in_file(const char *config_filename,
1708 const char *key, const char *value)
1710 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1713 int git_config_set(const char *key, const char *value)
1715 return git_config_set_multivar(key, value, NULL, 0);
1719 * Auxiliary function to sanity-check and split the key into the section
1720 * identifier and variable name.
1722 * Returns 0 on success, -1 when there is an invalid character in the key and
1723 * -2 if there is no section name in the key.
1725 * store_key - pointer to char* which will hold a copy of the key with
1726 * lowercase section and variable name
1727 * baselen - pointer to int which will hold the length of the
1728 * section + subsection part, can be NULL
1730 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1732 int i, dot, baselen;
1733 const char *last_dot = strrchr(key, '.');
1736 * Since "key" actually contains the section name and the real
1737 * key name separated by a dot, we have to know where the dot is.
1740 if (last_dot == NULL || last_dot == key) {
1741 error("key does not contain a section: %s", key);
1742 return -CONFIG_NO_SECTION_OR_NAME;
1746 error("key does not contain variable name: %s", key);
1747 return -CONFIG_NO_SECTION_OR_NAME;
1750 baselen = last_dot - key;
1752 *baselen_ = baselen;
1755 * Validate the key and while at it, lower case it for matching.
1757 *store_key = xmalloc(strlen(key) + 1);
1760 for (i = 0; key[i]; i++) {
1761 unsigned char c = key[i];
1764 /* Leave the extended basename untouched.. */
1765 if (!dot || i > baselen) {
1766 if (!iskeychar(c) ||
1767 (i == baselen + 1 && !isalpha(c))) {
1768 error("invalid key: %s", key);
1769 goto out_free_ret_1;
1772 } else if (c == '\n') {
1773 error("invalid key (newline): %s", key);
1774 goto out_free_ret_1;
1776 (*store_key)[i] = c;
1778 (*store_key)[i] = 0;
1785 return -CONFIG_INVALID_KEY;
1789 * If value==NULL, unset in (remove from) config,
1790 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1791 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1792 * else all matching key/values (regardless how many) are removed,
1793 * before the new pair is written.
1795 * Returns 0 on success.
1797 * This function does this:
1799 * - it locks the config file by creating ".git/config.lock"
1801 * - it then parses the config using store_aux() as validator to find
1802 * the position on the key/value pair to replace. If it is to be unset,
1803 * it must be found exactly once.
1805 * - the config file is mmap()ed and the part before the match (if any) is
1806 * written to the lock file, then the changed part and the rest.
1808 * - the config file is removed and the lock file rename()d to it.
1811 int git_config_set_multivar_in_file(const char *config_filename,
1812 const char *key, const char *value,
1813 const char *value_regex, int multi_replace)
1817 struct lock_file *lock = NULL;
1818 char *filename_buf = NULL;
1820 /* parse-key returns negative; flip the sign to feed exit(3) */
1821 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1825 store.multi_replace = multi_replace;
1827 if (!config_filename)
1828 config_filename = filename_buf = git_pathdup("config");
1831 * The lock serves a purpose in addition to locking: the new
1832 * contents of .git/config will be written into it.
1834 lock = xcalloc(1, sizeof(struct lock_file));
1835 fd = hold_lock_file_for_update(lock, config_filename, 0);
1837 error("could not lock config file %s: %s", config_filename, strerror(errno));
1839 ret = CONFIG_NO_LOCK;
1844 * If .git/config does not exist yet, write a minimal version.
1846 in_fd = open(config_filename, O_RDONLY);
1850 if ( ENOENT != errno ) {
1851 error("opening %s: %s", config_filename,
1853 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1856 /* if nothing to unset, error out */
1857 if (value == NULL) {
1858 ret = CONFIG_NOTHING_SET;
1862 store.key = (char *)key;
1863 if (!store_write_section(fd, key) ||
1864 !store_write_pair(fd, key, value))
1869 size_t contents_sz, copy_begin, copy_end;
1870 int i, new_line = 0;
1872 if (value_regex == NULL)
1873 store.value_regex = NULL;
1875 if (value_regex[0] == '!') {
1876 store.do_not_match = 1;
1879 store.do_not_match = 0;
1881 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1882 if (regcomp(store.value_regex, value_regex,
1884 error("invalid pattern: %s", value_regex);
1885 free(store.value_regex);
1886 ret = CONFIG_INVALID_PATTERN;
1891 ALLOC_GROW(store.offset, 1, store.offset_alloc);
1892 store.offset[0] = 0;
1893 store.state = START;
1897 * After this, store.offset will contain the *end* offset
1898 * of the last match, or remain at 0 if no match was found.
1899 * As a side effect, we make sure to transform only a valid
1900 * existing config file.
1902 if (git_config_from_file(store_aux, config_filename, NULL)) {
1903 error("invalid config file %s", config_filename);
1905 if (store.value_regex != NULL) {
1906 regfree(store.value_regex);
1907 free(store.value_regex);
1909 ret = CONFIG_INVALID_FILE;
1914 if (store.value_regex != NULL) {
1915 regfree(store.value_regex);
1916 free(store.value_regex);
1919 /* if nothing to unset, or too many matches, error out */
1920 if ((store.seen == 0 && value == NULL) ||
1921 (store.seen > 1 && multi_replace == 0)) {
1922 ret = CONFIG_NOTHING_SET;
1927 contents_sz = xsize_t(st.st_size);
1928 contents = xmmap(NULL, contents_sz, PROT_READ,
1929 MAP_PRIVATE, in_fd, 0);
1932 if (chmod(lock->filename, st.st_mode & 07777) < 0) {
1933 error("chmod on %s failed: %s",
1934 lock->filename, strerror(errno));
1935 ret = CONFIG_NO_WRITE;
1939 if (store.seen == 0)
1942 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1943 if (store.offset[i] == 0) {
1944 store.offset[i] = copy_end = contents_sz;
1945 } else if (store.state != KEY_SEEN) {
1946 copy_end = store.offset[i];
1948 copy_end = find_beginning_of_line(
1949 contents, contents_sz,
1950 store.offset[i]-2, &new_line);
1952 if (copy_end > 0 && contents[copy_end-1] != '\n')
1955 /* write the first part of the config */
1956 if (copy_end > copy_begin) {
1957 if (write_in_full(fd, contents + copy_begin,
1958 copy_end - copy_begin) <
1959 copy_end - copy_begin)
1962 write_str_in_full(fd, "\n") != 1)
1965 copy_begin = store.offset[i];
1968 /* write the pair (value == NULL means unset) */
1969 if (value != NULL) {
1970 if (store.state == START) {
1971 if (!store_write_section(fd, key))
1974 if (!store_write_pair(fd, key, value))
1978 /* write the rest of the config */
1979 if (copy_begin < contents_sz)
1980 if (write_in_full(fd, contents + copy_begin,
1981 contents_sz - copy_begin) <
1982 contents_sz - copy_begin)
1985 munmap(contents, contents_sz);
1988 if (commit_lock_file(lock) < 0) {
1989 error("could not commit config file %s", config_filename);
1990 ret = CONFIG_NO_WRITE;
1995 * lock is committed, so don't try to roll it back below.
1996 * NOTE: Since lockfile.c keeps a linked list of all created
1997 * lock_file structures, it isn't safe to free(lock). It's
1998 * better to just leave it hanging around.
2003 /* Invalidate the config cache */
2008 rollback_lock_file(lock);
2013 ret = write_error(lock->filename);
2018 int git_config_set_multivar(const char *key, const char *value,
2019 const char *value_regex, int multi_replace)
2021 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
2025 static int section_name_match (const char *buf, const char *name)
2027 int i = 0, j = 0, dot = 0;
2030 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2031 if (!dot && isspace(buf[i])) {
2033 if (name[j++] != '.')
2035 for (i++; isspace(buf[i]); i++)
2041 if (buf[i] == '\\' && dot)
2043 else if (buf[i] == '"' && dot) {
2044 for (i++; isspace(buf[i]); i++)
2048 if (buf[i] != name[j++])
2051 if (buf[i] == ']' && name[j] == 0) {
2053 * We match, now just find the right length offset by
2054 * gobbling up any whitespace after it, as well
2057 for (; buf[i] && isspace(buf[i]); i++)
2064 static int section_name_is_ok(const char *name)
2066 /* Empty section names are bogus. */
2071 * Before a dot, we must be alphanumeric or dash. After the first dot,
2072 * anything goes, so we can stop checking.
2074 for (; *name && *name != '.'; name++)
2075 if (*name != '-' && !isalnum(*name))
2080 /* if new_name == NULL, the section is removed instead */
2081 int git_config_rename_section_in_file(const char *config_filename,
2082 const char *old_name, const char *new_name)
2084 int ret = 0, remove = 0;
2085 char *filename_buf = NULL;
2086 struct lock_file *lock;
2092 if (new_name && !section_name_is_ok(new_name)) {
2093 ret = error("invalid section name: %s", new_name);
2097 if (!config_filename)
2098 config_filename = filename_buf = git_pathdup("config");
2100 lock = xcalloc(1, sizeof(struct lock_file));
2101 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2103 ret = error("could not lock config file %s", config_filename);
2107 if (!(config_file = fopen(config_filename, "rb"))) {
2108 /* no config file means nothing to rename, no error */
2109 goto unlock_and_out;
2112 fstat(fileno(config_file), &st);
2114 if (chmod(lock->filename, st.st_mode & 07777) < 0) {
2115 ret = error("chmod on %s failed: %s",
2116 lock->filename, strerror(errno));
2120 while (fgets(buf, sizeof(buf), config_file)) {
2124 for (i = 0; buf[i] && isspace(buf[i]); i++)
2126 if (buf[i] == '[') {
2127 /* it's a section */
2128 int offset = section_name_match(&buf[i], old_name);
2131 if (new_name == NULL) {
2135 store.baselen = strlen(new_name);
2136 if (!store_write_section(out_fd, new_name)) {
2137 ret = write_error(lock->filename);
2141 * We wrote out the new section, with
2142 * a newline, now skip the old
2145 output += offset + i;
2146 if (strlen(output) > 0) {
2148 * More content means there's
2149 * a declaration to put on the
2150 * next line; indent with a
2161 length = strlen(output);
2162 if (write_in_full(out_fd, output, length) != length) {
2163 ret = write_error(lock->filename);
2167 fclose(config_file);
2169 if (commit_lock_file(lock) < 0)
2170 ret = error("could not commit config file %s", config_filename);
2176 int git_config_rename_section(const char *old_name, const char *new_name)
2178 return git_config_rename_section_in_file(NULL, old_name, new_name);
2182 * Call this to report error for your variable that should not
2183 * get a boolean value (i.e. "[my] var" means "true").
2185 #undef config_error_nonbool
2186 int config_error_nonbool(const char *var)
2188 return error("Missing value for '%s'", var);
2191 int parse_config_key(const char *var,
2192 const char *section,
2193 const char **subsection, int *subsection_len,
2196 int section_len = strlen(section);
2199 /* Does it start with "section." ? */
2200 if (!starts_with(var, section) || var[section_len] != '.')
2204 * Find the key; we don't know yet if we have a subsection, but we must
2205 * parse backwards from the end, since the subsection may have dots in
2208 dot = strrchr(var, '.');
2211 /* Did we have a subsection at all? */
2212 if (dot == var + section_len) {
2214 *subsection_len = 0;
2217 *subsection = var + section_len + 1;
2218 *subsection_len = dot - *subsection;