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_long(const char *value, long *ret)
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 > maximum_signed_value_of_type(long)) ||
497 int git_parse_ulong(const char *value, unsigned long *ret)
499 if (value && *value) {
505 val = strtoumax(value, &end, 0);
509 if (!parse_unit_factor(end, &val))
511 if ((val > maximum_unsigned_value_of_type(long)) ||
520 static void die_bad_config(const char *name)
523 die("bad config value for '%s' in %s", name, cf->name);
524 die("bad config value for '%s'", name);
527 int git_config_int(const char *name, const char *value)
530 if (!git_parse_long(value, &ret))
531 die_bad_config(name);
535 unsigned long git_config_ulong(const char *name, const char *value)
538 if (!git_parse_ulong(value, &ret))
539 die_bad_config(name);
543 static int git_config_maybe_bool_text(const char *name, const char *value)
549 if (!strcasecmp(value, "true")
550 || !strcasecmp(value, "yes")
551 || !strcasecmp(value, "on"))
553 if (!strcasecmp(value, "false")
554 || !strcasecmp(value, "no")
555 || !strcasecmp(value, "off"))
560 int git_config_maybe_bool(const char *name, const char *value)
562 long v = git_config_maybe_bool_text(name, value);
565 if (git_parse_long(value, &v))
570 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
572 int v = git_config_maybe_bool_text(name, value);
578 return git_config_int(name, value);
581 int git_config_bool(const char *name, const char *value)
584 return !!git_config_bool_or_int(name, value, &discard);
587 int git_config_string(const char **dest, const char *var, const char *value)
590 return config_error_nonbool(var);
591 *dest = xstrdup(value);
595 int git_config_pathname(const char **dest, const char *var, const char *value)
598 return config_error_nonbool(var);
599 *dest = expand_user_path(value);
601 die("Failed to expand user dir in: '%s'", value);
605 static int git_default_core_config(const char *var, const char *value)
607 /* This needs a better name */
608 if (!strcmp(var, "core.filemode")) {
609 trust_executable_bit = git_config_bool(var, value);
612 if (!strcmp(var, "core.trustctime")) {
613 trust_ctime = git_config_bool(var, value);
616 if (!strcmp(var, "core.statinfo") ||
617 !strcmp(var, "core.checkstat")) {
619 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
620 * never been advertised. we will remove it at Git
623 if (!strcmp(var, "core.statinfo")) {
626 warning("'core.statinfo' will be removed in Git 2.0; "
627 "use 'core.checkstat' instead.");
630 if (!strcasecmp(value, "default"))
632 else if (!strcasecmp(value, "minimal"))
636 if (!strcmp(var, "core.quotepath")) {
637 quote_path_fully = git_config_bool(var, value);
641 if (!strcmp(var, "core.symlinks")) {
642 has_symlinks = git_config_bool(var, value);
646 if (!strcmp(var, "core.ignorecase")) {
647 ignore_case = git_config_bool(var, value);
651 if (!strcmp(var, "core.attributesfile"))
652 return git_config_pathname(&git_attributes_file, var, value);
654 if (!strcmp(var, "core.bare")) {
655 is_bare_repository_cfg = git_config_bool(var, value);
659 if (!strcmp(var, "core.ignorestat")) {
660 assume_unchanged = git_config_bool(var, value);
664 if (!strcmp(var, "core.prefersymlinkrefs")) {
665 prefer_symlink_refs = git_config_bool(var, value);
669 if (!strcmp(var, "core.logallrefupdates")) {
670 log_all_ref_updates = git_config_bool(var, value);
674 if (!strcmp(var, "core.warnambiguousrefs")) {
675 warn_ambiguous_refs = git_config_bool(var, value);
679 if (!strcmp(var, "core.abbrev")) {
680 int abbrev = git_config_int(var, value);
681 if (abbrev < minimum_abbrev || abbrev > 40)
683 default_abbrev = abbrev;
687 if (!strcmp(var, "core.loosecompression")) {
688 int level = git_config_int(var, value);
690 level = Z_DEFAULT_COMPRESSION;
691 else if (level < 0 || level > Z_BEST_COMPRESSION)
692 die("bad zlib compression level %d", level);
693 zlib_compression_level = level;
694 zlib_compression_seen = 1;
698 if (!strcmp(var, "core.compression")) {
699 int level = git_config_int(var, value);
701 level = Z_DEFAULT_COMPRESSION;
702 else if (level < 0 || level > Z_BEST_COMPRESSION)
703 die("bad zlib compression level %d", level);
704 core_compression_level = level;
705 core_compression_seen = 1;
706 if (!zlib_compression_seen)
707 zlib_compression_level = level;
711 if (!strcmp(var, "core.packedgitwindowsize")) {
712 int pgsz_x2 = getpagesize() * 2;
713 packed_git_window_size = git_config_ulong(var, value);
715 /* This value must be multiple of (pagesize * 2) */
716 packed_git_window_size /= pgsz_x2;
717 if (packed_git_window_size < 1)
718 packed_git_window_size = 1;
719 packed_git_window_size *= pgsz_x2;
723 if (!strcmp(var, "core.bigfilethreshold")) {
724 big_file_threshold = git_config_ulong(var, value);
728 if (!strcmp(var, "core.packedgitlimit")) {
729 packed_git_limit = git_config_ulong(var, value);
733 if (!strcmp(var, "core.deltabasecachelimit")) {
734 delta_base_cache_limit = git_config_ulong(var, value);
738 if (!strcmp(var, "core.autocrlf")) {
739 if (value && !strcasecmp(value, "input")) {
740 if (core_eol == EOL_CRLF)
741 return error("core.autocrlf=input conflicts with core.eol=crlf");
742 auto_crlf = AUTO_CRLF_INPUT;
745 auto_crlf = git_config_bool(var, value);
749 if (!strcmp(var, "core.safecrlf")) {
750 if (value && !strcasecmp(value, "warn")) {
751 safe_crlf = SAFE_CRLF_WARN;
754 safe_crlf = git_config_bool(var, value);
758 if (!strcmp(var, "core.eol")) {
759 if (value && !strcasecmp(value, "lf"))
761 else if (value && !strcasecmp(value, "crlf"))
763 else if (value && !strcasecmp(value, "native"))
764 core_eol = EOL_NATIVE;
766 core_eol = EOL_UNSET;
767 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
768 return error("core.autocrlf=input conflicts with core.eol=crlf");
772 if (!strcmp(var, "core.notesref")) {
773 notes_ref_name = xstrdup(value);
777 if (!strcmp(var, "core.pager"))
778 return git_config_string(&pager_program, var, value);
780 if (!strcmp(var, "core.editor"))
781 return git_config_string(&editor_program, var, value);
783 if (!strcmp(var, "core.commentchar")) {
785 int ret = git_config_string(&comment, var, value);
787 comment_line_char = comment[0];
791 if (!strcmp(var, "core.askpass"))
792 return git_config_string(&askpass_program, var, value);
794 if (!strcmp(var, "core.excludesfile"))
795 return git_config_pathname(&excludes_file, var, value);
797 if (!strcmp(var, "core.whitespace")) {
799 return config_error_nonbool(var);
800 whitespace_rule_cfg = parse_whitespace_rule(value);
804 if (!strcmp(var, "core.fsyncobjectfiles")) {
805 fsync_object_files = git_config_bool(var, value);
809 if (!strcmp(var, "core.preloadindex")) {
810 core_preload_index = git_config_bool(var, value);
814 if (!strcmp(var, "core.createobject")) {
815 if (!strcmp(value, "rename"))
816 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
817 else if (!strcmp(value, "link"))
818 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
820 die("Invalid mode for object creation: %s", value);
824 if (!strcmp(var, "core.sparsecheckout")) {
825 core_apply_sparse_checkout = git_config_bool(var, value);
829 if (!strcmp(var, "core.precomposeunicode")) {
830 precomposed_unicode = git_config_bool(var, value);
834 /* Add other config variables here and to Documentation/config.txt. */
838 static int git_default_i18n_config(const char *var, const char *value)
840 if (!strcmp(var, "i18n.commitencoding"))
841 return git_config_string(&git_commit_encoding, var, value);
843 if (!strcmp(var, "i18n.logoutputencoding"))
844 return git_config_string(&git_log_output_encoding, var, value);
846 /* Add other config variables here and to Documentation/config.txt. */
850 static int git_default_branch_config(const char *var, const char *value)
852 if (!strcmp(var, "branch.autosetupmerge")) {
853 if (value && !strcasecmp(value, "always")) {
854 git_branch_track = BRANCH_TRACK_ALWAYS;
857 git_branch_track = git_config_bool(var, value);
860 if (!strcmp(var, "branch.autosetuprebase")) {
862 return config_error_nonbool(var);
863 else if (!strcmp(value, "never"))
864 autorebase = AUTOREBASE_NEVER;
865 else if (!strcmp(value, "local"))
866 autorebase = AUTOREBASE_LOCAL;
867 else if (!strcmp(value, "remote"))
868 autorebase = AUTOREBASE_REMOTE;
869 else if (!strcmp(value, "always"))
870 autorebase = AUTOREBASE_ALWAYS;
872 return error("Malformed value for %s", var);
876 /* Add other config variables here and to Documentation/config.txt. */
880 static int git_default_push_config(const char *var, const char *value)
882 if (!strcmp(var, "push.default")) {
884 return config_error_nonbool(var);
885 else if (!strcmp(value, "nothing"))
886 push_default = PUSH_DEFAULT_NOTHING;
887 else if (!strcmp(value, "matching"))
888 push_default = PUSH_DEFAULT_MATCHING;
889 else if (!strcmp(value, "simple"))
890 push_default = PUSH_DEFAULT_SIMPLE;
891 else if (!strcmp(value, "upstream"))
892 push_default = PUSH_DEFAULT_UPSTREAM;
893 else if (!strcmp(value, "tracking")) /* deprecated */
894 push_default = PUSH_DEFAULT_UPSTREAM;
895 else if (!strcmp(value, "current"))
896 push_default = PUSH_DEFAULT_CURRENT;
898 error("Malformed value for %s: %s", var, value);
899 return error("Must be one of nothing, matching, simple, "
900 "upstream or current.");
905 /* Add other config variables here and to Documentation/config.txt. */
909 static int git_default_mailmap_config(const char *var, const char *value)
911 if (!strcmp(var, "mailmap.file"))
912 return git_config_string(&git_mailmap_file, var, value);
913 if (!strcmp(var, "mailmap.blob"))
914 return git_config_string(&git_mailmap_blob, var, value);
916 /* Add other config variables here and to Documentation/config.txt. */
920 int git_default_config(const char *var, const char *value, void *dummy)
922 if (!prefixcmp(var, "core."))
923 return git_default_core_config(var, value);
925 if (!prefixcmp(var, "user."))
926 return git_ident_config(var, value, dummy);
928 if (!prefixcmp(var, "i18n."))
929 return git_default_i18n_config(var, value);
931 if (!prefixcmp(var, "branch."))
932 return git_default_branch_config(var, value);
934 if (!prefixcmp(var, "push."))
935 return git_default_push_config(var, value);
937 if (!prefixcmp(var, "mailmap."))
938 return git_default_mailmap_config(var, value);
940 if (!prefixcmp(var, "advice."))
941 return git_default_advice_config(var, value);
943 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
944 pager_use_color = git_config_bool(var,value);
948 if (!strcmp(var, "pack.packsizelimit")) {
949 pack_size_limit_cfg = git_config_ulong(var, value);
952 /* Add other config variables here and to Documentation/config.txt. */
957 * All source specific fields in the union, die_on_error, name and the callbacks
958 * fgetc, ungetc, ftell of top need to be initialized before calling
961 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
965 /* push config-file parsing state stack */
969 strbuf_init(&top->value, 1024);
970 strbuf_init(&top->var, 1024);
973 ret = git_parse_source(fn, data);
975 /* pop config-file parsing state stack */
976 strbuf_release(&top->value);
977 strbuf_release(&top->var);
983 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
986 FILE *f = fopen(filename, "r");
990 struct config_source top;
994 top.die_on_error = 1;
995 top.do_fgetc = config_file_fgetc;
996 top.do_ungetc = config_file_ungetc;
997 top.do_ftell = config_file_ftell;
999 ret = do_config_from(&top, fn, data);
1006 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1007 size_t len, void *data)
1009 struct config_source top;
1011 top.u.buf.buf = buf;
1012 top.u.buf.len = len;
1015 top.die_on_error = 0;
1016 top.do_fgetc = config_buf_fgetc;
1017 top.do_ungetc = config_buf_ungetc;
1018 top.do_ftell = config_buf_ftell;
1020 return do_config_from(&top, fn, data);
1023 static int git_config_from_blob_sha1(config_fn_t fn,
1025 const unsigned char *sha1,
1028 enum object_type type;
1033 buf = read_sha1_file(sha1, &type, &size);
1035 return error("unable to load config blob object '%s'", name);
1036 if (type != OBJ_BLOB) {
1038 return error("reference '%s' does not point to a blob", name);
1041 ret = git_config_from_buf(fn, name, buf, size, data);
1047 static int git_config_from_blob_ref(config_fn_t fn,
1051 unsigned char sha1[20];
1053 if (get_sha1(name, sha1) < 0)
1054 return error("unable to resolve config blob '%s'", name);
1055 return git_config_from_blob_sha1(fn, name, sha1, data);
1058 const char *git_etc_gitconfig(void)
1060 static const char *system_wide;
1062 system_wide = system_path(ETC_GITCONFIG);
1066 int git_env_bool(const char *k, int def)
1068 const char *v = getenv(k);
1069 return v ? git_config_bool(k, v) : def;
1072 int git_config_system(void)
1074 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1077 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1079 int ret = 0, found = 0;
1080 char *xdg_config = NULL;
1081 char *user_config = NULL;
1083 home_config_paths(&user_config, &xdg_config, "config");
1085 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1086 ret += git_config_from_file(fn, git_etc_gitconfig(),
1091 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1092 ret += git_config_from_file(fn, xdg_config, data);
1096 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1097 ret += git_config_from_file(fn, user_config, data);
1101 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1102 ret += git_config_from_file(fn, repo_config, data);
1106 switch (git_config_from_parameters(fn, data)) {
1107 case -1: /* error */
1108 die("unable to parse command-line config");
1110 case 0: /* found nothing */
1112 default: /* found at least one item */
1119 return ret == 0 ? found : ret;
1122 int git_config_with_options(config_fn_t fn, void *data,
1123 const char *filename,
1124 const char *blob_ref,
1125 int respect_includes)
1127 char *repo_config = NULL;
1129 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1131 if (respect_includes) {
1134 fn = git_config_include;
1139 * If we have a specific filename, use it. Otherwise, follow the
1140 * regular lookup sequence.
1143 return git_config_from_file(fn, filename, data);
1145 return git_config_from_blob_ref(fn, blob_ref, data);
1147 repo_config = git_pathdup("config");
1148 ret = git_config_early(fn, data, repo_config);
1154 int git_config(config_fn_t fn, void *data)
1156 return git_config_with_options(fn, data, NULL, NULL, 1);
1160 * Find all the stuff for git_config_set() below.
1167 regex_t *value_regex;
1170 unsigned int offset_alloc;
1171 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1175 static int matches(const char *key, const char *value)
1177 return !strcmp(key, store.key) &&
1178 (store.value_regex == NULL ||
1179 (store.do_not_match ^
1180 !regexec(store.value_regex, value, 0, NULL, 0)));
1183 static int store_aux(const char *key, const char *value, void *cb)
1188 switch (store.state) {
1190 if (matches(key, value)) {
1191 if (store.seen == 1 && store.multi_replace == 0) {
1192 warning("%s has multiple values", key);
1195 ALLOC_GROW(store.offset, store.seen + 1,
1196 store.offset_alloc);
1198 store.offset[store.seen] = cf->do_ftell(cf);
1204 * What we are looking for is in store.key (both
1205 * section and var), and its section part is baselen
1206 * long. We found key (again, both section and var).
1207 * We would want to know if this key is in the same
1208 * section as what we are looking for. We already
1209 * know we are in the same section as what should
1212 ep = strrchr(key, '.');
1213 section_len = ep - key;
1215 if ((section_len != store.baselen) ||
1216 memcmp(key, store.key, section_len+1)) {
1217 store.state = SECTION_END_SEEN;
1222 * Do not increment matches: this is no match, but we
1223 * just made sure we are in the desired section.
1225 ALLOC_GROW(store.offset, store.seen + 1,
1226 store.offset_alloc);
1227 store.offset[store.seen] = cf->do_ftell(cf);
1229 case SECTION_END_SEEN:
1231 if (matches(key, value)) {
1232 ALLOC_GROW(store.offset, store.seen + 1,
1233 store.offset_alloc);
1234 store.offset[store.seen] = cf->do_ftell(cf);
1235 store.state = KEY_SEEN;
1238 if (strrchr(key, '.') - key == store.baselen &&
1239 !strncmp(key, store.key, store.baselen)) {
1240 store.state = SECTION_SEEN;
1241 ALLOC_GROW(store.offset,
1243 store.offset_alloc);
1244 store.offset[store.seen] = cf->do_ftell(cf);
1251 static int write_error(const char *filename)
1253 error("failed to write new configuration file %s", filename);
1255 /* Same error code as "failed to rename". */
1259 static int store_write_section(int fd, const char *key)
1263 struct strbuf sb = STRBUF_INIT;
1265 dot = memchr(key, '.', store.baselen);
1267 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1268 for (i = dot - key + 1; i < store.baselen; i++) {
1269 if (key[i] == '"' || key[i] == '\\')
1270 strbuf_addch(&sb, '\\');
1271 strbuf_addch(&sb, key[i]);
1273 strbuf_addstr(&sb, "\"]\n");
1275 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1278 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1279 strbuf_release(&sb);
1284 static int store_write_pair(int fd, const char *key, const char *value)
1287 int length = strlen(key + store.baselen + 1);
1288 const char *quote = "";
1289 struct strbuf sb = STRBUF_INIT;
1292 * Check to see if the value needs to be surrounded with a dq pair.
1293 * Note that problematic characters are always backslash-quoted; this
1294 * check is about not losing leading or trailing SP and strings that
1295 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1296 * configuration parser.
1298 if (value[0] == ' ')
1300 for (i = 0; value[i]; i++)
1301 if (value[i] == ';' || value[i] == '#')
1303 if (i && value[i - 1] == ' ')
1306 strbuf_addf(&sb, "\t%.*s = %s",
1307 length, key + store.baselen + 1, quote);
1309 for (i = 0; value[i]; i++)
1312 strbuf_addstr(&sb, "\\n");
1315 strbuf_addstr(&sb, "\\t");
1319 strbuf_addch(&sb, '\\');
1321 strbuf_addch(&sb, value[i]);
1324 strbuf_addf(&sb, "%s\n", quote);
1326 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1327 strbuf_release(&sb);
1332 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1333 size_t offset_, int *found_bracket)
1335 size_t equal_offset = size, bracket_offset = size;
1339 for (offset = offset_-2; offset > 0
1340 && contents[offset] != '\n'; offset--)
1341 switch (contents[offset]) {
1342 case '=': equal_offset = offset; break;
1343 case ']': bracket_offset = offset; break;
1345 if (offset > 0 && contents[offset-1] == '\\') {
1349 if (bracket_offset < equal_offset) {
1351 offset = bracket_offset+1;
1358 int git_config_set_in_file(const char *config_filename,
1359 const char *key, const char *value)
1361 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1364 int git_config_set(const char *key, const char *value)
1366 return git_config_set_multivar(key, value, NULL, 0);
1370 * Auxiliary function to sanity-check and split the key into the section
1371 * identifier and variable name.
1373 * Returns 0 on success, -1 when there is an invalid character in the key and
1374 * -2 if there is no section name in the key.
1376 * store_key - pointer to char* which will hold a copy of the key with
1377 * lowercase section and variable name
1378 * baselen - pointer to int which will hold the length of the
1379 * section + subsection part, can be NULL
1381 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1383 int i, dot, baselen;
1384 const char *last_dot = strrchr(key, '.');
1387 * Since "key" actually contains the section name and the real
1388 * key name separated by a dot, we have to know where the dot is.
1391 if (last_dot == NULL || last_dot == key) {
1392 error("key does not contain a section: %s", key);
1393 return -CONFIG_NO_SECTION_OR_NAME;
1397 error("key does not contain variable name: %s", key);
1398 return -CONFIG_NO_SECTION_OR_NAME;
1401 baselen = last_dot - key;
1403 *baselen_ = baselen;
1406 * Validate the key and while at it, lower case it for matching.
1408 *store_key = xmalloc(strlen(key) + 1);
1411 for (i = 0; key[i]; i++) {
1412 unsigned char c = key[i];
1415 /* Leave the extended basename untouched.. */
1416 if (!dot || i > baselen) {
1417 if (!iskeychar(c) ||
1418 (i == baselen + 1 && !isalpha(c))) {
1419 error("invalid key: %s", key);
1420 goto out_free_ret_1;
1423 } else if (c == '\n') {
1424 error("invalid key (newline): %s", key);
1425 goto out_free_ret_1;
1427 (*store_key)[i] = c;
1429 (*store_key)[i] = 0;
1436 return -CONFIG_INVALID_KEY;
1440 * If value==NULL, unset in (remove from) config,
1441 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1442 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1443 * else all matching key/values (regardless how many) are removed,
1444 * before the new pair is written.
1446 * Returns 0 on success.
1448 * This function does this:
1450 * - it locks the config file by creating ".git/config.lock"
1452 * - it then parses the config using store_aux() as validator to find
1453 * the position on the key/value pair to replace. If it is to be unset,
1454 * it must be found exactly once.
1456 * - the config file is mmap()ed and the part before the match (if any) is
1457 * written to the lock file, then the changed part and the rest.
1459 * - the config file is removed and the lock file rename()d to it.
1462 int git_config_set_multivar_in_file(const char *config_filename,
1463 const char *key, const char *value,
1464 const char *value_regex, int multi_replace)
1468 struct lock_file *lock = NULL;
1469 char *filename_buf = NULL;
1471 /* parse-key returns negative; flip the sign to feed exit(3) */
1472 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1476 store.multi_replace = multi_replace;
1478 if (!config_filename)
1479 config_filename = filename_buf = git_pathdup("config");
1482 * The lock serves a purpose in addition to locking: the new
1483 * contents of .git/config will be written into it.
1485 lock = xcalloc(sizeof(struct lock_file), 1);
1486 fd = hold_lock_file_for_update(lock, config_filename, 0);
1488 error("could not lock config file %s: %s", config_filename, strerror(errno));
1490 ret = CONFIG_NO_LOCK;
1495 * If .git/config does not exist yet, write a minimal version.
1497 in_fd = open(config_filename, O_RDONLY);
1501 if ( ENOENT != errno ) {
1502 error("opening %s: %s", config_filename,
1504 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1507 /* if nothing to unset, error out */
1508 if (value == NULL) {
1509 ret = CONFIG_NOTHING_SET;
1513 store.key = (char *)key;
1514 if (!store_write_section(fd, key) ||
1515 !store_write_pair(fd, key, value))
1520 size_t contents_sz, copy_begin, copy_end;
1521 int i, new_line = 0;
1523 if (value_regex == NULL)
1524 store.value_regex = NULL;
1526 if (value_regex[0] == '!') {
1527 store.do_not_match = 1;
1530 store.do_not_match = 0;
1532 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1533 if (regcomp(store.value_regex, value_regex,
1535 error("invalid pattern: %s", value_regex);
1536 free(store.value_regex);
1537 ret = CONFIG_INVALID_PATTERN;
1542 ALLOC_GROW(store.offset, 1, store.offset_alloc);
1543 store.offset[0] = 0;
1544 store.state = START;
1548 * After this, store.offset will contain the *end* offset
1549 * of the last match, or remain at 0 if no match was found.
1550 * As a side effect, we make sure to transform only a valid
1551 * existing config file.
1553 if (git_config_from_file(store_aux, config_filename, NULL)) {
1554 error("invalid config file %s", config_filename);
1556 if (store.value_regex != NULL) {
1557 regfree(store.value_regex);
1558 free(store.value_regex);
1560 ret = CONFIG_INVALID_FILE;
1565 if (store.value_regex != NULL) {
1566 regfree(store.value_regex);
1567 free(store.value_regex);
1570 /* if nothing to unset, or too many matches, error out */
1571 if ((store.seen == 0 && value == NULL) ||
1572 (store.seen > 1 && multi_replace == 0)) {
1573 ret = CONFIG_NOTHING_SET;
1578 contents_sz = xsize_t(st.st_size);
1579 contents = xmmap(NULL, contents_sz, PROT_READ,
1580 MAP_PRIVATE, in_fd, 0);
1583 if (store.seen == 0)
1586 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1587 if (store.offset[i] == 0) {
1588 store.offset[i] = copy_end = contents_sz;
1589 } else if (store.state != KEY_SEEN) {
1590 copy_end = store.offset[i];
1592 copy_end = find_beginning_of_line(
1593 contents, contents_sz,
1594 store.offset[i]-2, &new_line);
1596 if (copy_end > 0 && contents[copy_end-1] != '\n')
1599 /* write the first part of the config */
1600 if (copy_end > copy_begin) {
1601 if (write_in_full(fd, contents + copy_begin,
1602 copy_end - copy_begin) <
1603 copy_end - copy_begin)
1606 write_str_in_full(fd, "\n") != 1)
1609 copy_begin = store.offset[i];
1612 /* write the pair (value == NULL means unset) */
1613 if (value != NULL) {
1614 if (store.state == START) {
1615 if (!store_write_section(fd, key))
1618 if (!store_write_pair(fd, key, value))
1622 /* write the rest of the config */
1623 if (copy_begin < contents_sz)
1624 if (write_in_full(fd, contents + copy_begin,
1625 contents_sz - copy_begin) <
1626 contents_sz - copy_begin)
1629 munmap(contents, contents_sz);
1632 if (commit_lock_file(lock) < 0) {
1633 error("could not commit config file %s", config_filename);
1634 ret = CONFIG_NO_WRITE;
1639 * lock is committed, so don't try to roll it back below.
1640 * NOTE: Since lockfile.c keeps a linked list of all created
1641 * lock_file structures, it isn't safe to free(lock). It's
1642 * better to just leave it hanging around.
1649 rollback_lock_file(lock);
1654 ret = write_error(lock->filename);
1659 int git_config_set_multivar(const char *key, const char *value,
1660 const char *value_regex, int multi_replace)
1662 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1666 static int section_name_match (const char *buf, const char *name)
1668 int i = 0, j = 0, dot = 0;
1671 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1672 if (!dot && isspace(buf[i])) {
1674 if (name[j++] != '.')
1676 for (i++; isspace(buf[i]); i++)
1682 if (buf[i] == '\\' && dot)
1684 else if (buf[i] == '"' && dot) {
1685 for (i++; isspace(buf[i]); i++)
1689 if (buf[i] != name[j++])
1692 if (buf[i] == ']' && name[j] == 0) {
1694 * We match, now just find the right length offset by
1695 * gobbling up any whitespace after it, as well
1698 for (; buf[i] && isspace(buf[i]); i++)
1705 static int section_name_is_ok(const char *name)
1707 /* Empty section names are bogus. */
1712 * Before a dot, we must be alphanumeric or dash. After the first dot,
1713 * anything goes, so we can stop checking.
1715 for (; *name && *name != '.'; name++)
1716 if (*name != '-' && !isalnum(*name))
1721 /* if new_name == NULL, the section is removed instead */
1722 int git_config_rename_section_in_file(const char *config_filename,
1723 const char *old_name, const char *new_name)
1725 int ret = 0, remove = 0;
1726 char *filename_buf = NULL;
1727 struct lock_file *lock;
1732 if (new_name && !section_name_is_ok(new_name)) {
1733 ret = error("invalid section name: %s", new_name);
1737 if (!config_filename)
1738 config_filename = filename_buf = git_pathdup("config");
1740 lock = xcalloc(sizeof(struct lock_file), 1);
1741 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1743 ret = error("could not lock config file %s", config_filename);
1747 if (!(config_file = fopen(config_filename, "rb"))) {
1748 /* no config file means nothing to rename, no error */
1749 goto unlock_and_out;
1752 while (fgets(buf, sizeof(buf), config_file)) {
1756 for (i = 0; buf[i] && isspace(buf[i]); i++)
1758 if (buf[i] == '[') {
1759 /* it's a section */
1760 int offset = section_name_match(&buf[i], old_name);
1763 if (new_name == NULL) {
1767 store.baselen = strlen(new_name);
1768 if (!store_write_section(out_fd, new_name)) {
1769 ret = write_error(lock->filename);
1773 * We wrote out the new section, with
1774 * a newline, now skip the old
1777 output += offset + i;
1778 if (strlen(output) > 0) {
1780 * More content means there's
1781 * a declaration to put on the
1782 * next line; indent with a
1793 length = strlen(output);
1794 if (write_in_full(out_fd, output, length) != length) {
1795 ret = write_error(lock->filename);
1799 fclose(config_file);
1801 if (commit_lock_file(lock) < 0)
1802 ret = error("could not commit config file %s", config_filename);
1808 int git_config_rename_section(const char *old_name, const char *new_name)
1810 return git_config_rename_section_in_file(NULL, old_name, new_name);
1814 * Call this to report error for your variable that should not
1815 * get a boolean value (i.e. "[my] var" means "true").
1817 #undef config_error_nonbool
1818 int config_error_nonbool(const char *var)
1820 return error("Missing value for '%s'", var);
1823 int parse_config_key(const char *var,
1824 const char *section,
1825 const char **subsection, int *subsection_len,
1828 int section_len = strlen(section);
1831 /* Does it start with "section." ? */
1832 if (prefixcmp(var, section) || var[section_len] != '.')
1836 * Find the key; we don't know yet if we have a subsection, but we must
1837 * parse backwards from the end, since the subsection may have dots in
1840 dot = strrchr(var, '.');
1843 /* Did we have a subsection at all? */
1844 if (dot == var + section_len) {
1846 *subsection_len = 0;
1849 *subsection = var + section_len + 1;
1850 *subsection_len = dot - *subsection;