2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
15 #include "string-list.h"
19 struct config_source {
20 struct config_source *prev;
29 enum config_origin_type origin_type;
38 int (*do_fgetc)(struct config_source *c);
39 int (*do_ungetc)(int c, struct config_source *conf);
40 long (*do_ftell)(struct config_source *c);
44 * These variables record the "current" config source, which
45 * can be accessed by parsing callbacks.
47 * The "cf" variable will be non-NULL only when we are actually parsing a real
48 * config source (file, blob, cmdline, etc).
50 * The "current_config_kvi" variable will be non-NULL only when we are feeding
51 * cached config from a configset into a callback.
53 * They should generally never be non-NULL at the same time. If they are both
54 * NULL, then we aren't parsing anything (and depending on the function looking
55 * at the variables, it's either a bug for it to be called in the first place,
56 * or it's a function which can be reused for non-config purposes, and should
57 * fall back to some sane behavior).
59 static struct config_source *cf;
60 static struct key_value_info *current_config_kvi;
63 * Similar to the variables above, this gives access to the "scope" of the
64 * current value (repo, global, etc). For cached values, it can be found via
65 * the current_config_kvi as above. During parsing, the current value can be
66 * found in this variable. It's not part of "cf" because it transcends a single
67 * file (i.e., a file included from .git/config is still in "repo" scope).
69 static enum config_scope current_parsing_scope;
71 static int core_compression_seen;
72 static int pack_compression_seen;
73 static int zlib_compression_seen;
76 * Default config_set that contains key-value pairs from the usual set of config
77 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
78 * config file and the global /etc/gitconfig)
80 static struct config_set the_config_set;
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++];
106 static int config_buf_ungetc(int c, struct config_source *conf)
108 if (conf->u.buf.pos > 0) {
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
111 die("BUG: config_buf can only ungetc the same character");
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[] =
125 "exceeded maximum include depth (%d) while including\n"
129 "Do you have circular includes?";
130 static int handle_path_include(const char *path, struct config_include_data *inc)
133 struct strbuf buf = STRBUF_INIT;
137 return config_error_nonbool("include.path");
139 expanded = expand_user_path(path, 0);
141 return error("could not expand include path '%s'", path);
145 * Use an absolute path as-is, but interpret relative paths
146 * based on the including config file.
148 if (!is_absolute_path(path)) {
151 if (!cf || !cf->path)
152 return error("relative config includes must come from files");
154 slash = find_last_dir_sep(cf->path);
156 strbuf_add(&buf, cf->path, slash - cf->path + 1);
157 strbuf_addstr(&buf, path);
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,
165 cf->name ? cf->name :
167 ret = git_config_from_file(git_config_include, path, inc);
170 strbuf_release(&buf);
175 static int prepare_include_condition_pattern(struct strbuf *pat)
177 struct strbuf path = STRBUF_INIT;
181 expanded = expand_user_path(pat->buf, 1);
184 strbuf_addstr(pat, expanded);
188 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
191 if (!cf || !cf->path)
192 return error(_("relative config include "
193 "conditionals must come from files"));
195 strbuf_realpath(&path, cf->path, 1);
196 slash = find_last_dir_sep(path.buf);
198 die("BUG: how is this possible?");
199 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
200 prefix = slash - path.buf + 1 /* slash */;
201 } else if (!is_absolute_path(pat->buf))
202 strbuf_insert(pat, 0, "**/", 3);
204 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
205 strbuf_addstr(pat, "**");
207 strbuf_release(&path);
211 static int include_by_gitdir(const struct config_options *opts,
212 const char *cond, size_t cond_len, int icase)
214 struct strbuf text = STRBUF_INIT;
215 struct strbuf pattern = STRBUF_INIT;
220 git_dir = opts->git_dir;
224 strbuf_realpath(&text, git_dir, 1);
225 strbuf_add(&pattern, cond, cond_len);
226 prefix = prepare_include_condition_pattern(&pattern);
233 * perform literal matching on the prefix part so that
234 * any wildcard character in it can't create side effects.
236 if (text.len < prefix)
238 if (!icase && strncmp(pattern.buf, text.buf, prefix))
240 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
244 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
245 icase ? WM_CASEFOLD : 0, NULL);
248 strbuf_release(&pattern);
249 strbuf_release(&text);
253 static int include_condition_is_true(const struct config_options *opts,
254 const char *cond, size_t cond_len)
257 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
258 return include_by_gitdir(opts, cond, cond_len, 0);
259 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
260 return include_by_gitdir(opts, cond, cond_len, 1);
262 /* unknown conditionals are always false */
266 int git_config_include(const char *var, const char *value, void *data)
268 struct config_include_data *inc = data;
269 const char *cond, *key;
274 * Pass along all values, including "include" directives; this makes it
275 * possible to query information on the includes themselves.
277 ret = inc->fn(var, value, inc->data);
281 if (!strcmp(var, "include.path"))
282 ret = handle_path_include(value, inc);
284 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
285 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
286 !strcmp(key, "path"))
287 ret = handle_path_include(value, inc);
292 void git_config_push_parameter(const char *text)
294 struct strbuf env = STRBUF_INIT;
295 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
297 strbuf_addstr(&env, old);
298 strbuf_addch(&env, ' ');
300 sq_quote_buf(&env, text);
301 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
302 strbuf_release(&env);
305 static inline int iskeychar(int c)
307 return isalnum(c) || c == '-';
311 * Auxiliary function to sanity-check and split the key into the section
312 * identifier and variable name.
314 * Returns 0 on success, -1 when there is an invalid character in the key and
315 * -2 if there is no section name in the key.
317 * store_key - pointer to char* which will hold a copy of the key with
318 * lowercase section and variable name
319 * baselen - pointer to int which will hold the length of the
320 * section + subsection part, can be NULL
322 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
325 const char *last_dot = strrchr(key, '.');
328 * Since "key" actually contains the section name and the real
329 * key name separated by a dot, we have to know where the dot is.
332 if (last_dot == NULL || last_dot == key) {
334 error("key does not contain a section: %s", key);
335 return -CONFIG_NO_SECTION_OR_NAME;
340 error("key does not contain variable name: %s", key);
341 return -CONFIG_NO_SECTION_OR_NAME;
344 baselen = last_dot - key;
349 * Validate the key and while at it, lower case it for matching.
352 *store_key = xmallocz(strlen(key));
355 for (i = 0; key[i]; i++) {
356 unsigned char c = key[i];
359 /* Leave the extended basename untouched.. */
360 if (!dot || i > baselen) {
362 (i == baselen + 1 && !isalpha(c))) {
364 error("invalid key: %s", key);
368 } else if (c == '\n') {
370 error("invalid key (newline): %s", key);
384 return -CONFIG_INVALID_KEY;
387 int git_config_parse_key(const char *key, char **store_key, int *baselen)
389 return git_config_parse_key_1(key, store_key, baselen, 0);
392 int git_config_key_is_valid(const char *key)
394 return !git_config_parse_key_1(key, NULL, NULL, 1);
397 int git_config_parse_parameter(const char *text,
398 config_fn_t fn, void *data)
401 char *canonical_name;
402 struct strbuf **pair;
405 pair = strbuf_split_str(text, '=', 2);
407 return error("bogus config parameter: %s", text);
409 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
410 strbuf_setlen(pair[0], pair[0]->len - 1);
411 value = pair[1] ? pair[1]->buf : "";
416 strbuf_trim(pair[0]);
418 strbuf_list_free(pair);
419 return error("bogus config parameter: %s", text);
422 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
425 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
426 free(canonical_name);
428 strbuf_list_free(pair);
432 int git_config_from_parameters(config_fn_t fn, void *data)
434 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
437 const char **argv = NULL;
438 int nr = 0, alloc = 0;
440 struct config_source source;
445 memset(&source, 0, sizeof(source));
447 source.origin_type = CONFIG_ORIGIN_CMDLINE;
450 /* sq_dequote will write over it */
453 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
454 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
458 for (i = 0; i < nr; i++) {
459 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
472 static int get_next_char(void)
474 int c = cf->do_fgetc(cf);
477 /* DOS like systems */
478 c = cf->do_fgetc(cf);
481 cf->do_ungetc(c, cf);
495 static char *parse_value(void)
497 int quote = 0, comment = 0, space = 0;
499 strbuf_reset(&cf->value);
501 int c = get_next_char();
507 return cf->value.buf;
511 if (isspace(c) && !quote) {
517 if (c == ';' || c == '#') {
522 for (; space; space--)
523 strbuf_addch(&cf->value, ' ');
538 /* Some characters escape as themselves */
541 /* Reject unknown escape sequences */
545 strbuf_addch(&cf->value, c);
552 strbuf_addch(&cf->value, c);
556 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
562 /* Get the full name */
569 strbuf_addch(name, tolower(c));
572 while (c == ' ' || c == '\t')
579 value = parse_value();
584 * We already consumed the \n, but we need linenr to point to
585 * the line we just parsed during the call to fn to get
586 * accurate line number in error messages.
589 ret = fn(name->buf, value, data);
595 static int get_extended_base_var(struct strbuf *name, int c)
599 goto error_incomplete_line;
601 } while (isspace(c));
603 /* We require the format to be '[base "extension"]' */
606 strbuf_addch(name, '.');
609 int c = get_next_char();
611 goto error_incomplete_line;
617 goto error_incomplete_line;
619 strbuf_addch(name, c);
623 if (get_next_char() != ']')
626 error_incomplete_line:
631 static int get_base_var(struct strbuf *name)
634 int c = get_next_char();
640 return get_extended_base_var(name, c);
641 if (!iskeychar(c) && c != '.')
643 strbuf_addch(name, tolower(c));
647 static int git_parse_source(config_fn_t fn, void *data)
651 struct strbuf *var = &cf->var;
652 int error_return = 0;
653 char *error_msg = NULL;
655 /* U+FEFF Byte Order Mark in UTF8 */
656 const char *bomptr = utf8_bom;
659 int c = get_next_char();
660 if (bomptr && *bomptr) {
661 /* We are at the file beginning; skip UTF8-encoded BOM
662 * if present. Sane editors won't put this in on their
663 * own, but e.g. Windows Notepad will do it happily. */
664 if (c == (*bomptr & 0377)) {
668 /* Do not tolerate partial BOM. */
669 if (bomptr != utf8_bom)
671 /* No BOM at file beginning. Cool. */
681 if (comment || isspace(c))
683 if (c == '#' || c == ';') {
688 /* Reset prior to determining a new stem */
690 if (get_base_var(var) < 0 || var->len < 1)
692 strbuf_addch(var, '.');
699 * Truncate the var name back to the section header
700 * stem prior to grabbing the suffix part of the name
703 strbuf_setlen(var, baselen);
704 strbuf_addch(var, tolower(c));
705 if (get_value(fn, data, var) < 0)
709 switch (cf->origin_type) {
710 case CONFIG_ORIGIN_BLOB:
711 error_msg = xstrfmt(_("bad config line %d in blob %s"),
712 cf->linenr, cf->name);
714 case CONFIG_ORIGIN_FILE:
715 error_msg = xstrfmt(_("bad config line %d in file %s"),
716 cf->linenr, cf->name);
718 case CONFIG_ORIGIN_STDIN:
719 error_msg = xstrfmt(_("bad config line %d in standard input"),
722 case CONFIG_ORIGIN_SUBMODULE_BLOB:
723 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
724 cf->linenr, cf->name);
726 case CONFIG_ORIGIN_CMDLINE:
727 error_msg = xstrfmt(_("bad config line %d in command line %s"),
728 cf->linenr, cf->name);
731 error_msg = xstrfmt(_("bad config line %d in %s"),
732 cf->linenr, cf->name);
735 if (cf->die_on_error)
736 die("%s", error_msg);
738 error_return = error("%s", error_msg);
744 static int parse_unit_factor(const char *end, uintmax_t *val)
748 else if (!strcasecmp(end, "k")) {
752 else if (!strcasecmp(end, "m")) {
756 else if (!strcasecmp(end, "g")) {
757 *val *= 1024 * 1024 * 1024;
763 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
765 if (value && *value) {
769 uintmax_t factor = 1;
772 val = strtoimax(value, &end, 0);
775 if (!parse_unit_factor(end, &factor)) {
781 if (uval > max || labs(val) > uval) {
793 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
795 if (value && *value) {
801 val = strtoumax(value, &end, 0);
805 if (!parse_unit_factor(end, &val)) {
809 if (val > max || oldval > val) {
820 static int git_parse_int(const char *value, int *ret)
823 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
829 static int git_parse_int64(const char *value, int64_t *ret)
832 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
838 int git_parse_ulong(const char *value, unsigned long *ret)
841 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
847 static int git_parse_ssize_t(const char *value, ssize_t *ret)
850 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
857 static void die_bad_number(const char *name, const char *value)
859 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
864 if (!(cf && cf->name))
865 die(_("bad numeric config value '%s' for '%s': %s"),
866 value, name, error_type);
868 switch (cf->origin_type) {
869 case CONFIG_ORIGIN_BLOB:
870 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
871 value, name, cf->name, error_type);
872 case CONFIG_ORIGIN_FILE:
873 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
874 value, name, cf->name, error_type);
875 case CONFIG_ORIGIN_STDIN:
876 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
877 value, name, error_type);
878 case CONFIG_ORIGIN_SUBMODULE_BLOB:
879 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
880 value, name, cf->name, error_type);
881 case CONFIG_ORIGIN_CMDLINE:
882 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
883 value, name, cf->name, error_type);
885 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
886 value, name, cf->name, error_type);
890 int git_config_int(const char *name, const char *value)
893 if (!git_parse_int(value, &ret))
894 die_bad_number(name, value);
898 int64_t git_config_int64(const char *name, const char *value)
901 if (!git_parse_int64(value, &ret))
902 die_bad_number(name, value);
906 unsigned long git_config_ulong(const char *name, const char *value)
909 if (!git_parse_ulong(value, &ret))
910 die_bad_number(name, value);
914 ssize_t git_config_ssize_t(const char *name, const char *value)
917 if (!git_parse_ssize_t(value, &ret))
918 die_bad_number(name, value);
922 int git_parse_maybe_bool(const char *value)
928 if (!strcasecmp(value, "true")
929 || !strcasecmp(value, "yes")
930 || !strcasecmp(value, "on"))
932 if (!strcasecmp(value, "false")
933 || !strcasecmp(value, "no")
934 || !strcasecmp(value, "off"))
939 int git_config_maybe_bool(const char *name, const char *value)
941 int v = git_parse_maybe_bool(value);
944 if (git_parse_int(value, &v))
949 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
951 int v = git_parse_maybe_bool(value);
957 return git_config_int(name, value);
960 int git_config_bool(const char *name, const char *value)
963 return !!git_config_bool_or_int(name, value, &discard);
966 int git_config_string(const char **dest, const char *var, const char *value)
969 return config_error_nonbool(var);
970 *dest = xstrdup(value);
974 int git_config_pathname(const char **dest, const char *var, const char *value)
977 return config_error_nonbool(var);
978 *dest = expand_user_path(value, 0);
980 die(_("failed to expand user dir in: '%s'"), value);
984 static int git_default_core_config(const char *var, const char *value)
986 /* This needs a better name */
987 if (!strcmp(var, "core.filemode")) {
988 trust_executable_bit = git_config_bool(var, value);
991 if (!strcmp(var, "core.trustctime")) {
992 trust_ctime = git_config_bool(var, value);
995 if (!strcmp(var, "core.checkstat")) {
996 if (!strcasecmp(value, "default"))
998 else if (!strcasecmp(value, "minimal"))
1002 if (!strcmp(var, "core.quotepath")) {
1003 quote_path_fully = git_config_bool(var, value);
1007 if (!strcmp(var, "core.symlinks")) {
1008 has_symlinks = git_config_bool(var, value);
1012 if (!strcmp(var, "core.ignorecase")) {
1013 ignore_case = git_config_bool(var, value);
1017 if (!strcmp(var, "core.attributesfile"))
1018 return git_config_pathname(&git_attributes_file, var, value);
1020 if (!strcmp(var, "core.hookspath"))
1021 return git_config_pathname(&git_hooks_path, var, value);
1023 if (!strcmp(var, "core.bare")) {
1024 is_bare_repository_cfg = git_config_bool(var, value);
1028 if (!strcmp(var, "core.ignorestat")) {
1029 assume_unchanged = git_config_bool(var, value);
1033 if (!strcmp(var, "core.prefersymlinkrefs")) {
1034 prefer_symlink_refs = git_config_bool(var, value);
1038 if (!strcmp(var, "core.logallrefupdates")) {
1039 if (value && !strcasecmp(value, "always"))
1040 log_all_ref_updates = LOG_REFS_ALWAYS;
1041 else if (git_config_bool(var, value))
1042 log_all_ref_updates = LOG_REFS_NORMAL;
1044 log_all_ref_updates = LOG_REFS_NONE;
1048 if (!strcmp(var, "core.warnambiguousrefs")) {
1049 warn_ambiguous_refs = git_config_bool(var, value);
1053 if (!strcmp(var, "core.abbrev")) {
1055 return config_error_nonbool(var);
1056 if (!strcasecmp(value, "auto"))
1057 default_abbrev = -1;
1059 int abbrev = git_config_int(var, value);
1060 if (abbrev < minimum_abbrev || abbrev > 40)
1061 return error("abbrev length out of range: %d", abbrev);
1062 default_abbrev = abbrev;
1067 if (!strcmp(var, "core.disambiguate"))
1068 return set_disambiguate_hint_config(var, value);
1070 if (!strcmp(var, "core.loosecompression")) {
1071 int level = git_config_int(var, value);
1073 level = Z_DEFAULT_COMPRESSION;
1074 else if (level < 0 || level > Z_BEST_COMPRESSION)
1075 die(_("bad zlib compression level %d"), level);
1076 zlib_compression_level = level;
1077 zlib_compression_seen = 1;
1081 if (!strcmp(var, "core.compression")) {
1082 int level = git_config_int(var, value);
1084 level = Z_DEFAULT_COMPRESSION;
1085 else if (level < 0 || level > Z_BEST_COMPRESSION)
1086 die(_("bad zlib compression level %d"), level);
1087 core_compression_level = level;
1088 core_compression_seen = 1;
1089 if (!zlib_compression_seen)
1090 zlib_compression_level = level;
1091 if (!pack_compression_seen)
1092 pack_compression_level = level;
1096 if (!strcmp(var, "core.packedgitwindowsize")) {
1097 int pgsz_x2 = getpagesize() * 2;
1098 packed_git_window_size = git_config_ulong(var, value);
1100 /* This value must be multiple of (pagesize * 2) */
1101 packed_git_window_size /= pgsz_x2;
1102 if (packed_git_window_size < 1)
1103 packed_git_window_size = 1;
1104 packed_git_window_size *= pgsz_x2;
1108 if (!strcmp(var, "core.bigfilethreshold")) {
1109 big_file_threshold = git_config_ulong(var, value);
1113 if (!strcmp(var, "core.packedgitlimit")) {
1114 packed_git_limit = git_config_ulong(var, value);
1118 if (!strcmp(var, "core.deltabasecachelimit")) {
1119 delta_base_cache_limit = git_config_ulong(var, value);
1123 if (!strcmp(var, "core.autocrlf")) {
1124 if (value && !strcasecmp(value, "input")) {
1125 auto_crlf = AUTO_CRLF_INPUT;
1128 auto_crlf = git_config_bool(var, value);
1132 if (!strcmp(var, "core.safecrlf")) {
1133 if (value && !strcasecmp(value, "warn")) {
1134 safe_crlf = SAFE_CRLF_WARN;
1137 safe_crlf = git_config_bool(var, value);
1141 if (!strcmp(var, "core.eol")) {
1142 if (value && !strcasecmp(value, "lf"))
1144 else if (value && !strcasecmp(value, "crlf"))
1145 core_eol = EOL_CRLF;
1146 else if (value && !strcasecmp(value, "native"))
1147 core_eol = EOL_NATIVE;
1149 core_eol = EOL_UNSET;
1153 if (!strcmp(var, "core.notesref")) {
1154 notes_ref_name = xstrdup(value);
1158 if (!strcmp(var, "core.editor"))
1159 return git_config_string(&editor_program, var, value);
1161 if (!strcmp(var, "core.commentchar")) {
1163 return config_error_nonbool(var);
1164 else if (!strcasecmp(value, "auto"))
1165 auto_comment_line_char = 1;
1166 else if (value[0] && !value[1]) {
1167 comment_line_char = value[0];
1168 auto_comment_line_char = 0;
1170 return error("core.commentChar should only be one character");
1174 if (!strcmp(var, "core.askpass"))
1175 return git_config_string(&askpass_program, var, value);
1177 if (!strcmp(var, "core.excludesfile"))
1178 return git_config_pathname(&excludes_file, var, value);
1180 if (!strcmp(var, "core.whitespace")) {
1182 return config_error_nonbool(var);
1183 whitespace_rule_cfg = parse_whitespace_rule(value);
1187 if (!strcmp(var, "core.fsyncobjectfiles")) {
1188 fsync_object_files = git_config_bool(var, value);
1192 if (!strcmp(var, "core.preloadindex")) {
1193 core_preload_index = git_config_bool(var, value);
1197 if (!strcmp(var, "core.createobject")) {
1198 if (!strcmp(value, "rename"))
1199 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1200 else if (!strcmp(value, "link"))
1201 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1203 die(_("invalid mode for object creation: %s"), value);
1207 if (!strcmp(var, "core.sparsecheckout")) {
1208 core_apply_sparse_checkout = git_config_bool(var, value);
1212 if (!strcmp(var, "core.precomposeunicode")) {
1213 precomposed_unicode = git_config_bool(var, value);
1217 if (!strcmp(var, "core.protecthfs")) {
1218 protect_hfs = git_config_bool(var, value);
1222 if (!strcmp(var, "core.protectntfs")) {
1223 protect_ntfs = git_config_bool(var, value);
1227 if (!strcmp(var, "core.hidedotfiles")) {
1228 if (value && !strcasecmp(value, "dotgitonly"))
1229 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1231 hide_dotfiles = git_config_bool(var, value);
1235 /* Add other config variables here and to Documentation/config.txt. */
1239 static int git_default_i18n_config(const char *var, const char *value)
1241 if (!strcmp(var, "i18n.commitencoding"))
1242 return git_config_string(&git_commit_encoding, var, value);
1244 if (!strcmp(var, "i18n.logoutputencoding"))
1245 return git_config_string(&git_log_output_encoding, var, value);
1247 /* Add other config variables here and to Documentation/config.txt. */
1251 static int git_default_branch_config(const char *var, const char *value)
1253 if (!strcmp(var, "branch.autosetupmerge")) {
1254 if (value && !strcasecmp(value, "always")) {
1255 git_branch_track = BRANCH_TRACK_ALWAYS;
1258 git_branch_track = git_config_bool(var, value);
1261 if (!strcmp(var, "branch.autosetuprebase")) {
1263 return config_error_nonbool(var);
1264 else if (!strcmp(value, "never"))
1265 autorebase = AUTOREBASE_NEVER;
1266 else if (!strcmp(value, "local"))
1267 autorebase = AUTOREBASE_LOCAL;
1268 else if (!strcmp(value, "remote"))
1269 autorebase = AUTOREBASE_REMOTE;
1270 else if (!strcmp(value, "always"))
1271 autorebase = AUTOREBASE_ALWAYS;
1273 return error("malformed value for %s", var);
1277 /* Add other config variables here and to Documentation/config.txt. */
1281 static int git_default_push_config(const char *var, const char *value)
1283 if (!strcmp(var, "push.default")) {
1285 return config_error_nonbool(var);
1286 else if (!strcmp(value, "nothing"))
1287 push_default = PUSH_DEFAULT_NOTHING;
1288 else if (!strcmp(value, "matching"))
1289 push_default = PUSH_DEFAULT_MATCHING;
1290 else if (!strcmp(value, "simple"))
1291 push_default = PUSH_DEFAULT_SIMPLE;
1292 else if (!strcmp(value, "upstream"))
1293 push_default = PUSH_DEFAULT_UPSTREAM;
1294 else if (!strcmp(value, "tracking")) /* deprecated */
1295 push_default = PUSH_DEFAULT_UPSTREAM;
1296 else if (!strcmp(value, "current"))
1297 push_default = PUSH_DEFAULT_CURRENT;
1299 error("malformed value for %s: %s", var, value);
1300 return error("Must be one of nothing, matching, simple, "
1301 "upstream or current.");
1306 /* Add other config variables here and to Documentation/config.txt. */
1310 static int git_default_mailmap_config(const char *var, const char *value)
1312 if (!strcmp(var, "mailmap.file"))
1313 return git_config_pathname(&git_mailmap_file, var, value);
1314 if (!strcmp(var, "mailmap.blob"))
1315 return git_config_string(&git_mailmap_blob, var, value);
1317 /* Add other config variables here and to Documentation/config.txt. */
1321 int git_default_config(const char *var, const char *value, void *dummy)
1323 if (starts_with(var, "core."))
1324 return git_default_core_config(var, value);
1326 if (starts_with(var, "user."))
1327 return git_ident_config(var, value, dummy);
1329 if (starts_with(var, "i18n."))
1330 return git_default_i18n_config(var, value);
1332 if (starts_with(var, "branch."))
1333 return git_default_branch_config(var, value);
1335 if (starts_with(var, "push."))
1336 return git_default_push_config(var, value);
1338 if (starts_with(var, "mailmap."))
1339 return git_default_mailmap_config(var, value);
1341 if (starts_with(var, "advice."))
1342 return git_default_advice_config(var, value);
1344 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1345 pager_use_color = git_config_bool(var,value);
1349 if (!strcmp(var, "pack.packsizelimit")) {
1350 pack_size_limit_cfg = git_config_ulong(var, value);
1354 if (!strcmp(var, "pack.compression")) {
1355 int level = git_config_int(var, value);
1357 level = Z_DEFAULT_COMPRESSION;
1358 else if (level < 0 || level > Z_BEST_COMPRESSION)
1359 die(_("bad pack compression level %d"), level);
1360 pack_compression_level = level;
1361 pack_compression_seen = 1;
1365 /* Add other config variables here and to Documentation/config.txt. */
1370 * All source specific fields in the union, die_on_error, name and the callbacks
1371 * fgetc, ungetc, ftell of top need to be initialized before calling
1374 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1378 /* push config-file parsing state stack */
1382 strbuf_init(&top->value, 1024);
1383 strbuf_init(&top->var, 1024);
1386 ret = git_parse_source(fn, data);
1388 /* pop config-file parsing state stack */
1389 strbuf_release(&top->value);
1390 strbuf_release(&top->var);
1396 static int do_config_from_file(config_fn_t fn,
1397 const enum config_origin_type origin_type,
1398 const char *name, const char *path, FILE *f,
1401 struct config_source top;
1404 top.origin_type = origin_type;
1407 top.die_on_error = 1;
1408 top.do_fgetc = config_file_fgetc;
1409 top.do_ungetc = config_file_ungetc;
1410 top.do_ftell = config_file_ftell;
1412 return do_config_from(&top, fn, data);
1415 static int git_config_from_stdin(config_fn_t fn, void *data)
1417 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1420 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1425 f = fopen(filename, "r");
1428 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1435 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1436 const char *name, const char *buf, size_t len, void *data)
1438 struct config_source top;
1440 top.u.buf.buf = buf;
1441 top.u.buf.len = len;
1443 top.origin_type = origin_type;
1446 top.die_on_error = 0;
1447 top.do_fgetc = config_buf_fgetc;
1448 top.do_ungetc = config_buf_ungetc;
1449 top.do_ftell = config_buf_ftell;
1451 return do_config_from(&top, fn, data);
1454 int git_config_from_blob_sha1(config_fn_t fn,
1456 const unsigned char *sha1,
1459 enum object_type type;
1464 buf = read_sha1_file(sha1, &type, &size);
1466 return error("unable to load config blob object '%s'", name);
1467 if (type != OBJ_BLOB) {
1469 return error("reference '%s' does not point to a blob", name);
1472 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1478 static int git_config_from_blob_ref(config_fn_t fn,
1482 unsigned char sha1[20];
1484 if (get_sha1(name, sha1) < 0)
1485 return error("unable to resolve config blob '%s'", name);
1486 return git_config_from_blob_sha1(fn, name, sha1, data);
1489 const char *git_etc_gitconfig(void)
1491 static const char *system_wide;
1493 system_wide = system_path(ETC_GITCONFIG);
1498 * Parse environment variable 'k' as a boolean (in various
1499 * possible spellings); if missing, use the default value 'def'.
1501 int git_env_bool(const char *k, int def)
1503 const char *v = getenv(k);
1504 return v ? git_config_bool(k, v) : def;
1508 * Parse environment variable 'k' as ulong with possibly a unit
1509 * suffix; if missing, use the default value 'val'.
1511 unsigned long git_env_ulong(const char *k, unsigned long val)
1513 const char *v = getenv(k);
1514 if (v && !git_parse_ulong(v, &val))
1515 die("failed to parse %s", k);
1519 int git_config_system(void)
1521 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1524 static int do_git_config_sequence(const struct config_options *opts,
1525 config_fn_t fn, void *data)
1528 char *xdg_config = xdg_config_home("config");
1529 char *user_config = expand_user_path("~/.gitconfig", 0);
1532 if (opts->commondir)
1533 repo_config = mkpathdup("%s/config", opts->commondir);
1537 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1538 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1539 ret += git_config_from_file(fn, git_etc_gitconfig(),
1542 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1543 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1544 ret += git_config_from_file(fn, xdg_config, data);
1546 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1547 ret += git_config_from_file(fn, user_config, data);
1549 current_parsing_scope = CONFIG_SCOPE_REPO;
1550 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1551 ret += git_config_from_file(fn, repo_config, data);
1553 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1554 if (git_config_from_parameters(fn, data) < 0)
1555 die(_("unable to parse command-line config"));
1557 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1564 int config_with_options(config_fn_t fn, void *data,
1565 struct git_config_source *config_source,
1566 const struct config_options *opts)
1568 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1570 if (opts->respect_includes) {
1574 fn = git_config_include;
1579 * If we have a specific filename, use it. Otherwise, follow the
1580 * regular lookup sequence.
1582 if (config_source && config_source->use_stdin)
1583 return git_config_from_stdin(fn, data);
1584 else if (config_source && config_source->file)
1585 return git_config_from_file(fn, config_source->file, data);
1586 else if (config_source && config_source->blob)
1587 return git_config_from_blob_ref(fn, config_source->blob, data);
1589 return do_git_config_sequence(opts, fn, data);
1592 static void git_config_raw(config_fn_t fn, void *data)
1594 struct config_options opts = {0};
1596 opts.respect_includes = 1;
1597 if (have_git_dir()) {
1598 opts.commondir = get_git_common_dir();
1599 opts.git_dir = get_git_dir();
1602 if (config_with_options(fn, data, NULL, &opts) < 0)
1604 * config_with_options() normally returns only
1605 * zero, as most errors are fatal, and
1606 * non-fatal potential errors are guarded by "if"
1607 * statements that are entered only when no error is
1610 * If we ever encounter a non-fatal error, it means
1611 * something went really wrong and we should stop
1614 die(_("unknown error occurred while reading the configuration files"));
1617 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1620 struct string_list *values;
1621 struct config_set_element *entry;
1622 struct configset_list *list = &cs->list;
1624 for (i = 0; i < list->nr; i++) {
1625 entry = list->items[i].e;
1626 value_index = list->items[i].value_index;
1627 values = &entry->value_list;
1629 current_config_kvi = values->items[value_index].util;
1631 if (fn(entry->key, values->items[value_index].string, data) < 0)
1632 git_die_config_linenr(entry->key,
1633 current_config_kvi->filename,
1634 current_config_kvi->linenr);
1636 current_config_kvi = NULL;
1640 void read_early_config(config_fn_t cb, void *data)
1642 struct config_options opts = {0};
1643 struct strbuf commondir = STRBUF_INIT;
1644 struct strbuf gitdir = STRBUF_INIT;
1646 opts.respect_includes = 1;
1648 if (have_git_dir()) {
1649 opts.commondir = get_git_common_dir();
1650 opts.git_dir = get_git_dir();
1652 * When setup_git_directory() was not yet asked to discover the
1653 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1654 * is any repository config we should use (but unlike
1655 * setup_git_directory_gently(), no global state is changed, most
1656 * notably, the current working directory is still the same after the
1659 } else if (!discover_git_directory(&commondir, &gitdir)) {
1660 opts.commondir = commondir.buf;
1661 opts.git_dir = gitdir.buf;
1664 config_with_options(cb, data, NULL, &opts);
1666 strbuf_release(&commondir);
1667 strbuf_release(&gitdir);
1670 static void git_config_check_init(void);
1672 void git_config(config_fn_t fn, void *data)
1674 git_config_check_init();
1675 configset_iter(&the_config_set, fn, data);
1678 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1680 struct config_set_element k;
1681 struct config_set_element *found_entry;
1682 char *normalized_key;
1684 * `key` may come from the user, so normalize it before using it
1685 * for querying entries from the hashmap.
1687 if (git_config_parse_key(key, &normalized_key, NULL))
1690 hashmap_entry_init(&k, strhash(normalized_key));
1691 k.key = normalized_key;
1692 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1693 free(normalized_key);
1697 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1699 struct config_set_element *e;
1700 struct string_list_item *si;
1701 struct configset_list_item *l_item;
1702 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1704 e = configset_find_element(cs, key);
1706 * Since the keys are being fed by git_config*() callback mechanism, they
1707 * are already normalized. So simply add them without any further munging.
1710 e = xmalloc(sizeof(*e));
1711 hashmap_entry_init(e, strhash(key));
1712 e->key = xstrdup(key);
1713 string_list_init(&e->value_list, 1);
1714 hashmap_add(&cs->config_hash, e);
1716 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1718 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1719 l_item = &cs->list.items[cs->list.nr++];
1721 l_item->value_index = e->value_list.nr - 1;
1724 die("BUG: configset_add_value has no source");
1726 kv_info->filename = strintern(cf->name);
1727 kv_info->linenr = cf->linenr;
1728 kv_info->origin_type = cf->origin_type;
1730 /* for values read from `git_config_from_parameters()` */
1731 kv_info->filename = NULL;
1732 kv_info->linenr = -1;
1733 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1735 kv_info->scope = current_parsing_scope;
1741 static int config_set_element_cmp(const struct config_set_element *e1,
1742 const struct config_set_element *e2, const void *unused)
1744 return strcmp(e1->key, e2->key);
1747 void git_configset_init(struct config_set *cs)
1749 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1750 cs->hash_initialized = 1;
1753 cs->list.items = NULL;
1756 void git_configset_clear(struct config_set *cs)
1758 struct config_set_element *entry;
1759 struct hashmap_iter iter;
1760 if (!cs->hash_initialized)
1763 hashmap_iter_init(&cs->config_hash, &iter);
1764 while ((entry = hashmap_iter_next(&iter))) {
1766 string_list_clear(&entry->value_list, 1);
1768 hashmap_free(&cs->config_hash, 1);
1769 cs->hash_initialized = 0;
1770 free(cs->list.items);
1773 cs->list.items = NULL;
1776 static int config_set_callback(const char *key, const char *value, void *cb)
1778 struct config_set *cs = cb;
1779 configset_add_value(cs, key, value);
1783 int git_configset_add_file(struct config_set *cs, const char *filename)
1785 return git_config_from_file(config_set_callback, filename, cs);
1788 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1790 const struct string_list *values = NULL;
1792 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1793 * queried key in the files of the configset, the value returned will be the last
1794 * value in the value list for that key.
1796 values = git_configset_get_value_multi(cs, key);
1800 assert(values->nr > 0);
1801 *value = values->items[values->nr - 1].string;
1805 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1807 struct config_set_element *e = configset_find_element(cs, key);
1808 return e ? &e->value_list : NULL;
1811 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1814 if (!git_configset_get_value(cs, key, &value))
1815 return git_config_string(dest, key, value);
1820 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1822 return git_configset_get_string_const(cs, key, (const char **)dest);
1825 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1828 if (!git_configset_get_value(cs, key, &value)) {
1829 *dest = git_config_int(key, value);
1835 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1838 if (!git_configset_get_value(cs, key, &value)) {
1839 *dest = git_config_ulong(key, value);
1845 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1848 if (!git_configset_get_value(cs, key, &value)) {
1849 *dest = git_config_bool(key, value);
1855 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1856 int *is_bool, int *dest)
1859 if (!git_configset_get_value(cs, key, &value)) {
1860 *dest = git_config_bool_or_int(key, value, is_bool);
1866 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1869 if (!git_configset_get_value(cs, key, &value)) {
1870 *dest = git_config_maybe_bool(key, value);
1878 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1881 if (!git_configset_get_value(cs, key, &value))
1882 return git_config_pathname(dest, key, value);
1887 static void git_config_check_init(void)
1889 if (the_config_set.hash_initialized)
1891 git_configset_init(&the_config_set);
1892 git_config_raw(config_set_callback, &the_config_set);
1895 void git_config_clear(void)
1897 if (!the_config_set.hash_initialized)
1899 git_configset_clear(&the_config_set);
1902 int git_config_get_value(const char *key, const char **value)
1904 git_config_check_init();
1905 return git_configset_get_value(&the_config_set, key, value);
1908 const struct string_list *git_config_get_value_multi(const char *key)
1910 git_config_check_init();
1911 return git_configset_get_value_multi(&the_config_set, key);
1914 int git_config_get_string_const(const char *key, const char **dest)
1917 git_config_check_init();
1918 ret = git_configset_get_string_const(&the_config_set, key, dest);
1920 git_die_config(key, NULL);
1924 int git_config_get_string(const char *key, char **dest)
1926 git_config_check_init();
1927 return git_config_get_string_const(key, (const char **)dest);
1930 int git_config_get_int(const char *key, int *dest)
1932 git_config_check_init();
1933 return git_configset_get_int(&the_config_set, key, dest);
1936 int git_config_get_ulong(const char *key, unsigned long *dest)
1938 git_config_check_init();
1939 return git_configset_get_ulong(&the_config_set, key, dest);
1942 int git_config_get_bool(const char *key, int *dest)
1944 git_config_check_init();
1945 return git_configset_get_bool(&the_config_set, key, dest);
1948 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1950 git_config_check_init();
1951 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1954 int git_config_get_maybe_bool(const char *key, int *dest)
1956 git_config_check_init();
1957 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1960 int git_config_get_pathname(const char *key, const char **dest)
1963 git_config_check_init();
1964 ret = git_configset_get_pathname(&the_config_set, key, dest);
1966 git_die_config(key, NULL);
1970 int git_config_get_expiry(const char *key, const char **output)
1972 int ret = git_config_get_string_const(key, output);
1975 if (strcmp(*output, "now")) {
1976 unsigned long now = approxidate("now");
1977 if (approxidate(*output) >= now)
1978 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
1983 int git_config_get_untracked_cache(void)
1988 /* Hack for test programs like test-dump-untracked-cache */
1989 if (ignore_untracked_cache_config)
1992 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
1995 if (!git_config_get_value("core.untrackedcache", &v)) {
1996 if (!strcasecmp(v, "keep"))
1999 error(_("unknown core.untrackedCache value '%s'; "
2000 "using 'keep' default value"), v);
2004 return -1; /* default value */
2007 int git_config_get_split_index(void)
2011 if (!git_config_get_maybe_bool("core.splitindex", &val))
2014 return -1; /* default value */
2017 int git_config_get_max_percent_split_change(void)
2021 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2022 if (0 <= val && val <= 100)
2025 return error(_("splitIndex.maxPercentChange value '%d' "
2026 "should be between 0 and 100"), val);
2029 return -1; /* default value */
2033 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2036 die(_("unable to parse '%s' from command-line config"), key);
2038 die(_("bad config variable '%s' in file '%s' at line %d"),
2039 key, filename, linenr);
2042 NORETURN __attribute__((format(printf, 2, 3)))
2043 void git_die_config(const char *key, const char *err, ...)
2045 const struct string_list *values;
2046 struct key_value_info *kv_info;
2050 va_start(params, err);
2051 vreportf("error: ", err, params);
2054 values = git_config_get_value_multi(key);
2055 kv_info = values->items[values->nr - 1].util;
2056 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2060 * Find all the stuff for git_config_set() below.
2067 regex_t *value_regex;
2070 unsigned int offset_alloc;
2071 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2075 static int matches(const char *key, const char *value)
2077 if (strcmp(key, store.key))
2078 return 0; /* not ours */
2079 if (!store.value_regex)
2080 return 1; /* always matches */
2081 if (store.value_regex == CONFIG_REGEX_NONE)
2082 return 0; /* never matches */
2084 return store.do_not_match ^
2085 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2088 static int store_aux(const char *key, const char *value, void *cb)
2093 switch (store.state) {
2095 if (matches(key, value)) {
2096 if (store.seen == 1 && store.multi_replace == 0) {
2097 warning(_("%s has multiple values"), key);
2100 ALLOC_GROW(store.offset, store.seen + 1,
2101 store.offset_alloc);
2103 store.offset[store.seen] = cf->do_ftell(cf);
2109 * What we are looking for is in store.key (both
2110 * section and var), and its section part is baselen
2111 * long. We found key (again, both section and var).
2112 * We would want to know if this key is in the same
2113 * section as what we are looking for. We already
2114 * know we are in the same section as what should
2117 ep = strrchr(key, '.');
2118 section_len = ep - key;
2120 if ((section_len != store.baselen) ||
2121 memcmp(key, store.key, section_len+1)) {
2122 store.state = SECTION_END_SEEN;
2127 * Do not increment matches: this is no match, but we
2128 * just made sure we are in the desired section.
2130 ALLOC_GROW(store.offset, store.seen + 1,
2131 store.offset_alloc);
2132 store.offset[store.seen] = cf->do_ftell(cf);
2134 case SECTION_END_SEEN:
2136 if (matches(key, value)) {
2137 ALLOC_GROW(store.offset, store.seen + 1,
2138 store.offset_alloc);
2139 store.offset[store.seen] = cf->do_ftell(cf);
2140 store.state = KEY_SEEN;
2143 if (strrchr(key, '.') - key == store.baselen &&
2144 !strncmp(key, store.key, store.baselen)) {
2145 store.state = SECTION_SEEN;
2146 ALLOC_GROW(store.offset,
2148 store.offset_alloc);
2149 store.offset[store.seen] = cf->do_ftell(cf);
2156 static int write_error(const char *filename)
2158 error("failed to write new configuration file %s", filename);
2160 /* Same error code as "failed to rename". */
2164 static int store_write_section(int fd, const char *key)
2168 struct strbuf sb = STRBUF_INIT;
2170 dot = memchr(key, '.', store.baselen);
2172 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2173 for (i = dot - key + 1; i < store.baselen; i++) {
2174 if (key[i] == '"' || key[i] == '\\')
2175 strbuf_addch(&sb, '\\');
2176 strbuf_addch(&sb, key[i]);
2178 strbuf_addstr(&sb, "\"]\n");
2180 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2183 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2184 strbuf_release(&sb);
2189 static int store_write_pair(int fd, const char *key, const char *value)
2192 int length = strlen(key + store.baselen + 1);
2193 const char *quote = "";
2194 struct strbuf sb = STRBUF_INIT;
2197 * Check to see if the value needs to be surrounded with a dq pair.
2198 * Note that problematic characters are always backslash-quoted; this
2199 * check is about not losing leading or trailing SP and strings that
2200 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2201 * configuration parser.
2203 if (value[0] == ' ')
2205 for (i = 0; value[i]; i++)
2206 if (value[i] == ';' || value[i] == '#')
2208 if (i && value[i - 1] == ' ')
2211 strbuf_addf(&sb, "\t%.*s = %s",
2212 length, key + store.baselen + 1, quote);
2214 for (i = 0; value[i]; i++)
2217 strbuf_addstr(&sb, "\\n");
2220 strbuf_addstr(&sb, "\\t");
2224 strbuf_addch(&sb, '\\');
2226 strbuf_addch(&sb, value[i]);
2229 strbuf_addf(&sb, "%s\n", quote);
2231 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2232 strbuf_release(&sb);
2237 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2238 size_t offset_, int *found_bracket)
2240 size_t equal_offset = size, bracket_offset = size;
2244 for (offset = offset_-2; offset > 0
2245 && contents[offset] != '\n'; offset--)
2246 switch (contents[offset]) {
2247 case '=': equal_offset = offset; break;
2248 case ']': bracket_offset = offset; break;
2250 if (offset > 0 && contents[offset-1] == '\\') {
2254 if (bracket_offset < equal_offset) {
2256 offset = bracket_offset+1;
2263 int git_config_set_in_file_gently(const char *config_filename,
2264 const char *key, const char *value)
2266 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2269 void git_config_set_in_file(const char *config_filename,
2270 const char *key, const char *value)
2272 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2275 int git_config_set_gently(const char *key, const char *value)
2277 return git_config_set_multivar_gently(key, value, NULL, 0);
2280 void git_config_set(const char *key, const char *value)
2282 git_config_set_multivar(key, value, NULL, 0);
2286 * If value==NULL, unset in (remove from) config,
2287 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2288 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2289 * (only add a new one)
2290 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2291 * else all matching key/values (regardless how many) are removed,
2292 * before the new pair is written.
2294 * Returns 0 on success.
2296 * This function does this:
2298 * - it locks the config file by creating ".git/config.lock"
2300 * - it then parses the config using store_aux() as validator to find
2301 * the position on the key/value pair to replace. If it is to be unset,
2302 * it must be found exactly once.
2304 * - the config file is mmap()ed and the part before the match (if any) is
2305 * written to the lock file, then the changed part and the rest.
2307 * - the config file is removed and the lock file rename()d to it.
2310 int git_config_set_multivar_in_file_gently(const char *config_filename,
2311 const char *key, const char *value,
2312 const char *value_regex,
2315 int fd = -1, in_fd = -1;
2317 struct lock_file *lock = NULL;
2318 char *filename_buf = NULL;
2319 char *contents = NULL;
2322 /* parse-key returns negative; flip the sign to feed exit(3) */
2323 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2327 store.multi_replace = multi_replace;
2329 if (!config_filename)
2330 config_filename = filename_buf = git_pathdup("config");
2333 * The lock serves a purpose in addition to locking: the new
2334 * contents of .git/config will be written into it.
2336 lock = xcalloc(1, sizeof(struct lock_file));
2337 fd = hold_lock_file_for_update(lock, config_filename, 0);
2339 error_errno("could not lock config file %s", config_filename);
2341 ret = CONFIG_NO_LOCK;
2346 * If .git/config does not exist yet, write a minimal version.
2348 in_fd = open(config_filename, O_RDONLY);
2352 if ( ENOENT != errno ) {
2353 error_errno("opening %s", config_filename);
2354 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2357 /* if nothing to unset, error out */
2358 if (value == NULL) {
2359 ret = CONFIG_NOTHING_SET;
2363 store.key = (char *)key;
2364 if (!store_write_section(fd, key) ||
2365 !store_write_pair(fd, key, value))
2369 size_t copy_begin, copy_end;
2370 int i, new_line = 0;
2372 if (value_regex == NULL)
2373 store.value_regex = NULL;
2374 else if (value_regex == CONFIG_REGEX_NONE)
2375 store.value_regex = CONFIG_REGEX_NONE;
2377 if (value_regex[0] == '!') {
2378 store.do_not_match = 1;
2381 store.do_not_match = 0;
2383 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2384 if (regcomp(store.value_regex, value_regex,
2386 error("invalid pattern: %s", value_regex);
2387 free(store.value_regex);
2388 ret = CONFIG_INVALID_PATTERN;
2393 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2394 store.offset[0] = 0;
2395 store.state = START;
2399 * After this, store.offset will contain the *end* offset
2400 * of the last match, or remain at 0 if no match was found.
2401 * As a side effect, we make sure to transform only a valid
2402 * existing config file.
2404 if (git_config_from_file(store_aux, config_filename, NULL)) {
2405 error("invalid config file %s", config_filename);
2407 if (store.value_regex != NULL &&
2408 store.value_regex != CONFIG_REGEX_NONE) {
2409 regfree(store.value_regex);
2410 free(store.value_regex);
2412 ret = CONFIG_INVALID_FILE;
2417 if (store.value_regex != NULL &&
2418 store.value_regex != CONFIG_REGEX_NONE) {
2419 regfree(store.value_regex);
2420 free(store.value_regex);
2423 /* if nothing to unset, or too many matches, error out */
2424 if ((store.seen == 0 && value == NULL) ||
2425 (store.seen > 1 && multi_replace == 0)) {
2426 ret = CONFIG_NOTHING_SET;
2430 if (fstat(in_fd, &st) == -1) {
2431 error_errno(_("fstat on %s failed"), config_filename);
2432 ret = CONFIG_INVALID_FILE;
2436 contents_sz = xsize_t(st.st_size);
2437 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2438 MAP_PRIVATE, in_fd, 0);
2439 if (contents == MAP_FAILED) {
2440 if (errno == ENODEV && S_ISDIR(st.st_mode))
2442 error_errno("unable to mmap '%s'", config_filename);
2443 ret = CONFIG_INVALID_FILE;
2450 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2451 error_errno("chmod on %s failed", get_lock_file_path(lock));
2452 ret = CONFIG_NO_WRITE;
2456 if (store.seen == 0)
2459 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2460 if (store.offset[i] == 0) {
2461 store.offset[i] = copy_end = contents_sz;
2462 } else if (store.state != KEY_SEEN) {
2463 copy_end = store.offset[i];
2465 copy_end = find_beginning_of_line(
2466 contents, contents_sz,
2467 store.offset[i]-2, &new_line);
2469 if (copy_end > 0 && contents[copy_end-1] != '\n')
2472 /* write the first part of the config */
2473 if (copy_end > copy_begin) {
2474 if (write_in_full(fd, contents + copy_begin,
2475 copy_end - copy_begin) <
2476 copy_end - copy_begin)
2479 write_str_in_full(fd, "\n") != 1)
2482 copy_begin = store.offset[i];
2485 /* write the pair (value == NULL means unset) */
2486 if (value != NULL) {
2487 if (store.state == START) {
2488 if (!store_write_section(fd, key))
2491 if (!store_write_pair(fd, key, value))
2495 /* write the rest of the config */
2496 if (copy_begin < contents_sz)
2497 if (write_in_full(fd, contents + copy_begin,
2498 contents_sz - copy_begin) <
2499 contents_sz - copy_begin)
2502 munmap(contents, contents_sz);
2506 if (commit_lock_file(lock) < 0) {
2507 error_errno("could not write config file %s", config_filename);
2508 ret = CONFIG_NO_WRITE;
2514 * lock is committed, so don't try to roll it back below.
2515 * NOTE: Since lockfile.c keeps a linked list of all created
2516 * lock_file structures, it isn't safe to free(lock). It's
2517 * better to just leave it hanging around.
2522 /* Invalidate the config cache */
2527 rollback_lock_file(lock);
2530 munmap(contents, contents_sz);
2536 ret = write_error(get_lock_file_path(lock));
2541 void git_config_set_multivar_in_file(const char *config_filename,
2542 const char *key, const char *value,
2543 const char *value_regex, int multi_replace)
2545 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2546 value_regex, multi_replace))
2549 die(_("could not set '%s' to '%s'"), key, value);
2551 die(_("could not unset '%s'"), key);
2554 int git_config_set_multivar_gently(const char *key, const char *value,
2555 const char *value_regex, int multi_replace)
2557 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2561 void git_config_set_multivar(const char *key, const char *value,
2562 const char *value_regex, int multi_replace)
2564 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2568 static int section_name_match (const char *buf, const char *name)
2570 int i = 0, j = 0, dot = 0;
2573 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2574 if (!dot && isspace(buf[i])) {
2576 if (name[j++] != '.')
2578 for (i++; isspace(buf[i]); i++)
2584 if (buf[i] == '\\' && dot)
2586 else if (buf[i] == '"' && dot) {
2587 for (i++; isspace(buf[i]); i++)
2591 if (buf[i] != name[j++])
2594 if (buf[i] == ']' && name[j] == 0) {
2596 * We match, now just find the right length offset by
2597 * gobbling up any whitespace after it, as well
2600 for (; buf[i] && isspace(buf[i]); i++)
2607 static int section_name_is_ok(const char *name)
2609 /* Empty section names are bogus. */
2614 * Before a dot, we must be alphanumeric or dash. After the first dot,
2615 * anything goes, so we can stop checking.
2617 for (; *name && *name != '.'; name++)
2618 if (*name != '-' && !isalnum(*name))
2623 /* if new_name == NULL, the section is removed instead */
2624 int git_config_rename_section_in_file(const char *config_filename,
2625 const char *old_name, const char *new_name)
2627 int ret = 0, remove = 0;
2628 char *filename_buf = NULL;
2629 struct lock_file *lock;
2635 if (new_name && !section_name_is_ok(new_name)) {
2636 ret = error("invalid section name: %s", new_name);
2637 goto out_no_rollback;
2640 if (!config_filename)
2641 config_filename = filename_buf = git_pathdup("config");
2643 lock = xcalloc(1, sizeof(struct lock_file));
2644 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2646 ret = error("could not lock config file %s", config_filename);
2650 if (!(config_file = fopen(config_filename, "rb"))) {
2651 /* no config file means nothing to rename, no error */
2652 goto commit_and_out;
2655 if (fstat(fileno(config_file), &st) == -1) {
2656 ret = error_errno(_("fstat on %s failed"), config_filename);
2660 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2661 ret = error_errno("chmod on %s failed",
2662 get_lock_file_path(lock));
2666 while (fgets(buf, sizeof(buf), config_file)) {
2670 for (i = 0; buf[i] && isspace(buf[i]); i++)
2672 if (buf[i] == '[') {
2673 /* it's a section */
2674 int offset = section_name_match(&buf[i], old_name);
2677 if (new_name == NULL) {
2681 store.baselen = strlen(new_name);
2682 if (!store_write_section(out_fd, new_name)) {
2683 ret = write_error(get_lock_file_path(lock));
2687 * We wrote out the new section, with
2688 * a newline, now skip the old
2691 output += offset + i;
2692 if (strlen(output) > 0) {
2694 * More content means there's
2695 * a declaration to put on the
2696 * next line; indent with a
2707 length = strlen(output);
2708 if (write_in_full(out_fd, output, length) != length) {
2709 ret = write_error(get_lock_file_path(lock));
2713 fclose(config_file);
2715 if (commit_lock_file(lock) < 0)
2716 ret = error_errno("could not write config file %s",
2719 rollback_lock_file(lock);
2725 int git_config_rename_section(const char *old_name, const char *new_name)
2727 return git_config_rename_section_in_file(NULL, old_name, new_name);
2731 * Call this to report error for your variable that should not
2732 * get a boolean value (i.e. "[my] var" means "true").
2734 #undef config_error_nonbool
2735 int config_error_nonbool(const char *var)
2737 return error("missing value for '%s'", var);
2740 int parse_config_key(const char *var,
2741 const char *section,
2742 const char **subsection, int *subsection_len,
2747 /* Does it start with "section." ? */
2748 if (!skip_prefix(var, section, &var) || *var != '.')
2752 * Find the key; we don't know yet if we have a subsection, but we must
2753 * parse backwards from the end, since the subsection may have dots in
2756 dot = strrchr(var, '.');
2759 /* Did we have a subsection at all? */
2763 *subsection_len = 0;
2769 *subsection = var + 1;
2770 *subsection_len = dot - *subsection;
2776 const char *current_config_origin_type(void)
2779 if (current_config_kvi)
2780 type = current_config_kvi->origin_type;
2782 type = cf->origin_type;
2784 die("BUG: current_config_origin_type called outside config callback");
2787 case CONFIG_ORIGIN_BLOB:
2789 case CONFIG_ORIGIN_FILE:
2791 case CONFIG_ORIGIN_STDIN:
2792 return "standard input";
2793 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2794 return "submodule-blob";
2795 case CONFIG_ORIGIN_CMDLINE:
2796 return "command line";
2798 die("BUG: unknown config origin type");
2802 const char *current_config_name(void)
2805 if (current_config_kvi)
2806 name = current_config_kvi->filename;
2810 die("BUG: current_config_name called outside config callback");
2811 return name ? name : "";
2814 enum config_scope current_config_scope(void)
2816 if (current_config_kvi)
2817 return current_config_kvi->scope;
2819 return current_parsing_scope;