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 static int git_default_core_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, "core.pager"))
448 return git_config_string(&pager_program, var, value);
450 if (!strcmp(var, "core.editor"))
451 return git_config_string(&editor_program, var, value);
453 if (!strcmp(var, "core.excludesfile"))
454 return git_config_string(&excludes_file, var, value);
456 if (!strcmp(var, "core.whitespace")) {
458 return config_error_nonbool(var);
459 whitespace_rule_cfg = parse_whitespace_rule(value);
463 if (!strcmp(var, "core.fsyncobjectfiles")) {
464 fsync_object_files = git_config_bool(var, value);
468 /* Add other config variables here and to Documentation/config.txt. */
472 static int git_default_user_config(const char *var, const char *value)
474 if (!strcmp(var, "user.name")) {
476 return config_error_nonbool(var);
477 strlcpy(git_default_name, value, sizeof(git_default_name));
478 if (git_default_email[0])
479 user_ident_explicitly_given = 1;
483 if (!strcmp(var, "user.email")) {
485 return config_error_nonbool(var);
486 strlcpy(git_default_email, value, sizeof(git_default_email));
487 if (git_default_name[0])
488 user_ident_explicitly_given = 1;
492 /* Add other config variables here and to Documentation/config.txt. */
496 static int git_default_i18n_config(const char *var, const char *value)
498 if (!strcmp(var, "i18n.commitencoding"))
499 return git_config_string(&git_commit_encoding, var, value);
501 if (!strcmp(var, "i18n.logoutputencoding"))
502 return git_config_string(&git_log_output_encoding, var, value);
504 /* Add other config variables here and to Documentation/config.txt. */
508 static int git_default_branch_config(const char *var, const char *value)
510 if (!strcmp(var, "branch.autosetupmerge")) {
511 if (value && !strcasecmp(value, "always")) {
512 git_branch_track = BRANCH_TRACK_ALWAYS;
515 git_branch_track = git_config_bool(var, value);
518 if (!strcmp(var, "branch.autosetuprebase")) {
520 return config_error_nonbool(var);
521 else if (!strcmp(value, "never"))
522 autorebase = AUTOREBASE_NEVER;
523 else if (!strcmp(value, "local"))
524 autorebase = AUTOREBASE_LOCAL;
525 else if (!strcmp(value, "remote"))
526 autorebase = AUTOREBASE_REMOTE;
527 else if (!strcmp(value, "always"))
528 autorebase = AUTOREBASE_ALWAYS;
530 return error("Malformed value for %s", var);
534 /* Add other config variables here and to Documentation/config.txt. */
538 int git_default_config(const char *var, const char *value, void *dummy)
540 if (!prefixcmp(var, "core."))
541 return git_default_core_config(var, value);
543 if (!prefixcmp(var, "user."))
544 return git_default_user_config(var, value);
546 if (!prefixcmp(var, "i18n."))
547 return git_default_i18n_config(var, value);
549 if (!prefixcmp(var, "branch."))
550 return git_default_branch_config(var, value);
552 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
553 pager_use_color = git_config_bool(var,value);
557 /* Add other config variables here and to Documentation/config.txt. */
561 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
564 FILE *f = fopen(filename, "r");
569 config_file_name = filename;
572 ret = git_parse_file(fn, data);
574 config_file_name = NULL;
579 const char *git_etc_gitconfig(void)
581 static const char *system_wide;
583 system_wide = ETC_GITCONFIG;
584 if (!is_absolute_path(system_wide)) {
585 /* interpret path relative to exec-dir */
586 struct strbuf d = STRBUF_INIT;
587 strbuf_addf(&d, "%s/%s", git_exec_path(), system_wide);
588 system_wide = strbuf_detach(&d, NULL);
594 static int git_env_bool(const char *k, int def)
596 const char *v = getenv(k);
597 return v ? git_config_bool(k, v) : def;
600 int git_config_system(void)
602 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
605 int git_config_global(void)
607 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
610 int git_config(config_fn_t fn, void *data)
613 char *repo_config = NULL;
614 const char *home = NULL, *filename;
616 /* $GIT_CONFIG makes git read _only_ the given config file,
617 * $GIT_CONFIG_LOCAL will make it process it in addition to the
618 * global config file, the same way it would the per-repository
619 * config file otherwise. */
620 filename = getenv(CONFIG_ENVIRONMENT);
622 if (git_config_system() && !access(git_etc_gitconfig(), R_OK))
623 ret += git_config_from_file(fn, git_etc_gitconfig(),
625 home = getenv("HOME");
626 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
628 filename = repo_config = xstrdup(git_path("config"));
631 if (git_config_global() && home) {
632 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
633 if (!access(user_config, R_OK))
634 ret = git_config_from_file(fn, user_config, data);
638 ret += git_config_from_file(fn, filename, data);
644 * Find all the stuff for git_config_set() below.
647 #define MAX_MATCHES 512
653 regex_t* value_regex;
655 size_t offset[MAX_MATCHES];
656 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
660 static int matches(const char* key, const char* value)
662 return !strcmp(key, store.key) &&
663 (store.value_regex == NULL ||
664 (store.do_not_match ^
665 !regexec(store.value_regex, value, 0, NULL, 0)));
668 static int store_aux(const char* key, const char* value, void *cb)
673 switch (store.state) {
675 if (matches(key, value)) {
676 if (store.seen == 1 && store.multi_replace == 0) {
677 warning("%s has multiple values", key);
678 } else if (store.seen >= MAX_MATCHES) {
679 error("too many matches for %s", key);
683 store.offset[store.seen] = ftell(config_file);
689 * What we are looking for is in store.key (both
690 * section and var), and its section part is baselen
691 * long. We found key (again, both section and var).
692 * We would want to know if this key is in the same
693 * section as what we are looking for. We already
694 * know we are in the same section as what should
697 ep = strrchr(key, '.');
698 section_len = ep - key;
700 if ((section_len != store.baselen) ||
701 memcmp(key, store.key, section_len+1)) {
702 store.state = SECTION_END_SEEN;
707 * Do not increment matches: this is no match, but we
708 * just made sure we are in the desired section.
710 store.offset[store.seen] = ftell(config_file);
712 case SECTION_END_SEEN:
714 if (matches(key, value)) {
715 store.offset[store.seen] = ftell(config_file);
716 store.state = KEY_SEEN;
719 if (strrchr(key, '.') - key == store.baselen &&
720 !strncmp(key, store.key, store.baselen)) {
721 store.state = SECTION_SEEN;
722 store.offset[store.seen] = ftell(config_file);
729 static int write_error(const char *filename)
731 error("failed to write new configuration file %s", filename);
733 /* Same error code as "failed to rename". */
737 static int store_write_section(int fd, const char* key)
744 dot = memchr(key, '.', store.baselen);
746 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
747 for (i = dot - key + 1; i < store.baselen; i++) {
748 if (key[i] == '"' || key[i] == '\\')
749 strbuf_addch(&sb, '\\');
750 strbuf_addch(&sb, key[i]);
752 strbuf_addstr(&sb, "\"]\n");
754 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
757 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
763 static int store_write_pair(int fd, const char* key, const char* value)
766 int length = strlen(key + store.baselen + 1);
767 const char *quote = "";
771 * Check to see if the value needs to be surrounded with a dq pair.
772 * Note that problematic characters are always backslash-quoted; this
773 * check is about not losing leading or trailing SP and strings that
774 * follow beginning-of-comment characters (i.e. ';' and '#') by the
775 * configuration parser.
779 for (i = 0; value[i]; i++)
780 if (value[i] == ';' || value[i] == '#')
782 if (i && value[i - 1] == ' ')
786 strbuf_addf(&sb, "\t%.*s = %s",
787 length, key + store.baselen + 1, quote);
789 for (i = 0; value[i]; i++)
792 strbuf_addstr(&sb, "\\n");
795 strbuf_addstr(&sb, "\\t");
799 strbuf_addch(&sb, '\\');
801 strbuf_addch(&sb, value[i]);
804 strbuf_addf(&sb, "%s\n", quote);
806 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
812 static ssize_t find_beginning_of_line(const char* contents, size_t size,
813 size_t offset_, int* found_bracket)
815 size_t equal_offset = size, bracket_offset = size;
819 for (offset = offset_-2; offset > 0
820 && contents[offset] != '\n'; offset--)
821 switch (contents[offset]) {
822 case '=': equal_offset = offset; break;
823 case ']': bracket_offset = offset; break;
825 if (offset > 0 && contents[offset-1] == '\\') {
829 if (bracket_offset < equal_offset) {
831 offset = bracket_offset+1;
838 int git_config_set(const char* key, const char* value)
840 return git_config_set_multivar(key, value, NULL, 0);
844 * If value==NULL, unset in (remove from) config,
845 * if value_regex!=NULL, disregard key/value pairs where value does not match.
846 * if multi_replace==0, nothing, or only one matching key/value is replaced,
847 * else all matching key/values (regardless how many) are removed,
848 * before the new pair is written.
850 * Returns 0 on success.
852 * This function does this:
854 * - it locks the config file by creating ".git/config.lock"
856 * - it then parses the config using store_aux() as validator to find
857 * the position on the key/value pair to replace. If it is to be unset,
858 * it must be found exactly once.
860 * - the config file is mmap()ed and the part before the match (if any) is
861 * written to the lock file, then the changed part and the rest.
863 * - the config file is removed and the lock file rename()d to it.
866 int git_config_set_multivar(const char* key, const char* value,
867 const char* value_regex, int multi_replace)
872 char* config_filename;
873 struct lock_file *lock = NULL;
874 const char* last_dot = strrchr(key, '.');
876 config_filename = getenv(CONFIG_ENVIRONMENT);
877 if (!config_filename) {
878 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
879 if (!config_filename)
880 config_filename = git_path("config");
882 config_filename = xstrdup(config_filename);
885 * Since "key" actually contains the section name and the real
886 * key name separated by a dot, we have to know where the dot is.
889 if (last_dot == NULL) {
890 error("key does not contain a section: %s", key);
894 store.baselen = last_dot - key;
896 store.multi_replace = multi_replace;
899 * Validate the key and while at it, lower case it for matching.
901 store.key = xmalloc(strlen(key) + 1);
903 for (i = 0; key[i]; i++) {
904 unsigned char c = key[i];
907 /* Leave the extended basename untouched.. */
908 if (!dot || i > store.baselen) {
909 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
910 error("invalid key: %s", key);
916 } else if (c == '\n') {
917 error("invalid key (newline): %s", key);
927 * The lock serves a purpose in addition to locking: the new
928 * contents of .git/config will be written into it.
930 lock = xcalloc(sizeof(struct lock_file), 1);
931 fd = hold_lock_file_for_update(lock, config_filename, 0);
933 error("could not lock config file %s", config_filename);
940 * If .git/config does not exist yet, write a minimal version.
942 in_fd = open(config_filename, O_RDONLY);
946 if ( ENOENT != errno ) {
947 error("opening %s: %s", config_filename,
949 ret = 3; /* same as "invalid config file" */
952 /* if nothing to unset, error out */
958 store.key = (char*)key;
959 if (!store_write_section(fd, key) ||
960 !store_write_pair(fd, key, value))
965 size_t contents_sz, copy_begin, copy_end;
968 if (value_regex == NULL)
969 store.value_regex = NULL;
971 if (value_regex[0] == '!') {
972 store.do_not_match = 1;
975 store.do_not_match = 0;
977 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
978 if (regcomp(store.value_regex, value_regex,
980 error("invalid pattern: %s", value_regex);
981 free(store.value_regex);
992 * After this, store.offset will contain the *end* offset
993 * of the last match, or remain at 0 if no match was found.
994 * As a side effect, we make sure to transform only a valid
995 * existing config file.
997 if (git_config_from_file(store_aux, config_filename, NULL)) {
998 error("invalid config file %s", config_filename);
1000 if (store.value_regex != NULL) {
1001 regfree(store.value_regex);
1002 free(store.value_regex);
1009 if (store.value_regex != NULL) {
1010 regfree(store.value_regex);
1011 free(store.value_regex);
1014 /* if nothing to unset, or too many matches, error out */
1015 if ((store.seen == 0 && value == NULL) ||
1016 (store.seen > 1 && multi_replace == 0)) {
1022 contents_sz = xsize_t(st.st_size);
1023 contents = xmmap(NULL, contents_sz, PROT_READ,
1024 MAP_PRIVATE, in_fd, 0);
1027 if (store.seen == 0)
1030 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1031 if (store.offset[i] == 0) {
1032 store.offset[i] = copy_end = contents_sz;
1033 } else if (store.state != KEY_SEEN) {
1034 copy_end = store.offset[i];
1036 copy_end = find_beginning_of_line(
1037 contents, contents_sz,
1038 store.offset[i]-2, &new_line);
1040 if (copy_end > 0 && contents[copy_end-1] != '\n')
1043 /* write the first part of the config */
1044 if (copy_end > copy_begin) {
1045 if (write_in_full(fd, contents + copy_begin,
1046 copy_end - copy_begin) <
1047 copy_end - copy_begin)
1050 write_in_full(fd, "\n", 1) != 1)
1053 copy_begin = store.offset[i];
1056 /* write the pair (value == NULL means unset) */
1057 if (value != NULL) {
1058 if (store.state == START) {
1059 if (!store_write_section(fd, key))
1062 if (!store_write_pair(fd, key, value))
1066 /* write the rest of the config */
1067 if (copy_begin < contents_sz)
1068 if (write_in_full(fd, contents + copy_begin,
1069 contents_sz - copy_begin) <
1070 contents_sz - copy_begin)
1073 munmap(contents, contents_sz);
1076 if (commit_lock_file(lock) < 0) {
1077 error("could not commit config file %s", config_filename);
1083 * lock is committed, so don't try to roll it back below.
1084 * NOTE: Since lockfile.c keeps a linked list of all created
1085 * lock_file structures, it isn't safe to free(lock). It's
1086 * better to just leave it hanging around.
1093 rollback_lock_file(lock);
1094 free(config_filename);
1098 ret = write_error(lock->filename);
1103 static int section_name_match (const char *buf, const char *name)
1105 int i = 0, j = 0, dot = 0;
1106 for (; buf[i] && buf[i] != ']'; i++) {
1107 if (!dot && isspace(buf[i])) {
1109 if (name[j++] != '.')
1111 for (i++; isspace(buf[i]); i++)
1117 if (buf[i] == '\\' && dot)
1119 else if (buf[i] == '"' && dot) {
1120 for (i++; isspace(buf[i]); i++)
1124 if (buf[i] != name[j++])
1127 return (buf[i] == ']' && name[j] == 0);
1130 /* if new_name == NULL, the section is removed instead */
1131 int git_config_rename_section(const char *old_name, const char *new_name)
1133 int ret = 0, remove = 0;
1134 char *config_filename;
1135 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1139 config_filename = getenv(CONFIG_ENVIRONMENT);
1140 if (!config_filename) {
1141 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1142 if (!config_filename)
1143 config_filename = git_path("config");
1145 config_filename = xstrdup(config_filename);
1146 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1148 ret = error("could not lock config file %s", config_filename);
1152 if (!(config_file = fopen(config_filename, "rb"))) {
1153 /* no config file means nothing to rename, no error */
1154 goto unlock_and_out;
1157 while (fgets(buf, sizeof(buf), config_file)) {
1160 for (i = 0; buf[i] && isspace(buf[i]); i++)
1162 if (buf[i] == '[') {
1163 /* it's a section */
1164 if (section_name_match (&buf[i+1], old_name)) {
1166 if (new_name == NULL) {
1170 store.baselen = strlen(new_name);
1171 if (!store_write_section(out_fd, new_name)) {
1172 ret = write_error(lock->filename);
1181 length = strlen(buf);
1182 if (write_in_full(out_fd, buf, length) != length) {
1183 ret = write_error(lock->filename);
1187 fclose(config_file);
1189 if (commit_lock_file(lock) < 0)
1190 ret = error("could not commit config file %s", config_filename);
1192 free(config_filename);
1197 * Call this to report error for your variable that should not
1198 * get a boolean value (i.e. "[my] var" means "true").
1200 int config_error_nonbool(const char *var)
1202 return error("Missing value for '%s'", var);