2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
14 #include "string-list.h"
18 struct config_source {
19 struct config_source *prev;
28 enum config_origin_type origin_type;
37 int (*do_fgetc)(struct config_source *c);
38 int (*do_ungetc)(int c, struct config_source *conf);
39 long (*do_ftell)(struct config_source *c);
43 * These variables record the "current" config source, which
44 * can be accessed by parsing callbacks.
46 * The "cf" variable will be non-NULL only when we are actually parsing a real
47 * config source (file, blob, cmdline, etc).
49 * The "current_config_kvi" variable will be non-NULL only when we are feeding
50 * cached config from a configset into a callback.
52 * They should generally never be non-NULL at the same time. If they are both
53 * NULL, then we aren't parsing anything (and depending on the function looking
54 * at the variables, it's either a bug for it to be called in the first place,
55 * or it's a function which can be reused for non-config purposes, and should
56 * fall back to some sane behavior).
58 static struct config_source *cf;
59 static struct key_value_info *current_config_kvi;
62 * Similar to the variables above, this gives access to the "scope" of the
63 * current value (repo, global, etc). For cached values, it can be found via
64 * the current_config_kvi as above. During parsing, the current value can be
65 * found in this variable. It's not part of "cf" because it transcends a single
66 * file (i.e., a file included from .git/config is still in "repo" scope).
68 static enum config_scope current_parsing_scope;
70 static int core_compression_seen;
71 static int pack_compression_seen;
72 static int zlib_compression_seen;
75 * Default config_set that contains key-value pairs from the usual set of config
76 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
77 * config file and the global /etc/gitconfig)
79 static struct config_set the_config_set;
81 static int config_file_fgetc(struct config_source *conf)
83 return getc_unlocked(conf->u.file);
86 static int config_file_ungetc(int c, struct config_source *conf)
88 return ungetc(c, conf->u.file);
91 static long config_file_ftell(struct config_source *conf)
93 return ftell(conf->u.file);
97 static int config_buf_fgetc(struct config_source *conf)
99 if (conf->u.buf.pos < conf->u.buf.len)
100 return conf->u.buf.buf[conf->u.buf.pos++];
105 static int config_buf_ungetc(int c, struct config_source *conf)
107 if (conf->u.buf.pos > 0) {
109 if (conf->u.buf.buf[conf->u.buf.pos] != c)
110 die("BUG: config_buf can only ungetc the same character");
117 static long config_buf_ftell(struct config_source *conf)
119 return conf->u.buf.pos;
122 #define MAX_INCLUDE_DEPTH 10
123 static const char include_depth_advice[] =
124 "exceeded maximum include depth (%d) while including\n"
128 "Do you have circular includes?";
129 static int handle_path_include(const char *path, struct config_include_data *inc)
132 struct strbuf buf = STRBUF_INIT;
136 return config_error_nonbool("include.path");
138 expanded = expand_user_path(path);
140 return error("could not expand include path '%s'", path);
144 * Use an absolute path as-is, but interpret relative paths
145 * based on the including config file.
147 if (!is_absolute_path(path)) {
150 if (!cf || !cf->path)
151 return error("relative config includes must come from files");
153 slash = find_last_dir_sep(cf->path);
155 strbuf_add(&buf, cf->path, slash - cf->path + 1);
156 strbuf_addstr(&buf, path);
160 if (!access_or_die(path, R_OK, 0)) {
161 if (++inc->depth > MAX_INCLUDE_DEPTH)
162 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
164 cf->name ? cf->name :
166 ret = git_config_from_file(git_config_include, path, inc);
169 strbuf_release(&buf);
174 static int prepare_include_condition_pattern(struct strbuf *pat)
176 struct strbuf path = STRBUF_INIT;
180 expanded = expand_user_path(pat->buf);
183 strbuf_addstr(pat, expanded);
187 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
190 if (!cf || !cf->path)
191 return error(_("relative config include "
192 "conditionals must come from files"));
194 strbuf_add_absolute_path(&path, cf->path);
195 slash = find_last_dir_sep(path.buf);
197 die("BUG: how is this possible?");
198 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
199 prefix = slash - path.buf + 1 /* slash */;
200 } else if (!is_absolute_path(pat->buf))
201 strbuf_insert(pat, 0, "**/", 3);
203 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
204 strbuf_addstr(pat, "**");
206 strbuf_release(&path);
210 static int include_by_gitdir(const char *cond, size_t cond_len, int icase)
212 struct strbuf text = STRBUF_INIT;
213 struct strbuf pattern = STRBUF_INIT;
216 strbuf_add_absolute_path(&text, get_git_dir());
217 strbuf_add(&pattern, cond, cond_len);
218 prefix = prepare_include_condition_pattern(&pattern);
225 * perform literal matching on the prefix part so that
226 * any wildcard character in it can't create side effects.
228 if (text.len < prefix)
230 if (!icase && strncmp(pattern.buf, text.buf, prefix))
232 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
236 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
237 icase ? WM_CASEFOLD : 0, NULL);
240 strbuf_release(&pattern);
241 strbuf_release(&text);
245 static int include_condition_is_true(const char *cond, size_t cond_len)
248 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
249 return include_by_gitdir(cond, cond_len, 0);
250 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
251 return include_by_gitdir(cond, cond_len, 1);
253 /* unknown conditionals are always false */
257 int git_config_include(const char *var, const char *value, void *data)
259 struct config_include_data *inc = data;
260 const char *cond, *key;
265 * Pass along all values, including "include" directives; this makes it
266 * possible to query information on the includes themselves.
268 ret = inc->fn(var, value, inc->data);
272 if (!strcmp(var, "include.path"))
273 ret = handle_path_include(value, inc);
275 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
276 (cond && include_condition_is_true(cond, cond_len)) &&
277 !strcmp(key, "path"))
278 ret = handle_path_include(value, inc);
283 void git_config_push_parameter(const char *text)
285 struct strbuf env = STRBUF_INIT;
286 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
288 strbuf_addstr(&env, old);
289 strbuf_addch(&env, ' ');
291 sq_quote_buf(&env, text);
292 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
293 strbuf_release(&env);
296 static inline int iskeychar(int c)
298 return isalnum(c) || c == '-';
302 * Auxiliary function to sanity-check and split the key into the section
303 * identifier and variable name.
305 * Returns 0 on success, -1 when there is an invalid character in the key and
306 * -2 if there is no section name in the key.
308 * store_key - pointer to char* which will hold a copy of the key with
309 * lowercase section and variable name
310 * baselen - pointer to int which will hold the length of the
311 * section + subsection part, can be NULL
313 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
316 const char *last_dot = strrchr(key, '.');
319 * Since "key" actually contains the section name and the real
320 * key name separated by a dot, we have to know where the dot is.
323 if (last_dot == NULL || last_dot == key) {
325 error("key does not contain a section: %s", key);
326 return -CONFIG_NO_SECTION_OR_NAME;
331 error("key does not contain variable name: %s", key);
332 return -CONFIG_NO_SECTION_OR_NAME;
335 baselen = last_dot - key;
340 * Validate the key and while at it, lower case it for matching.
343 *store_key = xmallocz(strlen(key));
346 for (i = 0; key[i]; i++) {
347 unsigned char c = key[i];
350 /* Leave the extended basename untouched.. */
351 if (!dot || i > baselen) {
353 (i == baselen + 1 && !isalpha(c))) {
355 error("invalid key: %s", key);
359 } else if (c == '\n') {
361 error("invalid key (newline): %s", key);
375 return -CONFIG_INVALID_KEY;
378 int git_config_parse_key(const char *key, char **store_key, int *baselen)
380 return git_config_parse_key_1(key, store_key, baselen, 0);
383 int git_config_key_is_valid(const char *key)
385 return !git_config_parse_key_1(key, NULL, NULL, 1);
388 int git_config_parse_parameter(const char *text,
389 config_fn_t fn, void *data)
392 char *canonical_name;
393 struct strbuf **pair;
396 pair = strbuf_split_str(text, '=', 2);
398 return error("bogus config parameter: %s", text);
400 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
401 strbuf_setlen(pair[0], pair[0]->len - 1);
402 value = pair[1] ? pair[1]->buf : "";
407 strbuf_trim(pair[0]);
409 strbuf_list_free(pair);
410 return error("bogus config parameter: %s", text);
413 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
416 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
417 free(canonical_name);
419 strbuf_list_free(pair);
423 int git_config_from_parameters(config_fn_t fn, void *data)
425 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
428 const char **argv = NULL;
429 int nr = 0, alloc = 0;
431 struct config_source source;
436 memset(&source, 0, sizeof(source));
438 source.origin_type = CONFIG_ORIGIN_CMDLINE;
441 /* sq_dequote will write over it */
444 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
445 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
449 for (i = 0; i < nr; i++) {
450 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
463 static int get_next_char(void)
465 int c = cf->do_fgetc(cf);
468 /* DOS like systems */
469 c = cf->do_fgetc(cf);
472 cf->do_ungetc(c, cf);
486 static char *parse_value(void)
488 int quote = 0, comment = 0, space = 0;
490 strbuf_reset(&cf->value);
492 int c = get_next_char();
498 return cf->value.buf;
502 if (isspace(c) && !quote) {
508 if (c == ';' || c == '#') {
513 for (; space; space--)
514 strbuf_addch(&cf->value, ' ');
529 /* Some characters escape as themselves */
532 /* Reject unknown escape sequences */
536 strbuf_addch(&cf->value, c);
543 strbuf_addch(&cf->value, c);
547 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
553 /* Get the full name */
560 strbuf_addch(name, tolower(c));
563 while (c == ' ' || c == '\t')
570 value = parse_value();
575 * We already consumed the \n, but we need linenr to point to
576 * the line we just parsed during the call to fn to get
577 * accurate line number in error messages.
580 ret = fn(name->buf, value, data);
585 static int get_extended_base_var(struct strbuf *name, int c)
589 goto error_incomplete_line;
591 } while (isspace(c));
593 /* We require the format to be '[base "extension"]' */
596 strbuf_addch(name, '.');
599 int c = get_next_char();
601 goto error_incomplete_line;
607 goto error_incomplete_line;
609 strbuf_addch(name, c);
613 if (get_next_char() != ']')
616 error_incomplete_line:
621 static int get_base_var(struct strbuf *name)
624 int c = get_next_char();
630 return get_extended_base_var(name, c);
631 if (!iskeychar(c) && c != '.')
633 strbuf_addch(name, tolower(c));
637 static int git_parse_source(config_fn_t fn, void *data)
641 struct strbuf *var = &cf->var;
642 int error_return = 0;
643 char *error_msg = NULL;
645 /* U+FEFF Byte Order Mark in UTF8 */
646 const char *bomptr = utf8_bom;
649 int c = get_next_char();
650 if (bomptr && *bomptr) {
651 /* We are at the file beginning; skip UTF8-encoded BOM
652 * if present. Sane editors won't put this in on their
653 * own, but e.g. Windows Notepad will do it happily. */
654 if (c == (*bomptr & 0377)) {
658 /* Do not tolerate partial BOM. */
659 if (bomptr != utf8_bom)
661 /* No BOM at file beginning. Cool. */
671 if (comment || isspace(c))
673 if (c == '#' || c == ';') {
678 /* Reset prior to determining a new stem */
680 if (get_base_var(var) < 0 || var->len < 1)
682 strbuf_addch(var, '.');
689 * Truncate the var name back to the section header
690 * stem prior to grabbing the suffix part of the name
693 strbuf_setlen(var, baselen);
694 strbuf_addch(var, tolower(c));
695 if (get_value(fn, data, var) < 0)
699 switch (cf->origin_type) {
700 case CONFIG_ORIGIN_BLOB:
701 error_msg = xstrfmt(_("bad config line %d in blob %s"),
702 cf->linenr, cf->name);
704 case CONFIG_ORIGIN_FILE:
705 error_msg = xstrfmt(_("bad config line %d in file %s"),
706 cf->linenr, cf->name);
708 case CONFIG_ORIGIN_STDIN:
709 error_msg = xstrfmt(_("bad config line %d in standard input"),
712 case CONFIG_ORIGIN_SUBMODULE_BLOB:
713 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
714 cf->linenr, cf->name);
716 case CONFIG_ORIGIN_CMDLINE:
717 error_msg = xstrfmt(_("bad config line %d in command line %s"),
718 cf->linenr, cf->name);
721 error_msg = xstrfmt(_("bad config line %d in %s"),
722 cf->linenr, cf->name);
725 if (cf->die_on_error)
726 die("%s", error_msg);
728 error_return = error("%s", error_msg);
734 static int parse_unit_factor(const char *end, uintmax_t *val)
738 else if (!strcasecmp(end, "k")) {
742 else if (!strcasecmp(end, "m")) {
746 else if (!strcasecmp(end, "g")) {
747 *val *= 1024 * 1024 * 1024;
753 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
755 if (value && *value) {
759 uintmax_t factor = 1;
762 val = strtoimax(value, &end, 0);
765 if (!parse_unit_factor(end, &factor)) {
771 if (uval > max || labs(val) > uval) {
783 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
785 if (value && *value) {
791 val = strtoumax(value, &end, 0);
795 if (!parse_unit_factor(end, &val)) {
799 if (val > max || oldval > val) {
810 static int git_parse_int(const char *value, int *ret)
813 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
819 static int git_parse_int64(const char *value, int64_t *ret)
822 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
828 int git_parse_ulong(const char *value, unsigned long *ret)
831 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
838 static void die_bad_number(const char *name, const char *value)
840 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
845 if (!(cf && cf->name))
846 die(_("bad numeric config value '%s' for '%s': %s"),
847 value, name, error_type);
849 switch (cf->origin_type) {
850 case CONFIG_ORIGIN_BLOB:
851 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
852 value, name, cf->name, error_type);
853 case CONFIG_ORIGIN_FILE:
854 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
855 value, name, cf->name, error_type);
856 case CONFIG_ORIGIN_STDIN:
857 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
858 value, name, error_type);
859 case CONFIG_ORIGIN_SUBMODULE_BLOB:
860 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
861 value, name, cf->name, error_type);
862 case CONFIG_ORIGIN_CMDLINE:
863 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
864 value, name, cf->name, error_type);
866 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
867 value, name, cf->name, error_type);
871 int git_config_int(const char *name, const char *value)
874 if (!git_parse_int(value, &ret))
875 die_bad_number(name, value);
879 int64_t git_config_int64(const char *name, const char *value)
882 if (!git_parse_int64(value, &ret))
883 die_bad_number(name, value);
887 unsigned long git_config_ulong(const char *name, const char *value)
890 if (!git_parse_ulong(value, &ret))
891 die_bad_number(name, value);
895 int git_parse_maybe_bool(const char *value)
901 if (!strcasecmp(value, "true")
902 || !strcasecmp(value, "yes")
903 || !strcasecmp(value, "on"))
905 if (!strcasecmp(value, "false")
906 || !strcasecmp(value, "no")
907 || !strcasecmp(value, "off"))
912 int git_config_maybe_bool(const char *name, const char *value)
914 int v = git_parse_maybe_bool(value);
917 if (git_parse_int(value, &v))
922 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
924 int v = git_parse_maybe_bool(value);
930 return git_config_int(name, value);
933 int git_config_bool(const char *name, const char *value)
936 return !!git_config_bool_or_int(name, value, &discard);
939 int git_config_string(const char **dest, const char *var, const char *value)
942 return config_error_nonbool(var);
943 *dest = xstrdup(value);
947 int git_config_pathname(const char **dest, const char *var, const char *value)
950 return config_error_nonbool(var);
951 *dest = expand_user_path(value);
953 die(_("failed to expand user dir in: '%s'"), value);
957 static int git_default_core_config(const char *var, const char *value)
959 /* This needs a better name */
960 if (!strcmp(var, "core.filemode")) {
961 trust_executable_bit = git_config_bool(var, value);
964 if (!strcmp(var, "core.trustctime")) {
965 trust_ctime = git_config_bool(var, value);
968 if (!strcmp(var, "core.checkstat")) {
969 if (!strcasecmp(value, "default"))
971 else if (!strcasecmp(value, "minimal"))
975 if (!strcmp(var, "core.quotepath")) {
976 quote_path_fully = git_config_bool(var, value);
980 if (!strcmp(var, "core.symlinks")) {
981 has_symlinks = git_config_bool(var, value);
985 if (!strcmp(var, "core.ignorecase")) {
986 ignore_case = git_config_bool(var, value);
990 if (!strcmp(var, "core.attributesfile"))
991 return git_config_pathname(&git_attributes_file, var, value);
993 if (!strcmp(var, "core.hookspath"))
994 return git_config_pathname(&git_hooks_path, var, value);
996 if (!strcmp(var, "core.bare")) {
997 is_bare_repository_cfg = git_config_bool(var, value);
1001 if (!strcmp(var, "core.ignorestat")) {
1002 assume_unchanged = git_config_bool(var, value);
1006 if (!strcmp(var, "core.prefersymlinkrefs")) {
1007 prefer_symlink_refs = git_config_bool(var, value);
1011 if (!strcmp(var, "core.logallrefupdates")) {
1012 if (value && !strcasecmp(value, "always"))
1013 log_all_ref_updates = LOG_REFS_ALWAYS;
1014 else if (git_config_bool(var, value))
1015 log_all_ref_updates = LOG_REFS_NORMAL;
1017 log_all_ref_updates = LOG_REFS_NONE;
1021 if (!strcmp(var, "core.warnambiguousrefs")) {
1022 warn_ambiguous_refs = git_config_bool(var, value);
1026 if (!strcmp(var, "core.abbrev")) {
1028 return config_error_nonbool(var);
1029 if (!strcasecmp(value, "auto"))
1030 default_abbrev = -1;
1032 int abbrev = git_config_int(var, value);
1033 if (abbrev < minimum_abbrev || abbrev > 40)
1034 return error("abbrev length out of range: %d", abbrev);
1035 default_abbrev = abbrev;
1040 if (!strcmp(var, "core.disambiguate"))
1041 return set_disambiguate_hint_config(var, value);
1043 if (!strcmp(var, "core.loosecompression")) {
1044 int level = git_config_int(var, value);
1046 level = Z_DEFAULT_COMPRESSION;
1047 else if (level < 0 || level > Z_BEST_COMPRESSION)
1048 die(_("bad zlib compression level %d"), level);
1049 zlib_compression_level = level;
1050 zlib_compression_seen = 1;
1054 if (!strcmp(var, "core.compression")) {
1055 int level = git_config_int(var, value);
1057 level = Z_DEFAULT_COMPRESSION;
1058 else if (level < 0 || level > Z_BEST_COMPRESSION)
1059 die(_("bad zlib compression level %d"), level);
1060 core_compression_level = level;
1061 core_compression_seen = 1;
1062 if (!zlib_compression_seen)
1063 zlib_compression_level = level;
1064 if (!pack_compression_seen)
1065 pack_compression_level = level;
1069 if (!strcmp(var, "core.packedgitwindowsize")) {
1070 int pgsz_x2 = getpagesize() * 2;
1071 packed_git_window_size = git_config_ulong(var, value);
1073 /* This value must be multiple of (pagesize * 2) */
1074 packed_git_window_size /= pgsz_x2;
1075 if (packed_git_window_size < 1)
1076 packed_git_window_size = 1;
1077 packed_git_window_size *= pgsz_x2;
1081 if (!strcmp(var, "core.bigfilethreshold")) {
1082 big_file_threshold = git_config_ulong(var, value);
1086 if (!strcmp(var, "core.packedgitlimit")) {
1087 packed_git_limit = git_config_ulong(var, value);
1091 if (!strcmp(var, "core.deltabasecachelimit")) {
1092 delta_base_cache_limit = git_config_ulong(var, value);
1096 if (!strcmp(var, "core.autocrlf")) {
1097 if (value && !strcasecmp(value, "input")) {
1098 auto_crlf = AUTO_CRLF_INPUT;
1101 auto_crlf = git_config_bool(var, value);
1105 if (!strcmp(var, "core.safecrlf")) {
1106 if (value && !strcasecmp(value, "warn")) {
1107 safe_crlf = SAFE_CRLF_WARN;
1110 safe_crlf = git_config_bool(var, value);
1114 if (!strcmp(var, "core.eol")) {
1115 if (value && !strcasecmp(value, "lf"))
1117 else if (value && !strcasecmp(value, "crlf"))
1118 core_eol = EOL_CRLF;
1119 else if (value && !strcasecmp(value, "native"))
1120 core_eol = EOL_NATIVE;
1122 core_eol = EOL_UNSET;
1126 if (!strcmp(var, "core.notesref")) {
1127 notes_ref_name = xstrdup(value);
1131 if (!strcmp(var, "core.editor"))
1132 return git_config_string(&editor_program, var, value);
1134 if (!strcmp(var, "core.commentchar")) {
1136 return config_error_nonbool(var);
1137 else if (!strcasecmp(value, "auto"))
1138 auto_comment_line_char = 1;
1139 else if (value[0] && !value[1]) {
1140 comment_line_char = value[0];
1141 auto_comment_line_char = 0;
1143 return error("core.commentChar should only be one character");
1147 if (!strcmp(var, "core.askpass"))
1148 return git_config_string(&askpass_program, var, value);
1150 if (!strcmp(var, "core.excludesfile"))
1151 return git_config_pathname(&excludes_file, var, value);
1153 if (!strcmp(var, "core.whitespace")) {
1155 return config_error_nonbool(var);
1156 whitespace_rule_cfg = parse_whitespace_rule(value);
1160 if (!strcmp(var, "core.fsyncobjectfiles")) {
1161 fsync_object_files = git_config_bool(var, value);
1165 if (!strcmp(var, "core.preloadindex")) {
1166 core_preload_index = git_config_bool(var, value);
1170 if (!strcmp(var, "core.createobject")) {
1171 if (!strcmp(value, "rename"))
1172 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1173 else if (!strcmp(value, "link"))
1174 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1176 die(_("invalid mode for object creation: %s"), value);
1180 if (!strcmp(var, "core.sparsecheckout")) {
1181 core_apply_sparse_checkout = git_config_bool(var, value);
1185 if (!strcmp(var, "core.precomposeunicode")) {
1186 precomposed_unicode = git_config_bool(var, value);
1190 if (!strcmp(var, "core.protecthfs")) {
1191 protect_hfs = git_config_bool(var, value);
1195 if (!strcmp(var, "core.protectntfs")) {
1196 protect_ntfs = git_config_bool(var, value);
1200 if (!strcmp(var, "core.hidedotfiles")) {
1201 if (value && !strcasecmp(value, "dotgitonly"))
1202 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1204 hide_dotfiles = git_config_bool(var, value);
1208 /* Add other config variables here and to Documentation/config.txt. */
1212 static int git_default_i18n_config(const char *var, const char *value)
1214 if (!strcmp(var, "i18n.commitencoding"))
1215 return git_config_string(&git_commit_encoding, var, value);
1217 if (!strcmp(var, "i18n.logoutputencoding"))
1218 return git_config_string(&git_log_output_encoding, var, value);
1220 /* Add other config variables here and to Documentation/config.txt. */
1224 static int git_default_branch_config(const char *var, const char *value)
1226 if (!strcmp(var, "branch.autosetupmerge")) {
1227 if (value && !strcasecmp(value, "always")) {
1228 git_branch_track = BRANCH_TRACK_ALWAYS;
1231 git_branch_track = git_config_bool(var, value);
1234 if (!strcmp(var, "branch.autosetuprebase")) {
1236 return config_error_nonbool(var);
1237 else if (!strcmp(value, "never"))
1238 autorebase = AUTOREBASE_NEVER;
1239 else if (!strcmp(value, "local"))
1240 autorebase = AUTOREBASE_LOCAL;
1241 else if (!strcmp(value, "remote"))
1242 autorebase = AUTOREBASE_REMOTE;
1243 else if (!strcmp(value, "always"))
1244 autorebase = AUTOREBASE_ALWAYS;
1246 return error("malformed value for %s", var);
1250 /* Add other config variables here and to Documentation/config.txt. */
1254 static int git_default_push_config(const char *var, const char *value)
1256 if (!strcmp(var, "push.default")) {
1258 return config_error_nonbool(var);
1259 else if (!strcmp(value, "nothing"))
1260 push_default = PUSH_DEFAULT_NOTHING;
1261 else if (!strcmp(value, "matching"))
1262 push_default = PUSH_DEFAULT_MATCHING;
1263 else if (!strcmp(value, "simple"))
1264 push_default = PUSH_DEFAULT_SIMPLE;
1265 else if (!strcmp(value, "upstream"))
1266 push_default = PUSH_DEFAULT_UPSTREAM;
1267 else if (!strcmp(value, "tracking")) /* deprecated */
1268 push_default = PUSH_DEFAULT_UPSTREAM;
1269 else if (!strcmp(value, "current"))
1270 push_default = PUSH_DEFAULT_CURRENT;
1272 error("malformed value for %s: %s", var, value);
1273 return error("Must be one of nothing, matching, simple, "
1274 "upstream or current.");
1279 /* Add other config variables here and to Documentation/config.txt. */
1283 static int git_default_mailmap_config(const char *var, const char *value)
1285 if (!strcmp(var, "mailmap.file"))
1286 return git_config_pathname(&git_mailmap_file, var, value);
1287 if (!strcmp(var, "mailmap.blob"))
1288 return git_config_string(&git_mailmap_blob, var, value);
1290 /* Add other config variables here and to Documentation/config.txt. */
1294 int git_default_config(const char *var, const char *value, void *dummy)
1296 if (starts_with(var, "core."))
1297 return git_default_core_config(var, value);
1299 if (starts_with(var, "user."))
1300 return git_ident_config(var, value, dummy);
1302 if (starts_with(var, "i18n."))
1303 return git_default_i18n_config(var, value);
1305 if (starts_with(var, "branch."))
1306 return git_default_branch_config(var, value);
1308 if (starts_with(var, "push."))
1309 return git_default_push_config(var, value);
1311 if (starts_with(var, "mailmap."))
1312 return git_default_mailmap_config(var, value);
1314 if (starts_with(var, "advice."))
1315 return git_default_advice_config(var, value);
1317 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1318 pager_use_color = git_config_bool(var,value);
1322 if (!strcmp(var, "pack.packsizelimit")) {
1323 pack_size_limit_cfg = git_config_ulong(var, value);
1327 if (!strcmp(var, "pack.compression")) {
1328 int level = git_config_int(var, value);
1330 level = Z_DEFAULT_COMPRESSION;
1331 else if (level < 0 || level > Z_BEST_COMPRESSION)
1332 die(_("bad pack compression level %d"), level);
1333 pack_compression_level = level;
1334 pack_compression_seen = 1;
1338 /* Add other config variables here and to Documentation/config.txt. */
1343 * All source specific fields in the union, die_on_error, name and the callbacks
1344 * fgetc, ungetc, ftell of top need to be initialized before calling
1347 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1351 /* push config-file parsing state stack */
1355 strbuf_init(&top->value, 1024);
1356 strbuf_init(&top->var, 1024);
1359 ret = git_parse_source(fn, data);
1361 /* pop config-file parsing state stack */
1362 strbuf_release(&top->value);
1363 strbuf_release(&top->var);
1369 static int do_config_from_file(config_fn_t fn,
1370 const enum config_origin_type origin_type,
1371 const char *name, const char *path, FILE *f,
1374 struct config_source top;
1377 top.origin_type = origin_type;
1380 top.die_on_error = 1;
1381 top.do_fgetc = config_file_fgetc;
1382 top.do_ungetc = config_file_ungetc;
1383 top.do_ftell = config_file_ftell;
1385 return do_config_from(&top, fn, data);
1388 static int git_config_from_stdin(config_fn_t fn, void *data)
1390 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1393 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1398 f = fopen(filename, "r");
1401 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1408 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1409 const char *name, const char *buf, size_t len, void *data)
1411 struct config_source top;
1413 top.u.buf.buf = buf;
1414 top.u.buf.len = len;
1416 top.origin_type = origin_type;
1419 top.die_on_error = 0;
1420 top.do_fgetc = config_buf_fgetc;
1421 top.do_ungetc = config_buf_ungetc;
1422 top.do_ftell = config_buf_ftell;
1424 return do_config_from(&top, fn, data);
1427 int git_config_from_blob_sha1(config_fn_t fn,
1429 const unsigned char *sha1,
1432 enum object_type type;
1437 buf = read_sha1_file(sha1, &type, &size);
1439 return error("unable to load config blob object '%s'", name);
1440 if (type != OBJ_BLOB) {
1442 return error("reference '%s' does not point to a blob", name);
1445 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1451 static int git_config_from_blob_ref(config_fn_t fn,
1455 unsigned char sha1[20];
1457 if (get_sha1(name, sha1) < 0)
1458 return error("unable to resolve config blob '%s'", name);
1459 return git_config_from_blob_sha1(fn, name, sha1, data);
1462 const char *git_etc_gitconfig(void)
1464 static const char *system_wide;
1466 system_wide = system_path(ETC_GITCONFIG);
1471 * Parse environment variable 'k' as a boolean (in various
1472 * possible spellings); if missing, use the default value 'def'.
1474 int git_env_bool(const char *k, int def)
1476 const char *v = getenv(k);
1477 return v ? git_config_bool(k, v) : def;
1481 * Parse environment variable 'k' as ulong with possibly a unit
1482 * suffix; if missing, use the default value 'val'.
1484 unsigned long git_env_ulong(const char *k, unsigned long val)
1486 const char *v = getenv(k);
1487 if (v && !git_parse_ulong(v, &val))
1488 die("failed to parse %s", k);
1492 int git_config_system(void)
1494 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1497 static int do_git_config_sequence(config_fn_t fn, void *data)
1500 char *xdg_config = xdg_config_home("config");
1501 char *user_config = expand_user_path("~/.gitconfig");
1502 char *repo_config = have_git_dir() ? git_pathdup("config") : NULL;
1504 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1505 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1506 ret += git_config_from_file(fn, git_etc_gitconfig(),
1509 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1510 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1511 ret += git_config_from_file(fn, xdg_config, data);
1513 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1514 ret += git_config_from_file(fn, user_config, data);
1516 current_parsing_scope = CONFIG_SCOPE_REPO;
1517 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1518 ret += git_config_from_file(fn, repo_config, data);
1520 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1521 if (git_config_from_parameters(fn, data) < 0)
1522 die(_("unable to parse command-line config"));
1524 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1531 int git_config_with_options(config_fn_t fn, void *data,
1532 struct git_config_source *config_source,
1533 int respect_includes)
1535 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1537 if (respect_includes) {
1540 fn = git_config_include;
1545 * If we have a specific filename, use it. Otherwise, follow the
1546 * regular lookup sequence.
1548 if (config_source && config_source->use_stdin)
1549 return git_config_from_stdin(fn, data);
1550 else if (config_source && config_source->file)
1551 return git_config_from_file(fn, config_source->file, data);
1552 else if (config_source && config_source->blob)
1553 return git_config_from_blob_ref(fn, config_source->blob, data);
1555 return do_git_config_sequence(fn, data);
1558 static void git_config_raw(config_fn_t fn, void *data)
1560 if (git_config_with_options(fn, data, NULL, 1) < 0)
1562 * git_config_with_options() normally returns only
1563 * zero, as most errors are fatal, and
1564 * non-fatal potential errors are guarded by "if"
1565 * statements that are entered only when no error is
1568 * If we ever encounter a non-fatal error, it means
1569 * something went really wrong and we should stop
1572 die(_("unknown error occurred while reading the configuration files"));
1575 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1578 struct string_list *values;
1579 struct config_set_element *entry;
1580 struct configset_list *list = &cs->list;
1582 for (i = 0; i < list->nr; i++) {
1583 entry = list->items[i].e;
1584 value_index = list->items[i].value_index;
1585 values = &entry->value_list;
1587 current_config_kvi = values->items[value_index].util;
1589 if (fn(entry->key, values->items[value_index].string, data) < 0)
1590 git_die_config_linenr(entry->key,
1591 current_config_kvi->filename,
1592 current_config_kvi->linenr);
1594 current_config_kvi = NULL;
1598 void read_early_config(config_fn_t cb, void *data)
1600 struct strbuf buf = STRBUF_INIT;
1602 git_config_with_options(cb, data, NULL, 1);
1605 * When setup_git_directory() was not yet asked to discover the
1606 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1607 * is any repository config we should use (but unlike
1608 * setup_git_directory_gently(), no global state is changed, most
1609 * notably, the current working directory is still the same after the
1612 if (!have_git_dir() && discover_git_directory(&buf)) {
1613 struct git_config_source repo_config;
1615 memset(&repo_config, 0, sizeof(repo_config));
1616 strbuf_addstr(&buf, "/config");
1617 repo_config.file = buf.buf;
1618 git_config_with_options(cb, data, &repo_config, 1);
1620 strbuf_release(&buf);
1623 static void git_config_check_init(void);
1625 void git_config(config_fn_t fn, void *data)
1627 git_config_check_init();
1628 configset_iter(&the_config_set, fn, data);
1631 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1633 struct config_set_element k;
1634 struct config_set_element *found_entry;
1635 char *normalized_key;
1637 * `key` may come from the user, so normalize it before using it
1638 * for querying entries from the hashmap.
1640 if (git_config_parse_key(key, &normalized_key, NULL))
1643 hashmap_entry_init(&k, strhash(normalized_key));
1644 k.key = normalized_key;
1645 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1646 free(normalized_key);
1650 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1652 struct config_set_element *e;
1653 struct string_list_item *si;
1654 struct configset_list_item *l_item;
1655 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1657 e = configset_find_element(cs, key);
1659 * Since the keys are being fed by git_config*() callback mechanism, they
1660 * are already normalized. So simply add them without any further munging.
1663 e = xmalloc(sizeof(*e));
1664 hashmap_entry_init(e, strhash(key));
1665 e->key = xstrdup(key);
1666 string_list_init(&e->value_list, 1);
1667 hashmap_add(&cs->config_hash, e);
1669 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1671 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1672 l_item = &cs->list.items[cs->list.nr++];
1674 l_item->value_index = e->value_list.nr - 1;
1677 die("BUG: configset_add_value has no source");
1679 kv_info->filename = strintern(cf->name);
1680 kv_info->linenr = cf->linenr;
1681 kv_info->origin_type = cf->origin_type;
1683 /* for values read from `git_config_from_parameters()` */
1684 kv_info->filename = NULL;
1685 kv_info->linenr = -1;
1686 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1688 kv_info->scope = current_parsing_scope;
1694 static int config_set_element_cmp(const struct config_set_element *e1,
1695 const struct config_set_element *e2, const void *unused)
1697 return strcmp(e1->key, e2->key);
1700 void git_configset_init(struct config_set *cs)
1702 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1703 cs->hash_initialized = 1;
1706 cs->list.items = NULL;
1709 void git_configset_clear(struct config_set *cs)
1711 struct config_set_element *entry;
1712 struct hashmap_iter iter;
1713 if (!cs->hash_initialized)
1716 hashmap_iter_init(&cs->config_hash, &iter);
1717 while ((entry = hashmap_iter_next(&iter))) {
1719 string_list_clear(&entry->value_list, 1);
1721 hashmap_free(&cs->config_hash, 1);
1722 cs->hash_initialized = 0;
1723 free(cs->list.items);
1726 cs->list.items = NULL;
1729 static int config_set_callback(const char *key, const char *value, void *cb)
1731 struct config_set *cs = cb;
1732 configset_add_value(cs, key, value);
1736 int git_configset_add_file(struct config_set *cs, const char *filename)
1738 return git_config_from_file(config_set_callback, filename, cs);
1741 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1743 const struct string_list *values = NULL;
1745 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1746 * queried key in the files of the configset, the value returned will be the last
1747 * value in the value list for that key.
1749 values = git_configset_get_value_multi(cs, key);
1753 assert(values->nr > 0);
1754 *value = values->items[values->nr - 1].string;
1758 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1760 struct config_set_element *e = configset_find_element(cs, key);
1761 return e ? &e->value_list : NULL;
1764 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1767 if (!git_configset_get_value(cs, key, &value))
1768 return git_config_string(dest, key, value);
1773 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1775 return git_configset_get_string_const(cs, key, (const char **)dest);
1778 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1781 if (!git_configset_get_value(cs, key, &value)) {
1782 *dest = git_config_int(key, value);
1788 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1791 if (!git_configset_get_value(cs, key, &value)) {
1792 *dest = git_config_ulong(key, value);
1798 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1801 if (!git_configset_get_value(cs, key, &value)) {
1802 *dest = git_config_bool(key, value);
1808 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1809 int *is_bool, int *dest)
1812 if (!git_configset_get_value(cs, key, &value)) {
1813 *dest = git_config_bool_or_int(key, value, is_bool);
1819 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1822 if (!git_configset_get_value(cs, key, &value)) {
1823 *dest = git_config_maybe_bool(key, value);
1831 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1834 if (!git_configset_get_value(cs, key, &value))
1835 return git_config_pathname(dest, key, value);
1840 static void git_config_check_init(void)
1842 if (the_config_set.hash_initialized)
1844 git_configset_init(&the_config_set);
1845 git_config_raw(config_set_callback, &the_config_set);
1848 void git_config_clear(void)
1850 if (!the_config_set.hash_initialized)
1852 git_configset_clear(&the_config_set);
1855 int git_config_get_value(const char *key, const char **value)
1857 git_config_check_init();
1858 return git_configset_get_value(&the_config_set, key, value);
1861 const struct string_list *git_config_get_value_multi(const char *key)
1863 git_config_check_init();
1864 return git_configset_get_value_multi(&the_config_set, key);
1867 int git_config_get_string_const(const char *key, const char **dest)
1870 git_config_check_init();
1871 ret = git_configset_get_string_const(&the_config_set, key, dest);
1873 git_die_config(key, NULL);
1877 int git_config_get_string(const char *key, char **dest)
1879 git_config_check_init();
1880 return git_config_get_string_const(key, (const char **)dest);
1883 int git_config_get_int(const char *key, int *dest)
1885 git_config_check_init();
1886 return git_configset_get_int(&the_config_set, key, dest);
1889 int git_config_get_ulong(const char *key, unsigned long *dest)
1891 git_config_check_init();
1892 return git_configset_get_ulong(&the_config_set, key, dest);
1895 int git_config_get_bool(const char *key, int *dest)
1897 git_config_check_init();
1898 return git_configset_get_bool(&the_config_set, key, dest);
1901 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1903 git_config_check_init();
1904 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1907 int git_config_get_maybe_bool(const char *key, int *dest)
1909 git_config_check_init();
1910 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1913 int git_config_get_pathname(const char *key, const char **dest)
1916 git_config_check_init();
1917 ret = git_configset_get_pathname(&the_config_set, key, dest);
1919 git_die_config(key, NULL);
1923 int git_config_get_expiry(const char *key, const char **output)
1925 int ret = git_config_get_string_const(key, output);
1928 if (strcmp(*output, "now")) {
1929 timestamp_t now = approxidate("now");
1930 if (approxidate(*output) >= now)
1931 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
1936 int git_config_get_untracked_cache(void)
1941 /* Hack for test programs like test-dump-untracked-cache */
1942 if (ignore_untracked_cache_config)
1945 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
1948 if (!git_config_get_value("core.untrackedcache", &v)) {
1949 if (!strcasecmp(v, "keep"))
1952 error(_("unknown core.untrackedCache value '%s'; "
1953 "using 'keep' default value"), v);
1957 return -1; /* default value */
1960 int git_config_get_split_index(void)
1964 if (!git_config_get_maybe_bool("core.splitindex", &val))
1967 return -1; /* default value */
1970 int git_config_get_max_percent_split_change(void)
1974 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
1975 if (0 <= val && val <= 100)
1978 return error(_("splitIndex.maxPercentChange value '%d' "
1979 "should be between 0 and 100"), val);
1982 return -1; /* default value */
1986 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1989 die(_("unable to parse '%s' from command-line config"), key);
1991 die(_("bad config variable '%s' in file '%s' at line %d"),
1992 key, filename, linenr);
1995 NORETURN __attribute__((format(printf, 2, 3)))
1996 void git_die_config(const char *key, const char *err, ...)
1998 const struct string_list *values;
1999 struct key_value_info *kv_info;
2003 va_start(params, err);
2004 vreportf("error: ", err, params);
2007 values = git_config_get_value_multi(key);
2008 kv_info = values->items[values->nr - 1].util;
2009 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2013 * Find all the stuff for git_config_set() below.
2020 regex_t *value_regex;
2023 unsigned int offset_alloc;
2024 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2028 static int matches(const char *key, const char *value)
2030 if (strcmp(key, store.key))
2031 return 0; /* not ours */
2032 if (!store.value_regex)
2033 return 1; /* always matches */
2034 if (store.value_regex == CONFIG_REGEX_NONE)
2035 return 0; /* never matches */
2037 return store.do_not_match ^
2038 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2041 static int store_aux(const char *key, const char *value, void *cb)
2046 switch (store.state) {
2048 if (matches(key, value)) {
2049 if (store.seen == 1 && store.multi_replace == 0) {
2050 warning(_("%s has multiple values"), key);
2053 ALLOC_GROW(store.offset, store.seen + 1,
2054 store.offset_alloc);
2056 store.offset[store.seen] = cf->do_ftell(cf);
2062 * What we are looking for is in store.key (both
2063 * section and var), and its section part is baselen
2064 * long. We found key (again, both section and var).
2065 * We would want to know if this key is in the same
2066 * section as what we are looking for. We already
2067 * know we are in the same section as what should
2070 ep = strrchr(key, '.');
2071 section_len = ep - key;
2073 if ((section_len != store.baselen) ||
2074 memcmp(key, store.key, section_len+1)) {
2075 store.state = SECTION_END_SEEN;
2080 * Do not increment matches: this is no match, but we
2081 * just made sure we are in the desired section.
2083 ALLOC_GROW(store.offset, store.seen + 1,
2084 store.offset_alloc);
2085 store.offset[store.seen] = cf->do_ftell(cf);
2087 case SECTION_END_SEEN:
2089 if (matches(key, value)) {
2090 ALLOC_GROW(store.offset, store.seen + 1,
2091 store.offset_alloc);
2092 store.offset[store.seen] = cf->do_ftell(cf);
2093 store.state = KEY_SEEN;
2096 if (strrchr(key, '.') - key == store.baselen &&
2097 !strncmp(key, store.key, store.baselen)) {
2098 store.state = SECTION_SEEN;
2099 ALLOC_GROW(store.offset,
2101 store.offset_alloc);
2102 store.offset[store.seen] = cf->do_ftell(cf);
2109 static int write_error(const char *filename)
2111 error("failed to write new configuration file %s", filename);
2113 /* Same error code as "failed to rename". */
2117 static int store_write_section(int fd, const char *key)
2121 struct strbuf sb = STRBUF_INIT;
2123 dot = memchr(key, '.', store.baselen);
2125 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2126 for (i = dot - key + 1; i < store.baselen; i++) {
2127 if (key[i] == '"' || key[i] == '\\')
2128 strbuf_addch(&sb, '\\');
2129 strbuf_addch(&sb, key[i]);
2131 strbuf_addstr(&sb, "\"]\n");
2133 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2136 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2137 strbuf_release(&sb);
2142 static int store_write_pair(int fd, const char *key, const char *value)
2145 int length = strlen(key + store.baselen + 1);
2146 const char *quote = "";
2147 struct strbuf sb = STRBUF_INIT;
2150 * Check to see if the value needs to be surrounded with a dq pair.
2151 * Note that problematic characters are always backslash-quoted; this
2152 * check is about not losing leading or trailing SP and strings that
2153 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2154 * configuration parser.
2156 if (value[0] == ' ')
2158 for (i = 0; value[i]; i++)
2159 if (value[i] == ';' || value[i] == '#')
2161 if (i && value[i - 1] == ' ')
2164 strbuf_addf(&sb, "\t%.*s = %s",
2165 length, key + store.baselen + 1, quote);
2167 for (i = 0; value[i]; i++)
2170 strbuf_addstr(&sb, "\\n");
2173 strbuf_addstr(&sb, "\\t");
2177 strbuf_addch(&sb, '\\');
2179 strbuf_addch(&sb, value[i]);
2182 strbuf_addf(&sb, "%s\n", quote);
2184 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2185 strbuf_release(&sb);
2190 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2191 size_t offset_, int *found_bracket)
2193 size_t equal_offset = size, bracket_offset = size;
2197 for (offset = offset_-2; offset > 0
2198 && contents[offset] != '\n'; offset--)
2199 switch (contents[offset]) {
2200 case '=': equal_offset = offset; break;
2201 case ']': bracket_offset = offset; break;
2203 if (offset > 0 && contents[offset-1] == '\\') {
2207 if (bracket_offset < equal_offset) {
2209 offset = bracket_offset+1;
2216 int git_config_set_in_file_gently(const char *config_filename,
2217 const char *key, const char *value)
2219 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2222 void git_config_set_in_file(const char *config_filename,
2223 const char *key, const char *value)
2225 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2228 int git_config_set_gently(const char *key, const char *value)
2230 return git_config_set_multivar_gently(key, value, NULL, 0);
2233 void git_config_set(const char *key, const char *value)
2235 git_config_set_multivar(key, value, NULL, 0);
2239 * If value==NULL, unset in (remove from) config,
2240 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2241 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2242 * (only add a new one)
2243 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2244 * else all matching key/values (regardless how many) are removed,
2245 * before the new pair is written.
2247 * Returns 0 on success.
2249 * This function does this:
2251 * - it locks the config file by creating ".git/config.lock"
2253 * - it then parses the config using store_aux() as validator to find
2254 * the position on the key/value pair to replace. If it is to be unset,
2255 * it must be found exactly once.
2257 * - the config file is mmap()ed and the part before the match (if any) is
2258 * written to the lock file, then the changed part and the rest.
2260 * - the config file is removed and the lock file rename()d to it.
2263 int git_config_set_multivar_in_file_gently(const char *config_filename,
2264 const char *key, const char *value,
2265 const char *value_regex,
2268 int fd = -1, in_fd = -1;
2270 struct lock_file *lock = NULL;
2271 char *filename_buf = NULL;
2272 char *contents = NULL;
2275 /* parse-key returns negative; flip the sign to feed exit(3) */
2276 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2280 store.multi_replace = multi_replace;
2282 if (!config_filename)
2283 config_filename = filename_buf = git_pathdup("config");
2286 * The lock serves a purpose in addition to locking: the new
2287 * contents of .git/config will be written into it.
2289 lock = xcalloc(1, sizeof(struct lock_file));
2290 fd = hold_lock_file_for_update(lock, config_filename, 0);
2292 error_errno("could not lock config file %s", config_filename);
2294 ret = CONFIG_NO_LOCK;
2299 * If .git/config does not exist yet, write a minimal version.
2301 in_fd = open(config_filename, O_RDONLY);
2305 if ( ENOENT != errno ) {
2306 error_errno("opening %s", config_filename);
2307 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2310 /* if nothing to unset, error out */
2311 if (value == NULL) {
2312 ret = CONFIG_NOTHING_SET;
2316 store.key = (char *)key;
2317 if (!store_write_section(fd, key) ||
2318 !store_write_pair(fd, key, value))
2322 size_t copy_begin, copy_end;
2323 int i, new_line = 0;
2325 if (value_regex == NULL)
2326 store.value_regex = NULL;
2327 else if (value_regex == CONFIG_REGEX_NONE)
2328 store.value_regex = CONFIG_REGEX_NONE;
2330 if (value_regex[0] == '!') {
2331 store.do_not_match = 1;
2334 store.do_not_match = 0;
2336 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2337 if (regcomp(store.value_regex, value_regex,
2339 error("invalid pattern: %s", value_regex);
2340 free(store.value_regex);
2341 ret = CONFIG_INVALID_PATTERN;
2346 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2347 store.offset[0] = 0;
2348 store.state = START;
2352 * After this, store.offset will contain the *end* offset
2353 * of the last match, or remain at 0 if no match was found.
2354 * As a side effect, we make sure to transform only a valid
2355 * existing config file.
2357 if (git_config_from_file(store_aux, config_filename, NULL)) {
2358 error("invalid config file %s", config_filename);
2360 if (store.value_regex != NULL &&
2361 store.value_regex != CONFIG_REGEX_NONE) {
2362 regfree(store.value_regex);
2363 free(store.value_regex);
2365 ret = CONFIG_INVALID_FILE;
2370 if (store.value_regex != NULL &&
2371 store.value_regex != CONFIG_REGEX_NONE) {
2372 regfree(store.value_regex);
2373 free(store.value_regex);
2376 /* if nothing to unset, or too many matches, error out */
2377 if ((store.seen == 0 && value == NULL) ||
2378 (store.seen > 1 && multi_replace == 0)) {
2379 ret = CONFIG_NOTHING_SET;
2383 if (fstat(in_fd, &st) == -1) {
2384 error_errno(_("fstat on %s failed"), config_filename);
2385 ret = CONFIG_INVALID_FILE;
2389 contents_sz = xsize_t(st.st_size);
2390 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2391 MAP_PRIVATE, in_fd, 0);
2392 if (contents == MAP_FAILED) {
2393 if (errno == ENODEV && S_ISDIR(st.st_mode))
2395 error_errno("unable to mmap '%s'", config_filename);
2396 ret = CONFIG_INVALID_FILE;
2403 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2404 error_errno("chmod on %s failed", get_lock_file_path(lock));
2405 ret = CONFIG_NO_WRITE;
2409 if (store.seen == 0)
2412 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2413 if (store.offset[i] == 0) {
2414 store.offset[i] = copy_end = contents_sz;
2415 } else if (store.state != KEY_SEEN) {
2416 copy_end = store.offset[i];
2418 copy_end = find_beginning_of_line(
2419 contents, contents_sz,
2420 store.offset[i]-2, &new_line);
2422 if (copy_end > 0 && contents[copy_end-1] != '\n')
2425 /* write the first part of the config */
2426 if (copy_end > copy_begin) {
2427 if (write_in_full(fd, contents + copy_begin,
2428 copy_end - copy_begin) <
2429 copy_end - copy_begin)
2432 write_str_in_full(fd, "\n") != 1)
2435 copy_begin = store.offset[i];
2438 /* write the pair (value == NULL means unset) */
2439 if (value != NULL) {
2440 if (store.state == START) {
2441 if (!store_write_section(fd, key))
2444 if (!store_write_pair(fd, key, value))
2448 /* write the rest of the config */
2449 if (copy_begin < contents_sz)
2450 if (write_in_full(fd, contents + copy_begin,
2451 contents_sz - copy_begin) <
2452 contents_sz - copy_begin)
2455 munmap(contents, contents_sz);
2459 if (commit_lock_file(lock) < 0) {
2460 error_errno("could not write config file %s", config_filename);
2461 ret = CONFIG_NO_WRITE;
2467 * lock is committed, so don't try to roll it back below.
2468 * NOTE: Since lockfile.c keeps a linked list of all created
2469 * lock_file structures, it isn't safe to free(lock). It's
2470 * better to just leave it hanging around.
2475 /* Invalidate the config cache */
2480 rollback_lock_file(lock);
2483 munmap(contents, contents_sz);
2489 ret = write_error(get_lock_file_path(lock));
2494 void git_config_set_multivar_in_file(const char *config_filename,
2495 const char *key, const char *value,
2496 const char *value_regex, int multi_replace)
2498 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2499 value_regex, multi_replace))
2502 die(_("could not set '%s' to '%s'"), key, value);
2504 die(_("could not unset '%s'"), key);
2507 int git_config_set_multivar_gently(const char *key, const char *value,
2508 const char *value_regex, int multi_replace)
2510 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2514 void git_config_set_multivar(const char *key, const char *value,
2515 const char *value_regex, int multi_replace)
2517 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2521 static int section_name_match (const char *buf, const char *name)
2523 int i = 0, j = 0, dot = 0;
2526 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2527 if (!dot && isspace(buf[i])) {
2529 if (name[j++] != '.')
2531 for (i++; isspace(buf[i]); i++)
2537 if (buf[i] == '\\' && dot)
2539 else if (buf[i] == '"' && dot) {
2540 for (i++; isspace(buf[i]); i++)
2544 if (buf[i] != name[j++])
2547 if (buf[i] == ']' && name[j] == 0) {
2549 * We match, now just find the right length offset by
2550 * gobbling up any whitespace after it, as well
2553 for (; buf[i] && isspace(buf[i]); i++)
2560 static int section_name_is_ok(const char *name)
2562 /* Empty section names are bogus. */
2567 * Before a dot, we must be alphanumeric or dash. After the first dot,
2568 * anything goes, so we can stop checking.
2570 for (; *name && *name != '.'; name++)
2571 if (*name != '-' && !isalnum(*name))
2576 /* if new_name == NULL, the section is removed instead */
2577 int git_config_rename_section_in_file(const char *config_filename,
2578 const char *old_name, const char *new_name)
2580 int ret = 0, remove = 0;
2581 char *filename_buf = NULL;
2582 struct lock_file *lock;
2588 if (new_name && !section_name_is_ok(new_name)) {
2589 ret = error("invalid section name: %s", new_name);
2590 goto out_no_rollback;
2593 if (!config_filename)
2594 config_filename = filename_buf = git_pathdup("config");
2596 lock = xcalloc(1, sizeof(struct lock_file));
2597 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2599 ret = error("could not lock config file %s", config_filename);
2603 if (!(config_file = fopen(config_filename, "rb"))) {
2604 /* no config file means nothing to rename, no error */
2605 goto commit_and_out;
2608 if (fstat(fileno(config_file), &st) == -1) {
2609 ret = error_errno(_("fstat on %s failed"), config_filename);
2613 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2614 ret = error_errno("chmod on %s failed",
2615 get_lock_file_path(lock));
2619 while (fgets(buf, sizeof(buf), config_file)) {
2623 for (i = 0; buf[i] && isspace(buf[i]); i++)
2625 if (buf[i] == '[') {
2626 /* it's a section */
2627 int offset = section_name_match(&buf[i], old_name);
2630 if (new_name == NULL) {
2634 store.baselen = strlen(new_name);
2635 if (!store_write_section(out_fd, new_name)) {
2636 ret = write_error(get_lock_file_path(lock));
2640 * We wrote out the new section, with
2641 * a newline, now skip the old
2644 output += offset + i;
2645 if (strlen(output) > 0) {
2647 * More content means there's
2648 * a declaration to put on the
2649 * next line; indent with a
2660 length = strlen(output);
2661 if (write_in_full(out_fd, output, length) != length) {
2662 ret = write_error(get_lock_file_path(lock));
2666 fclose(config_file);
2668 if (commit_lock_file(lock) < 0)
2669 ret = error_errno("could not write config file %s",
2672 rollback_lock_file(lock);
2678 int git_config_rename_section(const char *old_name, const char *new_name)
2680 return git_config_rename_section_in_file(NULL, old_name, new_name);
2684 * Call this to report error for your variable that should not
2685 * get a boolean value (i.e. "[my] var" means "true").
2687 #undef config_error_nonbool
2688 int config_error_nonbool(const char *var)
2690 return error("missing value for '%s'", var);
2693 int parse_config_key(const char *var,
2694 const char *section,
2695 const char **subsection, int *subsection_len,
2700 /* Does it start with "section." ? */
2701 if (!skip_prefix(var, section, &var) || *var != '.')
2705 * Find the key; we don't know yet if we have a subsection, but we must
2706 * parse backwards from the end, since the subsection may have dots in
2709 dot = strrchr(var, '.');
2712 /* Did we have a subsection at all? */
2716 *subsection_len = 0;
2722 *subsection = var + 1;
2723 *subsection_len = dot - *subsection;
2729 const char *current_config_origin_type(void)
2732 if (current_config_kvi)
2733 type = current_config_kvi->origin_type;
2735 type = cf->origin_type;
2737 die("BUG: current_config_origin_type called outside config callback");
2740 case CONFIG_ORIGIN_BLOB:
2742 case CONFIG_ORIGIN_FILE:
2744 case CONFIG_ORIGIN_STDIN:
2745 return "standard input";
2746 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2747 return "submodule-blob";
2748 case CONFIG_ORIGIN_CMDLINE:
2749 return "command line";
2751 die("BUG: unknown config origin type");
2755 const char *current_config_name(void)
2758 if (current_config_kvi)
2759 name = current_config_kvi->filename;
2763 die("BUG: current_config_name called outside config callback");
2764 return name ? name : "";
2767 enum config_scope current_config_scope(void)
2769 if (current_config_kvi)
2770 return current_config_kvi->scope;
2772 return current_parsing_scope;