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;
30 int (*do_fgetc)(struct config_source *c);
31 int (*do_ungetc)(int c, struct config_source *conf);
32 long (*do_ftell)(struct config_source *c);
35 static struct config_source *cf;
37 static int zlib_compression_seen;
39 static int config_file_fgetc(struct config_source *conf)
41 return fgetc(conf->u.file);
44 static int config_file_ungetc(int c, struct config_source *conf)
46 return ungetc(c, conf->u.file);
49 static long config_file_ftell(struct config_source *conf)
51 return ftell(conf->u.file);
55 static int config_buf_fgetc(struct config_source *conf)
57 if (conf->u.buf.pos < conf->u.buf.len)
58 return conf->u.buf.buf[conf->u.buf.pos++];
63 static int config_buf_ungetc(int c, struct config_source *conf)
65 if (conf->u.buf.pos > 0)
66 return conf->u.buf.buf[--conf->u.buf.pos];
71 static long config_buf_ftell(struct config_source *conf)
73 return conf->u.buf.pos;
76 #define MAX_INCLUDE_DEPTH 10
77 static const char include_depth_advice[] =
78 "exceeded maximum include depth (%d) while including\n"
82 "Do you have circular includes?";
83 static int handle_path_include(const char *path, struct config_include_data *inc)
86 struct strbuf buf = STRBUF_INIT;
87 char *expanded = expand_user_path(path);
90 return error("Could not expand include path '%s'", path);
94 * Use an absolute path as-is, but interpret relative paths
95 * based on the including config file.
97 if (!is_absolute_path(path)) {
100 if (!cf || !cf->name)
101 return error("relative config includes must come from files");
103 slash = find_last_dir_sep(cf->name);
105 strbuf_add(&buf, cf->name, slash - cf->name + 1);
106 strbuf_addstr(&buf, path);
110 if (!access_or_die(path, R_OK, 0)) {
111 if (++inc->depth > MAX_INCLUDE_DEPTH)
112 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
113 cf && cf->name ? cf->name : "the command line");
114 ret = git_config_from_file(git_config_include, path, inc);
117 strbuf_release(&buf);
122 int git_config_include(const char *var, const char *value, void *data)
124 struct config_include_data *inc = data;
129 * Pass along all values, including "include" directives; this makes it
130 * possible to query information on the includes themselves.
132 ret = inc->fn(var, value, inc->data);
136 type = skip_prefix(var, "include.");
140 if (!strcmp(type, "path"))
141 ret = handle_path_include(value, inc);
145 static void lowercase(char *p)
151 void git_config_push_parameter(const char *text)
153 struct strbuf env = STRBUF_INIT;
154 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
156 strbuf_addstr(&env, old);
157 strbuf_addch(&env, ' ');
159 sq_quote_buf(&env, text);
160 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
161 strbuf_release(&env);
164 int git_config_parse_parameter(const char *text,
165 config_fn_t fn, void *data)
168 struct strbuf **pair;
170 pair = strbuf_split_str(text, '=', 2);
172 return error("bogus config parameter: %s", text);
174 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
175 strbuf_setlen(pair[0], pair[0]->len - 1);
176 value = pair[1] ? pair[1]->buf : "";
181 strbuf_trim(pair[0]);
183 strbuf_list_free(pair);
184 return error("bogus config parameter: %s", text);
186 lowercase(pair[0]->buf);
187 if (fn(pair[0]->buf, value, data) < 0) {
188 strbuf_list_free(pair);
191 strbuf_list_free(pair);
195 int git_config_from_parameters(config_fn_t fn, void *data)
197 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
199 const char **argv = NULL;
200 int nr = 0, alloc = 0;
205 /* sq_dequote will write over it */
208 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
210 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
213 for (i = 0; i < nr; i++) {
214 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
226 static int get_next_char(void)
228 int c = cf->do_fgetc(cf);
231 /* DOS like systems */
232 c = cf->do_fgetc(cf);
234 cf->do_ungetc(c, cf);
247 static char *parse_value(void)
249 int quote = 0, comment = 0, space = 0;
251 strbuf_reset(&cf->value);
253 int c = get_next_char();
259 return cf->value.buf;
263 if (isspace(c) && !quote) {
269 if (c == ';' || c == '#') {
274 for (; space; space--)
275 strbuf_addch(&cf->value, ' ');
290 /* Some characters escape as themselves */
293 /* Reject unknown escape sequences */
297 strbuf_addch(&cf->value, c);
304 strbuf_addch(&cf->value, c);
308 static inline int iskeychar(int c)
310 return isalnum(c) || c == '-';
313 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
318 /* Get the full name */
325 strbuf_addch(name, tolower(c));
328 while (c == ' ' || c == '\t')
335 value = parse_value();
339 return fn(name->buf, value, data);
342 static int get_extended_base_var(struct strbuf *name, int c)
346 goto error_incomplete_line;
348 } while (isspace(c));
350 /* We require the format to be '[base "extension"]' */
353 strbuf_addch(name, '.');
356 int c = get_next_char();
358 goto error_incomplete_line;
364 goto error_incomplete_line;
366 strbuf_addch(name, c);
370 if (get_next_char() != ']')
373 error_incomplete_line:
378 static int get_base_var(struct strbuf *name)
381 int c = get_next_char();
387 return get_extended_base_var(name, c);
388 if (!iskeychar(c) && c != '.')
390 strbuf_addch(name, tolower(c));
394 static int git_parse_source(config_fn_t fn, void *data)
398 struct strbuf *var = &cf->var;
400 /* U+FEFF Byte Order Mark in UTF8 */
401 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
402 const unsigned char *bomptr = utf8_bom;
405 int c = get_next_char();
406 if (bomptr && *bomptr) {
407 /* We are at the file beginning; skip UTF8-encoded BOM
408 * if present. Sane editors won't put this in on their
409 * own, but e.g. Windows Notepad will do it happily. */
410 if ((unsigned char) c == *bomptr) {
414 /* Do not tolerate partial BOM. */
415 if (bomptr != utf8_bom)
417 /* No BOM at file beginning. Cool. */
427 if (comment || isspace(c))
429 if (c == '#' || c == ';') {
434 /* Reset prior to determining a new stem */
436 if (get_base_var(var) < 0 || var->len < 1)
438 strbuf_addch(var, '.');
445 * Truncate the var name back to the section header
446 * stem prior to grabbing the suffix part of the name
449 strbuf_setlen(var, baselen);
450 strbuf_addch(var, tolower(c));
451 if (get_value(fn, data, var) < 0)
454 if (cf->die_on_error)
455 die("bad config file line %d in %s", cf->linenr, cf->name);
457 return error("bad config file line %d in %s", cf->linenr, cf->name);
460 static int parse_unit_factor(const char *end, uintmax_t *val)
464 else if (!strcasecmp(end, "k")) {
468 else if (!strcasecmp(end, "m")) {
472 else if (!strcasecmp(end, "g")) {
473 *val *= 1024 * 1024 * 1024;
479 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
481 if (value && *value) {
485 uintmax_t factor = 1;
488 val = strtoimax(value, &end, 0);
491 if (!parse_unit_factor(end, &factor)) {
497 if (uval > max || abs(val) > uval) {
509 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
511 if (value && *value) {
517 val = strtoumax(value, &end, 0);
521 if (!parse_unit_factor(end, &val)) {
525 if (val > max || oldval > val) {
536 static int git_parse_int(const char *value, int *ret)
539 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
545 static int git_parse_int64(const char *value, int64_t *ret)
548 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
554 int git_parse_ulong(const char *value, unsigned long *ret)
557 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
563 static void die_bad_number(const char *name, const char *value)
565 const char *reason = errno == ERANGE ?
572 die("bad numeric config value '%s' for '%s' in %s: %s",
573 value, name, cf->name, reason);
574 die("bad numeric config value '%s' for '%s': %s", value, name, reason);
577 int git_config_int(const char *name, const char *value)
580 if (!git_parse_int(value, &ret))
581 die_bad_number(name, value);
585 int64_t git_config_int64(const char *name, const char *value)
588 if (!git_parse_int64(value, &ret))
589 die_bad_number(name, value);
593 unsigned long git_config_ulong(const char *name, const char *value)
596 if (!git_parse_ulong(value, &ret))
597 die_bad_number(name, value);
601 static int git_config_maybe_bool_text(const char *name, const char *value)
607 if (!strcasecmp(value, "true")
608 || !strcasecmp(value, "yes")
609 || !strcasecmp(value, "on"))
611 if (!strcasecmp(value, "false")
612 || !strcasecmp(value, "no")
613 || !strcasecmp(value, "off"))
618 int git_config_maybe_bool(const char *name, const char *value)
620 int v = git_config_maybe_bool_text(name, value);
623 if (git_parse_int(value, &v))
628 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
630 int v = git_config_maybe_bool_text(name, value);
636 return git_config_int(name, value);
639 int git_config_bool(const char *name, const char *value)
642 return !!git_config_bool_or_int(name, value, &discard);
645 int git_config_string(const char **dest, const char *var, const char *value)
648 return config_error_nonbool(var);
649 *dest = xstrdup(value);
653 int git_config_pathname(const char **dest, const char *var, const char *value)
656 return config_error_nonbool(var);
657 *dest = expand_user_path(value);
659 die("Failed to expand user dir in: '%s'", value);
663 static int git_default_core_config(const char *var, const char *value)
665 /* This needs a better name */
666 if (!strcmp(var, "core.filemode")) {
667 trust_executable_bit = git_config_bool(var, value);
670 if (!strcmp(var, "core.trustctime")) {
671 trust_ctime = git_config_bool(var, value);
674 if (!strcmp(var, "core.statinfo") ||
675 !strcmp(var, "core.checkstat")) {
677 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
678 * never been advertised. we will remove it at Git
681 if (!strcmp(var, "core.statinfo")) {
684 warning("'core.statinfo' will be removed in Git 2.0; "
685 "use 'core.checkstat' instead.");
688 if (!strcasecmp(value, "default"))
690 else if (!strcasecmp(value, "minimal"))
694 if (!strcmp(var, "core.quotepath")) {
695 quote_path_fully = git_config_bool(var, value);
699 if (!strcmp(var, "core.symlinks")) {
700 has_symlinks = git_config_bool(var, value);
704 if (!strcmp(var, "core.ignorecase")) {
705 ignore_case = git_config_bool(var, value);
709 if (!strcmp(var, "core.attributesfile"))
710 return git_config_pathname(&git_attributes_file, var, value);
712 if (!strcmp(var, "core.bare")) {
713 is_bare_repository_cfg = git_config_bool(var, value);
717 if (!strcmp(var, "core.ignorestat")) {
718 assume_unchanged = git_config_bool(var, value);
722 if (!strcmp(var, "core.prefersymlinkrefs")) {
723 prefer_symlink_refs = git_config_bool(var, value);
727 if (!strcmp(var, "core.logallrefupdates")) {
728 log_all_ref_updates = git_config_bool(var, value);
732 if (!strcmp(var, "core.warnambiguousrefs")) {
733 warn_ambiguous_refs = git_config_bool(var, value);
737 if (!strcmp(var, "core.abbrev")) {
738 int abbrev = git_config_int(var, value);
739 if (abbrev < minimum_abbrev || abbrev > 40)
741 default_abbrev = abbrev;
745 if (!strcmp(var, "core.loosecompression")) {
746 int level = git_config_int(var, value);
748 level = Z_DEFAULT_COMPRESSION;
749 else if (level < 0 || level > Z_BEST_COMPRESSION)
750 die("bad zlib compression level %d", level);
751 zlib_compression_level = level;
752 zlib_compression_seen = 1;
756 if (!strcmp(var, "core.compression")) {
757 int level = git_config_int(var, value);
759 level = Z_DEFAULT_COMPRESSION;
760 else if (level < 0 || level > Z_BEST_COMPRESSION)
761 die("bad zlib compression level %d", level);
762 core_compression_level = level;
763 core_compression_seen = 1;
764 if (!zlib_compression_seen)
765 zlib_compression_level = level;
769 if (!strcmp(var, "core.packedgitwindowsize")) {
770 int pgsz_x2 = getpagesize() * 2;
771 packed_git_window_size = git_config_ulong(var, value);
773 /* This value must be multiple of (pagesize * 2) */
774 packed_git_window_size /= pgsz_x2;
775 if (packed_git_window_size < 1)
776 packed_git_window_size = 1;
777 packed_git_window_size *= pgsz_x2;
781 if (!strcmp(var, "core.bigfilethreshold")) {
782 big_file_threshold = git_config_ulong(var, value);
786 if (!strcmp(var, "core.packedgitlimit")) {
787 packed_git_limit = git_config_ulong(var, value);
791 if (!strcmp(var, "core.deltabasecachelimit")) {
792 delta_base_cache_limit = git_config_ulong(var, value);
796 if (!strcmp(var, "core.autocrlf")) {
797 if (value && !strcasecmp(value, "input")) {
798 if (core_eol == EOL_CRLF)
799 return error("core.autocrlf=input conflicts with core.eol=crlf");
800 auto_crlf = AUTO_CRLF_INPUT;
803 auto_crlf = git_config_bool(var, value);
807 if (!strcmp(var, "core.safecrlf")) {
808 if (value && !strcasecmp(value, "warn")) {
809 safe_crlf = SAFE_CRLF_WARN;
812 safe_crlf = git_config_bool(var, value);
816 if (!strcmp(var, "core.eol")) {
817 if (value && !strcasecmp(value, "lf"))
819 else if (value && !strcasecmp(value, "crlf"))
821 else if (value && !strcasecmp(value, "native"))
822 core_eol = EOL_NATIVE;
824 core_eol = EOL_UNSET;
825 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
826 return error("core.autocrlf=input conflicts with core.eol=crlf");
830 if (!strcmp(var, "core.notesref")) {
831 notes_ref_name = xstrdup(value);
835 if (!strcmp(var, "core.pager"))
836 return git_config_string(&pager_program, var, value);
838 if (!strcmp(var, "core.editor"))
839 return git_config_string(&editor_program, var, value);
841 if (!strcmp(var, "core.commentchar")) {
843 int ret = git_config_string(&comment, var, value);
845 comment_line_char = comment[0];
849 if (!strcmp(var, "core.askpass"))
850 return git_config_string(&askpass_program, var, value);
852 if (!strcmp(var, "core.excludesfile"))
853 return git_config_pathname(&excludes_file, var, value);
855 if (!strcmp(var, "core.whitespace")) {
857 return config_error_nonbool(var);
858 whitespace_rule_cfg = parse_whitespace_rule(value);
862 if (!strcmp(var, "core.fsyncobjectfiles")) {
863 fsync_object_files = git_config_bool(var, value);
867 if (!strcmp(var, "core.preloadindex")) {
868 core_preload_index = git_config_bool(var, value);
872 if (!strcmp(var, "core.createobject")) {
873 if (!strcmp(value, "rename"))
874 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
875 else if (!strcmp(value, "link"))
876 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
878 die("Invalid mode for object creation: %s", value);
882 if (!strcmp(var, "core.sparsecheckout")) {
883 core_apply_sparse_checkout = git_config_bool(var, value);
887 if (!strcmp(var, "core.precomposeunicode")) {
888 precomposed_unicode = git_config_bool(var, value);
892 /* Add other config variables here and to Documentation/config.txt. */
896 static int git_default_i18n_config(const char *var, const char *value)
898 if (!strcmp(var, "i18n.commitencoding"))
899 return git_config_string(&git_commit_encoding, var, value);
901 if (!strcmp(var, "i18n.logoutputencoding"))
902 return git_config_string(&git_log_output_encoding, var, value);
904 /* Add other config variables here and to Documentation/config.txt. */
908 static int git_default_branch_config(const char *var, const char *value)
910 if (!strcmp(var, "branch.autosetupmerge")) {
911 if (value && !strcasecmp(value, "always")) {
912 git_branch_track = BRANCH_TRACK_ALWAYS;
915 git_branch_track = git_config_bool(var, value);
918 if (!strcmp(var, "branch.autosetuprebase")) {
920 return config_error_nonbool(var);
921 else if (!strcmp(value, "never"))
922 autorebase = AUTOREBASE_NEVER;
923 else if (!strcmp(value, "local"))
924 autorebase = AUTOREBASE_LOCAL;
925 else if (!strcmp(value, "remote"))
926 autorebase = AUTOREBASE_REMOTE;
927 else if (!strcmp(value, "always"))
928 autorebase = AUTOREBASE_ALWAYS;
930 return error("Malformed value for %s", var);
934 /* Add other config variables here and to Documentation/config.txt. */
938 static int git_default_push_config(const char *var, const char *value)
940 if (!strcmp(var, "push.default")) {
942 return config_error_nonbool(var);
943 else if (!strcmp(value, "nothing"))
944 push_default = PUSH_DEFAULT_NOTHING;
945 else if (!strcmp(value, "matching"))
946 push_default = PUSH_DEFAULT_MATCHING;
947 else if (!strcmp(value, "simple"))
948 push_default = PUSH_DEFAULT_SIMPLE;
949 else if (!strcmp(value, "upstream"))
950 push_default = PUSH_DEFAULT_UPSTREAM;
951 else if (!strcmp(value, "tracking")) /* deprecated */
952 push_default = PUSH_DEFAULT_UPSTREAM;
953 else if (!strcmp(value, "current"))
954 push_default = PUSH_DEFAULT_CURRENT;
956 error("Malformed value for %s: %s", var, value);
957 return error("Must be one of nothing, matching, simple, "
958 "upstream or current.");
963 /* Add other config variables here and to Documentation/config.txt. */
967 static int git_default_mailmap_config(const char *var, const char *value)
969 if (!strcmp(var, "mailmap.file"))
970 return git_config_string(&git_mailmap_file, var, value);
971 if (!strcmp(var, "mailmap.blob"))
972 return git_config_string(&git_mailmap_blob, var, value);
974 /* Add other config variables here and to Documentation/config.txt. */
978 int git_default_config(const char *var, const char *value, void *dummy)
980 if (!prefixcmp(var, "core."))
981 return git_default_core_config(var, value);
983 if (!prefixcmp(var, "user."))
984 return git_ident_config(var, value, dummy);
986 if (!prefixcmp(var, "i18n."))
987 return git_default_i18n_config(var, value);
989 if (!prefixcmp(var, "branch."))
990 return git_default_branch_config(var, value);
992 if (!prefixcmp(var, "push."))
993 return git_default_push_config(var, value);
995 if (!prefixcmp(var, "mailmap."))
996 return git_default_mailmap_config(var, value);
998 if (!prefixcmp(var, "advice."))
999 return git_default_advice_config(var, value);
1001 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1002 pager_use_color = git_config_bool(var,value);
1006 if (!strcmp(var, "pack.packsizelimit")) {
1007 pack_size_limit_cfg = git_config_ulong(var, value);
1010 /* Add other config variables here and to Documentation/config.txt. */
1015 * All source specific fields in the union, die_on_error, name and the callbacks
1016 * fgetc, ungetc, ftell of top need to be initialized before calling
1019 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1023 /* push config-file parsing state stack */
1027 strbuf_init(&top->value, 1024);
1028 strbuf_init(&top->var, 1024);
1031 ret = git_parse_source(fn, data);
1033 /* pop config-file parsing state stack */
1034 strbuf_release(&top->value);
1035 strbuf_release(&top->var);
1041 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1044 FILE *f = fopen(filename, "r");
1048 struct config_source top;
1051 top.name = filename;
1052 top.die_on_error = 1;
1053 top.do_fgetc = config_file_fgetc;
1054 top.do_ungetc = config_file_ungetc;
1055 top.do_ftell = config_file_ftell;
1057 ret = do_config_from(&top, fn, data);
1064 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1065 size_t len, void *data)
1067 struct config_source top;
1069 top.u.buf.buf = buf;
1070 top.u.buf.len = len;
1073 top.die_on_error = 0;
1074 top.do_fgetc = config_buf_fgetc;
1075 top.do_ungetc = config_buf_ungetc;
1076 top.do_ftell = config_buf_ftell;
1078 return do_config_from(&top, fn, data);
1081 static int git_config_from_blob_sha1(config_fn_t fn,
1083 const unsigned char *sha1,
1086 enum object_type type;
1091 buf = read_sha1_file(sha1, &type, &size);
1093 return error("unable to load config blob object '%s'", name);
1094 if (type != OBJ_BLOB) {
1096 return error("reference '%s' does not point to a blob", name);
1099 ret = git_config_from_buf(fn, name, buf, size, data);
1105 static int git_config_from_blob_ref(config_fn_t fn,
1109 unsigned char sha1[20];
1111 if (get_sha1(name, sha1) < 0)
1112 return error("unable to resolve config blob '%s'", name);
1113 return git_config_from_blob_sha1(fn, name, sha1, data);
1116 const char *git_etc_gitconfig(void)
1118 static const char *system_wide;
1120 system_wide = system_path(ETC_GITCONFIG);
1124 int git_env_bool(const char *k, int def)
1126 const char *v = getenv(k);
1127 return v ? git_config_bool(k, v) : def;
1130 int git_config_system(void)
1132 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1135 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1137 int ret = 0, found = 0;
1138 char *xdg_config = NULL;
1139 char *user_config = NULL;
1141 home_config_paths(&user_config, &xdg_config, "config");
1143 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1144 ret += git_config_from_file(fn, git_etc_gitconfig(),
1149 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1150 ret += git_config_from_file(fn, xdg_config, data);
1154 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1155 ret += git_config_from_file(fn, user_config, data);
1159 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1160 ret += git_config_from_file(fn, repo_config, data);
1164 switch (git_config_from_parameters(fn, data)) {
1165 case -1: /* error */
1166 die("unable to parse command-line config");
1168 case 0: /* found nothing */
1170 default: /* found at least one item */
1177 return ret == 0 ? found : ret;
1180 int git_config_with_options(config_fn_t fn, void *data,
1181 const char *filename,
1182 const char *blob_ref,
1183 int respect_includes)
1185 char *repo_config = NULL;
1187 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1189 if (respect_includes) {
1192 fn = git_config_include;
1197 * If we have a specific filename, use it. Otherwise, follow the
1198 * regular lookup sequence.
1201 return git_config_from_file(fn, filename, data);
1203 return git_config_from_blob_ref(fn, blob_ref, data);
1205 repo_config = git_pathdup("config");
1206 ret = git_config_early(fn, data, repo_config);
1212 int git_config(config_fn_t fn, void *data)
1214 return git_config_with_options(fn, data, NULL, NULL, 1);
1218 * Find all the stuff for git_config_set() below.
1221 #define MAX_MATCHES 512
1227 regex_t *value_regex;
1229 size_t offset[MAX_MATCHES];
1230 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1234 static int matches(const char *key, const char *value)
1236 return !strcmp(key, store.key) &&
1237 (store.value_regex == NULL ||
1238 (store.do_not_match ^
1239 !regexec(store.value_regex, value, 0, NULL, 0)));
1242 static int store_aux(const char *key, const char *value, void *cb)
1247 switch (store.state) {
1249 if (matches(key, value)) {
1250 if (store.seen == 1 && store.multi_replace == 0) {
1251 warning("%s has multiple values", key);
1252 } else if (store.seen >= MAX_MATCHES) {
1253 error("too many matches for %s", key);
1257 store.offset[store.seen] = cf->do_ftell(cf);
1263 * What we are looking for is in store.key (both
1264 * section and var), and its section part is baselen
1265 * long. We found key (again, both section and var).
1266 * We would want to know if this key is in the same
1267 * section as what we are looking for. We already
1268 * know we are in the same section as what should
1271 ep = strrchr(key, '.');
1272 section_len = ep - key;
1274 if ((section_len != store.baselen) ||
1275 memcmp(key, store.key, section_len+1)) {
1276 store.state = SECTION_END_SEEN;
1281 * Do not increment matches: this is no match, but we
1282 * just made sure we are in the desired section.
1284 store.offset[store.seen] = cf->do_ftell(cf);
1286 case SECTION_END_SEEN:
1288 if (matches(key, value)) {
1289 store.offset[store.seen] = cf->do_ftell(cf);
1290 store.state = KEY_SEEN;
1293 if (strrchr(key, '.') - key == store.baselen &&
1294 !strncmp(key, store.key, store.baselen)) {
1295 store.state = SECTION_SEEN;
1296 store.offset[store.seen] = cf->do_ftell(cf);
1303 static int write_error(const char *filename)
1305 error("failed to write new configuration file %s", filename);
1307 /* Same error code as "failed to rename". */
1311 static int store_write_section(int fd, const char *key)
1315 struct strbuf sb = STRBUF_INIT;
1317 dot = memchr(key, '.', store.baselen);
1319 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1320 for (i = dot - key + 1; i < store.baselen; i++) {
1321 if (key[i] == '"' || key[i] == '\\')
1322 strbuf_addch(&sb, '\\');
1323 strbuf_addch(&sb, key[i]);
1325 strbuf_addstr(&sb, "\"]\n");
1327 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1330 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1331 strbuf_release(&sb);
1336 static int store_write_pair(int fd, const char *key, const char *value)
1339 int length = strlen(key + store.baselen + 1);
1340 const char *quote = "";
1341 struct strbuf sb = STRBUF_INIT;
1344 * Check to see if the value needs to be surrounded with a dq pair.
1345 * Note that problematic characters are always backslash-quoted; this
1346 * check is about not losing leading or trailing SP and strings that
1347 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1348 * configuration parser.
1350 if (value[0] == ' ')
1352 for (i = 0; value[i]; i++)
1353 if (value[i] == ';' || value[i] == '#')
1355 if (i && value[i - 1] == ' ')
1358 strbuf_addf(&sb, "\t%.*s = %s",
1359 length, key + store.baselen + 1, quote);
1361 for (i = 0; value[i]; i++)
1364 strbuf_addstr(&sb, "\\n");
1367 strbuf_addstr(&sb, "\\t");
1371 strbuf_addch(&sb, '\\');
1373 strbuf_addch(&sb, value[i]);
1376 strbuf_addf(&sb, "%s\n", quote);
1378 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1379 strbuf_release(&sb);
1384 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1385 size_t offset_, int *found_bracket)
1387 size_t equal_offset = size, bracket_offset = size;
1391 for (offset = offset_-2; offset > 0
1392 && contents[offset] != '\n'; offset--)
1393 switch (contents[offset]) {
1394 case '=': equal_offset = offset; break;
1395 case ']': bracket_offset = offset; break;
1397 if (offset > 0 && contents[offset-1] == '\\') {
1401 if (bracket_offset < equal_offset) {
1403 offset = bracket_offset+1;
1410 int git_config_set_in_file(const char *config_filename,
1411 const char *key, const char *value)
1413 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1416 int git_config_set(const char *key, const char *value)
1418 return git_config_set_multivar(key, value, NULL, 0);
1422 * Auxiliary function to sanity-check and split the key into the section
1423 * identifier and variable name.
1425 * Returns 0 on success, -1 when there is an invalid character in the key and
1426 * -2 if there is no section name in the key.
1428 * store_key - pointer to char* which will hold a copy of the key with
1429 * lowercase section and variable name
1430 * baselen - pointer to int which will hold the length of the
1431 * section + subsection part, can be NULL
1433 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1435 int i, dot, baselen;
1436 const char *last_dot = strrchr(key, '.');
1439 * Since "key" actually contains the section name and the real
1440 * key name separated by a dot, we have to know where the dot is.
1443 if (last_dot == NULL || last_dot == key) {
1444 error("key does not contain a section: %s", key);
1445 return -CONFIG_NO_SECTION_OR_NAME;
1449 error("key does not contain variable name: %s", key);
1450 return -CONFIG_NO_SECTION_OR_NAME;
1453 baselen = last_dot - key;
1455 *baselen_ = baselen;
1458 * Validate the key and while at it, lower case it for matching.
1460 *store_key = xmalloc(strlen(key) + 1);
1463 for (i = 0; key[i]; i++) {
1464 unsigned char c = key[i];
1467 /* Leave the extended basename untouched.. */
1468 if (!dot || i > baselen) {
1469 if (!iskeychar(c) ||
1470 (i == baselen + 1 && !isalpha(c))) {
1471 error("invalid key: %s", key);
1472 goto out_free_ret_1;
1475 } else if (c == '\n') {
1476 error("invalid key (newline): %s", key);
1477 goto out_free_ret_1;
1479 (*store_key)[i] = c;
1481 (*store_key)[i] = 0;
1488 return -CONFIG_INVALID_KEY;
1492 * If value==NULL, unset in (remove from) config,
1493 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1494 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1495 * else all matching key/values (regardless how many) are removed,
1496 * before the new pair is written.
1498 * Returns 0 on success.
1500 * This function does this:
1502 * - it locks the config file by creating ".git/config.lock"
1504 * - it then parses the config using store_aux() as validator to find
1505 * the position on the key/value pair to replace. If it is to be unset,
1506 * it must be found exactly once.
1508 * - the config file is mmap()ed and the part before the match (if any) is
1509 * written to the lock file, then the changed part and the rest.
1511 * - the config file is removed and the lock file rename()d to it.
1514 int git_config_set_multivar_in_file(const char *config_filename,
1515 const char *key, const char *value,
1516 const char *value_regex, int multi_replace)
1520 struct lock_file *lock = NULL;
1521 char *filename_buf = NULL;
1523 /* parse-key returns negative; flip the sign to feed exit(3) */
1524 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1528 store.multi_replace = multi_replace;
1530 if (!config_filename)
1531 config_filename = filename_buf = git_pathdup("config");
1534 * The lock serves a purpose in addition to locking: the new
1535 * contents of .git/config will be written into it.
1537 lock = xcalloc(sizeof(struct lock_file), 1);
1538 fd = hold_lock_file_for_update(lock, config_filename, 0);
1540 error("could not lock config file %s: %s", config_filename, strerror(errno));
1542 ret = CONFIG_NO_LOCK;
1547 * If .git/config does not exist yet, write a minimal version.
1549 in_fd = open(config_filename, O_RDONLY);
1553 if ( ENOENT != errno ) {
1554 error("opening %s: %s", config_filename,
1556 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1559 /* if nothing to unset, error out */
1560 if (value == NULL) {
1561 ret = CONFIG_NOTHING_SET;
1565 store.key = (char *)key;
1566 if (!store_write_section(fd, key) ||
1567 !store_write_pair(fd, key, value))
1572 size_t contents_sz, copy_begin, copy_end;
1573 int i, new_line = 0;
1575 if (value_regex == NULL)
1576 store.value_regex = NULL;
1578 if (value_regex[0] == '!') {
1579 store.do_not_match = 1;
1582 store.do_not_match = 0;
1584 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1585 if (regcomp(store.value_regex, value_regex,
1587 error("invalid pattern: %s", value_regex);
1588 free(store.value_regex);
1589 ret = CONFIG_INVALID_PATTERN;
1594 store.offset[0] = 0;
1595 store.state = START;
1599 * After this, store.offset will contain the *end* offset
1600 * of the last match, or remain at 0 if no match was found.
1601 * As a side effect, we make sure to transform only a valid
1602 * existing config file.
1604 if (git_config_from_file(store_aux, config_filename, NULL)) {
1605 error("invalid config file %s", config_filename);
1607 if (store.value_regex != NULL) {
1608 regfree(store.value_regex);
1609 free(store.value_regex);
1611 ret = CONFIG_INVALID_FILE;
1616 if (store.value_regex != NULL) {
1617 regfree(store.value_regex);
1618 free(store.value_regex);
1621 /* if nothing to unset, or too many matches, error out */
1622 if ((store.seen == 0 && value == NULL) ||
1623 (store.seen > 1 && multi_replace == 0)) {
1624 ret = CONFIG_NOTHING_SET;
1629 contents_sz = xsize_t(st.st_size);
1630 contents = xmmap(NULL, contents_sz, PROT_READ,
1631 MAP_PRIVATE, in_fd, 0);
1634 if (store.seen == 0)
1637 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1638 if (store.offset[i] == 0) {
1639 store.offset[i] = copy_end = contents_sz;
1640 } else if (store.state != KEY_SEEN) {
1641 copy_end = store.offset[i];
1643 copy_end = find_beginning_of_line(
1644 contents, contents_sz,
1645 store.offset[i]-2, &new_line);
1647 if (copy_end > 0 && contents[copy_end-1] != '\n')
1650 /* write the first part of the config */
1651 if (copy_end > copy_begin) {
1652 if (write_in_full(fd, contents + copy_begin,
1653 copy_end - copy_begin) <
1654 copy_end - copy_begin)
1657 write_str_in_full(fd, "\n") != 1)
1660 copy_begin = store.offset[i];
1663 /* write the pair (value == NULL means unset) */
1664 if (value != NULL) {
1665 if (store.state == START) {
1666 if (!store_write_section(fd, key))
1669 if (!store_write_pair(fd, key, value))
1673 /* write the rest of the config */
1674 if (copy_begin < contents_sz)
1675 if (write_in_full(fd, contents + copy_begin,
1676 contents_sz - copy_begin) <
1677 contents_sz - copy_begin)
1680 munmap(contents, contents_sz);
1683 if (commit_lock_file(lock) < 0) {
1684 error("could not commit config file %s", config_filename);
1685 ret = CONFIG_NO_WRITE;
1690 * lock is committed, so don't try to roll it back below.
1691 * NOTE: Since lockfile.c keeps a linked list of all created
1692 * lock_file structures, it isn't safe to free(lock). It's
1693 * better to just leave it hanging around.
1700 rollback_lock_file(lock);
1705 ret = write_error(lock->filename);
1710 int git_config_set_multivar(const char *key, const char *value,
1711 const char *value_regex, int multi_replace)
1713 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1717 static int section_name_match (const char *buf, const char *name)
1719 int i = 0, j = 0, dot = 0;
1722 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1723 if (!dot && isspace(buf[i])) {
1725 if (name[j++] != '.')
1727 for (i++; isspace(buf[i]); i++)
1733 if (buf[i] == '\\' && dot)
1735 else if (buf[i] == '"' && dot) {
1736 for (i++; isspace(buf[i]); i++)
1740 if (buf[i] != name[j++])
1743 if (buf[i] == ']' && name[j] == 0) {
1745 * We match, now just find the right length offset by
1746 * gobbling up any whitespace after it, as well
1749 for (; buf[i] && isspace(buf[i]); i++)
1756 static int section_name_is_ok(const char *name)
1758 /* Empty section names are bogus. */
1763 * Before a dot, we must be alphanumeric or dash. After the first dot,
1764 * anything goes, so we can stop checking.
1766 for (; *name && *name != '.'; name++)
1767 if (*name != '-' && !isalnum(*name))
1772 /* if new_name == NULL, the section is removed instead */
1773 int git_config_rename_section_in_file(const char *config_filename,
1774 const char *old_name, const char *new_name)
1776 int ret = 0, remove = 0;
1777 char *filename_buf = NULL;
1778 struct lock_file *lock;
1783 if (new_name && !section_name_is_ok(new_name)) {
1784 ret = error("invalid section name: %s", new_name);
1788 if (!config_filename)
1789 config_filename = filename_buf = git_pathdup("config");
1791 lock = xcalloc(sizeof(struct lock_file), 1);
1792 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1794 ret = error("could not lock config file %s", config_filename);
1798 if (!(config_file = fopen(config_filename, "rb"))) {
1799 /* no config file means nothing to rename, no error */
1800 goto unlock_and_out;
1803 while (fgets(buf, sizeof(buf), config_file)) {
1807 for (i = 0; buf[i] && isspace(buf[i]); i++)
1809 if (buf[i] == '[') {
1810 /* it's a section */
1811 int offset = section_name_match(&buf[i], old_name);
1814 if (new_name == NULL) {
1818 store.baselen = strlen(new_name);
1819 if (!store_write_section(out_fd, new_name)) {
1820 ret = write_error(lock->filename);
1824 * We wrote out the new section, with
1825 * a newline, now skip the old
1828 output += offset + i;
1829 if (strlen(output) > 0) {
1831 * More content means there's
1832 * a declaration to put on the
1833 * next line; indent with a
1844 length = strlen(output);
1845 if (write_in_full(out_fd, output, length) != length) {
1846 ret = write_error(lock->filename);
1850 fclose(config_file);
1852 if (commit_lock_file(lock) < 0)
1853 ret = error("could not commit config file %s", config_filename);
1859 int git_config_rename_section(const char *old_name, const char *new_name)
1861 return git_config_rename_section_in_file(NULL, old_name, new_name);
1865 * Call this to report error for your variable that should not
1866 * get a boolean value (i.e. "[my] var" means "true").
1868 #undef config_error_nonbool
1869 int config_error_nonbool(const char *var)
1871 return error("Missing value for '%s'", var);
1874 int parse_config_key(const char *var,
1875 const char *section,
1876 const char **subsection, int *subsection_len,
1879 int section_len = strlen(section);
1882 /* Does it start with "section." ? */
1883 if (prefixcmp(var, section) || var[section_len] != '.')
1887 * Find the key; we don't know yet if we have a subsection, but we must
1888 * parse backwards from the end, since the subsection may have dots in
1891 dot = strrchr(var, '.');
1894 /* Did we have a subsection at all? */
1895 if (dot == var + section_len) {
1897 *subsection_len = 0;
1900 *subsection = var + section_len + 1;
1901 *subsection_len = dot - *subsection;