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;
90 return config_error_nonbool("include.path");
92 expanded = expand_user_path(path);
94 return error("Could not expand include path '%s'", path);
98 * Use an absolute path as-is, but interpret relative paths
99 * based on the including config file.
101 if (!is_absolute_path(path)) {
104 if (!cf || !cf->name)
105 return error("relative config includes must come from files");
107 slash = find_last_dir_sep(cf->name);
109 strbuf_add(&buf, cf->name, slash - cf->name + 1);
110 strbuf_addstr(&buf, path);
114 if (!access_or_die(path, R_OK, 0)) {
115 if (++inc->depth > MAX_INCLUDE_DEPTH)
116 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
117 cf && cf->name ? cf->name : "the command line");
118 ret = git_config_from_file(git_config_include, path, inc);
121 strbuf_release(&buf);
126 int git_config_include(const char *var, const char *value, void *data)
128 struct config_include_data *inc = data;
133 * Pass along all values, including "include" directives; this makes it
134 * possible to query information on the includes themselves.
136 ret = inc->fn(var, value, inc->data);
140 type = skip_prefix(var, "include.");
144 if (!strcmp(type, "path"))
145 ret = handle_path_include(value, inc);
149 static void lowercase(char *p)
155 void git_config_push_parameter(const char *text)
157 struct strbuf env = STRBUF_INIT;
158 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
160 strbuf_addstr(&env, old);
161 strbuf_addch(&env, ' ');
163 sq_quote_buf(&env, text);
164 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
165 strbuf_release(&env);
168 int git_config_parse_parameter(const char *text,
169 config_fn_t fn, void *data)
171 struct strbuf **pair;
172 pair = strbuf_split_str(text, '=', 2);
174 return error("bogus config parameter: %s", text);
175 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
176 strbuf_setlen(pair[0], pair[0]->len - 1);
177 strbuf_trim(pair[0]);
179 strbuf_list_free(pair);
180 return error("bogus config parameter: %s", text);
182 lowercase(pair[0]->buf);
183 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
184 strbuf_list_free(pair);
187 strbuf_list_free(pair);
191 int git_config_from_parameters(config_fn_t fn, void *data)
193 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
195 const char **argv = NULL;
196 int nr = 0, alloc = 0;
201 /* sq_dequote will write over it */
204 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
206 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
209 for (i = 0; i < nr; i++) {
210 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
222 static int get_next_char(void)
224 int c = cf->do_fgetc(cf);
227 /* DOS like systems */
228 c = cf->do_fgetc(cf);
230 cf->do_ungetc(c, cf);
243 static char *parse_value(void)
245 int quote = 0, comment = 0, space = 0;
247 strbuf_reset(&cf->value);
249 int c = get_next_char();
255 return cf->value.buf;
259 if (isspace(c) && !quote) {
265 if (c == ';' || c == '#') {
270 for (; space; space--)
271 strbuf_addch(&cf->value, ' ');
286 /* Some characters escape as themselves */
289 /* Reject unknown escape sequences */
293 strbuf_addch(&cf->value, c);
300 strbuf_addch(&cf->value, c);
304 static inline int iskeychar(int c)
306 return isalnum(c) || c == '-';
309 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
314 /* Get the full name */
321 strbuf_addch(name, tolower(c));
324 while (c == ' ' || c == '\t')
331 value = parse_value();
335 return fn(name->buf, value, data);
338 static int get_extended_base_var(struct strbuf *name, int c)
342 goto error_incomplete_line;
344 } while (isspace(c));
346 /* We require the format to be '[base "extension"]' */
349 strbuf_addch(name, '.');
352 int c = get_next_char();
354 goto error_incomplete_line;
360 goto error_incomplete_line;
362 strbuf_addch(name, c);
366 if (get_next_char() != ']')
369 error_incomplete_line:
374 static int get_base_var(struct strbuf *name)
377 int c = get_next_char();
383 return get_extended_base_var(name, c);
384 if (!iskeychar(c) && c != '.')
386 strbuf_addch(name, tolower(c));
390 static int git_parse_source(config_fn_t fn, void *data)
394 struct strbuf *var = &cf->var;
396 /* U+FEFF Byte Order Mark in UTF8 */
397 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
398 const unsigned char *bomptr = utf8_bom;
401 int c = get_next_char();
402 if (bomptr && *bomptr) {
403 /* We are at the file beginning; skip UTF8-encoded BOM
404 * if present. Sane editors won't put this in on their
405 * own, but e.g. Windows Notepad will do it happily. */
406 if ((unsigned char) c == *bomptr) {
410 /* Do not tolerate partial BOM. */
411 if (bomptr != utf8_bom)
413 /* No BOM at file beginning. Cool. */
423 if (comment || isspace(c))
425 if (c == '#' || c == ';') {
430 /* Reset prior to determining a new stem */
432 if (get_base_var(var) < 0 || var->len < 1)
434 strbuf_addch(var, '.');
441 * Truncate the var name back to the section header
442 * stem prior to grabbing the suffix part of the name
445 strbuf_setlen(var, baselen);
446 strbuf_addch(var, tolower(c));
447 if (get_value(fn, data, var) < 0)
450 if (cf->die_on_error)
451 die("bad config file line %d in %s", cf->linenr, cf->name);
453 return error("bad config file line %d in %s", cf->linenr, cf->name);
456 static int parse_unit_factor(const char *end, uintmax_t *val)
460 else if (!strcasecmp(end, "k")) {
464 else if (!strcasecmp(end, "m")) {
468 else if (!strcasecmp(end, "g")) {
469 *val *= 1024 * 1024 * 1024;
475 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
477 if (value && *value) {
481 uintmax_t factor = 1;
484 val = strtoimax(value, &end, 0);
487 if (!parse_unit_factor(end, &factor)) {
493 if (uval > max || abs(val) > uval) {
505 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
507 if (value && *value) {
513 val = strtoumax(value, &end, 0);
517 if (!parse_unit_factor(end, &val)) {
521 if (val > max || oldval > val) {
532 static int git_parse_int(const char *value, int *ret)
535 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
541 static int git_parse_int64(const char *value, int64_t *ret)
544 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
550 int git_parse_ulong(const char *value, unsigned long *ret)
553 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
559 static void die_bad_number(const char *name, const char *value)
561 const char *reason = errno == ERANGE ?
568 die("bad numeric config value '%s' for '%s' in %s: %s",
569 value, name, cf->name, reason);
570 die("bad numeric config value '%s' for '%s': %s", value, name, reason);
573 int git_config_int(const char *name, const char *value)
576 if (!git_parse_int(value, &ret))
577 die_bad_number(name, value);
581 int64_t git_config_int64(const char *name, const char *value)
584 if (!git_parse_int64(value, &ret))
585 die_bad_number(name, value);
589 unsigned long git_config_ulong(const char *name, const char *value)
592 if (!git_parse_ulong(value, &ret))
593 die_bad_number(name, value);
597 static int git_config_maybe_bool_text(const char *name, const char *value)
603 if (!strcasecmp(value, "true")
604 || !strcasecmp(value, "yes")
605 || !strcasecmp(value, "on"))
607 if (!strcasecmp(value, "false")
608 || !strcasecmp(value, "no")
609 || !strcasecmp(value, "off"))
614 int git_config_maybe_bool(const char *name, const char *value)
616 int v = git_config_maybe_bool_text(name, value);
619 if (git_parse_int(value, &v))
624 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
626 int v = git_config_maybe_bool_text(name, value);
632 return git_config_int(name, value);
635 int git_config_bool(const char *name, const char *value)
638 return !!git_config_bool_or_int(name, value, &discard);
641 int git_config_string(const char **dest, const char *var, const char *value)
644 return config_error_nonbool(var);
645 *dest = xstrdup(value);
649 int git_config_pathname(const char **dest, const char *var, const char *value)
652 return config_error_nonbool(var);
653 *dest = expand_user_path(value);
655 die("Failed to expand user dir in: '%s'", value);
659 static int git_default_core_config(const char *var, const char *value)
661 /* This needs a better name */
662 if (!strcmp(var, "core.filemode")) {
663 trust_executable_bit = git_config_bool(var, value);
666 if (!strcmp(var, "core.trustctime")) {
667 trust_ctime = git_config_bool(var, value);
670 if (!strcmp(var, "core.statinfo") ||
671 !strcmp(var, "core.checkstat")) {
673 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
674 * never been advertised. we will remove it at Git
677 if (!strcmp(var, "core.statinfo")) {
680 warning("'core.statinfo' will be removed in Git 2.0; "
681 "use 'core.checkstat' instead.");
684 if (!strcasecmp(value, "default"))
686 else if (!strcasecmp(value, "minimal"))
690 if (!strcmp(var, "core.quotepath")) {
691 quote_path_fully = git_config_bool(var, value);
695 if (!strcmp(var, "core.symlinks")) {
696 has_symlinks = git_config_bool(var, value);
700 if (!strcmp(var, "core.ignorecase")) {
701 ignore_case = git_config_bool(var, value);
705 if (!strcmp(var, "core.attributesfile"))
706 return git_config_pathname(&git_attributes_file, var, value);
708 if (!strcmp(var, "core.bare")) {
709 is_bare_repository_cfg = git_config_bool(var, value);
713 if (!strcmp(var, "core.ignorestat")) {
714 assume_unchanged = git_config_bool(var, value);
718 if (!strcmp(var, "core.prefersymlinkrefs")) {
719 prefer_symlink_refs = git_config_bool(var, value);
723 if (!strcmp(var, "core.logallrefupdates")) {
724 log_all_ref_updates = git_config_bool(var, value);
728 if (!strcmp(var, "core.warnambiguousrefs")) {
729 warn_ambiguous_refs = git_config_bool(var, value);
733 if (!strcmp(var, "core.abbrev")) {
734 int abbrev = git_config_int(var, value);
735 if (abbrev < minimum_abbrev || abbrev > 40)
737 default_abbrev = abbrev;
741 if (!strcmp(var, "core.loosecompression")) {
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 zlib_compression_level = level;
748 zlib_compression_seen = 1;
752 if (!strcmp(var, "core.compression")) {
753 int level = git_config_int(var, value);
755 level = Z_DEFAULT_COMPRESSION;
756 else if (level < 0 || level > Z_BEST_COMPRESSION)
757 die("bad zlib compression level %d", level);
758 core_compression_level = level;
759 core_compression_seen = 1;
760 if (!zlib_compression_seen)
761 zlib_compression_level = level;
765 if (!strcmp(var, "core.packedgitwindowsize")) {
766 int pgsz_x2 = getpagesize() * 2;
767 packed_git_window_size = git_config_ulong(var, value);
769 /* This value must be multiple of (pagesize * 2) */
770 packed_git_window_size /= pgsz_x2;
771 if (packed_git_window_size < 1)
772 packed_git_window_size = 1;
773 packed_git_window_size *= pgsz_x2;
777 if (!strcmp(var, "core.bigfilethreshold")) {
778 big_file_threshold = git_config_ulong(var, value);
782 if (!strcmp(var, "core.packedgitlimit")) {
783 packed_git_limit = git_config_ulong(var, value);
787 if (!strcmp(var, "core.deltabasecachelimit")) {
788 delta_base_cache_limit = git_config_ulong(var, value);
792 if (!strcmp(var, "core.autocrlf")) {
793 if (value && !strcasecmp(value, "input")) {
794 if (core_eol == EOL_CRLF)
795 return error("core.autocrlf=input conflicts with core.eol=crlf");
796 auto_crlf = AUTO_CRLF_INPUT;
799 auto_crlf = git_config_bool(var, value);
803 if (!strcmp(var, "core.safecrlf")) {
804 if (value && !strcasecmp(value, "warn")) {
805 safe_crlf = SAFE_CRLF_WARN;
808 safe_crlf = git_config_bool(var, value);
812 if (!strcmp(var, "core.eol")) {
813 if (value && !strcasecmp(value, "lf"))
815 else if (value && !strcasecmp(value, "crlf"))
817 else if (value && !strcasecmp(value, "native"))
818 core_eol = EOL_NATIVE;
820 core_eol = EOL_UNSET;
821 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
822 return error("core.autocrlf=input conflicts with core.eol=crlf");
826 if (!strcmp(var, "core.notesref")) {
827 notes_ref_name = xstrdup(value);
831 if (!strcmp(var, "core.pager"))
832 return git_config_string(&pager_program, var, value);
834 if (!strcmp(var, "core.editor"))
835 return git_config_string(&editor_program, var, value);
837 if (!strcmp(var, "core.commentchar")) {
839 int ret = git_config_string(&comment, var, value);
841 comment_line_char = comment[0];
845 if (!strcmp(var, "core.askpass"))
846 return git_config_string(&askpass_program, var, value);
848 if (!strcmp(var, "core.excludesfile"))
849 return git_config_pathname(&excludes_file, var, value);
851 if (!strcmp(var, "core.whitespace")) {
853 return config_error_nonbool(var);
854 whitespace_rule_cfg = parse_whitespace_rule(value);
858 if (!strcmp(var, "core.fsyncobjectfiles")) {
859 fsync_object_files = git_config_bool(var, value);
863 if (!strcmp(var, "core.preloadindex")) {
864 core_preload_index = git_config_bool(var, value);
868 if (!strcmp(var, "core.createobject")) {
869 if (!strcmp(value, "rename"))
870 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
871 else if (!strcmp(value, "link"))
872 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
874 die("Invalid mode for object creation: %s", value);
878 if (!strcmp(var, "core.sparsecheckout")) {
879 core_apply_sparse_checkout = git_config_bool(var, value);
883 if (!strcmp(var, "core.precomposeunicode")) {
884 precomposed_unicode = git_config_bool(var, value);
888 /* Add other config variables here and to Documentation/config.txt. */
892 static int git_default_i18n_config(const char *var, const char *value)
894 if (!strcmp(var, "i18n.commitencoding"))
895 return git_config_string(&git_commit_encoding, var, value);
897 if (!strcmp(var, "i18n.logoutputencoding"))
898 return git_config_string(&git_log_output_encoding, var, value);
900 /* Add other config variables here and to Documentation/config.txt. */
904 static int git_default_branch_config(const char *var, const char *value)
906 if (!strcmp(var, "branch.autosetupmerge")) {
907 if (value && !strcasecmp(value, "always")) {
908 git_branch_track = BRANCH_TRACK_ALWAYS;
911 git_branch_track = git_config_bool(var, value);
914 if (!strcmp(var, "branch.autosetuprebase")) {
916 return config_error_nonbool(var);
917 else if (!strcmp(value, "never"))
918 autorebase = AUTOREBASE_NEVER;
919 else if (!strcmp(value, "local"))
920 autorebase = AUTOREBASE_LOCAL;
921 else if (!strcmp(value, "remote"))
922 autorebase = AUTOREBASE_REMOTE;
923 else if (!strcmp(value, "always"))
924 autorebase = AUTOREBASE_ALWAYS;
926 return error("Malformed value for %s", var);
930 /* Add other config variables here and to Documentation/config.txt. */
934 static int git_default_push_config(const char *var, const char *value)
936 if (!strcmp(var, "push.default")) {
938 return config_error_nonbool(var);
939 else if (!strcmp(value, "nothing"))
940 push_default = PUSH_DEFAULT_NOTHING;
941 else if (!strcmp(value, "matching"))
942 push_default = PUSH_DEFAULT_MATCHING;
943 else if (!strcmp(value, "simple"))
944 push_default = PUSH_DEFAULT_SIMPLE;
945 else if (!strcmp(value, "upstream"))
946 push_default = PUSH_DEFAULT_UPSTREAM;
947 else if (!strcmp(value, "tracking")) /* deprecated */
948 push_default = PUSH_DEFAULT_UPSTREAM;
949 else if (!strcmp(value, "current"))
950 push_default = PUSH_DEFAULT_CURRENT;
952 error("Malformed value for %s: %s", var, value);
953 return error("Must be one of nothing, matching, simple, "
954 "upstream or current.");
959 /* Add other config variables here and to Documentation/config.txt. */
963 static int git_default_mailmap_config(const char *var, const char *value)
965 if (!strcmp(var, "mailmap.file"))
966 return git_config_string(&git_mailmap_file, var, value);
967 if (!strcmp(var, "mailmap.blob"))
968 return git_config_string(&git_mailmap_blob, var, value);
970 /* Add other config variables here and to Documentation/config.txt. */
974 int git_default_config(const char *var, const char *value, void *dummy)
976 if (starts_with(var, "core."))
977 return git_default_core_config(var, value);
979 if (starts_with(var, "user."))
980 return git_ident_config(var, value, dummy);
982 if (starts_with(var, "i18n."))
983 return git_default_i18n_config(var, value);
985 if (starts_with(var, "branch."))
986 return git_default_branch_config(var, value);
988 if (starts_with(var, "push."))
989 return git_default_push_config(var, value);
991 if (starts_with(var, "mailmap."))
992 return git_default_mailmap_config(var, value);
994 if (starts_with(var, "advice."))
995 return git_default_advice_config(var, value);
997 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
998 pager_use_color = git_config_bool(var,value);
1002 if (!strcmp(var, "pack.packsizelimit")) {
1003 pack_size_limit_cfg = git_config_ulong(var, value);
1006 /* Add other config variables here and to Documentation/config.txt. */
1011 * All source specific fields in the union, die_on_error, name and the callbacks
1012 * fgetc, ungetc, ftell of top need to be initialized before calling
1015 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1019 /* push config-file parsing state stack */
1023 strbuf_init(&top->value, 1024);
1024 strbuf_init(&top->var, 1024);
1027 ret = git_parse_source(fn, data);
1029 /* pop config-file parsing state stack */
1030 strbuf_release(&top->value);
1031 strbuf_release(&top->var);
1037 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1040 FILE *f = fopen(filename, "r");
1044 struct config_source top;
1047 top.name = filename;
1048 top.die_on_error = 1;
1049 top.do_fgetc = config_file_fgetc;
1050 top.do_ungetc = config_file_ungetc;
1051 top.do_ftell = config_file_ftell;
1053 ret = do_config_from(&top, fn, data);
1060 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1061 size_t len, void *data)
1063 struct config_source top;
1065 top.u.buf.buf = buf;
1066 top.u.buf.len = len;
1069 top.die_on_error = 0;
1070 top.do_fgetc = config_buf_fgetc;
1071 top.do_ungetc = config_buf_ungetc;
1072 top.do_ftell = config_buf_ftell;
1074 return do_config_from(&top, fn, data);
1077 static int git_config_from_blob_sha1(config_fn_t fn,
1079 const unsigned char *sha1,
1082 enum object_type type;
1087 buf = read_sha1_file(sha1, &type, &size);
1089 return error("unable to load config blob object '%s'", name);
1090 if (type != OBJ_BLOB) {
1092 return error("reference '%s' does not point to a blob", name);
1095 ret = git_config_from_buf(fn, name, buf, size, data);
1101 static int git_config_from_blob_ref(config_fn_t fn,
1105 unsigned char sha1[20];
1107 if (get_sha1(name, sha1) < 0)
1108 return error("unable to resolve config blob '%s'", name);
1109 return git_config_from_blob_sha1(fn, name, sha1, data);
1112 const char *git_etc_gitconfig(void)
1114 static const char *system_wide;
1116 system_wide = system_path(ETC_GITCONFIG);
1120 int git_env_bool(const char *k, int def)
1122 const char *v = getenv(k);
1123 return v ? git_config_bool(k, v) : def;
1126 int git_config_system(void)
1128 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1131 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1133 int ret = 0, found = 0;
1134 char *xdg_config = NULL;
1135 char *user_config = NULL;
1137 home_config_paths(&user_config, &xdg_config, "config");
1139 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1140 ret += git_config_from_file(fn, git_etc_gitconfig(),
1145 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1146 ret += git_config_from_file(fn, xdg_config, data);
1150 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1151 ret += git_config_from_file(fn, user_config, data);
1155 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1156 ret += git_config_from_file(fn, repo_config, data);
1160 switch (git_config_from_parameters(fn, data)) {
1161 case -1: /* error */
1162 die("unable to parse command-line config");
1164 case 0: /* found nothing */
1166 default: /* found at least one item */
1173 return ret == 0 ? found : ret;
1176 int git_config_with_options(config_fn_t fn, void *data,
1177 const char *filename,
1178 const char *blob_ref,
1179 int respect_includes)
1181 char *repo_config = NULL;
1183 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1185 if (respect_includes) {
1188 fn = git_config_include;
1193 * If we have a specific filename, use it. Otherwise, follow the
1194 * regular lookup sequence.
1197 return git_config_from_file(fn, filename, data);
1199 return git_config_from_blob_ref(fn, blob_ref, data);
1201 repo_config = git_pathdup("config");
1202 ret = git_config_early(fn, data, repo_config);
1208 int git_config(config_fn_t fn, void *data)
1210 return git_config_with_options(fn, data, NULL, NULL, 1);
1214 * Find all the stuff for git_config_set() below.
1221 regex_t *value_regex;
1224 unsigned int offset_alloc;
1225 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1229 static int matches(const char *key, const char *value)
1231 return !strcmp(key, store.key) &&
1232 (store.value_regex == NULL ||
1233 (store.do_not_match ^
1234 !regexec(store.value_regex, value, 0, NULL, 0)));
1237 static int store_aux(const char *key, const char *value, void *cb)
1242 switch (store.state) {
1244 if (matches(key, value)) {
1245 if (store.seen == 1 && store.multi_replace == 0) {
1246 warning("%s has multiple values", key);
1249 ALLOC_GROW(store.offset, store.seen + 1,
1250 store.offset_alloc);
1252 store.offset[store.seen] = cf->do_ftell(cf);
1258 * What we are looking for is in store.key (both
1259 * section and var), and its section part is baselen
1260 * long. We found key (again, both section and var).
1261 * We would want to know if this key is in the same
1262 * section as what we are looking for. We already
1263 * know we are in the same section as what should
1266 ep = strrchr(key, '.');
1267 section_len = ep - key;
1269 if ((section_len != store.baselen) ||
1270 memcmp(key, store.key, section_len+1)) {
1271 store.state = SECTION_END_SEEN;
1276 * Do not increment matches: this is no match, but we
1277 * just made sure we are in the desired section.
1279 ALLOC_GROW(store.offset, store.seen + 1,
1280 store.offset_alloc);
1281 store.offset[store.seen] = cf->do_ftell(cf);
1283 case SECTION_END_SEEN:
1285 if (matches(key, value)) {
1286 ALLOC_GROW(store.offset, store.seen + 1,
1287 store.offset_alloc);
1288 store.offset[store.seen] = cf->do_ftell(cf);
1289 store.state = KEY_SEEN;
1292 if (strrchr(key, '.') - key == store.baselen &&
1293 !strncmp(key, store.key, store.baselen)) {
1294 store.state = SECTION_SEEN;
1295 ALLOC_GROW(store.offset,
1297 store.offset_alloc);
1298 store.offset[store.seen] = cf->do_ftell(cf);
1305 static int write_error(const char *filename)
1307 error("failed to write new configuration file %s", filename);
1309 /* Same error code as "failed to rename". */
1313 static int store_write_section(int fd, const char *key)
1317 struct strbuf sb = STRBUF_INIT;
1319 dot = memchr(key, '.', store.baselen);
1321 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1322 for (i = dot - key + 1; i < store.baselen; i++) {
1323 if (key[i] == '"' || key[i] == '\\')
1324 strbuf_addch(&sb, '\\');
1325 strbuf_addch(&sb, key[i]);
1327 strbuf_addstr(&sb, "\"]\n");
1329 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1332 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1333 strbuf_release(&sb);
1338 static int store_write_pair(int fd, const char *key, const char *value)
1341 int length = strlen(key + store.baselen + 1);
1342 const char *quote = "";
1343 struct strbuf sb = STRBUF_INIT;
1346 * Check to see if the value needs to be surrounded with a dq pair.
1347 * Note that problematic characters are always backslash-quoted; this
1348 * check is about not losing leading or trailing SP and strings that
1349 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1350 * configuration parser.
1352 if (value[0] == ' ')
1354 for (i = 0; value[i]; i++)
1355 if (value[i] == ';' || value[i] == '#')
1357 if (i && value[i - 1] == ' ')
1360 strbuf_addf(&sb, "\t%.*s = %s",
1361 length, key + store.baselen + 1, quote);
1363 for (i = 0; value[i]; i++)
1366 strbuf_addstr(&sb, "\\n");
1369 strbuf_addstr(&sb, "\\t");
1373 strbuf_addch(&sb, '\\');
1375 strbuf_addch(&sb, value[i]);
1378 strbuf_addf(&sb, "%s\n", quote);
1380 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1381 strbuf_release(&sb);
1386 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1387 size_t offset_, int *found_bracket)
1389 size_t equal_offset = size, bracket_offset = size;
1393 for (offset = offset_-2; offset > 0
1394 && contents[offset] != '\n'; offset--)
1395 switch (contents[offset]) {
1396 case '=': equal_offset = offset; break;
1397 case ']': bracket_offset = offset; break;
1399 if (offset > 0 && contents[offset-1] == '\\') {
1403 if (bracket_offset < equal_offset) {
1405 offset = bracket_offset+1;
1412 int git_config_set_in_file(const char *config_filename,
1413 const char *key, const char *value)
1415 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1418 int git_config_set(const char *key, const char *value)
1420 return git_config_set_multivar(key, value, NULL, 0);
1424 * Auxiliary function to sanity-check and split the key into the section
1425 * identifier and variable name.
1427 * Returns 0 on success, -1 when there is an invalid character in the key and
1428 * -2 if there is no section name in the key.
1430 * store_key - pointer to char* which will hold a copy of the key with
1431 * lowercase section and variable name
1432 * baselen - pointer to int which will hold the length of the
1433 * section + subsection part, can be NULL
1435 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1437 int i, dot, baselen;
1438 const char *last_dot = strrchr(key, '.');
1441 * Since "key" actually contains the section name and the real
1442 * key name separated by a dot, we have to know where the dot is.
1445 if (last_dot == NULL || last_dot == key) {
1446 error("key does not contain a section: %s", key);
1447 return -CONFIG_NO_SECTION_OR_NAME;
1451 error("key does not contain variable name: %s", key);
1452 return -CONFIG_NO_SECTION_OR_NAME;
1455 baselen = last_dot - key;
1457 *baselen_ = baselen;
1460 * Validate the key and while at it, lower case it for matching.
1462 *store_key = xmalloc(strlen(key) + 1);
1465 for (i = 0; key[i]; i++) {
1466 unsigned char c = key[i];
1469 /* Leave the extended basename untouched.. */
1470 if (!dot || i > baselen) {
1471 if (!iskeychar(c) ||
1472 (i == baselen + 1 && !isalpha(c))) {
1473 error("invalid key: %s", key);
1474 goto out_free_ret_1;
1477 } else if (c == '\n') {
1478 error("invalid key (newline): %s", key);
1479 goto out_free_ret_1;
1481 (*store_key)[i] = c;
1483 (*store_key)[i] = 0;
1490 return -CONFIG_INVALID_KEY;
1494 * If value==NULL, unset in (remove from) config,
1495 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1496 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1497 * else all matching key/values (regardless how many) are removed,
1498 * before the new pair is written.
1500 * Returns 0 on success.
1502 * This function does this:
1504 * - it locks the config file by creating ".git/config.lock"
1506 * - it then parses the config using store_aux() as validator to find
1507 * the position on the key/value pair to replace. If it is to be unset,
1508 * it must be found exactly once.
1510 * - the config file is mmap()ed and the part before the match (if any) is
1511 * written to the lock file, then the changed part and the rest.
1513 * - the config file is removed and the lock file rename()d to it.
1516 int git_config_set_multivar_in_file(const char *config_filename,
1517 const char *key, const char *value,
1518 const char *value_regex, int multi_replace)
1522 struct lock_file *lock = NULL;
1523 char *filename_buf = NULL;
1525 /* parse-key returns negative; flip the sign to feed exit(3) */
1526 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1530 store.multi_replace = multi_replace;
1532 if (!config_filename)
1533 config_filename = filename_buf = git_pathdup("config");
1536 * The lock serves a purpose in addition to locking: the new
1537 * contents of .git/config will be written into it.
1539 lock = xcalloc(sizeof(struct lock_file), 1);
1540 fd = hold_lock_file_for_update(lock, config_filename, 0);
1542 error("could not lock config file %s: %s", config_filename, strerror(errno));
1544 ret = CONFIG_NO_LOCK;
1549 * If .git/config does not exist yet, write a minimal version.
1551 in_fd = open(config_filename, O_RDONLY);
1555 if ( ENOENT != errno ) {
1556 error("opening %s: %s", config_filename,
1558 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1561 /* if nothing to unset, error out */
1562 if (value == NULL) {
1563 ret = CONFIG_NOTHING_SET;
1567 store.key = (char *)key;
1568 if (!store_write_section(fd, key) ||
1569 !store_write_pair(fd, key, value))
1574 size_t contents_sz, copy_begin, copy_end;
1575 int i, new_line = 0;
1577 if (value_regex == NULL)
1578 store.value_regex = NULL;
1580 if (value_regex[0] == '!') {
1581 store.do_not_match = 1;
1584 store.do_not_match = 0;
1586 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1587 if (regcomp(store.value_regex, value_regex,
1589 error("invalid pattern: %s", value_regex);
1590 free(store.value_regex);
1591 ret = CONFIG_INVALID_PATTERN;
1596 ALLOC_GROW(store.offset, 1, store.offset_alloc);
1597 store.offset[0] = 0;
1598 store.state = START;
1602 * After this, store.offset will contain the *end* offset
1603 * of the last match, or remain at 0 if no match was found.
1604 * As a side effect, we make sure to transform only a valid
1605 * existing config file.
1607 if (git_config_from_file(store_aux, config_filename, NULL)) {
1608 error("invalid config file %s", config_filename);
1610 if (store.value_regex != NULL) {
1611 regfree(store.value_regex);
1612 free(store.value_regex);
1614 ret = CONFIG_INVALID_FILE;
1619 if (store.value_regex != NULL) {
1620 regfree(store.value_regex);
1621 free(store.value_regex);
1624 /* if nothing to unset, or too many matches, error out */
1625 if ((store.seen == 0 && value == NULL) ||
1626 (store.seen > 1 && multi_replace == 0)) {
1627 ret = CONFIG_NOTHING_SET;
1632 contents_sz = xsize_t(st.st_size);
1633 contents = xmmap(NULL, contents_sz, PROT_READ,
1634 MAP_PRIVATE, in_fd, 0);
1637 if (store.seen == 0)
1640 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1641 if (store.offset[i] == 0) {
1642 store.offset[i] = copy_end = contents_sz;
1643 } else if (store.state != KEY_SEEN) {
1644 copy_end = store.offset[i];
1646 copy_end = find_beginning_of_line(
1647 contents, contents_sz,
1648 store.offset[i]-2, &new_line);
1650 if (copy_end > 0 && contents[copy_end-1] != '\n')
1653 /* write the first part of the config */
1654 if (copy_end > copy_begin) {
1655 if (write_in_full(fd, contents + copy_begin,
1656 copy_end - copy_begin) <
1657 copy_end - copy_begin)
1660 write_str_in_full(fd, "\n") != 1)
1663 copy_begin = store.offset[i];
1666 /* write the pair (value == NULL means unset) */
1667 if (value != NULL) {
1668 if (store.state == START) {
1669 if (!store_write_section(fd, key))
1672 if (!store_write_pair(fd, key, value))
1676 /* write the rest of the config */
1677 if (copy_begin < contents_sz)
1678 if (write_in_full(fd, contents + copy_begin,
1679 contents_sz - copy_begin) <
1680 contents_sz - copy_begin)
1683 munmap(contents, contents_sz);
1686 if (commit_lock_file(lock) < 0) {
1687 error("could not commit config file %s", config_filename);
1688 ret = CONFIG_NO_WRITE;
1693 * lock is committed, so don't try to roll it back below.
1694 * NOTE: Since lockfile.c keeps a linked list of all created
1695 * lock_file structures, it isn't safe to free(lock). It's
1696 * better to just leave it hanging around.
1703 rollback_lock_file(lock);
1708 ret = write_error(lock->filename);
1713 int git_config_set_multivar(const char *key, const char *value,
1714 const char *value_regex, int multi_replace)
1716 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1720 static int section_name_match (const char *buf, const char *name)
1722 int i = 0, j = 0, dot = 0;
1725 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1726 if (!dot && isspace(buf[i])) {
1728 if (name[j++] != '.')
1730 for (i++; isspace(buf[i]); i++)
1736 if (buf[i] == '\\' && dot)
1738 else if (buf[i] == '"' && dot) {
1739 for (i++; isspace(buf[i]); i++)
1743 if (buf[i] != name[j++])
1746 if (buf[i] == ']' && name[j] == 0) {
1748 * We match, now just find the right length offset by
1749 * gobbling up any whitespace after it, as well
1752 for (; buf[i] && isspace(buf[i]); i++)
1759 static int section_name_is_ok(const char *name)
1761 /* Empty section names are bogus. */
1766 * Before a dot, we must be alphanumeric or dash. After the first dot,
1767 * anything goes, so we can stop checking.
1769 for (; *name && *name != '.'; name++)
1770 if (*name != '-' && !isalnum(*name))
1775 /* if new_name == NULL, the section is removed instead */
1776 int git_config_rename_section_in_file(const char *config_filename,
1777 const char *old_name, const char *new_name)
1779 int ret = 0, remove = 0;
1780 char *filename_buf = NULL;
1781 struct lock_file *lock;
1786 if (new_name && !section_name_is_ok(new_name)) {
1787 ret = error("invalid section name: %s", new_name);
1791 if (!config_filename)
1792 config_filename = filename_buf = git_pathdup("config");
1794 lock = xcalloc(sizeof(struct lock_file), 1);
1795 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1797 ret = error("could not lock config file %s", config_filename);
1801 if (!(config_file = fopen(config_filename, "rb"))) {
1802 /* no config file means nothing to rename, no error */
1803 goto unlock_and_out;
1806 while (fgets(buf, sizeof(buf), config_file)) {
1810 for (i = 0; buf[i] && isspace(buf[i]); i++)
1812 if (buf[i] == '[') {
1813 /* it's a section */
1814 int offset = section_name_match(&buf[i], old_name);
1817 if (new_name == NULL) {
1821 store.baselen = strlen(new_name);
1822 if (!store_write_section(out_fd, new_name)) {
1823 ret = write_error(lock->filename);
1827 * We wrote out the new section, with
1828 * a newline, now skip the old
1831 output += offset + i;
1832 if (strlen(output) > 0) {
1834 * More content means there's
1835 * a declaration to put on the
1836 * next line; indent with a
1847 length = strlen(output);
1848 if (write_in_full(out_fd, output, length) != length) {
1849 ret = write_error(lock->filename);
1853 fclose(config_file);
1855 if (commit_lock_file(lock) < 0)
1856 ret = error("could not commit config file %s", config_filename);
1862 int git_config_rename_section(const char *old_name, const char *new_name)
1864 return git_config_rename_section_in_file(NULL, old_name, new_name);
1868 * Call this to report error for your variable that should not
1869 * get a boolean value (i.e. "[my] var" means "true").
1871 #undef config_error_nonbool
1872 int config_error_nonbool(const char *var)
1874 return error("Missing value for '%s'", var);
1877 int parse_config_key(const char *var,
1878 const char *section,
1879 const char **subsection, int *subsection_len,
1882 int section_len = strlen(section);
1885 /* Does it start with "section." ? */
1886 if (!starts_with(var, section) || var[section_len] != '.')
1890 * Find the key; we don't know yet if we have a subsection, but we must
1891 * parse backwards from the end, since the subsection may have dots in
1894 dot = strrchr(var, '.');
1897 /* Did we have a subsection at all? */
1898 if (dot == var + section_len) {
1900 *subsection_len = 0;
1903 *subsection = var + section_len + 1;
1904 *subsection_len = dot - *subsection;