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 const char *config_exclusive_filename = NULL;
31 static void lowercase(char *p)
37 void git_config_push_parameter(const char *text)
39 struct strbuf env = STRBUF_INIT;
40 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
42 strbuf_addstr(&env, old);
43 strbuf_addch(&env, ' ');
45 sq_quote_buf(&env, text);
46 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
50 int git_config_parse_parameter(const char *text,
51 config_fn_t fn, void *data)
54 pair = strbuf_split_str(text, '=', 2);
56 return error("bogus config parameter: %s", text);
57 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
58 strbuf_setlen(pair[0], pair[0]->len - 1);
61 strbuf_list_free(pair);
62 return error("bogus config parameter: %s", text);
64 lowercase(pair[0]->buf);
65 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
66 strbuf_list_free(pair);
69 strbuf_list_free(pair);
73 int git_config_from_parameters(config_fn_t fn, void *data)
75 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
77 const char **argv = NULL;
78 int nr = 0, alloc = 0;
83 /* sq_dequote will write over it */
86 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
88 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
91 for (i = 0; i < nr; i++) {
92 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
104 static int get_next_char(void)
110 if (cf && ((f = cf->f) != NULL)) {
113 /* DOS like systems */
130 static char *parse_value(void)
132 int quote = 0, comment = 0, space = 0;
134 strbuf_reset(&cf->value);
136 int c = get_next_char();
140 return cf->value.buf;
144 if (isspace(c) && !quote) {
150 if (c == ';' || c == '#') {
155 for (; space; space--)
156 strbuf_addch(&cf->value, ' ');
171 /* Some characters escape as themselves */
174 /* Reject unknown escape sequences */
178 strbuf_addch(&cf->value, c);
185 strbuf_addch(&cf->value, c);
189 static inline int iskeychar(int c)
191 return isalnum(c) || c == '-';
194 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
199 /* Get the full name */
206 name[len++] = tolower(c);
211 while (c == ' ' || c == '\t')
218 value = parse_value();
222 return fn(name, value, data);
225 static int get_extended_base_var(char *name, int baselen, int c)
231 } while (isspace(c));
233 /* We require the format to be '[base "extension"]' */
236 name[baselen++] = '.';
239 int c = get_next_char();
250 if (baselen > MAXNAME / 2)
255 if (get_next_char() != ']')
260 static int get_base_var(char *name)
265 int c = get_next_char();
271 return get_extended_base_var(name, baselen, c);
272 if (!iskeychar(c) && c != '.')
274 if (baselen > MAXNAME / 2)
276 name[baselen++] = tolower(c);
280 static int git_parse_file(config_fn_t fn, void *data)
286 /* U+FEFF Byte Order Mark in UTF8 */
287 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
288 const unsigned char *bomptr = utf8_bom;
291 int c = get_next_char();
292 if (bomptr && *bomptr) {
293 /* We are at the file beginning; skip UTF8-encoded BOM
294 * if present. Sane editors won't put this in on their
295 * own, but e.g. Windows Notepad will do it happily. */
296 if ((unsigned char) c == *bomptr) {
300 /* Do not tolerate partial BOM. */
301 if (bomptr != utf8_bom)
303 /* No BOM at file beginning. Cool. */
313 if (comment || isspace(c))
315 if (c == '#' || c == ';') {
320 baselen = get_base_var(var);
323 var[baselen++] = '.';
329 var[baselen] = tolower(c);
330 if (get_value(fn, data, var, baselen+1) < 0)
333 die("bad config file line %d in %s", cf->linenr, cf->name);
336 static int parse_unit_factor(const char *end, uintmax_t *val)
340 else if (!strcasecmp(end, "k")) {
344 else if (!strcasecmp(end, "m")) {
348 else if (!strcasecmp(end, "g")) {
349 *val *= 1024 * 1024 * 1024;
355 static int git_parse_long(const char *value, long *ret)
357 if (value && *value) {
361 uintmax_t factor = 1;
364 val = strtoimax(value, &end, 0);
367 if (!parse_unit_factor(end, &factor))
371 if ((uval > maximum_signed_value_of_type(long)) ||
381 int git_parse_ulong(const char *value, unsigned long *ret)
383 if (value && *value) {
389 val = strtoumax(value, &end, 0);
393 if (!parse_unit_factor(end, &val))
395 if ((val > maximum_unsigned_value_of_type(long)) ||
404 static void die_bad_config(const char *name)
407 die("bad config value for '%s' in %s", name, cf->name);
408 die("bad config value for '%s'", name);
411 int git_config_int(const char *name, const char *value)
414 if (!git_parse_long(value, &ret))
415 die_bad_config(name);
419 unsigned long git_config_ulong(const char *name, const char *value)
422 if (!git_parse_ulong(value, &ret))
423 die_bad_config(name);
427 static int git_config_maybe_bool_text(const char *name, const char *value)
433 if (!strcasecmp(value, "true")
434 || !strcasecmp(value, "yes")
435 || !strcasecmp(value, "on"))
437 if (!strcasecmp(value, "false")
438 || !strcasecmp(value, "no")
439 || !strcasecmp(value, "off"))
444 int git_config_maybe_bool(const char *name, const char *value)
446 long v = git_config_maybe_bool_text(name, value);
449 if (git_parse_long(value, &v))
454 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
456 int v = git_config_maybe_bool_text(name, value);
462 return git_config_int(name, value);
465 int git_config_bool(const char *name, const char *value)
468 return !!git_config_bool_or_int(name, value, &discard);
471 int git_config_string(const char **dest, const char *var, const char *value)
474 return config_error_nonbool(var);
475 *dest = xstrdup(value);
479 int git_config_pathname(const char **dest, const char *var, const char *value)
482 return config_error_nonbool(var);
483 *dest = expand_user_path(value);
485 die("Failed to expand user dir in: '%s'", value);
489 static int git_default_core_config(const char *var, const char *value)
491 /* This needs a better name */
492 if (!strcmp(var, "core.filemode")) {
493 trust_executable_bit = git_config_bool(var, value);
496 if (!strcmp(var, "core.trustctime")) {
497 trust_ctime = git_config_bool(var, value);
501 if (!strcmp(var, "core.quotepath")) {
502 quote_path_fully = git_config_bool(var, value);
506 if (!strcmp(var, "core.symlinks")) {
507 has_symlinks = git_config_bool(var, value);
511 if (!strcmp(var, "core.ignorecase")) {
512 ignore_case = git_config_bool(var, value);
516 if (!strcmp(var, "core.attributesfile"))
517 return git_config_pathname(&git_attributes_file, var, value);
519 if (!strcmp(var, "core.bare")) {
520 is_bare_repository_cfg = git_config_bool(var, value);
524 if (!strcmp(var, "core.ignorestat")) {
525 assume_unchanged = git_config_bool(var, value);
529 if (!strcmp(var, "core.prefersymlinkrefs")) {
530 prefer_symlink_refs = git_config_bool(var, value);
534 if (!strcmp(var, "core.logallrefupdates")) {
535 log_all_ref_updates = git_config_bool(var, value);
539 if (!strcmp(var, "core.warnambiguousrefs")) {
540 warn_ambiguous_refs = git_config_bool(var, value);
544 if (!strcmp(var, "core.abbrev")) {
545 int abbrev = git_config_int(var, value);
546 if (abbrev < minimum_abbrev || abbrev > 40)
548 default_abbrev = abbrev;
552 if (!strcmp(var, "core.loosecompression")) {
553 int level = git_config_int(var, value);
555 level = Z_DEFAULT_COMPRESSION;
556 else if (level < 0 || level > Z_BEST_COMPRESSION)
557 die("bad zlib compression level %d", level);
558 zlib_compression_level = level;
559 zlib_compression_seen = 1;
563 if (!strcmp(var, "core.compression")) {
564 int level = git_config_int(var, value);
566 level = Z_DEFAULT_COMPRESSION;
567 else if (level < 0 || level > Z_BEST_COMPRESSION)
568 die("bad zlib compression level %d", level);
569 core_compression_level = level;
570 core_compression_seen = 1;
571 if (!zlib_compression_seen)
572 zlib_compression_level = level;
576 if (!strcmp(var, "core.packedgitwindowsize")) {
577 int pgsz_x2 = getpagesize() * 2;
578 packed_git_window_size = git_config_ulong(var, value);
580 /* This value must be multiple of (pagesize * 2) */
581 packed_git_window_size /= pgsz_x2;
582 if (packed_git_window_size < 1)
583 packed_git_window_size = 1;
584 packed_git_window_size *= pgsz_x2;
588 if (!strcmp(var, "core.bigfilethreshold")) {
589 big_file_threshold = git_config_ulong(var, value);
593 if (!strcmp(var, "core.packedgitlimit")) {
594 packed_git_limit = git_config_ulong(var, value);
598 if (!strcmp(var, "core.deltabasecachelimit")) {
599 delta_base_cache_limit = git_config_ulong(var, value);
603 if (!strcmp(var, "core.logpackaccess"))
604 return git_config_string(&log_pack_access, var, value);
606 if (!strcmp(var, "core.autocrlf")) {
607 if (value && !strcasecmp(value, "input")) {
608 if (core_eol == EOL_CRLF)
609 return error("core.autocrlf=input conflicts with core.eol=crlf");
610 auto_crlf = AUTO_CRLF_INPUT;
613 auto_crlf = git_config_bool(var, value);
617 if (!strcmp(var, "core.safecrlf")) {
618 if (value && !strcasecmp(value, "warn")) {
619 safe_crlf = SAFE_CRLF_WARN;
622 safe_crlf = git_config_bool(var, value);
626 if (!strcmp(var, "core.eol")) {
627 if (value && !strcasecmp(value, "lf"))
629 else if (value && !strcasecmp(value, "crlf"))
631 else if (value && !strcasecmp(value, "native"))
632 core_eol = EOL_NATIVE;
634 core_eol = EOL_UNSET;
635 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
636 return error("core.autocrlf=input conflicts with core.eol=crlf");
640 if (!strcmp(var, "core.notesref")) {
641 notes_ref_name = xstrdup(value);
645 if (!strcmp(var, "core.pager"))
646 return git_config_string(&pager_program, var, value);
648 if (!strcmp(var, "core.editor"))
649 return git_config_string(&editor_program, var, value);
651 if (!strcmp(var, "core.askpass"))
652 return git_config_string(&askpass_program, var, value);
654 if (!strcmp(var, "core.excludesfile"))
655 return git_config_pathname(&excludes_file, var, value);
657 if (!strcmp(var, "core.whitespace")) {
659 return config_error_nonbool(var);
660 whitespace_rule_cfg = parse_whitespace_rule(value);
664 if (!strcmp(var, "core.fsyncobjectfiles")) {
665 fsync_object_files = git_config_bool(var, value);
669 if (!strcmp(var, "core.preloadindex")) {
670 core_preload_index = git_config_bool(var, value);
674 if (!strcmp(var, "core.createobject")) {
675 if (!strcmp(value, "rename"))
676 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
677 else if (!strcmp(value, "link"))
678 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
680 die("Invalid mode for object creation: %s", value);
684 if (!strcmp(var, "core.sparsecheckout")) {
685 core_apply_sparse_checkout = git_config_bool(var, value);
689 /* Add other config variables here and to Documentation/config.txt. */
693 static int git_default_user_config(const char *var, const char *value)
695 if (!strcmp(var, "user.name")) {
697 return config_error_nonbool(var);
698 strlcpy(git_default_name, value, sizeof(git_default_name));
699 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
703 if (!strcmp(var, "user.email")) {
705 return config_error_nonbool(var);
706 strlcpy(git_default_email, value, sizeof(git_default_email));
707 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
711 /* Add other config variables here and to Documentation/config.txt. */
715 static int git_default_i18n_config(const char *var, const char *value)
717 if (!strcmp(var, "i18n.commitencoding"))
718 return git_config_string(&git_commit_encoding, var, value);
720 if (!strcmp(var, "i18n.logoutputencoding"))
721 return git_config_string(&git_log_output_encoding, var, value);
723 /* Add other config variables here and to Documentation/config.txt. */
727 static int git_default_branch_config(const char *var, const char *value)
729 if (!strcmp(var, "branch.autosetupmerge")) {
730 if (value && !strcasecmp(value, "always")) {
731 git_branch_track = BRANCH_TRACK_ALWAYS;
734 git_branch_track = git_config_bool(var, value);
737 if (!strcmp(var, "branch.autosetuprebase")) {
739 return config_error_nonbool(var);
740 else if (!strcmp(value, "never"))
741 autorebase = AUTOREBASE_NEVER;
742 else if (!strcmp(value, "local"))
743 autorebase = AUTOREBASE_LOCAL;
744 else if (!strcmp(value, "remote"))
745 autorebase = AUTOREBASE_REMOTE;
746 else if (!strcmp(value, "always"))
747 autorebase = AUTOREBASE_ALWAYS;
749 return error("Malformed value for %s", var);
753 /* Add other config variables here and to Documentation/config.txt. */
757 static int git_default_push_config(const char *var, const char *value)
759 if (!strcmp(var, "push.default")) {
761 return config_error_nonbool(var);
762 else if (!strcmp(value, "nothing"))
763 push_default = PUSH_DEFAULT_NOTHING;
764 else if (!strcmp(value, "matching"))
765 push_default = PUSH_DEFAULT_MATCHING;
766 else if (!strcmp(value, "upstream"))
767 push_default = PUSH_DEFAULT_UPSTREAM;
768 else if (!strcmp(value, "tracking")) /* deprecated */
769 push_default = PUSH_DEFAULT_UPSTREAM;
770 else if (!strcmp(value, "current"))
771 push_default = PUSH_DEFAULT_CURRENT;
773 error("Malformed value for %s: %s", var, value);
774 return error("Must be one of nothing, matching, "
775 "tracking or current.");
780 /* Add other config variables here and to Documentation/config.txt. */
784 static int git_default_mailmap_config(const char *var, const char *value)
786 if (!strcmp(var, "mailmap.file"))
787 return git_config_string(&git_mailmap_file, var, value);
789 /* Add other config variables here and to Documentation/config.txt. */
793 int git_default_config(const char *var, const char *value, void *dummy)
795 if (!prefixcmp(var, "core."))
796 return git_default_core_config(var, value);
798 if (!prefixcmp(var, "user."))
799 return git_default_user_config(var, value);
801 if (!prefixcmp(var, "i18n."))
802 return git_default_i18n_config(var, value);
804 if (!prefixcmp(var, "branch."))
805 return git_default_branch_config(var, value);
807 if (!prefixcmp(var, "push."))
808 return git_default_push_config(var, value);
810 if (!prefixcmp(var, "mailmap."))
811 return git_default_mailmap_config(var, value);
813 if (!prefixcmp(var, "advice."))
814 return git_default_advice_config(var, value);
816 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
817 pager_use_color = git_config_bool(var,value);
821 /* Add other config variables here and to Documentation/config.txt. */
825 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
828 FILE *f = fopen(filename, "r");
834 /* push config-file parsing state stack */
840 strbuf_init(&top.value, 1024);
843 ret = git_parse_file(fn, data);
845 /* pop config-file parsing state stack */
846 strbuf_release(&top.value);
854 const char *git_etc_gitconfig(void)
856 static const char *system_wide;
858 system_wide = system_path(ETC_GITCONFIG);
862 int git_env_bool(const char *k, int def)
864 const char *v = getenv(k);
865 return v ? git_config_bool(k, v) : def;
868 int git_config_system(void)
870 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
873 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
875 int ret = 0, found = 0;
876 const char *home = NULL;
878 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
879 if (config_exclusive_filename)
880 return git_config_from_file(fn, config_exclusive_filename, data);
881 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
882 ret += git_config_from_file(fn, git_etc_gitconfig(),
887 home = getenv("HOME");
890 char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
891 if (!access(user_config, R_OK)) {
892 ret += git_config_from_file(fn, user_config, data);
897 if (repo_config && !access(repo_config, R_OK)) {
898 ret += git_config_from_file(fn, repo_config, data);
902 switch (git_config_from_parameters(fn, data)) {
904 die("unable to parse command-line config");
906 case 0: /* found nothing */
908 default: /* found at least one item */
913 return ret == 0 ? found : ret;
916 int git_config(config_fn_t fn, void *data)
918 char *repo_config = NULL;
921 repo_config = git_pathdup("config");
922 ret = git_config_early(fn, data, repo_config);
929 * Find all the stuff for git_config_set() below.
932 #define MAX_MATCHES 512
938 regex_t *value_regex;
940 size_t offset[MAX_MATCHES];
941 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
945 static int matches(const char *key, const char *value)
947 return !strcmp(key, store.key) &&
948 (store.value_regex == NULL ||
949 (store.do_not_match ^
950 !regexec(store.value_regex, value, 0, NULL, 0)));
953 static int store_aux(const char *key, const char *value, void *cb)
959 switch (store.state) {
961 if (matches(key, value)) {
962 if (store.seen == 1 && store.multi_replace == 0) {
963 warning("%s has multiple values", key);
964 } else if (store.seen >= MAX_MATCHES) {
965 error("too many matches for %s", key);
969 store.offset[store.seen] = ftell(f);
975 * What we are looking for is in store.key (both
976 * section and var), and its section part is baselen
977 * long. We found key (again, both section and var).
978 * We would want to know if this key is in the same
979 * section as what we are looking for. We already
980 * know we are in the same section as what should
983 ep = strrchr(key, '.');
984 section_len = ep - key;
986 if ((section_len != store.baselen) ||
987 memcmp(key, store.key, section_len+1)) {
988 store.state = SECTION_END_SEEN;
993 * Do not increment matches: this is no match, but we
994 * just made sure we are in the desired section.
996 store.offset[store.seen] = ftell(f);
998 case SECTION_END_SEEN:
1000 if (matches(key, value)) {
1001 store.offset[store.seen] = ftell(f);
1002 store.state = KEY_SEEN;
1005 if (strrchr(key, '.') - key == store.baselen &&
1006 !strncmp(key, store.key, store.baselen)) {
1007 store.state = SECTION_SEEN;
1008 store.offset[store.seen] = ftell(f);
1015 static int write_error(const char *filename)
1017 error("failed to write new configuration file %s", filename);
1019 /* Same error code as "failed to rename". */
1023 static int store_write_section(int fd, const char *key)
1027 struct strbuf sb = STRBUF_INIT;
1029 dot = memchr(key, '.', store.baselen);
1031 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1032 for (i = dot - key + 1; i < store.baselen; i++) {
1033 if (key[i] == '"' || key[i] == '\\')
1034 strbuf_addch(&sb, '\\');
1035 strbuf_addch(&sb, key[i]);
1037 strbuf_addstr(&sb, "\"]\n");
1039 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1042 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1043 strbuf_release(&sb);
1048 static int store_write_pair(int fd, const char *key, const char *value)
1051 int length = strlen(key + store.baselen + 1);
1052 const char *quote = "";
1053 struct strbuf sb = STRBUF_INIT;
1056 * Check to see if the value needs to be surrounded with a dq pair.
1057 * Note that problematic characters are always backslash-quoted; this
1058 * check is about not losing leading or trailing SP and strings that
1059 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1060 * configuration parser.
1062 if (value[0] == ' ')
1064 for (i = 0; value[i]; i++)
1065 if (value[i] == ';' || value[i] == '#')
1067 if (i && value[i - 1] == ' ')
1070 strbuf_addf(&sb, "\t%.*s = %s",
1071 length, key + store.baselen + 1, quote);
1073 for (i = 0; value[i]; i++)
1076 strbuf_addstr(&sb, "\\n");
1079 strbuf_addstr(&sb, "\\t");
1083 strbuf_addch(&sb, '\\');
1085 strbuf_addch(&sb, value[i]);
1088 strbuf_addf(&sb, "%s\n", quote);
1090 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1091 strbuf_release(&sb);
1096 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1097 size_t offset_, int *found_bracket)
1099 size_t equal_offset = size, bracket_offset = size;
1103 for (offset = offset_-2; offset > 0
1104 && contents[offset] != '\n'; offset--)
1105 switch (contents[offset]) {
1106 case '=': equal_offset = offset; break;
1107 case ']': bracket_offset = offset; break;
1109 if (offset > 0 && contents[offset-1] == '\\') {
1113 if (bracket_offset < equal_offset) {
1115 offset = bracket_offset+1;
1122 int git_config_set_in_file(const char *config_filename,
1123 const char *key, const char *value)
1125 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1128 int git_config_set(const char *key, const char *value)
1130 return git_config_set_multivar(key, value, NULL, 0);
1134 * Auxiliary function to sanity-check and split the key into the section
1135 * identifier and variable name.
1137 * Returns 0 on success, -1 when there is an invalid character in the key and
1138 * -2 if there is no section name in the key.
1140 * store_key - pointer to char* which will hold a copy of the key with
1141 * lowercase section and variable name
1142 * baselen - pointer to int which will hold the length of the
1143 * section + subsection part, can be NULL
1145 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1147 int i, dot, baselen;
1148 const char *last_dot = strrchr(key, '.');
1151 * Since "key" actually contains the section name and the real
1152 * key name separated by a dot, we have to know where the dot is.
1155 if (last_dot == NULL || last_dot == key) {
1156 error("key does not contain a section: %s", key);
1157 return -CONFIG_NO_SECTION_OR_NAME;
1161 error("key does not contain variable name: %s", key);
1162 return -CONFIG_NO_SECTION_OR_NAME;
1165 baselen = last_dot - key;
1167 *baselen_ = baselen;
1170 * Validate the key and while at it, lower case it for matching.
1172 *store_key = xmalloc(strlen(key) + 1);
1175 for (i = 0; key[i]; i++) {
1176 unsigned char c = key[i];
1179 /* Leave the extended basename untouched.. */
1180 if (!dot || i > baselen) {
1181 if (!iskeychar(c) ||
1182 (i == baselen + 1 && !isalpha(c))) {
1183 error("invalid key: %s", key);
1184 goto out_free_ret_1;
1187 } else if (c == '\n') {
1188 error("invalid key (newline): %s", key);
1189 goto out_free_ret_1;
1191 (*store_key)[i] = c;
1193 (*store_key)[i] = 0;
1199 return -CONFIG_INVALID_KEY;
1203 * If value==NULL, unset in (remove from) config,
1204 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1205 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1206 * else all matching key/values (regardless how many) are removed,
1207 * before the new pair is written.
1209 * Returns 0 on success.
1211 * This function does this:
1213 * - it locks the config file by creating ".git/config.lock"
1215 * - it then parses the config using store_aux() as validator to find
1216 * the position on the key/value pair to replace. If it is to be unset,
1217 * it must be found exactly once.
1219 * - the config file is mmap()ed and the part before the match (if any) is
1220 * written to the lock file, then the changed part and the rest.
1222 * - the config file is removed and the lock file rename()d to it.
1225 int git_config_set_multivar_in_file(const char *config_filename,
1226 const char *key, const char *value,
1227 const char *value_regex, int multi_replace)
1231 struct lock_file *lock = NULL;
1233 /* parse-key returns negative; flip the sign to feed exit(3) */
1234 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1238 store.multi_replace = multi_replace;
1242 * The lock serves a purpose in addition to locking: the new
1243 * contents of .git/config will be written into it.
1245 lock = xcalloc(sizeof(struct lock_file), 1);
1246 fd = hold_lock_file_for_update(lock, config_filename, 0);
1248 error("could not lock config file %s: %s", config_filename, strerror(errno));
1250 ret = CONFIG_NO_LOCK;
1255 * If .git/config does not exist yet, write a minimal version.
1257 in_fd = open(config_filename, O_RDONLY);
1261 if ( ENOENT != errno ) {
1262 error("opening %s: %s", config_filename,
1264 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1267 /* if nothing to unset, error out */
1268 if (value == NULL) {
1269 ret = CONFIG_NOTHING_SET;
1273 store.key = (char *)key;
1274 if (!store_write_section(fd, key) ||
1275 !store_write_pair(fd, key, value))
1280 size_t contents_sz, copy_begin, copy_end;
1281 int i, new_line = 0;
1283 if (value_regex == NULL)
1284 store.value_regex = NULL;
1286 if (value_regex[0] == '!') {
1287 store.do_not_match = 1;
1290 store.do_not_match = 0;
1292 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1293 if (regcomp(store.value_regex, value_regex,
1295 error("invalid pattern: %s", value_regex);
1296 free(store.value_regex);
1297 ret = CONFIG_INVALID_PATTERN;
1302 store.offset[0] = 0;
1303 store.state = START;
1307 * After this, store.offset will contain the *end* offset
1308 * of the last match, or remain at 0 if no match was found.
1309 * As a side effect, we make sure to transform only a valid
1310 * existing config file.
1312 if (git_config_from_file(store_aux, config_filename, NULL)) {
1313 error("invalid config file %s", config_filename);
1315 if (store.value_regex != NULL) {
1316 regfree(store.value_regex);
1317 free(store.value_regex);
1319 ret = CONFIG_INVALID_FILE;
1324 if (store.value_regex != NULL) {
1325 regfree(store.value_regex);
1326 free(store.value_regex);
1329 /* if nothing to unset, or too many matches, error out */
1330 if ((store.seen == 0 && value == NULL) ||
1331 (store.seen > 1 && multi_replace == 0)) {
1332 ret = CONFIG_NOTHING_SET;
1337 contents_sz = xsize_t(st.st_size);
1338 contents = xmmap(NULL, contents_sz, PROT_READ,
1339 MAP_PRIVATE, in_fd, 0);
1342 if (store.seen == 0)
1345 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1346 if (store.offset[i] == 0) {
1347 store.offset[i] = copy_end = contents_sz;
1348 } else if (store.state != KEY_SEEN) {
1349 copy_end = store.offset[i];
1351 copy_end = find_beginning_of_line(
1352 contents, contents_sz,
1353 store.offset[i]-2, &new_line);
1355 if (copy_end > 0 && contents[copy_end-1] != '\n')
1358 /* write the first part of the config */
1359 if (copy_end > copy_begin) {
1360 if (write_in_full(fd, contents + copy_begin,
1361 copy_end - copy_begin) <
1362 copy_end - copy_begin)
1365 write_str_in_full(fd, "\n") != 1)
1368 copy_begin = store.offset[i];
1371 /* write the pair (value == NULL means unset) */
1372 if (value != NULL) {
1373 if (store.state == START) {
1374 if (!store_write_section(fd, key))
1377 if (!store_write_pair(fd, key, value))
1381 /* write the rest of the config */
1382 if (copy_begin < contents_sz)
1383 if (write_in_full(fd, contents + copy_begin,
1384 contents_sz - copy_begin) <
1385 contents_sz - copy_begin)
1388 munmap(contents, contents_sz);
1391 if (commit_lock_file(lock) < 0) {
1392 error("could not commit config file %s", config_filename);
1393 ret = CONFIG_NO_WRITE;
1398 * lock is committed, so don't try to roll it back below.
1399 * NOTE: Since lockfile.c keeps a linked list of all created
1400 * lock_file structures, it isn't safe to free(lock). It's
1401 * better to just leave it hanging around.
1408 rollback_lock_file(lock);
1412 ret = write_error(lock->filename);
1417 int git_config_set_multivar(const char *key, const char *value,
1418 const char *value_regex, int multi_replace)
1420 const char *config_filename;
1424 if (config_exclusive_filename)
1425 config_filename = config_exclusive_filename;
1427 config_filename = buf = git_pathdup("config");
1429 ret = git_config_set_multivar_in_file(config_filename, key, value,
1430 value_regex, multi_replace);
1435 static int section_name_match (const char *buf, const char *name)
1437 int i = 0, j = 0, dot = 0;
1440 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1441 if (!dot && isspace(buf[i])) {
1443 if (name[j++] != '.')
1445 for (i++; isspace(buf[i]); i++)
1451 if (buf[i] == '\\' && dot)
1453 else if (buf[i] == '"' && dot) {
1454 for (i++; isspace(buf[i]); i++)
1458 if (buf[i] != name[j++])
1461 if (buf[i] == ']' && name[j] == 0) {
1463 * We match, now just find the right length offset by
1464 * gobbling up any whitespace after it, as well
1467 for (; buf[i] && isspace(buf[i]); i++)
1474 /* if new_name == NULL, the section is removed instead */
1475 int git_config_rename_section(const char *old_name, const char *new_name)
1477 int ret = 0, remove = 0;
1478 char *config_filename;
1479 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1484 if (config_exclusive_filename)
1485 config_filename = xstrdup(config_exclusive_filename);
1487 config_filename = git_pathdup("config");
1488 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1490 ret = error("could not lock config file %s", config_filename);
1494 if (!(config_file = fopen(config_filename, "rb"))) {
1495 /* no config file means nothing to rename, no error */
1496 goto unlock_and_out;
1499 while (fgets(buf, sizeof(buf), config_file)) {
1503 for (i = 0; buf[i] && isspace(buf[i]); i++)
1505 if (buf[i] == '[') {
1506 /* it's a section */
1507 int offset = section_name_match(&buf[i], old_name);
1510 if (new_name == NULL) {
1514 store.baselen = strlen(new_name);
1515 if (!store_write_section(out_fd, new_name)) {
1516 ret = write_error(lock->filename);
1520 * We wrote out the new section, with
1521 * a newline, now skip the old
1524 output += offset + i;
1525 if (strlen(output) > 0) {
1527 * More content means there's
1528 * a declaration to put on the
1529 * next line; indent with a
1540 length = strlen(output);
1541 if (write_in_full(out_fd, output, length) != length) {
1542 ret = write_error(lock->filename);
1546 fclose(config_file);
1548 if (commit_lock_file(lock) < 0)
1549 ret = error("could not commit config file %s", config_filename);
1551 free(config_filename);
1556 * Call this to report error for your variable that should not
1557 * get a boolean value (i.e. "[my] var" means "true").
1559 int config_error_nonbool(const char *var)
1561 return error("Missing value for '%s'", var);