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 static int get_next_char(void)
25 if ((f = config_file) != NULL) {
28 /* DOS like systems */
45 static char *parse_value(void)
47 static char value[1024];
48 int quote = 0, comment = 0, len = 0, space = 0;
51 int c = get_next_char();
52 if (len >= sizeof(value))
62 if (isspace(c) && !quote) {
67 if (c == ';' || c == '#') {
91 /* Some characters escape as themselves */
94 /* Reject unknown escape sequences */
109 static inline int iskeychar(int c)
111 return isalnum(c) || c == '-';
114 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
119 /* Get the full name */
126 name[len++] = tolower(c);
131 while (c == ' ' || c == '\t')
138 value = parse_value();
142 return fn(name, value, data);
145 static int get_extended_base_var(char *name, int baselen, int c)
151 } while (isspace(c));
153 /* We require the format to be '[base "extension"]' */
156 name[baselen++] = '.';
159 int c = get_next_char();
170 if (baselen > MAXNAME / 2)
175 if (get_next_char() != ']')
180 static int get_base_var(char *name)
185 int c = get_next_char();
191 return get_extended_base_var(name, baselen, c);
192 if (!iskeychar(c) && c != '.')
194 if (baselen > MAXNAME / 2)
196 name[baselen++] = tolower(c);
200 static int git_parse_file(config_fn_t fn, void *data)
204 static char var[MAXNAME];
207 int c = get_next_char();
214 if (comment || isspace(c))
216 if (c == '#' || c == ';') {
221 baselen = get_base_var(var);
224 var[baselen++] = '.';
230 var[baselen] = tolower(c);
231 if (get_value(fn, data, var, baselen+1) < 0)
234 die("bad config file line %d in %s", config_linenr, config_file_name);
237 static int parse_unit_factor(const char *end, unsigned long *val)
241 else if (!strcasecmp(end, "k")) {
245 else if (!strcasecmp(end, "m")) {
249 else if (!strcasecmp(end, "g")) {
250 *val *= 1024 * 1024 * 1024;
256 int git_parse_long(const char *value, long *ret)
258 if (value && *value) {
260 long val = strtol(value, &end, 0);
261 unsigned long factor = 1;
262 if (!parse_unit_factor(end, &factor))
270 int git_parse_ulong(const char *value, unsigned long *ret)
272 if (value && *value) {
274 unsigned long val = strtoul(value, &end, 0);
275 if (!parse_unit_factor(end, &val))
283 static void die_bad_config(const char *name)
285 if (config_file_name)
286 die("bad config value for '%s' in %s", name, config_file_name);
287 die("bad config value for '%s'", name);
290 int git_config_int(const char *name, const char *value)
293 if (!git_parse_long(value, &ret))
294 die_bad_config(name);
298 unsigned long git_config_ulong(const char *name, const char *value)
301 if (!git_parse_ulong(value, &ret))
302 die_bad_config(name);
306 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
313 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
315 if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
318 return git_config_int(name, value);
321 int git_config_bool(const char *name, const char *value)
324 return !!git_config_bool_or_int(name, value, &discard);
327 int git_config_string(const char **dest, const char *var, const char *value)
330 return config_error_nonbool(var);
331 *dest = xstrdup(value);
335 int git_default_config(const char *var, const char *value, void *dummy)
337 /* This needs a better name */
338 if (!strcmp(var, "core.filemode")) {
339 trust_executable_bit = git_config_bool(var, value);
343 if (!strcmp(var, "core.quotepath")) {
344 quote_path_fully = git_config_bool(var, value);
348 if (!strcmp(var, "core.symlinks")) {
349 has_symlinks = git_config_bool(var, value);
353 if (!strcmp(var, "core.ignorecase")) {
354 ignore_case = git_config_bool(var, value);
358 if (!strcmp(var, "core.bare")) {
359 is_bare_repository_cfg = git_config_bool(var, value);
363 if (!strcmp(var, "core.ignorestat")) {
364 assume_unchanged = git_config_bool(var, value);
368 if (!strcmp(var, "core.prefersymlinkrefs")) {
369 prefer_symlink_refs = git_config_bool(var, value);
373 if (!strcmp(var, "core.logallrefupdates")) {
374 log_all_ref_updates = git_config_bool(var, value);
378 if (!strcmp(var, "core.warnambiguousrefs")) {
379 warn_ambiguous_refs = git_config_bool(var, value);
383 if (!strcmp(var, "core.loosecompression")) {
384 int level = git_config_int(var, value);
386 level = Z_DEFAULT_COMPRESSION;
387 else if (level < 0 || level > Z_BEST_COMPRESSION)
388 die("bad zlib compression level %d", level);
389 zlib_compression_level = level;
390 zlib_compression_seen = 1;
394 if (!strcmp(var, "core.compression")) {
395 int level = git_config_int(var, value);
397 level = Z_DEFAULT_COMPRESSION;
398 else if (level < 0 || level > Z_BEST_COMPRESSION)
399 die("bad zlib compression level %d", level);
400 core_compression_level = level;
401 core_compression_seen = 1;
402 if (!zlib_compression_seen)
403 zlib_compression_level = level;
407 if (!strcmp(var, "core.packedgitwindowsize")) {
408 int pgsz_x2 = getpagesize() * 2;
409 packed_git_window_size = git_config_int(var, value);
411 /* This value must be multiple of (pagesize * 2) */
412 packed_git_window_size /= pgsz_x2;
413 if (packed_git_window_size < 1)
414 packed_git_window_size = 1;
415 packed_git_window_size *= pgsz_x2;
419 if (!strcmp(var, "core.packedgitlimit")) {
420 packed_git_limit = git_config_int(var, value);
424 if (!strcmp(var, "core.deltabasecachelimit")) {
425 delta_base_cache_limit = git_config_int(var, value);
429 if (!strcmp(var, "core.autocrlf")) {
430 if (value && !strcasecmp(value, "input")) {
434 auto_crlf = git_config_bool(var, value);
438 if (!strcmp(var, "core.safecrlf")) {
439 if (value && !strcasecmp(value, "warn")) {
440 safe_crlf = SAFE_CRLF_WARN;
443 safe_crlf = git_config_bool(var, value);
447 if (!strcmp(var, "user.name")) {
449 return config_error_nonbool(var);
450 strlcpy(git_default_name, value, sizeof(git_default_name));
451 if (git_default_email[0])
452 user_ident_explicitly_given = 1;
456 if (!strcmp(var, "user.email")) {
458 return config_error_nonbool(var);
459 strlcpy(git_default_email, value, sizeof(git_default_email));
460 if (git_default_name[0])
461 user_ident_explicitly_given = 1;
465 if (!strcmp(var, "i18n.commitencoding"))
466 return git_config_string(&git_commit_encoding, var, value);
468 if (!strcmp(var, "i18n.logoutputencoding"))
469 return git_config_string(&git_log_output_encoding, var, value);
471 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
472 pager_use_color = git_config_bool(var,value);
476 if (!strcmp(var, "core.pager"))
477 return git_config_string(&pager_program, var, value);
479 if (!strcmp(var, "core.editor"))
480 return git_config_string(&editor_program, var, value);
482 if (!strcmp(var, "core.excludesfile"))
483 return git_config_string(&excludes_file, var, value);
485 if (!strcmp(var, "core.whitespace")) {
487 return config_error_nonbool(var);
488 whitespace_rule_cfg = parse_whitespace_rule(value);
491 if (!strcmp(var, "branch.autosetupmerge")) {
492 if (value && !strcasecmp(value, "always")) {
493 git_branch_track = BRANCH_TRACK_ALWAYS;
496 git_branch_track = git_config_bool(var, value);
499 if (!strcmp(var, "branch.autosetuprebase")) {
501 return config_error_nonbool(var);
502 else if (!strcmp(value, "never"))
503 autorebase = AUTOREBASE_NEVER;
504 else if (!strcmp(value, "local"))
505 autorebase = AUTOREBASE_LOCAL;
506 else if (!strcmp(value, "remote"))
507 autorebase = AUTOREBASE_REMOTE;
508 else if (!strcmp(value, "always"))
509 autorebase = AUTOREBASE_ALWAYS;
511 return error("Malformed value for %s", var);
515 /* Add other config variables here and to Documentation/config.txt. */
519 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
522 FILE *f = fopen(filename, "r");
527 config_file_name = filename;
530 ret = git_parse_file(fn, data);
532 config_file_name = NULL;
537 const char *git_etc_gitconfig(void)
539 static const char *system_wide;
541 system_wide = ETC_GITCONFIG;
542 if (!is_absolute_path(system_wide)) {
543 /* interpret path relative to exec-dir */
544 struct strbuf d = STRBUF_INIT;
545 strbuf_addf(&d, "%s/%s", git_exec_path(), system_wide);
546 system_wide = strbuf_detach(&d, NULL);
552 static int git_env_bool(const char *k, int def)
554 const char *v = getenv(k);
555 return v ? git_config_bool(k, v) : def;
558 int git_config_system(void)
560 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
563 int git_config_global(void)
565 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
568 int git_config(config_fn_t fn, void *data)
571 char *repo_config = NULL;
572 const char *home = NULL, *filename;
574 /* $GIT_CONFIG makes git read _only_ the given config file,
575 * $GIT_CONFIG_LOCAL will make it process it in addition to the
576 * global config file, the same way it would the per-repository
577 * config file otherwise. */
578 filename = getenv(CONFIG_ENVIRONMENT);
580 if (git_config_system() && !access(git_etc_gitconfig(), R_OK))
581 ret += git_config_from_file(fn, git_etc_gitconfig(),
583 home = getenv("HOME");
584 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
586 filename = repo_config = xstrdup(git_path("config"));
589 if (git_config_global() && home) {
590 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
591 if (!access(user_config, R_OK))
592 ret = git_config_from_file(fn, user_config, data);
596 ret += git_config_from_file(fn, filename, data);
602 * Find all the stuff for git_config_set() below.
605 #define MAX_MATCHES 512
611 regex_t* value_regex;
613 size_t offset[MAX_MATCHES];
614 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
618 static int matches(const char* key, const char* value)
620 return !strcmp(key, store.key) &&
621 (store.value_regex == NULL ||
622 (store.do_not_match ^
623 !regexec(store.value_regex, value, 0, NULL, 0)));
626 static int store_aux(const char* key, const char* value, void *cb)
631 switch (store.state) {
633 if (matches(key, value)) {
634 if (store.seen == 1 && store.multi_replace == 0) {
635 warning("%s has multiple values", key);
636 } else if (store.seen >= MAX_MATCHES) {
637 error("too many matches for %s", key);
641 store.offset[store.seen] = ftell(config_file);
647 * What we are looking for is in store.key (both
648 * section and var), and its section part is baselen
649 * long. We found key (again, both section and var).
650 * We would want to know if this key is in the same
651 * section as what we are looking for. We already
652 * know we are in the same section as what should
655 ep = strrchr(key, '.');
656 section_len = ep - key;
658 if ((section_len != store.baselen) ||
659 memcmp(key, store.key, section_len+1)) {
660 store.state = SECTION_END_SEEN;
665 * Do not increment matches: this is no match, but we
666 * just made sure we are in the desired section.
668 store.offset[store.seen] = ftell(config_file);
670 case SECTION_END_SEEN:
672 if (matches(key, value)) {
673 store.offset[store.seen] = ftell(config_file);
674 store.state = KEY_SEEN;
677 if (strrchr(key, '.') - key == store.baselen &&
678 !strncmp(key, store.key, store.baselen)) {
679 store.state = SECTION_SEEN;
680 store.offset[store.seen] = ftell(config_file);
687 static int write_error(const char *filename)
689 error("failed to write new configuration file %s", filename);
691 /* Same error code as "failed to rename". */
695 static int store_write_section(int fd, const char* key)
702 dot = memchr(key, '.', store.baselen);
704 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
705 for (i = dot - key + 1; i < store.baselen; i++) {
706 if (key[i] == '"' || key[i] == '\\')
707 strbuf_addch(&sb, '\\');
708 strbuf_addch(&sb, key[i]);
710 strbuf_addstr(&sb, "\"]\n");
712 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
715 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
721 static int store_write_pair(int fd, const char* key, const char* value)
724 int length = strlen(key + store.baselen + 1);
725 const char *quote = "";
729 * Check to see if the value needs to be surrounded with a dq pair.
730 * Note that problematic characters are always backslash-quoted; this
731 * check is about not losing leading or trailing SP and strings that
732 * follow beginning-of-comment characters (i.e. ';' and '#') by the
733 * configuration parser.
737 for (i = 0; value[i]; i++)
738 if (value[i] == ';' || value[i] == '#')
740 if (i && value[i - 1] == ' ')
744 strbuf_addf(&sb, "\t%.*s = %s",
745 length, key + store.baselen + 1, quote);
747 for (i = 0; value[i]; i++)
750 strbuf_addstr(&sb, "\\n");
753 strbuf_addstr(&sb, "\\t");
757 strbuf_addch(&sb, '\\');
759 strbuf_addch(&sb, value[i]);
762 strbuf_addf(&sb, "%s\n", quote);
764 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
770 static ssize_t find_beginning_of_line(const char* contents, size_t size,
771 size_t offset_, int* found_bracket)
773 size_t equal_offset = size, bracket_offset = size;
777 for (offset = offset_-2; offset > 0
778 && contents[offset] != '\n'; offset--)
779 switch (contents[offset]) {
780 case '=': equal_offset = offset; break;
781 case ']': bracket_offset = offset; break;
783 if (offset > 0 && contents[offset-1] == '\\') {
787 if (bracket_offset < equal_offset) {
789 offset = bracket_offset+1;
796 int git_config_set(const char* key, const char* value)
798 return git_config_set_multivar(key, value, NULL, 0);
802 * If value==NULL, unset in (remove from) config,
803 * if value_regex!=NULL, disregard key/value pairs where value does not match.
804 * if multi_replace==0, nothing, or only one matching key/value is replaced,
805 * else all matching key/values (regardless how many) are removed,
806 * before the new pair is written.
808 * Returns 0 on success.
810 * This function does this:
812 * - it locks the config file by creating ".git/config.lock"
814 * - it then parses the config using store_aux() as validator to find
815 * the position on the key/value pair to replace. If it is to be unset,
816 * it must be found exactly once.
818 * - the config file is mmap()ed and the part before the match (if any) is
819 * written to the lock file, then the changed part and the rest.
821 * - the config file is removed and the lock file rename()d to it.
824 int git_config_set_multivar(const char* key, const char* value,
825 const char* value_regex, int multi_replace)
830 char* config_filename;
831 struct lock_file *lock = NULL;
832 const char* last_dot = strrchr(key, '.');
834 config_filename = getenv(CONFIG_ENVIRONMENT);
835 if (!config_filename) {
836 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
837 if (!config_filename)
838 config_filename = git_path("config");
840 config_filename = xstrdup(config_filename);
843 * Since "key" actually contains the section name and the real
844 * key name separated by a dot, we have to know where the dot is.
847 if (last_dot == NULL) {
848 error("key does not contain a section: %s", key);
852 store.baselen = last_dot - key;
854 store.multi_replace = multi_replace;
857 * Validate the key and while at it, lower case it for matching.
859 store.key = xmalloc(strlen(key) + 1);
861 for (i = 0; key[i]; i++) {
862 unsigned char c = key[i];
865 /* Leave the extended basename untouched.. */
866 if (!dot || i > store.baselen) {
867 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
868 error("invalid key: %s", key);
874 } else if (c == '\n') {
875 error("invalid key (newline): %s", key);
885 * The lock serves a purpose in addition to locking: the new
886 * contents of .git/config will be written into it.
888 lock = xcalloc(sizeof(struct lock_file), 1);
889 fd = hold_lock_file_for_update(lock, config_filename, 0);
891 error("could not lock config file %s", config_filename);
898 * If .git/config does not exist yet, write a minimal version.
900 in_fd = open(config_filename, O_RDONLY);
904 if ( ENOENT != errno ) {
905 error("opening %s: %s", config_filename,
907 ret = 3; /* same as "invalid config file" */
910 /* if nothing to unset, error out */
916 store.key = (char*)key;
917 if (!store_write_section(fd, key) ||
918 !store_write_pair(fd, key, value))
923 size_t contents_sz, copy_begin, copy_end;
926 if (value_regex == NULL)
927 store.value_regex = NULL;
929 if (value_regex[0] == '!') {
930 store.do_not_match = 1;
933 store.do_not_match = 0;
935 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
936 if (regcomp(store.value_regex, value_regex,
938 error("invalid pattern: %s", value_regex);
939 free(store.value_regex);
950 * After this, store.offset will contain the *end* offset
951 * of the last match, or remain at 0 if no match was found.
952 * As a side effect, we make sure to transform only a valid
953 * existing config file.
955 if (git_config_from_file(store_aux, config_filename, NULL)) {
956 error("invalid config file %s", config_filename);
958 if (store.value_regex != NULL) {
959 regfree(store.value_regex);
960 free(store.value_regex);
967 if (store.value_regex != NULL) {
968 regfree(store.value_regex);
969 free(store.value_regex);
972 /* if nothing to unset, or too many matches, error out */
973 if ((store.seen == 0 && value == NULL) ||
974 (store.seen > 1 && multi_replace == 0)) {
980 contents_sz = xsize_t(st.st_size);
981 contents = xmmap(NULL, contents_sz, PROT_READ,
982 MAP_PRIVATE, in_fd, 0);
988 for (i = 0, copy_begin = 0; i < store.seen; i++) {
989 if (store.offset[i] == 0) {
990 store.offset[i] = copy_end = contents_sz;
991 } else if (store.state != KEY_SEEN) {
992 copy_end = store.offset[i];
994 copy_end = find_beginning_of_line(
995 contents, contents_sz,
996 store.offset[i]-2, &new_line);
998 if (copy_end > 0 && contents[copy_end-1] != '\n')
1001 /* write the first part of the config */
1002 if (copy_end > copy_begin) {
1003 if (write_in_full(fd, contents + copy_begin,
1004 copy_end - copy_begin) <
1005 copy_end - copy_begin)
1008 write_in_full(fd, "\n", 1) != 1)
1011 copy_begin = store.offset[i];
1014 /* write the pair (value == NULL means unset) */
1015 if (value != NULL) {
1016 if (store.state == START) {
1017 if (!store_write_section(fd, key))
1020 if (!store_write_pair(fd, key, value))
1024 /* write the rest of the config */
1025 if (copy_begin < contents_sz)
1026 if (write_in_full(fd, contents + copy_begin,
1027 contents_sz - copy_begin) <
1028 contents_sz - copy_begin)
1031 munmap(contents, contents_sz);
1034 if (commit_lock_file(lock) < 0) {
1035 error("could not commit config file %s", config_filename);
1041 * lock is committed, so don't try to roll it back below.
1042 * NOTE: Since lockfile.c keeps a linked list of all created
1043 * lock_file structures, it isn't safe to free(lock). It's
1044 * better to just leave it hanging around.
1051 rollback_lock_file(lock);
1052 free(config_filename);
1056 ret = write_error(lock->filename);
1061 static int section_name_match (const char *buf, const char *name)
1063 int i = 0, j = 0, dot = 0;
1064 for (; buf[i] && buf[i] != ']'; i++) {
1065 if (!dot && isspace(buf[i])) {
1067 if (name[j++] != '.')
1069 for (i++; isspace(buf[i]); i++)
1075 if (buf[i] == '\\' && dot)
1077 else if (buf[i] == '"' && dot) {
1078 for (i++; isspace(buf[i]); i++)
1082 if (buf[i] != name[j++])
1085 return (buf[i] == ']' && name[j] == 0);
1088 /* if new_name == NULL, the section is removed instead */
1089 int git_config_rename_section(const char *old_name, const char *new_name)
1091 int ret = 0, remove = 0;
1092 char *config_filename;
1093 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1097 config_filename = getenv(CONFIG_ENVIRONMENT);
1098 if (!config_filename) {
1099 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1100 if (!config_filename)
1101 config_filename = git_path("config");
1103 config_filename = xstrdup(config_filename);
1104 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1106 ret = error("could not lock config file %s", config_filename);
1110 if (!(config_file = fopen(config_filename, "rb"))) {
1111 /* no config file means nothing to rename, no error */
1112 goto unlock_and_out;
1115 while (fgets(buf, sizeof(buf), config_file)) {
1118 for (i = 0; buf[i] && isspace(buf[i]); i++)
1120 if (buf[i] == '[') {
1121 /* it's a section */
1122 if (section_name_match (&buf[i+1], old_name)) {
1124 if (new_name == NULL) {
1128 store.baselen = strlen(new_name);
1129 if (!store_write_section(out_fd, new_name)) {
1130 ret = write_error(lock->filename);
1139 length = strlen(buf);
1140 if (write_in_full(out_fd, buf, length) != length) {
1141 ret = write_error(lock->filename);
1145 fclose(config_file);
1147 if (commit_lock_file(lock) < 0)
1148 ret = error("could not commit config file %s", config_filename);
1150 free(config_filename);
1155 * Call this to report error for your variable that should not
1156 * get a boolean value (i.e. "[my] var" means "true").
1158 int config_error_nonbool(const char *var)
1160 return error("Missing value for '%s'", var);