2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
13 typedef struct config_file {
14 struct config_file *prev;
23 static config_file *cf;
25 static int zlib_compression_seen;
27 #define MAX_INCLUDE_DEPTH 10
28 static const char include_depth_advice[] =
29 "exceeded maximum include depth (%d) while including\n"
33 "Do you have circular includes?";
34 static int handle_path_include(const char *path, struct config_include_data *inc)
37 struct strbuf buf = STRBUF_INIT;
38 char *expanded = expand_user_path(path);
41 return error("Could not expand include path '%s'", path);
45 * Use an absolute path as-is, but interpret relative paths
46 * based on the including config file.
48 if (!is_absolute_path(path)) {
52 return error("relative config includes must come from files");
54 slash = find_last_dir_sep(cf->name);
56 strbuf_add(&buf, cf->name, slash - cf->name + 1);
57 strbuf_addstr(&buf, path);
61 if (!access_or_warn(path, R_OK)) {
62 if (++inc->depth > MAX_INCLUDE_DEPTH)
63 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
64 cf && cf->name ? cf->name : "the command line");
65 ret = git_config_from_file(git_config_include, path, inc);
73 int git_config_include(const char *var, const char *value, void *data)
75 struct config_include_data *inc = data;
80 * Pass along all values, including "include" directives; this makes it
81 * possible to query information on the includes themselves.
83 ret = inc->fn(var, value, inc->data);
87 type = skip_prefix(var, "include.");
91 if (!strcmp(type, "path"))
92 ret = handle_path_include(value, inc);
96 static void lowercase(char *p)
102 void git_config_push_parameter(const char *text)
104 struct strbuf env = STRBUF_INIT;
105 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
107 strbuf_addstr(&env, old);
108 strbuf_addch(&env, ' ');
110 sq_quote_buf(&env, text);
111 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
112 strbuf_release(&env);
115 int git_config_parse_parameter(const char *text,
116 config_fn_t fn, void *data)
118 struct strbuf **pair;
119 pair = strbuf_split_str(text, '=', 2);
121 return error("bogus config parameter: %s", text);
122 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
123 strbuf_setlen(pair[0], pair[0]->len - 1);
124 strbuf_trim(pair[0]);
126 strbuf_list_free(pair);
127 return error("bogus config parameter: %s", text);
129 lowercase(pair[0]->buf);
130 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
131 strbuf_list_free(pair);
134 strbuf_list_free(pair);
138 int git_config_from_parameters(config_fn_t fn, void *data)
140 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
142 const char **argv = NULL;
143 int nr = 0, alloc = 0;
148 /* sq_dequote will write over it */
151 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
153 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
156 for (i = 0; i < nr; i++) {
157 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
169 static int get_next_char(void)
175 if (cf && ((f = cf->f) != NULL)) {
178 /* DOS like systems */
195 static char *parse_value(void)
197 int quote = 0, comment = 0, space = 0;
199 strbuf_reset(&cf->value);
201 int c = get_next_char();
207 return cf->value.buf;
211 if (isspace(c) && !quote) {
217 if (c == ';' || c == '#') {
222 for (; space; space--)
223 strbuf_addch(&cf->value, ' ');
238 /* Some characters escape as themselves */
241 /* Reject unknown escape sequences */
245 strbuf_addch(&cf->value, c);
252 strbuf_addch(&cf->value, c);
256 static inline int iskeychar(int c)
258 return isalnum(c) || c == '-';
261 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
266 /* Get the full name */
273 strbuf_addch(name, tolower(c));
276 while (c == ' ' || c == '\t')
283 value = parse_value();
287 return fn(name->buf, value, data);
290 static int get_extended_base_var(struct strbuf *name, int c)
294 goto error_incomplete_line;
296 } while (isspace(c));
298 /* We require the format to be '[base "extension"]' */
301 strbuf_addch(name, '.');
304 int c = get_next_char();
306 goto error_incomplete_line;
312 goto error_incomplete_line;
314 strbuf_addch(name, c);
318 if (get_next_char() != ']')
321 error_incomplete_line:
326 static int get_base_var(struct strbuf *name)
329 int c = get_next_char();
335 return get_extended_base_var(name, c);
336 if (!iskeychar(c) && c != '.')
338 strbuf_addch(name, tolower(c));
342 static int git_parse_file(config_fn_t fn, void *data)
346 struct strbuf *var = &cf->var;
348 /* U+FEFF Byte Order Mark in UTF8 */
349 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
350 const unsigned char *bomptr = utf8_bom;
353 int c = get_next_char();
354 if (bomptr && *bomptr) {
355 /* We are at the file beginning; skip UTF8-encoded BOM
356 * if present. Sane editors won't put this in on their
357 * own, but e.g. Windows Notepad will do it happily. */
358 if ((unsigned char) c == *bomptr) {
362 /* Do not tolerate partial BOM. */
363 if (bomptr != utf8_bom)
365 /* No BOM at file beginning. Cool. */
375 if (comment || isspace(c))
377 if (c == '#' || c == ';') {
382 /* Reset prior to determining a new stem */
384 if (get_base_var(var) < 0 || var->len < 1)
386 strbuf_addch(var, '.');
393 * Truncate the var name back to the section header
394 * stem prior to grabbing the suffix part of the name
397 strbuf_setlen(var, baselen);
398 strbuf_addch(var, tolower(c));
399 if (get_value(fn, data, var) < 0)
402 die("bad config file line %d in %s", cf->linenr, cf->name);
405 static int parse_unit_factor(const char *end, uintmax_t *val)
409 else if (!strcasecmp(end, "k")) {
413 else if (!strcasecmp(end, "m")) {
417 else if (!strcasecmp(end, "g")) {
418 *val *= 1024 * 1024 * 1024;
424 static int git_parse_long(const char *value, long *ret)
426 if (value && *value) {
430 uintmax_t factor = 1;
433 val = strtoimax(value, &end, 0);
436 if (!parse_unit_factor(end, &factor))
440 if ((uval > maximum_signed_value_of_type(long)) ||
450 int git_parse_ulong(const char *value, unsigned long *ret)
452 if (value && *value) {
458 val = strtoumax(value, &end, 0);
462 if (!parse_unit_factor(end, &val))
464 if ((val > maximum_unsigned_value_of_type(long)) ||
473 static void die_bad_config(const char *name)
476 die("bad config value for '%s' in %s", name, cf->name);
477 die("bad config value for '%s'", name);
480 int git_config_int(const char *name, const char *value)
483 if (!git_parse_long(value, &ret))
484 die_bad_config(name);
488 unsigned long git_config_ulong(const char *name, const char *value)
491 if (!git_parse_ulong(value, &ret))
492 die_bad_config(name);
496 static int git_config_maybe_bool_text(const char *name, const char *value)
502 if (!strcasecmp(value, "true")
503 || !strcasecmp(value, "yes")
504 || !strcasecmp(value, "on"))
506 if (!strcasecmp(value, "false")
507 || !strcasecmp(value, "no")
508 || !strcasecmp(value, "off"))
513 int git_config_maybe_bool(const char *name, const char *value)
515 long v = git_config_maybe_bool_text(name, value);
518 if (git_parse_long(value, &v))
523 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
525 int v = git_config_maybe_bool_text(name, value);
531 return git_config_int(name, value);
534 int git_config_bool(const char *name, const char *value)
537 return !!git_config_bool_or_int(name, value, &discard);
540 int git_config_string(const char **dest, const char *var, const char *value)
543 return config_error_nonbool(var);
544 *dest = xstrdup(value);
548 int git_config_pathname(const char **dest, const char *var, const char *value)
551 return config_error_nonbool(var);
552 *dest = expand_user_path(value);
554 die("Failed to expand user dir in: '%s'", value);
558 static int git_default_core_config(const char *var, const char *value)
560 /* This needs a better name */
561 if (!strcmp(var, "core.filemode")) {
562 trust_executable_bit = git_config_bool(var, value);
565 if (!strcmp(var, "core.trustctime")) {
566 trust_ctime = git_config_bool(var, value);
570 if (!strcmp(var, "core.quotepath")) {
571 quote_path_fully = git_config_bool(var, value);
575 if (!strcmp(var, "core.symlinks")) {
576 has_symlinks = git_config_bool(var, value);
580 if (!strcmp(var, "core.ignorecase")) {
581 ignore_case = git_config_bool(var, value);
585 if (!strcmp(var, "core.attributesfile"))
586 return git_config_pathname(&git_attributes_file, var, value);
588 if (!strcmp(var, "core.bare")) {
589 is_bare_repository_cfg = git_config_bool(var, value);
593 if (!strcmp(var, "core.ignorestat")) {
594 assume_unchanged = git_config_bool(var, value);
598 if (!strcmp(var, "core.prefersymlinkrefs")) {
599 prefer_symlink_refs = git_config_bool(var, value);
603 if (!strcmp(var, "core.logallrefupdates")) {
604 log_all_ref_updates = git_config_bool(var, value);
608 if (!strcmp(var, "core.warnambiguousrefs")) {
609 warn_ambiguous_refs = git_config_bool(var, value);
613 if (!strcmp(var, "core.abbrev")) {
614 int abbrev = git_config_int(var, value);
615 if (abbrev < minimum_abbrev || abbrev > 40)
617 default_abbrev = abbrev;
621 if (!strcmp(var, "core.loosecompression")) {
622 int level = git_config_int(var, value);
624 level = Z_DEFAULT_COMPRESSION;
625 else if (level < 0 || level > Z_BEST_COMPRESSION)
626 die("bad zlib compression level %d", level);
627 zlib_compression_level = level;
628 zlib_compression_seen = 1;
632 if (!strcmp(var, "core.compression")) {
633 int level = git_config_int(var, value);
635 level = Z_DEFAULT_COMPRESSION;
636 else if (level < 0 || level > Z_BEST_COMPRESSION)
637 die("bad zlib compression level %d", level);
638 core_compression_level = level;
639 core_compression_seen = 1;
640 if (!zlib_compression_seen)
641 zlib_compression_level = level;
645 if (!strcmp(var, "core.packedgitwindowsize")) {
646 int pgsz_x2 = getpagesize() * 2;
647 packed_git_window_size = git_config_ulong(var, value);
649 /* This value must be multiple of (pagesize * 2) */
650 packed_git_window_size /= pgsz_x2;
651 if (packed_git_window_size < 1)
652 packed_git_window_size = 1;
653 packed_git_window_size *= pgsz_x2;
657 if (!strcmp(var, "core.bigfilethreshold")) {
658 big_file_threshold = git_config_ulong(var, value);
662 if (!strcmp(var, "core.packedgitlimit")) {
663 packed_git_limit = git_config_ulong(var, value);
667 if (!strcmp(var, "core.deltabasecachelimit")) {
668 delta_base_cache_limit = git_config_ulong(var, value);
672 if (!strcmp(var, "core.logpackaccess"))
673 return git_config_string(&log_pack_access, var, value);
675 if (!strcmp(var, "core.autocrlf")) {
676 if (value && !strcasecmp(value, "input")) {
677 if (core_eol == EOL_CRLF)
678 return error("core.autocrlf=input conflicts with core.eol=crlf");
679 auto_crlf = AUTO_CRLF_INPUT;
682 auto_crlf = git_config_bool(var, value);
686 if (!strcmp(var, "core.safecrlf")) {
687 if (value && !strcasecmp(value, "warn")) {
688 safe_crlf = SAFE_CRLF_WARN;
691 safe_crlf = git_config_bool(var, value);
695 if (!strcmp(var, "core.eol")) {
696 if (value && !strcasecmp(value, "lf"))
698 else if (value && !strcasecmp(value, "crlf"))
700 else if (value && !strcasecmp(value, "native"))
701 core_eol = EOL_NATIVE;
703 core_eol = EOL_UNSET;
704 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
705 return error("core.autocrlf=input conflicts with core.eol=crlf");
709 if (!strcmp(var, "core.notesref")) {
710 notes_ref_name = xstrdup(value);
714 if (!strcmp(var, "core.pager"))
715 return git_config_string(&pager_program, var, value);
717 if (!strcmp(var, "core.editor"))
718 return git_config_string(&editor_program, var, value);
720 if (!strcmp(var, "core.askpass"))
721 return git_config_string(&askpass_program, var, value);
723 if (!strcmp(var, "core.excludesfile"))
724 return git_config_pathname(&excludes_file, var, value);
726 if (!strcmp(var, "core.whitespace")) {
728 return config_error_nonbool(var);
729 whitespace_rule_cfg = parse_whitespace_rule(value);
733 if (!strcmp(var, "core.fsyncobjectfiles")) {
734 fsync_object_files = git_config_bool(var, value);
738 if (!strcmp(var, "core.preloadindex")) {
739 core_preload_index = git_config_bool(var, value);
743 if (!strcmp(var, "core.createobject")) {
744 if (!strcmp(value, "rename"))
745 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
746 else if (!strcmp(value, "link"))
747 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
749 die("Invalid mode for object creation: %s", value);
753 if (!strcmp(var, "core.sparsecheckout")) {
754 core_apply_sparse_checkout = git_config_bool(var, value);
758 if (!strcmp(var, "core.precomposeunicode")) {
759 precomposed_unicode = git_config_bool(var, value);
763 /* Add other config variables here and to Documentation/config.txt. */
767 static int git_default_i18n_config(const char *var, const char *value)
769 if (!strcmp(var, "i18n.commitencoding"))
770 return git_config_string(&git_commit_encoding, var, value);
772 if (!strcmp(var, "i18n.logoutputencoding"))
773 return git_config_string(&git_log_output_encoding, var, value);
775 /* Add other config variables here and to Documentation/config.txt. */
779 static int git_default_branch_config(const char *var, const char *value)
781 if (!strcmp(var, "branch.autosetupmerge")) {
782 if (value && !strcasecmp(value, "always")) {
783 git_branch_track = BRANCH_TRACK_ALWAYS;
786 git_branch_track = git_config_bool(var, value);
789 if (!strcmp(var, "branch.autosetuprebase")) {
791 return config_error_nonbool(var);
792 else if (!strcmp(value, "never"))
793 autorebase = AUTOREBASE_NEVER;
794 else if (!strcmp(value, "local"))
795 autorebase = AUTOREBASE_LOCAL;
796 else if (!strcmp(value, "remote"))
797 autorebase = AUTOREBASE_REMOTE;
798 else if (!strcmp(value, "always"))
799 autorebase = AUTOREBASE_ALWAYS;
801 return error("Malformed value for %s", var);
805 /* Add other config variables here and to Documentation/config.txt. */
809 static int git_default_push_config(const char *var, const char *value)
811 if (!strcmp(var, "push.default")) {
813 return config_error_nonbool(var);
814 else if (!strcmp(value, "nothing"))
815 push_default = PUSH_DEFAULT_NOTHING;
816 else if (!strcmp(value, "matching"))
817 push_default = PUSH_DEFAULT_MATCHING;
818 else if (!strcmp(value, "simple"))
819 push_default = PUSH_DEFAULT_SIMPLE;
820 else if (!strcmp(value, "upstream"))
821 push_default = PUSH_DEFAULT_UPSTREAM;
822 else if (!strcmp(value, "tracking")) /* deprecated */
823 push_default = PUSH_DEFAULT_UPSTREAM;
824 else if (!strcmp(value, "current"))
825 push_default = PUSH_DEFAULT_CURRENT;
827 error("Malformed value for %s: %s", var, value);
828 return error("Must be one of nothing, matching, simple, "
829 "upstream or current.");
834 /* Add other config variables here and to Documentation/config.txt. */
838 static int git_default_mailmap_config(const char *var, const char *value)
840 if (!strcmp(var, "mailmap.file"))
841 return git_config_string(&git_mailmap_file, var, value);
843 /* Add other config variables here and to Documentation/config.txt. */
847 int git_default_config(const char *var, const char *value, void *dummy)
849 if (!prefixcmp(var, "core."))
850 return git_default_core_config(var, value);
852 if (!prefixcmp(var, "user."))
853 return git_ident_config(var, value, dummy);
855 if (!prefixcmp(var, "i18n."))
856 return git_default_i18n_config(var, value);
858 if (!prefixcmp(var, "branch."))
859 return git_default_branch_config(var, value);
861 if (!prefixcmp(var, "push."))
862 return git_default_push_config(var, value);
864 if (!prefixcmp(var, "mailmap."))
865 return git_default_mailmap_config(var, value);
867 if (!prefixcmp(var, "advice."))
868 return git_default_advice_config(var, value);
870 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
871 pager_use_color = git_config_bool(var,value);
875 if (!strcmp(var, "pack.packsizelimit")) {
876 pack_size_limit_cfg = git_config_ulong(var, value);
879 /* Add other config variables here and to Documentation/config.txt. */
883 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
886 FILE *f = fopen(filename, "r");
892 /* push config-file parsing state stack */
898 strbuf_init(&top.value, 1024);
899 strbuf_init(&top.var, 1024);
902 ret = git_parse_file(fn, data);
904 /* pop config-file parsing state stack */
905 strbuf_release(&top.value);
906 strbuf_release(&top.var);
914 const char *git_etc_gitconfig(void)
916 static const char *system_wide;
918 system_wide = system_path(ETC_GITCONFIG);
922 int git_env_bool(const char *k, int def)
924 const char *v = getenv(k);
925 return v ? git_config_bool(k, v) : def;
928 int git_config_system(void)
930 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
933 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
935 int ret = 0, found = 0;
936 char *xdg_config = NULL;
937 char *user_config = NULL;
939 home_config_paths(&user_config, &xdg_config, "config");
941 if (git_config_system() && !access_or_warn(git_etc_gitconfig(), R_OK)) {
942 ret += git_config_from_file(fn, git_etc_gitconfig(),
947 if (xdg_config && !access_or_warn(xdg_config, R_OK)) {
948 ret += git_config_from_file(fn, xdg_config, data);
952 if (user_config && !access_or_warn(user_config, R_OK)) {
953 ret += git_config_from_file(fn, user_config, data);
957 if (repo_config && !access_or_warn(repo_config, R_OK)) {
958 ret += git_config_from_file(fn, repo_config, data);
962 switch (git_config_from_parameters(fn, data)) {
964 die("unable to parse command-line config");
966 case 0: /* found nothing */
968 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;
1283 return -CONFIG_INVALID_KEY;
1287 * If value==NULL, unset in (remove from) config,
1288 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1289 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1290 * else all matching key/values (regardless how many) are removed,
1291 * before the new pair is written.
1293 * Returns 0 on success.
1295 * This function does this:
1297 * - it locks the config file by creating ".git/config.lock"
1299 * - it then parses the config using store_aux() as validator to find
1300 * the position on the key/value pair to replace. If it is to be unset,
1301 * it must be found exactly once.
1303 * - the config file is mmap()ed and the part before the match (if any) is
1304 * written to the lock file, then the changed part and the rest.
1306 * - the config file is removed and the lock file rename()d to it.
1309 int git_config_set_multivar_in_file(const char *config_filename,
1310 const char *key, const char *value,
1311 const char *value_regex, int multi_replace)
1315 struct lock_file *lock = NULL;
1316 char *filename_buf = NULL;
1318 /* parse-key returns negative; flip the sign to feed exit(3) */
1319 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1323 store.multi_replace = multi_replace;
1325 if (!config_filename)
1326 config_filename = filename_buf = git_pathdup("config");
1329 * The lock serves a purpose in addition to locking: the new
1330 * contents of .git/config will be written into it.
1332 lock = xcalloc(sizeof(struct lock_file), 1);
1333 fd = hold_lock_file_for_update(lock, config_filename, 0);
1335 error("could not lock config file %s: %s", config_filename, strerror(errno));
1337 ret = CONFIG_NO_LOCK;
1342 * If .git/config does not exist yet, write a minimal version.
1344 in_fd = open(config_filename, O_RDONLY);
1348 if ( ENOENT != errno ) {
1349 error("opening %s: %s", config_filename,
1351 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1354 /* if nothing to unset, error out */
1355 if (value == NULL) {
1356 ret = CONFIG_NOTHING_SET;
1360 store.key = (char *)key;
1361 if (!store_write_section(fd, key) ||
1362 !store_write_pair(fd, key, value))
1367 size_t contents_sz, copy_begin, copy_end;
1368 int i, new_line = 0;
1370 if (value_regex == NULL)
1371 store.value_regex = NULL;
1373 if (value_regex[0] == '!') {
1374 store.do_not_match = 1;
1377 store.do_not_match = 0;
1379 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1380 if (regcomp(store.value_regex, value_regex,
1382 error("invalid pattern: %s", value_regex);
1383 free(store.value_regex);
1384 ret = CONFIG_INVALID_PATTERN;
1389 store.offset[0] = 0;
1390 store.state = START;
1394 * After this, store.offset will contain the *end* offset
1395 * of the last match, or remain at 0 if no match was found.
1396 * As a side effect, we make sure to transform only a valid
1397 * existing config file.
1399 if (git_config_from_file(store_aux, config_filename, NULL)) {
1400 error("invalid config file %s", config_filename);
1402 if (store.value_regex != NULL) {
1403 regfree(store.value_regex);
1404 free(store.value_regex);
1406 ret = CONFIG_INVALID_FILE;
1411 if (store.value_regex != NULL) {
1412 regfree(store.value_regex);
1413 free(store.value_regex);
1416 /* if nothing to unset, or too many matches, error out */
1417 if ((store.seen == 0 && value == NULL) ||
1418 (store.seen > 1 && multi_replace == 0)) {
1419 ret = CONFIG_NOTHING_SET;
1424 contents_sz = xsize_t(st.st_size);
1425 contents = xmmap(NULL, contents_sz, PROT_READ,
1426 MAP_PRIVATE, in_fd, 0);
1429 if (store.seen == 0)
1432 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1433 if (store.offset[i] == 0) {
1434 store.offset[i] = copy_end = contents_sz;
1435 } else if (store.state != KEY_SEEN) {
1436 copy_end = store.offset[i];
1438 copy_end = find_beginning_of_line(
1439 contents, contents_sz,
1440 store.offset[i]-2, &new_line);
1442 if (copy_end > 0 && contents[copy_end-1] != '\n')
1445 /* write the first part of the config */
1446 if (copy_end > copy_begin) {
1447 if (write_in_full(fd, contents + copy_begin,
1448 copy_end - copy_begin) <
1449 copy_end - copy_begin)
1452 write_str_in_full(fd, "\n") != 1)
1455 copy_begin = store.offset[i];
1458 /* write the pair (value == NULL means unset) */
1459 if (value != NULL) {
1460 if (store.state == START) {
1461 if (!store_write_section(fd, key))
1464 if (!store_write_pair(fd, key, value))
1468 /* write the rest of the config */
1469 if (copy_begin < contents_sz)
1470 if (write_in_full(fd, contents + copy_begin,
1471 contents_sz - copy_begin) <
1472 contents_sz - copy_begin)
1475 munmap(contents, contents_sz);
1478 if (commit_lock_file(lock) < 0) {
1479 error("could not commit config file %s", config_filename);
1480 ret = CONFIG_NO_WRITE;
1485 * lock is committed, so don't try to roll it back below.
1486 * NOTE: Since lockfile.c keeps a linked list of all created
1487 * lock_file structures, it isn't safe to free(lock). It's
1488 * better to just leave it hanging around.
1495 rollback_lock_file(lock);
1500 ret = write_error(lock->filename);
1505 int git_config_set_multivar(const char *key, const char *value,
1506 const char *value_regex, int multi_replace)
1508 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1512 static int section_name_match (const char *buf, const char *name)
1514 int i = 0, j = 0, dot = 0;
1517 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1518 if (!dot && isspace(buf[i])) {
1520 if (name[j++] != '.')
1522 for (i++; isspace(buf[i]); i++)
1528 if (buf[i] == '\\' && dot)
1530 else if (buf[i] == '"' && dot) {
1531 for (i++; isspace(buf[i]); i++)
1535 if (buf[i] != name[j++])
1538 if (buf[i] == ']' && name[j] == 0) {
1540 * We match, now just find the right length offset by
1541 * gobbling up any whitespace after it, as well
1544 for (; buf[i] && isspace(buf[i]); i++)
1551 static int section_name_is_ok(const char *name)
1553 /* Empty section names are bogus. */
1558 * Before a dot, we must be alphanumeric or dash. After the first dot,
1559 * anything goes, so we can stop checking.
1561 for (; *name && *name != '.'; name++)
1562 if (*name != '-' && !isalnum(*name))
1567 /* if new_name == NULL, the section is removed instead */
1568 int git_config_rename_section_in_file(const char *config_filename,
1569 const char *old_name, const char *new_name)
1571 int ret = 0, remove = 0;
1572 char *filename_buf = NULL;
1573 struct lock_file *lock;
1578 if (new_name && !section_name_is_ok(new_name)) {
1579 ret = error("invalid section name: %s", new_name);
1583 if (!config_filename)
1584 config_filename = filename_buf = git_pathdup("config");
1586 lock = xcalloc(sizeof(struct lock_file), 1);
1587 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1589 ret = error("could not lock config file %s", config_filename);
1593 if (!(config_file = fopen(config_filename, "rb"))) {
1594 /* no config file means nothing to rename, no error */
1595 goto unlock_and_out;
1598 while (fgets(buf, sizeof(buf), config_file)) {
1602 for (i = 0; buf[i] && isspace(buf[i]); i++)
1604 if (buf[i] == '[') {
1605 /* it's a section */
1606 int offset = section_name_match(&buf[i], old_name);
1609 if (new_name == NULL) {
1613 store.baselen = strlen(new_name);
1614 if (!store_write_section(out_fd, new_name)) {
1615 ret = write_error(lock->filename);
1619 * We wrote out the new section, with
1620 * a newline, now skip the old
1623 output += offset + i;
1624 if (strlen(output) > 0) {
1626 * More content means there's
1627 * a declaration to put on the
1628 * next line; indent with a
1639 length = strlen(output);
1640 if (write_in_full(out_fd, output, length) != length) {
1641 ret = write_error(lock->filename);
1645 fclose(config_file);
1647 if (commit_lock_file(lock) < 0)
1648 ret = error("could not commit config file %s", config_filename);
1654 int git_config_rename_section(const char *old_name, const char *new_name)
1656 return git_config_rename_section_in_file(NULL, old_name, new_name);
1660 * Call this to report error for your variable that should not
1661 * get a boolean value (i.e. "[my] var" means "true").
1663 int config_error_nonbool(const char *var)
1665 return error("Missing value for '%s'", var);