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;
29 int (*fgetc)(struct config_source *c);
30 int (*ungetc)(int c, struct config_source *conf);
31 long (*ftell)(struct config_source *c);
34 static struct config_source *cf;
36 static int zlib_compression_seen;
38 static int config_file_fgetc(struct config_source *conf)
40 return fgetc(conf->u.file);
43 static int config_file_ungetc(int c, struct config_source *conf)
45 return ungetc(c, conf->u.file);
48 static long config_file_ftell(struct config_source *conf)
50 return ftell(conf->u.file);
54 static int config_buf_fgetc(struct config_source *conf)
56 if (conf->u.buf.pos < conf->u.buf.len)
57 return conf->u.buf.buf[conf->u.buf.pos++];
62 static int config_buf_ungetc(int c, struct config_source *conf)
64 if (conf->u.buf.pos > 0)
65 return conf->u.buf.buf[--conf->u.buf.pos];
70 static long config_buf_ftell(struct config_source *conf)
72 return conf->u.buf.pos;
75 #define MAX_INCLUDE_DEPTH 10
76 static const char include_depth_advice[] =
77 "exceeded maximum include depth (%d) while including\n"
81 "Do you have circular includes?";
82 static int handle_path_include(const char *path, struct config_include_data *inc)
85 struct strbuf buf = STRBUF_INIT;
86 char *expanded = expand_user_path(path);
89 return error("Could not expand include path '%s'", path);
93 * Use an absolute path as-is, but interpret relative paths
94 * based on the including config file.
96 if (!is_absolute_path(path)) {
100 return error("relative config includes must come from files");
102 slash = find_last_dir_sep(cf->name);
104 strbuf_add(&buf, cf->name, slash - cf->name + 1);
105 strbuf_addstr(&buf, path);
109 if (!access_or_die(path, R_OK)) {
110 if (++inc->depth > MAX_INCLUDE_DEPTH)
111 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
112 cf && cf->name ? cf->name : "the command line");
113 ret = git_config_from_file(git_config_include, path, inc);
116 strbuf_release(&buf);
121 int git_config_include(const char *var, const char *value, void *data)
123 struct config_include_data *inc = data;
128 * Pass along all values, including "include" directives; this makes it
129 * possible to query information on the includes themselves.
131 ret = inc->fn(var, value, inc->data);
135 type = skip_prefix(var, "include.");
139 if (!strcmp(type, "path"))
140 ret = handle_path_include(value, inc);
144 static void lowercase(char *p)
150 void git_config_push_parameter(const char *text)
152 struct strbuf env = STRBUF_INIT;
153 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
155 strbuf_addstr(&env, old);
156 strbuf_addch(&env, ' ');
158 sq_quote_buf(&env, text);
159 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
160 strbuf_release(&env);
163 int git_config_parse_parameter(const char *text,
164 config_fn_t fn, void *data)
166 struct strbuf **pair;
167 pair = strbuf_split_str(text, '=', 2);
169 return error("bogus config parameter: %s", text);
170 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
171 strbuf_setlen(pair[0], pair[0]->len - 1);
172 strbuf_trim(pair[0]);
174 strbuf_list_free(pair);
175 return error("bogus config parameter: %s", text);
177 lowercase(pair[0]->buf);
178 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
179 strbuf_list_free(pair);
182 strbuf_list_free(pair);
186 int git_config_from_parameters(config_fn_t fn, void *data)
188 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
190 const char **argv = NULL;
191 int nr = 0, alloc = 0;
196 /* sq_dequote will write over it */
199 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
201 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
204 for (i = 0; i < nr; i++) {
205 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
217 static int get_next_char(void)
219 int c = cf->fgetc(cf);
222 /* DOS like systems */
238 static char *parse_value(void)
240 int quote = 0, comment = 0, space = 0;
242 strbuf_reset(&cf->value);
244 int c = get_next_char();
250 return cf->value.buf;
254 if (isspace(c) && !quote) {
260 if (c == ';' || c == '#') {
265 for (; space; space--)
266 strbuf_addch(&cf->value, ' ');
281 /* Some characters escape as themselves */
284 /* Reject unknown escape sequences */
288 strbuf_addch(&cf->value, c);
295 strbuf_addch(&cf->value, c);
299 static inline int iskeychar(int c)
301 return isalnum(c) || c == '-';
304 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
309 /* Get the full name */
316 strbuf_addch(name, tolower(c));
319 while (c == ' ' || c == '\t')
326 value = parse_value();
330 return fn(name->buf, value, data);
333 static int get_extended_base_var(struct strbuf *name, int c)
337 goto error_incomplete_line;
339 } while (isspace(c));
341 /* We require the format to be '[base "extension"]' */
344 strbuf_addch(name, '.');
347 int c = get_next_char();
349 goto error_incomplete_line;
355 goto error_incomplete_line;
357 strbuf_addch(name, c);
361 if (get_next_char() != ']')
364 error_incomplete_line:
369 static int get_base_var(struct strbuf *name)
372 int c = get_next_char();
378 return get_extended_base_var(name, c);
379 if (!iskeychar(c) && c != '.')
381 strbuf_addch(name, tolower(c));
385 static int git_parse_source(config_fn_t fn, void *data)
389 struct strbuf *var = &cf->var;
391 /* U+FEFF Byte Order Mark in UTF8 */
392 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
393 const unsigned char *bomptr = utf8_bom;
396 int c = get_next_char();
397 if (bomptr && *bomptr) {
398 /* We are at the file beginning; skip UTF8-encoded BOM
399 * if present. Sane editors won't put this in on their
400 * own, but e.g. Windows Notepad will do it happily. */
401 if ((unsigned char) c == *bomptr) {
405 /* Do not tolerate partial BOM. */
406 if (bomptr != utf8_bom)
408 /* No BOM at file beginning. Cool. */
418 if (comment || isspace(c))
420 if (c == '#' || c == ';') {
425 /* Reset prior to determining a new stem */
427 if (get_base_var(var) < 0 || var->len < 1)
429 strbuf_addch(var, '.');
436 * Truncate the var name back to the section header
437 * stem prior to grabbing the suffix part of the name
440 strbuf_setlen(var, baselen);
441 strbuf_addch(var, tolower(c));
442 if (get_value(fn, data, var) < 0)
445 die("bad config file line %d in %s", cf->linenr, cf->name);
448 static int parse_unit_factor(const char *end, uintmax_t *val)
452 else if (!strcasecmp(end, "k")) {
456 else if (!strcasecmp(end, "m")) {
460 else if (!strcasecmp(end, "g")) {
461 *val *= 1024 * 1024 * 1024;
467 static int git_parse_long(const char *value, long *ret)
469 if (value && *value) {
473 uintmax_t factor = 1;
476 val = strtoimax(value, &end, 0);
479 if (!parse_unit_factor(end, &factor))
483 if ((uval > maximum_signed_value_of_type(long)) ||
493 int git_parse_ulong(const char *value, unsigned long *ret)
495 if (value && *value) {
501 val = strtoumax(value, &end, 0);
505 if (!parse_unit_factor(end, &val))
507 if ((val > maximum_unsigned_value_of_type(long)) ||
516 static void die_bad_config(const char *name)
519 die("bad config value for '%s' in %s", name, cf->name);
520 die("bad config value for '%s'", name);
523 int git_config_int(const char *name, const char *value)
526 if (!git_parse_long(value, &ret))
527 die_bad_config(name);
531 unsigned long git_config_ulong(const char *name, const char *value)
534 if (!git_parse_ulong(value, &ret))
535 die_bad_config(name);
539 static int git_config_maybe_bool_text(const char *name, const char *value)
545 if (!strcasecmp(value, "true")
546 || !strcasecmp(value, "yes")
547 || !strcasecmp(value, "on"))
549 if (!strcasecmp(value, "false")
550 || !strcasecmp(value, "no")
551 || !strcasecmp(value, "off"))
556 int git_config_maybe_bool(const char *name, const char *value)
558 long v = git_config_maybe_bool_text(name, value);
561 if (git_parse_long(value, &v))
566 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
568 int v = git_config_maybe_bool_text(name, value);
574 return git_config_int(name, value);
577 int git_config_bool(const char *name, const char *value)
580 return !!git_config_bool_or_int(name, value, &discard);
583 int git_config_string(const char **dest, const char *var, const char *value)
586 return config_error_nonbool(var);
587 *dest = xstrdup(value);
591 int git_config_pathname(const char **dest, const char *var, const char *value)
594 return config_error_nonbool(var);
595 *dest = expand_user_path(value);
597 die("Failed to expand user dir in: '%s'", value);
601 static int git_default_core_config(const char *var, const char *value)
603 /* This needs a better name */
604 if (!strcmp(var, "core.filemode")) {
605 trust_executable_bit = git_config_bool(var, value);
608 if (!strcmp(var, "core.trustctime")) {
609 trust_ctime = git_config_bool(var, value);
612 if (!strcmp(var, "core.statinfo")) {
613 if (!strcasecmp(value, "default"))
615 else if (!strcasecmp(value, "minimal"))
619 if (!strcmp(var, "core.quotepath")) {
620 quote_path_fully = git_config_bool(var, value);
624 if (!strcmp(var, "core.symlinks")) {
625 has_symlinks = git_config_bool(var, value);
629 if (!strcmp(var, "core.ignorecase")) {
630 ignore_case = git_config_bool(var, value);
634 if (!strcmp(var, "core.attributesfile"))
635 return git_config_pathname(&git_attributes_file, var, value);
637 if (!strcmp(var, "core.bare")) {
638 is_bare_repository_cfg = git_config_bool(var, value);
642 if (!strcmp(var, "core.ignorestat")) {
643 assume_unchanged = git_config_bool(var, value);
647 if (!strcmp(var, "core.prefersymlinkrefs")) {
648 prefer_symlink_refs = git_config_bool(var, value);
652 if (!strcmp(var, "core.logallrefupdates")) {
653 log_all_ref_updates = git_config_bool(var, value);
657 if (!strcmp(var, "core.warnambiguousrefs")) {
658 warn_ambiguous_refs = git_config_bool(var, value);
662 if (!strcmp(var, "core.abbrev")) {
663 int abbrev = git_config_int(var, value);
664 if (abbrev < minimum_abbrev || abbrev > 40)
666 default_abbrev = abbrev;
670 if (!strcmp(var, "core.loosecompression")) {
671 int level = git_config_int(var, value);
673 level = Z_DEFAULT_COMPRESSION;
674 else if (level < 0 || level > Z_BEST_COMPRESSION)
675 die("bad zlib compression level %d", level);
676 zlib_compression_level = level;
677 zlib_compression_seen = 1;
681 if (!strcmp(var, "core.compression")) {
682 int level = git_config_int(var, value);
684 level = Z_DEFAULT_COMPRESSION;
685 else if (level < 0 || level > Z_BEST_COMPRESSION)
686 die("bad zlib compression level %d", level);
687 core_compression_level = level;
688 core_compression_seen = 1;
689 if (!zlib_compression_seen)
690 zlib_compression_level = level;
694 if (!strcmp(var, "core.packedgitwindowsize")) {
695 int pgsz_x2 = getpagesize() * 2;
696 packed_git_window_size = git_config_ulong(var, value);
698 /* This value must be multiple of (pagesize * 2) */
699 packed_git_window_size /= pgsz_x2;
700 if (packed_git_window_size < 1)
701 packed_git_window_size = 1;
702 packed_git_window_size *= pgsz_x2;
706 if (!strcmp(var, "core.bigfilethreshold")) {
707 big_file_threshold = git_config_ulong(var, value);
711 if (!strcmp(var, "core.packedgitlimit")) {
712 packed_git_limit = git_config_ulong(var, value);
716 if (!strcmp(var, "core.deltabasecachelimit")) {
717 delta_base_cache_limit = git_config_ulong(var, value);
721 if (!strcmp(var, "core.logpackaccess"))
722 return git_config_string(&log_pack_access, var, value);
724 if (!strcmp(var, "core.autocrlf")) {
725 if (value && !strcasecmp(value, "input")) {
726 if (core_eol == EOL_CRLF)
727 return error("core.autocrlf=input conflicts with core.eol=crlf");
728 auto_crlf = AUTO_CRLF_INPUT;
731 auto_crlf = git_config_bool(var, value);
735 if (!strcmp(var, "core.safecrlf")) {
736 if (value && !strcasecmp(value, "warn")) {
737 safe_crlf = SAFE_CRLF_WARN;
740 safe_crlf = git_config_bool(var, value);
744 if (!strcmp(var, "core.eol")) {
745 if (value && !strcasecmp(value, "lf"))
747 else if (value && !strcasecmp(value, "crlf"))
749 else if (value && !strcasecmp(value, "native"))
750 core_eol = EOL_NATIVE;
752 core_eol = EOL_UNSET;
753 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
754 return error("core.autocrlf=input conflicts with core.eol=crlf");
758 if (!strcmp(var, "core.notesref")) {
759 notes_ref_name = xstrdup(value);
763 if (!strcmp(var, "core.pager"))
764 return git_config_string(&pager_program, var, value);
766 if (!strcmp(var, "core.editor"))
767 return git_config_string(&editor_program, var, value);
769 if (!strcmp(var, "core.commentchar")) {
771 int ret = git_config_string(&comment, var, value);
773 comment_line_char = comment[0];
777 if (!strcmp(var, "core.askpass"))
778 return git_config_string(&askpass_program, var, value);
780 if (!strcmp(var, "core.excludesfile"))
781 return git_config_pathname(&excludes_file, var, value);
783 if (!strcmp(var, "core.whitespace")) {
785 return config_error_nonbool(var);
786 whitespace_rule_cfg = parse_whitespace_rule(value);
790 if (!strcmp(var, "core.fsyncobjectfiles")) {
791 fsync_object_files = git_config_bool(var, value);
795 if (!strcmp(var, "core.preloadindex")) {
796 core_preload_index = git_config_bool(var, value);
800 if (!strcmp(var, "core.createobject")) {
801 if (!strcmp(value, "rename"))
802 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
803 else if (!strcmp(value, "link"))
804 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
806 die("Invalid mode for object creation: %s", value);
810 if (!strcmp(var, "core.sparsecheckout")) {
811 core_apply_sparse_checkout = git_config_bool(var, value);
815 if (!strcmp(var, "core.precomposeunicode")) {
816 precomposed_unicode = git_config_bool(var, value);
820 /* Add other config variables here and to Documentation/config.txt. */
824 static int git_default_i18n_config(const char *var, const char *value)
826 if (!strcmp(var, "i18n.commitencoding"))
827 return git_config_string(&git_commit_encoding, var, value);
829 if (!strcmp(var, "i18n.logoutputencoding"))
830 return git_config_string(&git_log_output_encoding, var, value);
832 /* Add other config variables here and to Documentation/config.txt. */
836 static int git_default_branch_config(const char *var, const char *value)
838 if (!strcmp(var, "branch.autosetupmerge")) {
839 if (value && !strcasecmp(value, "always")) {
840 git_branch_track = BRANCH_TRACK_ALWAYS;
843 git_branch_track = git_config_bool(var, value);
846 if (!strcmp(var, "branch.autosetuprebase")) {
848 return config_error_nonbool(var);
849 else if (!strcmp(value, "never"))
850 autorebase = AUTOREBASE_NEVER;
851 else if (!strcmp(value, "local"))
852 autorebase = AUTOREBASE_LOCAL;
853 else if (!strcmp(value, "remote"))
854 autorebase = AUTOREBASE_REMOTE;
855 else if (!strcmp(value, "always"))
856 autorebase = AUTOREBASE_ALWAYS;
858 return error("Malformed value for %s", var);
862 /* Add other config variables here and to Documentation/config.txt. */
866 static int git_default_push_config(const char *var, const char *value)
868 if (!strcmp(var, "push.default")) {
870 return config_error_nonbool(var);
871 else if (!strcmp(value, "nothing"))
872 push_default = PUSH_DEFAULT_NOTHING;
873 else if (!strcmp(value, "matching"))
874 push_default = PUSH_DEFAULT_MATCHING;
875 else if (!strcmp(value, "simple"))
876 push_default = PUSH_DEFAULT_SIMPLE;
877 else if (!strcmp(value, "upstream"))
878 push_default = PUSH_DEFAULT_UPSTREAM;
879 else if (!strcmp(value, "tracking")) /* deprecated */
880 push_default = PUSH_DEFAULT_UPSTREAM;
881 else if (!strcmp(value, "current"))
882 push_default = PUSH_DEFAULT_CURRENT;
884 error("Malformed value for %s: %s", var, value);
885 return error("Must be one of nothing, matching, simple, "
886 "upstream or current.");
891 /* Add other config variables here and to Documentation/config.txt. */
895 static int git_default_mailmap_config(const char *var, const char *value)
897 if (!strcmp(var, "mailmap.file"))
898 return git_config_string(&git_mailmap_file, var, value);
899 if (!strcmp(var, "mailmap.blob"))
900 return git_config_string(&git_mailmap_blob, var, value);
902 /* Add other config variables here and to Documentation/config.txt. */
906 int git_default_config(const char *var, const char *value, void *dummy)
908 if (!prefixcmp(var, "core."))
909 return git_default_core_config(var, value);
911 if (!prefixcmp(var, "user."))
912 return git_ident_config(var, value, dummy);
914 if (!prefixcmp(var, "i18n."))
915 return git_default_i18n_config(var, value);
917 if (!prefixcmp(var, "branch."))
918 return git_default_branch_config(var, value);
920 if (!prefixcmp(var, "push."))
921 return git_default_push_config(var, value);
923 if (!prefixcmp(var, "mailmap."))
924 return git_default_mailmap_config(var, value);
926 if (!prefixcmp(var, "advice."))
927 return git_default_advice_config(var, value);
929 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
930 pager_use_color = git_config_bool(var,value);
934 if (!strcmp(var, "pack.packsizelimit")) {
935 pack_size_limit_cfg = git_config_ulong(var, value);
938 /* Add other config variables here and to Documentation/config.txt. */
943 * All source specific fields in the union, name and the callbacks
944 * fgetc, ungetc, ftell of top need to be initialized before calling
947 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
951 /* push config-file parsing state stack */
955 strbuf_init(&top->value, 1024);
956 strbuf_init(&top->var, 1024);
959 ret = git_parse_source(fn, data);
961 /* pop config-file parsing state stack */
962 strbuf_release(&top->value);
963 strbuf_release(&top->var);
969 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
972 FILE *f = fopen(filename, "r");
976 struct config_source top;
980 top.fgetc = config_file_fgetc;
981 top.ungetc = config_file_ungetc;
982 top.ftell = config_file_ftell;
984 ret = do_config_from(&top, fn, data);
991 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
992 size_t len, void *data)
994 struct config_source top;
1000 top.fgetc = config_buf_fgetc;
1001 top.ungetc = config_buf_ungetc;
1002 top.ftell = config_buf_ftell;
1004 return do_config_from(&top, fn, data);
1007 static int git_config_from_blob_sha1(config_fn_t fn,
1009 const unsigned char *sha1,
1012 enum object_type type;
1017 buf = read_sha1_file(sha1, &type, &size);
1019 return error("unable to load config blob object '%s'", name);
1020 if (type != OBJ_BLOB) {
1022 return error("reference '%s' does not point to a blob", name);
1025 ret = git_config_from_buf(fn, name, buf, size, data);
1031 static int git_config_from_blob_ref(config_fn_t fn,
1035 unsigned char sha1[20];
1037 if (get_sha1(name, sha1) < 0)
1038 return error("unable to resolve config blob '%s'", name);
1039 return git_config_from_blob_sha1(fn, name, sha1, data);
1042 const char *git_etc_gitconfig(void)
1044 static const char *system_wide;
1046 system_wide = system_path(ETC_GITCONFIG);
1050 int git_env_bool(const char *k, int def)
1052 const char *v = getenv(k);
1053 return v ? git_config_bool(k, v) : def;
1056 int git_config_system(void)
1058 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1061 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1063 int ret = 0, found = 0;
1064 char *xdg_config = NULL;
1065 char *user_config = NULL;
1067 home_config_paths(&user_config, &xdg_config, "config");
1069 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK)) {
1070 ret += git_config_from_file(fn, git_etc_gitconfig(),
1075 if (xdg_config && !access_or_die(xdg_config, R_OK)) {
1076 ret += git_config_from_file(fn, xdg_config, data);
1080 if (user_config && !access_or_die(user_config, R_OK)) {
1081 ret += git_config_from_file(fn, user_config, data);
1085 if (repo_config && !access_or_die(repo_config, R_OK)) {
1086 ret += git_config_from_file(fn, repo_config, data);
1090 switch (git_config_from_parameters(fn, data)) {
1091 case -1: /* error */
1092 die("unable to parse command-line config");
1094 case 0: /* found nothing */
1096 default: /* found at least one item */
1103 return ret == 0 ? found : ret;
1106 int git_config_with_options(config_fn_t fn, void *data,
1107 const char *filename,
1108 const char *blob_ref,
1109 int respect_includes)
1111 char *repo_config = NULL;
1113 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1115 if (respect_includes) {
1118 fn = git_config_include;
1123 * If we have a specific filename, use it. Otherwise, follow the
1124 * regular lookup sequence.
1127 return git_config_from_file(fn, filename, data);
1129 return git_config_from_blob_ref(fn, blob_ref, data);
1131 repo_config = git_pathdup("config");
1132 ret = git_config_early(fn, data, repo_config);
1138 int git_config(config_fn_t fn, void *data)
1140 return git_config_with_options(fn, data, NULL, NULL, 1);
1144 * Find all the stuff for git_config_set() below.
1147 #define MAX_MATCHES 512
1153 regex_t *value_regex;
1155 size_t offset[MAX_MATCHES];
1156 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1160 static int matches(const char *key, const char *value)
1162 return !strcmp(key, store.key) &&
1163 (store.value_regex == NULL ||
1164 (store.do_not_match ^
1165 !regexec(store.value_regex, value, 0, NULL, 0)));
1168 static int store_aux(const char *key, const char *value, void *cb)
1173 switch (store.state) {
1175 if (matches(key, value)) {
1176 if (store.seen == 1 && store.multi_replace == 0) {
1177 warning("%s has multiple values", key);
1178 } else if (store.seen >= MAX_MATCHES) {
1179 error("too many matches for %s", key);
1183 store.offset[store.seen] = cf->ftell(cf);
1189 * What we are looking for is in store.key (both
1190 * section and var), and its section part is baselen
1191 * long. We found key (again, both section and var).
1192 * We would want to know if this key is in the same
1193 * section as what we are looking for. We already
1194 * know we are in the same section as what should
1197 ep = strrchr(key, '.');
1198 section_len = ep - key;
1200 if ((section_len != store.baselen) ||
1201 memcmp(key, store.key, section_len+1)) {
1202 store.state = SECTION_END_SEEN;
1207 * Do not increment matches: this is no match, but we
1208 * just made sure we are in the desired section.
1210 store.offset[store.seen] = cf->ftell(cf);
1212 case SECTION_END_SEEN:
1214 if (matches(key, value)) {
1215 store.offset[store.seen] = cf->ftell(cf);
1216 store.state = KEY_SEEN;
1219 if (strrchr(key, '.') - key == store.baselen &&
1220 !strncmp(key, store.key, store.baselen)) {
1221 store.state = SECTION_SEEN;
1222 store.offset[store.seen] = cf->ftell(cf);
1229 static int write_error(const char *filename)
1231 error("failed to write new configuration file %s", filename);
1233 /* Same error code as "failed to rename". */
1237 static int store_write_section(int fd, const char *key)
1241 struct strbuf sb = STRBUF_INIT;
1243 dot = memchr(key, '.', store.baselen);
1245 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1246 for (i = dot - key + 1; i < store.baselen; i++) {
1247 if (key[i] == '"' || key[i] == '\\')
1248 strbuf_addch(&sb, '\\');
1249 strbuf_addch(&sb, key[i]);
1251 strbuf_addstr(&sb, "\"]\n");
1253 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1256 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1257 strbuf_release(&sb);
1262 static int store_write_pair(int fd, const char *key, const char *value)
1265 int length = strlen(key + store.baselen + 1);
1266 const char *quote = "";
1267 struct strbuf sb = STRBUF_INIT;
1270 * Check to see if the value needs to be surrounded with a dq pair.
1271 * Note that problematic characters are always backslash-quoted; this
1272 * check is about not losing leading or trailing SP and strings that
1273 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1274 * configuration parser.
1276 if (value[0] == ' ')
1278 for (i = 0; value[i]; i++)
1279 if (value[i] == ';' || value[i] == '#')
1281 if (i && value[i - 1] == ' ')
1284 strbuf_addf(&sb, "\t%.*s = %s",
1285 length, key + store.baselen + 1, quote);
1287 for (i = 0; value[i]; i++)
1290 strbuf_addstr(&sb, "\\n");
1293 strbuf_addstr(&sb, "\\t");
1297 strbuf_addch(&sb, '\\');
1299 strbuf_addch(&sb, value[i]);
1302 strbuf_addf(&sb, "%s\n", quote);
1304 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1305 strbuf_release(&sb);
1310 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1311 size_t offset_, int *found_bracket)
1313 size_t equal_offset = size, bracket_offset = size;
1317 for (offset = offset_-2; offset > 0
1318 && contents[offset] != '\n'; offset--)
1319 switch (contents[offset]) {
1320 case '=': equal_offset = offset; break;
1321 case ']': bracket_offset = offset; break;
1323 if (offset > 0 && contents[offset-1] == '\\') {
1327 if (bracket_offset < equal_offset) {
1329 offset = bracket_offset+1;
1336 int git_config_set_in_file(const char *config_filename,
1337 const char *key, const char *value)
1339 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1342 int git_config_set(const char *key, const char *value)
1344 return git_config_set_multivar(key, value, NULL, 0);
1348 * Auxiliary function to sanity-check and split the key into the section
1349 * identifier and variable name.
1351 * Returns 0 on success, -1 when there is an invalid character in the key and
1352 * -2 if there is no section name in the key.
1354 * store_key - pointer to char* which will hold a copy of the key with
1355 * lowercase section and variable name
1356 * baselen - pointer to int which will hold the length of the
1357 * section + subsection part, can be NULL
1359 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1361 int i, dot, baselen;
1362 const char *last_dot = strrchr(key, '.');
1365 * Since "key" actually contains the section name and the real
1366 * key name separated by a dot, we have to know where the dot is.
1369 if (last_dot == NULL || last_dot == key) {
1370 error("key does not contain a section: %s", key);
1371 return -CONFIG_NO_SECTION_OR_NAME;
1375 error("key does not contain variable name: %s", key);
1376 return -CONFIG_NO_SECTION_OR_NAME;
1379 baselen = last_dot - key;
1381 *baselen_ = baselen;
1384 * Validate the key and while at it, lower case it for matching.
1386 *store_key = xmalloc(strlen(key) + 1);
1389 for (i = 0; key[i]; i++) {
1390 unsigned char c = key[i];
1393 /* Leave the extended basename untouched.. */
1394 if (!dot || i > baselen) {
1395 if (!iskeychar(c) ||
1396 (i == baselen + 1 && !isalpha(c))) {
1397 error("invalid key: %s", key);
1398 goto out_free_ret_1;
1401 } else if (c == '\n') {
1402 error("invalid key (newline): %s", key);
1403 goto out_free_ret_1;
1405 (*store_key)[i] = c;
1407 (*store_key)[i] = 0;
1414 return -CONFIG_INVALID_KEY;
1418 * If value==NULL, unset in (remove from) config,
1419 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1420 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1421 * else all matching key/values (regardless how many) are removed,
1422 * before the new pair is written.
1424 * Returns 0 on success.
1426 * This function does this:
1428 * - it locks the config file by creating ".git/config.lock"
1430 * - it then parses the config using store_aux() as validator to find
1431 * the position on the key/value pair to replace. If it is to be unset,
1432 * it must be found exactly once.
1434 * - the config file is mmap()ed and the part before the match (if any) is
1435 * written to the lock file, then the changed part and the rest.
1437 * - the config file is removed and the lock file rename()d to it.
1440 int git_config_set_multivar_in_file(const char *config_filename,
1441 const char *key, const char *value,
1442 const char *value_regex, int multi_replace)
1446 struct lock_file *lock = NULL;
1447 char *filename_buf = NULL;
1449 /* parse-key returns negative; flip the sign to feed exit(3) */
1450 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1454 store.multi_replace = multi_replace;
1456 if (!config_filename)
1457 config_filename = filename_buf = git_pathdup("config");
1460 * The lock serves a purpose in addition to locking: the new
1461 * contents of .git/config will be written into it.
1463 lock = xcalloc(sizeof(struct lock_file), 1);
1464 fd = hold_lock_file_for_update(lock, config_filename, 0);
1466 error("could not lock config file %s: %s", config_filename, strerror(errno));
1468 ret = CONFIG_NO_LOCK;
1473 * If .git/config does not exist yet, write a minimal version.
1475 in_fd = open(config_filename, O_RDONLY);
1479 if ( ENOENT != errno ) {
1480 error("opening %s: %s", config_filename,
1482 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1485 /* if nothing to unset, error out */
1486 if (value == NULL) {
1487 ret = CONFIG_NOTHING_SET;
1491 store.key = (char *)key;
1492 if (!store_write_section(fd, key) ||
1493 !store_write_pair(fd, key, value))
1498 size_t contents_sz, copy_begin, copy_end;
1499 int i, new_line = 0;
1501 if (value_regex == NULL)
1502 store.value_regex = NULL;
1504 if (value_regex[0] == '!') {
1505 store.do_not_match = 1;
1508 store.do_not_match = 0;
1510 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1511 if (regcomp(store.value_regex, value_regex,
1513 error("invalid pattern: %s", value_regex);
1514 free(store.value_regex);
1515 ret = CONFIG_INVALID_PATTERN;
1520 store.offset[0] = 0;
1521 store.state = START;
1525 * After this, store.offset will contain the *end* offset
1526 * of the last match, or remain at 0 if no match was found.
1527 * As a side effect, we make sure to transform only a valid
1528 * existing config file.
1530 if (git_config_from_file(store_aux, config_filename, NULL)) {
1531 error("invalid config file %s", config_filename);
1533 if (store.value_regex != NULL) {
1534 regfree(store.value_regex);
1535 free(store.value_regex);
1537 ret = CONFIG_INVALID_FILE;
1542 if (store.value_regex != NULL) {
1543 regfree(store.value_regex);
1544 free(store.value_regex);
1547 /* if nothing to unset, or too many matches, error out */
1548 if ((store.seen == 0 && value == NULL) ||
1549 (store.seen > 1 && multi_replace == 0)) {
1550 ret = CONFIG_NOTHING_SET;
1555 contents_sz = xsize_t(st.st_size);
1556 contents = xmmap(NULL, contents_sz, PROT_READ,
1557 MAP_PRIVATE, in_fd, 0);
1560 if (store.seen == 0)
1563 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1564 if (store.offset[i] == 0) {
1565 store.offset[i] = copy_end = contents_sz;
1566 } else if (store.state != KEY_SEEN) {
1567 copy_end = store.offset[i];
1569 copy_end = find_beginning_of_line(
1570 contents, contents_sz,
1571 store.offset[i]-2, &new_line);
1573 if (copy_end > 0 && contents[copy_end-1] != '\n')
1576 /* write the first part of the config */
1577 if (copy_end > copy_begin) {
1578 if (write_in_full(fd, contents + copy_begin,
1579 copy_end - copy_begin) <
1580 copy_end - copy_begin)
1583 write_str_in_full(fd, "\n") != 1)
1586 copy_begin = store.offset[i];
1589 /* write the pair (value == NULL means unset) */
1590 if (value != NULL) {
1591 if (store.state == START) {
1592 if (!store_write_section(fd, key))
1595 if (!store_write_pair(fd, key, value))
1599 /* write the rest of the config */
1600 if (copy_begin < contents_sz)
1601 if (write_in_full(fd, contents + copy_begin,
1602 contents_sz - copy_begin) <
1603 contents_sz - copy_begin)
1606 munmap(contents, contents_sz);
1609 if (commit_lock_file(lock) < 0) {
1610 error("could not commit config file %s", config_filename);
1611 ret = CONFIG_NO_WRITE;
1616 * lock is committed, so don't try to roll it back below.
1617 * NOTE: Since lockfile.c keeps a linked list of all created
1618 * lock_file structures, it isn't safe to free(lock). It's
1619 * better to just leave it hanging around.
1626 rollback_lock_file(lock);
1631 ret = write_error(lock->filename);
1636 int git_config_set_multivar(const char *key, const char *value,
1637 const char *value_regex, int multi_replace)
1639 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1643 static int section_name_match (const char *buf, const char *name)
1645 int i = 0, j = 0, dot = 0;
1648 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1649 if (!dot && isspace(buf[i])) {
1651 if (name[j++] != '.')
1653 for (i++; isspace(buf[i]); i++)
1659 if (buf[i] == '\\' && dot)
1661 else if (buf[i] == '"' && dot) {
1662 for (i++; isspace(buf[i]); i++)
1666 if (buf[i] != name[j++])
1669 if (buf[i] == ']' && name[j] == 0) {
1671 * We match, now just find the right length offset by
1672 * gobbling up any whitespace after it, as well
1675 for (; buf[i] && isspace(buf[i]); i++)
1682 static int section_name_is_ok(const char *name)
1684 /* Empty section names are bogus. */
1689 * Before a dot, we must be alphanumeric or dash. After the first dot,
1690 * anything goes, so we can stop checking.
1692 for (; *name && *name != '.'; name++)
1693 if (*name != '-' && !isalnum(*name))
1698 /* if new_name == NULL, the section is removed instead */
1699 int git_config_rename_section_in_file(const char *config_filename,
1700 const char *old_name, const char *new_name)
1702 int ret = 0, remove = 0;
1703 char *filename_buf = NULL;
1704 struct lock_file *lock;
1709 if (new_name && !section_name_is_ok(new_name)) {
1710 ret = error("invalid section name: %s", new_name);
1714 if (!config_filename)
1715 config_filename = filename_buf = git_pathdup("config");
1717 lock = xcalloc(sizeof(struct lock_file), 1);
1718 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1720 ret = error("could not lock config file %s", config_filename);
1724 if (!(config_file = fopen(config_filename, "rb"))) {
1725 /* no config file means nothing to rename, no error */
1726 goto unlock_and_out;
1729 while (fgets(buf, sizeof(buf), config_file)) {
1733 for (i = 0; buf[i] && isspace(buf[i]); i++)
1735 if (buf[i] == '[') {
1736 /* it's a section */
1737 int offset = section_name_match(&buf[i], old_name);
1740 if (new_name == NULL) {
1744 store.baselen = strlen(new_name);
1745 if (!store_write_section(out_fd, new_name)) {
1746 ret = write_error(lock->filename);
1750 * We wrote out the new section, with
1751 * a newline, now skip the old
1754 output += offset + i;
1755 if (strlen(output) > 0) {
1757 * More content means there's
1758 * a declaration to put on the
1759 * next line; indent with a
1770 length = strlen(output);
1771 if (write_in_full(out_fd, output, length) != length) {
1772 ret = write_error(lock->filename);
1776 fclose(config_file);
1778 if (commit_lock_file(lock) < 0)
1779 ret = error("could not commit config file %s", config_filename);
1785 int git_config_rename_section(const char *old_name, const char *new_name)
1787 return git_config_rename_section_in_file(NULL, old_name, new_name);
1791 * Call this to report error for your variable that should not
1792 * get a boolean value (i.e. "[my] var" means "true").
1794 #undef config_error_nonbool
1795 int config_error_nonbool(const char *var)
1797 return error("Missing value for '%s'", var);
1800 int parse_config_key(const char *var,
1801 const char *section,
1802 const char **subsection, int *subsection_len,
1805 int section_len = strlen(section);
1808 /* Does it start with "section." ? */
1809 if (prefixcmp(var, section) || var[section_len] != '.')
1813 * Find the key; we don't know yet if we have a subsection, but we must
1814 * parse backwards from the end, since the subsection may have dots in
1817 dot = strrchr(var, '.');
1820 /* Did we have a subsection at all? */
1821 if (dot == var + section_len) {
1823 *subsection_len = 0;
1826 *subsection = var + section_len + 1;
1827 *subsection_len = dot - *subsection;