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);
496 /* Add other config variables here and to Documentation/config.txt. */
500 int git_config_from_file(config_fn_t fn, const char *filename)
503 FILE *f = fopen(filename, "r");
508 config_file_name = filename;
511 ret = git_parse_file(fn);
513 config_file_name = NULL;
518 const char *git_etc_gitconfig(void)
520 static const char *system_wide;
522 system_wide = ETC_GITCONFIG;
523 if (!is_absolute_path(system_wide)) {
524 /* interpret path relative to exec-dir */
525 struct strbuf d = STRBUF_INIT;
526 strbuf_addf(&d, "%s/%s", git_exec_path(), system_wide);
527 system_wide = strbuf_detach(&d, NULL);
533 int git_env_bool(const char *k, int def)
535 const char *v = getenv(k);
536 return v ? git_config_bool(k, v) : def;
539 int git_config_system(void)
541 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
544 int git_config_global(void)
546 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
549 int git_config(config_fn_t fn)
552 char *repo_config = NULL;
553 const char *home = NULL, *filename;
555 /* $GIT_CONFIG makes git read _only_ the given config file,
556 * $GIT_CONFIG_LOCAL will make it process it in addition to the
557 * global config file, the same way it would the per-repository
558 * config file otherwise. */
559 filename = getenv(CONFIG_ENVIRONMENT);
561 if (git_config_system() && !access(git_etc_gitconfig(), R_OK))
562 ret += git_config_from_file(fn, git_etc_gitconfig());
563 home = getenv("HOME");
564 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
566 filename = repo_config = xstrdup(git_path("config"));
569 if (git_config_global() && home) {
570 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
571 if (!access(user_config, R_OK))
572 ret = git_config_from_file(fn, user_config);
576 ret += git_config_from_file(fn, filename);
582 * Find all the stuff for git_config_set() below.
585 #define MAX_MATCHES 512
591 regex_t* value_regex;
593 size_t offset[MAX_MATCHES];
594 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
598 static int matches(const char* key, const char* value)
600 return !strcmp(key, store.key) &&
601 (store.value_regex == NULL ||
602 (store.do_not_match ^
603 !regexec(store.value_regex, value, 0, NULL, 0)));
606 static int store_aux(const char* key, const char* value)
611 switch (store.state) {
613 if (matches(key, value)) {
614 if (store.seen == 1 && store.multi_replace == 0) {
616 "Warning: %s has multiple values\n",
618 } else if (store.seen >= MAX_MATCHES) {
619 fprintf(stderr, "Too many matches\n");
623 store.offset[store.seen] = ftell(config_file);
629 * What we are looking for is in store.key (both
630 * section and var), and its section part is baselen
631 * long. We found key (again, both section and var).
632 * We would want to know if this key is in the same
633 * section as what we are looking for. We already
634 * know we are in the same section as what should
637 ep = strrchr(key, '.');
638 section_len = ep - key;
640 if ((section_len != store.baselen) ||
641 memcmp(key, store.key, section_len+1)) {
642 store.state = SECTION_END_SEEN;
647 * Do not increment matches: this is no match, but we
648 * just made sure we are in the desired section.
650 store.offset[store.seen] = ftell(config_file);
652 case SECTION_END_SEEN:
654 if (matches(key, value)) {
655 store.offset[store.seen] = ftell(config_file);
656 store.state = KEY_SEEN;
659 if (strrchr(key, '.') - key == store.baselen &&
660 !strncmp(key, store.key, store.baselen)) {
661 store.state = SECTION_SEEN;
662 store.offset[store.seen] = ftell(config_file);
669 static int write_error(void)
671 fprintf(stderr, "Failed to write new configuration file\n");
673 /* Same error code as "failed to rename". */
677 static int store_write_section(int fd, const char* key)
684 dot = memchr(key, '.', store.baselen);
686 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
687 for (i = dot - key + 1; i < store.baselen; i++) {
689 strbuf_addch(&sb, '\\');
690 strbuf_addch(&sb, key[i]);
692 strbuf_addstr(&sb, "\"]\n");
694 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
697 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
703 static int store_write_pair(int fd, const char* key, const char* value)
706 int length = strlen(key + store.baselen + 1);
707 const char *quote = "";
711 * Check to see if the value needs to be surrounded with a dq pair.
712 * Note that problematic characters are always backslash-quoted; this
713 * check is about not losing leading or trailing SP and strings that
714 * follow beginning-of-comment characters (i.e. ';' and '#') by the
715 * configuration parser.
719 for (i = 0; value[i]; i++)
720 if (value[i] == ';' || value[i] == '#')
722 if (i && value[i - 1] == ' ')
726 strbuf_addf(&sb, "\t%.*s = %s",
727 length, key + store.baselen + 1, quote);
729 for (i = 0; value[i]; i++)
732 strbuf_addstr(&sb, "\\n");
735 strbuf_addstr(&sb, "\\t");
739 strbuf_addch(&sb, '\\');
741 strbuf_addch(&sb, value[i]);
744 strbuf_addf(&sb, "%s\n", quote);
746 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
752 static ssize_t find_beginning_of_line(const char* contents, size_t size,
753 size_t offset_, int* found_bracket)
755 size_t equal_offset = size, bracket_offset = size;
759 for (offset = offset_-2; offset > 0
760 && contents[offset] != '\n'; offset--)
761 switch (contents[offset]) {
762 case '=': equal_offset = offset; break;
763 case ']': bracket_offset = offset; break;
765 if (offset > 0 && contents[offset-1] == '\\') {
769 if (bracket_offset < equal_offset) {
771 offset = bracket_offset+1;
778 int git_config_set(const char* key, const char* value)
780 return git_config_set_multivar(key, value, NULL, 0);
784 * If value==NULL, unset in (remove from) config,
785 * if value_regex!=NULL, disregard key/value pairs where value does not match.
786 * if multi_replace==0, nothing, or only one matching key/value is replaced,
787 * else all matching key/values (regardless how many) are removed,
788 * before the new pair is written.
790 * Returns 0 on success.
792 * This function does this:
794 * - it locks the config file by creating ".git/config.lock"
796 * - it then parses the config using store_aux() as validator to find
797 * the position on the key/value pair to replace. If it is to be unset,
798 * it must be found exactly once.
800 * - the config file is mmap()ed and the part before the match (if any) is
801 * written to the lock file, then the changed part and the rest.
803 * - the config file is removed and the lock file rename()d to it.
806 int git_config_set_multivar(const char* key, const char* value,
807 const char* value_regex, int multi_replace)
812 char* config_filename;
813 struct lock_file *lock = NULL;
814 const char* last_dot = strrchr(key, '.');
816 config_filename = getenv(CONFIG_ENVIRONMENT);
817 if (!config_filename) {
818 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
819 if (!config_filename)
820 config_filename = git_path("config");
822 config_filename = xstrdup(config_filename);
825 * Since "key" actually contains the section name and the real
826 * key name separated by a dot, we have to know where the dot is.
829 if (last_dot == NULL) {
830 fprintf(stderr, "key does not contain a section: %s\n", key);
834 store.baselen = last_dot - key;
836 store.multi_replace = multi_replace;
839 * Validate the key and while at it, lower case it for matching.
841 store.key = xmalloc(strlen(key) + 1);
843 for (i = 0; key[i]; i++) {
844 unsigned char c = key[i];
847 /* Leave the extended basename untouched.. */
848 if (!dot || i > store.baselen) {
849 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
850 fprintf(stderr, "invalid key: %s\n", key);
856 } else if (c == '\n') {
857 fprintf(stderr, "invalid key (newline): %s\n", key);
867 * The lock serves a purpose in addition to locking: the new
868 * contents of .git/config will be written into it.
870 lock = xcalloc(sizeof(struct lock_file), 1);
871 fd = hold_lock_file_for_update(lock, config_filename, 0);
873 fprintf(stderr, "could not lock config file\n");
880 * If .git/config does not exist yet, write a minimal version.
882 in_fd = open(config_filename, O_RDONLY);
886 if ( ENOENT != errno ) {
887 error("opening %s: %s", config_filename,
889 ret = 3; /* same as "invalid config file" */
892 /* if nothing to unset, error out */
898 store.key = (char*)key;
899 if (!store_write_section(fd, key) ||
900 !store_write_pair(fd, key, value))
905 size_t contents_sz, copy_begin, copy_end;
908 if (value_regex == NULL)
909 store.value_regex = NULL;
911 if (value_regex[0] == '!') {
912 store.do_not_match = 1;
915 store.do_not_match = 0;
917 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
918 if (regcomp(store.value_regex, value_regex,
920 fprintf(stderr, "Invalid pattern: %s\n",
922 free(store.value_regex);
933 * After this, store.offset will contain the *end* offset
934 * of the last match, or remain at 0 if no match was found.
935 * As a side effect, we make sure to transform only a valid
936 * existing config file.
938 if (git_config_from_file(store_aux, config_filename)) {
939 fprintf(stderr, "invalid config file\n");
941 if (store.value_regex != NULL) {
942 regfree(store.value_regex);
943 free(store.value_regex);
950 if (store.value_regex != NULL) {
951 regfree(store.value_regex);
952 free(store.value_regex);
955 /* if nothing to unset, or too many matches, error out */
956 if ((store.seen == 0 && value == NULL) ||
957 (store.seen > 1 && multi_replace == 0)) {
963 contents_sz = xsize_t(st.st_size);
964 contents = xmmap(NULL, contents_sz, PROT_READ,
965 MAP_PRIVATE, in_fd, 0);
971 for (i = 0, copy_begin = 0; i < store.seen; i++) {
972 if (store.offset[i] == 0) {
973 store.offset[i] = copy_end = contents_sz;
974 } else if (store.state != KEY_SEEN) {
975 copy_end = store.offset[i];
977 copy_end = find_beginning_of_line(
978 contents, contents_sz,
979 store.offset[i]-2, &new_line);
981 if (copy_end > 0 && contents[copy_end-1] != '\n')
984 /* write the first part of the config */
985 if (copy_end > copy_begin) {
986 if (write_in_full(fd, contents + copy_begin,
987 copy_end - copy_begin) <
988 copy_end - copy_begin)
991 write_in_full(fd, "\n", 1) != 1)
994 copy_begin = store.offset[i];
997 /* write the pair (value == NULL means unset) */
999 if (store.state == START) {
1000 if (!store_write_section(fd, key))
1003 if (!store_write_pair(fd, key, value))
1007 /* write the rest of the config */
1008 if (copy_begin < contents_sz)
1009 if (write_in_full(fd, contents + copy_begin,
1010 contents_sz - copy_begin) <
1011 contents_sz - copy_begin)
1014 munmap(contents, contents_sz);
1017 if (commit_lock_file(lock) < 0) {
1018 fprintf(stderr, "Cannot commit config file!\n");
1024 * lock is committed, so don't try to roll it back below.
1025 * NOTE: Since lockfile.c keeps a linked list of all created
1026 * lock_file structures, it isn't safe to free(lock). It's
1027 * better to just leave it hanging around.
1034 rollback_lock_file(lock);
1035 free(config_filename);
1039 ret = write_error();
1044 static int section_name_match (const char *buf, const char *name)
1046 int i = 0, j = 0, dot = 0;
1047 for (; buf[i] && buf[i] != ']'; i++) {
1048 if (!dot && isspace(buf[i])) {
1050 if (name[j++] != '.')
1052 for (i++; isspace(buf[i]); i++)
1058 if (buf[i] == '\\' && dot)
1060 else if (buf[i] == '"' && dot) {
1061 for (i++; isspace(buf[i]); i++)
1065 if (buf[i] != name[j++])
1068 return (buf[i] == ']' && name[j] == 0);
1071 /* if new_name == NULL, the section is removed instead */
1072 int git_config_rename_section(const char *old_name, const char *new_name)
1074 int ret = 0, remove = 0;
1075 char *config_filename;
1076 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1080 config_filename = getenv(CONFIG_ENVIRONMENT);
1081 if (!config_filename) {
1082 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1083 if (!config_filename)
1084 config_filename = git_path("config");
1086 config_filename = xstrdup(config_filename);
1087 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1089 ret = error("Could not lock config file!");
1093 if (!(config_file = fopen(config_filename, "rb"))) {
1094 /* no config file means nothing to rename, no error */
1095 goto unlock_and_out;
1098 while (fgets(buf, sizeof(buf), config_file)) {
1101 for (i = 0; buf[i] && isspace(buf[i]); i++)
1103 if (buf[i] == '[') {
1104 /* it's a section */
1105 if (section_name_match (&buf[i+1], old_name)) {
1107 if (new_name == NULL) {
1111 store.baselen = strlen(new_name);
1112 if (!store_write_section(out_fd, new_name)) {
1113 ret = write_error();
1122 length = strlen(buf);
1123 if (write_in_full(out_fd, buf, length) != length) {
1124 ret = write_error();
1128 fclose(config_file);
1130 if (commit_lock_file(lock) < 0)
1131 ret = error("Cannot commit config file!");
1133 free(config_filename);
1138 * Call this to report error for your variable that should not
1139 * get a boolean value (i.e. "[my] var" means "true").
1141 int config_error_nonbool(const char *var)
1143 return error("Missing value for '%s'", var);