2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
15 typedef struct config_file {
16 struct config_file *prev;
25 static config_file *cf;
27 static int zlib_compression_seen;
29 #define MAX_INCLUDE_DEPTH 10
30 static const char include_depth_advice[] =
31 "exceeded maximum include depth (%d) while including\n"
35 "Do you have circular includes?";
36 static int handle_path_include(const char *path, struct config_include_data *inc)
39 struct strbuf buf = STRBUF_INIT;
42 * Use an absolute path as-is, but interpret relative paths
43 * based on the including config file.
45 if (!is_absolute_path(path)) {
49 return error("relative config includes must come from files");
51 slash = find_last_dir_sep(cf->name);
53 strbuf_add(&buf, cf->name, slash - cf->name + 1);
54 strbuf_addstr(&buf, path);
58 if (!access(path, R_OK)) {
59 if (++inc->depth > MAX_INCLUDE_DEPTH)
60 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
61 cf && cf->name ? cf->name : "the command line");
62 ret = git_config_from_file(git_config_include, path, inc);
69 int git_config_include(const char *var, const char *value, void *data)
71 struct config_include_data *inc = data;
76 * Pass along all values, including "include" directives; this makes it
77 * possible to query information on the includes themselves.
79 ret = inc->fn(var, value, inc->data);
83 type = skip_prefix(var, "include.");
87 if (!strcmp(type, "path"))
88 ret = handle_path_include(value, inc);
92 static void lowercase(char *p)
98 void git_config_push_parameter(const char *text)
100 struct strbuf env = STRBUF_INIT;
101 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
103 strbuf_addstr(&env, old);
104 strbuf_addch(&env, ' ');
106 sq_quote_buf(&env, text);
107 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
108 strbuf_release(&env);
111 int git_config_parse_parameter(const char *text,
112 config_fn_t fn, void *data)
114 struct strbuf **pair;
115 pair = strbuf_split_str(text, '=', 2);
117 return error("bogus config parameter: %s", text);
118 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
119 strbuf_setlen(pair[0], pair[0]->len - 1);
120 strbuf_trim(pair[0]);
122 strbuf_list_free(pair);
123 return error("bogus config parameter: %s", text);
125 lowercase(pair[0]->buf);
126 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
127 strbuf_list_free(pair);
130 strbuf_list_free(pair);
134 int git_config_from_parameters(config_fn_t fn, void *data)
136 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
138 const char **argv = NULL;
139 int nr = 0, alloc = 0;
144 /* sq_dequote will write over it */
147 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
149 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
152 for (i = 0; i < nr; i++) {
153 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
165 static int get_next_char(void)
171 if (cf && ((f = cf->f) != NULL)) {
174 /* DOS like systems */
191 static char *parse_value(void)
193 int quote = 0, comment = 0, space = 0;
195 strbuf_reset(&cf->value);
197 int c = get_next_char();
201 return cf->value.buf;
205 if (isspace(c) && !quote) {
211 if (c == ';' || c == '#') {
216 for (; space; space--)
217 strbuf_addch(&cf->value, ' ');
232 /* Some characters escape as themselves */
235 /* Reject unknown escape sequences */
239 strbuf_addch(&cf->value, c);
246 strbuf_addch(&cf->value, c);
250 static inline int iskeychar(int c)
252 return isalnum(c) || c == '-';
255 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
260 /* Get the full name */
267 name[len++] = tolower(c);
272 while (c == ' ' || c == '\t')
279 value = parse_value();
283 return fn(name, value, data);
286 static int get_extended_base_var(char *name, int baselen, int c)
292 } while (isspace(c));
294 /* We require the format to be '[base "extension"]' */
297 name[baselen++] = '.';
300 int c = get_next_char();
311 if (baselen > MAXNAME / 2)
316 if (get_next_char() != ']')
321 static int get_base_var(char *name)
326 int c = get_next_char();
332 return get_extended_base_var(name, baselen, c);
333 if (!iskeychar(c) && c != '.')
335 if (baselen > MAXNAME / 2)
337 name[baselen++] = tolower(c);
341 static int git_parse_file(config_fn_t fn, void *data)
347 /* U+FEFF Byte Order Mark in UTF8 */
348 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
349 const unsigned char *bomptr = utf8_bom;
352 int c = get_next_char();
353 if (bomptr && *bomptr) {
354 /* We are at the file beginning; skip UTF8-encoded BOM
355 * if present. Sane editors won't put this in on their
356 * own, but e.g. Windows Notepad will do it happily. */
357 if ((unsigned char) c == *bomptr) {
361 /* Do not tolerate partial BOM. */
362 if (bomptr != utf8_bom)
364 /* No BOM at file beginning. Cool. */
374 if (comment || isspace(c))
376 if (c == '#' || c == ';') {
381 baselen = get_base_var(var);
384 var[baselen++] = '.';
390 var[baselen] = tolower(c);
391 if (get_value(fn, data, var, baselen+1) < 0)
394 die("bad config file line %d in %s", cf->linenr, cf->name);
397 static int parse_unit_factor(const char *end, uintmax_t *val)
401 else if (!strcasecmp(end, "k")) {
405 else if (!strcasecmp(end, "m")) {
409 else if (!strcasecmp(end, "g")) {
410 *val *= 1024 * 1024 * 1024;
416 static int git_parse_long(const char *value, long *ret)
418 if (value && *value) {
422 uintmax_t factor = 1;
425 val = strtoimax(value, &end, 0);
428 if (!parse_unit_factor(end, &factor))
432 if ((uval > maximum_signed_value_of_type(long)) ||
442 int git_parse_ulong(const char *value, unsigned long *ret)
444 if (value && *value) {
450 val = strtoumax(value, &end, 0);
454 if (!parse_unit_factor(end, &val))
456 if ((val > maximum_unsigned_value_of_type(long)) ||
465 static void die_bad_config(const char *name)
468 die("bad config value for '%s' in %s", name, cf->name);
469 die("bad config value for '%s'", name);
472 int git_config_int(const char *name, const char *value)
475 if (!git_parse_long(value, &ret))
476 die_bad_config(name);
480 unsigned long git_config_ulong(const char *name, const char *value)
483 if (!git_parse_ulong(value, &ret))
484 die_bad_config(name);
488 static int git_config_maybe_bool_text(const char *name, const char *value)
494 if (!strcasecmp(value, "true")
495 || !strcasecmp(value, "yes")
496 || !strcasecmp(value, "on"))
498 if (!strcasecmp(value, "false")
499 || !strcasecmp(value, "no")
500 || !strcasecmp(value, "off"))
505 int git_config_maybe_bool(const char *name, const char *value)
507 long v = git_config_maybe_bool_text(name, value);
510 if (git_parse_long(value, &v))
515 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
517 int v = git_config_maybe_bool_text(name, value);
523 return git_config_int(name, value);
526 int git_config_bool(const char *name, const char *value)
529 return !!git_config_bool_or_int(name, value, &discard);
532 int git_config_string(const char **dest, const char *var, const char *value)
535 return config_error_nonbool(var);
536 *dest = xstrdup(value);
540 int git_config_pathname(const char **dest, const char *var, const char *value)
543 return config_error_nonbool(var);
544 *dest = expand_user_path(value);
546 die("Failed to expand user dir in: '%s'", value);
550 static int git_default_core_config(const char *var, const char *value)
552 /* This needs a better name */
553 if (!strcmp(var, "core.filemode")) {
554 trust_executable_bit = git_config_bool(var, value);
557 if (!strcmp(var, "core.trustctime")) {
558 trust_ctime = git_config_bool(var, value);
562 if (!strcmp(var, "core.quotepath")) {
563 quote_path_fully = git_config_bool(var, value);
567 if (!strcmp(var, "core.symlinks")) {
568 has_symlinks = git_config_bool(var, value);
572 if (!strcmp(var, "core.ignorecase")) {
573 ignore_case = git_config_bool(var, value);
577 if (!strcmp(var, "core.attributesfile"))
578 return git_config_pathname(&git_attributes_file, var, value);
580 if (!strcmp(var, "core.bare")) {
581 is_bare_repository_cfg = git_config_bool(var, value);
585 if (!strcmp(var, "core.ignorestat")) {
586 assume_unchanged = git_config_bool(var, value);
590 if (!strcmp(var, "core.prefersymlinkrefs")) {
591 prefer_symlink_refs = git_config_bool(var, value);
595 if (!strcmp(var, "core.logallrefupdates")) {
596 log_all_ref_updates = git_config_bool(var, value);
600 if (!strcmp(var, "core.warnambiguousrefs")) {
601 warn_ambiguous_refs = git_config_bool(var, value);
605 if (!strcmp(var, "core.abbrev")) {
606 int abbrev = git_config_int(var, value);
607 if (abbrev < minimum_abbrev || abbrev > 40)
609 default_abbrev = abbrev;
613 if (!strcmp(var, "core.loosecompression")) {
614 int level = git_config_int(var, value);
616 level = Z_DEFAULT_COMPRESSION;
617 else if (level < 0 || level > Z_BEST_COMPRESSION)
618 die("bad zlib compression level %d", level);
619 zlib_compression_level = level;
620 zlib_compression_seen = 1;
624 if (!strcmp(var, "core.compression")) {
625 int level = git_config_int(var, value);
627 level = Z_DEFAULT_COMPRESSION;
628 else if (level < 0 || level > Z_BEST_COMPRESSION)
629 die("bad zlib compression level %d", level);
630 core_compression_level = level;
631 core_compression_seen = 1;
632 if (!zlib_compression_seen)
633 zlib_compression_level = level;
637 if (!strcmp(var, "core.packedgitwindowsize")) {
638 int pgsz_x2 = getpagesize() * 2;
639 packed_git_window_size = git_config_ulong(var, value);
641 /* This value must be multiple of (pagesize * 2) */
642 packed_git_window_size /= pgsz_x2;
643 if (packed_git_window_size < 1)
644 packed_git_window_size = 1;
645 packed_git_window_size *= pgsz_x2;
649 if (!strcmp(var, "core.bigfilethreshold")) {
650 big_file_threshold = git_config_ulong(var, value);
654 if (!strcmp(var, "core.packedgitlimit")) {
655 packed_git_limit = git_config_ulong(var, value);
659 if (!strcmp(var, "core.deltabasecachelimit")) {
660 delta_base_cache_limit = git_config_ulong(var, value);
664 if (!strcmp(var, "core.logpackaccess"))
665 return git_config_string(&log_pack_access, var, value);
667 if (!strcmp(var, "core.autocrlf")) {
668 if (value && !strcasecmp(value, "input")) {
669 if (core_eol == EOL_CRLF)
670 return error("core.autocrlf=input conflicts with core.eol=crlf");
671 auto_crlf = AUTO_CRLF_INPUT;
674 auto_crlf = git_config_bool(var, value);
678 if (!strcmp(var, "core.safecrlf")) {
679 if (value && !strcasecmp(value, "warn")) {
680 safe_crlf = SAFE_CRLF_WARN;
683 safe_crlf = git_config_bool(var, value);
687 if (!strcmp(var, "core.eol")) {
688 if (value && !strcasecmp(value, "lf"))
690 else if (value && !strcasecmp(value, "crlf"))
692 else if (value && !strcasecmp(value, "native"))
693 core_eol = EOL_NATIVE;
695 core_eol = EOL_UNSET;
696 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
697 return error("core.autocrlf=input conflicts with core.eol=crlf");
701 if (!strcmp(var, "core.notesref")) {
702 notes_ref_name = xstrdup(value);
706 if (!strcmp(var, "core.pager"))
707 return git_config_string(&pager_program, var, value);
709 if (!strcmp(var, "core.editor"))
710 return git_config_string(&editor_program, var, value);
712 if (!strcmp(var, "core.askpass"))
713 return git_config_string(&askpass_program, var, value);
715 if (!strcmp(var, "core.excludesfile"))
716 return git_config_pathname(&excludes_file, var, value);
718 if (!strcmp(var, "core.whitespace")) {
720 return config_error_nonbool(var);
721 whitespace_rule_cfg = parse_whitespace_rule(value);
725 if (!strcmp(var, "core.fsyncobjectfiles")) {
726 fsync_object_files = git_config_bool(var, value);
730 if (!strcmp(var, "core.preloadindex")) {
731 core_preload_index = git_config_bool(var, value);
735 if (!strcmp(var, "core.createobject")) {
736 if (!strcmp(value, "rename"))
737 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
738 else if (!strcmp(value, "link"))
739 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
741 die("Invalid mode for object creation: %s", value);
745 if (!strcmp(var, "core.sparsecheckout")) {
746 core_apply_sparse_checkout = git_config_bool(var, value);
750 /* Add other config variables here and to Documentation/config.txt. */
754 static int git_default_user_config(const char *var, const char *value)
756 if (!strcmp(var, "user.name")) {
758 return config_error_nonbool(var);
759 strlcpy(git_default_name, value, sizeof(git_default_name));
760 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
764 if (!strcmp(var, "user.email")) {
766 return config_error_nonbool(var);
767 strlcpy(git_default_email, value, sizeof(git_default_email));
768 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
772 /* Add other config variables here and to Documentation/config.txt. */
776 static int git_default_i18n_config(const char *var, const char *value)
778 if (!strcmp(var, "i18n.commitencoding"))
779 return git_config_string(&git_commit_encoding, var, value);
781 if (!strcmp(var, "i18n.logoutputencoding"))
782 return git_config_string(&git_log_output_encoding, var, value);
784 /* Add other config variables here and to Documentation/config.txt. */
788 static int git_default_branch_config(const char *var, const char *value)
790 if (!strcmp(var, "branch.autosetupmerge")) {
791 if (value && !strcasecmp(value, "always")) {
792 git_branch_track = BRANCH_TRACK_ALWAYS;
795 git_branch_track = git_config_bool(var, value);
798 if (!strcmp(var, "branch.autosetuprebase")) {
800 return config_error_nonbool(var);
801 else if (!strcmp(value, "never"))
802 autorebase = AUTOREBASE_NEVER;
803 else if (!strcmp(value, "local"))
804 autorebase = AUTOREBASE_LOCAL;
805 else if (!strcmp(value, "remote"))
806 autorebase = AUTOREBASE_REMOTE;
807 else if (!strcmp(value, "always"))
808 autorebase = AUTOREBASE_ALWAYS;
810 return error("Malformed value for %s", var);
814 /* Add other config variables here and to Documentation/config.txt. */
818 static int git_default_push_config(const char *var, const char *value)
820 if (!strcmp(var, "push.default")) {
822 return config_error_nonbool(var);
823 else if (!strcmp(value, "nothing"))
824 push_default = PUSH_DEFAULT_NOTHING;
825 else if (!strcmp(value, "matching"))
826 push_default = PUSH_DEFAULT_MATCHING;
827 else if (!strcmp(value, "upstream"))
828 push_default = PUSH_DEFAULT_UPSTREAM;
829 else if (!strcmp(value, "tracking")) /* deprecated */
830 push_default = PUSH_DEFAULT_UPSTREAM;
831 else if (!strcmp(value, "current"))
832 push_default = PUSH_DEFAULT_CURRENT;
834 error("Malformed value for %s: %s", var, value);
835 return error("Must be one of nothing, matching, "
836 "tracking or current.");
841 /* Add other config variables here and to Documentation/config.txt. */
845 static int git_default_mailmap_config(const char *var, const char *value)
847 if (!strcmp(var, "mailmap.file"))
848 return git_config_string(&git_mailmap_file, var, value);
850 /* Add other config variables here and to Documentation/config.txt. */
854 int git_default_config(const char *var, const char *value, void *dummy)
856 if (!prefixcmp(var, "core."))
857 return git_default_core_config(var, value);
859 if (!prefixcmp(var, "user."))
860 return git_default_user_config(var, value);
862 if (!prefixcmp(var, "i18n."))
863 return git_default_i18n_config(var, value);
865 if (!prefixcmp(var, "branch."))
866 return git_default_branch_config(var, value);
868 if (!prefixcmp(var, "push."))
869 return git_default_push_config(var, value);
871 if (!prefixcmp(var, "mailmap."))
872 return git_default_mailmap_config(var, value);
874 if (!prefixcmp(var, "advice."))
875 return git_default_advice_config(var, value);
877 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
878 pager_use_color = git_config_bool(var,value);
882 if (!strcmp(var, "pack.packsizelimit")) {
883 pack_size_limit_cfg = git_config_ulong(var, value);
886 /* Add other config variables here and to Documentation/config.txt. */
890 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
893 FILE *f = fopen(filename, "r");
899 /* push config-file parsing state stack */
905 strbuf_init(&top.value, 1024);
908 ret = git_parse_file(fn, data);
910 /* pop config-file parsing state stack */
911 strbuf_release(&top.value);
919 const char *git_etc_gitconfig(void)
921 static const char *system_wide;
923 system_wide = system_path(ETC_GITCONFIG);
927 int git_env_bool(const char *k, int def)
929 const char *v = getenv(k);
930 return v ? git_config_bool(k, v) : def;
933 int git_config_system(void)
935 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
938 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
940 int ret = 0, found = 0;
941 const char *home = NULL;
943 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
944 ret += git_config_from_file(fn, git_etc_gitconfig(),
949 home = getenv("HOME");
952 char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
953 if (!access(user_config, R_OK)) {
954 ret += git_config_from_file(fn, user_config, data);
959 if (repo_config && !access(repo_config, R_OK)) {
960 ret += git_config_from_file(fn, repo_config, data);
964 switch (git_config_from_parameters(fn, data)) {
966 die("unable to parse command-line config");
968 case 0: /* found nothing */
970 default: /* found at least one item */
975 return ret == 0 ? found : ret;
978 int git_config_with_options(config_fn_t fn, void *data,
979 const char *filename, int respect_includes)
981 char *repo_config = NULL;
983 struct config_include_data inc = CONFIG_INCLUDE_INIT;
985 if (respect_includes) {
988 fn = git_config_include;
993 * If we have a specific filename, use it. Otherwise, follow the
994 * regular lookup sequence.
997 return git_config_from_file(fn, filename, data);
999 repo_config = git_pathdup("config");
1000 ret = git_config_early(fn, data, repo_config);
1006 int git_config(config_fn_t fn, void *data)
1008 return git_config_with_options(fn, data, NULL, 1);
1012 * Find all the stuff for git_config_set() below.
1015 #define MAX_MATCHES 512
1021 regex_t *value_regex;
1023 size_t offset[MAX_MATCHES];
1024 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1028 static int matches(const char *key, const char *value)
1030 return !strcmp(key, store.key) &&
1031 (store.value_regex == NULL ||
1032 (store.do_not_match ^
1033 !regexec(store.value_regex, value, 0, NULL, 0)));
1036 static int store_aux(const char *key, const char *value, void *cb)
1042 switch (store.state) {
1044 if (matches(key, value)) {
1045 if (store.seen == 1 && store.multi_replace == 0) {
1046 warning("%s has multiple values", key);
1047 } else if (store.seen >= MAX_MATCHES) {
1048 error("too many matches for %s", key);
1052 store.offset[store.seen] = ftell(f);
1058 * What we are looking for is in store.key (both
1059 * section and var), and its section part is baselen
1060 * long. We found key (again, both section and var).
1061 * We would want to know if this key is in the same
1062 * section as what we are looking for. We already
1063 * know we are in the same section as what should
1066 ep = strrchr(key, '.');
1067 section_len = ep - key;
1069 if ((section_len != store.baselen) ||
1070 memcmp(key, store.key, section_len+1)) {
1071 store.state = SECTION_END_SEEN;
1076 * Do not increment matches: this is no match, but we
1077 * just made sure we are in the desired section.
1079 store.offset[store.seen] = ftell(f);
1081 case SECTION_END_SEEN:
1083 if (matches(key, value)) {
1084 store.offset[store.seen] = ftell(f);
1085 store.state = KEY_SEEN;
1088 if (strrchr(key, '.') - key == store.baselen &&
1089 !strncmp(key, store.key, store.baselen)) {
1090 store.state = SECTION_SEEN;
1091 store.offset[store.seen] = ftell(f);
1098 static int write_error(const char *filename)
1100 error("failed to write new configuration file %s", filename);
1102 /* Same error code as "failed to rename". */
1106 static int store_write_section(int fd, const char *key)
1110 struct strbuf sb = STRBUF_INIT;
1112 dot = memchr(key, '.', store.baselen);
1114 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1115 for (i = dot - key + 1; i < store.baselen; i++) {
1116 if (key[i] == '"' || key[i] == '\\')
1117 strbuf_addch(&sb, '\\');
1118 strbuf_addch(&sb, key[i]);
1120 strbuf_addstr(&sb, "\"]\n");
1122 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1125 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1126 strbuf_release(&sb);
1131 static int store_write_pair(int fd, const char *key, const char *value)
1134 int length = strlen(key + store.baselen + 1);
1135 const char *quote = "";
1136 struct strbuf sb = STRBUF_INIT;
1139 * Check to see if the value needs to be surrounded with a dq pair.
1140 * Note that problematic characters are always backslash-quoted; this
1141 * check is about not losing leading or trailing SP and strings that
1142 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1143 * configuration parser.
1145 if (value[0] == ' ')
1147 for (i = 0; value[i]; i++)
1148 if (value[i] == ';' || value[i] == '#')
1150 if (i && value[i - 1] == ' ')
1153 strbuf_addf(&sb, "\t%.*s = %s",
1154 length, key + store.baselen + 1, quote);
1156 for (i = 0; value[i]; i++)
1159 strbuf_addstr(&sb, "\\n");
1162 strbuf_addstr(&sb, "\\t");
1166 strbuf_addch(&sb, '\\');
1168 strbuf_addch(&sb, value[i]);
1171 strbuf_addf(&sb, "%s\n", quote);
1173 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1174 strbuf_release(&sb);
1179 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1180 size_t offset_, int *found_bracket)
1182 size_t equal_offset = size, bracket_offset = size;
1186 for (offset = offset_-2; offset > 0
1187 && contents[offset] != '\n'; offset--)
1188 switch (contents[offset]) {
1189 case '=': equal_offset = offset; break;
1190 case ']': bracket_offset = offset; break;
1192 if (offset > 0 && contents[offset-1] == '\\') {
1196 if (bracket_offset < equal_offset) {
1198 offset = bracket_offset+1;
1205 int git_config_set_in_file(const char *config_filename,
1206 const char *key, const char *value)
1208 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1211 int git_config_set(const char *key, const char *value)
1213 return git_config_set_multivar(key, value, NULL, 0);
1217 * Auxiliary function to sanity-check and split the key into the section
1218 * identifier and variable name.
1220 * Returns 0 on success, -1 when there is an invalid character in the key and
1221 * -2 if there is no section name in the key.
1223 * store_key - pointer to char* which will hold a copy of the key with
1224 * lowercase section and variable name
1225 * baselen - pointer to int which will hold the length of the
1226 * section + subsection part, can be NULL
1228 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1230 int i, dot, baselen;
1231 const char *last_dot = strrchr(key, '.');
1234 * Since "key" actually contains the section name and the real
1235 * key name separated by a dot, we have to know where the dot is.
1238 if (last_dot == NULL || last_dot == key) {
1239 error("key does not contain a section: %s", key);
1240 return -CONFIG_NO_SECTION_OR_NAME;
1244 error("key does not contain variable name: %s", key);
1245 return -CONFIG_NO_SECTION_OR_NAME;
1248 baselen = last_dot - key;
1250 *baselen_ = baselen;
1253 * Validate the key and while at it, lower case it for matching.
1255 *store_key = xmalloc(strlen(key) + 1);
1258 for (i = 0; key[i]; i++) {
1259 unsigned char c = key[i];
1262 /* Leave the extended basename untouched.. */
1263 if (!dot || i > baselen) {
1264 if (!iskeychar(c) ||
1265 (i == baselen + 1 && !isalpha(c))) {
1266 error("invalid key: %s", key);
1267 goto out_free_ret_1;
1270 } else if (c == '\n') {
1271 error("invalid key (newline): %s", key);
1272 goto out_free_ret_1;
1274 (*store_key)[i] = c;
1276 (*store_key)[i] = 0;
1282 return -CONFIG_INVALID_KEY;
1286 * If value==NULL, unset in (remove from) config,
1287 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1288 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1289 * else all matching key/values (regardless how many) are removed,
1290 * before the new pair is written.
1292 * Returns 0 on success.
1294 * This function does this:
1296 * - it locks the config file by creating ".git/config.lock"
1298 * - it then parses the config using store_aux() as validator to find
1299 * the position on the key/value pair to replace. If it is to be unset,
1300 * it must be found exactly once.
1302 * - the config file is mmap()ed and the part before the match (if any) is
1303 * written to the lock file, then the changed part and the rest.
1305 * - the config file is removed and the lock file rename()d to it.
1308 int git_config_set_multivar_in_file(const char *config_filename,
1309 const char *key, const char *value,
1310 const char *value_regex, int multi_replace)
1314 struct lock_file *lock = NULL;
1315 char *filename_buf = NULL;
1317 /* parse-key returns negative; flip the sign to feed exit(3) */
1318 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1322 store.multi_replace = multi_replace;
1324 if (!config_filename)
1325 config_filename = filename_buf = git_pathdup("config");
1328 * The lock serves a purpose in addition to locking: the new
1329 * contents of .git/config will be written into it.
1331 lock = xcalloc(sizeof(struct lock_file), 1);
1332 fd = hold_lock_file_for_update(lock, config_filename, 0);
1334 error("could not lock config file %s: %s", config_filename, strerror(errno));
1336 ret = CONFIG_NO_LOCK;
1341 * If .git/config does not exist yet, write a minimal version.
1343 in_fd = open(config_filename, O_RDONLY);
1347 if ( ENOENT != errno ) {
1348 error("opening %s: %s", config_filename,
1350 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1353 /* if nothing to unset, error out */
1354 if (value == NULL) {
1355 ret = CONFIG_NOTHING_SET;
1359 store.key = (char *)key;
1360 if (!store_write_section(fd, key) ||
1361 !store_write_pair(fd, key, value))
1366 size_t contents_sz, copy_begin, copy_end;
1367 int i, new_line = 0;
1369 if (value_regex == NULL)
1370 store.value_regex = NULL;
1372 if (value_regex[0] == '!') {
1373 store.do_not_match = 1;
1376 store.do_not_match = 0;
1378 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1379 if (regcomp(store.value_regex, value_regex,
1381 error("invalid pattern: %s", value_regex);
1382 free(store.value_regex);
1383 ret = CONFIG_INVALID_PATTERN;
1388 store.offset[0] = 0;
1389 store.state = START;
1393 * After this, store.offset will contain the *end* offset
1394 * of the last match, or remain at 0 if no match was found.
1395 * As a side effect, we make sure to transform only a valid
1396 * existing config file.
1398 if (git_config_from_file(store_aux, config_filename, NULL)) {
1399 error("invalid config file %s", config_filename);
1401 if (store.value_regex != NULL) {
1402 regfree(store.value_regex);
1403 free(store.value_regex);
1405 ret = CONFIG_INVALID_FILE;
1410 if (store.value_regex != NULL) {
1411 regfree(store.value_regex);
1412 free(store.value_regex);
1415 /* if nothing to unset, or too many matches, error out */
1416 if ((store.seen == 0 && value == NULL) ||
1417 (store.seen > 1 && multi_replace == 0)) {
1418 ret = CONFIG_NOTHING_SET;
1423 contents_sz = xsize_t(st.st_size);
1424 contents = xmmap(NULL, contents_sz, PROT_READ,
1425 MAP_PRIVATE, in_fd, 0);
1428 if (store.seen == 0)
1431 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1432 if (store.offset[i] == 0) {
1433 store.offset[i] = copy_end = contents_sz;
1434 } else if (store.state != KEY_SEEN) {
1435 copy_end = store.offset[i];
1437 copy_end = find_beginning_of_line(
1438 contents, contents_sz,
1439 store.offset[i]-2, &new_line);
1441 if (copy_end > 0 && contents[copy_end-1] != '\n')
1444 /* write the first part of the config */
1445 if (copy_end > copy_begin) {
1446 if (write_in_full(fd, contents + copy_begin,
1447 copy_end - copy_begin) <
1448 copy_end - copy_begin)
1451 write_str_in_full(fd, "\n") != 1)
1454 copy_begin = store.offset[i];
1457 /* write the pair (value == NULL means unset) */
1458 if (value != NULL) {
1459 if (store.state == START) {
1460 if (!store_write_section(fd, key))
1463 if (!store_write_pair(fd, key, value))
1467 /* write the rest of the config */
1468 if (copy_begin < contents_sz)
1469 if (write_in_full(fd, contents + copy_begin,
1470 contents_sz - copy_begin) <
1471 contents_sz - copy_begin)
1474 munmap(contents, contents_sz);
1477 if (commit_lock_file(lock) < 0) {
1478 error("could not commit config file %s", config_filename);
1479 ret = CONFIG_NO_WRITE;
1484 * lock is committed, so don't try to roll it back below.
1485 * NOTE: Since lockfile.c keeps a linked list of all created
1486 * lock_file structures, it isn't safe to free(lock). It's
1487 * better to just leave it hanging around.
1494 rollback_lock_file(lock);
1499 ret = write_error(lock->filename);
1504 int git_config_set_multivar(const char *key, const char *value,
1505 const char *value_regex, int multi_replace)
1507 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1511 static int section_name_match (const char *buf, const char *name)
1513 int i = 0, j = 0, dot = 0;
1516 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1517 if (!dot && isspace(buf[i])) {
1519 if (name[j++] != '.')
1521 for (i++; isspace(buf[i]); i++)
1527 if (buf[i] == '\\' && dot)
1529 else if (buf[i] == '"' && dot) {
1530 for (i++; isspace(buf[i]); i++)
1534 if (buf[i] != name[j++])
1537 if (buf[i] == ']' && name[j] == 0) {
1539 * We match, now just find the right length offset by
1540 * gobbling up any whitespace after it, as well
1543 for (; buf[i] && isspace(buf[i]); i++)
1550 /* if new_name == NULL, the section is removed instead */
1551 int git_config_rename_section_in_file(const char *config_filename,
1552 const char *old_name, const char *new_name)
1554 int ret = 0, remove = 0;
1555 char *filename_buf = NULL;
1556 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1561 if (!config_filename)
1562 config_filename = filename_buf = git_pathdup("config");
1564 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1566 ret = error("could not lock config file %s", config_filename);
1570 if (!(config_file = fopen(config_filename, "rb"))) {
1571 /* no config file means nothing to rename, no error */
1572 goto unlock_and_out;
1575 while (fgets(buf, sizeof(buf), config_file)) {
1579 for (i = 0; buf[i] && isspace(buf[i]); i++)
1581 if (buf[i] == '[') {
1582 /* it's a section */
1583 int offset = section_name_match(&buf[i], old_name);
1586 if (new_name == NULL) {
1590 store.baselen = strlen(new_name);
1591 if (!store_write_section(out_fd, new_name)) {
1592 ret = write_error(lock->filename);
1596 * We wrote out the new section, with
1597 * a newline, now skip the old
1600 output += offset + i;
1601 if (strlen(output) > 0) {
1603 * More content means there's
1604 * a declaration to put on the
1605 * next line; indent with a
1616 length = strlen(output);
1617 if (write_in_full(out_fd, output, length) != length) {
1618 ret = write_error(lock->filename);
1622 fclose(config_file);
1624 if (commit_lock_file(lock) < 0)
1625 ret = error("could not commit config file %s", config_filename);
1631 int git_config_rename_section(const char *old_name, const char *new_name)
1633 return git_config_rename_section_in_file(NULL, old_name, new_name);
1637 * Call this to report error for your variable that should not
1638 * get a boolean value (i.e. "[my] var" means "true").
1640 int config_error_nonbool(const char *var)
1642 return error("Missing value for '%s'", var);