2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
13 static FILE *config_file;
14 static const char *config_file_name;
15 static int config_linenr;
16 static int config_file_eof;
17 static int zlib_compression_seen;
19 const char *config_exclusive_filename = NULL;
21 static int get_next_char(void)
27 if ((f = config_file) != NULL) {
30 /* DOS like systems */
47 static char *parse_value(void)
49 static char value[1024];
50 int quote = 0, comment = 0, len = 0, space = 0;
53 int c = get_next_char();
54 if (len >= sizeof(value))
64 if (isspace(c) && !quote) {
69 if (c == ';' || c == '#') {
93 /* Some characters escape as themselves */
96 /* Reject unknown escape sequences */
111 static inline int iskeychar(int c)
113 return isalnum(c) || c == '-';
116 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
121 /* Get the full name */
128 name[len++] = tolower(c);
133 while (c == ' ' || c == '\t')
140 value = parse_value();
144 return fn(name, value, data);
147 static int get_extended_base_var(char *name, int baselen, int c)
153 } while (isspace(c));
155 /* We require the format to be '[base "extension"]' */
158 name[baselen++] = '.';
161 int c = get_next_char();
172 if (baselen > MAXNAME / 2)
177 if (get_next_char() != ']')
182 static int get_base_var(char *name)
187 int c = get_next_char();
193 return get_extended_base_var(name, baselen, c);
194 if (!iskeychar(c) && c != '.')
196 if (baselen > MAXNAME / 2)
198 name[baselen++] = tolower(c);
202 static int git_parse_file(config_fn_t fn, void *data)
206 static char var[MAXNAME];
208 /* U+FEFF Byte Order Mark in UTF8 */
209 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
210 const unsigned char *bomptr = utf8_bom;
213 int c = get_next_char();
214 if (bomptr && *bomptr) {
215 /* We are at the file beginning; skip UTF8-encoded BOM
216 * if present. Sane editors won't put this in on their
217 * own, but e.g. Windows Notepad will do it happily. */
218 if ((unsigned char) c == *bomptr) {
222 /* Do not tolerate partial BOM. */
223 if (bomptr != utf8_bom)
225 /* No BOM at file beginning. Cool. */
235 if (comment || isspace(c))
237 if (c == '#' || c == ';') {
242 baselen = get_base_var(var);
245 var[baselen++] = '.';
251 var[baselen] = tolower(c);
252 if (get_value(fn, data, var, baselen+1) < 0)
255 die("bad config file line %d in %s", config_linenr, config_file_name);
258 static int parse_unit_factor(const char *end, unsigned long *val)
262 else if (!strcasecmp(end, "k")) {
266 else if (!strcasecmp(end, "m")) {
270 else if (!strcasecmp(end, "g")) {
271 *val *= 1024 * 1024 * 1024;
277 static int git_parse_long(const char *value, long *ret)
279 if (value && *value) {
281 long val = strtol(value, &end, 0);
282 unsigned long factor = 1;
283 if (!parse_unit_factor(end, &factor))
291 int git_parse_ulong(const char *value, unsigned long *ret)
293 if (value && *value) {
295 unsigned long val = strtoul(value, &end, 0);
296 if (!parse_unit_factor(end, &val))
304 static void die_bad_config(const char *name)
306 if (config_file_name)
307 die("bad config value for '%s' in %s", name, config_file_name);
308 die("bad config value for '%s'", name);
311 int git_config_int(const char *name, const char *value)
314 if (!git_parse_long(value, &ret))
315 die_bad_config(name);
319 unsigned long git_config_ulong(const char *name, const char *value)
322 if (!git_parse_ulong(value, &ret))
323 die_bad_config(name);
327 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
334 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
336 if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
339 return git_config_int(name, value);
342 int git_config_bool(const char *name, const char *value)
345 return !!git_config_bool_or_int(name, value, &discard);
348 int git_config_string(const char **dest, const char *var, const char *value)
351 return config_error_nonbool(var);
352 *dest = xstrdup(value);
356 static int git_default_core_config(const char *var, const char *value)
358 /* This needs a better name */
359 if (!strcmp(var, "core.filemode")) {
360 trust_executable_bit = git_config_bool(var, value);
363 if (!strcmp(var, "core.trustctime")) {
364 trust_ctime = git_config_bool(var, value);
368 if (!strcmp(var, "core.quotepath")) {
369 quote_path_fully = git_config_bool(var, value);
373 if (!strcmp(var, "core.symlinks")) {
374 has_symlinks = git_config_bool(var, value);
378 if (!strcmp(var, "core.ignorecase")) {
379 ignore_case = git_config_bool(var, value);
383 if (!strcmp(var, "core.bare")) {
384 is_bare_repository_cfg = git_config_bool(var, value);
388 if (!strcmp(var, "core.ignorestat")) {
389 assume_unchanged = git_config_bool(var, value);
393 if (!strcmp(var, "core.prefersymlinkrefs")) {
394 prefer_symlink_refs = git_config_bool(var, value);
398 if (!strcmp(var, "core.logallrefupdates")) {
399 log_all_ref_updates = git_config_bool(var, value);
403 if (!strcmp(var, "core.warnambiguousrefs")) {
404 warn_ambiguous_refs = git_config_bool(var, value);
408 if (!strcmp(var, "core.loosecompression")) {
409 int level = git_config_int(var, value);
411 level = Z_DEFAULT_COMPRESSION;
412 else if (level < 0 || level > Z_BEST_COMPRESSION)
413 die("bad zlib compression level %d", level);
414 zlib_compression_level = level;
415 zlib_compression_seen = 1;
419 if (!strcmp(var, "core.compression")) {
420 int level = git_config_int(var, value);
422 level = Z_DEFAULT_COMPRESSION;
423 else if (level < 0 || level > Z_BEST_COMPRESSION)
424 die("bad zlib compression level %d", level);
425 core_compression_level = level;
426 core_compression_seen = 1;
427 if (!zlib_compression_seen)
428 zlib_compression_level = level;
432 if (!strcmp(var, "core.packedgitwindowsize")) {
433 int pgsz_x2 = getpagesize() * 2;
434 packed_git_window_size = git_config_int(var, value);
436 /* This value must be multiple of (pagesize * 2) */
437 packed_git_window_size /= pgsz_x2;
438 if (packed_git_window_size < 1)
439 packed_git_window_size = 1;
440 packed_git_window_size *= pgsz_x2;
444 if (!strcmp(var, "core.packedgitlimit")) {
445 packed_git_limit = git_config_int(var, value);
449 if (!strcmp(var, "core.deltabasecachelimit")) {
450 delta_base_cache_limit = git_config_int(var, value);
454 if (!strcmp(var, "core.autocrlf")) {
455 if (value && !strcasecmp(value, "input")) {
459 auto_crlf = git_config_bool(var, value);
463 if (!strcmp(var, "core.safecrlf")) {
464 if (value && !strcasecmp(value, "warn")) {
465 safe_crlf = SAFE_CRLF_WARN;
468 safe_crlf = git_config_bool(var, value);
472 if (!strcmp(var, "core.notesref")) {
473 notes_ref_name = xstrdup(value);
477 if (!strcmp(var, "core.pager"))
478 return git_config_string(&pager_program, var, value);
480 if (!strcmp(var, "core.editor"))
481 return git_config_string(&editor_program, var, value);
483 if (!strcmp(var, "core.excludesfile"))
484 return git_config_string(&excludes_file, var, value);
486 if (!strcmp(var, "core.whitespace")) {
488 return config_error_nonbool(var);
489 whitespace_rule_cfg = parse_whitespace_rule(value);
493 if (!strcmp(var, "core.fsyncobjectfiles")) {
494 fsync_object_files = git_config_bool(var, value);
498 if (!strcmp(var, "core.preloadindex")) {
499 core_preload_index = git_config_bool(var, value);
503 /* Add other config variables here and to Documentation/config.txt. */
507 static int git_default_user_config(const char *var, const char *value)
509 if (!strcmp(var, "user.name")) {
511 return config_error_nonbool(var);
512 strlcpy(git_default_name, value, sizeof(git_default_name));
513 if (git_default_email[0])
514 user_ident_explicitly_given = 1;
518 if (!strcmp(var, "user.email")) {
520 return config_error_nonbool(var);
521 strlcpy(git_default_email, value, sizeof(git_default_email));
522 if (git_default_name[0])
523 user_ident_explicitly_given = 1;
527 /* Add other config variables here and to Documentation/config.txt. */
531 static int git_default_i18n_config(const char *var, const char *value)
533 if (!strcmp(var, "i18n.commitencoding"))
534 return git_config_string(&git_commit_encoding, var, value);
536 if (!strcmp(var, "i18n.logoutputencoding"))
537 return git_config_string(&git_log_output_encoding, var, value);
539 /* Add other config variables here and to Documentation/config.txt. */
543 static int git_default_branch_config(const char *var, const char *value)
545 if (!strcmp(var, "branch.autosetupmerge")) {
546 if (value && !strcasecmp(value, "always")) {
547 git_branch_track = BRANCH_TRACK_ALWAYS;
550 git_branch_track = git_config_bool(var, value);
553 if (!strcmp(var, "branch.autosetuprebase")) {
555 return config_error_nonbool(var);
556 else if (!strcmp(value, "never"))
557 autorebase = AUTOREBASE_NEVER;
558 else if (!strcmp(value, "local"))
559 autorebase = AUTOREBASE_LOCAL;
560 else if (!strcmp(value, "remote"))
561 autorebase = AUTOREBASE_REMOTE;
562 else if (!strcmp(value, "always"))
563 autorebase = AUTOREBASE_ALWAYS;
565 return error("Malformed value for %s", var);
569 /* Add other config variables here and to Documentation/config.txt. */
573 int git_default_config(const char *var, const char *value, void *dummy)
575 if (!prefixcmp(var, "core."))
576 return git_default_core_config(var, value);
578 if (!prefixcmp(var, "user."))
579 return git_default_user_config(var, value);
581 if (!prefixcmp(var, "i18n."))
582 return git_default_i18n_config(var, value);
584 if (!prefixcmp(var, "branch."))
585 return git_default_branch_config(var, value);
587 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
588 pager_use_color = git_config_bool(var,value);
592 /* Add other config variables here and to Documentation/config.txt. */
596 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
599 FILE *f = fopen(filename, "r");
604 config_file_name = filename;
607 ret = git_parse_file(fn, data);
609 config_file_name = NULL;
614 const char *git_etc_gitconfig(void)
616 static const char *system_wide;
618 system_wide = system_path(ETC_GITCONFIG);
622 static int git_env_bool(const char *k, int def)
624 const char *v = getenv(k);
625 return v ? git_config_bool(k, v) : def;
628 int git_config_system(void)
630 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
633 int git_config_global(void)
635 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
638 int git_config(config_fn_t fn, void *data)
640 int ret = 0, found = 0;
641 char *repo_config = NULL;
642 const char *home = NULL;
644 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
645 if (config_exclusive_filename)
646 return git_config_from_file(fn, config_exclusive_filename, data);
647 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
648 ret += git_config_from_file(fn, git_etc_gitconfig(),
653 home = getenv("HOME");
654 if (git_config_global() && home) {
655 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
656 if (!access(user_config, R_OK)) {
657 ret += git_config_from_file(fn, user_config, data);
663 repo_config = git_pathdup("config");
664 if (!access(repo_config, R_OK)) {
665 ret += git_config_from_file(fn, repo_config, data);
675 * Find all the stuff for git_config_set() below.
678 #define MAX_MATCHES 512
684 regex_t* value_regex;
686 size_t offset[MAX_MATCHES];
687 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
691 static int matches(const char* key, const char* value)
693 return !strcmp(key, store.key) &&
694 (store.value_regex == NULL ||
695 (store.do_not_match ^
696 !regexec(store.value_regex, value, 0, NULL, 0)));
699 static int store_aux(const char* key, const char* value, void *cb)
704 switch (store.state) {
706 if (matches(key, value)) {
707 if (store.seen == 1 && store.multi_replace == 0) {
708 warning("%s has multiple values", key);
709 } else if (store.seen >= MAX_MATCHES) {
710 error("too many matches for %s", key);
714 store.offset[store.seen] = ftell(config_file);
720 * What we are looking for is in store.key (both
721 * section and var), and its section part is baselen
722 * long. We found key (again, both section and var).
723 * We would want to know if this key is in the same
724 * section as what we are looking for. We already
725 * know we are in the same section as what should
728 ep = strrchr(key, '.');
729 section_len = ep - key;
731 if ((section_len != store.baselen) ||
732 memcmp(key, store.key, section_len+1)) {
733 store.state = SECTION_END_SEEN;
738 * Do not increment matches: this is no match, but we
739 * just made sure we are in the desired section.
741 store.offset[store.seen] = ftell(config_file);
743 case SECTION_END_SEEN:
745 if (matches(key, value)) {
746 store.offset[store.seen] = ftell(config_file);
747 store.state = KEY_SEEN;
750 if (strrchr(key, '.') - key == store.baselen &&
751 !strncmp(key, store.key, store.baselen)) {
752 store.state = SECTION_SEEN;
753 store.offset[store.seen] = ftell(config_file);
760 static int write_error(const char *filename)
762 error("failed to write new configuration file %s", filename);
764 /* Same error code as "failed to rename". */
768 static int store_write_section(int fd, const char* key)
772 struct strbuf sb = STRBUF_INIT;
774 dot = memchr(key, '.', store.baselen);
776 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
777 for (i = dot - key + 1; i < store.baselen; i++) {
778 if (key[i] == '"' || key[i] == '\\')
779 strbuf_addch(&sb, '\\');
780 strbuf_addch(&sb, key[i]);
782 strbuf_addstr(&sb, "\"]\n");
784 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
787 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
793 static int store_write_pair(int fd, const char* key, const char* value)
796 int length = strlen(key + store.baselen + 1);
797 const char *quote = "";
798 struct strbuf sb = STRBUF_INIT;
801 * Check to see if the value needs to be surrounded with a dq pair.
802 * Note that problematic characters are always backslash-quoted; this
803 * check is about not losing leading or trailing SP and strings that
804 * follow beginning-of-comment characters (i.e. ';' and '#') by the
805 * configuration parser.
809 for (i = 0; value[i]; i++)
810 if (value[i] == ';' || value[i] == '#')
812 if (i && value[i - 1] == ' ')
815 strbuf_addf(&sb, "\t%.*s = %s",
816 length, key + store.baselen + 1, quote);
818 for (i = 0; value[i]; i++)
821 strbuf_addstr(&sb, "\\n");
824 strbuf_addstr(&sb, "\\t");
828 strbuf_addch(&sb, '\\');
830 strbuf_addch(&sb, value[i]);
833 strbuf_addf(&sb, "%s\n", quote);
835 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
841 static ssize_t find_beginning_of_line(const char* contents, size_t size,
842 size_t offset_, int* found_bracket)
844 size_t equal_offset = size, bracket_offset = size;
848 for (offset = offset_-2; offset > 0
849 && contents[offset] != '\n'; offset--)
850 switch (contents[offset]) {
851 case '=': equal_offset = offset; break;
852 case ']': bracket_offset = offset; break;
854 if (offset > 0 && contents[offset-1] == '\\') {
858 if (bracket_offset < equal_offset) {
860 offset = bracket_offset+1;
867 int git_config_set(const char* key, const char* value)
869 return git_config_set_multivar(key, value, NULL, 0);
873 * If value==NULL, unset in (remove from) config,
874 * if value_regex!=NULL, disregard key/value pairs where value does not match.
875 * if multi_replace==0, nothing, or only one matching key/value is replaced,
876 * else all matching key/values (regardless how many) are removed,
877 * before the new pair is written.
879 * Returns 0 on success.
881 * This function does this:
883 * - it locks the config file by creating ".git/config.lock"
885 * - it then parses the config using store_aux() as validator to find
886 * the position on the key/value pair to replace. If it is to be unset,
887 * it must be found exactly once.
889 * - the config file is mmap()ed and the part before the match (if any) is
890 * written to the lock file, then the changed part and the rest.
892 * - the config file is removed and the lock file rename()d to it.
895 int git_config_set_multivar(const char* key, const char* value,
896 const char* value_regex, int multi_replace)
901 char* config_filename;
902 struct lock_file *lock = NULL;
903 const char* last_dot = strrchr(key, '.');
905 if (config_exclusive_filename)
906 config_filename = xstrdup(config_exclusive_filename);
908 config_filename = git_pathdup("config");
911 * Since "key" actually contains the section name and the real
912 * key name separated by a dot, we have to know where the dot is.
915 if (last_dot == NULL) {
916 error("key does not contain a section: %s", key);
920 store.baselen = last_dot - key;
922 store.multi_replace = multi_replace;
925 * Validate the key and while at it, lower case it for matching.
927 store.key = xmalloc(strlen(key) + 1);
929 for (i = 0; key[i]; i++) {
930 unsigned char c = key[i];
933 /* Leave the extended basename untouched.. */
934 if (!dot || i > store.baselen) {
935 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
936 error("invalid key: %s", key);
942 } else if (c == '\n') {
943 error("invalid key (newline): %s", key);
953 * The lock serves a purpose in addition to locking: the new
954 * contents of .git/config will be written into it.
956 lock = xcalloc(sizeof(struct lock_file), 1);
957 fd = hold_lock_file_for_update(lock, config_filename, 0);
959 error("could not lock config file %s", config_filename);
966 * If .git/config does not exist yet, write a minimal version.
968 in_fd = open(config_filename, O_RDONLY);
972 if ( ENOENT != errno ) {
973 error("opening %s: %s", config_filename,
975 ret = 3; /* same as "invalid config file" */
978 /* if nothing to unset, error out */
984 store.key = (char*)key;
985 if (!store_write_section(fd, key) ||
986 !store_write_pair(fd, key, value))
991 size_t contents_sz, copy_begin, copy_end;
994 if (value_regex == NULL)
995 store.value_regex = NULL;
997 if (value_regex[0] == '!') {
998 store.do_not_match = 1;
1001 store.do_not_match = 0;
1003 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1004 if (regcomp(store.value_regex, value_regex,
1006 error("invalid pattern: %s", value_regex);
1007 free(store.value_regex);
1013 store.offset[0] = 0;
1014 store.state = START;
1018 * After this, store.offset will contain the *end* offset
1019 * of the last match, or remain at 0 if no match was found.
1020 * As a side effect, we make sure to transform only a valid
1021 * existing config file.
1023 if (git_config_from_file(store_aux, config_filename, NULL)) {
1024 error("invalid config file %s", config_filename);
1026 if (store.value_regex != NULL) {
1027 regfree(store.value_regex);
1028 free(store.value_regex);
1035 if (store.value_regex != NULL) {
1036 regfree(store.value_regex);
1037 free(store.value_regex);
1040 /* if nothing to unset, or too many matches, error out */
1041 if ((store.seen == 0 && value == NULL) ||
1042 (store.seen > 1 && multi_replace == 0)) {
1048 contents_sz = xsize_t(st.st_size);
1049 contents = xmmap(NULL, contents_sz, PROT_READ,
1050 MAP_PRIVATE, in_fd, 0);
1053 if (store.seen == 0)
1056 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1057 if (store.offset[i] == 0) {
1058 store.offset[i] = copy_end = contents_sz;
1059 } else if (store.state != KEY_SEEN) {
1060 copy_end = store.offset[i];
1062 copy_end = find_beginning_of_line(
1063 contents, contents_sz,
1064 store.offset[i]-2, &new_line);
1066 if (copy_end > 0 && contents[copy_end-1] != '\n')
1069 /* write the first part of the config */
1070 if (copy_end > copy_begin) {
1071 if (write_in_full(fd, contents + copy_begin,
1072 copy_end - copy_begin) <
1073 copy_end - copy_begin)
1076 write_in_full(fd, "\n", 1) != 1)
1079 copy_begin = store.offset[i];
1082 /* write the pair (value == NULL means unset) */
1083 if (value != NULL) {
1084 if (store.state == START) {
1085 if (!store_write_section(fd, key))
1088 if (!store_write_pair(fd, key, value))
1092 /* write the rest of the config */
1093 if (copy_begin < contents_sz)
1094 if (write_in_full(fd, contents + copy_begin,
1095 contents_sz - copy_begin) <
1096 contents_sz - copy_begin)
1099 munmap(contents, contents_sz);
1102 if (commit_lock_file(lock) < 0) {
1103 error("could not commit config file %s", config_filename);
1109 * lock is committed, so don't try to roll it back below.
1110 * NOTE: Since lockfile.c keeps a linked list of all created
1111 * lock_file structures, it isn't safe to free(lock). It's
1112 * better to just leave it hanging around.
1119 rollback_lock_file(lock);
1120 free(config_filename);
1124 ret = write_error(lock->filename);
1129 static int section_name_match (const char *buf, const char *name)
1131 int i = 0, j = 0, dot = 0;
1132 for (; buf[i] && buf[i] != ']'; i++) {
1133 if (!dot && isspace(buf[i])) {
1135 if (name[j++] != '.')
1137 for (i++; isspace(buf[i]); i++)
1143 if (buf[i] == '\\' && dot)
1145 else if (buf[i] == '"' && dot) {
1146 for (i++; isspace(buf[i]); i++)
1150 if (buf[i] != name[j++])
1153 return (buf[i] == ']' && name[j] == 0);
1156 /* if new_name == NULL, the section is removed instead */
1157 int git_config_rename_section(const char *old_name, const char *new_name)
1159 int ret = 0, remove = 0;
1160 char *config_filename;
1161 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1165 if (config_exclusive_filename)
1166 config_filename = xstrdup(config_exclusive_filename);
1168 config_filename = git_pathdup("config");
1169 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1171 ret = error("could not lock config file %s", config_filename);
1175 if (!(config_file = fopen(config_filename, "rb"))) {
1176 /* no config file means nothing to rename, no error */
1177 goto unlock_and_out;
1180 while (fgets(buf, sizeof(buf), config_file)) {
1183 for (i = 0; buf[i] && isspace(buf[i]); i++)
1185 if (buf[i] == '[') {
1186 /* it's a section */
1187 if (section_name_match (&buf[i+1], old_name)) {
1189 if (new_name == NULL) {
1193 store.baselen = strlen(new_name);
1194 if (!store_write_section(out_fd, new_name)) {
1195 ret = write_error(lock->filename);
1204 length = strlen(buf);
1205 if (write_in_full(out_fd, buf, length) != length) {
1206 ret = write_error(lock->filename);
1210 fclose(config_file);
1212 if (commit_lock_file(lock) < 0)
1213 ret = error("could not commit config file %s", config_filename);
1215 free(config_filename);
1220 * Call this to report error for your variable that should not
1221 * get a boolean value (i.e. "[my] var" means "true").
1223 int config_error_nonbool(const char *var)
1225 return error("Missing value for '%s'", var);