2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
13 struct config_source {
14 struct config_source *prev;
31 int (*do_fgetc)(struct config_source *c);
32 int (*do_ungetc)(int c, struct config_source *conf);
33 long (*do_ftell)(struct config_source *c);
36 static struct config_source *cf;
38 static int zlib_compression_seen;
40 static int config_file_fgetc(struct config_source *conf)
42 return fgetc(conf->u.file);
45 static int config_file_ungetc(int c, struct config_source *conf)
47 return ungetc(c, conf->u.file);
50 static long config_file_ftell(struct config_source *conf)
52 return ftell(conf->u.file);
56 static int config_buf_fgetc(struct config_source *conf)
58 if (conf->u.buf.pos < conf->u.buf.len)
59 return conf->u.buf.buf[conf->u.buf.pos++];
64 static int config_buf_ungetc(int c, struct config_source *conf)
66 if (conf->u.buf.pos > 0)
67 return conf->u.buf.buf[--conf->u.buf.pos];
72 static long config_buf_ftell(struct config_source *conf)
74 return conf->u.buf.pos;
77 #define MAX_INCLUDE_DEPTH 10
78 static const char include_depth_advice[] =
79 "exceeded maximum include depth (%d) while including\n"
83 "Do you have circular includes?";
84 static int handle_path_include(const char *path, struct config_include_data *inc)
87 struct strbuf buf = STRBUF_INIT;
91 return config_error_nonbool("include.path");
93 expanded = expand_user_path(path);
95 return error("Could not expand include path '%s'", path);
99 * Use an absolute path as-is, but interpret relative paths
100 * based on the including config file.
102 if (!is_absolute_path(path)) {
105 if (!cf || !cf->path)
106 return error("relative config includes must come from files");
108 slash = find_last_dir_sep(cf->path);
110 strbuf_add(&buf, cf->path, slash - cf->path + 1);
111 strbuf_addstr(&buf, path);
115 if (!access_or_die(path, R_OK, 0)) {
116 if (++inc->depth > MAX_INCLUDE_DEPTH)
117 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
118 cf && cf->name ? cf->name : "the command line");
119 ret = git_config_from_file(git_config_include, path, inc);
122 strbuf_release(&buf);
127 int git_config_include(const char *var, const char *value, void *data)
129 struct config_include_data *inc = data;
134 * Pass along all values, including "include" directives; this makes it
135 * possible to query information on the includes themselves.
137 ret = inc->fn(var, value, inc->data);
141 type = skip_prefix(var, "include.");
145 if (!strcmp(type, "path"))
146 ret = handle_path_include(value, inc);
150 void git_config_push_parameter(const char *text)
152 struct strbuf env = STRBUF_INIT;
153 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
155 strbuf_addstr(&env, old);
156 strbuf_addch(&env, ' ');
158 sq_quote_buf(&env, text);
159 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
160 strbuf_release(&env);
163 int git_config_parse_parameter(const char *text,
164 config_fn_t fn, void *data)
166 struct strbuf **pair;
167 pair = strbuf_split_str(text, '=', 2);
169 return error("bogus config parameter: %s", text);
170 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
171 strbuf_setlen(pair[0], pair[0]->len - 1);
172 strbuf_trim(pair[0]);
174 strbuf_list_free(pair);
175 return error("bogus config parameter: %s", text);
177 strbuf_tolower(pair[0]);
178 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
179 strbuf_list_free(pair);
182 strbuf_list_free(pair);
186 int git_config_from_parameters(config_fn_t fn, void *data)
188 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
190 const char **argv = NULL;
191 int nr = 0, alloc = 0;
196 /* sq_dequote will write over it */
199 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
201 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
204 for (i = 0; i < nr; i++) {
205 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
217 static int get_next_char(void)
219 int c = cf->do_fgetc(cf);
222 /* DOS like systems */
223 c = cf->do_fgetc(cf);
225 cf->do_ungetc(c, cf);
238 static char *parse_value(void)
240 int quote = 0, comment = 0, space = 0;
242 strbuf_reset(&cf->value);
244 int c = get_next_char();
250 return cf->value.buf;
254 if (isspace(c) && !quote) {
260 if (c == ';' || c == '#') {
265 for (; space; space--)
266 strbuf_addch(&cf->value, ' ');
281 /* Some characters escape as themselves */
284 /* Reject unknown escape sequences */
288 strbuf_addch(&cf->value, c);
295 strbuf_addch(&cf->value, c);
299 static inline int iskeychar(int c)
301 return isalnum(c) || c == '-';
304 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
309 /* Get the full name */
316 strbuf_addch(name, tolower(c));
319 while (c == ' ' || c == '\t')
326 value = parse_value();
330 return fn(name->buf, value, data);
333 static int get_extended_base_var(struct strbuf *name, int c)
337 goto error_incomplete_line;
339 } while (isspace(c));
341 /* We require the format to be '[base "extension"]' */
344 strbuf_addch(name, '.');
347 int c = get_next_char();
349 goto error_incomplete_line;
355 goto error_incomplete_line;
357 strbuf_addch(name, c);
361 if (get_next_char() != ']')
364 error_incomplete_line:
369 static int get_base_var(struct strbuf *name)
372 int c = get_next_char();
378 return get_extended_base_var(name, c);
379 if (!iskeychar(c) && c != '.')
381 strbuf_addch(name, tolower(c));
385 static int git_parse_source(config_fn_t fn, void *data)
389 struct strbuf *var = &cf->var;
391 /* U+FEFF Byte Order Mark in UTF8 */
392 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
393 const unsigned char *bomptr = utf8_bom;
396 int c = get_next_char();
397 if (bomptr && *bomptr) {
398 /* We are at the file beginning; skip UTF8-encoded BOM
399 * if present. Sane editors won't put this in on their
400 * own, but e.g. Windows Notepad will do it happily. */
401 if ((unsigned char) c == *bomptr) {
405 /* Do not tolerate partial BOM. */
406 if (bomptr != utf8_bom)
408 /* No BOM at file beginning. Cool. */
418 if (comment || isspace(c))
420 if (c == '#' || c == ';') {
425 /* Reset prior to determining a new stem */
427 if (get_base_var(var) < 0 || var->len < 1)
429 strbuf_addch(var, '.');
436 * Truncate the var name back to the section header
437 * stem prior to grabbing the suffix part of the name
440 strbuf_setlen(var, baselen);
441 strbuf_addch(var, tolower(c));
442 if (get_value(fn, data, var) < 0)
445 if (cf->die_on_error)
446 die("bad config file line %d in %s", cf->linenr, cf->name);
448 return error("bad config file line %d in %s", cf->linenr, cf->name);
451 static int parse_unit_factor(const char *end, uintmax_t *val)
455 else if (!strcasecmp(end, "k")) {
459 else if (!strcasecmp(end, "m")) {
463 else if (!strcasecmp(end, "g")) {
464 *val *= 1024 * 1024 * 1024;
470 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
472 if (value && *value) {
476 uintmax_t factor = 1;
479 val = strtoimax(value, &end, 0);
482 if (!parse_unit_factor(end, &factor)) {
488 if (uval > max || abs(val) > uval) {
500 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
502 if (value && *value) {
508 val = strtoumax(value, &end, 0);
512 if (!parse_unit_factor(end, &val)) {
516 if (val > max || oldval > val) {
527 static int git_parse_int(const char *value, int *ret)
530 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
536 static int git_parse_int64(const char *value, int64_t *ret)
539 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
545 int git_parse_ulong(const char *value, unsigned long *ret)
548 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
555 static void die_bad_number(const char *name, const char *value)
557 const char *reason = errno == ERANGE ?
564 die("bad numeric config value '%s' for '%s' in %s: %s",
565 value, name, cf->name, reason);
566 die("bad numeric config value '%s' for '%s': %s", value, name, reason);
569 int git_config_int(const char *name, const char *value)
572 if (!git_parse_int(value, &ret))
573 die_bad_number(name, value);
577 int64_t git_config_int64(const char *name, const char *value)
580 if (!git_parse_int64(value, &ret))
581 die_bad_number(name, value);
585 unsigned long git_config_ulong(const char *name, const char *value)
588 if (!git_parse_ulong(value, &ret))
589 die_bad_number(name, value);
593 static int git_config_maybe_bool_text(const char *name, const char *value)
599 if (!strcasecmp(value, "true")
600 || !strcasecmp(value, "yes")
601 || !strcasecmp(value, "on"))
603 if (!strcasecmp(value, "false")
604 || !strcasecmp(value, "no")
605 || !strcasecmp(value, "off"))
610 int git_config_maybe_bool(const char *name, const char *value)
612 int v = git_config_maybe_bool_text(name, value);
615 if (git_parse_int(value, &v))
620 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
622 int v = git_config_maybe_bool_text(name, value);
628 return git_config_int(name, value);
631 int git_config_bool(const char *name, const char *value)
634 return !!git_config_bool_or_int(name, value, &discard);
637 int git_config_string(const char **dest, const char *var, const char *value)
640 return config_error_nonbool(var);
641 *dest = xstrdup(value);
645 int git_config_pathname(const char **dest, const char *var, const char *value)
648 return config_error_nonbool(var);
649 *dest = expand_user_path(value);
651 die("Failed to expand user dir in: '%s'", value);
655 static int git_default_core_config(const char *var, const char *value)
657 /* This needs a better name */
658 if (!strcmp(var, "core.filemode")) {
659 trust_executable_bit = git_config_bool(var, value);
662 if (!strcmp(var, "core.trustctime")) {
663 trust_ctime = git_config_bool(var, value);
666 if (!strcmp(var, "core.checkstat")) {
667 if (!strcasecmp(value, "default"))
669 else if (!strcasecmp(value, "minimal"))
673 if (!strcmp(var, "core.quotepath")) {
674 quote_path_fully = git_config_bool(var, value);
678 if (!strcmp(var, "core.symlinks")) {
679 has_symlinks = git_config_bool(var, value);
683 if (!strcmp(var, "core.ignorecase")) {
684 ignore_case = git_config_bool(var, value);
688 if (!strcmp(var, "core.attributesfile"))
689 return git_config_pathname(&git_attributes_file, var, value);
691 if (!strcmp(var, "core.bare")) {
692 is_bare_repository_cfg = git_config_bool(var, value);
696 if (!strcmp(var, "core.ignorestat")) {
697 assume_unchanged = git_config_bool(var, value);
701 if (!strcmp(var, "core.prefersymlinkrefs")) {
702 prefer_symlink_refs = git_config_bool(var, value);
706 if (!strcmp(var, "core.logallrefupdates")) {
707 log_all_ref_updates = git_config_bool(var, value);
711 if (!strcmp(var, "core.warnambiguousrefs")) {
712 warn_ambiguous_refs = git_config_bool(var, value);
716 if (!strcmp(var, "core.abbrev")) {
717 int abbrev = git_config_int(var, value);
718 if (abbrev < minimum_abbrev || abbrev > 40)
720 default_abbrev = abbrev;
724 if (!strcmp(var, "core.loosecompression")) {
725 int level = git_config_int(var, value);
727 level = Z_DEFAULT_COMPRESSION;
728 else if (level < 0 || level > Z_BEST_COMPRESSION)
729 die("bad zlib compression level %d", level);
730 zlib_compression_level = level;
731 zlib_compression_seen = 1;
735 if (!strcmp(var, "core.compression")) {
736 int level = git_config_int(var, value);
738 level = Z_DEFAULT_COMPRESSION;
739 else if (level < 0 || level > Z_BEST_COMPRESSION)
740 die("bad zlib compression level %d", level);
741 core_compression_level = level;
742 core_compression_seen = 1;
743 if (!zlib_compression_seen)
744 zlib_compression_level = level;
748 if (!strcmp(var, "core.packedgitwindowsize")) {
749 int pgsz_x2 = getpagesize() * 2;
750 packed_git_window_size = git_config_ulong(var, value);
752 /* This value must be multiple of (pagesize * 2) */
753 packed_git_window_size /= pgsz_x2;
754 if (packed_git_window_size < 1)
755 packed_git_window_size = 1;
756 packed_git_window_size *= pgsz_x2;
760 if (!strcmp(var, "core.bigfilethreshold")) {
761 big_file_threshold = git_config_ulong(var, value);
765 if (!strcmp(var, "core.packedgitlimit")) {
766 packed_git_limit = git_config_ulong(var, value);
770 if (!strcmp(var, "core.deltabasecachelimit")) {
771 delta_base_cache_limit = git_config_ulong(var, value);
775 if (!strcmp(var, "core.autocrlf")) {
776 if (value && !strcasecmp(value, "input")) {
777 if (core_eol == EOL_CRLF)
778 return error("core.autocrlf=input conflicts with core.eol=crlf");
779 auto_crlf = AUTO_CRLF_INPUT;
782 auto_crlf = git_config_bool(var, value);
786 if (!strcmp(var, "core.safecrlf")) {
787 if (value && !strcasecmp(value, "warn")) {
788 safe_crlf = SAFE_CRLF_WARN;
791 safe_crlf = git_config_bool(var, value);
795 if (!strcmp(var, "core.eol")) {
796 if (value && !strcasecmp(value, "lf"))
798 else if (value && !strcasecmp(value, "crlf"))
800 else if (value && !strcasecmp(value, "native"))
801 core_eol = EOL_NATIVE;
803 core_eol = EOL_UNSET;
804 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
805 return error("core.autocrlf=input conflicts with core.eol=crlf");
809 if (!strcmp(var, "core.notesref")) {
810 notes_ref_name = xstrdup(value);
814 if (!strcmp(var, "core.pager"))
815 return git_config_string(&pager_program, var, value);
817 if (!strcmp(var, "core.editor"))
818 return git_config_string(&editor_program, var, value);
820 if (!strcmp(var, "core.commentchar")) {
822 int ret = git_config_string(&comment, var, value);
824 comment_line_char = comment[0];
828 if (!strcmp(var, "core.askpass"))
829 return git_config_string(&askpass_program, var, value);
831 if (!strcmp(var, "core.excludesfile"))
832 return git_config_pathname(&excludes_file, var, value);
834 if (!strcmp(var, "core.whitespace")) {
836 return config_error_nonbool(var);
837 whitespace_rule_cfg = parse_whitespace_rule(value);
841 if (!strcmp(var, "core.fsyncobjectfiles")) {
842 fsync_object_files = git_config_bool(var, value);
846 if (!strcmp(var, "core.preloadindex")) {
847 core_preload_index = git_config_bool(var, value);
851 if (!strcmp(var, "core.createobject")) {
852 if (!strcmp(value, "rename"))
853 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
854 else if (!strcmp(value, "link"))
855 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
857 die("Invalid mode for object creation: %s", value);
861 if (!strcmp(var, "core.sparsecheckout")) {
862 core_apply_sparse_checkout = git_config_bool(var, value);
866 if (!strcmp(var, "core.precomposeunicode")) {
867 precomposed_unicode = git_config_bool(var, value);
871 /* Add other config variables here and to Documentation/config.txt. */
875 static int git_default_i18n_config(const char *var, const char *value)
877 if (!strcmp(var, "i18n.commitencoding"))
878 return git_config_string(&git_commit_encoding, var, value);
880 if (!strcmp(var, "i18n.logoutputencoding"))
881 return git_config_string(&git_log_output_encoding, var, value);
883 /* Add other config variables here and to Documentation/config.txt. */
887 static int git_default_branch_config(const char *var, const char *value)
889 if (!strcmp(var, "branch.autosetupmerge")) {
890 if (value && !strcasecmp(value, "always")) {
891 git_branch_track = BRANCH_TRACK_ALWAYS;
894 git_branch_track = git_config_bool(var, value);
897 if (!strcmp(var, "branch.autosetuprebase")) {
899 return config_error_nonbool(var);
900 else if (!strcmp(value, "never"))
901 autorebase = AUTOREBASE_NEVER;
902 else if (!strcmp(value, "local"))
903 autorebase = AUTOREBASE_LOCAL;
904 else if (!strcmp(value, "remote"))
905 autorebase = AUTOREBASE_REMOTE;
906 else if (!strcmp(value, "always"))
907 autorebase = AUTOREBASE_ALWAYS;
909 return error("Malformed value for %s", var);
913 /* Add other config variables here and to Documentation/config.txt. */
917 static int git_default_push_config(const char *var, const char *value)
919 if (!strcmp(var, "push.default")) {
921 return config_error_nonbool(var);
922 else if (!strcmp(value, "nothing"))
923 push_default = PUSH_DEFAULT_NOTHING;
924 else if (!strcmp(value, "matching"))
925 push_default = PUSH_DEFAULT_MATCHING;
926 else if (!strcmp(value, "simple"))
927 push_default = PUSH_DEFAULT_SIMPLE;
928 else if (!strcmp(value, "upstream"))
929 push_default = PUSH_DEFAULT_UPSTREAM;
930 else if (!strcmp(value, "tracking")) /* deprecated */
931 push_default = PUSH_DEFAULT_UPSTREAM;
932 else if (!strcmp(value, "current"))
933 push_default = PUSH_DEFAULT_CURRENT;
935 error("Malformed value for %s: %s", var, value);
936 return error("Must be one of nothing, matching, simple, "
937 "upstream or current.");
942 /* Add other config variables here and to Documentation/config.txt. */
946 static int git_default_mailmap_config(const char *var, const char *value)
948 if (!strcmp(var, "mailmap.file"))
949 return git_config_string(&git_mailmap_file, var, value);
950 if (!strcmp(var, "mailmap.blob"))
951 return git_config_string(&git_mailmap_blob, var, value);
953 /* Add other config variables here and to Documentation/config.txt. */
957 int git_default_config(const char *var, const char *value, void *dummy)
959 if (starts_with(var, "core."))
960 return git_default_core_config(var, value);
962 if (starts_with(var, "user."))
963 return git_ident_config(var, value, dummy);
965 if (starts_with(var, "i18n."))
966 return git_default_i18n_config(var, value);
968 if (starts_with(var, "branch."))
969 return git_default_branch_config(var, value);
971 if (starts_with(var, "push."))
972 return git_default_push_config(var, value);
974 if (starts_with(var, "mailmap."))
975 return git_default_mailmap_config(var, value);
977 if (starts_with(var, "advice."))
978 return git_default_advice_config(var, value);
980 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
981 pager_use_color = git_config_bool(var,value);
985 if (!strcmp(var, "pack.packsizelimit")) {
986 pack_size_limit_cfg = git_config_ulong(var, value);
989 /* Add other config variables here and to Documentation/config.txt. */
994 * All source specific fields in the union, die_on_error, name and the callbacks
995 * fgetc, ungetc, ftell of top need to be initialized before calling
998 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1002 /* push config-file parsing state stack */
1006 strbuf_init(&top->value, 1024);
1007 strbuf_init(&top->var, 1024);
1010 ret = git_parse_source(fn, data);
1012 /* pop config-file parsing state stack */
1013 strbuf_release(&top->value);
1014 strbuf_release(&top->var);
1020 static int do_config_from_file(config_fn_t fn,
1021 const char *name, const char *path, FILE *f, void *data)
1023 struct config_source top;
1028 top.die_on_error = 1;
1029 top.do_fgetc = config_file_fgetc;
1030 top.do_ungetc = config_file_ungetc;
1031 top.do_ftell = config_file_ftell;
1033 return do_config_from(&top, fn, data);
1036 static int git_config_from_stdin(config_fn_t fn, void *data)
1038 return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
1041 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1046 f = fopen(filename, "r");
1048 ret = do_config_from_file(fn, filename, filename, f, data);
1054 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1055 size_t len, void *data)
1057 struct config_source top;
1059 top.u.buf.buf = buf;
1060 top.u.buf.len = len;
1064 top.die_on_error = 0;
1065 top.do_fgetc = config_buf_fgetc;
1066 top.do_ungetc = config_buf_ungetc;
1067 top.do_ftell = config_buf_ftell;
1069 return do_config_from(&top, fn, data);
1072 static int git_config_from_blob_sha1(config_fn_t fn,
1074 const unsigned char *sha1,
1077 enum object_type type;
1082 buf = read_sha1_file(sha1, &type, &size);
1084 return error("unable to load config blob object '%s'", name);
1085 if (type != OBJ_BLOB) {
1087 return error("reference '%s' does not point to a blob", name);
1090 ret = git_config_from_buf(fn, name, buf, size, data);
1096 static int git_config_from_blob_ref(config_fn_t fn,
1100 unsigned char sha1[20];
1102 if (get_sha1(name, sha1) < 0)
1103 return error("unable to resolve config blob '%s'", name);
1104 return git_config_from_blob_sha1(fn, name, sha1, data);
1107 const char *git_etc_gitconfig(void)
1109 static const char *system_wide;
1111 system_wide = system_path(ETC_GITCONFIG);
1115 int git_env_bool(const char *k, int def)
1117 const char *v = getenv(k);
1118 return v ? git_config_bool(k, v) : def;
1121 int git_config_system(void)
1123 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1126 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1128 int ret = 0, found = 0;
1129 char *xdg_config = NULL;
1130 char *user_config = NULL;
1132 home_config_paths(&user_config, &xdg_config, "config");
1134 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1135 ret += git_config_from_file(fn, git_etc_gitconfig(),
1140 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1141 ret += git_config_from_file(fn, xdg_config, data);
1145 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1146 ret += git_config_from_file(fn, user_config, data);
1150 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1151 ret += git_config_from_file(fn, repo_config, data);
1155 switch (git_config_from_parameters(fn, data)) {
1156 case -1: /* error */
1157 die("unable to parse command-line config");
1159 case 0: /* found nothing */
1161 default: /* found at least one item */
1168 return ret == 0 ? found : ret;
1171 int git_config_with_options(config_fn_t fn, void *data,
1172 struct git_config_source *config_source,
1173 int respect_includes)
1175 char *repo_config = NULL;
1177 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1179 if (respect_includes) {
1182 fn = git_config_include;
1187 * If we have a specific filename, use it. Otherwise, follow the
1188 * regular lookup sequence.
1190 if (config_source && config_source->use_stdin)
1191 return git_config_from_stdin(fn, data);
1192 else if (config_source && config_source->file)
1193 return git_config_from_file(fn, config_source->file, data);
1194 else if (config_source && config_source->blob)
1195 return git_config_from_blob_ref(fn, config_source->blob, data);
1197 repo_config = git_pathdup("config");
1198 ret = git_config_early(fn, data, repo_config);
1204 int git_config(config_fn_t fn, void *data)
1206 return git_config_with_options(fn, data, NULL, 1);
1210 * Find all the stuff for git_config_set() below.
1217 regex_t *value_regex;
1220 unsigned int offset_alloc;
1221 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1225 static int matches(const char *key, const char *value)
1227 return !strcmp(key, store.key) &&
1228 (store.value_regex == NULL ||
1229 (store.do_not_match ^
1230 !regexec(store.value_regex, value, 0, NULL, 0)));
1233 static int store_aux(const char *key, const char *value, void *cb)
1238 switch (store.state) {
1240 if (matches(key, value)) {
1241 if (store.seen == 1 && store.multi_replace == 0) {
1242 warning("%s has multiple values", key);
1245 ALLOC_GROW(store.offset, store.seen + 1,
1246 store.offset_alloc);
1248 store.offset[store.seen] = cf->do_ftell(cf);
1254 * What we are looking for is in store.key (both
1255 * section and var), and its section part is baselen
1256 * long. We found key (again, both section and var).
1257 * We would want to know if this key is in the same
1258 * section as what we are looking for. We already
1259 * know we are in the same section as what should
1262 ep = strrchr(key, '.');
1263 section_len = ep - key;
1265 if ((section_len != store.baselen) ||
1266 memcmp(key, store.key, section_len+1)) {
1267 store.state = SECTION_END_SEEN;
1272 * Do not increment matches: this is no match, but we
1273 * just made sure we are in the desired section.
1275 ALLOC_GROW(store.offset, store.seen + 1,
1276 store.offset_alloc);
1277 store.offset[store.seen] = cf->do_ftell(cf);
1279 case SECTION_END_SEEN:
1281 if (matches(key, value)) {
1282 ALLOC_GROW(store.offset, store.seen + 1,
1283 store.offset_alloc);
1284 store.offset[store.seen] = cf->do_ftell(cf);
1285 store.state = KEY_SEEN;
1288 if (strrchr(key, '.') - key == store.baselen &&
1289 !strncmp(key, store.key, store.baselen)) {
1290 store.state = SECTION_SEEN;
1291 ALLOC_GROW(store.offset,
1293 store.offset_alloc);
1294 store.offset[store.seen] = cf->do_ftell(cf);
1301 static int write_error(const char *filename)
1303 error("failed to write new configuration file %s", filename);
1305 /* Same error code as "failed to rename". */
1309 static int store_write_section(int fd, const char *key)
1313 struct strbuf sb = STRBUF_INIT;
1315 dot = memchr(key, '.', store.baselen);
1317 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1318 for (i = dot - key + 1; i < store.baselen; i++) {
1319 if (key[i] == '"' || key[i] == '\\')
1320 strbuf_addch(&sb, '\\');
1321 strbuf_addch(&sb, key[i]);
1323 strbuf_addstr(&sb, "\"]\n");
1325 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1328 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1329 strbuf_release(&sb);
1334 static int store_write_pair(int fd, const char *key, const char *value)
1337 int length = strlen(key + store.baselen + 1);
1338 const char *quote = "";
1339 struct strbuf sb = STRBUF_INIT;
1342 * Check to see if the value needs to be surrounded with a dq pair.
1343 * Note that problematic characters are always backslash-quoted; this
1344 * check is about not losing leading or trailing SP and strings that
1345 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1346 * configuration parser.
1348 if (value[0] == ' ')
1350 for (i = 0; value[i]; i++)
1351 if (value[i] == ';' || value[i] == '#')
1353 if (i && value[i - 1] == ' ')
1356 strbuf_addf(&sb, "\t%.*s = %s",
1357 length, key + store.baselen + 1, quote);
1359 for (i = 0; value[i]; i++)
1362 strbuf_addstr(&sb, "\\n");
1365 strbuf_addstr(&sb, "\\t");
1369 strbuf_addch(&sb, '\\');
1371 strbuf_addch(&sb, value[i]);
1374 strbuf_addf(&sb, "%s\n", quote);
1376 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1377 strbuf_release(&sb);
1382 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1383 size_t offset_, int *found_bracket)
1385 size_t equal_offset = size, bracket_offset = size;
1389 for (offset = offset_-2; offset > 0
1390 && contents[offset] != '\n'; offset--)
1391 switch (contents[offset]) {
1392 case '=': equal_offset = offset; break;
1393 case ']': bracket_offset = offset; break;
1395 if (offset > 0 && contents[offset-1] == '\\') {
1399 if (bracket_offset < equal_offset) {
1401 offset = bracket_offset+1;
1408 int git_config_set_in_file(const char *config_filename,
1409 const char *key, const char *value)
1411 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1414 int git_config_set(const char *key, const char *value)
1416 return git_config_set_multivar(key, value, NULL, 0);
1420 * Auxiliary function to sanity-check and split the key into the section
1421 * identifier and variable name.
1423 * Returns 0 on success, -1 when there is an invalid character in the key and
1424 * -2 if there is no section name in the key.
1426 * store_key - pointer to char* which will hold a copy of the key with
1427 * lowercase section and variable name
1428 * baselen - pointer to int which will hold the length of the
1429 * section + subsection part, can be NULL
1431 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1433 int i, dot, baselen;
1434 const char *last_dot = strrchr(key, '.');
1437 * Since "key" actually contains the section name and the real
1438 * key name separated by a dot, we have to know where the dot is.
1441 if (last_dot == NULL || last_dot == key) {
1442 error("key does not contain a section: %s", key);
1443 return -CONFIG_NO_SECTION_OR_NAME;
1447 error("key does not contain variable name: %s", key);
1448 return -CONFIG_NO_SECTION_OR_NAME;
1451 baselen = last_dot - key;
1453 *baselen_ = baselen;
1456 * Validate the key and while at it, lower case it for matching.
1458 *store_key = xmalloc(strlen(key) + 1);
1461 for (i = 0; key[i]; i++) {
1462 unsigned char c = key[i];
1465 /* Leave the extended basename untouched.. */
1466 if (!dot || i > baselen) {
1467 if (!iskeychar(c) ||
1468 (i == baselen + 1 && !isalpha(c))) {
1469 error("invalid key: %s", key);
1470 goto out_free_ret_1;
1473 } else if (c == '\n') {
1474 error("invalid key (newline): %s", key);
1475 goto out_free_ret_1;
1477 (*store_key)[i] = c;
1479 (*store_key)[i] = 0;
1486 return -CONFIG_INVALID_KEY;
1490 * If value==NULL, unset in (remove from) config,
1491 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1492 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1493 * else all matching key/values (regardless how many) are removed,
1494 * before the new pair is written.
1496 * Returns 0 on success.
1498 * This function does this:
1500 * - it locks the config file by creating ".git/config.lock"
1502 * - it then parses the config using store_aux() as validator to find
1503 * the position on the key/value pair to replace. If it is to be unset,
1504 * it must be found exactly once.
1506 * - the config file is mmap()ed and the part before the match (if any) is
1507 * written to the lock file, then the changed part and the rest.
1509 * - the config file is removed and the lock file rename()d to it.
1512 int git_config_set_multivar_in_file(const char *config_filename,
1513 const char *key, const char *value,
1514 const char *value_regex, int multi_replace)
1518 struct lock_file *lock = NULL;
1519 char *filename_buf = NULL;
1521 /* parse-key returns negative; flip the sign to feed exit(3) */
1522 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1526 store.multi_replace = multi_replace;
1528 if (!config_filename)
1529 config_filename = filename_buf = git_pathdup("config");
1532 * The lock serves a purpose in addition to locking: the new
1533 * contents of .git/config will be written into it.
1535 lock = xcalloc(sizeof(struct lock_file), 1);
1536 fd = hold_lock_file_for_update(lock, config_filename, 0);
1538 error("could not lock config file %s: %s", config_filename, strerror(errno));
1540 ret = CONFIG_NO_LOCK;
1545 * If .git/config does not exist yet, write a minimal version.
1547 in_fd = open(config_filename, O_RDONLY);
1551 if ( ENOENT != errno ) {
1552 error("opening %s: %s", config_filename,
1554 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1557 /* if nothing to unset, error out */
1558 if (value == NULL) {
1559 ret = CONFIG_NOTHING_SET;
1563 store.key = (char *)key;
1564 if (!store_write_section(fd, key) ||
1565 !store_write_pair(fd, key, value))
1570 size_t contents_sz, copy_begin, copy_end;
1571 int i, new_line = 0;
1573 if (value_regex == NULL)
1574 store.value_regex = NULL;
1576 if (value_regex[0] == '!') {
1577 store.do_not_match = 1;
1580 store.do_not_match = 0;
1582 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1583 if (regcomp(store.value_regex, value_regex,
1585 error("invalid pattern: %s", value_regex);
1586 free(store.value_regex);
1587 ret = CONFIG_INVALID_PATTERN;
1592 ALLOC_GROW(store.offset, 1, store.offset_alloc);
1593 store.offset[0] = 0;
1594 store.state = START;
1598 * After this, store.offset will contain the *end* offset
1599 * of the last match, or remain at 0 if no match was found.
1600 * As a side effect, we make sure to transform only a valid
1601 * existing config file.
1603 if (git_config_from_file(store_aux, config_filename, NULL)) {
1604 error("invalid config file %s", config_filename);
1606 if (store.value_regex != NULL) {
1607 regfree(store.value_regex);
1608 free(store.value_regex);
1610 ret = CONFIG_INVALID_FILE;
1615 if (store.value_regex != NULL) {
1616 regfree(store.value_regex);
1617 free(store.value_regex);
1620 /* if nothing to unset, or too many matches, error out */
1621 if ((store.seen == 0 && value == NULL) ||
1622 (store.seen > 1 && multi_replace == 0)) {
1623 ret = CONFIG_NOTHING_SET;
1628 contents_sz = xsize_t(st.st_size);
1629 contents = xmmap(NULL, contents_sz, PROT_READ,
1630 MAP_PRIVATE, in_fd, 0);
1633 if (store.seen == 0)
1636 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1637 if (store.offset[i] == 0) {
1638 store.offset[i] = copy_end = contents_sz;
1639 } else if (store.state != KEY_SEEN) {
1640 copy_end = store.offset[i];
1642 copy_end = find_beginning_of_line(
1643 contents, contents_sz,
1644 store.offset[i]-2, &new_line);
1646 if (copy_end > 0 && contents[copy_end-1] != '\n')
1649 /* write the first part of the config */
1650 if (copy_end > copy_begin) {
1651 if (write_in_full(fd, contents + copy_begin,
1652 copy_end - copy_begin) <
1653 copy_end - copy_begin)
1656 write_str_in_full(fd, "\n") != 1)
1659 copy_begin = store.offset[i];
1662 /* write the pair (value == NULL means unset) */
1663 if (value != NULL) {
1664 if (store.state == START) {
1665 if (!store_write_section(fd, key))
1668 if (!store_write_pair(fd, key, value))
1672 /* write the rest of the config */
1673 if (copy_begin < contents_sz)
1674 if (write_in_full(fd, contents + copy_begin,
1675 contents_sz - copy_begin) <
1676 contents_sz - copy_begin)
1679 munmap(contents, contents_sz);
1682 if (commit_lock_file(lock) < 0) {
1683 error("could not commit config file %s", config_filename);
1684 ret = CONFIG_NO_WRITE;
1689 * lock is committed, so don't try to roll it back below.
1690 * NOTE: Since lockfile.c keeps a linked list of all created
1691 * lock_file structures, it isn't safe to free(lock). It's
1692 * better to just leave it hanging around.
1699 rollback_lock_file(lock);
1704 ret = write_error(lock->filename);
1709 int git_config_set_multivar(const char *key, const char *value,
1710 const char *value_regex, int multi_replace)
1712 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1716 static int section_name_match (const char *buf, const char *name)
1718 int i = 0, j = 0, dot = 0;
1721 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1722 if (!dot && isspace(buf[i])) {
1724 if (name[j++] != '.')
1726 for (i++; isspace(buf[i]); i++)
1732 if (buf[i] == '\\' && dot)
1734 else if (buf[i] == '"' && dot) {
1735 for (i++; isspace(buf[i]); i++)
1739 if (buf[i] != name[j++])
1742 if (buf[i] == ']' && name[j] == 0) {
1744 * We match, now just find the right length offset by
1745 * gobbling up any whitespace after it, as well
1748 for (; buf[i] && isspace(buf[i]); i++)
1755 static int section_name_is_ok(const char *name)
1757 /* Empty section names are bogus. */
1762 * Before a dot, we must be alphanumeric or dash. After the first dot,
1763 * anything goes, so we can stop checking.
1765 for (; *name && *name != '.'; name++)
1766 if (*name != '-' && !isalnum(*name))
1771 /* if new_name == NULL, the section is removed instead */
1772 int git_config_rename_section_in_file(const char *config_filename,
1773 const char *old_name, const char *new_name)
1775 int ret = 0, remove = 0;
1776 char *filename_buf = NULL;
1777 struct lock_file *lock;
1782 if (new_name && !section_name_is_ok(new_name)) {
1783 ret = error("invalid section name: %s", new_name);
1787 if (!config_filename)
1788 config_filename = filename_buf = git_pathdup("config");
1790 lock = xcalloc(sizeof(struct lock_file), 1);
1791 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1793 ret = error("could not lock config file %s", config_filename);
1797 if (!(config_file = fopen(config_filename, "rb"))) {
1798 /* no config file means nothing to rename, no error */
1799 goto unlock_and_out;
1802 while (fgets(buf, sizeof(buf), config_file)) {
1806 for (i = 0; buf[i] && isspace(buf[i]); i++)
1808 if (buf[i] == '[') {
1809 /* it's a section */
1810 int offset = section_name_match(&buf[i], old_name);
1813 if (new_name == NULL) {
1817 store.baselen = strlen(new_name);
1818 if (!store_write_section(out_fd, new_name)) {
1819 ret = write_error(lock->filename);
1823 * We wrote out the new section, with
1824 * a newline, now skip the old
1827 output += offset + i;
1828 if (strlen(output) > 0) {
1830 * More content means there's
1831 * a declaration to put on the
1832 * next line; indent with a
1843 length = strlen(output);
1844 if (write_in_full(out_fd, output, length) != length) {
1845 ret = write_error(lock->filename);
1849 fclose(config_file);
1851 if (commit_lock_file(lock) < 0)
1852 ret = error("could not commit config file %s", config_filename);
1858 int git_config_rename_section(const char *old_name, const char *new_name)
1860 return git_config_rename_section_in_file(NULL, old_name, new_name);
1864 * Call this to report error for your variable that should not
1865 * get a boolean value (i.e. "[my] var" means "true").
1867 #undef config_error_nonbool
1868 int config_error_nonbool(const char *var)
1870 return error("Missing value for '%s'", var);
1873 int parse_config_key(const char *var,
1874 const char *section,
1875 const char **subsection, int *subsection_len,
1878 int section_len = strlen(section);
1881 /* Does it start with "section." ? */
1882 if (!starts_with(var, section) || var[section_len] != '.')
1886 * Find the key; we don't know yet if we have a subsection, but we must
1887 * parse backwards from the end, since the subsection may have dots in
1890 dot = strrchr(var, '.');
1893 /* Did we have a subsection at all? */
1894 if (dot == var + section_len) {
1896 *subsection_len = 0;
1899 *subsection = var + section_len + 1;
1900 *subsection_len = dot - *subsection;