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 (*fgetc)(struct config_source *c);
31 int (*ungetc)(int c, struct config_source *conf);
32 long (*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)
167 struct strbuf **pair;
168 pair = strbuf_split_str(text, '=', 2);
170 return error("bogus config parameter: %s", text);
171 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
172 strbuf_setlen(pair[0], pair[0]->len - 1);
173 strbuf_trim(pair[0]);
175 strbuf_list_free(pair);
176 return error("bogus config parameter: %s", text);
178 lowercase(pair[0]->buf);
179 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
180 strbuf_list_free(pair);
183 strbuf_list_free(pair);
187 int git_config_from_parameters(config_fn_t fn, void *data)
189 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
191 const char **argv = NULL;
192 int nr = 0, alloc = 0;
197 /* sq_dequote will write over it */
200 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
202 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
205 for (i = 0; i < nr; i++) {
206 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
218 static int get_next_char(void)
220 int c = cf->fgetc(cf);
223 /* DOS like systems */
239 static char *parse_value(void)
241 int quote = 0, comment = 0, space = 0;
243 strbuf_reset(&cf->value);
245 int c = get_next_char();
251 return cf->value.buf;
255 if (isspace(c) && !quote) {
261 if (c == ';' || c == '#') {
266 for (; space; space--)
267 strbuf_addch(&cf->value, ' ');
282 /* Some characters escape as themselves */
285 /* Reject unknown escape sequences */
289 strbuf_addch(&cf->value, c);
296 strbuf_addch(&cf->value, c);
300 static inline int iskeychar(int c)
302 return isalnum(c) || c == '-';
305 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
310 /* Get the full name */
317 strbuf_addch(name, tolower(c));
320 while (c == ' ' || c == '\t')
327 value = parse_value();
331 return fn(name->buf, value, data);
334 static int get_extended_base_var(struct strbuf *name, int c)
338 goto error_incomplete_line;
340 } while (isspace(c));
342 /* We require the format to be '[base "extension"]' */
345 strbuf_addch(name, '.');
348 int c = get_next_char();
350 goto error_incomplete_line;
356 goto error_incomplete_line;
358 strbuf_addch(name, c);
362 if (get_next_char() != ']')
365 error_incomplete_line:
370 static int get_base_var(struct strbuf *name)
373 int c = get_next_char();
379 return get_extended_base_var(name, c);
380 if (!iskeychar(c) && c != '.')
382 strbuf_addch(name, tolower(c));
386 static int git_parse_source(config_fn_t fn, void *data)
390 struct strbuf *var = &cf->var;
392 /* U+FEFF Byte Order Mark in UTF8 */
393 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
394 const unsigned char *bomptr = utf8_bom;
397 int c = get_next_char();
398 if (bomptr && *bomptr) {
399 /* We are at the file beginning; skip UTF8-encoded BOM
400 * if present. Sane editors won't put this in on their
401 * own, but e.g. Windows Notepad will do it happily. */
402 if ((unsigned char) c == *bomptr) {
406 /* Do not tolerate partial BOM. */
407 if (bomptr != utf8_bom)
409 /* No BOM at file beginning. Cool. */
419 if (comment || isspace(c))
421 if (c == '#' || c == ';') {
426 /* Reset prior to determining a new stem */
428 if (get_base_var(var) < 0 || var->len < 1)
430 strbuf_addch(var, '.');
437 * Truncate the var name back to the section header
438 * stem prior to grabbing the suffix part of the name
441 strbuf_setlen(var, baselen);
442 strbuf_addch(var, tolower(c));
443 if (get_value(fn, data, var) < 0)
446 if (cf->die_on_error)
447 die("bad config file line %d in %s", cf->linenr, cf->name);
449 return error("bad config file line %d in %s", cf->linenr, cf->name);
452 static int parse_unit_factor(const char *end, uintmax_t *val)
456 else if (!strcasecmp(end, "k")) {
460 else if (!strcasecmp(end, "m")) {
464 else if (!strcasecmp(end, "g")) {
465 *val *= 1024 * 1024 * 1024;
471 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
473 if (value && *value) {
477 uintmax_t factor = 1;
480 val = strtoimax(value, &end, 0);
483 if (!parse_unit_factor(end, &factor))
487 if (uval > max || abs(val) > uval)
496 int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
498 if (value && *value) {
504 val = strtoumax(value, &end, 0);
508 if (!parse_unit_factor(end, &val))
510 if (val > max || oldval > val)
518 static int git_parse_int(const char *value, int *ret)
521 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
527 int git_parse_ulong(const char *value, unsigned long *ret)
530 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
536 static void die_bad_config(const char *name)
539 die("bad config value for '%s' in %s", name, cf->name);
540 die("bad config value for '%s'", name);
543 int git_config_int(const char *name, const char *value)
546 if (!git_parse_int(value, &ret))
547 die_bad_config(name);
551 unsigned long git_config_ulong(const char *name, const char *value)
554 if (!git_parse_ulong(value, &ret))
555 die_bad_config(name);
559 static int git_config_maybe_bool_text(const char *name, const char *value)
565 if (!strcasecmp(value, "true")
566 || !strcasecmp(value, "yes")
567 || !strcasecmp(value, "on"))
569 if (!strcasecmp(value, "false")
570 || !strcasecmp(value, "no")
571 || !strcasecmp(value, "off"))
576 int git_config_maybe_bool(const char *name, const char *value)
578 int v = git_config_maybe_bool_text(name, value);
581 if (git_parse_int(value, &v))
586 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
588 int v = git_config_maybe_bool_text(name, value);
594 return git_config_int(name, value);
597 int git_config_bool(const char *name, const char *value)
600 return !!git_config_bool_or_int(name, value, &discard);
603 int git_config_string(const char **dest, const char *var, const char *value)
606 return config_error_nonbool(var);
607 *dest = xstrdup(value);
611 int git_config_pathname(const char **dest, const char *var, const char *value)
614 return config_error_nonbool(var);
615 *dest = expand_user_path(value);
617 die("Failed to expand user dir in: '%s'", value);
621 static int git_default_core_config(const char *var, const char *value)
623 /* This needs a better name */
624 if (!strcmp(var, "core.filemode")) {
625 trust_executable_bit = git_config_bool(var, value);
628 if (!strcmp(var, "core.trustctime")) {
629 trust_ctime = git_config_bool(var, value);
632 if (!strcmp(var, "core.statinfo") ||
633 !strcmp(var, "core.checkstat")) {
635 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
636 * never been advertised. we will remove it at Git
639 if (!strcmp(var, "core.statinfo")) {
642 warning("'core.statinfo' will be removed in Git 2.0; "
643 "use 'core.checkstat' instead.");
646 if (!strcasecmp(value, "default"))
648 else if (!strcasecmp(value, "minimal"))
652 if (!strcmp(var, "core.quotepath")) {
653 quote_path_fully = git_config_bool(var, value);
657 if (!strcmp(var, "core.symlinks")) {
658 has_symlinks = git_config_bool(var, value);
662 if (!strcmp(var, "core.ignorecase")) {
663 ignore_case = git_config_bool(var, value);
667 if (!strcmp(var, "core.attributesfile"))
668 return git_config_pathname(&git_attributes_file, var, value);
670 if (!strcmp(var, "core.bare")) {
671 is_bare_repository_cfg = git_config_bool(var, value);
675 if (!strcmp(var, "core.ignorestat")) {
676 assume_unchanged = git_config_bool(var, value);
680 if (!strcmp(var, "core.prefersymlinkrefs")) {
681 prefer_symlink_refs = git_config_bool(var, value);
685 if (!strcmp(var, "core.logallrefupdates")) {
686 log_all_ref_updates = git_config_bool(var, value);
690 if (!strcmp(var, "core.warnambiguousrefs")) {
691 warn_ambiguous_refs = git_config_bool(var, value);
695 if (!strcmp(var, "core.abbrev")) {
696 int abbrev = git_config_int(var, value);
697 if (abbrev < minimum_abbrev || abbrev > 40)
699 default_abbrev = abbrev;
703 if (!strcmp(var, "core.loosecompression")) {
704 int level = git_config_int(var, value);
706 level = Z_DEFAULT_COMPRESSION;
707 else if (level < 0 || level > Z_BEST_COMPRESSION)
708 die("bad zlib compression level %d", level);
709 zlib_compression_level = level;
710 zlib_compression_seen = 1;
714 if (!strcmp(var, "core.compression")) {
715 int level = git_config_int(var, value);
717 level = Z_DEFAULT_COMPRESSION;
718 else if (level < 0 || level > Z_BEST_COMPRESSION)
719 die("bad zlib compression level %d", level);
720 core_compression_level = level;
721 core_compression_seen = 1;
722 if (!zlib_compression_seen)
723 zlib_compression_level = level;
727 if (!strcmp(var, "core.packedgitwindowsize")) {
728 int pgsz_x2 = getpagesize() * 2;
729 packed_git_window_size = git_config_ulong(var, value);
731 /* This value must be multiple of (pagesize * 2) */
732 packed_git_window_size /= pgsz_x2;
733 if (packed_git_window_size < 1)
734 packed_git_window_size = 1;
735 packed_git_window_size *= pgsz_x2;
739 if (!strcmp(var, "core.bigfilethreshold")) {
740 big_file_threshold = git_config_ulong(var, value);
744 if (!strcmp(var, "core.packedgitlimit")) {
745 packed_git_limit = git_config_ulong(var, value);
749 if (!strcmp(var, "core.deltabasecachelimit")) {
750 delta_base_cache_limit = git_config_ulong(var, value);
754 if (!strcmp(var, "core.autocrlf")) {
755 if (value && !strcasecmp(value, "input")) {
756 if (core_eol == EOL_CRLF)
757 return error("core.autocrlf=input conflicts with core.eol=crlf");
758 auto_crlf = AUTO_CRLF_INPUT;
761 auto_crlf = git_config_bool(var, value);
765 if (!strcmp(var, "core.safecrlf")) {
766 if (value && !strcasecmp(value, "warn")) {
767 safe_crlf = SAFE_CRLF_WARN;
770 safe_crlf = git_config_bool(var, value);
774 if (!strcmp(var, "core.eol")) {
775 if (value && !strcasecmp(value, "lf"))
777 else if (value && !strcasecmp(value, "crlf"))
779 else if (value && !strcasecmp(value, "native"))
780 core_eol = EOL_NATIVE;
782 core_eol = EOL_UNSET;
783 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
784 return error("core.autocrlf=input conflicts with core.eol=crlf");
788 if (!strcmp(var, "core.notesref")) {
789 notes_ref_name = xstrdup(value);
793 if (!strcmp(var, "core.pager"))
794 return git_config_string(&pager_program, var, value);
796 if (!strcmp(var, "core.editor"))
797 return git_config_string(&editor_program, var, value);
799 if (!strcmp(var, "core.commentchar")) {
801 int ret = git_config_string(&comment, var, value);
803 comment_line_char = comment[0];
807 if (!strcmp(var, "core.askpass"))
808 return git_config_string(&askpass_program, var, value);
810 if (!strcmp(var, "core.excludesfile"))
811 return git_config_pathname(&excludes_file, var, value);
813 if (!strcmp(var, "core.whitespace")) {
815 return config_error_nonbool(var);
816 whitespace_rule_cfg = parse_whitespace_rule(value);
820 if (!strcmp(var, "core.fsyncobjectfiles")) {
821 fsync_object_files = git_config_bool(var, value);
825 if (!strcmp(var, "core.preloadindex")) {
826 core_preload_index = git_config_bool(var, value);
830 if (!strcmp(var, "core.createobject")) {
831 if (!strcmp(value, "rename"))
832 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
833 else if (!strcmp(value, "link"))
834 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
836 die("Invalid mode for object creation: %s", value);
840 if (!strcmp(var, "core.sparsecheckout")) {
841 core_apply_sparse_checkout = git_config_bool(var, value);
845 if (!strcmp(var, "core.precomposeunicode")) {
846 precomposed_unicode = git_config_bool(var, value);
850 /* Add other config variables here and to Documentation/config.txt. */
854 static int git_default_i18n_config(const char *var, const char *value)
856 if (!strcmp(var, "i18n.commitencoding"))
857 return git_config_string(&git_commit_encoding, var, value);
859 if (!strcmp(var, "i18n.logoutputencoding"))
860 return git_config_string(&git_log_output_encoding, var, value);
862 /* Add other config variables here and to Documentation/config.txt. */
866 static int git_default_branch_config(const char *var, const char *value)
868 if (!strcmp(var, "branch.autosetupmerge")) {
869 if (value && !strcasecmp(value, "always")) {
870 git_branch_track = BRANCH_TRACK_ALWAYS;
873 git_branch_track = git_config_bool(var, value);
876 if (!strcmp(var, "branch.autosetuprebase")) {
878 return config_error_nonbool(var);
879 else if (!strcmp(value, "never"))
880 autorebase = AUTOREBASE_NEVER;
881 else if (!strcmp(value, "local"))
882 autorebase = AUTOREBASE_LOCAL;
883 else if (!strcmp(value, "remote"))
884 autorebase = AUTOREBASE_REMOTE;
885 else if (!strcmp(value, "always"))
886 autorebase = AUTOREBASE_ALWAYS;
888 return error("Malformed value for %s", var);
892 /* Add other config variables here and to Documentation/config.txt. */
896 static int git_default_push_config(const char *var, const char *value)
898 if (!strcmp(var, "push.default")) {
900 return config_error_nonbool(var);
901 else if (!strcmp(value, "nothing"))
902 push_default = PUSH_DEFAULT_NOTHING;
903 else if (!strcmp(value, "matching"))
904 push_default = PUSH_DEFAULT_MATCHING;
905 else if (!strcmp(value, "simple"))
906 push_default = PUSH_DEFAULT_SIMPLE;
907 else if (!strcmp(value, "upstream"))
908 push_default = PUSH_DEFAULT_UPSTREAM;
909 else if (!strcmp(value, "tracking")) /* deprecated */
910 push_default = PUSH_DEFAULT_UPSTREAM;
911 else if (!strcmp(value, "current"))
912 push_default = PUSH_DEFAULT_CURRENT;
914 error("Malformed value for %s: %s", var, value);
915 return error("Must be one of nothing, matching, simple, "
916 "upstream or current.");
921 /* Add other config variables here and to Documentation/config.txt. */
925 static int git_default_mailmap_config(const char *var, const char *value)
927 if (!strcmp(var, "mailmap.file"))
928 return git_config_string(&git_mailmap_file, var, value);
929 if (!strcmp(var, "mailmap.blob"))
930 return git_config_string(&git_mailmap_blob, var, value);
932 /* Add other config variables here and to Documentation/config.txt. */
936 int git_default_config(const char *var, const char *value, void *dummy)
938 if (!prefixcmp(var, "core."))
939 return git_default_core_config(var, value);
941 if (!prefixcmp(var, "user."))
942 return git_ident_config(var, value, dummy);
944 if (!prefixcmp(var, "i18n."))
945 return git_default_i18n_config(var, value);
947 if (!prefixcmp(var, "branch."))
948 return git_default_branch_config(var, value);
950 if (!prefixcmp(var, "push."))
951 return git_default_push_config(var, value);
953 if (!prefixcmp(var, "mailmap."))
954 return git_default_mailmap_config(var, value);
956 if (!prefixcmp(var, "advice."))
957 return git_default_advice_config(var, value);
959 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
960 pager_use_color = git_config_bool(var,value);
964 if (!strcmp(var, "pack.packsizelimit")) {
965 pack_size_limit_cfg = git_config_ulong(var, value);
968 /* Add other config variables here and to Documentation/config.txt. */
973 * All source specific fields in the union, die_on_error, name and the callbacks
974 * fgetc, ungetc, ftell of top need to be initialized before calling
977 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
981 /* push config-file parsing state stack */
985 strbuf_init(&top->value, 1024);
986 strbuf_init(&top->var, 1024);
989 ret = git_parse_source(fn, data);
991 /* pop config-file parsing state stack */
992 strbuf_release(&top->value);
993 strbuf_release(&top->var);
999 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1002 FILE *f = fopen(filename, "r");
1006 struct config_source top;
1009 top.name = filename;
1010 top.die_on_error = 1;
1011 top.fgetc = config_file_fgetc;
1012 top.ungetc = config_file_ungetc;
1013 top.ftell = config_file_ftell;
1015 ret = do_config_from(&top, fn, data);
1022 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1023 size_t len, void *data)
1025 struct config_source top;
1027 top.u.buf.buf = buf;
1028 top.u.buf.len = len;
1031 top.die_on_error = 0;
1032 top.fgetc = config_buf_fgetc;
1033 top.ungetc = config_buf_ungetc;
1034 top.ftell = config_buf_ftell;
1036 return do_config_from(&top, fn, data);
1039 static int git_config_from_blob_sha1(config_fn_t fn,
1041 const unsigned char *sha1,
1044 enum object_type type;
1049 buf = read_sha1_file(sha1, &type, &size);
1051 return error("unable to load config blob object '%s'", name);
1052 if (type != OBJ_BLOB) {
1054 return error("reference '%s' does not point to a blob", name);
1057 ret = git_config_from_buf(fn, name, buf, size, data);
1063 static int git_config_from_blob_ref(config_fn_t fn,
1067 unsigned char sha1[20];
1069 if (get_sha1(name, sha1) < 0)
1070 return error("unable to resolve config blob '%s'", name);
1071 return git_config_from_blob_sha1(fn, name, sha1, data);
1074 const char *git_etc_gitconfig(void)
1076 static const char *system_wide;
1078 system_wide = system_path(ETC_GITCONFIG);
1082 int git_env_bool(const char *k, int def)
1084 const char *v = getenv(k);
1085 return v ? git_config_bool(k, v) : def;
1088 int git_config_system(void)
1090 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1093 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1095 int ret = 0, found = 0;
1096 char *xdg_config = NULL;
1097 char *user_config = NULL;
1099 home_config_paths(&user_config, &xdg_config, "config");
1101 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1102 ret += git_config_from_file(fn, git_etc_gitconfig(),
1107 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1108 ret += git_config_from_file(fn, xdg_config, data);
1112 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1113 ret += git_config_from_file(fn, user_config, data);
1117 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1118 ret += git_config_from_file(fn, repo_config, data);
1122 switch (git_config_from_parameters(fn, data)) {
1123 case -1: /* error */
1124 die("unable to parse command-line config");
1126 case 0: /* found nothing */
1128 default: /* found at least one item */
1135 return ret == 0 ? found : ret;
1138 int git_config_with_options(config_fn_t fn, void *data,
1139 const char *filename,
1140 const char *blob_ref,
1141 int respect_includes)
1143 char *repo_config = NULL;
1145 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1147 if (respect_includes) {
1150 fn = git_config_include;
1155 * If we have a specific filename, use it. Otherwise, follow the
1156 * regular lookup sequence.
1159 return git_config_from_file(fn, filename, data);
1161 return git_config_from_blob_ref(fn, blob_ref, data);
1163 repo_config = git_pathdup("config");
1164 ret = git_config_early(fn, data, repo_config);
1170 int git_config(config_fn_t fn, void *data)
1172 return git_config_with_options(fn, data, NULL, NULL, 1);
1176 * Find all the stuff for git_config_set() below.
1179 #define MAX_MATCHES 512
1185 regex_t *value_regex;
1187 size_t offset[MAX_MATCHES];
1188 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1192 static int matches(const char *key, const char *value)
1194 return !strcmp(key, store.key) &&
1195 (store.value_regex == NULL ||
1196 (store.do_not_match ^
1197 !regexec(store.value_regex, value, 0, NULL, 0)));
1200 static int store_aux(const char *key, const char *value, void *cb)
1205 switch (store.state) {
1207 if (matches(key, value)) {
1208 if (store.seen == 1 && store.multi_replace == 0) {
1209 warning("%s has multiple values", key);
1210 } else if (store.seen >= MAX_MATCHES) {
1211 error("too many matches for %s", key);
1215 store.offset[store.seen] = cf->ftell(cf);
1221 * What we are looking for is in store.key (both
1222 * section and var), and its section part is baselen
1223 * long. We found key (again, both section and var).
1224 * We would want to know if this key is in the same
1225 * section as what we are looking for. We already
1226 * know we are in the same section as what should
1229 ep = strrchr(key, '.');
1230 section_len = ep - key;
1232 if ((section_len != store.baselen) ||
1233 memcmp(key, store.key, section_len+1)) {
1234 store.state = SECTION_END_SEEN;
1239 * Do not increment matches: this is no match, but we
1240 * just made sure we are in the desired section.
1242 store.offset[store.seen] = cf->ftell(cf);
1244 case SECTION_END_SEEN:
1246 if (matches(key, value)) {
1247 store.offset[store.seen] = cf->ftell(cf);
1248 store.state = KEY_SEEN;
1251 if (strrchr(key, '.') - key == store.baselen &&
1252 !strncmp(key, store.key, store.baselen)) {
1253 store.state = SECTION_SEEN;
1254 store.offset[store.seen] = cf->ftell(cf);
1261 static int write_error(const char *filename)
1263 error("failed to write new configuration file %s", filename);
1265 /* Same error code as "failed to rename". */
1269 static int store_write_section(int fd, const char *key)
1273 struct strbuf sb = STRBUF_INIT;
1275 dot = memchr(key, '.', store.baselen);
1277 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1278 for (i = dot - key + 1; i < store.baselen; i++) {
1279 if (key[i] == '"' || key[i] == '\\')
1280 strbuf_addch(&sb, '\\');
1281 strbuf_addch(&sb, key[i]);
1283 strbuf_addstr(&sb, "\"]\n");
1285 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1288 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1289 strbuf_release(&sb);
1294 static int store_write_pair(int fd, const char *key, const char *value)
1297 int length = strlen(key + store.baselen + 1);
1298 const char *quote = "";
1299 struct strbuf sb = STRBUF_INIT;
1302 * Check to see if the value needs to be surrounded with a dq pair.
1303 * Note that problematic characters are always backslash-quoted; this
1304 * check is about not losing leading or trailing SP and strings that
1305 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1306 * configuration parser.
1308 if (value[0] == ' ')
1310 for (i = 0; value[i]; i++)
1311 if (value[i] == ';' || value[i] == '#')
1313 if (i && value[i - 1] == ' ')
1316 strbuf_addf(&sb, "\t%.*s = %s",
1317 length, key + store.baselen + 1, quote);
1319 for (i = 0; value[i]; i++)
1322 strbuf_addstr(&sb, "\\n");
1325 strbuf_addstr(&sb, "\\t");
1329 strbuf_addch(&sb, '\\');
1331 strbuf_addch(&sb, value[i]);
1334 strbuf_addf(&sb, "%s\n", quote);
1336 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1337 strbuf_release(&sb);
1342 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1343 size_t offset_, int *found_bracket)
1345 size_t equal_offset = size, bracket_offset = size;
1349 for (offset = offset_-2; offset > 0
1350 && contents[offset] != '\n'; offset--)
1351 switch (contents[offset]) {
1352 case '=': equal_offset = offset; break;
1353 case ']': bracket_offset = offset; break;
1355 if (offset > 0 && contents[offset-1] == '\\') {
1359 if (bracket_offset < equal_offset) {
1361 offset = bracket_offset+1;
1368 int git_config_set_in_file(const char *config_filename,
1369 const char *key, const char *value)
1371 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1374 int git_config_set(const char *key, const char *value)
1376 return git_config_set_multivar(key, value, NULL, 0);
1380 * Auxiliary function to sanity-check and split the key into the section
1381 * identifier and variable name.
1383 * Returns 0 on success, -1 when there is an invalid character in the key and
1384 * -2 if there is no section name in the key.
1386 * store_key - pointer to char* which will hold a copy of the key with
1387 * lowercase section and variable name
1388 * baselen - pointer to int which will hold the length of the
1389 * section + subsection part, can be NULL
1391 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1393 int i, dot, baselen;
1394 const char *last_dot = strrchr(key, '.');
1397 * Since "key" actually contains the section name and the real
1398 * key name separated by a dot, we have to know where the dot is.
1401 if (last_dot == NULL || last_dot == key) {
1402 error("key does not contain a section: %s", key);
1403 return -CONFIG_NO_SECTION_OR_NAME;
1407 error("key does not contain variable name: %s", key);
1408 return -CONFIG_NO_SECTION_OR_NAME;
1411 baselen = last_dot - key;
1413 *baselen_ = baselen;
1416 * Validate the key and while at it, lower case it for matching.
1418 *store_key = xmalloc(strlen(key) + 1);
1421 for (i = 0; key[i]; i++) {
1422 unsigned char c = key[i];
1425 /* Leave the extended basename untouched.. */
1426 if (!dot || i > baselen) {
1427 if (!iskeychar(c) ||
1428 (i == baselen + 1 && !isalpha(c))) {
1429 error("invalid key: %s", key);
1430 goto out_free_ret_1;
1433 } else if (c == '\n') {
1434 error("invalid key (newline): %s", key);
1435 goto out_free_ret_1;
1437 (*store_key)[i] = c;
1439 (*store_key)[i] = 0;
1446 return -CONFIG_INVALID_KEY;
1450 * If value==NULL, unset in (remove from) config,
1451 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1452 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1453 * else all matching key/values (regardless how many) are removed,
1454 * before the new pair is written.
1456 * Returns 0 on success.
1458 * This function does this:
1460 * - it locks the config file by creating ".git/config.lock"
1462 * - it then parses the config using store_aux() as validator to find
1463 * the position on the key/value pair to replace. If it is to be unset,
1464 * it must be found exactly once.
1466 * - the config file is mmap()ed and the part before the match (if any) is
1467 * written to the lock file, then the changed part and the rest.
1469 * - the config file is removed and the lock file rename()d to it.
1472 int git_config_set_multivar_in_file(const char *config_filename,
1473 const char *key, const char *value,
1474 const char *value_regex, int multi_replace)
1478 struct lock_file *lock = NULL;
1479 char *filename_buf = NULL;
1481 /* parse-key returns negative; flip the sign to feed exit(3) */
1482 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1486 store.multi_replace = multi_replace;
1488 if (!config_filename)
1489 config_filename = filename_buf = git_pathdup("config");
1492 * The lock serves a purpose in addition to locking: the new
1493 * contents of .git/config will be written into it.
1495 lock = xcalloc(sizeof(struct lock_file), 1);
1496 fd = hold_lock_file_for_update(lock, config_filename, 0);
1498 error("could not lock config file %s: %s", config_filename, strerror(errno));
1500 ret = CONFIG_NO_LOCK;
1505 * If .git/config does not exist yet, write a minimal version.
1507 in_fd = open(config_filename, O_RDONLY);
1511 if ( ENOENT != errno ) {
1512 error("opening %s: %s", config_filename,
1514 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1517 /* if nothing to unset, error out */
1518 if (value == NULL) {
1519 ret = CONFIG_NOTHING_SET;
1523 store.key = (char *)key;
1524 if (!store_write_section(fd, key) ||
1525 !store_write_pair(fd, key, value))
1530 size_t contents_sz, copy_begin, copy_end;
1531 int i, new_line = 0;
1533 if (value_regex == NULL)
1534 store.value_regex = NULL;
1536 if (value_regex[0] == '!') {
1537 store.do_not_match = 1;
1540 store.do_not_match = 0;
1542 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1543 if (regcomp(store.value_regex, value_regex,
1545 error("invalid pattern: %s", value_regex);
1546 free(store.value_regex);
1547 ret = CONFIG_INVALID_PATTERN;
1552 store.offset[0] = 0;
1553 store.state = START;
1557 * After this, store.offset will contain the *end* offset
1558 * of the last match, or remain at 0 if no match was found.
1559 * As a side effect, we make sure to transform only a valid
1560 * existing config file.
1562 if (git_config_from_file(store_aux, config_filename, NULL)) {
1563 error("invalid config file %s", config_filename);
1565 if (store.value_regex != NULL) {
1566 regfree(store.value_regex);
1567 free(store.value_regex);
1569 ret = CONFIG_INVALID_FILE;
1574 if (store.value_regex != NULL) {
1575 regfree(store.value_regex);
1576 free(store.value_regex);
1579 /* if nothing to unset, or too many matches, error out */
1580 if ((store.seen == 0 && value == NULL) ||
1581 (store.seen > 1 && multi_replace == 0)) {
1582 ret = CONFIG_NOTHING_SET;
1587 contents_sz = xsize_t(st.st_size);
1588 contents = xmmap(NULL, contents_sz, PROT_READ,
1589 MAP_PRIVATE, in_fd, 0);
1592 if (store.seen == 0)
1595 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1596 if (store.offset[i] == 0) {
1597 store.offset[i] = copy_end = contents_sz;
1598 } else if (store.state != KEY_SEEN) {
1599 copy_end = store.offset[i];
1601 copy_end = find_beginning_of_line(
1602 contents, contents_sz,
1603 store.offset[i]-2, &new_line);
1605 if (copy_end > 0 && contents[copy_end-1] != '\n')
1608 /* write the first part of the config */
1609 if (copy_end > copy_begin) {
1610 if (write_in_full(fd, contents + copy_begin,
1611 copy_end - copy_begin) <
1612 copy_end - copy_begin)
1615 write_str_in_full(fd, "\n") != 1)
1618 copy_begin = store.offset[i];
1621 /* write the pair (value == NULL means unset) */
1622 if (value != NULL) {
1623 if (store.state == START) {
1624 if (!store_write_section(fd, key))
1627 if (!store_write_pair(fd, key, value))
1631 /* write the rest of the config */
1632 if (copy_begin < contents_sz)
1633 if (write_in_full(fd, contents + copy_begin,
1634 contents_sz - copy_begin) <
1635 contents_sz - copy_begin)
1638 munmap(contents, contents_sz);
1641 if (commit_lock_file(lock) < 0) {
1642 error("could not commit config file %s", config_filename);
1643 ret = CONFIG_NO_WRITE;
1648 * lock is committed, so don't try to roll it back below.
1649 * NOTE: Since lockfile.c keeps a linked list of all created
1650 * lock_file structures, it isn't safe to free(lock). It's
1651 * better to just leave it hanging around.
1658 rollback_lock_file(lock);
1663 ret = write_error(lock->filename);
1668 int git_config_set_multivar(const char *key, const char *value,
1669 const char *value_regex, int multi_replace)
1671 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1675 static int section_name_match (const char *buf, const char *name)
1677 int i = 0, j = 0, dot = 0;
1680 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1681 if (!dot && isspace(buf[i])) {
1683 if (name[j++] != '.')
1685 for (i++; isspace(buf[i]); i++)
1691 if (buf[i] == '\\' && dot)
1693 else if (buf[i] == '"' && dot) {
1694 for (i++; isspace(buf[i]); i++)
1698 if (buf[i] != name[j++])
1701 if (buf[i] == ']' && name[j] == 0) {
1703 * We match, now just find the right length offset by
1704 * gobbling up any whitespace after it, as well
1707 for (; buf[i] && isspace(buf[i]); i++)
1714 static int section_name_is_ok(const char *name)
1716 /* Empty section names are bogus. */
1721 * Before a dot, we must be alphanumeric or dash. After the first dot,
1722 * anything goes, so we can stop checking.
1724 for (; *name && *name != '.'; name++)
1725 if (*name != '-' && !isalnum(*name))
1730 /* if new_name == NULL, the section is removed instead */
1731 int git_config_rename_section_in_file(const char *config_filename,
1732 const char *old_name, const char *new_name)
1734 int ret = 0, remove = 0;
1735 char *filename_buf = NULL;
1736 struct lock_file *lock;
1741 if (new_name && !section_name_is_ok(new_name)) {
1742 ret = error("invalid section name: %s", new_name);
1746 if (!config_filename)
1747 config_filename = filename_buf = git_pathdup("config");
1749 lock = xcalloc(sizeof(struct lock_file), 1);
1750 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1752 ret = error("could not lock config file %s", config_filename);
1756 if (!(config_file = fopen(config_filename, "rb"))) {
1757 /* no config file means nothing to rename, no error */
1758 goto unlock_and_out;
1761 while (fgets(buf, sizeof(buf), config_file)) {
1765 for (i = 0; buf[i] && isspace(buf[i]); i++)
1767 if (buf[i] == '[') {
1768 /* it's a section */
1769 int offset = section_name_match(&buf[i], old_name);
1772 if (new_name == NULL) {
1776 store.baselen = strlen(new_name);
1777 if (!store_write_section(out_fd, new_name)) {
1778 ret = write_error(lock->filename);
1782 * We wrote out the new section, with
1783 * a newline, now skip the old
1786 output += offset + i;
1787 if (strlen(output) > 0) {
1789 * More content means there's
1790 * a declaration to put on the
1791 * next line; indent with a
1802 length = strlen(output);
1803 if (write_in_full(out_fd, output, length) != length) {
1804 ret = write_error(lock->filename);
1808 fclose(config_file);
1810 if (commit_lock_file(lock) < 0)
1811 ret = error("could not commit config file %s", config_filename);
1817 int git_config_rename_section(const char *old_name, const char *new_name)
1819 return git_config_rename_section_in_file(NULL, old_name, new_name);
1823 * Call this to report error for your variable that should not
1824 * get a boolean value (i.e. "[my] var" means "true").
1826 #undef config_error_nonbool
1827 int config_error_nonbool(const char *var)
1829 return error("Missing value for '%s'", var);
1832 int parse_config_key(const char *var,
1833 const char *section,
1834 const char **subsection, int *subsection_len,
1837 int section_len = strlen(section);
1840 /* Does it start with "section." ? */
1841 if (prefixcmp(var, section) || var[section_len] != '.')
1845 * Find the key; we don't know yet if we have a subsection, but we must
1846 * parse backwards from the end, since the subsection may have dots in
1849 dot = strrchr(var, '.');
1852 /* Did we have a subsection at all? */
1853 if (dot == var + section_len) {
1855 *subsection_len = 0;
1858 *subsection = var + section_len + 1;
1859 *subsection_len = dot - *subsection;