2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
11 #include "environment.h"
12 #include "repository.h"
18 #include "string-list.h"
19 #include "object-store.h"
25 struct config_source {
26 struct config_source *prev;
35 enum config_origin_type origin_type;
38 enum config_error_action default_error_action;
44 unsigned subsection_case_sensitive : 1;
46 int (*do_fgetc)(struct config_source *c);
47 int (*do_ungetc)(int c, struct config_source *conf);
48 long (*do_ftell)(struct config_source *c);
52 * These variables record the "current" config source, which
53 * can be accessed by parsing callbacks.
55 * The "cf" variable will be non-NULL only when we are actually parsing a real
56 * config source (file, blob, cmdline, etc).
58 * The "current_config_kvi" variable will be non-NULL only when we are feeding
59 * cached config from a configset into a callback.
61 * They should generally never be non-NULL at the same time. If they are both
62 * NULL, then we aren't parsing anything (and depending on the function looking
63 * at the variables, it's either a bug for it to be called in the first place,
64 * or it's a function which can be reused for non-config purposes, and should
65 * fall back to some sane behavior).
67 static struct config_source *cf;
68 static struct key_value_info *current_config_kvi;
71 * Similar to the variables above, this gives access to the "scope" of the
72 * current value (repo, global, etc). For cached values, it can be found via
73 * the current_config_kvi as above. During parsing, the current value can be
74 * found in this variable. It's not part of "cf" because it transcends a single
75 * file (i.e., a file included from .git/config is still in "repo" scope).
77 static enum config_scope current_parsing_scope;
79 static int core_compression_seen;
80 static int pack_compression_seen;
81 static int zlib_compression_seen;
83 static int config_file_fgetc(struct config_source *conf)
85 return getc_unlocked(conf->u.file);
88 static int config_file_ungetc(int c, struct config_source *conf)
90 return ungetc(c, conf->u.file);
93 static long config_file_ftell(struct config_source *conf)
95 return ftell(conf->u.file);
99 static int config_buf_fgetc(struct config_source *conf)
101 if (conf->u.buf.pos < conf->u.buf.len)
102 return conf->u.buf.buf[conf->u.buf.pos++];
107 static int config_buf_ungetc(int c, struct config_source *conf)
109 if (conf->u.buf.pos > 0) {
111 if (conf->u.buf.buf[conf->u.buf.pos] != c)
112 BUG("config_buf can only ungetc the same character");
119 static long config_buf_ftell(struct config_source *conf)
121 return conf->u.buf.pos;
124 #define MAX_INCLUDE_DEPTH 10
125 static const char include_depth_advice[] = N_(
126 "exceeded maximum include depth (%d) while including\n"
130 "This might be due to circular includes.");
131 static int handle_path_include(const char *path, struct config_include_data *inc)
134 struct strbuf buf = STRBUF_INIT;
138 return config_error_nonbool("include.path");
140 expanded = expand_user_path(path, 0);
142 return error(_("could not expand include path '%s'"), path);
146 * Use an absolute path as-is, but interpret relative paths
147 * based on the including config file.
149 if (!is_absolute_path(path)) {
152 if (!cf || !cf->path)
153 return error(_("relative config includes must come from files"));
155 slash = find_last_dir_sep(cf->path);
157 strbuf_add(&buf, cf->path, slash - cf->path + 1);
158 strbuf_addstr(&buf, path);
162 if (!access_or_die(path, R_OK, 0)) {
163 if (++inc->depth > MAX_INCLUDE_DEPTH)
164 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
166 cf->name ? cf->name :
168 ret = git_config_from_file(git_config_include, path, inc);
171 strbuf_release(&buf);
176 static void add_trailing_starstar_for_dir(struct strbuf *pat)
178 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
179 strbuf_addstr(pat, "**");
182 static int prepare_include_condition_pattern(struct strbuf *pat)
184 struct strbuf path = STRBUF_INIT;
188 expanded = expand_user_path(pat->buf, 1);
191 strbuf_addstr(pat, expanded);
195 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
198 if (!cf || !cf->path)
199 return error(_("relative config include "
200 "conditionals must come from files"));
202 strbuf_realpath(&path, cf->path, 1);
203 slash = find_last_dir_sep(path.buf);
205 BUG("how is this possible?");
206 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
207 prefix = slash - path.buf + 1 /* slash */;
208 } else if (!is_absolute_path(pat->buf))
209 strbuf_insertstr(pat, 0, "**/");
211 add_trailing_starstar_for_dir(pat);
213 strbuf_release(&path);
217 static int include_by_gitdir(const struct config_options *opts,
218 const char *cond, size_t cond_len, int icase)
220 struct strbuf text = STRBUF_INIT;
221 struct strbuf pattern = STRBUF_INIT;
224 int already_tried_absolute = 0;
227 git_dir = opts->git_dir;
231 strbuf_realpath(&text, git_dir, 1);
232 strbuf_add(&pattern, cond, cond_len);
233 prefix = prepare_include_condition_pattern(&pattern);
241 * perform literal matching on the prefix part so that
242 * any wildcard character in it can't create side effects.
244 if (text.len < prefix)
246 if (!icase && strncmp(pattern.buf, text.buf, prefix))
248 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
252 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
253 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
255 if (!ret && !already_tried_absolute) {
257 * We've tried e.g. matching gitdir:~/work, but if
258 * ~/work is a symlink to /mnt/storage/work
259 * strbuf_realpath() will expand it, so the rule won't
260 * match. Let's match against a
261 * strbuf_add_absolute_path() version of the path,
262 * which'll do the right thing
265 strbuf_add_absolute_path(&text, git_dir);
266 already_tried_absolute = 1;
270 strbuf_release(&pattern);
271 strbuf_release(&text);
275 static int include_by_branch(const char *cond, size_t cond_len)
279 struct strbuf pattern = STRBUF_INIT;
280 const char *refname = !the_repository->gitdir ?
281 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
282 const char *shortname;
284 if (!refname || !(flags & REF_ISSYMREF) ||
285 !skip_prefix(refname, "refs/heads/", &shortname))
288 strbuf_add(&pattern, cond, cond_len);
289 add_trailing_starstar_for_dir(&pattern);
290 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
291 strbuf_release(&pattern);
295 static int include_condition_is_true(const struct config_options *opts,
296 const char *cond, size_t cond_len)
299 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
300 return include_by_gitdir(opts, cond, cond_len, 0);
301 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
302 return include_by_gitdir(opts, cond, cond_len, 1);
303 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
304 return include_by_branch(cond, cond_len);
306 /* unknown conditionals are always false */
310 int git_config_include(const char *var, const char *value, void *data)
312 struct config_include_data *inc = data;
313 const char *cond, *key;
318 * Pass along all values, including "include" directives; this makes it
319 * possible to query information on the includes themselves.
321 ret = inc->fn(var, value, inc->data);
325 if (!strcmp(var, "include.path"))
326 ret = handle_path_include(value, inc);
328 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
329 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
330 !strcmp(key, "path"))
331 ret = handle_path_include(value, inc);
336 static void git_config_push_split_parameter(const char *key, const char *value)
338 struct strbuf env = STRBUF_INIT;
339 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
341 strbuf_addstr(&env, old);
342 strbuf_addch(&env, ' ');
344 sq_quote_buf(&env, key);
345 strbuf_addch(&env, '=');
347 sq_quote_buf(&env, value);
348 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
349 strbuf_release(&env);
352 void git_config_push_parameter(const char *text)
359 * section.subsection=with=equals.key=value
361 * we cannot tell if it means:
363 * [section "subsection=with=equals"]
369 * subsection = with=equals.key=value
371 * We parse left-to-right for the first "=", meaning we'll prefer to
372 * keep the value intact over the subsection. This is historical, but
373 * also sensible since values are more likely to contain odd or
374 * untrusted input than a section name.
376 * A missing equals is explicitly allowed (as a bool-only entry).
378 value = strchr(text, '=');
380 char *key = xmemdupz(text, value - text);
381 git_config_push_split_parameter(key, value + 1);
384 git_config_push_split_parameter(text, NULL);
388 void git_config_push_env(const char *spec)
391 const char *env_name;
392 const char *env_value;
394 env_name = strrchr(spec, '=');
396 die(_("invalid config format: %s"), spec);
397 key = xmemdupz(spec, env_name - spec);
400 die(_("missing environment variable name for configuration '%.*s'"),
401 (int)(env_name - spec - 1), spec);
403 env_value = getenv(env_name);
405 die(_("missing environment variable '%s' for configuration '%.*s'"),
406 env_name, (int)(env_name - spec - 1), spec);
408 git_config_push_split_parameter(key, env_value);
412 static inline int iskeychar(int c)
414 return isalnum(c) || c == '-';
418 * Auxiliary function to sanity-check and split the key into the section
419 * identifier and variable name.
421 * Returns 0 on success, -1 when there is an invalid character in the key and
422 * -2 if there is no section name in the key.
424 * store_key - pointer to char* which will hold a copy of the key with
425 * lowercase section and variable name
426 * baselen - pointer to size_t which will hold the length of the
427 * section + subsection part, can be NULL
429 static int git_config_parse_key_1(const char *key, char **store_key, size_t *baselen_, int quiet)
433 const char *last_dot = strrchr(key, '.');
436 * Since "key" actually contains the section name and the real
437 * key name separated by a dot, we have to know where the dot is.
440 if (last_dot == NULL || last_dot == key) {
442 error(_("key does not contain a section: %s"), key);
443 return -CONFIG_NO_SECTION_OR_NAME;
448 error(_("key does not contain variable name: %s"), key);
449 return -CONFIG_NO_SECTION_OR_NAME;
452 baselen = last_dot - key;
457 * Validate the key and while at it, lower case it for matching.
460 *store_key = xmallocz(strlen(key));
463 for (i = 0; key[i]; i++) {
464 unsigned char c = key[i];
467 /* Leave the extended basename untouched.. */
468 if (!dot || i > baselen) {
470 (i == baselen + 1 && !isalpha(c))) {
472 error(_("invalid key: %s"), key);
476 } else if (c == '\n') {
478 error(_("invalid key (newline): %s"), key);
489 FREE_AND_NULL(*store_key);
491 return -CONFIG_INVALID_KEY;
494 int git_config_parse_key(const char *key, char **store_key, size_t *baselen)
496 return git_config_parse_key_1(key, store_key, baselen, 0);
499 int git_config_key_is_valid(const char *key)
501 return !git_config_parse_key_1(key, NULL, NULL, 1);
504 static int config_parse_pair(const char *key, const char *value,
505 config_fn_t fn, void *data)
507 char *canonical_name;
511 return error(_("empty config key"));
512 if (git_config_parse_key(key, &canonical_name, NULL))
515 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
516 free(canonical_name);
520 int git_config_parse_parameter(const char *text,
521 config_fn_t fn, void *data)
524 struct strbuf **pair;
527 pair = strbuf_split_str(text, '=', 2);
529 return error(_("bogus config parameter: %s"), text);
531 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
532 strbuf_setlen(pair[0], pair[0]->len - 1);
533 value = pair[1] ? pair[1]->buf : "";
538 strbuf_trim(pair[0]);
540 strbuf_list_free(pair);
541 return error(_("bogus config parameter: %s"), text);
544 ret = config_parse_pair(pair[0]->buf, value, fn, data);
545 strbuf_list_free(pair);
549 static int parse_config_env_list(char *env, config_fn_t fn, void *data)
552 while (cur && *cur) {
553 const char *key = sq_dequote_step(cur, &cur);
555 return error(_("bogus format in %s"),
556 CONFIG_DATA_ENVIRONMENT);
558 if (!cur || isspace(*cur)) {
559 /* old-style 'key=value' */
560 if (git_config_parse_parameter(key, fn, data) < 0)
563 else if (*cur == '=') {
564 /* new-style 'key'='value' */
570 value = sq_dequote_step(cur, &cur);
571 if (!value || (cur && !isspace(*cur))) {
572 return error(_("bogus format in %s"),
573 CONFIG_DATA_ENVIRONMENT);
575 } else if (!*cur || isspace(*cur)) {
576 /* implicit bool: 'key'= */
579 return error(_("bogus format in %s"),
580 CONFIG_DATA_ENVIRONMENT);
583 if (config_parse_pair(key, value, fn, data) < 0)
588 return error(_("bogus format in %s"),
589 CONFIG_DATA_ENVIRONMENT);
593 while (isspace(*cur))
600 int git_config_from_parameters(config_fn_t fn, void *data)
603 struct strbuf envvar = STRBUF_INIT;
604 struct strvec to_free = STRVEC_INIT;
607 struct config_source source;
609 memset(&source, 0, sizeof(source));
611 source.origin_type = CONFIG_ORIGIN_CMDLINE;
614 env = getenv(CONFIG_COUNT_ENVIRONMENT);
620 count = strtoul(env, &endp, 10);
622 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
625 if (count > INT_MAX) {
626 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
630 for (i = 0; i < count; i++) {
631 const char *key, *value;
633 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
634 key = getenv_safe(&to_free, envvar.buf);
636 ret = error(_("missing config key %s"), envvar.buf);
639 strbuf_reset(&envvar);
641 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
642 value = getenv_safe(&to_free, envvar.buf);
644 ret = error(_("missing config value %s"), envvar.buf);
647 strbuf_reset(&envvar);
649 if (config_parse_pair(key, value, fn, data) < 0) {
656 env = getenv(CONFIG_DATA_ENVIRONMENT);
658 /* sq_dequote will write over it */
660 if (parse_config_env_list(envw, fn, data) < 0) {
667 strbuf_release(&envvar);
668 strvec_clear(&to_free);
674 static int get_next_char(void)
676 int c = cf->do_fgetc(cf);
679 /* DOS like systems */
680 c = cf->do_fgetc(cf);
683 cf->do_ungetc(c, cf);
688 if (c != EOF && ++cf->total_len > INT_MAX) {
690 * This is an absurdly long config file; refuse to parse
691 * further in order to protect downstream code from integer
692 * overflows. Note that we can't return an error specifically,
693 * but we can mark EOF and put trash in the return value,
694 * which will trigger a parse error.
710 static char *parse_value(void)
712 int quote = 0, comment = 0, space = 0;
714 strbuf_reset(&cf->value);
716 int c = get_next_char();
722 return cf->value.buf;
726 if (isspace(c) && !quote) {
732 if (c == ';' || c == '#') {
737 for (; space; space--)
738 strbuf_addch(&cf->value, ' ');
753 /* Some characters escape as themselves */
756 /* Reject unknown escape sequences */
760 strbuf_addch(&cf->value, c);
767 strbuf_addch(&cf->value, c);
771 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
777 /* Get the full name */
784 strbuf_addch(name, tolower(c));
787 while (c == ' ' || c == '\t')
794 value = parse_value();
799 * We already consumed the \n, but we need linenr to point to
800 * the line we just parsed during the call to fn to get
801 * accurate line number in error messages.
804 ret = fn(name->buf, value, data);
810 static int get_extended_base_var(struct strbuf *name, int c)
812 cf->subsection_case_sensitive = 0;
815 goto error_incomplete_line;
817 } while (isspace(c));
819 /* We require the format to be '[base "extension"]' */
822 strbuf_addch(name, '.');
825 int c = get_next_char();
827 goto error_incomplete_line;
833 goto error_incomplete_line;
835 strbuf_addch(name, c);
839 if (get_next_char() != ']')
842 error_incomplete_line:
847 static int get_base_var(struct strbuf *name)
849 cf->subsection_case_sensitive = 1;
851 int c = get_next_char();
857 return get_extended_base_var(name, c);
858 if (!iskeychar(c) && c != '.')
860 strbuf_addch(name, tolower(c));
864 struct parse_event_data {
865 enum config_event_t previous_type;
866 size_t previous_offset;
867 const struct config_options *opts;
870 static int do_event(enum config_event_t type, struct parse_event_data *data)
874 if (!data->opts || !data->opts->event_fn)
877 if (type == CONFIG_EVENT_WHITESPACE &&
878 data->previous_type == type)
881 offset = cf->do_ftell(cf);
883 * At EOF, the parser always "inserts" an extra '\n', therefore
884 * the end offset of the event is the current file position, otherwise
885 * we will already have advanced to the next event.
887 if (type != CONFIG_EVENT_EOF)
890 if (data->previous_type != CONFIG_EVENT_EOF &&
891 data->opts->event_fn(data->previous_type, data->previous_offset,
892 offset, data->opts->event_fn_data) < 0)
895 data->previous_type = type;
896 data->previous_offset = offset;
901 static int git_parse_source(config_fn_t fn, void *data,
902 const struct config_options *opts)
906 struct strbuf *var = &cf->var;
907 int error_return = 0;
908 char *error_msg = NULL;
910 /* U+FEFF Byte Order Mark in UTF8 */
911 const char *bomptr = utf8_bom;
913 /* For the parser event callback */
914 struct parse_event_data event_data = {
915 CONFIG_EVENT_EOF, 0, opts
922 if (bomptr && *bomptr) {
923 /* We are at the file beginning; skip UTF8-encoded BOM
924 * if present. Sane editors won't put this in on their
925 * own, but e.g. Windows Notepad will do it happily. */
926 if (c == (*bomptr & 0377)) {
930 /* Do not tolerate partial BOM. */
931 if (bomptr != utf8_bom)
933 /* No BOM at file beginning. Cool. */
939 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
943 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
951 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
955 if (c == '#' || c == ';') {
956 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
962 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
965 /* Reset prior to determining a new stem */
967 if (get_base_var(var) < 0 || var->len < 1)
969 strbuf_addch(var, '.');
976 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
980 * Truncate the var name back to the section header
981 * stem prior to grabbing the suffix part of the name
984 strbuf_setlen(var, baselen);
985 strbuf_addch(var, tolower(c));
986 if (get_value(fn, data, var) < 0)
990 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
993 switch (cf->origin_type) {
994 case CONFIG_ORIGIN_BLOB:
995 error_msg = xstrfmt(_("bad config line %d in blob %s"),
996 cf->linenr, cf->name);
998 case CONFIG_ORIGIN_FILE:
999 error_msg = xstrfmt(_("bad config line %d in file %s"),
1000 cf->linenr, cf->name);
1002 case CONFIG_ORIGIN_STDIN:
1003 error_msg = xstrfmt(_("bad config line %d in standard input"),
1006 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1007 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1008 cf->linenr, cf->name);
1010 case CONFIG_ORIGIN_CMDLINE:
1011 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1012 cf->linenr, cf->name);
1015 error_msg = xstrfmt(_("bad config line %d in %s"),
1016 cf->linenr, cf->name);
1019 switch (opts && opts->error_action ?
1020 opts->error_action :
1021 cf->default_error_action) {
1022 case CONFIG_ERROR_DIE:
1023 die("%s", error_msg);
1025 case CONFIG_ERROR_ERROR:
1026 error_return = error("%s", error_msg);
1028 case CONFIG_ERROR_SILENT:
1031 case CONFIG_ERROR_UNSET:
1032 BUG("config error action unset");
1036 return error_return;
1039 static uintmax_t get_unit_factor(const char *end)
1043 else if (!strcasecmp(end, "k"))
1045 else if (!strcasecmp(end, "m"))
1047 else if (!strcasecmp(end, "g"))
1048 return 1024 * 1024 * 1024;
1052 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1054 if (value && *value) {
1061 val = strtoimax(value, &end, 0);
1062 if (errno == ERANGE)
1064 factor = get_unit_factor(end);
1069 uval = val < 0 ? -val : val;
1070 if (unsigned_mult_overflows(factor, uval) ||
1071 factor * uval > max) {
1083 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1085 if (value && *value) {
1091 val = strtoumax(value, &end, 0);
1092 if (errno == ERANGE)
1094 factor = get_unit_factor(end);
1099 if (unsigned_mult_overflows(factor, val) ||
1100 factor * val > max) {
1112 static int git_parse_int(const char *value, int *ret)
1115 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1121 static int git_parse_int64(const char *value, int64_t *ret)
1124 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1130 int git_parse_ulong(const char *value, unsigned long *ret)
1133 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1139 int git_parse_ssize_t(const char *value, ssize_t *ret)
1142 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1149 static void die_bad_number(const char *name, const char *value)
1151 const char *error_type = (errno == ERANGE) ?
1152 N_("out of range") : N_("invalid unit");
1153 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1158 if (!strcmp(name, "GIT_TEST_GETTEXT_POISON"))
1160 * We explicitly *don't* use _() here since it would
1161 * cause an infinite loop with _() needing to call
1162 * use_gettext_poison(). This is why marked up
1163 * translations with N_() above.
1165 die(bad_numeric, value, name, error_type);
1167 if (!(cf && cf->name))
1168 die(_(bad_numeric), value, name, _(error_type));
1170 switch (cf->origin_type) {
1171 case CONFIG_ORIGIN_BLOB:
1172 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1173 value, name, cf->name, _(error_type));
1174 case CONFIG_ORIGIN_FILE:
1175 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1176 value, name, cf->name, _(error_type));
1177 case CONFIG_ORIGIN_STDIN:
1178 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1179 value, name, _(error_type));
1180 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1181 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1182 value, name, cf->name, _(error_type));
1183 case CONFIG_ORIGIN_CMDLINE:
1184 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1185 value, name, cf->name, _(error_type));
1187 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1188 value, name, cf->name, _(error_type));
1192 int git_config_int(const char *name, const char *value)
1195 if (!git_parse_int(value, &ret))
1196 die_bad_number(name, value);
1200 int64_t git_config_int64(const char *name, const char *value)
1203 if (!git_parse_int64(value, &ret))
1204 die_bad_number(name, value);
1208 unsigned long git_config_ulong(const char *name, const char *value)
1211 if (!git_parse_ulong(value, &ret))
1212 die_bad_number(name, value);
1216 ssize_t git_config_ssize_t(const char *name, const char *value)
1219 if (!git_parse_ssize_t(value, &ret))
1220 die_bad_number(name, value);
1224 static int git_parse_maybe_bool_text(const char *value)
1230 if (!strcasecmp(value, "true")
1231 || !strcasecmp(value, "yes")
1232 || !strcasecmp(value, "on"))
1234 if (!strcasecmp(value, "false")
1235 || !strcasecmp(value, "no")
1236 || !strcasecmp(value, "off"))
1241 int git_parse_maybe_bool(const char *value)
1243 int v = git_parse_maybe_bool_text(value);
1246 if (git_parse_int(value, &v))
1251 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1253 int v = git_parse_maybe_bool_text(value);
1259 return git_config_int(name, value);
1262 int git_config_bool(const char *name, const char *value)
1265 return !!git_config_bool_or_int(name, value, &discard);
1268 int git_config_string(const char **dest, const char *var, const char *value)
1271 return config_error_nonbool(var);
1272 *dest = xstrdup(value);
1276 int git_config_pathname(const char **dest, const char *var, const char *value)
1279 return config_error_nonbool(var);
1280 *dest = expand_user_path(value, 0);
1282 die(_("failed to expand user dir in: '%s'"), value);
1286 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1289 return config_error_nonbool(var);
1290 if (parse_expiry_date(value, timestamp))
1291 return error(_("'%s' for '%s' is not a valid timestamp"),
1296 int git_config_color(char *dest, const char *var, const char *value)
1299 return config_error_nonbool(var);
1300 if (color_parse(value, dest) < 0)
1305 static int git_default_core_config(const char *var, const char *value, void *cb)
1307 /* This needs a better name */
1308 if (!strcmp(var, "core.filemode")) {
1309 trust_executable_bit = git_config_bool(var, value);
1312 if (!strcmp(var, "core.trustctime")) {
1313 trust_ctime = git_config_bool(var, value);
1316 if (!strcmp(var, "core.checkstat")) {
1317 if (!strcasecmp(value, "default"))
1319 else if (!strcasecmp(value, "minimal"))
1323 if (!strcmp(var, "core.quotepath")) {
1324 quote_path_fully = git_config_bool(var, value);
1328 if (!strcmp(var, "core.symlinks")) {
1329 has_symlinks = git_config_bool(var, value);
1333 if (!strcmp(var, "core.ignorecase")) {
1334 ignore_case = git_config_bool(var, value);
1338 if (!strcmp(var, "core.attributesfile"))
1339 return git_config_pathname(&git_attributes_file, var, value);
1341 if (!strcmp(var, "core.hookspath"))
1342 return git_config_pathname(&git_hooks_path, var, value);
1344 if (!strcmp(var, "core.bare")) {
1345 is_bare_repository_cfg = git_config_bool(var, value);
1349 if (!strcmp(var, "core.ignorestat")) {
1350 assume_unchanged = git_config_bool(var, value);
1354 if (!strcmp(var, "core.prefersymlinkrefs")) {
1355 prefer_symlink_refs = git_config_bool(var, value);
1359 if (!strcmp(var, "core.logallrefupdates")) {
1360 if (value && !strcasecmp(value, "always"))
1361 log_all_ref_updates = LOG_REFS_ALWAYS;
1362 else if (git_config_bool(var, value))
1363 log_all_ref_updates = LOG_REFS_NORMAL;
1365 log_all_ref_updates = LOG_REFS_NONE;
1369 if (!strcmp(var, "core.warnambiguousrefs")) {
1370 warn_ambiguous_refs = git_config_bool(var, value);
1374 if (!strcmp(var, "core.abbrev")) {
1376 return config_error_nonbool(var);
1377 if (!strcasecmp(value, "auto"))
1378 default_abbrev = -1;
1380 int abbrev = git_config_int(var, value);
1381 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1382 return error(_("abbrev length out of range: %d"), abbrev);
1383 default_abbrev = abbrev;
1388 if (!strcmp(var, "core.disambiguate"))
1389 return set_disambiguate_hint_config(var, value);
1391 if (!strcmp(var, "core.loosecompression")) {
1392 int level = git_config_int(var, value);
1394 level = Z_DEFAULT_COMPRESSION;
1395 else if (level < 0 || level > Z_BEST_COMPRESSION)
1396 die(_("bad zlib compression level %d"), level);
1397 zlib_compression_level = level;
1398 zlib_compression_seen = 1;
1402 if (!strcmp(var, "core.compression")) {
1403 int level = git_config_int(var, value);
1405 level = Z_DEFAULT_COMPRESSION;
1406 else if (level < 0 || level > Z_BEST_COMPRESSION)
1407 die(_("bad zlib compression level %d"), level);
1408 core_compression_level = level;
1409 core_compression_seen = 1;
1410 if (!zlib_compression_seen)
1411 zlib_compression_level = level;
1412 if (!pack_compression_seen)
1413 pack_compression_level = level;
1417 if (!strcmp(var, "core.packedgitwindowsize")) {
1418 int pgsz_x2 = getpagesize() * 2;
1419 packed_git_window_size = git_config_ulong(var, value);
1421 /* This value must be multiple of (pagesize * 2) */
1422 packed_git_window_size /= pgsz_x2;
1423 if (packed_git_window_size < 1)
1424 packed_git_window_size = 1;
1425 packed_git_window_size *= pgsz_x2;
1429 if (!strcmp(var, "core.bigfilethreshold")) {
1430 big_file_threshold = git_config_ulong(var, value);
1434 if (!strcmp(var, "core.packedgitlimit")) {
1435 packed_git_limit = git_config_ulong(var, value);
1439 if (!strcmp(var, "core.deltabasecachelimit")) {
1440 delta_base_cache_limit = git_config_ulong(var, value);
1444 if (!strcmp(var, "core.autocrlf")) {
1445 if (value && !strcasecmp(value, "input")) {
1446 auto_crlf = AUTO_CRLF_INPUT;
1449 auto_crlf = git_config_bool(var, value);
1453 if (!strcmp(var, "core.safecrlf")) {
1455 if (value && !strcasecmp(value, "warn")) {
1456 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1459 eol_rndtrp_die = git_config_bool(var, value);
1460 global_conv_flags_eol = eol_rndtrp_die ?
1461 CONV_EOL_RNDTRP_DIE : 0;
1465 if (!strcmp(var, "core.eol")) {
1466 if (value && !strcasecmp(value, "lf"))
1468 else if (value && !strcasecmp(value, "crlf"))
1469 core_eol = EOL_CRLF;
1470 else if (value && !strcasecmp(value, "native"))
1471 core_eol = EOL_NATIVE;
1473 core_eol = EOL_UNSET;
1477 if (!strcmp(var, "core.checkroundtripencoding")) {
1478 check_roundtrip_encoding = xstrdup(value);
1482 if (!strcmp(var, "core.notesref")) {
1483 notes_ref_name = xstrdup(value);
1487 if (!strcmp(var, "core.editor"))
1488 return git_config_string(&editor_program, var, value);
1490 if (!strcmp(var, "core.commentchar")) {
1492 return config_error_nonbool(var);
1493 else if (!strcasecmp(value, "auto"))
1494 auto_comment_line_char = 1;
1495 else if (value[0] && !value[1]) {
1496 comment_line_char = value[0];
1497 auto_comment_line_char = 0;
1499 return error(_("core.commentChar should only be one character"));
1503 if (!strcmp(var, "core.askpass"))
1504 return git_config_string(&askpass_program, var, value);
1506 if (!strcmp(var, "core.excludesfile"))
1507 return git_config_pathname(&excludes_file, var, value);
1509 if (!strcmp(var, "core.whitespace")) {
1511 return config_error_nonbool(var);
1512 whitespace_rule_cfg = parse_whitespace_rule(value);
1516 if (!strcmp(var, "core.fsyncobjectfiles")) {
1517 fsync_object_files = git_config_bool(var, value);
1521 if (!strcmp(var, "core.preloadindex")) {
1522 core_preload_index = git_config_bool(var, value);
1526 if (!strcmp(var, "core.createobject")) {
1527 if (!strcmp(value, "rename"))
1528 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1529 else if (!strcmp(value, "link"))
1530 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1532 die(_("invalid mode for object creation: %s"), value);
1536 if (!strcmp(var, "core.sparsecheckout")) {
1537 core_apply_sparse_checkout = git_config_bool(var, value);
1541 if (!strcmp(var, "core.sparsecheckoutcone")) {
1542 core_sparse_checkout_cone = git_config_bool(var, value);
1546 if (!strcmp(var, "core.precomposeunicode")) {
1547 precomposed_unicode = git_config_bool(var, value);
1551 if (!strcmp(var, "core.protecthfs")) {
1552 protect_hfs = git_config_bool(var, value);
1556 if (!strcmp(var, "core.protectntfs")) {
1557 protect_ntfs = git_config_bool(var, value);
1561 if (!strcmp(var, "core.usereplacerefs")) {
1562 read_replace_refs = git_config_bool(var, value);
1566 /* Add other config variables here and to Documentation/config.txt. */
1567 return platform_core_config(var, value, cb);
1570 static int git_default_i18n_config(const char *var, const char *value)
1572 if (!strcmp(var, "i18n.commitencoding"))
1573 return git_config_string(&git_commit_encoding, var, value);
1575 if (!strcmp(var, "i18n.logoutputencoding"))
1576 return git_config_string(&git_log_output_encoding, var, value);
1578 /* Add other config variables here and to Documentation/config.txt. */
1582 static int git_default_branch_config(const char *var, const char *value)
1584 if (!strcmp(var, "branch.autosetupmerge")) {
1585 if (value && !strcasecmp(value, "always")) {
1586 git_branch_track = BRANCH_TRACK_ALWAYS;
1589 git_branch_track = git_config_bool(var, value);
1592 if (!strcmp(var, "branch.autosetuprebase")) {
1594 return config_error_nonbool(var);
1595 else if (!strcmp(value, "never"))
1596 autorebase = AUTOREBASE_NEVER;
1597 else if (!strcmp(value, "local"))
1598 autorebase = AUTOREBASE_LOCAL;
1599 else if (!strcmp(value, "remote"))
1600 autorebase = AUTOREBASE_REMOTE;
1601 else if (!strcmp(value, "always"))
1602 autorebase = AUTOREBASE_ALWAYS;
1604 return error(_("malformed value for %s"), var);
1608 /* Add other config variables here and to Documentation/config.txt. */
1612 static int git_default_push_config(const char *var, const char *value)
1614 if (!strcmp(var, "push.default")) {
1616 return config_error_nonbool(var);
1617 else if (!strcmp(value, "nothing"))
1618 push_default = PUSH_DEFAULT_NOTHING;
1619 else if (!strcmp(value, "matching"))
1620 push_default = PUSH_DEFAULT_MATCHING;
1621 else if (!strcmp(value, "simple"))
1622 push_default = PUSH_DEFAULT_SIMPLE;
1623 else if (!strcmp(value, "upstream"))
1624 push_default = PUSH_DEFAULT_UPSTREAM;
1625 else if (!strcmp(value, "tracking")) /* deprecated */
1626 push_default = PUSH_DEFAULT_UPSTREAM;
1627 else if (!strcmp(value, "current"))
1628 push_default = PUSH_DEFAULT_CURRENT;
1630 error(_("malformed value for %s: %s"), var, value);
1631 return error(_("must be one of nothing, matching, simple, "
1632 "upstream or current"));
1637 /* Add other config variables here and to Documentation/config.txt. */
1641 static int git_default_mailmap_config(const char *var, const char *value)
1643 if (!strcmp(var, "mailmap.file"))
1644 return git_config_pathname(&git_mailmap_file, var, value);
1645 if (!strcmp(var, "mailmap.blob"))
1646 return git_config_string(&git_mailmap_blob, var, value);
1648 /* Add other config variables here and to Documentation/config.txt. */
1652 int git_default_config(const char *var, const char *value, void *cb)
1654 if (starts_with(var, "core."))
1655 return git_default_core_config(var, value, cb);
1657 if (starts_with(var, "user.") ||
1658 starts_with(var, "author.") ||
1659 starts_with(var, "committer."))
1660 return git_ident_config(var, value, cb);
1662 if (starts_with(var, "i18n."))
1663 return git_default_i18n_config(var, value);
1665 if (starts_with(var, "branch."))
1666 return git_default_branch_config(var, value);
1668 if (starts_with(var, "push."))
1669 return git_default_push_config(var, value);
1671 if (starts_with(var, "mailmap."))
1672 return git_default_mailmap_config(var, value);
1674 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1675 return git_default_advice_config(var, value);
1677 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1678 pager_use_color = git_config_bool(var,value);
1682 if (!strcmp(var, "pack.packsizelimit")) {
1683 pack_size_limit_cfg = git_config_ulong(var, value);
1687 if (!strcmp(var, "pack.compression")) {
1688 int level = git_config_int(var, value);
1690 level = Z_DEFAULT_COMPRESSION;
1691 else if (level < 0 || level > Z_BEST_COMPRESSION)
1692 die(_("bad pack compression level %d"), level);
1693 pack_compression_level = level;
1694 pack_compression_seen = 1;
1698 /* Add other config variables here and to Documentation/config.txt. */
1703 * All source specific fields in the union, die_on_error, name and the callbacks
1704 * fgetc, ungetc, ftell of top need to be initialized before calling
1707 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1708 const struct config_options *opts)
1712 /* push config-file parsing state stack */
1717 strbuf_init(&top->value, 1024);
1718 strbuf_init(&top->var, 1024);
1721 ret = git_parse_source(fn, data, opts);
1723 /* pop config-file parsing state stack */
1724 strbuf_release(&top->value);
1725 strbuf_release(&top->var);
1731 static int do_config_from_file(config_fn_t fn,
1732 const enum config_origin_type origin_type,
1733 const char *name, const char *path, FILE *f,
1734 void *data, const struct config_options *opts)
1736 struct config_source top;
1740 top.origin_type = origin_type;
1743 top.default_error_action = CONFIG_ERROR_DIE;
1744 top.do_fgetc = config_file_fgetc;
1745 top.do_ungetc = config_file_ungetc;
1746 top.do_ftell = config_file_ftell;
1749 ret = do_config_from(&top, fn, data, opts);
1754 static int git_config_from_stdin(config_fn_t fn, void *data)
1756 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1760 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1762 const struct config_options *opts)
1767 f = fopen_or_warn(filename, "r");
1769 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1770 filename, f, data, opts);
1776 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1778 return git_config_from_file_with_options(fn, filename, data, NULL);
1781 int git_config_from_mem(config_fn_t fn,
1782 const enum config_origin_type origin_type,
1783 const char *name, const char *buf, size_t len,
1784 void *data, const struct config_options *opts)
1786 struct config_source top;
1788 top.u.buf.buf = buf;
1789 top.u.buf.len = len;
1791 top.origin_type = origin_type;
1794 top.default_error_action = CONFIG_ERROR_ERROR;
1795 top.do_fgetc = config_buf_fgetc;
1796 top.do_ungetc = config_buf_ungetc;
1797 top.do_ftell = config_buf_ftell;
1799 return do_config_from(&top, fn, data, opts);
1802 int git_config_from_blob_oid(config_fn_t fn,
1804 const struct object_id *oid,
1807 enum object_type type;
1812 buf = read_object_file(oid, &type, &size);
1814 return error(_("unable to load config blob object '%s'"), name);
1815 if (type != OBJ_BLOB) {
1817 return error(_("reference '%s' does not point to a blob"), name);
1820 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1827 static int git_config_from_blob_ref(config_fn_t fn,
1831 struct object_id oid;
1833 if (get_oid(name, &oid) < 0)
1834 return error(_("unable to resolve config blob '%s'"), name);
1835 return git_config_from_blob_oid(fn, name, &oid, data);
1838 const char *git_etc_gitconfig(void)
1840 static const char *system_wide;
1842 system_wide = system_path(ETC_GITCONFIG);
1847 * Parse environment variable 'k' as a boolean (in various
1848 * possible spellings); if missing, use the default value 'def'.
1850 int git_env_bool(const char *k, int def)
1852 const char *v = getenv(k);
1853 return v ? git_config_bool(k, v) : def;
1857 * Parse environment variable 'k' as ulong with possibly a unit
1858 * suffix; if missing, use the default value 'val'.
1860 unsigned long git_env_ulong(const char *k, unsigned long val)
1862 const char *v = getenv(k);
1863 if (v && !git_parse_ulong(v, &val))
1864 die(_("failed to parse %s"), k);
1868 int git_config_system(void)
1870 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1873 static int do_git_config_sequence(const struct config_options *opts,
1874 config_fn_t fn, void *data)
1877 char *xdg_config = xdg_config_home("config");
1878 char *user_config = expand_user_path("~/.gitconfig", 0);
1880 enum config_scope prev_parsing_scope = current_parsing_scope;
1882 if (opts->commondir)
1883 repo_config = mkpathdup("%s/config", opts->commondir);
1884 else if (opts->git_dir)
1885 BUG("git_dir without commondir");
1889 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1890 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK,
1891 opts->system_gently ?
1892 ACCESS_EACCES_OK : 0))
1893 ret += git_config_from_file(fn, git_etc_gitconfig(),
1896 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1897 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1898 ret += git_config_from_file(fn, xdg_config, data);
1900 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1901 ret += git_config_from_file(fn, user_config, data);
1903 current_parsing_scope = CONFIG_SCOPE_LOCAL;
1904 if (!opts->ignore_repo && repo_config &&
1905 !access_or_die(repo_config, R_OK, 0))
1906 ret += git_config_from_file(fn, repo_config, data);
1908 current_parsing_scope = CONFIG_SCOPE_WORKTREE;
1909 if (!opts->ignore_worktree && repository_format_worktree_config) {
1910 char *path = git_pathdup("config.worktree");
1911 if (!access_or_die(path, R_OK, 0))
1912 ret += git_config_from_file(fn, path, data);
1916 current_parsing_scope = CONFIG_SCOPE_COMMAND;
1917 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
1918 die(_("unable to parse command-line config"));
1920 current_parsing_scope = prev_parsing_scope;
1927 int config_with_options(config_fn_t fn, void *data,
1928 struct git_config_source *config_source,
1929 const struct config_options *opts)
1931 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1933 if (opts->respect_includes) {
1937 fn = git_config_include;
1942 current_parsing_scope = config_source->scope;
1945 * If we have a specific filename, use it. Otherwise, follow the
1946 * regular lookup sequence.
1948 if (config_source && config_source->use_stdin)
1949 return git_config_from_stdin(fn, data);
1950 else if (config_source && config_source->file)
1951 return git_config_from_file(fn, config_source->file, data);
1952 else if (config_source && config_source->blob)
1953 return git_config_from_blob_ref(fn, config_source->blob, data);
1955 return do_git_config_sequence(opts, fn, data);
1958 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1961 struct string_list *values;
1962 struct config_set_element *entry;
1963 struct configset_list *list = &cs->list;
1965 for (i = 0; i < list->nr; i++) {
1966 entry = list->items[i].e;
1967 value_index = list->items[i].value_index;
1968 values = &entry->value_list;
1970 current_config_kvi = values->items[value_index].util;
1972 if (fn(entry->key, values->items[value_index].string, data) < 0)
1973 git_die_config_linenr(entry->key,
1974 current_config_kvi->filename,
1975 current_config_kvi->linenr);
1977 current_config_kvi = NULL;
1981 void read_early_config(config_fn_t cb, void *data)
1983 struct config_options opts = {0};
1984 struct strbuf commondir = STRBUF_INIT;
1985 struct strbuf gitdir = STRBUF_INIT;
1987 opts.respect_includes = 1;
1989 if (have_git_dir()) {
1990 opts.commondir = get_git_common_dir();
1991 opts.git_dir = get_git_dir();
1993 * When setup_git_directory() was not yet asked to discover the
1994 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1995 * is any repository config we should use (but unlike
1996 * setup_git_directory_gently(), no global state is changed, most
1997 * notably, the current working directory is still the same after the
2000 } else if (!discover_git_directory(&commondir, &gitdir)) {
2001 opts.commondir = commondir.buf;
2002 opts.git_dir = gitdir.buf;
2005 config_with_options(cb, data, NULL, &opts);
2007 strbuf_release(&commondir);
2008 strbuf_release(&gitdir);
2012 * Read config but only enumerate system and global settings.
2013 * Omit any repo-local, worktree-local, or command-line settings.
2015 void read_very_early_config(config_fn_t cb, void *data)
2017 struct config_options opts = { 0 };
2019 opts.respect_includes = 1;
2020 opts.ignore_repo = 1;
2021 opts.ignore_worktree = 1;
2022 opts.ignore_cmdline = 1;
2023 opts.system_gently = 1;
2025 config_with_options(cb, data, NULL, &opts);
2028 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
2030 struct config_set_element k;
2031 struct config_set_element *found_entry;
2032 char *normalized_key;
2034 * `key` may come from the user, so normalize it before using it
2035 * for querying entries from the hashmap.
2037 if (git_config_parse_key(key, &normalized_key, NULL))
2040 hashmap_entry_init(&k.ent, strhash(normalized_key));
2041 k.key = normalized_key;
2042 found_entry = hashmap_get_entry(&cs->config_hash, &k, ent, NULL);
2043 free(normalized_key);
2047 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
2049 struct config_set_element *e;
2050 struct string_list_item *si;
2051 struct configset_list_item *l_item;
2052 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2054 e = configset_find_element(cs, key);
2056 * Since the keys are being fed by git_config*() callback mechanism, they
2057 * are already normalized. So simply add them without any further munging.
2060 e = xmalloc(sizeof(*e));
2061 hashmap_entry_init(&e->ent, strhash(key));
2062 e->key = xstrdup(key);
2063 string_list_init(&e->value_list, 1);
2064 hashmap_add(&cs->config_hash, &e->ent);
2066 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2068 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
2069 l_item = &cs->list.items[cs->list.nr++];
2071 l_item->value_index = e->value_list.nr - 1;
2074 BUG("configset_add_value has no source");
2076 kv_info->filename = strintern(cf->name);
2077 kv_info->linenr = cf->linenr;
2078 kv_info->origin_type = cf->origin_type;
2080 /* for values read from `git_config_from_parameters()` */
2081 kv_info->filename = NULL;
2082 kv_info->linenr = -1;
2083 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
2085 kv_info->scope = current_parsing_scope;
2091 static int config_set_element_cmp(const void *unused_cmp_data,
2092 const struct hashmap_entry *eptr,
2093 const struct hashmap_entry *entry_or_key,
2094 const void *unused_keydata)
2096 const struct config_set_element *e1, *e2;
2098 e1 = container_of(eptr, const struct config_set_element, ent);
2099 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2101 return strcmp(e1->key, e2->key);
2104 void git_configset_init(struct config_set *cs)
2106 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
2107 cs->hash_initialized = 1;
2110 cs->list.items = NULL;
2113 void git_configset_clear(struct config_set *cs)
2115 struct config_set_element *entry;
2116 struct hashmap_iter iter;
2117 if (!cs->hash_initialized)
2120 hashmap_for_each_entry(&cs->config_hash, &iter, entry,
2121 ent /* member name */) {
2123 string_list_clear(&entry->value_list, 1);
2125 hashmap_clear_and_free(&cs->config_hash, struct config_set_element, ent);
2126 cs->hash_initialized = 0;
2127 free(cs->list.items);
2130 cs->list.items = NULL;
2133 static int config_set_callback(const char *key, const char *value, void *cb)
2135 struct config_set *cs = cb;
2136 configset_add_value(cs, key, value);
2140 int git_configset_add_file(struct config_set *cs, const char *filename)
2142 return git_config_from_file(config_set_callback, filename, cs);
2145 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
2147 const struct string_list *values = NULL;
2149 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2150 * queried key in the files of the configset, the value returned will be the last
2151 * value in the value list for that key.
2153 values = git_configset_get_value_multi(cs, key);
2157 assert(values->nr > 0);
2158 *value = values->items[values->nr - 1].string;
2162 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
2164 struct config_set_element *e = configset_find_element(cs, key);
2165 return e ? &e->value_list : NULL;
2168 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
2171 if (!git_configset_get_value(cs, key, &value))
2172 return git_config_string((const char **)dest, key, value);
2177 int git_configset_get_string_tmp(struct config_set *cs, const char *key,
2181 if (!git_configset_get_value(cs, key, &value)) {
2183 return config_error_nonbool(key);
2191 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
2194 if (!git_configset_get_value(cs, key, &value)) {
2195 *dest = git_config_int(key, value);
2201 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
2204 if (!git_configset_get_value(cs, key, &value)) {
2205 *dest = git_config_ulong(key, value);
2211 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
2214 if (!git_configset_get_value(cs, key, &value)) {
2215 *dest = git_config_bool(key, value);
2221 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
2222 int *is_bool, int *dest)
2225 if (!git_configset_get_value(cs, key, &value)) {
2226 *dest = git_config_bool_or_int(key, value, is_bool);
2232 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2235 if (!git_configset_get_value(cs, key, &value)) {
2236 *dest = git_parse_maybe_bool(value);
2244 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2247 if (!git_configset_get_value(cs, key, &value))
2248 return git_config_pathname(dest, key, value);
2253 /* Functions use to read configuration from a repository */
2254 static void repo_read_config(struct repository *repo)
2256 struct config_options opts = { 0 };
2258 opts.respect_includes = 1;
2259 opts.commondir = repo->commondir;
2260 opts.git_dir = repo->gitdir;
2263 repo->config = xcalloc(1, sizeof(struct config_set));
2265 git_configset_clear(repo->config);
2267 git_configset_init(repo->config);
2269 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2271 * config_with_options() normally returns only
2272 * zero, as most errors are fatal, and
2273 * non-fatal potential errors are guarded by "if"
2274 * statements that are entered only when no error is
2277 * If we ever encounter a non-fatal error, it means
2278 * something went really wrong and we should stop
2281 die(_("unknown error occurred while reading the configuration files"));
2284 static void git_config_check_init(struct repository *repo)
2286 if (repo->config && repo->config->hash_initialized)
2288 repo_read_config(repo);
2291 static void repo_config_clear(struct repository *repo)
2293 if (!repo->config || !repo->config->hash_initialized)
2295 git_configset_clear(repo->config);
2298 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2300 git_config_check_init(repo);
2301 configset_iter(repo->config, fn, data);
2304 int repo_config_get_value(struct repository *repo,
2305 const char *key, const char **value)
2307 git_config_check_init(repo);
2308 return git_configset_get_value(repo->config, key, value);
2311 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2314 git_config_check_init(repo);
2315 return git_configset_get_value_multi(repo->config, key);
2318 int repo_config_get_string(struct repository *repo,
2319 const char *key, char **dest)
2322 git_config_check_init(repo);
2323 ret = git_configset_get_string(repo->config, key, dest);
2325 git_die_config(key, NULL);
2329 int repo_config_get_string_tmp(struct repository *repo,
2330 const char *key, const char **dest)
2333 git_config_check_init(repo);
2334 ret = git_configset_get_string_tmp(repo->config, key, dest);
2336 git_die_config(key, NULL);
2340 int repo_config_get_int(struct repository *repo,
2341 const char *key, int *dest)
2343 git_config_check_init(repo);
2344 return git_configset_get_int(repo->config, key, dest);
2347 int repo_config_get_ulong(struct repository *repo,
2348 const char *key, unsigned long *dest)
2350 git_config_check_init(repo);
2351 return git_configset_get_ulong(repo->config, key, dest);
2354 int repo_config_get_bool(struct repository *repo,
2355 const char *key, int *dest)
2357 git_config_check_init(repo);
2358 return git_configset_get_bool(repo->config, key, dest);
2361 int repo_config_get_bool_or_int(struct repository *repo,
2362 const char *key, int *is_bool, int *dest)
2364 git_config_check_init(repo);
2365 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2368 int repo_config_get_maybe_bool(struct repository *repo,
2369 const char *key, int *dest)
2371 git_config_check_init(repo);
2372 return git_configset_get_maybe_bool(repo->config, key, dest);
2375 int repo_config_get_pathname(struct repository *repo,
2376 const char *key, const char **dest)
2379 git_config_check_init(repo);
2380 ret = git_configset_get_pathname(repo->config, key, dest);
2382 git_die_config(key, NULL);
2386 /* Functions used historically to read configuration from 'the_repository' */
2387 void git_config(config_fn_t fn, void *data)
2389 repo_config(the_repository, fn, data);
2392 void git_config_clear(void)
2394 repo_config_clear(the_repository);
2397 int git_config_get_value(const char *key, const char **value)
2399 return repo_config_get_value(the_repository, key, value);
2402 const struct string_list *git_config_get_value_multi(const char *key)
2404 return repo_config_get_value_multi(the_repository, key);
2407 int git_config_get_string(const char *key, char **dest)
2409 return repo_config_get_string(the_repository, key, dest);
2412 int git_config_get_string_tmp(const char *key, const char **dest)
2414 return repo_config_get_string_tmp(the_repository, key, dest);
2417 int git_config_get_int(const char *key, int *dest)
2419 return repo_config_get_int(the_repository, key, dest);
2422 int git_config_get_ulong(const char *key, unsigned long *dest)
2424 return repo_config_get_ulong(the_repository, key, dest);
2427 int git_config_get_bool(const char *key, int *dest)
2429 return repo_config_get_bool(the_repository, key, dest);
2432 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2434 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2437 int git_config_get_maybe_bool(const char *key, int *dest)
2439 return repo_config_get_maybe_bool(the_repository, key, dest);
2442 int git_config_get_pathname(const char *key, const char **dest)
2444 return repo_config_get_pathname(the_repository, key, dest);
2447 int git_config_get_expiry(const char *key, const char **output)
2449 int ret = git_config_get_string(key, (char **)output);
2452 if (strcmp(*output, "now")) {
2453 timestamp_t now = approxidate("now");
2454 if (approxidate(*output) >= now)
2455 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2460 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2462 const char *expiry_string;
2466 if (git_config_get_string_tmp(key, &expiry_string))
2467 return 1; /* no such thing */
2469 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2470 const int scale = 86400;
2471 *expiry = now - days * scale;
2475 if (!parse_expiry_date(expiry_string, &when)) {
2479 return -1; /* thing exists but cannot be parsed */
2482 int git_config_get_split_index(void)
2486 if (!git_config_get_maybe_bool("core.splitindex", &val))
2489 return -1; /* default value */
2492 int git_config_get_max_percent_split_change(void)
2496 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2497 if (0 <= val && val <= 100)
2500 return error(_("splitIndex.maxPercentChange value '%d' "
2501 "should be between 0 and 100"), val);
2504 return -1; /* default value */
2507 int git_config_get_fsmonitor(void)
2509 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2510 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2512 if (core_fsmonitor && !*core_fsmonitor)
2513 core_fsmonitor = NULL;
2521 int git_config_get_index_threads(int *dest)
2525 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2531 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2533 *dest = val ? 0 : 1;
2543 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2546 die(_("unable to parse '%s' from command-line config"), key);
2548 die(_("bad config variable '%s' in file '%s' at line %d"),
2549 key, filename, linenr);
2552 NORETURN __attribute__((format(printf, 2, 3)))
2553 void git_die_config(const char *key, const char *err, ...)
2555 const struct string_list *values;
2556 struct key_value_info *kv_info;
2560 va_start(params, err);
2561 vreportf("error: ", err, params);
2564 values = git_config_get_value_multi(key);
2565 kv_info = values->items[values->nr - 1].util;
2566 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2570 * Find all the stuff for git_config_set() below.
2573 struct config_store_data {
2577 regex_t *value_regex;
2581 enum config_event_t type;
2582 int is_keys_section;
2584 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2585 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2588 static void config_store_data_clear(struct config_store_data *store)
2591 if (store->value_regex != NULL &&
2592 store->value_regex != CONFIG_REGEX_NONE) {
2593 regfree(store->value_regex);
2594 free(store->value_regex);
2596 free(store->parsed);
2598 memset(store, 0, sizeof(*store));
2601 static int matches(const char *key, const char *value,
2602 const struct config_store_data *store)
2604 if (strcmp(key, store->key))
2605 return 0; /* not ours */
2606 if (!store->value_regex)
2607 return 1; /* always matches */
2608 if (store->value_regex == CONFIG_REGEX_NONE)
2609 return 0; /* never matches */
2611 return store->do_not_match ^
2612 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2615 static int store_aux_event(enum config_event_t type,
2616 size_t begin, size_t end, void *data)
2618 struct config_store_data *store = data;
2620 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2621 store->parsed[store->parsed_nr].begin = begin;
2622 store->parsed[store->parsed_nr].end = end;
2623 store->parsed[store->parsed_nr].type = type;
2625 if (type == CONFIG_EVENT_SECTION) {
2626 int (*cmpfn)(const char *, const char *, size_t);
2628 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2629 return error(_("invalid section name '%s'"), cf->var.buf);
2631 if (cf->subsection_case_sensitive)
2632 cmpfn = strncasecmp;
2636 /* Is this the section we were looking for? */
2637 store->is_keys_section =
2638 store->parsed[store->parsed_nr].is_keys_section =
2639 cf->var.len - 1 == store->baselen &&
2640 !cmpfn(cf->var.buf, store->key, store->baselen);
2641 if (store->is_keys_section) {
2642 store->section_seen = 1;
2643 ALLOC_GROW(store->seen, store->seen_nr + 1,
2645 store->seen[store->seen_nr] = store->parsed_nr;
2654 static int store_aux(const char *key, const char *value, void *cb)
2656 struct config_store_data *store = cb;
2658 if (store->key_seen) {
2659 if (matches(key, value, store)) {
2660 if (store->seen_nr == 1 && store->multi_replace == 0) {
2661 warning(_("%s has multiple values"), key);
2664 ALLOC_GROW(store->seen, store->seen_nr + 1,
2667 store->seen[store->seen_nr] = store->parsed_nr;
2670 } else if (store->is_keys_section) {
2672 * Do not increment matches yet: this may not be a match, but we
2673 * are in the desired section.
2675 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2676 store->seen[store->seen_nr] = store->parsed_nr;
2677 store->section_seen = 1;
2679 if (matches(key, value, store)) {
2681 store->key_seen = 1;
2688 static int write_error(const char *filename)
2690 error(_("failed to write new configuration file %s"), filename);
2692 /* Same error code as "failed to rename". */
2696 static struct strbuf store_create_section(const char *key,
2697 const struct config_store_data *store)
2701 struct strbuf sb = STRBUF_INIT;
2703 dot = memchr(key, '.', store->baselen);
2705 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2706 for (i = dot - key + 1; i < store->baselen; i++) {
2707 if (key[i] == '"' || key[i] == '\\')
2708 strbuf_addch(&sb, '\\');
2709 strbuf_addch(&sb, key[i]);
2711 strbuf_addstr(&sb, "\"]\n");
2713 strbuf_addch(&sb, '[');
2714 strbuf_add(&sb, key, store->baselen);
2715 strbuf_addstr(&sb, "]\n");
2721 static ssize_t write_section(int fd, const char *key,
2722 const struct config_store_data *store)
2724 struct strbuf sb = store_create_section(key, store);
2727 ret = write_in_full(fd, sb.buf, sb.len);
2728 strbuf_release(&sb);
2733 static ssize_t write_pair(int fd, const char *key, const char *value,
2734 const struct config_store_data *store)
2738 const char *quote = "";
2739 struct strbuf sb = STRBUF_INIT;
2742 * Check to see if the value needs to be surrounded with a dq pair.
2743 * Note that problematic characters are always backslash-quoted; this
2744 * check is about not losing leading or trailing SP and strings that
2745 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2746 * configuration parser.
2748 if (value[0] == ' ')
2750 for (i = 0; value[i]; i++)
2751 if (value[i] == ';' || value[i] == '#')
2753 if (i && value[i - 1] == ' ')
2756 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
2758 for (i = 0; value[i]; i++)
2761 strbuf_addstr(&sb, "\\n");
2764 strbuf_addstr(&sb, "\\t");
2768 strbuf_addch(&sb, '\\');
2771 strbuf_addch(&sb, value[i]);
2774 strbuf_addf(&sb, "%s\n", quote);
2776 ret = write_in_full(fd, sb.buf, sb.len);
2777 strbuf_release(&sb);
2783 * If we are about to unset the last key(s) in a section, and if there are
2784 * no comments surrounding (or included in) the section, we will want to
2785 * extend begin/end to remove the entire section.
2787 * Note: the parameter `seen_ptr` points to the index into the store.seen
2788 * array. * This index may be incremented if a section has more than one
2789 * entry (which all are to be removed).
2791 static void maybe_remove_section(struct config_store_data *store,
2792 size_t *begin_offset, size_t *end_offset,
2796 int i, seen, section_seen = 0;
2799 * First, ensure that this is the first key, and that there are no
2800 * comments before the entry nor before the section header.
2803 for (i = store->seen[seen]; i > 0; i--) {
2804 enum config_event_t type = store->parsed[i - 1].type;
2806 if (type == CONFIG_EVENT_COMMENT)
2807 /* There is a comment before this entry or section */
2809 if (type == CONFIG_EVENT_ENTRY) {
2811 /* This is not the section's first entry. */
2813 /* We encountered no comment before the section. */
2816 if (type == CONFIG_EVENT_SECTION) {
2817 if (!store->parsed[i - 1].is_keys_section)
2822 begin = store->parsed[i].begin;
2825 * Next, make sure that we are removing he last key(s) in the section,
2826 * and that there are no comments that are possibly about the current
2829 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2830 enum config_event_t type = store->parsed[i].type;
2832 if (type == CONFIG_EVENT_COMMENT)
2834 if (type == CONFIG_EVENT_SECTION) {
2835 if (store->parsed[i].is_keys_section)
2839 if (type == CONFIG_EVENT_ENTRY) {
2840 if (++seen < store->seen_nr &&
2841 i == store->seen[seen])
2842 /* We want to remove this entry, too */
2844 /* There is another entry in this section. */
2850 * We are really removing the last entry/entries from this section, and
2851 * there are no enclosed or surrounding comments. Remove the entire,
2852 * now-empty section.
2855 *begin_offset = begin;
2856 if (i < store->parsed_nr)
2857 *end_offset = store->parsed[i].begin;
2859 *end_offset = store->parsed[store->parsed_nr - 1].end;
2862 int git_config_set_in_file_gently(const char *config_filename,
2863 const char *key, const char *value)
2865 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2868 void git_config_set_in_file(const char *config_filename,
2869 const char *key, const char *value)
2871 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2874 int git_config_set_gently(const char *key, const char *value)
2876 return git_config_set_multivar_gently(key, value, NULL, 0);
2879 void git_config_set(const char *key, const char *value)
2881 git_config_set_multivar(key, value, NULL, 0);
2883 trace2_cmd_set_config(key, value);
2887 * If value==NULL, unset in (remove from) config,
2888 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2889 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2890 * (only add a new one)
2891 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2892 * else all matching key/values (regardless how many) are removed,
2893 * before the new pair is written.
2895 * Returns 0 on success.
2897 * This function does this:
2899 * - it locks the config file by creating ".git/config.lock"
2901 * - it then parses the config using store_aux() as validator to find
2902 * the position on the key/value pair to replace. If it is to be unset,
2903 * it must be found exactly once.
2905 * - the config file is mmap()ed and the part before the match (if any) is
2906 * written to the lock file, then the changed part and the rest.
2908 * - the config file is removed and the lock file rename()d to it.
2911 int git_config_set_multivar_in_file_gently(const char *config_filename,
2912 const char *key, const char *value,
2913 const char *value_regex,
2916 int fd = -1, in_fd = -1;
2918 struct lock_file lock = LOCK_INIT;
2919 char *filename_buf = NULL;
2920 char *contents = NULL;
2922 struct config_store_data store;
2924 memset(&store, 0, sizeof(store));
2926 /* parse-key returns negative; flip the sign to feed exit(3) */
2927 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2931 store.multi_replace = multi_replace;
2933 if (!config_filename)
2934 config_filename = filename_buf = git_pathdup("config");
2937 * The lock serves a purpose in addition to locking: the new
2938 * contents of .git/config will be written into it.
2940 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2942 error_errno(_("could not lock config file %s"), config_filename);
2943 ret = CONFIG_NO_LOCK;
2948 * If .git/config does not exist yet, write a minimal version.
2950 in_fd = open(config_filename, O_RDONLY);
2952 if ( ENOENT != errno ) {
2953 error_errno(_("opening %s"), config_filename);
2954 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2957 /* if nothing to unset, error out */
2958 if (value == NULL) {
2959 ret = CONFIG_NOTHING_SET;
2964 store.key = xstrdup(key);
2965 if (write_section(fd, key, &store) < 0 ||
2966 write_pair(fd, key, value, &store) < 0)
2970 size_t copy_begin, copy_end;
2971 int i, new_line = 0;
2972 struct config_options opts;
2974 if (value_regex == NULL)
2975 store.value_regex = NULL;
2976 else if (value_regex == CONFIG_REGEX_NONE)
2977 store.value_regex = CONFIG_REGEX_NONE;
2979 if (value_regex[0] == '!') {
2980 store.do_not_match = 1;
2983 store.do_not_match = 0;
2985 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2986 if (regcomp(store.value_regex, value_regex,
2988 error(_("invalid pattern: %s"), value_regex);
2989 FREE_AND_NULL(store.value_regex);
2990 ret = CONFIG_INVALID_PATTERN;
2995 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2996 store.parsed[0].end = 0;
2998 memset(&opts, 0, sizeof(opts));
2999 opts.event_fn = store_aux_event;
3000 opts.event_fn_data = &store;
3003 * After this, store.parsed will contain offsets of all the
3004 * parsed elements, and store.seen will contain a list of
3005 * matches, as indices into store.parsed.
3007 * As a side effect, we make sure to transform only a valid
3008 * existing config file.
3010 if (git_config_from_file_with_options(store_aux,
3013 error(_("invalid config file %s"), config_filename);
3014 ret = CONFIG_INVALID_FILE;
3018 /* if nothing to unset, or too many matches, error out */
3019 if ((store.seen_nr == 0 && value == NULL) ||
3020 (store.seen_nr > 1 && multi_replace == 0)) {
3021 ret = CONFIG_NOTHING_SET;
3025 if (fstat(in_fd, &st) == -1) {
3026 error_errno(_("fstat on %s failed"), config_filename);
3027 ret = CONFIG_INVALID_FILE;
3031 contents_sz = xsize_t(st.st_size);
3032 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3033 MAP_PRIVATE, in_fd, 0);
3034 if (contents == MAP_FAILED) {
3035 if (errno == ENODEV && S_ISDIR(st.st_mode))
3037 error_errno(_("unable to mmap '%s'"), config_filename);
3038 ret = CONFIG_INVALID_FILE;
3045 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3046 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3047 ret = CONFIG_NO_WRITE;
3051 if (store.seen_nr == 0) {
3052 if (!store.seen_alloc) {
3053 /* Did not see key nor section */
3054 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3055 store.seen[0] = store.parsed_nr
3056 - !!store.parsed_nr;
3061 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3063 int j = store.seen[i];
3066 if (!store.key_seen) {
3067 copy_end = store.parsed[j].end;
3068 /* include '\n' when copying section header */
3069 if (copy_end > 0 && copy_end < contents_sz &&
3070 contents[copy_end - 1] != '\n' &&
3071 contents[copy_end] == '\n')
3073 replace_end = copy_end;
3075 replace_end = store.parsed[j].end;
3076 copy_end = store.parsed[j].begin;
3078 maybe_remove_section(&store,
3082 * Swallow preceding white-space on the same
3085 while (copy_end > 0 ) {
3086 char c = contents[copy_end - 1];
3088 if (isspace(c) && c != '\n')
3095 if (copy_end > 0 && contents[copy_end-1] != '\n')
3098 /* write the first part of the config */
3099 if (copy_end > copy_begin) {
3100 if (write_in_full(fd, contents + copy_begin,
3101 copy_end - copy_begin) < 0)
3104 write_str_in_full(fd, "\n") < 0)
3107 copy_begin = replace_end;
3110 /* write the pair (value == NULL means unset) */
3111 if (value != NULL) {
3112 if (!store.section_seen) {
3113 if (write_section(fd, key, &store) < 0)
3116 if (write_pair(fd, key, value, &store) < 0)
3120 /* write the rest of the config */
3121 if (copy_begin < contents_sz)
3122 if (write_in_full(fd, contents + copy_begin,
3123 contents_sz - copy_begin) < 0)
3126 munmap(contents, contents_sz);
3130 if (commit_lock_file(&lock) < 0) {
3131 error_errno(_("could not write config file %s"), config_filename);
3132 ret = CONFIG_NO_WRITE;
3138 /* Invalidate the config cache */
3142 rollback_lock_file(&lock);
3145 munmap(contents, contents_sz);
3148 config_store_data_clear(&store);
3152 ret = write_error(get_lock_file_path(&lock));
3157 void git_config_set_multivar_in_file(const char *config_filename,
3158 const char *key, const char *value,
3159 const char *value_regex, int multi_replace)
3161 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3162 value_regex, multi_replace))
3165 die(_("could not set '%s' to '%s'"), key, value);
3167 die(_("could not unset '%s'"), key);
3170 int git_config_set_multivar_gently(const char *key, const char *value,
3171 const char *value_regex, int multi_replace)
3173 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
3177 void git_config_set_multivar(const char *key, const char *value,
3178 const char *value_regex, int multi_replace)
3180 git_config_set_multivar_in_file(NULL, key, value, value_regex,
3184 static int section_name_match (const char *buf, const char *name)
3186 int i = 0, j = 0, dot = 0;
3189 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3190 if (!dot && isspace(buf[i])) {
3192 if (name[j++] != '.')
3194 for (i++; isspace(buf[i]); i++)
3200 if (buf[i] == '\\' && dot)
3202 else if (buf[i] == '"' && dot) {
3203 for (i++; isspace(buf[i]); i++)
3207 if (buf[i] != name[j++])
3210 if (buf[i] == ']' && name[j] == 0) {
3212 * We match, now just find the right length offset by
3213 * gobbling up any whitespace after it, as well
3216 for (; buf[i] && isspace(buf[i]); i++)
3223 static int section_name_is_ok(const char *name)
3225 /* Empty section names are bogus. */
3230 * Before a dot, we must be alphanumeric or dash. After the first dot,
3231 * anything goes, so we can stop checking.
3233 for (; *name && *name != '.'; name++)
3234 if (*name != '-' && !isalnum(*name))
3239 /* if new_name == NULL, the section is removed instead */
3240 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3241 const char *old_name,
3242 const char *new_name, int copy)
3244 int ret = 0, remove = 0;
3245 char *filename_buf = NULL;
3246 struct lock_file lock = LOCK_INIT;
3249 FILE *config_file = NULL;
3251 struct strbuf copystr = STRBUF_INIT;
3252 struct config_store_data store;
3254 memset(&store, 0, sizeof(store));
3256 if (new_name && !section_name_is_ok(new_name)) {
3257 ret = error(_("invalid section name: %s"), new_name);
3258 goto out_no_rollback;
3261 if (!config_filename)
3262 config_filename = filename_buf = git_pathdup("config");
3264 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3266 ret = error(_("could not lock config file %s"), config_filename);
3270 if (!(config_file = fopen(config_filename, "rb"))) {
3271 ret = warn_on_fopen_errors(config_filename);
3274 /* no config file means nothing to rename, no error */
3275 goto commit_and_out;
3278 if (fstat(fileno(config_file), &st) == -1) {
3279 ret = error_errno(_("fstat on %s failed"), config_filename);
3283 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3284 ret = error_errno(_("chmod on %s failed"),
3285 get_lock_file_path(&lock));
3289 while (fgets(buf, sizeof(buf), config_file)) {
3294 for (i = 0; buf[i] && isspace(buf[i]); i++)
3296 if (buf[i] == '[') {
3297 /* it's a section */
3302 * When encountering a new section under -c we
3303 * need to flush out any section we're already
3304 * coping and begin anew. There might be
3305 * multiple [branch "$name"] sections.
3307 if (copystr.len > 0) {
3308 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3309 ret = write_error(get_lock_file_path(&lock));
3312 strbuf_reset(©str);
3315 offset = section_name_match(&buf[i], old_name);
3318 if (new_name == NULL) {
3322 store.baselen = strlen(new_name);
3324 if (write_section(out_fd, new_name, &store) < 0) {
3325 ret = write_error(get_lock_file_path(&lock));
3329 * We wrote out the new section, with
3330 * a newline, now skip the old
3333 output += offset + i;
3334 if (strlen(output) > 0) {
3336 * More content means there's
3337 * a declaration to put on the
3338 * next line; indent with a
3345 copystr = store_create_section(new_name, &store);
3352 length = strlen(output);
3354 if (!is_section && copystr.len > 0) {
3355 strbuf_add(©str, output, length);
3358 if (write_in_full(out_fd, output, length) < 0) {
3359 ret = write_error(get_lock_file_path(&lock));
3365 * Copy a trailing section at the end of the config, won't be
3366 * flushed by the usual "flush because we have a new section
3367 * logic in the loop above.
3369 if (copystr.len > 0) {
3370 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3371 ret = write_error(get_lock_file_path(&lock));
3374 strbuf_reset(©str);
3377 fclose(config_file);
3380 if (commit_lock_file(&lock) < 0)
3381 ret = error_errno(_("could not write config file %s"),
3385 fclose(config_file);
3386 rollback_lock_file(&lock);
3389 config_store_data_clear(&store);
3393 int git_config_rename_section_in_file(const char *config_filename,
3394 const char *old_name, const char *new_name)
3396 return git_config_copy_or_rename_section_in_file(config_filename,
3397 old_name, new_name, 0);
3400 int git_config_rename_section(const char *old_name, const char *new_name)
3402 return git_config_rename_section_in_file(NULL, old_name, new_name);
3405 int git_config_copy_section_in_file(const char *config_filename,
3406 const char *old_name, const char *new_name)
3408 return git_config_copy_or_rename_section_in_file(config_filename,
3409 old_name, new_name, 1);
3412 int git_config_copy_section(const char *old_name, const char *new_name)
3414 return git_config_copy_section_in_file(NULL, old_name, new_name);
3418 * Call this to report error for your variable that should not
3419 * get a boolean value (i.e. "[my] var" means "true").
3421 #undef config_error_nonbool
3422 int config_error_nonbool(const char *var)
3424 return error(_("missing value for '%s'"), var);
3427 int parse_config_key(const char *var,
3428 const char *section,
3429 const char **subsection, size_t *subsection_len,
3434 /* Does it start with "section." ? */
3435 if (!skip_prefix(var, section, &var) || *var != '.')
3439 * Find the key; we don't know yet if we have a subsection, but we must
3440 * parse backwards from the end, since the subsection may have dots in
3443 dot = strrchr(var, '.');
3446 /* Did we have a subsection at all? */
3450 *subsection_len = 0;
3456 *subsection = var + 1;
3457 *subsection_len = dot - *subsection;
3463 const char *current_config_origin_type(void)
3466 if (current_config_kvi)
3467 type = current_config_kvi->origin_type;
3469 type = cf->origin_type;
3471 BUG("current_config_origin_type called outside config callback");
3474 case CONFIG_ORIGIN_BLOB:
3476 case CONFIG_ORIGIN_FILE:
3478 case CONFIG_ORIGIN_STDIN:
3479 return "standard input";
3480 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3481 return "submodule-blob";
3482 case CONFIG_ORIGIN_CMDLINE:
3483 return "command line";
3485 BUG("unknown config origin type");
3489 const char *config_scope_name(enum config_scope scope)
3492 case CONFIG_SCOPE_SYSTEM:
3494 case CONFIG_SCOPE_GLOBAL:
3496 case CONFIG_SCOPE_LOCAL:
3498 case CONFIG_SCOPE_WORKTREE:
3500 case CONFIG_SCOPE_COMMAND:
3502 case CONFIG_SCOPE_SUBMODULE:
3509 const char *current_config_name(void)
3512 if (current_config_kvi)
3513 name = current_config_kvi->filename;
3517 BUG("current_config_name called outside config callback");
3518 return name ? name : "";
3521 enum config_scope current_config_scope(void)
3523 if (current_config_kvi)
3524 return current_config_kvi->scope;
3526 return current_parsing_scope;
3529 int current_config_line(void)
3531 if (current_config_kvi)
3532 return current_config_kvi->linenr;
3537 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3541 for (i = 0; i < nr_mapping; i++) {
3542 const char *name = mapping[i];
3544 if (name && !strcasecmp(var, name))