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.pager"))
473 return git_config_string(&pager_program, var, value);
475 if (!strcmp(var, "core.editor"))
476 return git_config_string(&editor_program, var, value);
478 if (!strcmp(var, "core.excludesfile"))
479 return git_config_string(&excludes_file, var, value);
481 if (!strcmp(var, "core.whitespace")) {
483 return config_error_nonbool(var);
484 whitespace_rule_cfg = parse_whitespace_rule(value);
488 if (!strcmp(var, "core.fsyncobjectfiles")) {
489 fsync_object_files = git_config_bool(var, value);
493 /* Add other config variables here and to Documentation/config.txt. */
497 static int git_default_user_config(const char *var, const char *value)
499 if (!strcmp(var, "user.name")) {
501 return config_error_nonbool(var);
502 strlcpy(git_default_name, value, sizeof(git_default_name));
503 if (git_default_email[0])
504 user_ident_explicitly_given = 1;
508 if (!strcmp(var, "user.email")) {
510 return config_error_nonbool(var);
511 strlcpy(git_default_email, value, sizeof(git_default_email));
512 if (git_default_name[0])
513 user_ident_explicitly_given = 1;
517 /* Add other config variables here and to Documentation/config.txt. */
521 static int git_default_i18n_config(const char *var, const char *value)
523 if (!strcmp(var, "i18n.commitencoding"))
524 return git_config_string(&git_commit_encoding, var, value);
526 if (!strcmp(var, "i18n.logoutputencoding"))
527 return git_config_string(&git_log_output_encoding, var, value);
529 /* Add other config variables here and to Documentation/config.txt. */
533 static int git_default_branch_config(const char *var, const char *value)
535 if (!strcmp(var, "branch.autosetupmerge")) {
536 if (value && !strcasecmp(value, "always")) {
537 git_branch_track = BRANCH_TRACK_ALWAYS;
540 git_branch_track = git_config_bool(var, value);
543 if (!strcmp(var, "branch.autosetuprebase")) {
545 return config_error_nonbool(var);
546 else if (!strcmp(value, "never"))
547 autorebase = AUTOREBASE_NEVER;
548 else if (!strcmp(value, "local"))
549 autorebase = AUTOREBASE_LOCAL;
550 else if (!strcmp(value, "remote"))
551 autorebase = AUTOREBASE_REMOTE;
552 else if (!strcmp(value, "always"))
553 autorebase = AUTOREBASE_ALWAYS;
555 return error("Malformed value for %s", var);
559 /* Add other config variables here and to Documentation/config.txt. */
563 int git_default_config(const char *var, const char *value, void *dummy)
565 if (!prefixcmp(var, "core."))
566 return git_default_core_config(var, value);
568 if (!prefixcmp(var, "user."))
569 return git_default_user_config(var, value);
571 if (!prefixcmp(var, "i18n."))
572 return git_default_i18n_config(var, value);
574 if (!prefixcmp(var, "branch."))
575 return git_default_branch_config(var, value);
577 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
578 pager_use_color = git_config_bool(var,value);
582 /* Add other config variables here and to Documentation/config.txt. */
586 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
589 FILE *f = fopen(filename, "r");
594 config_file_name = filename;
597 ret = git_parse_file(fn, data);
599 config_file_name = NULL;
604 const char *git_etc_gitconfig(void)
606 static const char *system_wide;
608 system_wide = system_path(ETC_GITCONFIG);
612 static int git_env_bool(const char *k, int def)
614 const char *v = getenv(k);
615 return v ? git_config_bool(k, v) : def;
618 int git_config_system(void)
620 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
623 int git_config_global(void)
625 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
628 int git_config(config_fn_t fn, void *data)
631 char *repo_config = NULL;
632 const char *home = NULL;
634 /* $GIT_CONFIG makes git read _only_ the given config file,
635 * $GIT_CONFIG_LOCAL will make it process it in addition to the
636 * global config file, the same way it would the per-repository
637 * config file otherwise. */
638 if (config_exclusive_filename)
639 return git_config_from_file(fn, config_exclusive_filename, data);
640 if (git_config_system() && !access(git_etc_gitconfig(), R_OK))
641 ret += git_config_from_file(fn, git_etc_gitconfig(),
644 home = getenv("HOME");
645 if (git_config_global() && home) {
646 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
647 if (!access(user_config, R_OK))
648 ret += git_config_from_file(fn, user_config, data);
652 repo_config = xstrdup(git_path("config"));
653 ret += git_config_from_file(fn, repo_config, data);
659 * Find all the stuff for git_config_set() below.
662 #define MAX_MATCHES 512
668 regex_t* value_regex;
670 size_t offset[MAX_MATCHES];
671 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
675 static int matches(const char* key, const char* value)
677 return !strcmp(key, store.key) &&
678 (store.value_regex == NULL ||
679 (store.do_not_match ^
680 !regexec(store.value_regex, value, 0, NULL, 0)));
683 static int store_aux(const char* key, const char* value, void *cb)
688 switch (store.state) {
690 if (matches(key, value)) {
691 if (store.seen == 1 && store.multi_replace == 0) {
692 warning("%s has multiple values", key);
693 } else if (store.seen >= MAX_MATCHES) {
694 error("too many matches for %s", key);
698 store.offset[store.seen] = ftell(config_file);
704 * What we are looking for is in store.key (both
705 * section and var), and its section part is baselen
706 * long. We found key (again, both section and var).
707 * We would want to know if this key is in the same
708 * section as what we are looking for. We already
709 * know we are in the same section as what should
712 ep = strrchr(key, '.');
713 section_len = ep - key;
715 if ((section_len != store.baselen) ||
716 memcmp(key, store.key, section_len+1)) {
717 store.state = SECTION_END_SEEN;
722 * Do not increment matches: this is no match, but we
723 * just made sure we are in the desired section.
725 store.offset[store.seen] = ftell(config_file);
727 case SECTION_END_SEEN:
729 if (matches(key, value)) {
730 store.offset[store.seen] = ftell(config_file);
731 store.state = KEY_SEEN;
734 if (strrchr(key, '.') - key == store.baselen &&
735 !strncmp(key, store.key, store.baselen)) {
736 store.state = SECTION_SEEN;
737 store.offset[store.seen] = ftell(config_file);
744 static int write_error(const char *filename)
746 error("failed to write new configuration file %s", filename);
748 /* Same error code as "failed to rename". */
752 static int store_write_section(int fd, const char* key)
759 dot = memchr(key, '.', store.baselen);
761 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
762 for (i = dot - key + 1; i < store.baselen; i++) {
763 if (key[i] == '"' || key[i] == '\\')
764 strbuf_addch(&sb, '\\');
765 strbuf_addch(&sb, key[i]);
767 strbuf_addstr(&sb, "\"]\n");
769 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
772 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
778 static int store_write_pair(int fd, const char* key, const char* value)
781 int length = strlen(key + store.baselen + 1);
782 const char *quote = "";
786 * Check to see if the value needs to be surrounded with a dq pair.
787 * Note that problematic characters are always backslash-quoted; this
788 * check is about not losing leading or trailing SP and strings that
789 * follow beginning-of-comment characters (i.e. ';' and '#') by the
790 * configuration parser.
794 for (i = 0; value[i]; i++)
795 if (value[i] == ';' || value[i] == '#')
797 if (i && value[i - 1] == ' ')
801 strbuf_addf(&sb, "\t%.*s = %s",
802 length, key + store.baselen + 1, quote);
804 for (i = 0; value[i]; i++)
807 strbuf_addstr(&sb, "\\n");
810 strbuf_addstr(&sb, "\\t");
814 strbuf_addch(&sb, '\\');
816 strbuf_addch(&sb, value[i]);
819 strbuf_addf(&sb, "%s\n", quote);
821 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
827 static ssize_t find_beginning_of_line(const char* contents, size_t size,
828 size_t offset_, int* found_bracket)
830 size_t equal_offset = size, bracket_offset = size;
834 for (offset = offset_-2; offset > 0
835 && contents[offset] != '\n'; offset--)
836 switch (contents[offset]) {
837 case '=': equal_offset = offset; break;
838 case ']': bracket_offset = offset; break;
840 if (offset > 0 && contents[offset-1] == '\\') {
844 if (bracket_offset < equal_offset) {
846 offset = bracket_offset+1;
853 int git_config_set(const char* key, const char* value)
855 return git_config_set_multivar(key, value, NULL, 0);
859 * If value==NULL, unset in (remove from) config,
860 * if value_regex!=NULL, disregard key/value pairs where value does not match.
861 * if multi_replace==0, nothing, or only one matching key/value is replaced,
862 * else all matching key/values (regardless how many) are removed,
863 * before the new pair is written.
865 * Returns 0 on success.
867 * This function does this:
869 * - it locks the config file by creating ".git/config.lock"
871 * - it then parses the config using store_aux() as validator to find
872 * the position on the key/value pair to replace. If it is to be unset,
873 * it must be found exactly once.
875 * - the config file is mmap()ed and the part before the match (if any) is
876 * written to the lock file, then the changed part and the rest.
878 * - the config file is removed and the lock file rename()d to it.
881 int git_config_set_multivar(const char* key, const char* value,
882 const char* value_regex, int multi_replace)
887 char* config_filename;
888 struct lock_file *lock = NULL;
889 const char* last_dot = strrchr(key, '.');
891 if (config_exclusive_filename)
892 config_filename = xstrdup(config_exclusive_filename);
894 config_filename = xstrdup(git_path("config"));
897 * Since "key" actually contains the section name and the real
898 * key name separated by a dot, we have to know where the dot is.
901 if (last_dot == NULL) {
902 error("key does not contain a section: %s", key);
906 store.baselen = last_dot - key;
908 store.multi_replace = multi_replace;
911 * Validate the key and while at it, lower case it for matching.
913 store.key = xmalloc(strlen(key) + 1);
915 for (i = 0; key[i]; i++) {
916 unsigned char c = key[i];
919 /* Leave the extended basename untouched.. */
920 if (!dot || i > store.baselen) {
921 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
922 error("invalid key: %s", key);
928 } else if (c == '\n') {
929 error("invalid key (newline): %s", key);
939 * The lock serves a purpose in addition to locking: the new
940 * contents of .git/config will be written into it.
942 lock = xcalloc(sizeof(struct lock_file), 1);
943 fd = hold_lock_file_for_update(lock, config_filename, 0);
945 error("could not lock config file %s", config_filename);
952 * If .git/config does not exist yet, write a minimal version.
954 in_fd = open(config_filename, O_RDONLY);
958 if ( ENOENT != errno ) {
959 error("opening %s: %s", config_filename,
961 ret = 3; /* same as "invalid config file" */
964 /* if nothing to unset, error out */
970 store.key = (char*)key;
971 if (!store_write_section(fd, key) ||
972 !store_write_pair(fd, key, value))
977 size_t contents_sz, copy_begin, copy_end;
980 if (value_regex == NULL)
981 store.value_regex = NULL;
983 if (value_regex[0] == '!') {
984 store.do_not_match = 1;
987 store.do_not_match = 0;
989 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
990 if (regcomp(store.value_regex, value_regex,
992 error("invalid pattern: %s", value_regex);
993 free(store.value_regex);
1000 store.state = START;
1004 * After this, store.offset will contain the *end* offset
1005 * of the last match, or remain at 0 if no match was found.
1006 * As a side effect, we make sure to transform only a valid
1007 * existing config file.
1009 if (git_config_from_file(store_aux, config_filename, NULL)) {
1010 error("invalid config file %s", config_filename);
1012 if (store.value_regex != NULL) {
1013 regfree(store.value_regex);
1014 free(store.value_regex);
1021 if (store.value_regex != NULL) {
1022 regfree(store.value_regex);
1023 free(store.value_regex);
1026 /* if nothing to unset, or too many matches, error out */
1027 if ((store.seen == 0 && value == NULL) ||
1028 (store.seen > 1 && multi_replace == 0)) {
1034 contents_sz = xsize_t(st.st_size);
1035 contents = xmmap(NULL, contents_sz, PROT_READ,
1036 MAP_PRIVATE, in_fd, 0);
1039 if (store.seen == 0)
1042 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1043 if (store.offset[i] == 0) {
1044 store.offset[i] = copy_end = contents_sz;
1045 } else if (store.state != KEY_SEEN) {
1046 copy_end = store.offset[i];
1048 copy_end = find_beginning_of_line(
1049 contents, contents_sz,
1050 store.offset[i]-2, &new_line);
1052 if (copy_end > 0 && contents[copy_end-1] != '\n')
1055 /* write the first part of the config */
1056 if (copy_end > copy_begin) {
1057 if (write_in_full(fd, contents + copy_begin,
1058 copy_end - copy_begin) <
1059 copy_end - copy_begin)
1062 write_in_full(fd, "\n", 1) != 1)
1065 copy_begin = store.offset[i];
1068 /* write the pair (value == NULL means unset) */
1069 if (value != NULL) {
1070 if (store.state == START) {
1071 if (!store_write_section(fd, key))
1074 if (!store_write_pair(fd, key, value))
1078 /* write the rest of the config */
1079 if (copy_begin < contents_sz)
1080 if (write_in_full(fd, contents + copy_begin,
1081 contents_sz - copy_begin) <
1082 contents_sz - copy_begin)
1085 munmap(contents, contents_sz);
1088 if (commit_lock_file(lock) < 0) {
1089 error("could not commit config file %s", config_filename);
1095 * lock is committed, so don't try to roll it back below.
1096 * NOTE: Since lockfile.c keeps a linked list of all created
1097 * lock_file structures, it isn't safe to free(lock). It's
1098 * better to just leave it hanging around.
1105 rollback_lock_file(lock);
1106 free(config_filename);
1110 ret = write_error(lock->filename);
1115 static int section_name_match (const char *buf, const char *name)
1117 int i = 0, j = 0, dot = 0;
1118 for (; buf[i] && buf[i] != ']'; i++) {
1119 if (!dot && isspace(buf[i])) {
1121 if (name[j++] != '.')
1123 for (i++; isspace(buf[i]); i++)
1129 if (buf[i] == '\\' && dot)
1131 else if (buf[i] == '"' && dot) {
1132 for (i++; isspace(buf[i]); i++)
1136 if (buf[i] != name[j++])
1139 return (buf[i] == ']' && name[j] == 0);
1142 /* if new_name == NULL, the section is removed instead */
1143 int git_config_rename_section(const char *old_name, const char *new_name)
1145 int ret = 0, remove = 0;
1146 char *config_filename;
1147 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1151 if (config_exclusive_filename)
1152 config_filename = xstrdup(config_exclusive_filename);
1154 config_filename = xstrdup(git_path("config"));
1155 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1157 ret = error("could not lock config file %s", config_filename);
1161 if (!(config_file = fopen(config_filename, "rb"))) {
1162 /* no config file means nothing to rename, no error */
1163 goto unlock_and_out;
1166 while (fgets(buf, sizeof(buf), config_file)) {
1169 for (i = 0; buf[i] && isspace(buf[i]); i++)
1171 if (buf[i] == '[') {
1172 /* it's a section */
1173 if (section_name_match (&buf[i+1], old_name)) {
1175 if (new_name == NULL) {
1179 store.baselen = strlen(new_name);
1180 if (!store_write_section(out_fd, new_name)) {
1181 ret = write_error(lock->filename);
1190 length = strlen(buf);
1191 if (write_in_full(out_fd, buf, length) != length) {
1192 ret = write_error(lock->filename);
1196 fclose(config_file);
1198 if (commit_lock_file(lock) < 0)
1199 ret = error("could not commit config file %s", config_filename);
1201 free(config_filename);
1206 * Call this to report error for your variable that should not
1207 * get a boolean value (i.e. "[my] var" means "true").
1209 int config_error_nonbool(const char *var)
1211 return error("Missing value for '%s'", var);