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.bare")) {
354 is_bare_repository_cfg = git_config_bool(var, value);
358 if (!strcmp(var, "core.ignorestat")) {
359 assume_unchanged = git_config_bool(var, value);
363 if (!strcmp(var, "core.prefersymlinkrefs")) {
364 prefer_symlink_refs = git_config_bool(var, value);
368 if (!strcmp(var, "core.logallrefupdates")) {
369 log_all_ref_updates = git_config_bool(var, value);
373 if (!strcmp(var, "core.warnambiguousrefs")) {
374 warn_ambiguous_refs = git_config_bool(var, value);
378 if (!strcmp(var, "core.loosecompression")) {
379 int level = git_config_int(var, value);
381 level = Z_DEFAULT_COMPRESSION;
382 else if (level < 0 || level > Z_BEST_COMPRESSION)
383 die("bad zlib compression level %d", level);
384 zlib_compression_level = level;
385 zlib_compression_seen = 1;
389 if (!strcmp(var, "core.compression")) {
390 int level = git_config_int(var, value);
392 level = Z_DEFAULT_COMPRESSION;
393 else if (level < 0 || level > Z_BEST_COMPRESSION)
394 die("bad zlib compression level %d", level);
395 core_compression_level = level;
396 core_compression_seen = 1;
397 if (!zlib_compression_seen)
398 zlib_compression_level = level;
402 if (!strcmp(var, "core.packedgitwindowsize")) {
403 int pgsz_x2 = getpagesize() * 2;
404 packed_git_window_size = git_config_int(var, value);
406 /* This value must be multiple of (pagesize * 2) */
407 packed_git_window_size /= pgsz_x2;
408 if (packed_git_window_size < 1)
409 packed_git_window_size = 1;
410 packed_git_window_size *= pgsz_x2;
414 if (!strcmp(var, "core.packedgitlimit")) {
415 packed_git_limit = git_config_int(var, value);
419 if (!strcmp(var, "core.deltabasecachelimit")) {
420 delta_base_cache_limit = git_config_int(var, value);
424 if (!strcmp(var, "core.autocrlf")) {
425 if (value && !strcasecmp(value, "input")) {
429 auto_crlf = git_config_bool(var, value);
433 if (!strcmp(var, "core.safecrlf")) {
434 if (value && !strcasecmp(value, "warn")) {
435 safe_crlf = SAFE_CRLF_WARN;
438 safe_crlf = git_config_bool(var, value);
442 if (!strcmp(var, "user.name")) {
444 return config_error_nonbool(var);
445 strlcpy(git_default_name, value, sizeof(git_default_name));
446 if (git_default_email[0])
447 user_ident_explicitly_given = 1;
451 if (!strcmp(var, "user.email")) {
453 return config_error_nonbool(var);
454 strlcpy(git_default_email, value, sizeof(git_default_email));
455 if (git_default_name[0])
456 user_ident_explicitly_given = 1;
460 if (!strcmp(var, "i18n.commitencoding"))
461 return git_config_string(&git_commit_encoding, var, value);
463 if (!strcmp(var, "i18n.logoutputencoding"))
464 return git_config_string(&git_log_output_encoding, var, value);
466 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
467 pager_use_color = git_config_bool(var,value);
471 if (!strcmp(var, "core.pager"))
472 return git_config_string(&pager_program, var, value);
474 if (!strcmp(var, "core.editor"))
475 return git_config_string(&editor_program, var, value);
477 if (!strcmp(var, "core.excludesfile"))
478 return git_config_string(&excludes_file, var, value);
480 if (!strcmp(var, "core.whitespace")) {
482 return config_error_nonbool(var);
483 whitespace_rule_cfg = parse_whitespace_rule(value);
486 if (!strcmp(var, "branch.autosetupmerge")) {
487 if (value && !strcasecmp(value, "always")) {
488 git_branch_track = BRANCH_TRACK_ALWAYS;
491 git_branch_track = git_config_bool(var, value);
495 /* Add other config variables here and to Documentation/config.txt. */
499 int git_config_from_file(config_fn_t fn, const char *filename)
502 FILE *f = fopen(filename, "r");
507 config_file_name = filename;
510 ret = git_parse_file(fn);
512 config_file_name = NULL;
517 const char *git_etc_gitconfig(void)
519 static const char *system_wide;
521 system_wide = ETC_GITCONFIG;
522 if (!is_absolute_path(system_wide)) {
523 /* interpret path relative to exec-dir */
524 struct strbuf d = STRBUF_INIT;
525 strbuf_addf(&d, "%s/%s", git_exec_path(), system_wide);
526 system_wide = strbuf_detach(&d, NULL);
532 int git_env_bool(const char *k, int def)
534 const char *v = getenv(k);
535 return v ? git_config_bool(k, v) : def;
538 int git_config_system(void)
540 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
543 int git_config_global(void)
545 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
548 int git_config(config_fn_t fn)
551 char *repo_config = NULL;
552 const char *home = NULL, *filename;
554 /* $GIT_CONFIG makes git read _only_ the given config file,
555 * $GIT_CONFIG_LOCAL will make it process it in addition to the
556 * global config file, the same way it would the per-repository
557 * config file otherwise. */
558 filename = getenv(CONFIG_ENVIRONMENT);
560 if (git_config_system() && !access(git_etc_gitconfig(), R_OK))
561 ret += git_config_from_file(fn, git_etc_gitconfig());
562 home = getenv("HOME");
563 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
565 filename = repo_config = xstrdup(git_path("config"));
568 if (git_config_global() && home) {
569 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
570 if (!access(user_config, R_OK))
571 ret = git_config_from_file(fn, user_config);
575 ret += git_config_from_file(fn, filename);
581 * Find all the stuff for git_config_set() below.
584 #define MAX_MATCHES 512
590 regex_t* value_regex;
592 size_t offset[MAX_MATCHES];
593 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
597 static int matches(const char* key, const char* value)
599 return !strcmp(key, store.key) &&
600 (store.value_regex == NULL ||
601 (store.do_not_match ^
602 !regexec(store.value_regex, value, 0, NULL, 0)));
605 static int store_aux(const char* key, const char* value)
610 switch (store.state) {
612 if (matches(key, value)) {
613 if (store.seen == 1 && store.multi_replace == 0) {
615 "Warning: %s has multiple values\n",
617 } else if (store.seen >= MAX_MATCHES) {
618 fprintf(stderr, "Too many matches\n");
622 store.offset[store.seen] = ftell(config_file);
628 * What we are looking for is in store.key (both
629 * section and var), and its section part is baselen
630 * long. We found key (again, both section and var).
631 * We would want to know if this key is in the same
632 * section as what we are looking for. We already
633 * know we are in the same section as what should
636 ep = strrchr(key, '.');
637 section_len = ep - key;
639 if ((section_len != store.baselen) ||
640 memcmp(key, store.key, section_len+1)) {
641 store.state = SECTION_END_SEEN;
646 * Do not increment matches: this is no match, but we
647 * just made sure we are in the desired section.
649 store.offset[store.seen] = ftell(config_file);
651 case SECTION_END_SEEN:
653 if (matches(key, value)) {
654 store.offset[store.seen] = ftell(config_file);
655 store.state = KEY_SEEN;
658 if (strrchr(key, '.') - key == store.baselen &&
659 !strncmp(key, store.key, store.baselen)) {
660 store.state = SECTION_SEEN;
661 store.offset[store.seen] = ftell(config_file);
668 static int write_error(void)
670 fprintf(stderr, "Failed to write new configuration file\n");
672 /* Same error code as "failed to rename". */
676 static int store_write_section(int fd, const char* key)
683 dot = memchr(key, '.', store.baselen);
685 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
686 for (i = dot - key + 1; i < store.baselen; i++) {
688 strbuf_addch(&sb, '\\');
689 strbuf_addch(&sb, key[i]);
691 strbuf_addstr(&sb, "\"]\n");
693 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
696 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
702 static int store_write_pair(int fd, const char* key, const char* value)
705 int length = strlen(key + store.baselen + 1);
706 const char *quote = "";
710 * Check to see if the value needs to be surrounded with a dq pair.
711 * Note that problematic characters are always backslash-quoted; this
712 * check is about not losing leading or trailing SP and strings that
713 * follow beginning-of-comment characters (i.e. ';' and '#') by the
714 * configuration parser.
718 for (i = 0; value[i]; i++)
719 if (value[i] == ';' || value[i] == '#')
721 if (i && value[i - 1] == ' ')
725 strbuf_addf(&sb, "\t%.*s = %s",
726 length, key + store.baselen + 1, quote);
728 for (i = 0; value[i]; i++)
731 strbuf_addstr(&sb, "\\n");
734 strbuf_addstr(&sb, "\\t");
738 strbuf_addch(&sb, '\\');
740 strbuf_addch(&sb, value[i]);
743 strbuf_addf(&sb, "%s\n", quote);
745 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
751 static ssize_t find_beginning_of_line(const char* contents, size_t size,
752 size_t offset_, int* found_bracket)
754 size_t equal_offset = size, bracket_offset = size;
758 for (offset = offset_-2; offset > 0
759 && contents[offset] != '\n'; offset--)
760 switch (contents[offset]) {
761 case '=': equal_offset = offset; break;
762 case ']': bracket_offset = offset; break;
764 if (offset > 0 && contents[offset-1] == '\\') {
768 if (bracket_offset < equal_offset) {
770 offset = bracket_offset+1;
777 int git_config_set(const char* key, const char* value)
779 return git_config_set_multivar(key, value, NULL, 0);
783 * If value==NULL, unset in (remove from) config,
784 * if value_regex!=NULL, disregard key/value pairs where value does not match.
785 * if multi_replace==0, nothing, or only one matching key/value is replaced,
786 * else all matching key/values (regardless how many) are removed,
787 * before the new pair is written.
789 * Returns 0 on success.
791 * This function does this:
793 * - it locks the config file by creating ".git/config.lock"
795 * - it then parses the config using store_aux() as validator to find
796 * the position on the key/value pair to replace. If it is to be unset,
797 * it must be found exactly once.
799 * - the config file is mmap()ed and the part before the match (if any) is
800 * written to the lock file, then the changed part and the rest.
802 * - the config file is removed and the lock file rename()d to it.
805 int git_config_set_multivar(const char* key, const char* value,
806 const char* value_regex, int multi_replace)
811 char* config_filename;
812 struct lock_file *lock = NULL;
813 const char* last_dot = strrchr(key, '.');
815 config_filename = getenv(CONFIG_ENVIRONMENT);
816 if (!config_filename) {
817 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
818 if (!config_filename)
819 config_filename = git_path("config");
821 config_filename = xstrdup(config_filename);
824 * Since "key" actually contains the section name and the real
825 * key name separated by a dot, we have to know where the dot is.
828 if (last_dot == NULL) {
829 fprintf(stderr, "key does not contain a section: %s\n", key);
833 store.baselen = last_dot - key;
835 store.multi_replace = multi_replace;
838 * Validate the key and while at it, lower case it for matching.
840 store.key = xmalloc(strlen(key) + 1);
842 for (i = 0; key[i]; i++) {
843 unsigned char c = key[i];
846 /* Leave the extended basename untouched.. */
847 if (!dot || i > store.baselen) {
848 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
849 fprintf(stderr, "invalid key: %s\n", key);
855 } else if (c == '\n') {
856 fprintf(stderr, "invalid key (newline): %s\n", key);
866 * The lock serves a purpose in addition to locking: the new
867 * contents of .git/config will be written into it.
869 lock = xcalloc(sizeof(struct lock_file), 1);
870 fd = hold_lock_file_for_update(lock, config_filename, 0);
872 fprintf(stderr, "could not lock config file\n");
879 * If .git/config does not exist yet, write a minimal version.
881 in_fd = open(config_filename, O_RDONLY);
885 if ( ENOENT != errno ) {
886 error("opening %s: %s", config_filename,
888 ret = 3; /* same as "invalid config file" */
891 /* if nothing to unset, error out */
897 store.key = (char*)key;
898 if (!store_write_section(fd, key) ||
899 !store_write_pair(fd, key, value))
904 size_t contents_sz, copy_begin, copy_end;
907 if (value_regex == NULL)
908 store.value_regex = NULL;
910 if (value_regex[0] == '!') {
911 store.do_not_match = 1;
914 store.do_not_match = 0;
916 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
917 if (regcomp(store.value_regex, value_regex,
919 fprintf(stderr, "Invalid pattern: %s\n",
921 free(store.value_regex);
932 * After this, store.offset will contain the *end* offset
933 * of the last match, or remain at 0 if no match was found.
934 * As a side effect, we make sure to transform only a valid
935 * existing config file.
937 if (git_config_from_file(store_aux, config_filename)) {
938 fprintf(stderr, "invalid config file\n");
940 if (store.value_regex != NULL) {
941 regfree(store.value_regex);
942 free(store.value_regex);
949 if (store.value_regex != NULL) {
950 regfree(store.value_regex);
951 free(store.value_regex);
954 /* if nothing to unset, or too many matches, error out */
955 if ((store.seen == 0 && value == NULL) ||
956 (store.seen > 1 && multi_replace == 0)) {
962 contents_sz = xsize_t(st.st_size);
963 contents = xmmap(NULL, contents_sz, PROT_READ,
964 MAP_PRIVATE, in_fd, 0);
970 for (i = 0, copy_begin = 0; i < store.seen; i++) {
971 if (store.offset[i] == 0) {
972 store.offset[i] = copy_end = contents_sz;
973 } else if (store.state != KEY_SEEN) {
974 copy_end = store.offset[i];
976 copy_end = find_beginning_of_line(
977 contents, contents_sz,
978 store.offset[i]-2, &new_line);
980 if (copy_end > 0 && contents[copy_end-1] != '\n')
983 /* write the first part of the config */
984 if (copy_end > copy_begin) {
985 if (write_in_full(fd, contents + copy_begin,
986 copy_end - copy_begin) <
987 copy_end - copy_begin)
990 write_in_full(fd, "\n", 1) != 1)
993 copy_begin = store.offset[i];
996 /* write the pair (value == NULL means unset) */
998 if (store.state == START) {
999 if (!store_write_section(fd, key))
1002 if (!store_write_pair(fd, key, value))
1006 /* write the rest of the config */
1007 if (copy_begin < contents_sz)
1008 if (write_in_full(fd, contents + copy_begin,
1009 contents_sz - copy_begin) <
1010 contents_sz - copy_begin)
1013 munmap(contents, contents_sz);
1016 if (commit_lock_file(lock) < 0) {
1017 fprintf(stderr, "Cannot commit config file!\n");
1023 * lock is committed, so don't try to roll it back below.
1024 * NOTE: Since lockfile.c keeps a linked list of all created
1025 * lock_file structures, it isn't safe to free(lock). It's
1026 * better to just leave it hanging around.
1033 rollback_lock_file(lock);
1034 free(config_filename);
1038 ret = write_error();
1043 static int section_name_match (const char *buf, const char *name)
1045 int i = 0, j = 0, dot = 0;
1046 for (; buf[i] && buf[i] != ']'; i++) {
1047 if (!dot && isspace(buf[i])) {
1049 if (name[j++] != '.')
1051 for (i++; isspace(buf[i]); i++)
1057 if (buf[i] == '\\' && dot)
1059 else if (buf[i] == '"' && dot) {
1060 for (i++; isspace(buf[i]); i++)
1064 if (buf[i] != name[j++])
1067 return (buf[i] == ']' && name[j] == 0);
1070 /* if new_name == NULL, the section is removed instead */
1071 int git_config_rename_section(const char *old_name, const char *new_name)
1073 int ret = 0, remove = 0;
1074 char *config_filename;
1075 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1079 config_filename = getenv(CONFIG_ENVIRONMENT);
1080 if (!config_filename) {
1081 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1082 if (!config_filename)
1083 config_filename = git_path("config");
1085 config_filename = xstrdup(config_filename);
1086 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1088 ret = error("Could not lock config file!");
1092 if (!(config_file = fopen(config_filename, "rb"))) {
1093 /* no config file means nothing to rename, no error */
1094 goto unlock_and_out;
1097 while (fgets(buf, sizeof(buf), config_file)) {
1100 for (i = 0; buf[i] && isspace(buf[i]); i++)
1102 if (buf[i] == '[') {
1103 /* it's a section */
1104 if (section_name_match (&buf[i+1], old_name)) {
1106 if (new_name == NULL) {
1110 store.baselen = strlen(new_name);
1111 if (!store_write_section(out_fd, new_name)) {
1112 ret = write_error();
1121 length = strlen(buf);
1122 if (write_in_full(out_fd, buf, length) != length) {
1123 ret = write_error();
1127 fclose(config_file);
1129 if (commit_lock_file(lock) < 0)
1130 ret = error("Cannot commit config file!");
1132 free(config_filename);
1137 * Call this to report error for your variable that should not
1138 * get a boolean value (i.e. "[my] var" means "true").
1140 int config_error_nonbool(const char *var)
1142 return error("Missing value for '%s'", var);