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 static void lowercase(char *p)
156 void git_config_push_parameter(const char *text)
158 struct strbuf env = STRBUF_INIT;
159 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
161 strbuf_addstr(&env, old);
162 strbuf_addch(&env, ' ');
164 sq_quote_buf(&env, text);
165 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
166 strbuf_release(&env);
169 int git_config_parse_parameter(const char *text,
170 config_fn_t fn, void *data)
172 struct strbuf **pair;
173 pair = strbuf_split_str(text, '=', 2);
175 return error("bogus config parameter: %s", text);
176 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
177 strbuf_setlen(pair[0], pair[0]->len - 1);
178 strbuf_trim(pair[0]);
180 strbuf_list_free(pair);
181 return error("bogus config parameter: %s", text);
183 lowercase(pair[0]->buf);
184 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
185 strbuf_list_free(pair);
188 strbuf_list_free(pair);
192 int git_config_from_parameters(config_fn_t fn, void *data)
194 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
196 const char **argv = NULL;
197 int nr = 0, alloc = 0;
202 /* sq_dequote will write over it */
205 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
207 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
210 for (i = 0; i < nr; i++) {
211 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
223 static int get_next_char(void)
225 int c = cf->do_fgetc(cf);
228 /* DOS like systems */
229 c = cf->do_fgetc(cf);
231 cf->do_ungetc(c, cf);
244 static char *parse_value(void)
246 int quote = 0, comment = 0, space = 0;
248 strbuf_reset(&cf->value);
250 int c = get_next_char();
256 return cf->value.buf;
260 if (isspace(c) && !quote) {
266 if (c == ';' || c == '#') {
271 for (; space; space--)
272 strbuf_addch(&cf->value, ' ');
287 /* Some characters escape as themselves */
290 /* Reject unknown escape sequences */
294 strbuf_addch(&cf->value, c);
301 strbuf_addch(&cf->value, c);
305 static inline int iskeychar(int c)
307 return isalnum(c) || c == '-';
310 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
315 /* Get the full name */
322 strbuf_addch(name, tolower(c));
325 while (c == ' ' || c == '\t')
332 value = parse_value();
336 return fn(name->buf, value, data);
339 static int get_extended_base_var(struct strbuf *name, int c)
343 goto error_incomplete_line;
345 } while (isspace(c));
347 /* We require the format to be '[base "extension"]' */
350 strbuf_addch(name, '.');
353 int c = get_next_char();
355 goto error_incomplete_line;
361 goto error_incomplete_line;
363 strbuf_addch(name, c);
367 if (get_next_char() != ']')
370 error_incomplete_line:
375 static int get_base_var(struct strbuf *name)
378 int c = get_next_char();
384 return get_extended_base_var(name, c);
385 if (!iskeychar(c) && c != '.')
387 strbuf_addch(name, tolower(c));
391 static int git_parse_source(config_fn_t fn, void *data)
395 struct strbuf *var = &cf->var;
397 /* U+FEFF Byte Order Mark in UTF8 */
398 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
399 const unsigned char *bomptr = utf8_bom;
402 int c = get_next_char();
403 if (bomptr && *bomptr) {
404 /* We are at the file beginning; skip UTF8-encoded BOM
405 * if present. Sane editors won't put this in on their
406 * own, but e.g. Windows Notepad will do it happily. */
407 if ((unsigned char) c == *bomptr) {
411 /* Do not tolerate partial BOM. */
412 if (bomptr != utf8_bom)
414 /* No BOM at file beginning. Cool. */
424 if (comment || isspace(c))
426 if (c == '#' || c == ';') {
431 /* Reset prior to determining a new stem */
433 if (get_base_var(var) < 0 || var->len < 1)
435 strbuf_addch(var, '.');
442 * Truncate the var name back to the section header
443 * stem prior to grabbing the suffix part of the name
446 strbuf_setlen(var, baselen);
447 strbuf_addch(var, tolower(c));
448 if (get_value(fn, data, var) < 0)
451 if (cf->die_on_error)
452 die("bad config file line %d in %s", cf->linenr, cf->name);
454 return error("bad config file line %d in %s", cf->linenr, cf->name);
457 static int parse_unit_factor(const char *end, uintmax_t *val)
461 else if (!strcasecmp(end, "k")) {
465 else if (!strcasecmp(end, "m")) {
469 else if (!strcasecmp(end, "g")) {
470 *val *= 1024 * 1024 * 1024;
476 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
478 if (value && *value) {
482 uintmax_t factor = 1;
485 val = strtoimax(value, &end, 0);
488 if (!parse_unit_factor(end, &factor)) {
494 if (uval > max || abs(val) > uval) {
506 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
508 if (value && *value) {
514 val = strtoumax(value, &end, 0);
518 if (!parse_unit_factor(end, &val)) {
522 if (val > max || oldval > val) {
533 static int git_parse_int(const char *value, int *ret)
536 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
542 static int git_parse_int64(const char *value, int64_t *ret)
545 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
551 int git_parse_ulong(const char *value, unsigned long *ret)
554 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
561 static void die_bad_number(const char *name, const char *value)
563 const char *reason = errno == ERANGE ?
570 die("bad numeric config value '%s' for '%s' in %s: %s",
571 value, name, cf->name, reason);
572 die("bad numeric config value '%s' for '%s': %s", value, name, reason);
575 int git_config_int(const char *name, const char *value)
578 if (!git_parse_int(value, &ret))
579 die_bad_number(name, value);
583 int64_t git_config_int64(const char *name, const char *value)
586 if (!git_parse_int64(value, &ret))
587 die_bad_number(name, value);
591 unsigned long git_config_ulong(const char *name, const char *value)
594 if (!git_parse_ulong(value, &ret))
595 die_bad_number(name, value);
599 static int git_config_maybe_bool_text(const char *name, const char *value)
605 if (!strcasecmp(value, "true")
606 || !strcasecmp(value, "yes")
607 || !strcasecmp(value, "on"))
609 if (!strcasecmp(value, "false")
610 || !strcasecmp(value, "no")
611 || !strcasecmp(value, "off"))
616 int git_config_maybe_bool(const char *name, const char *value)
618 int v = git_config_maybe_bool_text(name, value);
621 if (git_parse_int(value, &v))
626 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
628 int v = git_config_maybe_bool_text(name, value);
634 return git_config_int(name, value);
637 int git_config_bool(const char *name, const char *value)
640 return !!git_config_bool_or_int(name, value, &discard);
643 int git_config_string(const char **dest, const char *var, const char *value)
646 return config_error_nonbool(var);
647 *dest = xstrdup(value);
651 int git_config_pathname(const char **dest, const char *var, const char *value)
654 return config_error_nonbool(var);
655 *dest = expand_user_path(value);
657 die("Failed to expand user dir in: '%s'", value);
661 static int git_default_core_config(const char *var, const char *value)
663 /* This needs a better name */
664 if (!strcmp(var, "core.filemode")) {
665 trust_executable_bit = git_config_bool(var, value);
668 if (!strcmp(var, "core.trustctime")) {
669 trust_ctime = git_config_bool(var, value);
672 if (!strcmp(var, "core.checkstat")) {
673 if (!strcasecmp(value, "default"))
675 else if (!strcasecmp(value, "minimal"))
679 if (!strcmp(var, "core.quotepath")) {
680 quote_path_fully = git_config_bool(var, value);
684 if (!strcmp(var, "core.symlinks")) {
685 has_symlinks = git_config_bool(var, value);
689 if (!strcmp(var, "core.ignorecase")) {
690 ignore_case = git_config_bool(var, value);
694 if (!strcmp(var, "core.attributesfile"))
695 return git_config_pathname(&git_attributes_file, var, value);
697 if (!strcmp(var, "core.bare")) {
698 is_bare_repository_cfg = git_config_bool(var, value);
702 if (!strcmp(var, "core.ignorestat")) {
703 assume_unchanged = git_config_bool(var, value);
707 if (!strcmp(var, "core.prefersymlinkrefs")) {
708 prefer_symlink_refs = git_config_bool(var, value);
712 if (!strcmp(var, "core.logallrefupdates")) {
713 log_all_ref_updates = git_config_bool(var, value);
717 if (!strcmp(var, "core.warnambiguousrefs")) {
718 warn_ambiguous_refs = git_config_bool(var, value);
722 if (!strcmp(var, "core.abbrev")) {
723 int abbrev = git_config_int(var, value);
724 if (abbrev < minimum_abbrev || abbrev > 40)
726 default_abbrev = abbrev;
730 if (!strcmp(var, "core.loosecompression")) {
731 int level = git_config_int(var, value);
733 level = Z_DEFAULT_COMPRESSION;
734 else if (level < 0 || level > Z_BEST_COMPRESSION)
735 die("bad zlib compression level %d", level);
736 zlib_compression_level = level;
737 zlib_compression_seen = 1;
741 if (!strcmp(var, "core.compression")) {
742 int level = git_config_int(var, value);
744 level = Z_DEFAULT_COMPRESSION;
745 else if (level < 0 || level > Z_BEST_COMPRESSION)
746 die("bad zlib compression level %d", level);
747 core_compression_level = level;
748 core_compression_seen = 1;
749 if (!zlib_compression_seen)
750 zlib_compression_level = level;
754 if (!strcmp(var, "core.packedgitwindowsize")) {
755 int pgsz_x2 = getpagesize() * 2;
756 packed_git_window_size = git_config_ulong(var, value);
758 /* This value must be multiple of (pagesize * 2) */
759 packed_git_window_size /= pgsz_x2;
760 if (packed_git_window_size < 1)
761 packed_git_window_size = 1;
762 packed_git_window_size *= pgsz_x2;
766 if (!strcmp(var, "core.bigfilethreshold")) {
767 big_file_threshold = git_config_ulong(var, value);
771 if (!strcmp(var, "core.packedgitlimit")) {
772 packed_git_limit = git_config_ulong(var, value);
776 if (!strcmp(var, "core.deltabasecachelimit")) {
777 delta_base_cache_limit = git_config_ulong(var, value);
781 if (!strcmp(var, "core.autocrlf")) {
782 if (value && !strcasecmp(value, "input")) {
783 if (core_eol == EOL_CRLF)
784 return error("core.autocrlf=input conflicts with core.eol=crlf");
785 auto_crlf = AUTO_CRLF_INPUT;
788 auto_crlf = git_config_bool(var, value);
792 if (!strcmp(var, "core.safecrlf")) {
793 if (value && !strcasecmp(value, "warn")) {
794 safe_crlf = SAFE_CRLF_WARN;
797 safe_crlf = git_config_bool(var, value);
801 if (!strcmp(var, "core.eol")) {
802 if (value && !strcasecmp(value, "lf"))
804 else if (value && !strcasecmp(value, "crlf"))
806 else if (value && !strcasecmp(value, "native"))
807 core_eol = EOL_NATIVE;
809 core_eol = EOL_UNSET;
810 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
811 return error("core.autocrlf=input conflicts with core.eol=crlf");
815 if (!strcmp(var, "core.notesref")) {
816 notes_ref_name = xstrdup(value);
820 if (!strcmp(var, "core.pager"))
821 return git_config_string(&pager_program, var, value);
823 if (!strcmp(var, "core.editor"))
824 return git_config_string(&editor_program, var, value);
826 if (!strcmp(var, "core.commentchar")) {
828 int ret = git_config_string(&comment, var, value);
831 else if (!strcasecmp(comment, "auto"))
832 auto_comment_line_char = 1;
833 else if (comment[0] && !comment[1]) {
834 comment_line_char = comment[0];
835 auto_comment_line_char = 0;
837 return error("core.commentChar should only be one character");
841 if (!strcmp(var, "core.askpass"))
842 return git_config_string(&askpass_program, var, value);
844 if (!strcmp(var, "core.excludesfile"))
845 return git_config_pathname(&excludes_file, var, value);
847 if (!strcmp(var, "core.whitespace")) {
849 return config_error_nonbool(var);
850 whitespace_rule_cfg = parse_whitespace_rule(value);
854 if (!strcmp(var, "core.fsyncobjectfiles")) {
855 fsync_object_files = git_config_bool(var, value);
859 if (!strcmp(var, "core.preloadindex")) {
860 core_preload_index = git_config_bool(var, value);
864 if (!strcmp(var, "core.createobject")) {
865 if (!strcmp(value, "rename"))
866 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
867 else if (!strcmp(value, "link"))
868 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
870 die("Invalid mode for object creation: %s", value);
874 if (!strcmp(var, "core.sparsecheckout")) {
875 core_apply_sparse_checkout = git_config_bool(var, value);
879 if (!strcmp(var, "core.precomposeunicode")) {
880 precomposed_unicode = git_config_bool(var, value);
884 /* Add other config variables here and to Documentation/config.txt. */
888 static int git_default_i18n_config(const char *var, const char *value)
890 if (!strcmp(var, "i18n.commitencoding"))
891 return git_config_string(&git_commit_encoding, var, value);
893 if (!strcmp(var, "i18n.logoutputencoding"))
894 return git_config_string(&git_log_output_encoding, var, value);
896 /* Add other config variables here and to Documentation/config.txt. */
900 static int git_default_branch_config(const char *var, const char *value)
902 if (!strcmp(var, "branch.autosetupmerge")) {
903 if (value && !strcasecmp(value, "always")) {
904 git_branch_track = BRANCH_TRACK_ALWAYS;
907 git_branch_track = git_config_bool(var, value);
910 if (!strcmp(var, "branch.autosetuprebase")) {
912 return config_error_nonbool(var);
913 else if (!strcmp(value, "never"))
914 autorebase = AUTOREBASE_NEVER;
915 else if (!strcmp(value, "local"))
916 autorebase = AUTOREBASE_LOCAL;
917 else if (!strcmp(value, "remote"))
918 autorebase = AUTOREBASE_REMOTE;
919 else if (!strcmp(value, "always"))
920 autorebase = AUTOREBASE_ALWAYS;
922 return error("Malformed value for %s", var);
926 /* Add other config variables here and to Documentation/config.txt. */
930 static int git_default_push_config(const char *var, const char *value)
932 if (!strcmp(var, "push.default")) {
934 return config_error_nonbool(var);
935 else if (!strcmp(value, "nothing"))
936 push_default = PUSH_DEFAULT_NOTHING;
937 else if (!strcmp(value, "matching"))
938 push_default = PUSH_DEFAULT_MATCHING;
939 else if (!strcmp(value, "simple"))
940 push_default = PUSH_DEFAULT_SIMPLE;
941 else if (!strcmp(value, "upstream"))
942 push_default = PUSH_DEFAULT_UPSTREAM;
943 else if (!strcmp(value, "tracking")) /* deprecated */
944 push_default = PUSH_DEFAULT_UPSTREAM;
945 else if (!strcmp(value, "current"))
946 push_default = PUSH_DEFAULT_CURRENT;
948 error("Malformed value for %s: %s", var, value);
949 return error("Must be one of nothing, matching, simple, "
950 "upstream or current.");
955 /* Add other config variables here and to Documentation/config.txt. */
959 static int git_default_mailmap_config(const char *var, const char *value)
961 if (!strcmp(var, "mailmap.file"))
962 return git_config_string(&git_mailmap_file, var, value);
963 if (!strcmp(var, "mailmap.blob"))
964 return git_config_string(&git_mailmap_blob, var, value);
966 /* Add other config variables here and to Documentation/config.txt. */
970 int git_default_config(const char *var, const char *value, void *dummy)
972 if (starts_with(var, "core."))
973 return git_default_core_config(var, value);
975 if (starts_with(var, "user."))
976 return git_ident_config(var, value, dummy);
978 if (starts_with(var, "i18n."))
979 return git_default_i18n_config(var, value);
981 if (starts_with(var, "branch."))
982 return git_default_branch_config(var, value);
984 if (starts_with(var, "push."))
985 return git_default_push_config(var, value);
987 if (starts_with(var, "mailmap."))
988 return git_default_mailmap_config(var, value);
990 if (starts_with(var, "advice."))
991 return git_default_advice_config(var, value);
993 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
994 pager_use_color = git_config_bool(var,value);
998 if (!strcmp(var, "pack.packsizelimit")) {
999 pack_size_limit_cfg = git_config_ulong(var, value);
1002 /* Add other config variables here and to Documentation/config.txt. */
1007 * All source specific fields in the union, die_on_error, name and the callbacks
1008 * fgetc, ungetc, ftell of top need to be initialized before calling
1011 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1015 /* push config-file parsing state stack */
1019 strbuf_init(&top->value, 1024);
1020 strbuf_init(&top->var, 1024);
1023 ret = git_parse_source(fn, data);
1025 /* pop config-file parsing state stack */
1026 strbuf_release(&top->value);
1027 strbuf_release(&top->var);
1033 static int do_config_from_file(config_fn_t fn,
1034 const char *name, const char *path, FILE *f, void *data)
1036 struct config_source top;
1041 top.die_on_error = 1;
1042 top.do_fgetc = config_file_fgetc;
1043 top.do_ungetc = config_file_ungetc;
1044 top.do_ftell = config_file_ftell;
1046 return do_config_from(&top, fn, data);
1049 static int git_config_from_stdin(config_fn_t fn, void *data)
1051 return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
1054 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1059 f = fopen(filename, "r");
1061 ret = do_config_from_file(fn, filename, filename, f, data);
1067 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1068 size_t len, void *data)
1070 struct config_source top;
1072 top.u.buf.buf = buf;
1073 top.u.buf.len = len;
1077 top.die_on_error = 0;
1078 top.do_fgetc = config_buf_fgetc;
1079 top.do_ungetc = config_buf_ungetc;
1080 top.do_ftell = config_buf_ftell;
1082 return do_config_from(&top, fn, data);
1085 static int git_config_from_blob_sha1(config_fn_t fn,
1087 const unsigned char *sha1,
1090 enum object_type type;
1095 buf = read_sha1_file(sha1, &type, &size);
1097 return error("unable to load config blob object '%s'", name);
1098 if (type != OBJ_BLOB) {
1100 return error("reference '%s' does not point to a blob", name);
1103 ret = git_config_from_buf(fn, name, buf, size, data);
1109 static int git_config_from_blob_ref(config_fn_t fn,
1113 unsigned char sha1[20];
1115 if (get_sha1(name, sha1) < 0)
1116 return error("unable to resolve config blob '%s'", name);
1117 return git_config_from_blob_sha1(fn, name, sha1, data);
1120 const char *git_etc_gitconfig(void)
1122 static const char *system_wide;
1124 system_wide = system_path(ETC_GITCONFIG);
1128 int git_env_bool(const char *k, int def)
1130 const char *v = getenv(k);
1131 return v ? git_config_bool(k, v) : def;
1134 int git_config_system(void)
1136 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1139 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1141 int ret = 0, found = 0;
1142 char *xdg_config = NULL;
1143 char *user_config = NULL;
1145 home_config_paths(&user_config, &xdg_config, "config");
1147 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1148 ret += git_config_from_file(fn, git_etc_gitconfig(),
1153 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1154 ret += git_config_from_file(fn, xdg_config, data);
1158 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1159 ret += git_config_from_file(fn, user_config, data);
1163 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1164 ret += git_config_from_file(fn, repo_config, data);
1168 switch (git_config_from_parameters(fn, data)) {
1169 case -1: /* error */
1170 die("unable to parse command-line config");
1172 case 0: /* found nothing */
1174 default: /* found at least one item */
1181 return ret == 0 ? found : ret;
1184 int git_config_with_options(config_fn_t fn, void *data,
1185 struct git_config_source *config_source,
1186 int respect_includes)
1188 char *repo_config = NULL;
1190 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1192 if (respect_includes) {
1195 fn = git_config_include;
1200 * If we have a specific filename, use it. Otherwise, follow the
1201 * regular lookup sequence.
1203 if (config_source && config_source->use_stdin)
1204 return git_config_from_stdin(fn, data);
1205 else if (config_source && config_source->file)
1206 return git_config_from_file(fn, config_source->file, data);
1207 else if (config_source && config_source->blob)
1208 return git_config_from_blob_ref(fn, config_source->blob, data);
1210 repo_config = git_pathdup("config");
1211 ret = git_config_early(fn, data, repo_config);
1217 int git_config(config_fn_t fn, void *data)
1219 return git_config_with_options(fn, data, NULL, 1);
1223 * Find all the stuff for git_config_set() below.
1230 regex_t *value_regex;
1233 unsigned int offset_alloc;
1234 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1238 static int matches(const char *key, const char *value)
1240 return !strcmp(key, store.key) &&
1241 (store.value_regex == NULL ||
1242 (store.do_not_match ^
1243 !regexec(store.value_regex, value, 0, NULL, 0)));
1246 static int store_aux(const char *key, const char *value, void *cb)
1251 switch (store.state) {
1253 if (matches(key, value)) {
1254 if (store.seen == 1 && store.multi_replace == 0) {
1255 warning("%s has multiple values", key);
1258 ALLOC_GROW(store.offset, store.seen + 1,
1259 store.offset_alloc);
1261 store.offset[store.seen] = cf->do_ftell(cf);
1267 * What we are looking for is in store.key (both
1268 * section and var), and its section part is baselen
1269 * long. We found key (again, both section and var).
1270 * We would want to know if this key is in the same
1271 * section as what we are looking for. We already
1272 * know we are in the same section as what should
1275 ep = strrchr(key, '.');
1276 section_len = ep - key;
1278 if ((section_len != store.baselen) ||
1279 memcmp(key, store.key, section_len+1)) {
1280 store.state = SECTION_END_SEEN;
1285 * Do not increment matches: this is no match, but we
1286 * just made sure we are in the desired section.
1288 ALLOC_GROW(store.offset, store.seen + 1,
1289 store.offset_alloc);
1290 store.offset[store.seen] = cf->do_ftell(cf);
1292 case SECTION_END_SEEN:
1294 if (matches(key, value)) {
1295 ALLOC_GROW(store.offset, store.seen + 1,
1296 store.offset_alloc);
1297 store.offset[store.seen] = cf->do_ftell(cf);
1298 store.state = KEY_SEEN;
1301 if (strrchr(key, '.') - key == store.baselen &&
1302 !strncmp(key, store.key, store.baselen)) {
1303 store.state = SECTION_SEEN;
1304 ALLOC_GROW(store.offset,
1306 store.offset_alloc);
1307 store.offset[store.seen] = cf->do_ftell(cf);
1314 static int write_error(const char *filename)
1316 error("failed to write new configuration file %s", filename);
1318 /* Same error code as "failed to rename". */
1322 static int store_write_section(int fd, const char *key)
1326 struct strbuf sb = STRBUF_INIT;
1328 dot = memchr(key, '.', store.baselen);
1330 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1331 for (i = dot - key + 1; i < store.baselen; i++) {
1332 if (key[i] == '"' || key[i] == '\\')
1333 strbuf_addch(&sb, '\\');
1334 strbuf_addch(&sb, key[i]);
1336 strbuf_addstr(&sb, "\"]\n");
1338 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1341 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1342 strbuf_release(&sb);
1347 static int store_write_pair(int fd, const char *key, const char *value)
1350 int length = strlen(key + store.baselen + 1);
1351 const char *quote = "";
1352 struct strbuf sb = STRBUF_INIT;
1355 * Check to see if the value needs to be surrounded with a dq pair.
1356 * Note that problematic characters are always backslash-quoted; this
1357 * check is about not losing leading or trailing SP and strings that
1358 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1359 * configuration parser.
1361 if (value[0] == ' ')
1363 for (i = 0; value[i]; i++)
1364 if (value[i] == ';' || value[i] == '#')
1366 if (i && value[i - 1] == ' ')
1369 strbuf_addf(&sb, "\t%.*s = %s",
1370 length, key + store.baselen + 1, quote);
1372 for (i = 0; value[i]; i++)
1375 strbuf_addstr(&sb, "\\n");
1378 strbuf_addstr(&sb, "\\t");
1382 strbuf_addch(&sb, '\\');
1384 strbuf_addch(&sb, value[i]);
1387 strbuf_addf(&sb, "%s\n", quote);
1389 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1390 strbuf_release(&sb);
1395 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1396 size_t offset_, int *found_bracket)
1398 size_t equal_offset = size, bracket_offset = size;
1402 for (offset = offset_-2; offset > 0
1403 && contents[offset] != '\n'; offset--)
1404 switch (contents[offset]) {
1405 case '=': equal_offset = offset; break;
1406 case ']': bracket_offset = offset; break;
1408 if (offset > 0 && contents[offset-1] == '\\') {
1412 if (bracket_offset < equal_offset) {
1414 offset = bracket_offset+1;
1421 int git_config_set_in_file(const char *config_filename,
1422 const char *key, const char *value)
1424 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1427 int git_config_set(const char *key, const char *value)
1429 return git_config_set_multivar(key, value, NULL, 0);
1433 * Auxiliary function to sanity-check and split the key into the section
1434 * identifier and variable name.
1436 * Returns 0 on success, -1 when there is an invalid character in the key and
1437 * -2 if there is no section name in the key.
1439 * store_key - pointer to char* which will hold a copy of the key with
1440 * lowercase section and variable name
1441 * baselen - pointer to int which will hold the length of the
1442 * section + subsection part, can be NULL
1444 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1446 int i, dot, baselen;
1447 const char *last_dot = strrchr(key, '.');
1450 * Since "key" actually contains the section name and the real
1451 * key name separated by a dot, we have to know where the dot is.
1454 if (last_dot == NULL || last_dot == key) {
1455 error("key does not contain a section: %s", key);
1456 return -CONFIG_NO_SECTION_OR_NAME;
1460 error("key does not contain variable name: %s", key);
1461 return -CONFIG_NO_SECTION_OR_NAME;
1464 baselen = last_dot - key;
1466 *baselen_ = baselen;
1469 * Validate the key and while at it, lower case it for matching.
1471 *store_key = xmalloc(strlen(key) + 1);
1474 for (i = 0; key[i]; i++) {
1475 unsigned char c = key[i];
1478 /* Leave the extended basename untouched.. */
1479 if (!dot || i > baselen) {
1480 if (!iskeychar(c) ||
1481 (i == baselen + 1 && !isalpha(c))) {
1482 error("invalid key: %s", key);
1483 goto out_free_ret_1;
1486 } else if (c == '\n') {
1487 error("invalid key (newline): %s", key);
1488 goto out_free_ret_1;
1490 (*store_key)[i] = c;
1492 (*store_key)[i] = 0;
1499 return -CONFIG_INVALID_KEY;
1503 * If value==NULL, unset in (remove from) config,
1504 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1505 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1506 * else all matching key/values (regardless how many) are removed,
1507 * before the new pair is written.
1509 * Returns 0 on success.
1511 * This function does this:
1513 * - it locks the config file by creating ".git/config.lock"
1515 * - it then parses the config using store_aux() as validator to find
1516 * the position on the key/value pair to replace. If it is to be unset,
1517 * it must be found exactly once.
1519 * - the config file is mmap()ed and the part before the match (if any) is
1520 * written to the lock file, then the changed part and the rest.
1522 * - the config file is removed and the lock file rename()d to it.
1525 int git_config_set_multivar_in_file(const char *config_filename,
1526 const char *key, const char *value,
1527 const char *value_regex, int multi_replace)
1531 struct lock_file *lock = NULL;
1532 char *filename_buf = NULL;
1534 /* parse-key returns negative; flip the sign to feed exit(3) */
1535 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1539 store.multi_replace = multi_replace;
1541 if (!config_filename)
1542 config_filename = filename_buf = git_pathdup("config");
1545 * The lock serves a purpose in addition to locking: the new
1546 * contents of .git/config will be written into it.
1548 lock = xcalloc(sizeof(struct lock_file), 1);
1549 fd = hold_lock_file_for_update(lock, config_filename, 0);
1551 error("could not lock config file %s: %s", config_filename, strerror(errno));
1553 ret = CONFIG_NO_LOCK;
1558 * If .git/config does not exist yet, write a minimal version.
1560 in_fd = open(config_filename, O_RDONLY);
1564 if ( ENOENT != errno ) {
1565 error("opening %s: %s", config_filename,
1567 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1570 /* if nothing to unset, error out */
1571 if (value == NULL) {
1572 ret = CONFIG_NOTHING_SET;
1576 store.key = (char *)key;
1577 if (!store_write_section(fd, key) ||
1578 !store_write_pair(fd, key, value))
1583 size_t contents_sz, copy_begin, copy_end;
1584 int i, new_line = 0;
1586 if (value_regex == NULL)
1587 store.value_regex = NULL;
1589 if (value_regex[0] == '!') {
1590 store.do_not_match = 1;
1593 store.do_not_match = 0;
1595 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1596 if (regcomp(store.value_regex, value_regex,
1598 error("invalid pattern: %s", value_regex);
1599 free(store.value_regex);
1600 ret = CONFIG_INVALID_PATTERN;
1605 ALLOC_GROW(store.offset, 1, store.offset_alloc);
1606 store.offset[0] = 0;
1607 store.state = START;
1611 * After this, store.offset will contain the *end* offset
1612 * of the last match, or remain at 0 if no match was found.
1613 * As a side effect, we make sure to transform only a valid
1614 * existing config file.
1616 if (git_config_from_file(store_aux, config_filename, NULL)) {
1617 error("invalid config file %s", config_filename);
1619 if (store.value_regex != NULL) {
1620 regfree(store.value_regex);
1621 free(store.value_regex);
1623 ret = CONFIG_INVALID_FILE;
1628 if (store.value_regex != NULL) {
1629 regfree(store.value_regex);
1630 free(store.value_regex);
1633 /* if nothing to unset, or too many matches, error out */
1634 if ((store.seen == 0 && value == NULL) ||
1635 (store.seen > 1 && multi_replace == 0)) {
1636 ret = CONFIG_NOTHING_SET;
1641 contents_sz = xsize_t(st.st_size);
1642 contents = xmmap(NULL, contents_sz, PROT_READ,
1643 MAP_PRIVATE, in_fd, 0);
1646 if (fchmod(fd, st.st_mode & 07777) < 0) {
1647 error("fchmod on %s failed: %s",
1648 lock->filename, strerror(errno));
1649 ret = CONFIG_NO_WRITE;
1653 if (store.seen == 0)
1656 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1657 if (store.offset[i] == 0) {
1658 store.offset[i] = copy_end = contents_sz;
1659 } else if (store.state != KEY_SEEN) {
1660 copy_end = store.offset[i];
1662 copy_end = find_beginning_of_line(
1663 contents, contents_sz,
1664 store.offset[i]-2, &new_line);
1666 if (copy_end > 0 && contents[copy_end-1] != '\n')
1669 /* write the first part of the config */
1670 if (copy_end > copy_begin) {
1671 if (write_in_full(fd, contents + copy_begin,
1672 copy_end - copy_begin) <
1673 copy_end - copy_begin)
1676 write_str_in_full(fd, "\n") != 1)
1679 copy_begin = store.offset[i];
1682 /* write the pair (value == NULL means unset) */
1683 if (value != NULL) {
1684 if (store.state == START) {
1685 if (!store_write_section(fd, key))
1688 if (!store_write_pair(fd, key, value))
1692 /* write the rest of the config */
1693 if (copy_begin < contents_sz)
1694 if (write_in_full(fd, contents + copy_begin,
1695 contents_sz - copy_begin) <
1696 contents_sz - copy_begin)
1699 munmap(contents, contents_sz);
1702 if (commit_lock_file(lock) < 0) {
1703 error("could not commit config file %s", config_filename);
1704 ret = CONFIG_NO_WRITE;
1709 * lock is committed, so don't try to roll it back below.
1710 * NOTE: Since lockfile.c keeps a linked list of all created
1711 * lock_file structures, it isn't safe to free(lock). It's
1712 * better to just leave it hanging around.
1719 rollback_lock_file(lock);
1724 ret = write_error(lock->filename);
1729 int git_config_set_multivar(const char *key, const char *value,
1730 const char *value_regex, int multi_replace)
1732 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1736 static int section_name_match (const char *buf, const char *name)
1738 int i = 0, j = 0, dot = 0;
1741 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1742 if (!dot && isspace(buf[i])) {
1744 if (name[j++] != '.')
1746 for (i++; isspace(buf[i]); i++)
1752 if (buf[i] == '\\' && dot)
1754 else if (buf[i] == '"' && dot) {
1755 for (i++; isspace(buf[i]); i++)
1759 if (buf[i] != name[j++])
1762 if (buf[i] == ']' && name[j] == 0) {
1764 * We match, now just find the right length offset by
1765 * gobbling up any whitespace after it, as well
1768 for (; buf[i] && isspace(buf[i]); i++)
1775 static int section_name_is_ok(const char *name)
1777 /* Empty section names are bogus. */
1782 * Before a dot, we must be alphanumeric or dash. After the first dot,
1783 * anything goes, so we can stop checking.
1785 for (; *name && *name != '.'; name++)
1786 if (*name != '-' && !isalnum(*name))
1791 /* if new_name == NULL, the section is removed instead */
1792 int git_config_rename_section_in_file(const char *config_filename,
1793 const char *old_name, const char *new_name)
1795 int ret = 0, remove = 0;
1796 char *filename_buf = NULL;
1797 struct lock_file *lock;
1803 if (new_name && !section_name_is_ok(new_name)) {
1804 ret = error("invalid section name: %s", new_name);
1808 if (!config_filename)
1809 config_filename = filename_buf = git_pathdup("config");
1811 lock = xcalloc(sizeof(struct lock_file), 1);
1812 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1814 ret = error("could not lock config file %s", config_filename);
1818 if (!(config_file = fopen(config_filename, "rb"))) {
1819 /* no config file means nothing to rename, no error */
1820 goto unlock_and_out;
1823 fstat(fileno(config_file), &st);
1825 if (fchmod(out_fd, st.st_mode & 07777) < 0) {
1826 ret = error("fchmod on %s failed: %s",
1827 lock->filename, strerror(errno));
1831 while (fgets(buf, sizeof(buf), config_file)) {
1835 for (i = 0; buf[i] && isspace(buf[i]); i++)
1837 if (buf[i] == '[') {
1838 /* it's a section */
1839 int offset = section_name_match(&buf[i], old_name);
1842 if (new_name == NULL) {
1846 store.baselen = strlen(new_name);
1847 if (!store_write_section(out_fd, new_name)) {
1848 ret = write_error(lock->filename);
1852 * We wrote out the new section, with
1853 * a newline, now skip the old
1856 output += offset + i;
1857 if (strlen(output) > 0) {
1859 * More content means there's
1860 * a declaration to put on the
1861 * next line; indent with a
1872 length = strlen(output);
1873 if (write_in_full(out_fd, output, length) != length) {
1874 ret = write_error(lock->filename);
1878 fclose(config_file);
1880 if (commit_lock_file(lock) < 0)
1881 ret = error("could not commit config file %s", config_filename);
1887 int git_config_rename_section(const char *old_name, const char *new_name)
1889 return git_config_rename_section_in_file(NULL, old_name, new_name);
1893 * Call this to report error for your variable that should not
1894 * get a boolean value (i.e. "[my] var" means "true").
1896 #undef config_error_nonbool
1897 int config_error_nonbool(const char *var)
1899 return error("Missing value for '%s'", var);
1902 int parse_config_key(const char *var,
1903 const char *section,
1904 const char **subsection, int *subsection_len,
1907 int section_len = strlen(section);
1910 /* Does it start with "section." ? */
1911 if (!starts_with(var, section) || var[section_len] != '.')
1915 * Find the key; we don't know yet if we have a subsection, but we must
1916 * parse backwards from the end, since the subsection may have dots in
1919 dot = strrchr(var, '.');
1922 /* Did we have a subsection at all? */
1923 if (dot == var + section_len) {
1925 *subsection_len = 0;
1928 *subsection = var + section_len + 1;
1929 *subsection_len = dot - *subsection;