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 const char *config_exclusive_filename = NULL;
21 static int get_next_char(void)
27 if ((f = config_file) != NULL) {
30 /* DOS like systems */
47 static char *parse_value(void)
49 static char value[1024];
50 int quote = 0, comment = 0, len = 0, space = 0;
53 int c = get_next_char();
54 if (len >= sizeof(value))
64 if (isspace(c) && !quote) {
69 if (c == ';' || c == '#') {
93 /* Some characters escape as themselves */
96 /* Reject unknown escape sequences */
111 static inline int iskeychar(int c)
113 return isalnum(c) || c == '-';
116 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
121 /* Get the full name */
128 name[len++] = tolower(c);
133 while (c == ' ' || c == '\t')
140 value = parse_value();
144 return fn(name, value, data);
147 static int get_extended_base_var(char *name, int baselen, int c)
153 } while (isspace(c));
155 /* We require the format to be '[base "extension"]' */
158 name[baselen++] = '.';
161 int c = get_next_char();
172 if (baselen > MAXNAME / 2)
177 if (get_next_char() != ']')
182 static int get_base_var(char *name)
187 int c = get_next_char();
193 return get_extended_base_var(name, baselen, c);
194 if (!iskeychar(c) && c != '.')
196 if (baselen > MAXNAME / 2)
198 name[baselen++] = tolower(c);
202 static int git_parse_file(config_fn_t fn, void *data)
206 static char var[MAXNAME];
209 int c = get_next_char();
216 if (comment || isspace(c))
218 if (c == '#' || c == ';') {
223 baselen = get_base_var(var);
226 var[baselen++] = '.';
232 var[baselen] = tolower(c);
233 if (get_value(fn, data, var, baselen+1) < 0)
236 die("bad config file line %d in %s", config_linenr, config_file_name);
239 static int parse_unit_factor(const char *end, unsigned long *val)
243 else if (!strcasecmp(end, "k")) {
247 else if (!strcasecmp(end, "m")) {
251 else if (!strcasecmp(end, "g")) {
252 *val *= 1024 * 1024 * 1024;
258 int git_parse_long(const char *value, long *ret)
260 if (value && *value) {
262 long val = strtol(value, &end, 0);
263 unsigned long factor = 1;
264 if (!parse_unit_factor(end, &factor))
272 int git_parse_ulong(const char *value, unsigned long *ret)
274 if (value && *value) {
276 unsigned long val = strtoul(value, &end, 0);
277 if (!parse_unit_factor(end, &val))
285 static void die_bad_config(const char *name)
287 if (config_file_name)
288 die("bad config value for '%s' in %s", name, config_file_name);
289 die("bad config value for '%s'", name);
292 int git_config_int(const char *name, const char *value)
295 if (!git_parse_long(value, &ret))
296 die_bad_config(name);
300 unsigned long git_config_ulong(const char *name, const char *value)
303 if (!git_parse_ulong(value, &ret))
304 die_bad_config(name);
308 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
315 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
317 if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
320 return git_config_int(name, value);
323 int git_config_bool(const char *name, const char *value)
326 return !!git_config_bool_or_int(name, value, &discard);
329 int git_config_string(const char **dest, const char *var, const char *value)
332 return config_error_nonbool(var);
333 *dest = xstrdup(value);
337 static int git_default_core_config(const char *var, const char *value)
339 /* This needs a better name */
340 if (!strcmp(var, "core.filemode")) {
341 trust_executable_bit = git_config_bool(var, value);
344 if (!strcmp(var, "core.trustctime")) {
345 trust_ctime = git_config_bool(var, value);
349 if (!strcmp(var, "core.quotepath")) {
350 quote_path_fully = git_config_bool(var, value);
354 if (!strcmp(var, "core.symlinks")) {
355 has_symlinks = git_config_bool(var, value);
359 if (!strcmp(var, "core.ignorecase")) {
360 ignore_case = git_config_bool(var, value);
364 if (!strcmp(var, "core.bare")) {
365 is_bare_repository_cfg = git_config_bool(var, value);
369 if (!strcmp(var, "core.ignorestat")) {
370 assume_unchanged = git_config_bool(var, value);
374 if (!strcmp(var, "core.prefersymlinkrefs")) {
375 prefer_symlink_refs = git_config_bool(var, value);
379 if (!strcmp(var, "core.logallrefupdates")) {
380 log_all_ref_updates = git_config_bool(var, value);
384 if (!strcmp(var, "core.warnambiguousrefs")) {
385 warn_ambiguous_refs = git_config_bool(var, value);
389 if (!strcmp(var, "core.loosecompression")) {
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 zlib_compression_level = level;
396 zlib_compression_seen = 1;
400 if (!strcmp(var, "core.compression")) {
401 int level = git_config_int(var, value);
403 level = Z_DEFAULT_COMPRESSION;
404 else if (level < 0 || level > Z_BEST_COMPRESSION)
405 die("bad zlib compression level %d", level);
406 core_compression_level = level;
407 core_compression_seen = 1;
408 if (!zlib_compression_seen)
409 zlib_compression_level = level;
413 if (!strcmp(var, "core.packedgitwindowsize")) {
414 int pgsz_x2 = getpagesize() * 2;
415 packed_git_window_size = git_config_int(var, value);
417 /* This value must be multiple of (pagesize * 2) */
418 packed_git_window_size /= pgsz_x2;
419 if (packed_git_window_size < 1)
420 packed_git_window_size = 1;
421 packed_git_window_size *= pgsz_x2;
425 if (!strcmp(var, "core.packedgitlimit")) {
426 packed_git_limit = git_config_int(var, value);
430 if (!strcmp(var, "core.deltabasecachelimit")) {
431 delta_base_cache_limit = git_config_int(var, value);
435 if (!strcmp(var, "core.autocrlf")) {
436 if (value && !strcasecmp(value, "input")) {
440 auto_crlf = git_config_bool(var, value);
444 if (!strcmp(var, "core.safecrlf")) {
445 if (value && !strcasecmp(value, "warn")) {
446 safe_crlf = SAFE_CRLF_WARN;
449 safe_crlf = git_config_bool(var, value);
453 if (!strcmp(var, "core.pager"))
454 return git_config_string(&pager_program, var, value);
456 if (!strcmp(var, "core.editor"))
457 return git_config_string(&editor_program, var, value);
459 if (!strcmp(var, "core.excludesfile"))
460 return git_config_string(&excludes_file, var, value);
462 if (!strcmp(var, "core.whitespace")) {
464 return config_error_nonbool(var);
465 whitespace_rule_cfg = parse_whitespace_rule(value);
469 if (!strcmp(var, "core.fsyncobjectfiles")) {
470 fsync_object_files = git_config_bool(var, value);
474 /* Add other config variables here and to Documentation/config.txt. */
478 static int git_default_user_config(const char *var, const char *value)
480 if (!strcmp(var, "user.name")) {
482 return config_error_nonbool(var);
483 strlcpy(git_default_name, value, sizeof(git_default_name));
484 if (git_default_email[0])
485 user_ident_explicitly_given = 1;
489 if (!strcmp(var, "user.email")) {
491 return config_error_nonbool(var);
492 strlcpy(git_default_email, value, sizeof(git_default_email));
493 if (git_default_name[0])
494 user_ident_explicitly_given = 1;
498 /* Add other config variables here and to Documentation/config.txt. */
502 static int git_default_i18n_config(const char *var, const char *value)
504 if (!strcmp(var, "i18n.commitencoding"))
505 return git_config_string(&git_commit_encoding, var, value);
507 if (!strcmp(var, "i18n.logoutputencoding"))
508 return git_config_string(&git_log_output_encoding, var, value);
510 /* Add other config variables here and to Documentation/config.txt. */
514 static int git_default_branch_config(const char *var, const char *value)
516 if (!strcmp(var, "branch.autosetupmerge")) {
517 if (value && !strcasecmp(value, "always")) {
518 git_branch_track = BRANCH_TRACK_ALWAYS;
521 git_branch_track = git_config_bool(var, value);
524 if (!strcmp(var, "branch.autosetuprebase")) {
526 return config_error_nonbool(var);
527 else if (!strcmp(value, "never"))
528 autorebase = AUTOREBASE_NEVER;
529 else if (!strcmp(value, "local"))
530 autorebase = AUTOREBASE_LOCAL;
531 else if (!strcmp(value, "remote"))
532 autorebase = AUTOREBASE_REMOTE;
533 else if (!strcmp(value, "always"))
534 autorebase = AUTOREBASE_ALWAYS;
536 return error("Malformed value for %s", var);
540 /* Add other config variables here and to Documentation/config.txt. */
544 int git_default_config(const char *var, const char *value, void *dummy)
546 if (!prefixcmp(var, "core."))
547 return git_default_core_config(var, value);
549 if (!prefixcmp(var, "user."))
550 return git_default_user_config(var, value);
552 if (!prefixcmp(var, "i18n."))
553 return git_default_i18n_config(var, value);
555 if (!prefixcmp(var, "branch."))
556 return git_default_branch_config(var, value);
558 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
559 pager_use_color = git_config_bool(var,value);
563 /* Add other config variables here and to Documentation/config.txt. */
567 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
570 FILE *f = fopen(filename, "r");
575 config_file_name = filename;
578 ret = git_parse_file(fn, data);
580 config_file_name = NULL;
585 const char *git_etc_gitconfig(void)
587 static const char *system_wide;
589 system_wide = system_path(ETC_GITCONFIG);
593 static int git_env_bool(const char *k, int def)
595 const char *v = getenv(k);
596 return v ? git_config_bool(k, v) : def;
599 int git_config_system(void)
601 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
604 int git_config_global(void)
606 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
609 int git_config(config_fn_t fn, void *data)
612 char *repo_config = NULL;
613 const char *home = NULL;
615 /* $GIT_CONFIG makes git read _only_ the given config file,
616 * $GIT_CONFIG_LOCAL will make it process it in addition to the
617 * global config file, the same way it would the per-repository
618 * config file otherwise. */
619 if (config_exclusive_filename)
620 return git_config_from_file(fn, config_exclusive_filename, data);
621 if (git_config_system() && !access(git_etc_gitconfig(), R_OK))
622 ret += git_config_from_file(fn, git_etc_gitconfig(),
625 home = getenv("HOME");
626 if (git_config_global() && home) {
627 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
628 if (!access(user_config, R_OK))
629 ret += git_config_from_file(fn, user_config, data);
633 repo_config = xstrdup(git_path("config"));
634 ret += git_config_from_file(fn, repo_config, data);
640 * Find all the stuff for git_config_set() below.
643 #define MAX_MATCHES 512
649 regex_t* value_regex;
651 size_t offset[MAX_MATCHES];
652 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
656 static int matches(const char* key, const char* value)
658 return !strcmp(key, store.key) &&
659 (store.value_regex == NULL ||
660 (store.do_not_match ^
661 !regexec(store.value_regex, value, 0, NULL, 0)));
664 static int store_aux(const char* key, const char* value, void *cb)
669 switch (store.state) {
671 if (matches(key, value)) {
672 if (store.seen == 1 && store.multi_replace == 0) {
673 warning("%s has multiple values", key);
674 } else if (store.seen >= MAX_MATCHES) {
675 error("too many matches for %s", key);
679 store.offset[store.seen] = ftell(config_file);
685 * What we are looking for is in store.key (both
686 * section and var), and its section part is baselen
687 * long. We found key (again, both section and var).
688 * We would want to know if this key is in the same
689 * section as what we are looking for. We already
690 * know we are in the same section as what should
693 ep = strrchr(key, '.');
694 section_len = ep - key;
696 if ((section_len != store.baselen) ||
697 memcmp(key, store.key, section_len+1)) {
698 store.state = SECTION_END_SEEN;
703 * Do not increment matches: this is no match, but we
704 * just made sure we are in the desired section.
706 store.offset[store.seen] = ftell(config_file);
708 case SECTION_END_SEEN:
710 if (matches(key, value)) {
711 store.offset[store.seen] = ftell(config_file);
712 store.state = KEY_SEEN;
715 if (strrchr(key, '.') - key == store.baselen &&
716 !strncmp(key, store.key, store.baselen)) {
717 store.state = SECTION_SEEN;
718 store.offset[store.seen] = ftell(config_file);
725 static int write_error(const char *filename)
727 error("failed to write new configuration file %s", filename);
729 /* Same error code as "failed to rename". */
733 static int store_write_section(int fd, const char* key)
740 dot = memchr(key, '.', store.baselen);
742 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
743 for (i = dot - key + 1; i < store.baselen; i++) {
744 if (key[i] == '"' || key[i] == '\\')
745 strbuf_addch(&sb, '\\');
746 strbuf_addch(&sb, key[i]);
748 strbuf_addstr(&sb, "\"]\n");
750 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
753 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
759 static int store_write_pair(int fd, const char* key, const char* value)
762 int length = strlen(key + store.baselen + 1);
763 const char *quote = "";
767 * Check to see if the value needs to be surrounded with a dq pair.
768 * Note that problematic characters are always backslash-quoted; this
769 * check is about not losing leading or trailing SP and strings that
770 * follow beginning-of-comment characters (i.e. ';' and '#') by the
771 * configuration parser.
775 for (i = 0; value[i]; i++)
776 if (value[i] == ';' || value[i] == '#')
778 if (i && value[i - 1] == ' ')
782 strbuf_addf(&sb, "\t%.*s = %s",
783 length, key + store.baselen + 1, quote);
785 for (i = 0; value[i]; i++)
788 strbuf_addstr(&sb, "\\n");
791 strbuf_addstr(&sb, "\\t");
795 strbuf_addch(&sb, '\\');
797 strbuf_addch(&sb, value[i]);
800 strbuf_addf(&sb, "%s\n", quote);
802 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
808 static ssize_t find_beginning_of_line(const char* contents, size_t size,
809 size_t offset_, int* found_bracket)
811 size_t equal_offset = size, bracket_offset = size;
815 for (offset = offset_-2; offset > 0
816 && contents[offset] != '\n'; offset--)
817 switch (contents[offset]) {
818 case '=': equal_offset = offset; break;
819 case ']': bracket_offset = offset; break;
821 if (offset > 0 && contents[offset-1] == '\\') {
825 if (bracket_offset < equal_offset) {
827 offset = bracket_offset+1;
834 int git_config_set(const char* key, const char* value)
836 return git_config_set_multivar(key, value, NULL, 0);
840 * If value==NULL, unset in (remove from) config,
841 * if value_regex!=NULL, disregard key/value pairs where value does not match.
842 * if multi_replace==0, nothing, or only one matching key/value is replaced,
843 * else all matching key/values (regardless how many) are removed,
844 * before the new pair is written.
846 * Returns 0 on success.
848 * This function does this:
850 * - it locks the config file by creating ".git/config.lock"
852 * - it then parses the config using store_aux() as validator to find
853 * the position on the key/value pair to replace. If it is to be unset,
854 * it must be found exactly once.
856 * - the config file is mmap()ed and the part before the match (if any) is
857 * written to the lock file, then the changed part and the rest.
859 * - the config file is removed and the lock file rename()d to it.
862 int git_config_set_multivar(const char* key, const char* value,
863 const char* value_regex, int multi_replace)
868 char* config_filename;
869 struct lock_file *lock = NULL;
870 const char* last_dot = strrchr(key, '.');
872 if (config_exclusive_filename)
873 config_filename = xstrdup(config_exclusive_filename);
875 config_filename = xstrdup(git_path("config"));
878 * Since "key" actually contains the section name and the real
879 * key name separated by a dot, we have to know where the dot is.
882 if (last_dot == NULL) {
883 error("key does not contain a section: %s", key);
887 store.baselen = last_dot - key;
889 store.multi_replace = multi_replace;
892 * Validate the key and while at it, lower case it for matching.
894 store.key = xmalloc(strlen(key) + 1);
896 for (i = 0; key[i]; i++) {
897 unsigned char c = key[i];
900 /* Leave the extended basename untouched.. */
901 if (!dot || i > store.baselen) {
902 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
903 error("invalid key: %s", key);
909 } else if (c == '\n') {
910 error("invalid key (newline): %s", key);
920 * The lock serves a purpose in addition to locking: the new
921 * contents of .git/config will be written into it.
923 lock = xcalloc(sizeof(struct lock_file), 1);
924 fd = hold_lock_file_for_update(lock, config_filename, 0);
926 error("could not lock config file %s", config_filename);
933 * If .git/config does not exist yet, write a minimal version.
935 in_fd = open(config_filename, O_RDONLY);
939 if ( ENOENT != errno ) {
940 error("opening %s: %s", config_filename,
942 ret = 3; /* same as "invalid config file" */
945 /* if nothing to unset, error out */
951 store.key = (char*)key;
952 if (!store_write_section(fd, key) ||
953 !store_write_pair(fd, key, value))
958 size_t contents_sz, copy_begin, copy_end;
961 if (value_regex == NULL)
962 store.value_regex = NULL;
964 if (value_regex[0] == '!') {
965 store.do_not_match = 1;
968 store.do_not_match = 0;
970 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
971 if (regcomp(store.value_regex, value_regex,
973 error("invalid pattern: %s", value_regex);
974 free(store.value_regex);
985 * After this, store.offset will contain the *end* offset
986 * of the last match, or remain at 0 if no match was found.
987 * As a side effect, we make sure to transform only a valid
988 * existing config file.
990 if (git_config_from_file(store_aux, config_filename, NULL)) {
991 error("invalid config file %s", config_filename);
993 if (store.value_regex != NULL) {
994 regfree(store.value_regex);
995 free(store.value_regex);
1002 if (store.value_regex != NULL) {
1003 regfree(store.value_regex);
1004 free(store.value_regex);
1007 /* if nothing to unset, or too many matches, error out */
1008 if ((store.seen == 0 && value == NULL) ||
1009 (store.seen > 1 && multi_replace == 0)) {
1015 contents_sz = xsize_t(st.st_size);
1016 contents = xmmap(NULL, contents_sz, PROT_READ,
1017 MAP_PRIVATE, in_fd, 0);
1020 if (store.seen == 0)
1023 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1024 if (store.offset[i] == 0) {
1025 store.offset[i] = copy_end = contents_sz;
1026 } else if (store.state != KEY_SEEN) {
1027 copy_end = store.offset[i];
1029 copy_end = find_beginning_of_line(
1030 contents, contents_sz,
1031 store.offset[i]-2, &new_line);
1033 if (copy_end > 0 && contents[copy_end-1] != '\n')
1036 /* write the first part of the config */
1037 if (copy_end > copy_begin) {
1038 if (write_in_full(fd, contents + copy_begin,
1039 copy_end - copy_begin) <
1040 copy_end - copy_begin)
1043 write_in_full(fd, "\n", 1) != 1)
1046 copy_begin = store.offset[i];
1049 /* write the pair (value == NULL means unset) */
1050 if (value != NULL) {
1051 if (store.state == START) {
1052 if (!store_write_section(fd, key))
1055 if (!store_write_pair(fd, key, value))
1059 /* write the rest of the config */
1060 if (copy_begin < contents_sz)
1061 if (write_in_full(fd, contents + copy_begin,
1062 contents_sz - copy_begin) <
1063 contents_sz - copy_begin)
1066 munmap(contents, contents_sz);
1069 if (commit_lock_file(lock) < 0) {
1070 error("could not commit config file %s", config_filename);
1076 * lock is committed, so don't try to roll it back below.
1077 * NOTE: Since lockfile.c keeps a linked list of all created
1078 * lock_file structures, it isn't safe to free(lock). It's
1079 * better to just leave it hanging around.
1086 rollback_lock_file(lock);
1087 free(config_filename);
1091 ret = write_error(lock->filename);
1096 static int section_name_match (const char *buf, const char *name)
1098 int i = 0, j = 0, dot = 0;
1099 for (; buf[i] && buf[i] != ']'; i++) {
1100 if (!dot && isspace(buf[i])) {
1102 if (name[j++] != '.')
1104 for (i++; isspace(buf[i]); i++)
1110 if (buf[i] == '\\' && dot)
1112 else if (buf[i] == '"' && dot) {
1113 for (i++; isspace(buf[i]); i++)
1117 if (buf[i] != name[j++])
1120 return (buf[i] == ']' && name[j] == 0);
1123 /* if new_name == NULL, the section is removed instead */
1124 int git_config_rename_section(const char *old_name, const char *new_name)
1126 int ret = 0, remove = 0;
1127 char *config_filename;
1128 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1132 if (config_exclusive_filename)
1133 config_filename = xstrdup(config_exclusive_filename);
1135 config_filename = xstrdup(git_path("config"));
1136 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1138 ret = error("could not lock config file %s", config_filename);
1142 if (!(config_file = fopen(config_filename, "rb"))) {
1143 /* no config file means nothing to rename, no error */
1144 goto unlock_and_out;
1147 while (fgets(buf, sizeof(buf), config_file)) {
1150 for (i = 0; buf[i] && isspace(buf[i]); i++)
1152 if (buf[i] == '[') {
1153 /* it's a section */
1154 if (section_name_match (&buf[i+1], old_name)) {
1156 if (new_name == NULL) {
1160 store.baselen = strlen(new_name);
1161 if (!store_write_section(out_fd, new_name)) {
1162 ret = write_error(lock->filename);
1171 length = strlen(buf);
1172 if (write_in_full(out_fd, buf, length) != length) {
1173 ret = write_error(lock->filename);
1177 fclose(config_file);
1179 if (commit_lock_file(lock) < 0)
1180 ret = error("could not commit config file %s", config_filename);
1182 free(config_filename);
1187 * Call this to report error for your variable that should not
1188 * get a boolean value (i.e. "[my] var" means "true").
1190 int config_error_nonbool(const char *var)
1192 return error("Missing value for '%s'", var);