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)
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->do_fgetc(cf);
223 /* DOS like systems */
224 c = cf->do_fgetc(cf);
226 cf->do_ungetc(c, cf);
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)) {
489 if (uval > max || abs(val) > uval) {
501 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
503 if (value && *value) {
509 val = strtoumax(value, &end, 0);
513 if (!parse_unit_factor(end, &val)) {
517 if (val > max || oldval > val) {
528 static int git_parse_int(const char *value, int *ret)
531 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
537 static int git_parse_int64(const char *value, int64_t *ret)
540 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
546 int git_parse_ulong(const char *value, unsigned long *ret)
549 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
555 static void die_bad_number(const char *name, const char *value)
557 const char *reason = errno == ERANGE ?
564 die("bad numeric config value '%s' for '%s' in %s: %s",
565 value, name, cf->name, reason);
566 die("bad numeric config value '%s' for '%s': %s", value, name, reason);
569 int git_config_int(const char *name, const char *value)
572 if (!git_parse_int(value, &ret))
573 die_bad_number(name, value);
577 int64_t git_config_int64(const char *name, const char *value)
580 if (!git_parse_int64(value, &ret))
581 die_bad_number(name, value);
585 unsigned long git_config_ulong(const char *name, const char *value)
588 if (!git_parse_ulong(value, &ret))
589 die_bad_number(name, value);
593 static int git_config_maybe_bool_text(const char *name, const char *value)
599 if (!strcasecmp(value, "true")
600 || !strcasecmp(value, "yes")
601 || !strcasecmp(value, "on"))
603 if (!strcasecmp(value, "false")
604 || !strcasecmp(value, "no")
605 || !strcasecmp(value, "off"))
610 int git_config_maybe_bool(const char *name, const char *value)
612 int v = git_config_maybe_bool_text(name, value);
615 if (git_parse_int(value, &v))
620 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
622 int v = git_config_maybe_bool_text(name, value);
628 return git_config_int(name, value);
631 int git_config_bool(const char *name, const char *value)
634 return !!git_config_bool_or_int(name, value, &discard);
637 int git_config_string(const char **dest, const char *var, const char *value)
640 return config_error_nonbool(var);
641 *dest = xstrdup(value);
645 int git_config_pathname(const char **dest, const char *var, const char *value)
648 return config_error_nonbool(var);
649 *dest = expand_user_path(value);
651 die("Failed to expand user dir in: '%s'", value);
655 static int git_default_core_config(const char *var, const char *value)
657 /* This needs a better name */
658 if (!strcmp(var, "core.filemode")) {
659 trust_executable_bit = git_config_bool(var, value);
662 if (!strcmp(var, "core.trustctime")) {
663 trust_ctime = git_config_bool(var, value);
666 if (!strcmp(var, "core.statinfo") ||
667 !strcmp(var, "core.checkstat")) {
669 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
670 * never been advertised. we will remove it at Git
673 if (!strcmp(var, "core.statinfo")) {
676 warning("'core.statinfo' will be removed in Git 2.0; "
677 "use 'core.checkstat' instead.");
680 if (!strcasecmp(value, "default"))
682 else if (!strcasecmp(value, "minimal"))
686 if (!strcmp(var, "core.quotepath")) {
687 quote_path_fully = git_config_bool(var, value);
691 if (!strcmp(var, "core.symlinks")) {
692 has_symlinks = git_config_bool(var, value);
696 if (!strcmp(var, "core.ignorecase")) {
697 ignore_case = git_config_bool(var, value);
701 if (!strcmp(var, "core.attributesfile"))
702 return git_config_pathname(&git_attributes_file, var, value);
704 if (!strcmp(var, "core.bare")) {
705 is_bare_repository_cfg = git_config_bool(var, value);
709 if (!strcmp(var, "core.ignorestat")) {
710 assume_unchanged = git_config_bool(var, value);
714 if (!strcmp(var, "core.prefersymlinkrefs")) {
715 prefer_symlink_refs = git_config_bool(var, value);
719 if (!strcmp(var, "core.logallrefupdates")) {
720 log_all_ref_updates = git_config_bool(var, value);
724 if (!strcmp(var, "core.warnambiguousrefs")) {
725 warn_ambiguous_refs = git_config_bool(var, value);
729 if (!strcmp(var, "core.abbrev")) {
730 int abbrev = git_config_int(var, value);
731 if (abbrev < minimum_abbrev || abbrev > 40)
733 default_abbrev = abbrev;
737 if (!strcmp(var, "core.loosecompression")) {
738 int level = git_config_int(var, value);
740 level = Z_DEFAULT_COMPRESSION;
741 else if (level < 0 || level > Z_BEST_COMPRESSION)
742 die("bad zlib compression level %d", level);
743 zlib_compression_level = level;
744 zlib_compression_seen = 1;
748 if (!strcmp(var, "core.compression")) {
749 int level = git_config_int(var, value);
751 level = Z_DEFAULT_COMPRESSION;
752 else if (level < 0 || level > Z_BEST_COMPRESSION)
753 die("bad zlib compression level %d", level);
754 core_compression_level = level;
755 core_compression_seen = 1;
756 if (!zlib_compression_seen)
757 zlib_compression_level = level;
761 if (!strcmp(var, "core.packedgitwindowsize")) {
762 int pgsz_x2 = getpagesize() * 2;
763 packed_git_window_size = git_config_ulong(var, value);
765 /* This value must be multiple of (pagesize * 2) */
766 packed_git_window_size /= pgsz_x2;
767 if (packed_git_window_size < 1)
768 packed_git_window_size = 1;
769 packed_git_window_size *= pgsz_x2;
773 if (!strcmp(var, "core.bigfilethreshold")) {
774 big_file_threshold = git_config_ulong(var, value);
778 if (!strcmp(var, "core.packedgitlimit")) {
779 packed_git_limit = git_config_ulong(var, value);
783 if (!strcmp(var, "core.deltabasecachelimit")) {
784 delta_base_cache_limit = git_config_ulong(var, value);
788 if (!strcmp(var, "core.autocrlf")) {
789 if (value && !strcasecmp(value, "input")) {
790 if (core_eol == EOL_CRLF)
791 return error("core.autocrlf=input conflicts with core.eol=crlf");
792 auto_crlf = AUTO_CRLF_INPUT;
795 auto_crlf = git_config_bool(var, value);
799 if (!strcmp(var, "core.safecrlf")) {
800 if (value && !strcasecmp(value, "warn")) {
801 safe_crlf = SAFE_CRLF_WARN;
804 safe_crlf = git_config_bool(var, value);
808 if (!strcmp(var, "core.eol")) {
809 if (value && !strcasecmp(value, "lf"))
811 else if (value && !strcasecmp(value, "crlf"))
813 else if (value && !strcasecmp(value, "native"))
814 core_eol = EOL_NATIVE;
816 core_eol = EOL_UNSET;
817 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
818 return error("core.autocrlf=input conflicts with core.eol=crlf");
822 if (!strcmp(var, "core.notesref")) {
823 notes_ref_name = xstrdup(value);
827 if (!strcmp(var, "core.pager"))
828 return git_config_string(&pager_program, var, value);
830 if (!strcmp(var, "core.editor"))
831 return git_config_string(&editor_program, var, value);
833 if (!strcmp(var, "core.commentchar")) {
835 int ret = git_config_string(&comment, var, value);
837 comment_line_char = comment[0];
841 if (!strcmp(var, "core.askpass"))
842 return git_config_string(&askpass_program, var, value);
844 if (!strcmp(var, "core.excludesfile"))
845 return git_config_pathname(&excludes_file, var, value);
847 if (!strcmp(var, "core.whitespace")) {
849 return config_error_nonbool(var);
850 whitespace_rule_cfg = parse_whitespace_rule(value);
854 if (!strcmp(var, "core.fsyncobjectfiles")) {
855 fsync_object_files = git_config_bool(var, value);
859 if (!strcmp(var, "core.preloadindex")) {
860 core_preload_index = git_config_bool(var, value);
864 if (!strcmp(var, "core.createobject")) {
865 if (!strcmp(value, "rename"))
866 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
867 else if (!strcmp(value, "link"))
868 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
870 die("Invalid mode for object creation: %s", value);
874 if (!strcmp(var, "core.sparsecheckout")) {
875 core_apply_sparse_checkout = git_config_bool(var, value);
879 if (!strcmp(var, "core.precomposeunicode")) {
880 precomposed_unicode = git_config_bool(var, value);
884 if (!strcmp(var, "core.protecthfs")) {
885 protect_hfs = git_config_bool(var, value);
889 /* Add other config variables here and to Documentation/config.txt. */
893 static int git_default_i18n_config(const char *var, const char *value)
895 if (!strcmp(var, "i18n.commitencoding"))
896 return git_config_string(&git_commit_encoding, var, value);
898 if (!strcmp(var, "i18n.logoutputencoding"))
899 return git_config_string(&git_log_output_encoding, var, value);
901 /* Add other config variables here and to Documentation/config.txt. */
905 static int git_default_branch_config(const char *var, const char *value)
907 if (!strcmp(var, "branch.autosetupmerge")) {
908 if (value && !strcasecmp(value, "always")) {
909 git_branch_track = BRANCH_TRACK_ALWAYS;
912 git_branch_track = git_config_bool(var, value);
915 if (!strcmp(var, "branch.autosetuprebase")) {
917 return config_error_nonbool(var);
918 else if (!strcmp(value, "never"))
919 autorebase = AUTOREBASE_NEVER;
920 else if (!strcmp(value, "local"))
921 autorebase = AUTOREBASE_LOCAL;
922 else if (!strcmp(value, "remote"))
923 autorebase = AUTOREBASE_REMOTE;
924 else if (!strcmp(value, "always"))
925 autorebase = AUTOREBASE_ALWAYS;
927 return error("Malformed value for %s", var);
931 /* Add other config variables here and to Documentation/config.txt. */
935 static int git_default_push_config(const char *var, const char *value)
937 if (!strcmp(var, "push.default")) {
939 return config_error_nonbool(var);
940 else if (!strcmp(value, "nothing"))
941 push_default = PUSH_DEFAULT_NOTHING;
942 else if (!strcmp(value, "matching"))
943 push_default = PUSH_DEFAULT_MATCHING;
944 else if (!strcmp(value, "simple"))
945 push_default = PUSH_DEFAULT_SIMPLE;
946 else if (!strcmp(value, "upstream"))
947 push_default = PUSH_DEFAULT_UPSTREAM;
948 else if (!strcmp(value, "tracking")) /* deprecated */
949 push_default = PUSH_DEFAULT_UPSTREAM;
950 else if (!strcmp(value, "current"))
951 push_default = PUSH_DEFAULT_CURRENT;
953 error("Malformed value for %s: %s", var, value);
954 return error("Must be one of nothing, matching, simple, "
955 "upstream or current.");
960 /* Add other config variables here and to Documentation/config.txt. */
964 static int git_default_mailmap_config(const char *var, const char *value)
966 if (!strcmp(var, "mailmap.file"))
967 return git_config_string(&git_mailmap_file, var, value);
968 if (!strcmp(var, "mailmap.blob"))
969 return git_config_string(&git_mailmap_blob, var, value);
971 /* Add other config variables here and to Documentation/config.txt. */
975 int git_default_config(const char *var, const char *value, void *dummy)
977 if (!prefixcmp(var, "core."))
978 return git_default_core_config(var, value);
980 if (!prefixcmp(var, "user."))
981 return git_ident_config(var, value, dummy);
983 if (!prefixcmp(var, "i18n."))
984 return git_default_i18n_config(var, value);
986 if (!prefixcmp(var, "branch."))
987 return git_default_branch_config(var, value);
989 if (!prefixcmp(var, "push."))
990 return git_default_push_config(var, value);
992 if (!prefixcmp(var, "mailmap."))
993 return git_default_mailmap_config(var, value);
995 if (!prefixcmp(var, "advice."))
996 return git_default_advice_config(var, value);
998 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
999 pager_use_color = git_config_bool(var,value);
1003 if (!strcmp(var, "pack.packsizelimit")) {
1004 pack_size_limit_cfg = git_config_ulong(var, value);
1007 /* Add other config variables here and to Documentation/config.txt. */
1012 * All source specific fields in the union, die_on_error, name and the callbacks
1013 * fgetc, ungetc, ftell of top need to be initialized before calling
1016 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1020 /* push config-file parsing state stack */
1024 strbuf_init(&top->value, 1024);
1025 strbuf_init(&top->var, 1024);
1028 ret = git_parse_source(fn, data);
1030 /* pop config-file parsing state stack */
1031 strbuf_release(&top->value);
1032 strbuf_release(&top->var);
1038 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1041 FILE *f = fopen(filename, "r");
1045 struct config_source top;
1048 top.name = filename;
1049 top.die_on_error = 1;
1050 top.do_fgetc = config_file_fgetc;
1051 top.do_ungetc = config_file_ungetc;
1052 top.do_ftell = config_file_ftell;
1054 ret = do_config_from(&top, fn, data);
1061 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1062 size_t len, void *data)
1064 struct config_source top;
1066 top.u.buf.buf = buf;
1067 top.u.buf.len = len;
1070 top.die_on_error = 0;
1071 top.do_fgetc = config_buf_fgetc;
1072 top.do_ungetc = config_buf_ungetc;
1073 top.do_ftell = config_buf_ftell;
1075 return do_config_from(&top, fn, data);
1078 static int git_config_from_blob_sha1(config_fn_t fn,
1080 const unsigned char *sha1,
1083 enum object_type type;
1088 buf = read_sha1_file(sha1, &type, &size);
1090 return error("unable to load config blob object '%s'", name);
1091 if (type != OBJ_BLOB) {
1093 return error("reference '%s' does not point to a blob", name);
1096 ret = git_config_from_buf(fn, name, buf, size, data);
1102 static int git_config_from_blob_ref(config_fn_t fn,
1106 unsigned char sha1[20];
1108 if (get_sha1(name, sha1) < 0)
1109 return error("unable to resolve config blob '%s'", name);
1110 return git_config_from_blob_sha1(fn, name, sha1, data);
1113 const char *git_etc_gitconfig(void)
1115 static const char *system_wide;
1117 system_wide = system_path(ETC_GITCONFIG);
1121 int git_env_bool(const char *k, int def)
1123 const char *v = getenv(k);
1124 return v ? git_config_bool(k, v) : def;
1127 int git_config_system(void)
1129 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1132 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1134 int ret = 0, found = 0;
1135 char *xdg_config = NULL;
1136 char *user_config = NULL;
1138 home_config_paths(&user_config, &xdg_config, "config");
1140 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1141 ret += git_config_from_file(fn, git_etc_gitconfig(),
1146 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1147 ret += git_config_from_file(fn, xdg_config, data);
1151 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1152 ret += git_config_from_file(fn, user_config, data);
1156 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1157 ret += git_config_from_file(fn, repo_config, data);
1161 switch (git_config_from_parameters(fn, data)) {
1162 case -1: /* error */
1163 die("unable to parse command-line config");
1165 case 0: /* found nothing */
1167 default: /* found at least one item */
1174 return ret == 0 ? found : ret;
1177 int git_config_with_options(config_fn_t fn, void *data,
1178 const char *filename,
1179 const char *blob_ref,
1180 int respect_includes)
1182 char *repo_config = NULL;
1184 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1186 if (respect_includes) {
1189 fn = git_config_include;
1194 * If we have a specific filename, use it. Otherwise, follow the
1195 * regular lookup sequence.
1198 return git_config_from_file(fn, filename, data);
1200 return git_config_from_blob_ref(fn, blob_ref, data);
1202 repo_config = git_pathdup("config");
1203 ret = git_config_early(fn, data, repo_config);
1209 int git_config(config_fn_t fn, void *data)
1211 return git_config_with_options(fn, data, NULL, NULL, 1);
1215 * Find all the stuff for git_config_set() below.
1218 #define MAX_MATCHES 512
1224 regex_t *value_regex;
1226 size_t offset[MAX_MATCHES];
1227 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1231 static int matches(const char *key, const char *value)
1233 return !strcmp(key, store.key) &&
1234 (store.value_regex == NULL ||
1235 (store.do_not_match ^
1236 !regexec(store.value_regex, value, 0, NULL, 0)));
1239 static int store_aux(const char *key, const char *value, void *cb)
1244 switch (store.state) {
1246 if (matches(key, value)) {
1247 if (store.seen == 1 && store.multi_replace == 0) {
1248 warning("%s has multiple values", key);
1249 } else if (store.seen >= MAX_MATCHES) {
1250 error("too many matches for %s", key);
1254 store.offset[store.seen] = cf->do_ftell(cf);
1260 * What we are looking for is in store.key (both
1261 * section and var), and its section part is baselen
1262 * long. We found key (again, both section and var).
1263 * We would want to know if this key is in the same
1264 * section as what we are looking for. We already
1265 * know we are in the same section as what should
1268 ep = strrchr(key, '.');
1269 section_len = ep - key;
1271 if ((section_len != store.baselen) ||
1272 memcmp(key, store.key, section_len+1)) {
1273 store.state = SECTION_END_SEEN;
1278 * Do not increment matches: this is no match, but we
1279 * just made sure we are in the desired section.
1281 store.offset[store.seen] = cf->do_ftell(cf);
1283 case SECTION_END_SEEN:
1285 if (matches(key, value)) {
1286 store.offset[store.seen] = cf->do_ftell(cf);
1287 store.state = KEY_SEEN;
1290 if (strrchr(key, '.') - key == store.baselen &&
1291 !strncmp(key, store.key, store.baselen)) {
1292 store.state = SECTION_SEEN;
1293 store.offset[store.seen] = cf->do_ftell(cf);
1300 static int write_error(const char *filename)
1302 error("failed to write new configuration file %s", filename);
1304 /* Same error code as "failed to rename". */
1308 static int store_write_section(int fd, const char *key)
1312 struct strbuf sb = STRBUF_INIT;
1314 dot = memchr(key, '.', store.baselen);
1316 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1317 for (i = dot - key + 1; i < store.baselen; i++) {
1318 if (key[i] == '"' || key[i] == '\\')
1319 strbuf_addch(&sb, '\\');
1320 strbuf_addch(&sb, key[i]);
1322 strbuf_addstr(&sb, "\"]\n");
1324 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1327 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1328 strbuf_release(&sb);
1333 static int store_write_pair(int fd, const char *key, const char *value)
1336 int length = strlen(key + store.baselen + 1);
1337 const char *quote = "";
1338 struct strbuf sb = STRBUF_INIT;
1341 * Check to see if the value needs to be surrounded with a dq pair.
1342 * Note that problematic characters are always backslash-quoted; this
1343 * check is about not losing leading or trailing SP and strings that
1344 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1345 * configuration parser.
1347 if (value[0] == ' ')
1349 for (i = 0; value[i]; i++)
1350 if (value[i] == ';' || value[i] == '#')
1352 if (i && value[i - 1] == ' ')
1355 strbuf_addf(&sb, "\t%.*s = %s",
1356 length, key + store.baselen + 1, quote);
1358 for (i = 0; value[i]; i++)
1361 strbuf_addstr(&sb, "\\n");
1364 strbuf_addstr(&sb, "\\t");
1368 strbuf_addch(&sb, '\\');
1370 strbuf_addch(&sb, value[i]);
1373 strbuf_addf(&sb, "%s\n", quote);
1375 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1376 strbuf_release(&sb);
1381 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1382 size_t offset_, int *found_bracket)
1384 size_t equal_offset = size, bracket_offset = size;
1388 for (offset = offset_-2; offset > 0
1389 && contents[offset] != '\n'; offset--)
1390 switch (contents[offset]) {
1391 case '=': equal_offset = offset; break;
1392 case ']': bracket_offset = offset; break;
1394 if (offset > 0 && contents[offset-1] == '\\') {
1398 if (bracket_offset < equal_offset) {
1400 offset = bracket_offset+1;
1407 int git_config_set_in_file(const char *config_filename,
1408 const char *key, const char *value)
1410 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1413 int git_config_set(const char *key, const char *value)
1415 return git_config_set_multivar(key, value, NULL, 0);
1419 * Auxiliary function to sanity-check and split the key into the section
1420 * identifier and variable name.
1422 * Returns 0 on success, -1 when there is an invalid character in the key and
1423 * -2 if there is no section name in the key.
1425 * store_key - pointer to char* which will hold a copy of the key with
1426 * lowercase section and variable name
1427 * baselen - pointer to int which will hold the length of the
1428 * section + subsection part, can be NULL
1430 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1432 int i, dot, baselen;
1433 const char *last_dot = strrchr(key, '.');
1436 * Since "key" actually contains the section name and the real
1437 * key name separated by a dot, we have to know where the dot is.
1440 if (last_dot == NULL || last_dot == key) {
1441 error("key does not contain a section: %s", key);
1442 return -CONFIG_NO_SECTION_OR_NAME;
1446 error("key does not contain variable name: %s", key);
1447 return -CONFIG_NO_SECTION_OR_NAME;
1450 baselen = last_dot - key;
1452 *baselen_ = baselen;
1455 * Validate the key and while at it, lower case it for matching.
1457 *store_key = xmalloc(strlen(key) + 1);
1460 for (i = 0; key[i]; i++) {
1461 unsigned char c = key[i];
1464 /* Leave the extended basename untouched.. */
1465 if (!dot || i > baselen) {
1466 if (!iskeychar(c) ||
1467 (i == baselen + 1 && !isalpha(c))) {
1468 error("invalid key: %s", key);
1469 goto out_free_ret_1;
1472 } else if (c == '\n') {
1473 error("invalid key (newline): %s", key);
1474 goto out_free_ret_1;
1476 (*store_key)[i] = c;
1478 (*store_key)[i] = 0;
1485 return -CONFIG_INVALID_KEY;
1489 * If value==NULL, unset in (remove from) config,
1490 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1491 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1492 * else all matching key/values (regardless how many) are removed,
1493 * before the new pair is written.
1495 * Returns 0 on success.
1497 * This function does this:
1499 * - it locks the config file by creating ".git/config.lock"
1501 * - it then parses the config using store_aux() as validator to find
1502 * the position on the key/value pair to replace. If it is to be unset,
1503 * it must be found exactly once.
1505 * - the config file is mmap()ed and the part before the match (if any) is
1506 * written to the lock file, then the changed part and the rest.
1508 * - the config file is removed and the lock file rename()d to it.
1511 int git_config_set_multivar_in_file(const char *config_filename,
1512 const char *key, const char *value,
1513 const char *value_regex, int multi_replace)
1517 struct lock_file *lock = NULL;
1518 char *filename_buf = NULL;
1520 /* parse-key returns negative; flip the sign to feed exit(3) */
1521 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1525 store.multi_replace = multi_replace;
1527 if (!config_filename)
1528 config_filename = filename_buf = git_pathdup("config");
1531 * The lock serves a purpose in addition to locking: the new
1532 * contents of .git/config will be written into it.
1534 lock = xcalloc(sizeof(struct lock_file), 1);
1535 fd = hold_lock_file_for_update(lock, config_filename, 0);
1537 error("could not lock config file %s: %s", config_filename, strerror(errno));
1539 ret = CONFIG_NO_LOCK;
1544 * If .git/config does not exist yet, write a minimal version.
1546 in_fd = open(config_filename, O_RDONLY);
1550 if ( ENOENT != errno ) {
1551 error("opening %s: %s", config_filename,
1553 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1556 /* if nothing to unset, error out */
1557 if (value == NULL) {
1558 ret = CONFIG_NOTHING_SET;
1562 store.key = (char *)key;
1563 if (!store_write_section(fd, key) ||
1564 !store_write_pair(fd, key, value))
1569 size_t contents_sz, copy_begin, copy_end;
1570 int i, new_line = 0;
1572 if (value_regex == NULL)
1573 store.value_regex = NULL;
1575 if (value_regex[0] == '!') {
1576 store.do_not_match = 1;
1579 store.do_not_match = 0;
1581 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1582 if (regcomp(store.value_regex, value_regex,
1584 error("invalid pattern: %s", value_regex);
1585 free(store.value_regex);
1586 ret = CONFIG_INVALID_PATTERN;
1591 store.offset[0] = 0;
1592 store.state = START;
1596 * After this, store.offset will contain the *end* offset
1597 * of the last match, or remain at 0 if no match was found.
1598 * As a side effect, we make sure to transform only a valid
1599 * existing config file.
1601 if (git_config_from_file(store_aux, config_filename, NULL)) {
1602 error("invalid config file %s", config_filename);
1604 if (store.value_regex != NULL) {
1605 regfree(store.value_regex);
1606 free(store.value_regex);
1608 ret = CONFIG_INVALID_FILE;
1613 if (store.value_regex != NULL) {
1614 regfree(store.value_regex);
1615 free(store.value_regex);
1618 /* if nothing to unset, or too many matches, error out */
1619 if ((store.seen == 0 && value == NULL) ||
1620 (store.seen > 1 && multi_replace == 0)) {
1621 ret = CONFIG_NOTHING_SET;
1626 contents_sz = xsize_t(st.st_size);
1627 contents = xmmap(NULL, contents_sz, PROT_READ,
1628 MAP_PRIVATE, in_fd, 0);
1631 if (store.seen == 0)
1634 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1635 if (store.offset[i] == 0) {
1636 store.offset[i] = copy_end = contents_sz;
1637 } else if (store.state != KEY_SEEN) {
1638 copy_end = store.offset[i];
1640 copy_end = find_beginning_of_line(
1641 contents, contents_sz,
1642 store.offset[i]-2, &new_line);
1644 if (copy_end > 0 && contents[copy_end-1] != '\n')
1647 /* write the first part of the config */
1648 if (copy_end > copy_begin) {
1649 if (write_in_full(fd, contents + copy_begin,
1650 copy_end - copy_begin) <
1651 copy_end - copy_begin)
1654 write_str_in_full(fd, "\n") != 1)
1657 copy_begin = store.offset[i];
1660 /* write the pair (value == NULL means unset) */
1661 if (value != NULL) {
1662 if (store.state == START) {
1663 if (!store_write_section(fd, key))
1666 if (!store_write_pair(fd, key, value))
1670 /* write the rest of the config */
1671 if (copy_begin < contents_sz)
1672 if (write_in_full(fd, contents + copy_begin,
1673 contents_sz - copy_begin) <
1674 contents_sz - copy_begin)
1677 munmap(contents, contents_sz);
1680 if (commit_lock_file(lock) < 0) {
1681 error("could not commit config file %s", config_filename);
1682 ret = CONFIG_NO_WRITE;
1687 * lock is committed, so don't try to roll it back below.
1688 * NOTE: Since lockfile.c keeps a linked list of all created
1689 * lock_file structures, it isn't safe to free(lock). It's
1690 * better to just leave it hanging around.
1697 rollback_lock_file(lock);
1702 ret = write_error(lock->filename);
1707 int git_config_set_multivar(const char *key, const char *value,
1708 const char *value_regex, int multi_replace)
1710 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1714 static int section_name_match (const char *buf, const char *name)
1716 int i = 0, j = 0, dot = 0;
1719 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1720 if (!dot && isspace(buf[i])) {
1722 if (name[j++] != '.')
1724 for (i++; isspace(buf[i]); i++)
1730 if (buf[i] == '\\' && dot)
1732 else if (buf[i] == '"' && dot) {
1733 for (i++; isspace(buf[i]); i++)
1737 if (buf[i] != name[j++])
1740 if (buf[i] == ']' && name[j] == 0) {
1742 * We match, now just find the right length offset by
1743 * gobbling up any whitespace after it, as well
1746 for (; buf[i] && isspace(buf[i]); i++)
1753 static int section_name_is_ok(const char *name)
1755 /* Empty section names are bogus. */
1760 * Before a dot, we must be alphanumeric or dash. After the first dot,
1761 * anything goes, so we can stop checking.
1763 for (; *name && *name != '.'; name++)
1764 if (*name != '-' && !isalnum(*name))
1769 /* if new_name == NULL, the section is removed instead */
1770 int git_config_rename_section_in_file(const char *config_filename,
1771 const char *old_name, const char *new_name)
1773 int ret = 0, remove = 0;
1774 char *filename_buf = NULL;
1775 struct lock_file *lock;
1780 if (new_name && !section_name_is_ok(new_name)) {
1781 ret = error("invalid section name: %s", new_name);
1785 if (!config_filename)
1786 config_filename = filename_buf = git_pathdup("config");
1788 lock = xcalloc(sizeof(struct lock_file), 1);
1789 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1791 ret = error("could not lock config file %s", config_filename);
1795 if (!(config_file = fopen(config_filename, "rb"))) {
1796 /* no config file means nothing to rename, no error */
1797 goto unlock_and_out;
1800 while (fgets(buf, sizeof(buf), config_file)) {
1804 for (i = 0; buf[i] && isspace(buf[i]); i++)
1806 if (buf[i] == '[') {
1807 /* it's a section */
1808 int offset = section_name_match(&buf[i], old_name);
1811 if (new_name == NULL) {
1815 store.baselen = strlen(new_name);
1816 if (!store_write_section(out_fd, new_name)) {
1817 ret = write_error(lock->filename);
1821 * We wrote out the new section, with
1822 * a newline, now skip the old
1825 output += offset + i;
1826 if (strlen(output) > 0) {
1828 * More content means there's
1829 * a declaration to put on the
1830 * next line; indent with a
1841 length = strlen(output);
1842 if (write_in_full(out_fd, output, length) != length) {
1843 ret = write_error(lock->filename);
1847 fclose(config_file);
1849 if (commit_lock_file(lock) < 0)
1850 ret = error("could not commit config file %s", config_filename);
1856 int git_config_rename_section(const char *old_name, const char *new_name)
1858 return git_config_rename_section_in_file(NULL, old_name, new_name);
1862 * Call this to report error for your variable that should not
1863 * get a boolean value (i.e. "[my] var" means "true").
1865 #undef config_error_nonbool
1866 int config_error_nonbool(const char *var)
1868 return error("Missing value for '%s'", var);
1871 int parse_config_key(const char *var,
1872 const char *section,
1873 const char **subsection, int *subsection_len,
1876 int section_len = strlen(section);
1879 /* Does it start with "section." ? */
1880 if (prefixcmp(var, section) || var[section_len] != '.')
1884 * Find the key; we don't know yet if we have a subsection, but we must
1885 * parse backwards from the end, since the subsection may have dots in
1888 dot = strrchr(var, '.');
1891 /* Did we have a subsection at all? */
1892 if (dot == var + section_len) {
1894 *subsection_len = 0;
1897 *subsection = var + section_len + 1;
1898 *subsection_len = dot - *subsection;