2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
14 #include "string-list.h"
17 struct config_source {
18 struct config_source *prev;
27 enum config_origin_type origin_type;
36 int (*do_fgetc)(struct config_source *c);
37 int (*do_ungetc)(int c, struct config_source *conf);
38 long (*do_ftell)(struct config_source *c);
42 * These variables record the "current" config source, which
43 * can be accessed by parsing callbacks.
45 * The "cf" variable will be non-NULL only when we are actually parsing a real
46 * config source (file, blob, cmdline, etc).
48 * The "current_config_kvi" variable will be non-NULL only when we are feeding
49 * cached config from a configset into a callback.
51 * They should generally never be non-NULL at the same time. If they are both
52 * NULL, then we aren't parsing anything (and depending on the function looking
53 * at the variables, it's either a bug for it to be called in the first place,
54 * or it's a function which can be reused for non-config purposes, and should
55 * fall back to some sane behavior).
57 static struct config_source *cf;
58 static struct key_value_info *current_config_kvi;
61 * Similar to the variables above, this gives access to the "scope" of the
62 * current value (repo, global, etc). For cached values, it can be found via
63 * the current_config_kvi as above. During parsing, the current value can be
64 * found in this variable. It's not part of "cf" because it transcends a single
65 * file (i.e., a file included from .git/config is still in "repo" scope).
67 static enum config_scope current_parsing_scope;
69 static int core_compression_seen;
70 static int pack_compression_seen;
71 static int zlib_compression_seen;
74 * Default config_set that contains key-value pairs from the usual set of config
75 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
76 * config file and the global /etc/gitconfig)
78 static struct config_set the_config_set;
80 static int config_file_fgetc(struct config_source *conf)
82 return getc_unlocked(conf->u.file);
85 static int config_file_ungetc(int c, struct config_source *conf)
87 return ungetc(c, conf->u.file);
90 static long config_file_ftell(struct config_source *conf)
92 return ftell(conf->u.file);
96 static int config_buf_fgetc(struct config_source *conf)
98 if (conf->u.buf.pos < conf->u.buf.len)
99 return conf->u.buf.buf[conf->u.buf.pos++];
104 static int config_buf_ungetc(int c, struct config_source *conf)
106 if (conf->u.buf.pos > 0) {
108 if (conf->u.buf.buf[conf->u.buf.pos] != c)
109 die("BUG: config_buf can only ungetc the same character");
116 static long config_buf_ftell(struct config_source *conf)
118 return conf->u.buf.pos;
121 #define MAX_INCLUDE_DEPTH 10
122 static const char include_depth_advice[] =
123 "exceeded maximum include depth (%d) while including\n"
127 "Do you have circular includes?";
128 static int handle_path_include(const char *path, struct config_include_data *inc)
131 struct strbuf buf = STRBUF_INIT;
135 return config_error_nonbool("include.path");
137 expanded = expand_user_path(path);
139 return error("could not expand include path '%s'", path);
143 * Use an absolute path as-is, but interpret relative paths
144 * based on the including config file.
146 if (!is_absolute_path(path)) {
149 if (!cf || !cf->path)
150 return error("relative config includes must come from files");
152 slash = find_last_dir_sep(cf->path);
154 strbuf_add(&buf, cf->path, slash - cf->path + 1);
155 strbuf_addstr(&buf, path);
159 if (!access_or_die(path, R_OK, 0)) {
160 if (++inc->depth > MAX_INCLUDE_DEPTH)
161 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
163 cf->name ? cf->name :
165 ret = git_config_from_file(git_config_include, path, inc);
168 strbuf_release(&buf);
173 int git_config_include(const char *var, const char *value, void *data)
175 struct config_include_data *inc = data;
179 * Pass along all values, including "include" directives; this makes it
180 * possible to query information on the includes themselves.
182 ret = inc->fn(var, value, inc->data);
186 if (!strcmp(var, "include.path"))
187 ret = handle_path_include(value, inc);
191 void git_config_push_parameter(const char *text)
193 struct strbuf env = STRBUF_INIT;
194 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
196 strbuf_addstr(&env, old);
197 strbuf_addch(&env, ' ');
199 sq_quote_buf(&env, text);
200 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
201 strbuf_release(&env);
204 int git_config_parse_parameter(const char *text,
205 config_fn_t fn, void *data)
208 struct strbuf **pair;
210 pair = strbuf_split_str(text, '=', 2);
212 return error("bogus config parameter: %s", text);
214 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
215 strbuf_setlen(pair[0], pair[0]->len - 1);
216 value = pair[1] ? pair[1]->buf : "";
221 strbuf_trim(pair[0]);
223 strbuf_list_free(pair);
224 return error("bogus config parameter: %s", text);
226 strbuf_tolower(pair[0]);
227 if (fn(pair[0]->buf, value, data) < 0) {
228 strbuf_list_free(pair);
231 strbuf_list_free(pair);
235 int git_config_from_parameters(config_fn_t fn, void *data)
237 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
240 const char **argv = NULL;
241 int nr = 0, alloc = 0;
243 struct config_source source;
248 memset(&source, 0, sizeof(source));
250 source.origin_type = CONFIG_ORIGIN_CMDLINE;
253 /* sq_dequote will write over it */
256 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
257 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
261 for (i = 0; i < nr; i++) {
262 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
275 static int get_next_char(void)
277 int c = cf->do_fgetc(cf);
280 /* DOS like systems */
281 c = cf->do_fgetc(cf);
284 cf->do_ungetc(c, cf);
298 static char *parse_value(void)
300 int quote = 0, comment = 0, space = 0;
302 strbuf_reset(&cf->value);
304 int c = get_next_char();
310 return cf->value.buf;
314 if (isspace(c) && !quote) {
320 if (c == ';' || c == '#') {
325 for (; space; space--)
326 strbuf_addch(&cf->value, ' ');
341 /* Some characters escape as themselves */
344 /* Reject unknown escape sequences */
348 strbuf_addch(&cf->value, c);
355 strbuf_addch(&cf->value, c);
359 static inline int iskeychar(int c)
361 return isalnum(c) || c == '-';
364 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
370 /* Get the full name */
377 strbuf_addch(name, tolower(c));
380 while (c == ' ' || c == '\t')
387 value = parse_value();
392 * We already consumed the \n, but we need linenr to point to
393 * the line we just parsed during the call to fn to get
394 * accurate line number in error messages.
397 ret = fn(name->buf, value, data);
402 static int get_extended_base_var(struct strbuf *name, int c)
406 goto error_incomplete_line;
408 } while (isspace(c));
410 /* We require the format to be '[base "extension"]' */
413 strbuf_addch(name, '.');
416 int c = get_next_char();
418 goto error_incomplete_line;
424 goto error_incomplete_line;
426 strbuf_addch(name, c);
430 if (get_next_char() != ']')
433 error_incomplete_line:
438 static int get_base_var(struct strbuf *name)
441 int c = get_next_char();
447 return get_extended_base_var(name, c);
448 if (!iskeychar(c) && c != '.')
450 strbuf_addch(name, tolower(c));
454 static int git_parse_source(config_fn_t fn, void *data)
458 struct strbuf *var = &cf->var;
459 int error_return = 0;
460 char *error_msg = NULL;
462 /* U+FEFF Byte Order Mark in UTF8 */
463 const char *bomptr = utf8_bom;
466 int c = get_next_char();
467 if (bomptr && *bomptr) {
468 /* We are at the file beginning; skip UTF8-encoded BOM
469 * if present. Sane editors won't put this in on their
470 * own, but e.g. Windows Notepad will do it happily. */
471 if (c == (*bomptr & 0377)) {
475 /* Do not tolerate partial BOM. */
476 if (bomptr != utf8_bom)
478 /* No BOM at file beginning. Cool. */
488 if (comment || isspace(c))
490 if (c == '#' || c == ';') {
495 /* Reset prior to determining a new stem */
497 if (get_base_var(var) < 0 || var->len < 1)
499 strbuf_addch(var, '.');
506 * Truncate the var name back to the section header
507 * stem prior to grabbing the suffix part of the name
510 strbuf_setlen(var, baselen);
511 strbuf_addch(var, tolower(c));
512 if (get_value(fn, data, var) < 0)
516 switch (cf->origin_type) {
517 case CONFIG_ORIGIN_BLOB:
518 error_msg = xstrfmt(_("bad config line %d in blob %s"),
519 cf->linenr, cf->name);
521 case CONFIG_ORIGIN_FILE:
522 error_msg = xstrfmt(_("bad config line %d in file %s"),
523 cf->linenr, cf->name);
525 case CONFIG_ORIGIN_STDIN:
526 error_msg = xstrfmt(_("bad config line %d in standard input"),
529 case CONFIG_ORIGIN_SUBMODULE_BLOB:
530 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
531 cf->linenr, cf->name);
533 case CONFIG_ORIGIN_CMDLINE:
534 error_msg = xstrfmt(_("bad config line %d in command line %s"),
535 cf->linenr, cf->name);
538 error_msg = xstrfmt(_("bad config line %d in %s"),
539 cf->linenr, cf->name);
542 if (cf->die_on_error)
543 die("%s", error_msg);
545 error_return = error("%s", error_msg);
551 static int parse_unit_factor(const char *end, uintmax_t *val)
555 else if (!strcasecmp(end, "k")) {
559 else if (!strcasecmp(end, "m")) {
563 else if (!strcasecmp(end, "g")) {
564 *val *= 1024 * 1024 * 1024;
570 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
572 if (value && *value) {
576 uintmax_t factor = 1;
579 val = strtoimax(value, &end, 0);
582 if (!parse_unit_factor(end, &factor)) {
588 if (uval > max || labs(val) > uval) {
600 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
602 if (value && *value) {
608 val = strtoumax(value, &end, 0);
612 if (!parse_unit_factor(end, &val)) {
616 if (val > max || oldval > val) {
627 static int git_parse_int(const char *value, int *ret)
630 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
636 static int git_parse_int64(const char *value, int64_t *ret)
639 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
645 int git_parse_ulong(const char *value, unsigned long *ret)
648 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
655 static void die_bad_number(const char *name, const char *value)
657 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
662 if (!(cf && cf->name))
663 die(_("bad numeric config value '%s' for '%s': %s"),
664 value, name, error_type);
666 switch (cf->origin_type) {
667 case CONFIG_ORIGIN_BLOB:
668 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
669 value, name, cf->name, error_type);
670 case CONFIG_ORIGIN_FILE:
671 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
672 value, name, cf->name, error_type);
673 case CONFIG_ORIGIN_STDIN:
674 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
675 value, name, error_type);
676 case CONFIG_ORIGIN_SUBMODULE_BLOB:
677 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
678 value, name, cf->name, error_type);
679 case CONFIG_ORIGIN_CMDLINE:
680 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
681 value, name, cf->name, error_type);
683 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
684 value, name, cf->name, error_type);
688 int git_config_int(const char *name, const char *value)
691 if (!git_parse_int(value, &ret))
692 die_bad_number(name, value);
696 int64_t git_config_int64(const char *name, const char *value)
699 if (!git_parse_int64(value, &ret))
700 die_bad_number(name, value);
704 unsigned long git_config_ulong(const char *name, const char *value)
707 if (!git_parse_ulong(value, &ret))
708 die_bad_number(name, value);
712 int git_parse_maybe_bool(const char *value)
718 if (!strcasecmp(value, "true")
719 || !strcasecmp(value, "yes")
720 || !strcasecmp(value, "on"))
722 if (!strcasecmp(value, "false")
723 || !strcasecmp(value, "no")
724 || !strcasecmp(value, "off"))
729 int git_config_maybe_bool(const char *name, const char *value)
731 int v = git_parse_maybe_bool(value);
734 if (git_parse_int(value, &v))
739 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
741 int v = git_parse_maybe_bool(value);
747 return git_config_int(name, value);
750 int git_config_bool(const char *name, const char *value)
753 return !!git_config_bool_or_int(name, value, &discard);
756 int git_config_string(const char **dest, const char *var, const char *value)
759 return config_error_nonbool(var);
760 *dest = xstrdup(value);
764 int git_config_pathname(const char **dest, const char *var, const char *value)
767 return config_error_nonbool(var);
768 *dest = expand_user_path(value);
770 die(_("failed to expand user dir in: '%s'"), value);
774 static int git_default_core_config(const char *var, const char *value)
776 /* This needs a better name */
777 if (!strcmp(var, "core.filemode")) {
778 trust_executable_bit = git_config_bool(var, value);
781 if (!strcmp(var, "core.trustctime")) {
782 trust_ctime = git_config_bool(var, value);
785 if (!strcmp(var, "core.checkstat")) {
786 if (!strcasecmp(value, "default"))
788 else if (!strcasecmp(value, "minimal"))
792 if (!strcmp(var, "core.quotepath")) {
793 quote_path_fully = git_config_bool(var, value);
797 if (!strcmp(var, "core.symlinks")) {
798 has_symlinks = git_config_bool(var, value);
802 if (!strcmp(var, "core.ignorecase")) {
803 ignore_case = git_config_bool(var, value);
807 if (!strcmp(var, "core.attributesfile"))
808 return git_config_pathname(&git_attributes_file, var, value);
810 if (!strcmp(var, "core.hookspath"))
811 return git_config_pathname(&git_hooks_path, var, value);
813 if (!strcmp(var, "core.bare")) {
814 is_bare_repository_cfg = git_config_bool(var, value);
818 if (!strcmp(var, "core.ignorestat")) {
819 assume_unchanged = git_config_bool(var, value);
823 if (!strcmp(var, "core.prefersymlinkrefs")) {
824 prefer_symlink_refs = git_config_bool(var, value);
828 if (!strcmp(var, "core.logallrefupdates")) {
829 if (value && !strcasecmp(value, "always"))
830 log_all_ref_updates = LOG_REFS_ALWAYS;
831 else if (git_config_bool(var, value))
832 log_all_ref_updates = LOG_REFS_NORMAL;
834 log_all_ref_updates = LOG_REFS_NONE;
838 if (!strcmp(var, "core.warnambiguousrefs")) {
839 warn_ambiguous_refs = git_config_bool(var, value);
843 if (!strcmp(var, "core.abbrev")) {
845 return config_error_nonbool(var);
846 if (!strcasecmp(value, "auto"))
849 int abbrev = git_config_int(var, value);
850 if (abbrev < minimum_abbrev || abbrev > 40)
851 return error("abbrev length out of range: %d", abbrev);
852 default_abbrev = abbrev;
857 if (!strcmp(var, "core.disambiguate"))
858 return set_disambiguate_hint_config(var, value);
860 if (!strcmp(var, "core.loosecompression")) {
861 int level = git_config_int(var, value);
863 level = Z_DEFAULT_COMPRESSION;
864 else if (level < 0 || level > Z_BEST_COMPRESSION)
865 die(_("bad zlib compression level %d"), level);
866 zlib_compression_level = level;
867 zlib_compression_seen = 1;
871 if (!strcmp(var, "core.compression")) {
872 int level = git_config_int(var, value);
874 level = Z_DEFAULT_COMPRESSION;
875 else if (level < 0 || level > Z_BEST_COMPRESSION)
876 die(_("bad zlib compression level %d"), level);
877 core_compression_level = level;
878 core_compression_seen = 1;
879 if (!zlib_compression_seen)
880 zlib_compression_level = level;
881 if (!pack_compression_seen)
882 pack_compression_level = level;
886 if (!strcmp(var, "core.packedgitwindowsize")) {
887 int pgsz_x2 = getpagesize() * 2;
888 packed_git_window_size = git_config_ulong(var, value);
890 /* This value must be multiple of (pagesize * 2) */
891 packed_git_window_size /= pgsz_x2;
892 if (packed_git_window_size < 1)
893 packed_git_window_size = 1;
894 packed_git_window_size *= pgsz_x2;
898 if (!strcmp(var, "core.bigfilethreshold")) {
899 big_file_threshold = git_config_ulong(var, value);
903 if (!strcmp(var, "core.packedgitlimit")) {
904 packed_git_limit = git_config_ulong(var, value);
908 if (!strcmp(var, "core.deltabasecachelimit")) {
909 delta_base_cache_limit = git_config_ulong(var, value);
913 if (!strcmp(var, "core.autocrlf")) {
914 if (value && !strcasecmp(value, "input")) {
915 auto_crlf = AUTO_CRLF_INPUT;
918 auto_crlf = git_config_bool(var, value);
922 if (!strcmp(var, "core.safecrlf")) {
923 if (value && !strcasecmp(value, "warn")) {
924 safe_crlf = SAFE_CRLF_WARN;
927 safe_crlf = git_config_bool(var, value);
931 if (!strcmp(var, "core.eol")) {
932 if (value && !strcasecmp(value, "lf"))
934 else if (value && !strcasecmp(value, "crlf"))
936 else if (value && !strcasecmp(value, "native"))
937 core_eol = EOL_NATIVE;
939 core_eol = EOL_UNSET;
943 if (!strcmp(var, "core.notesref")) {
944 notes_ref_name = xstrdup(value);
948 if (!strcmp(var, "core.editor"))
949 return git_config_string(&editor_program, var, value);
951 if (!strcmp(var, "core.commentchar")) {
953 return config_error_nonbool(var);
954 else if (!strcasecmp(value, "auto"))
955 auto_comment_line_char = 1;
956 else if (value[0] && !value[1]) {
957 comment_line_char = value[0];
958 auto_comment_line_char = 0;
960 return error("core.commentChar should only be one character");
964 if (!strcmp(var, "core.askpass"))
965 return git_config_string(&askpass_program, var, value);
967 if (!strcmp(var, "core.excludesfile"))
968 return git_config_pathname(&excludes_file, var, value);
970 if (!strcmp(var, "core.whitespace")) {
972 return config_error_nonbool(var);
973 whitespace_rule_cfg = parse_whitespace_rule(value);
977 if (!strcmp(var, "core.fsyncobjectfiles")) {
978 fsync_object_files = git_config_bool(var, value);
982 if (!strcmp(var, "core.preloadindex")) {
983 core_preload_index = git_config_bool(var, value);
987 if (!strcmp(var, "core.createobject")) {
988 if (!strcmp(value, "rename"))
989 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
990 else if (!strcmp(value, "link"))
991 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
993 die(_("invalid mode for object creation: %s"), value);
997 if (!strcmp(var, "core.sparsecheckout")) {
998 core_apply_sparse_checkout = git_config_bool(var, value);
1002 if (!strcmp(var, "core.precomposeunicode")) {
1003 precomposed_unicode = git_config_bool(var, value);
1007 if (!strcmp(var, "core.protecthfs")) {
1008 protect_hfs = git_config_bool(var, value);
1012 if (!strcmp(var, "core.protectntfs")) {
1013 protect_ntfs = git_config_bool(var, value);
1017 if (!strcmp(var, "core.hidedotfiles")) {
1018 if (value && !strcasecmp(value, "dotgitonly"))
1019 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1021 hide_dotfiles = git_config_bool(var, value);
1025 /* Add other config variables here and to Documentation/config.txt. */
1029 static int git_default_i18n_config(const char *var, const char *value)
1031 if (!strcmp(var, "i18n.commitencoding"))
1032 return git_config_string(&git_commit_encoding, var, value);
1034 if (!strcmp(var, "i18n.logoutputencoding"))
1035 return git_config_string(&git_log_output_encoding, var, value);
1037 /* Add other config variables here and to Documentation/config.txt. */
1041 static int git_default_branch_config(const char *var, const char *value)
1043 if (!strcmp(var, "branch.autosetupmerge")) {
1044 if (value && !strcasecmp(value, "always")) {
1045 git_branch_track = BRANCH_TRACK_ALWAYS;
1048 git_branch_track = git_config_bool(var, value);
1051 if (!strcmp(var, "branch.autosetuprebase")) {
1053 return config_error_nonbool(var);
1054 else if (!strcmp(value, "never"))
1055 autorebase = AUTOREBASE_NEVER;
1056 else if (!strcmp(value, "local"))
1057 autorebase = AUTOREBASE_LOCAL;
1058 else if (!strcmp(value, "remote"))
1059 autorebase = AUTOREBASE_REMOTE;
1060 else if (!strcmp(value, "always"))
1061 autorebase = AUTOREBASE_ALWAYS;
1063 return error("malformed value for %s", var);
1067 /* Add other config variables here and to Documentation/config.txt. */
1071 static int git_default_push_config(const char *var, const char *value)
1073 if (!strcmp(var, "push.default")) {
1075 return config_error_nonbool(var);
1076 else if (!strcmp(value, "nothing"))
1077 push_default = PUSH_DEFAULT_NOTHING;
1078 else if (!strcmp(value, "matching"))
1079 push_default = PUSH_DEFAULT_MATCHING;
1080 else if (!strcmp(value, "simple"))
1081 push_default = PUSH_DEFAULT_SIMPLE;
1082 else if (!strcmp(value, "upstream"))
1083 push_default = PUSH_DEFAULT_UPSTREAM;
1084 else if (!strcmp(value, "tracking")) /* deprecated */
1085 push_default = PUSH_DEFAULT_UPSTREAM;
1086 else if (!strcmp(value, "current"))
1087 push_default = PUSH_DEFAULT_CURRENT;
1089 error("malformed value for %s: %s", var, value);
1090 return error("Must be one of nothing, matching, simple, "
1091 "upstream or current.");
1096 /* Add other config variables here and to Documentation/config.txt. */
1100 static int git_default_mailmap_config(const char *var, const char *value)
1102 if (!strcmp(var, "mailmap.file"))
1103 return git_config_pathname(&git_mailmap_file, var, value);
1104 if (!strcmp(var, "mailmap.blob"))
1105 return git_config_string(&git_mailmap_blob, var, value);
1107 /* Add other config variables here and to Documentation/config.txt. */
1111 int git_default_config(const char *var, const char *value, void *dummy)
1113 if (starts_with(var, "core."))
1114 return git_default_core_config(var, value);
1116 if (starts_with(var, "user."))
1117 return git_ident_config(var, value, dummy);
1119 if (starts_with(var, "i18n."))
1120 return git_default_i18n_config(var, value);
1122 if (starts_with(var, "branch."))
1123 return git_default_branch_config(var, value);
1125 if (starts_with(var, "push."))
1126 return git_default_push_config(var, value);
1128 if (starts_with(var, "mailmap."))
1129 return git_default_mailmap_config(var, value);
1131 if (starts_with(var, "advice."))
1132 return git_default_advice_config(var, value);
1134 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1135 pager_use_color = git_config_bool(var,value);
1139 if (!strcmp(var, "pack.packsizelimit")) {
1140 pack_size_limit_cfg = git_config_ulong(var, value);
1144 if (!strcmp(var, "pack.compression")) {
1145 int level = git_config_int(var, value);
1147 level = Z_DEFAULT_COMPRESSION;
1148 else if (level < 0 || level > Z_BEST_COMPRESSION)
1149 die(_("bad pack compression level %d"), level);
1150 pack_compression_level = level;
1151 pack_compression_seen = 1;
1155 /* Add other config variables here and to Documentation/config.txt. */
1160 * All source specific fields in the union, die_on_error, name and the callbacks
1161 * fgetc, ungetc, ftell of top need to be initialized before calling
1164 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1168 /* push config-file parsing state stack */
1172 strbuf_init(&top->value, 1024);
1173 strbuf_init(&top->var, 1024);
1176 ret = git_parse_source(fn, data);
1178 /* pop config-file parsing state stack */
1179 strbuf_release(&top->value);
1180 strbuf_release(&top->var);
1186 static int do_config_from_file(config_fn_t fn,
1187 const enum config_origin_type origin_type,
1188 const char *name, const char *path, FILE *f,
1191 struct config_source top;
1194 top.origin_type = origin_type;
1197 top.die_on_error = 1;
1198 top.do_fgetc = config_file_fgetc;
1199 top.do_ungetc = config_file_ungetc;
1200 top.do_ftell = config_file_ftell;
1202 return do_config_from(&top, fn, data);
1205 static int git_config_from_stdin(config_fn_t fn, void *data)
1207 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1210 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1215 f = fopen(filename, "r");
1218 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1225 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1226 const char *name, const char *buf, size_t len, void *data)
1228 struct config_source top;
1230 top.u.buf.buf = buf;
1231 top.u.buf.len = len;
1233 top.origin_type = origin_type;
1236 top.die_on_error = 0;
1237 top.do_fgetc = config_buf_fgetc;
1238 top.do_ungetc = config_buf_ungetc;
1239 top.do_ftell = config_buf_ftell;
1241 return do_config_from(&top, fn, data);
1244 int git_config_from_blob_sha1(config_fn_t fn,
1246 const unsigned char *sha1,
1249 enum object_type type;
1254 buf = read_sha1_file(sha1, &type, &size);
1256 return error("unable to load config blob object '%s'", name);
1257 if (type != OBJ_BLOB) {
1259 return error("reference '%s' does not point to a blob", name);
1262 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1268 static int git_config_from_blob_ref(config_fn_t fn,
1272 unsigned char sha1[20];
1274 if (get_sha1(name, sha1) < 0)
1275 return error("unable to resolve config blob '%s'", name);
1276 return git_config_from_blob_sha1(fn, name, sha1, data);
1279 const char *git_etc_gitconfig(void)
1281 static const char *system_wide;
1283 system_wide = system_path(ETC_GITCONFIG);
1288 * Parse environment variable 'k' as a boolean (in various
1289 * possible spellings); if missing, use the default value 'def'.
1291 int git_env_bool(const char *k, int def)
1293 const char *v = getenv(k);
1294 return v ? git_config_bool(k, v) : def;
1298 * Parse environment variable 'k' as ulong with possibly a unit
1299 * suffix; if missing, use the default value 'val'.
1301 unsigned long git_env_ulong(const char *k, unsigned long val)
1303 const char *v = getenv(k);
1304 if (v && !git_parse_ulong(v, &val))
1305 die("failed to parse %s", k);
1309 int git_config_system(void)
1311 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1314 static int do_git_config_sequence(config_fn_t fn, void *data)
1317 char *xdg_config = xdg_config_home("config");
1318 char *user_config = expand_user_path("~/.gitconfig");
1319 char *repo_config = have_git_dir() ? git_pathdup("config") : NULL;
1321 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1322 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1323 ret += git_config_from_file(fn, git_etc_gitconfig(),
1326 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1327 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1328 ret += git_config_from_file(fn, xdg_config, data);
1330 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1331 ret += git_config_from_file(fn, user_config, data);
1333 current_parsing_scope = CONFIG_SCOPE_REPO;
1334 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1335 ret += git_config_from_file(fn, repo_config, data);
1337 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1338 if (git_config_from_parameters(fn, data) < 0)
1339 die(_("unable to parse command-line config"));
1341 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1348 int git_config_with_options(config_fn_t fn, void *data,
1349 struct git_config_source *config_source,
1350 int respect_includes)
1352 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1354 if (respect_includes) {
1357 fn = git_config_include;
1362 * If we have a specific filename, use it. Otherwise, follow the
1363 * regular lookup sequence.
1365 if (config_source && config_source->use_stdin)
1366 return git_config_from_stdin(fn, data);
1367 else if (config_source && config_source->file)
1368 return git_config_from_file(fn, config_source->file, data);
1369 else if (config_source && config_source->blob)
1370 return git_config_from_blob_ref(fn, config_source->blob, data);
1372 return do_git_config_sequence(fn, data);
1375 static void git_config_raw(config_fn_t fn, void *data)
1377 if (git_config_with_options(fn, data, NULL, 1) < 0)
1379 * git_config_with_options() normally returns only
1380 * zero, as most errors are fatal, and
1381 * non-fatal potential errors are guarded by "if"
1382 * statements that are entered only when no error is
1385 * If we ever encounter a non-fatal error, it means
1386 * something went really wrong and we should stop
1389 die(_("unknown error occurred while reading the configuration files"));
1392 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1395 struct string_list *values;
1396 struct config_set_element *entry;
1397 struct configset_list *list = &cs->list;
1399 for (i = 0; i < list->nr; i++) {
1400 entry = list->items[i].e;
1401 value_index = list->items[i].value_index;
1402 values = &entry->value_list;
1404 current_config_kvi = values->items[value_index].util;
1406 if (fn(entry->key, values->items[value_index].string, data) < 0)
1407 git_die_config_linenr(entry->key,
1408 current_config_kvi->filename,
1409 current_config_kvi->linenr);
1411 current_config_kvi = NULL;
1415 static void git_config_check_init(void);
1417 void git_config(config_fn_t fn, void *data)
1419 git_config_check_init();
1420 configset_iter(&the_config_set, fn, data);
1423 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1425 struct config_set_element k;
1426 struct config_set_element *found_entry;
1427 char *normalized_key;
1429 * `key` may come from the user, so normalize it before using it
1430 * for querying entries from the hashmap.
1432 if (git_config_parse_key(key, &normalized_key, NULL))
1435 hashmap_entry_init(&k, strhash(normalized_key));
1436 k.key = normalized_key;
1437 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1438 free(normalized_key);
1442 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1444 struct config_set_element *e;
1445 struct string_list_item *si;
1446 struct configset_list_item *l_item;
1447 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1449 e = configset_find_element(cs, key);
1451 * Since the keys are being fed by git_config*() callback mechanism, they
1452 * are already normalized. So simply add them without any further munging.
1455 e = xmalloc(sizeof(*e));
1456 hashmap_entry_init(e, strhash(key));
1457 e->key = xstrdup(key);
1458 string_list_init(&e->value_list, 1);
1459 hashmap_add(&cs->config_hash, e);
1461 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1463 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1464 l_item = &cs->list.items[cs->list.nr++];
1466 l_item->value_index = e->value_list.nr - 1;
1469 die("BUG: configset_add_value has no source");
1471 kv_info->filename = strintern(cf->name);
1472 kv_info->linenr = cf->linenr;
1473 kv_info->origin_type = cf->origin_type;
1475 /* for values read from `git_config_from_parameters()` */
1476 kv_info->filename = NULL;
1477 kv_info->linenr = -1;
1478 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1480 kv_info->scope = current_parsing_scope;
1486 static int config_set_element_cmp(const struct config_set_element *e1,
1487 const struct config_set_element *e2, const void *unused)
1489 return strcmp(e1->key, e2->key);
1492 void git_configset_init(struct config_set *cs)
1494 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1495 cs->hash_initialized = 1;
1498 cs->list.items = NULL;
1501 void git_configset_clear(struct config_set *cs)
1503 struct config_set_element *entry;
1504 struct hashmap_iter iter;
1505 if (!cs->hash_initialized)
1508 hashmap_iter_init(&cs->config_hash, &iter);
1509 while ((entry = hashmap_iter_next(&iter))) {
1511 string_list_clear(&entry->value_list, 1);
1513 hashmap_free(&cs->config_hash, 1);
1514 cs->hash_initialized = 0;
1515 free(cs->list.items);
1518 cs->list.items = NULL;
1521 static int config_set_callback(const char *key, const char *value, void *cb)
1523 struct config_set *cs = cb;
1524 configset_add_value(cs, key, value);
1528 int git_configset_add_file(struct config_set *cs, const char *filename)
1530 return git_config_from_file(config_set_callback, filename, cs);
1533 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1535 const struct string_list *values = NULL;
1537 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1538 * queried key in the files of the configset, the value returned will be the last
1539 * value in the value list for that key.
1541 values = git_configset_get_value_multi(cs, key);
1545 assert(values->nr > 0);
1546 *value = values->items[values->nr - 1].string;
1550 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1552 struct config_set_element *e = configset_find_element(cs, key);
1553 return e ? &e->value_list : NULL;
1556 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1559 if (!git_configset_get_value(cs, key, &value))
1560 return git_config_string(dest, key, value);
1565 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1567 return git_configset_get_string_const(cs, key, (const char **)dest);
1570 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1573 if (!git_configset_get_value(cs, key, &value)) {
1574 *dest = git_config_int(key, value);
1580 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1583 if (!git_configset_get_value(cs, key, &value)) {
1584 *dest = git_config_ulong(key, value);
1590 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1593 if (!git_configset_get_value(cs, key, &value)) {
1594 *dest = git_config_bool(key, value);
1600 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1601 int *is_bool, int *dest)
1604 if (!git_configset_get_value(cs, key, &value)) {
1605 *dest = git_config_bool_or_int(key, value, is_bool);
1611 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1614 if (!git_configset_get_value(cs, key, &value)) {
1615 *dest = git_config_maybe_bool(key, value);
1623 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1626 if (!git_configset_get_value(cs, key, &value))
1627 return git_config_pathname(dest, key, value);
1632 static void git_config_check_init(void)
1634 if (the_config_set.hash_initialized)
1636 git_configset_init(&the_config_set);
1637 git_config_raw(config_set_callback, &the_config_set);
1640 void git_config_clear(void)
1642 if (!the_config_set.hash_initialized)
1644 git_configset_clear(&the_config_set);
1647 int git_config_get_value(const char *key, const char **value)
1649 git_config_check_init();
1650 return git_configset_get_value(&the_config_set, key, value);
1653 const struct string_list *git_config_get_value_multi(const char *key)
1655 git_config_check_init();
1656 return git_configset_get_value_multi(&the_config_set, key);
1659 int git_config_get_string_const(const char *key, const char **dest)
1662 git_config_check_init();
1663 ret = git_configset_get_string_const(&the_config_set, key, dest);
1665 git_die_config(key, NULL);
1669 int git_config_get_string(const char *key, char **dest)
1671 git_config_check_init();
1672 return git_config_get_string_const(key, (const char **)dest);
1675 int git_config_get_int(const char *key, int *dest)
1677 git_config_check_init();
1678 return git_configset_get_int(&the_config_set, key, dest);
1681 int git_config_get_ulong(const char *key, unsigned long *dest)
1683 git_config_check_init();
1684 return git_configset_get_ulong(&the_config_set, key, dest);
1687 int git_config_get_bool(const char *key, int *dest)
1689 git_config_check_init();
1690 return git_configset_get_bool(&the_config_set, key, dest);
1693 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1695 git_config_check_init();
1696 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1699 int git_config_get_maybe_bool(const char *key, int *dest)
1701 git_config_check_init();
1702 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1705 int git_config_get_pathname(const char *key, const char **dest)
1708 git_config_check_init();
1709 ret = git_configset_get_pathname(&the_config_set, key, dest);
1711 git_die_config(key, NULL);
1715 int git_config_get_untracked_cache(void)
1720 /* Hack for test programs like test-dump-untracked-cache */
1721 if (ignore_untracked_cache_config)
1724 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
1727 if (!git_config_get_value("core.untrackedcache", &v)) {
1728 if (!strcasecmp(v, "keep"))
1731 error("unknown core.untrackedCache value '%s'; "
1732 "using 'keep' default value", v);
1736 return -1; /* default value */
1740 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1743 die(_("unable to parse '%s' from command-line config"), key);
1745 die(_("bad config variable '%s' in file '%s' at line %d"),
1746 key, filename, linenr);
1749 NORETURN __attribute__((format(printf, 2, 3)))
1750 void git_die_config(const char *key, const char *err, ...)
1752 const struct string_list *values;
1753 struct key_value_info *kv_info;
1757 va_start(params, err);
1758 vreportf("error: ", err, params);
1761 values = git_config_get_value_multi(key);
1762 kv_info = values->items[values->nr - 1].util;
1763 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
1767 * Find all the stuff for git_config_set() below.
1774 regex_t *value_regex;
1777 unsigned int offset_alloc;
1778 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1782 static int matches(const char *key, const char *value)
1784 if (strcmp(key, store.key))
1785 return 0; /* not ours */
1786 if (!store.value_regex)
1787 return 1; /* always matches */
1788 if (store.value_regex == CONFIG_REGEX_NONE)
1789 return 0; /* never matches */
1791 return store.do_not_match ^
1792 (value && !regexec(store.value_regex, value, 0, NULL, 0));
1795 static int store_aux(const char *key, const char *value, void *cb)
1800 switch (store.state) {
1802 if (matches(key, value)) {
1803 if (store.seen == 1 && store.multi_replace == 0) {
1804 warning(_("%s has multiple values"), key);
1807 ALLOC_GROW(store.offset, store.seen + 1,
1808 store.offset_alloc);
1810 store.offset[store.seen] = cf->do_ftell(cf);
1816 * What we are looking for is in store.key (both
1817 * section and var), and its section part is baselen
1818 * long. We found key (again, both section and var).
1819 * We would want to know if this key is in the same
1820 * section as what we are looking for. We already
1821 * know we are in the same section as what should
1824 ep = strrchr(key, '.');
1825 section_len = ep - key;
1827 if ((section_len != store.baselen) ||
1828 memcmp(key, store.key, section_len+1)) {
1829 store.state = SECTION_END_SEEN;
1834 * Do not increment matches: this is no match, but we
1835 * just made sure we are in the desired section.
1837 ALLOC_GROW(store.offset, store.seen + 1,
1838 store.offset_alloc);
1839 store.offset[store.seen] = cf->do_ftell(cf);
1841 case SECTION_END_SEEN:
1843 if (matches(key, value)) {
1844 ALLOC_GROW(store.offset, store.seen + 1,
1845 store.offset_alloc);
1846 store.offset[store.seen] = cf->do_ftell(cf);
1847 store.state = KEY_SEEN;
1850 if (strrchr(key, '.') - key == store.baselen &&
1851 !strncmp(key, store.key, store.baselen)) {
1852 store.state = SECTION_SEEN;
1853 ALLOC_GROW(store.offset,
1855 store.offset_alloc);
1856 store.offset[store.seen] = cf->do_ftell(cf);
1863 static int write_error(const char *filename)
1865 error("failed to write new configuration file %s", filename);
1867 /* Same error code as "failed to rename". */
1871 static int store_write_section(int fd, const char *key)
1875 struct strbuf sb = STRBUF_INIT;
1877 dot = memchr(key, '.', store.baselen);
1879 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1880 for (i = dot - key + 1; i < store.baselen; i++) {
1881 if (key[i] == '"' || key[i] == '\\')
1882 strbuf_addch(&sb, '\\');
1883 strbuf_addch(&sb, key[i]);
1885 strbuf_addstr(&sb, "\"]\n");
1887 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1890 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1891 strbuf_release(&sb);
1896 static int store_write_pair(int fd, const char *key, const char *value)
1899 int length = strlen(key + store.baselen + 1);
1900 const char *quote = "";
1901 struct strbuf sb = STRBUF_INIT;
1904 * Check to see if the value needs to be surrounded with a dq pair.
1905 * Note that problematic characters are always backslash-quoted; this
1906 * check is about not losing leading or trailing SP and strings that
1907 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1908 * configuration parser.
1910 if (value[0] == ' ')
1912 for (i = 0; value[i]; i++)
1913 if (value[i] == ';' || value[i] == '#')
1915 if (i && value[i - 1] == ' ')
1918 strbuf_addf(&sb, "\t%.*s = %s",
1919 length, key + store.baselen + 1, quote);
1921 for (i = 0; value[i]; i++)
1924 strbuf_addstr(&sb, "\\n");
1927 strbuf_addstr(&sb, "\\t");
1931 strbuf_addch(&sb, '\\');
1933 strbuf_addch(&sb, value[i]);
1936 strbuf_addf(&sb, "%s\n", quote);
1938 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1939 strbuf_release(&sb);
1944 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1945 size_t offset_, int *found_bracket)
1947 size_t equal_offset = size, bracket_offset = size;
1951 for (offset = offset_-2; offset > 0
1952 && contents[offset] != '\n'; offset--)
1953 switch (contents[offset]) {
1954 case '=': equal_offset = offset; break;
1955 case ']': bracket_offset = offset; break;
1957 if (offset > 0 && contents[offset-1] == '\\') {
1961 if (bracket_offset < equal_offset) {
1963 offset = bracket_offset+1;
1970 int git_config_set_in_file_gently(const char *config_filename,
1971 const char *key, const char *value)
1973 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
1976 void git_config_set_in_file(const char *config_filename,
1977 const char *key, const char *value)
1979 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1982 int git_config_set_gently(const char *key, const char *value)
1984 return git_config_set_multivar_gently(key, value, NULL, 0);
1987 void git_config_set(const char *key, const char *value)
1989 git_config_set_multivar(key, value, NULL, 0);
1993 * Auxiliary function to sanity-check and split the key into the section
1994 * identifier and variable name.
1996 * Returns 0 on success, -1 when there is an invalid character in the key and
1997 * -2 if there is no section name in the key.
1999 * store_key - pointer to char* which will hold a copy of the key with
2000 * lowercase section and variable name
2001 * baselen - pointer to int which will hold the length of the
2002 * section + subsection part, can be NULL
2004 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
2006 int i, dot, baselen;
2007 const char *last_dot = strrchr(key, '.');
2010 * Since "key" actually contains the section name and the real
2011 * key name separated by a dot, we have to know where the dot is.
2014 if (last_dot == NULL || last_dot == key) {
2016 error("key does not contain a section: %s", key);
2017 return -CONFIG_NO_SECTION_OR_NAME;
2022 error("key does not contain variable name: %s", key);
2023 return -CONFIG_NO_SECTION_OR_NAME;
2026 baselen = last_dot - key;
2028 *baselen_ = baselen;
2031 * Validate the key and while at it, lower case it for matching.
2034 *store_key = xmallocz(strlen(key));
2037 for (i = 0; key[i]; i++) {
2038 unsigned char c = key[i];
2041 /* Leave the extended basename untouched.. */
2042 if (!dot || i > baselen) {
2043 if (!iskeychar(c) ||
2044 (i == baselen + 1 && !isalpha(c))) {
2046 error("invalid key: %s", key);
2047 goto out_free_ret_1;
2050 } else if (c == '\n') {
2052 error("invalid key (newline): %s", key);
2053 goto out_free_ret_1;
2056 (*store_key)[i] = c;
2066 return -CONFIG_INVALID_KEY;
2069 int git_config_parse_key(const char *key, char **store_key, int *baselen)
2071 return git_config_parse_key_1(key, store_key, baselen, 0);
2074 int git_config_key_is_valid(const char *key)
2076 return !git_config_parse_key_1(key, NULL, NULL, 1);
2080 * If value==NULL, unset in (remove from) config,
2081 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2082 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2083 * (only add a new one)
2084 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2085 * else all matching key/values (regardless how many) are removed,
2086 * before the new pair is written.
2088 * Returns 0 on success.
2090 * This function does this:
2092 * - it locks the config file by creating ".git/config.lock"
2094 * - it then parses the config using store_aux() as validator to find
2095 * the position on the key/value pair to replace. If it is to be unset,
2096 * it must be found exactly once.
2098 * - the config file is mmap()ed and the part before the match (if any) is
2099 * written to the lock file, then the changed part and the rest.
2101 * - the config file is removed and the lock file rename()d to it.
2104 int git_config_set_multivar_in_file_gently(const char *config_filename,
2105 const char *key, const char *value,
2106 const char *value_regex,
2109 int fd = -1, in_fd = -1;
2111 struct lock_file *lock = NULL;
2112 char *filename_buf = NULL;
2113 char *contents = NULL;
2116 /* parse-key returns negative; flip the sign to feed exit(3) */
2117 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2121 store.multi_replace = multi_replace;
2123 if (!config_filename)
2124 config_filename = filename_buf = git_pathdup("config");
2127 * The lock serves a purpose in addition to locking: the new
2128 * contents of .git/config will be written into it.
2130 lock = xcalloc(1, sizeof(struct lock_file));
2131 fd = hold_lock_file_for_update(lock, config_filename, 0);
2133 error_errno("could not lock config file %s", config_filename);
2135 ret = CONFIG_NO_LOCK;
2140 * If .git/config does not exist yet, write a minimal version.
2142 in_fd = open(config_filename, O_RDONLY);
2146 if ( ENOENT != errno ) {
2147 error_errno("opening %s", config_filename);
2148 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2151 /* if nothing to unset, error out */
2152 if (value == NULL) {
2153 ret = CONFIG_NOTHING_SET;
2157 store.key = (char *)key;
2158 if (!store_write_section(fd, key) ||
2159 !store_write_pair(fd, key, value))
2163 size_t copy_begin, copy_end;
2164 int i, new_line = 0;
2166 if (value_regex == NULL)
2167 store.value_regex = NULL;
2168 else if (value_regex == CONFIG_REGEX_NONE)
2169 store.value_regex = CONFIG_REGEX_NONE;
2171 if (value_regex[0] == '!') {
2172 store.do_not_match = 1;
2175 store.do_not_match = 0;
2177 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2178 if (regcomp(store.value_regex, value_regex,
2180 error("invalid pattern: %s", value_regex);
2181 free(store.value_regex);
2182 ret = CONFIG_INVALID_PATTERN;
2187 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2188 store.offset[0] = 0;
2189 store.state = START;
2193 * After this, store.offset will contain the *end* offset
2194 * of the last match, or remain at 0 if no match was found.
2195 * As a side effect, we make sure to transform only a valid
2196 * existing config file.
2198 if (git_config_from_file(store_aux, config_filename, NULL)) {
2199 error("invalid config file %s", config_filename);
2201 if (store.value_regex != NULL &&
2202 store.value_regex != CONFIG_REGEX_NONE) {
2203 regfree(store.value_regex);
2204 free(store.value_regex);
2206 ret = CONFIG_INVALID_FILE;
2211 if (store.value_regex != NULL &&
2212 store.value_regex != CONFIG_REGEX_NONE) {
2213 regfree(store.value_regex);
2214 free(store.value_regex);
2217 /* if nothing to unset, or too many matches, error out */
2218 if ((store.seen == 0 && value == NULL) ||
2219 (store.seen > 1 && multi_replace == 0)) {
2220 ret = CONFIG_NOTHING_SET;
2224 if (fstat(in_fd, &st) == -1) {
2225 error_errno(_("fstat on %s failed"), config_filename);
2226 ret = CONFIG_INVALID_FILE;
2230 contents_sz = xsize_t(st.st_size);
2231 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2232 MAP_PRIVATE, in_fd, 0);
2233 if (contents == MAP_FAILED) {
2234 if (errno == ENODEV && S_ISDIR(st.st_mode))
2236 error_errno("unable to mmap '%s'", config_filename);
2237 ret = CONFIG_INVALID_FILE;
2244 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2245 error_errno("chmod on %s failed", get_lock_file_path(lock));
2246 ret = CONFIG_NO_WRITE;
2250 if (store.seen == 0)
2253 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2254 if (store.offset[i] == 0) {
2255 store.offset[i] = copy_end = contents_sz;
2256 } else if (store.state != KEY_SEEN) {
2257 copy_end = store.offset[i];
2259 copy_end = find_beginning_of_line(
2260 contents, contents_sz,
2261 store.offset[i]-2, &new_line);
2263 if (copy_end > 0 && contents[copy_end-1] != '\n')
2266 /* write the first part of the config */
2267 if (copy_end > copy_begin) {
2268 if (write_in_full(fd, contents + copy_begin,
2269 copy_end - copy_begin) <
2270 copy_end - copy_begin)
2273 write_str_in_full(fd, "\n") != 1)
2276 copy_begin = store.offset[i];
2279 /* write the pair (value == NULL means unset) */
2280 if (value != NULL) {
2281 if (store.state == START) {
2282 if (!store_write_section(fd, key))
2285 if (!store_write_pair(fd, key, value))
2289 /* write the rest of the config */
2290 if (copy_begin < contents_sz)
2291 if (write_in_full(fd, contents + copy_begin,
2292 contents_sz - copy_begin) <
2293 contents_sz - copy_begin)
2296 munmap(contents, contents_sz);
2300 if (commit_lock_file(lock) < 0) {
2301 error_errno("could not write config file %s", config_filename);
2302 ret = CONFIG_NO_WRITE;
2308 * lock is committed, so don't try to roll it back below.
2309 * NOTE: Since lockfile.c keeps a linked list of all created
2310 * lock_file structures, it isn't safe to free(lock). It's
2311 * better to just leave it hanging around.
2316 /* Invalidate the config cache */
2321 rollback_lock_file(lock);
2324 munmap(contents, contents_sz);
2330 ret = write_error(get_lock_file_path(lock));
2335 void git_config_set_multivar_in_file(const char *config_filename,
2336 const char *key, const char *value,
2337 const char *value_regex, int multi_replace)
2339 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2340 value_regex, multi_replace))
2343 die(_("could not set '%s' to '%s'"), key, value);
2345 die(_("could not unset '%s'"), key);
2348 int git_config_set_multivar_gently(const char *key, const char *value,
2349 const char *value_regex, int multi_replace)
2351 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2355 void git_config_set_multivar(const char *key, const char *value,
2356 const char *value_regex, int multi_replace)
2358 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2362 static int section_name_match (const char *buf, const char *name)
2364 int i = 0, j = 0, dot = 0;
2367 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2368 if (!dot && isspace(buf[i])) {
2370 if (name[j++] != '.')
2372 for (i++; isspace(buf[i]); i++)
2378 if (buf[i] == '\\' && dot)
2380 else if (buf[i] == '"' && dot) {
2381 for (i++; isspace(buf[i]); i++)
2385 if (buf[i] != name[j++])
2388 if (buf[i] == ']' && name[j] == 0) {
2390 * We match, now just find the right length offset by
2391 * gobbling up any whitespace after it, as well
2394 for (; buf[i] && isspace(buf[i]); i++)
2401 static int section_name_is_ok(const char *name)
2403 /* Empty section names are bogus. */
2408 * Before a dot, we must be alphanumeric or dash. After the first dot,
2409 * anything goes, so we can stop checking.
2411 for (; *name && *name != '.'; name++)
2412 if (*name != '-' && !isalnum(*name))
2417 /* if new_name == NULL, the section is removed instead */
2418 int git_config_rename_section_in_file(const char *config_filename,
2419 const char *old_name, const char *new_name)
2421 int ret = 0, remove = 0;
2422 char *filename_buf = NULL;
2423 struct lock_file *lock;
2429 if (new_name && !section_name_is_ok(new_name)) {
2430 ret = error("invalid section name: %s", new_name);
2431 goto out_no_rollback;
2434 if (!config_filename)
2435 config_filename = filename_buf = git_pathdup("config");
2437 lock = xcalloc(1, sizeof(struct lock_file));
2438 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2440 ret = error("could not lock config file %s", config_filename);
2444 if (!(config_file = fopen(config_filename, "rb"))) {
2445 /* no config file means nothing to rename, no error */
2446 goto commit_and_out;
2449 if (fstat(fileno(config_file), &st) == -1) {
2450 ret = error_errno(_("fstat on %s failed"), config_filename);
2454 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2455 ret = error_errno("chmod on %s failed",
2456 get_lock_file_path(lock));
2460 while (fgets(buf, sizeof(buf), config_file)) {
2464 for (i = 0; buf[i] && isspace(buf[i]); i++)
2466 if (buf[i] == '[') {
2467 /* it's a section */
2468 int offset = section_name_match(&buf[i], old_name);
2471 if (new_name == NULL) {
2475 store.baselen = strlen(new_name);
2476 if (!store_write_section(out_fd, new_name)) {
2477 ret = write_error(get_lock_file_path(lock));
2481 * We wrote out the new section, with
2482 * a newline, now skip the old
2485 output += offset + i;
2486 if (strlen(output) > 0) {
2488 * More content means there's
2489 * a declaration to put on the
2490 * next line; indent with a
2501 length = strlen(output);
2502 if (write_in_full(out_fd, output, length) != length) {
2503 ret = write_error(get_lock_file_path(lock));
2507 fclose(config_file);
2509 if (commit_lock_file(lock) < 0)
2510 ret = error_errno("could not write config file %s",
2513 rollback_lock_file(lock);
2519 int git_config_rename_section(const char *old_name, const char *new_name)
2521 return git_config_rename_section_in_file(NULL, old_name, new_name);
2525 * Call this to report error for your variable that should not
2526 * get a boolean value (i.e. "[my] var" means "true").
2528 #undef config_error_nonbool
2529 int config_error_nonbool(const char *var)
2531 return error("missing value for '%s'", var);
2534 int parse_config_key(const char *var,
2535 const char *section,
2536 const char **subsection, int *subsection_len,
2539 int section_len = strlen(section);
2542 /* Does it start with "section." ? */
2543 if (!starts_with(var, section) || var[section_len] != '.')
2547 * Find the key; we don't know yet if we have a subsection, but we must
2548 * parse backwards from the end, since the subsection may have dots in
2551 dot = strrchr(var, '.');
2554 /* Did we have a subsection at all? */
2555 if (dot == var + section_len) {
2557 *subsection_len = 0;
2560 *subsection = var + section_len + 1;
2561 *subsection_len = dot - *subsection;
2567 const char *current_config_origin_type(void)
2570 if (current_config_kvi)
2571 type = current_config_kvi->origin_type;
2573 type = cf->origin_type;
2575 die("BUG: current_config_origin_type called outside config callback");
2578 case CONFIG_ORIGIN_BLOB:
2580 case CONFIG_ORIGIN_FILE:
2582 case CONFIG_ORIGIN_STDIN:
2583 return "standard input";
2584 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2585 return "submodule-blob";
2586 case CONFIG_ORIGIN_CMDLINE:
2587 return "command line";
2589 die("BUG: unknown config origin type");
2593 const char *current_config_name(void)
2596 if (current_config_kvi)
2597 name = current_config_kvi->filename;
2601 die("BUG: current_config_name called outside config callback");
2602 return name ? name : "";
2605 enum config_scope current_config_scope(void)
2607 if (current_config_kvi)
2608 return current_config_kvi->scope;
2610 return current_parsing_scope;