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, 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);
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)
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, 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)
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));
454 if (!strcmp(var, "user.email")) {
456 return config_error_nonbool(var);
457 strlcpy(git_default_email, value, sizeof(git_default_email));
461 if (!strcmp(var, "i18n.commitencoding"))
462 return git_config_string(&git_commit_encoding, var, value);
464 if (!strcmp(var, "i18n.logoutputencoding"))
465 return git_config_string(&git_log_output_encoding, var, value);
467 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
468 pager_use_color = 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);
487 if (!strcmp(var, "branch.autosetupmerge")) {
488 if (value && !strcasecmp(value, "always")) {
489 git_branch_track = BRANCH_TRACK_ALWAYS;
492 git_branch_track = git_config_bool(var, value);
495 if (!strcmp(var, "branch.autosetuprebase")) {
497 return config_error_nonbool(var);
498 else if (!strcmp(value, "never"))
499 autorebase = AUTOREBASE_NEVER;
500 else if (!strcmp(value, "local"))
501 autorebase = AUTOREBASE_LOCAL;
502 else if (!strcmp(value, "remote"))
503 autorebase = AUTOREBASE_REMOTE;
504 else if (!strcmp(value, "always"))
505 autorebase = AUTOREBASE_ALWAYS;
507 return error("Malformed value for %s", var);
511 /* Add other config variables here and to Documentation/config.txt. */
515 int git_config_from_file(config_fn_t fn, const char *filename)
518 FILE *f = fopen(filename, "r");
523 config_file_name = filename;
526 ret = git_parse_file(fn);
528 config_file_name = NULL;
533 const char *git_etc_gitconfig(void)
535 static const char *system_wide;
537 system_wide = ETC_GITCONFIG;
538 if (!is_absolute_path(system_wide)) {
539 /* interpret path relative to exec-dir */
540 struct strbuf d = STRBUF_INIT;
541 strbuf_addf(&d, "%s/%s", git_exec_path(), system_wide);
542 system_wide = strbuf_detach(&d, NULL);
548 int git_env_bool(const char *k, int def)
550 const char *v = getenv(k);
551 return v ? git_config_bool(k, v) : def;
554 int git_config_system(void)
556 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
559 int git_config_global(void)
561 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
564 int git_config(config_fn_t fn)
567 char *repo_config = NULL;
568 const char *home = NULL, *filename;
570 /* $GIT_CONFIG makes git read _only_ the given config file,
571 * $GIT_CONFIG_LOCAL will make it process it in addition to the
572 * global config file, the same way it would the per-repository
573 * config file otherwise. */
574 filename = getenv(CONFIG_ENVIRONMENT);
576 if (git_config_system() && !access(git_etc_gitconfig(), R_OK))
577 ret += git_config_from_file(fn, git_etc_gitconfig());
578 home = getenv("HOME");
579 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
581 filename = repo_config = xstrdup(git_path("config"));
584 if (git_config_global() && home) {
585 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
586 if (!access(user_config, R_OK))
587 ret = git_config_from_file(fn, user_config);
591 ret += git_config_from_file(fn, filename);
597 * Find all the stuff for git_config_set() below.
600 #define MAX_MATCHES 512
606 regex_t* value_regex;
608 size_t offset[MAX_MATCHES];
609 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
613 static int matches(const char* key, const char* value)
615 return !strcmp(key, store.key) &&
616 (store.value_regex == NULL ||
617 (store.do_not_match ^
618 !regexec(store.value_regex, value, 0, NULL, 0)));
621 static int store_aux(const char* key, const char* value)
626 switch (store.state) {
628 if (matches(key, value)) {
629 if (store.seen == 1 && store.multi_replace == 0) {
631 "Warning: %s has multiple values\n",
633 } else if (store.seen >= MAX_MATCHES) {
634 fprintf(stderr, "Too many matches\n");
638 store.offset[store.seen] = ftell(config_file);
644 * What we are looking for is in store.key (both
645 * section and var), and its section part is baselen
646 * long. We found key (again, both section and var).
647 * We would want to know if this key is in the same
648 * section as what we are looking for. We already
649 * know we are in the same section as what should
652 ep = strrchr(key, '.');
653 section_len = ep - key;
655 if ((section_len != store.baselen) ||
656 memcmp(key, store.key, section_len+1)) {
657 store.state = SECTION_END_SEEN;
662 * Do not increment matches: this is no match, but we
663 * just made sure we are in the desired section.
665 store.offset[store.seen] = ftell(config_file);
667 case SECTION_END_SEEN:
669 if (matches(key, value)) {
670 store.offset[store.seen] = ftell(config_file);
671 store.state = KEY_SEEN;
674 if (strrchr(key, '.') - key == store.baselen &&
675 !strncmp(key, store.key, store.baselen)) {
676 store.state = SECTION_SEEN;
677 store.offset[store.seen] = ftell(config_file);
684 static int write_error(void)
686 fprintf(stderr, "Failed to write new configuration file\n");
688 /* Same error code as "failed to rename". */
692 static int store_write_section(int fd, const char* key)
699 dot = memchr(key, '.', store.baselen);
701 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
702 for (i = dot - key + 1; i < store.baselen; i++) {
704 strbuf_addch(&sb, '\\');
705 strbuf_addch(&sb, key[i]);
707 strbuf_addstr(&sb, "\"]\n");
709 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
712 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
718 static int store_write_pair(int fd, const char* key, const char* value)
721 int length = strlen(key + store.baselen + 1);
722 const char *quote = "";
726 * Check to see if the value needs to be surrounded with a dq pair.
727 * Note that problematic characters are always backslash-quoted; this
728 * check is about not losing leading or trailing SP and strings that
729 * follow beginning-of-comment characters (i.e. ';' and '#') by the
730 * configuration parser.
734 for (i = 0; value[i]; i++)
735 if (value[i] == ';' || value[i] == '#')
737 if (i && value[i - 1] == ' ')
741 strbuf_addf(&sb, "\t%.*s = %s",
742 length, key + store.baselen + 1, quote);
744 for (i = 0; value[i]; i++)
747 strbuf_addstr(&sb, "\\n");
750 strbuf_addstr(&sb, "\\t");
754 strbuf_addch(&sb, '\\');
756 strbuf_addch(&sb, value[i]);
759 strbuf_addf(&sb, "%s\n", quote);
761 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
767 static ssize_t find_beginning_of_line(const char* contents, size_t size,
768 size_t offset_, int* found_bracket)
770 size_t equal_offset = size, bracket_offset = size;
774 for (offset = offset_-2; offset > 0
775 && contents[offset] != '\n'; offset--)
776 switch (contents[offset]) {
777 case '=': equal_offset = offset; break;
778 case ']': bracket_offset = offset; break;
780 if (offset > 0 && contents[offset-1] == '\\') {
784 if (bracket_offset < equal_offset) {
786 offset = bracket_offset+1;
793 int git_config_set(const char* key, const char* value)
795 return git_config_set_multivar(key, value, NULL, 0);
799 * If value==NULL, unset in (remove from) config,
800 * if value_regex!=NULL, disregard key/value pairs where value does not match.
801 * if multi_replace==0, nothing, or only one matching key/value is replaced,
802 * else all matching key/values (regardless how many) are removed,
803 * before the new pair is written.
805 * Returns 0 on success.
807 * This function does this:
809 * - it locks the config file by creating ".git/config.lock"
811 * - it then parses the config using store_aux() as validator to find
812 * the position on the key/value pair to replace. If it is to be unset,
813 * it must be found exactly once.
815 * - the config file is mmap()ed and the part before the match (if any) is
816 * written to the lock file, then the changed part and the rest.
818 * - the config file is removed and the lock file rename()d to it.
821 int git_config_set_multivar(const char* key, const char* value,
822 const char* value_regex, int multi_replace)
827 char* config_filename;
828 struct lock_file *lock = NULL;
829 const char* last_dot = strrchr(key, '.');
831 config_filename = getenv(CONFIG_ENVIRONMENT);
832 if (!config_filename) {
833 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
834 if (!config_filename)
835 config_filename = git_path("config");
837 config_filename = xstrdup(config_filename);
840 * Since "key" actually contains the section name and the real
841 * key name separated by a dot, we have to know where the dot is.
844 if (last_dot == NULL) {
845 fprintf(stderr, "key does not contain a section: %s\n", key);
849 store.baselen = last_dot - key;
851 store.multi_replace = multi_replace;
854 * Validate the key and while at it, lower case it for matching.
856 store.key = xmalloc(strlen(key) + 1);
858 for (i = 0; key[i]; i++) {
859 unsigned char c = key[i];
862 /* Leave the extended basename untouched.. */
863 if (!dot || i > store.baselen) {
864 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
865 fprintf(stderr, "invalid key: %s\n", key);
871 } else if (c == '\n') {
872 fprintf(stderr, "invalid key (newline): %s\n", key);
882 * The lock serves a purpose in addition to locking: the new
883 * contents of .git/config will be written into it.
885 lock = xcalloc(sizeof(struct lock_file), 1);
886 fd = hold_lock_file_for_update(lock, config_filename, 0);
888 fprintf(stderr, "could not lock config file\n");
895 * If .git/config does not exist yet, write a minimal version.
897 in_fd = open(config_filename, O_RDONLY);
901 if ( ENOENT != errno ) {
902 error("opening %s: %s", config_filename,
904 ret = 3; /* same as "invalid config file" */
907 /* if nothing to unset, error out */
913 store.key = (char*)key;
914 if (!store_write_section(fd, key) ||
915 !store_write_pair(fd, key, value))
920 size_t contents_sz, copy_begin, copy_end;
923 if (value_regex == NULL)
924 store.value_regex = NULL;
926 if (value_regex[0] == '!') {
927 store.do_not_match = 1;
930 store.do_not_match = 0;
932 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
933 if (regcomp(store.value_regex, value_regex,
935 fprintf(stderr, "Invalid pattern: %s\n",
937 free(store.value_regex);
948 * After this, store.offset will contain the *end* offset
949 * of the last match, or remain at 0 if no match was found.
950 * As a side effect, we make sure to transform only a valid
951 * existing config file.
953 if (git_config_from_file(store_aux, config_filename)) {
954 fprintf(stderr, "invalid config file\n");
956 if (store.value_regex != NULL) {
957 regfree(store.value_regex);
958 free(store.value_regex);
965 if (store.value_regex != NULL) {
966 regfree(store.value_regex);
967 free(store.value_regex);
970 /* if nothing to unset, or too many matches, error out */
971 if ((store.seen == 0 && value == NULL) ||
972 (store.seen > 1 && multi_replace == 0)) {
978 contents_sz = xsize_t(st.st_size);
979 contents = xmmap(NULL, contents_sz, PROT_READ,
980 MAP_PRIVATE, in_fd, 0);
986 for (i = 0, copy_begin = 0; i < store.seen; i++) {
987 if (store.offset[i] == 0) {
988 store.offset[i] = copy_end = contents_sz;
989 } else if (store.state != KEY_SEEN) {
990 copy_end = store.offset[i];
992 copy_end = find_beginning_of_line(
993 contents, contents_sz,
994 store.offset[i]-2, &new_line);
996 if (copy_end > 0 && contents[copy_end-1] != '\n')
999 /* write the first part of the config */
1000 if (copy_end > copy_begin) {
1001 if (write_in_full(fd, contents + copy_begin,
1002 copy_end - copy_begin) <
1003 copy_end - copy_begin)
1006 write_in_full(fd, "\n", 1) != 1)
1009 copy_begin = store.offset[i];
1012 /* write the pair (value == NULL means unset) */
1013 if (value != NULL) {
1014 if (store.state == START) {
1015 if (!store_write_section(fd, key))
1018 if (!store_write_pair(fd, key, value))
1022 /* write the rest of the config */
1023 if (copy_begin < contents_sz)
1024 if (write_in_full(fd, contents + copy_begin,
1025 contents_sz - copy_begin) <
1026 contents_sz - copy_begin)
1029 munmap(contents, contents_sz);
1032 if (commit_lock_file(lock) < 0) {
1033 fprintf(stderr, "Cannot commit config file!\n");
1039 * lock is committed, so don't try to roll it back below.
1040 * NOTE: Since lockfile.c keeps a linked list of all created
1041 * lock_file structures, it isn't safe to free(lock). It's
1042 * better to just leave it hanging around.
1049 rollback_lock_file(lock);
1050 free(config_filename);
1054 ret = write_error();
1059 static int section_name_match (const char *buf, const char *name)
1061 int i = 0, j = 0, dot = 0;
1062 for (; buf[i] && buf[i] != ']'; i++) {
1063 if (!dot && isspace(buf[i])) {
1065 if (name[j++] != '.')
1067 for (i++; isspace(buf[i]); i++)
1073 if (buf[i] == '\\' && dot)
1075 else if (buf[i] == '"' && dot) {
1076 for (i++; isspace(buf[i]); i++)
1080 if (buf[i] != name[j++])
1083 return (buf[i] == ']' && name[j] == 0);
1086 /* if new_name == NULL, the section is removed instead */
1087 int git_config_rename_section(const char *old_name, const char *new_name)
1089 int ret = 0, remove = 0;
1090 char *config_filename;
1091 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1095 config_filename = getenv(CONFIG_ENVIRONMENT);
1096 if (!config_filename) {
1097 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1098 if (!config_filename)
1099 config_filename = git_path("config");
1101 config_filename = xstrdup(config_filename);
1102 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1104 ret = error("Could not lock config file!");
1108 if (!(config_file = fopen(config_filename, "rb"))) {
1109 /* no config file means nothing to rename, no error */
1110 goto unlock_and_out;
1113 while (fgets(buf, sizeof(buf), config_file)) {
1116 for (i = 0; buf[i] && isspace(buf[i]); i++)
1118 if (buf[i] == '[') {
1119 /* it's a section */
1120 if (section_name_match (&buf[i+1], old_name)) {
1122 if (new_name == NULL) {
1126 store.baselen = strlen(new_name);
1127 if (!store_write_section(out_fd, new_name)) {
1128 ret = write_error();
1137 length = strlen(buf);
1138 if (write_in_full(out_fd, buf, length) != length) {
1139 ret = write_error();
1143 fclose(config_file);
1145 if (commit_lock_file(lock) < 0)
1146 ret = error("Cannot commit config file!");
1148 free(config_filename);
1153 * Call this to report error for your variable that should not
1154 * get a boolean value (i.e. "[my] var" means "true").
1156 int config_error_nonbool(const char *var)
1158 return error("Missing value for '%s'", var);