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 int git_config_int(const char *name, const char *value)
286 if (!git_parse_long(value, &ret))
287 die("bad config value for '%s' in %s", name, config_file_name);
291 unsigned long git_config_ulong(const char *name, const char *value)
294 if (!git_parse_ulong(value, &ret))
295 die("bad config value for '%s' in %s", name, config_file_name);
299 int git_config_bool(const char *name, const char *value)
305 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
307 if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
309 return git_config_int(name, value) != 0;
312 int git_config_string(const char **dest, const char *var, const char *value)
315 return config_error_nonbool(var);
316 *dest = xstrdup(value);
320 int git_default_config(const char *var, const char *value)
322 /* This needs a better name */
323 if (!strcmp(var, "core.filemode")) {
324 trust_executable_bit = git_config_bool(var, value);
328 if (!strcmp(var, "core.quotepath")) {
329 quote_path_fully = git_config_bool(var, value);
333 if (!strcmp(var, "core.symlinks")) {
334 has_symlinks = git_config_bool(var, value);
338 if (!strcmp(var, "core.bare")) {
339 is_bare_repository_cfg = git_config_bool(var, value);
343 if (!strcmp(var, "core.ignorestat")) {
344 assume_unchanged = git_config_bool(var, value);
348 if (!strcmp(var, "core.prefersymlinkrefs")) {
349 prefer_symlink_refs = git_config_bool(var, value);
353 if (!strcmp(var, "core.logallrefupdates")) {
354 log_all_ref_updates = git_config_bool(var, value);
358 if (!strcmp(var, "core.warnambiguousrefs")) {
359 warn_ambiguous_refs = git_config_bool(var, value);
363 if (!strcmp(var, "core.loosecompression")) {
364 int level = git_config_int(var, value);
366 level = Z_DEFAULT_COMPRESSION;
367 else if (level < 0 || level > Z_BEST_COMPRESSION)
368 die("bad zlib compression level %d", level);
369 zlib_compression_level = level;
370 zlib_compression_seen = 1;
374 if (!strcmp(var, "core.compression")) {
375 int level = git_config_int(var, value);
377 level = Z_DEFAULT_COMPRESSION;
378 else if (level < 0 || level > Z_BEST_COMPRESSION)
379 die("bad zlib compression level %d", level);
380 core_compression_level = level;
381 core_compression_seen = 1;
382 if (!zlib_compression_seen)
383 zlib_compression_level = level;
387 if (!strcmp(var, "core.packedgitwindowsize")) {
388 int pgsz_x2 = getpagesize() * 2;
389 packed_git_window_size = git_config_int(var, value);
391 /* This value must be multiple of (pagesize * 2) */
392 packed_git_window_size /= pgsz_x2;
393 if (packed_git_window_size < 1)
394 packed_git_window_size = 1;
395 packed_git_window_size *= pgsz_x2;
399 if (!strcmp(var, "core.packedgitlimit")) {
400 packed_git_limit = git_config_int(var, value);
404 if (!strcmp(var, "core.deltabasecachelimit")) {
405 delta_base_cache_limit = git_config_int(var, value);
409 if (!strcmp(var, "core.autocrlf")) {
410 if (value && !strcasecmp(value, "input")) {
414 auto_crlf = git_config_bool(var, value);
418 if (!strcmp(var, "user.name")) {
420 return config_error_nonbool(var);
421 strlcpy(git_default_name, value, sizeof(git_default_name));
425 if (!strcmp(var, "user.email")) {
427 return config_error_nonbool(var);
428 strlcpy(git_default_email, value, sizeof(git_default_email));
432 if (!strcmp(var, "i18n.commitencoding"))
433 return git_config_string(&git_commit_encoding, var, value);
435 if (!strcmp(var, "i18n.logoutputencoding"))
436 return git_config_string(&git_log_output_encoding, var, value);
438 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
439 pager_use_color = git_config_bool(var,value);
443 if (!strcmp(var, "core.pager"))
444 return git_config_string(&pager_program, var, value);
446 if (!strcmp(var, "core.editor"))
447 return git_config_string(&editor_program, var, value);
449 if (!strcmp(var, "core.excludesfile"))
450 return git_config_string(&excludes_file, var, value);
452 if (!strcmp(var, "core.whitespace")) {
454 return config_error_nonbool(var);
455 whitespace_rule_cfg = parse_whitespace_rule(value);
459 /* Add other config variables here and to Documentation/config.txt. */
463 int git_config_from_file(config_fn_t fn, const char *filename)
466 FILE *f = fopen(filename, "r");
471 config_file_name = filename;
474 ret = git_parse_file(fn);
476 config_file_name = NULL;
481 const char *git_etc_gitconfig(void)
483 static const char *system_wide;
485 system_wide = ETC_GITCONFIG;
486 if (!is_absolute_path(system_wide)) {
487 /* interpret path relative to exec-dir */
488 const char *exec_path = git_exec_path();
489 system_wide = prefix_path(exec_path, strlen(exec_path),
496 int git_config(config_fn_t fn)
499 char *repo_config = NULL;
500 const char *home = NULL, *filename;
502 /* $GIT_CONFIG makes git read _only_ the given config file,
503 * $GIT_CONFIG_LOCAL will make it process it in addition to the
504 * global config file, the same way it would the per-repository
505 * config file otherwise. */
506 filename = getenv(CONFIG_ENVIRONMENT);
508 if (!access(git_etc_gitconfig(), R_OK))
509 ret += git_config_from_file(fn, git_etc_gitconfig());
510 home = getenv("HOME");
511 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
513 filename = repo_config = xstrdup(git_path("config"));
517 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
518 if (!access(user_config, R_OK))
519 ret = git_config_from_file(fn, user_config);
523 ret += git_config_from_file(fn, filename);
529 * Find all the stuff for git_config_set() below.
532 #define MAX_MATCHES 512
538 regex_t* value_regex;
540 size_t offset[MAX_MATCHES];
541 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
545 static int matches(const char* key, const char* value)
547 return !strcmp(key, store.key) &&
548 (store.value_regex == NULL ||
549 (store.do_not_match ^
550 !regexec(store.value_regex, value, 0, NULL, 0)));
553 static int store_aux(const char* key, const char* value)
558 switch (store.state) {
560 if (matches(key, value)) {
561 if (store.seen == 1 && store.multi_replace == 0) {
563 "Warning: %s has multiple values\n",
565 } else if (store.seen >= MAX_MATCHES) {
566 fprintf(stderr, "Too many matches\n");
570 store.offset[store.seen] = ftell(config_file);
576 * What we are looking for is in store.key (both
577 * section and var), and its section part is baselen
578 * long. We found key (again, both section and var).
579 * We would want to know if this key is in the same
580 * section as what we are looking for. We already
581 * know we are in the same section as what should
584 ep = strrchr(key, '.');
585 section_len = ep - key;
587 if ((section_len != store.baselen) ||
588 memcmp(key, store.key, section_len+1)) {
589 store.state = SECTION_END_SEEN;
594 * Do not increment matches: this is no match, but we
595 * just made sure we are in the desired section.
597 store.offset[store.seen] = ftell(config_file);
599 case SECTION_END_SEEN:
601 if (matches(key, value)) {
602 store.offset[store.seen] = ftell(config_file);
603 store.state = KEY_SEEN;
606 if (strrchr(key, '.') - key == store.baselen &&
607 !strncmp(key, store.key, store.baselen)) {
608 store.state = SECTION_SEEN;
609 store.offset[store.seen] = ftell(config_file);
616 static int write_error(void)
618 fprintf(stderr, "Failed to write new configuration file\n");
620 /* Same error code as "failed to rename". */
624 static int store_write_section(int fd, const char* key)
631 dot = memchr(key, '.', store.baselen);
633 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
634 for (i = dot - key + 1; i < store.baselen; i++) {
636 strbuf_addch(&sb, '\\');
637 strbuf_addch(&sb, key[i]);
639 strbuf_addstr(&sb, "\"]\n");
641 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
644 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
650 static int store_write_pair(int fd, const char* key, const char* value)
653 int length = strlen(key + store.baselen + 1);
654 const char *quote = "";
658 * Check to see if the value needs to be surrounded with a dq pair.
659 * Note that problematic characters are always backslash-quoted; this
660 * check is about not losing leading or trailing SP and strings that
661 * follow beginning-of-comment characters (i.e. ';' and '#') by the
662 * configuration parser.
666 for (i = 0; value[i]; i++)
667 if (value[i] == ';' || value[i] == '#')
669 if (i && value[i - 1] == ' ')
673 strbuf_addf(&sb, "\t%.*s = %s",
674 length, key + store.baselen + 1, quote);
676 for (i = 0; value[i]; i++)
679 strbuf_addstr(&sb, "\\n");
682 strbuf_addstr(&sb, "\\t");
686 strbuf_addch(&sb, '\\');
688 strbuf_addch(&sb, value[i]);
691 strbuf_addf(&sb, "%s\n", quote);
693 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
699 static ssize_t find_beginning_of_line(const char* contents, size_t size,
700 size_t offset_, int* found_bracket)
702 size_t equal_offset = size, bracket_offset = size;
706 for (offset = offset_-2; offset > 0
707 && contents[offset] != '\n'; offset--)
708 switch (contents[offset]) {
709 case '=': equal_offset = offset; break;
710 case ']': bracket_offset = offset; break;
712 if (offset > 0 && contents[offset-1] == '\\') {
716 if (bracket_offset < equal_offset) {
718 offset = bracket_offset+1;
725 int git_config_set(const char* key, const char* value)
727 return git_config_set_multivar(key, value, NULL, 0);
731 * If value==NULL, unset in (remove from) config,
732 * if value_regex!=NULL, disregard key/value pairs where value does not match.
733 * if multi_replace==0, nothing, or only one matching key/value is replaced,
734 * else all matching key/values (regardless how many) are removed,
735 * before the new pair is written.
737 * Returns 0 on success.
739 * This function does this:
741 * - it locks the config file by creating ".git/config.lock"
743 * - it then parses the config using store_aux() as validator to find
744 * the position on the key/value pair to replace. If it is to be unset,
745 * it must be found exactly once.
747 * - the config file is mmap()ed and the part before the match (if any) is
748 * written to the lock file, then the changed part and the rest.
750 * - the config file is removed and the lock file rename()d to it.
753 int git_config_set_multivar(const char* key, const char* value,
754 const char* value_regex, int multi_replace)
759 char* config_filename;
760 struct lock_file *lock = NULL;
761 const char* last_dot = strrchr(key, '.');
763 config_filename = getenv(CONFIG_ENVIRONMENT);
764 if (!config_filename) {
765 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
766 if (!config_filename)
767 config_filename = git_path("config");
769 config_filename = xstrdup(config_filename);
772 * Since "key" actually contains the section name and the real
773 * key name separated by a dot, we have to know where the dot is.
776 if (last_dot == NULL) {
777 fprintf(stderr, "key does not contain a section: %s\n", key);
781 store.baselen = last_dot - key;
783 store.multi_replace = multi_replace;
786 * Validate the key and while at it, lower case it for matching.
788 store.key = xmalloc(strlen(key) + 1);
790 for (i = 0; key[i]; i++) {
791 unsigned char c = key[i];
794 /* Leave the extended basename untouched.. */
795 if (!dot || i > store.baselen) {
796 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
797 fprintf(stderr, "invalid key: %s\n", key);
803 } else if (c == '\n') {
804 fprintf(stderr, "invalid key (newline): %s\n", key);
814 * The lock serves a purpose in addition to locking: the new
815 * contents of .git/config will be written into it.
817 lock = xcalloc(sizeof(struct lock_file), 1);
818 fd = hold_lock_file_for_update(lock, config_filename, 0);
820 fprintf(stderr, "could not lock config file\n");
827 * If .git/config does not exist yet, write a minimal version.
829 in_fd = open(config_filename, O_RDONLY);
833 if ( ENOENT != errno ) {
834 error("opening %s: %s", config_filename,
836 ret = 3; /* same as "invalid config file" */
839 /* if nothing to unset, error out */
845 store.key = (char*)key;
846 if (!store_write_section(fd, key) ||
847 !store_write_pair(fd, key, value))
852 size_t contents_sz, copy_begin, copy_end;
855 if (value_regex == NULL)
856 store.value_regex = NULL;
858 if (value_regex[0] == '!') {
859 store.do_not_match = 1;
862 store.do_not_match = 0;
864 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
865 if (regcomp(store.value_regex, value_regex,
867 fprintf(stderr, "Invalid pattern: %s\n",
869 free(store.value_regex);
880 * After this, store.offset will contain the *end* offset
881 * of the last match, or remain at 0 if no match was found.
882 * As a side effect, we make sure to transform only a valid
883 * existing config file.
885 if (git_config_from_file(store_aux, config_filename)) {
886 fprintf(stderr, "invalid config file\n");
888 if (store.value_regex != NULL) {
889 regfree(store.value_regex);
890 free(store.value_regex);
897 if (store.value_regex != NULL) {
898 regfree(store.value_regex);
899 free(store.value_regex);
902 /* if nothing to unset, or too many matches, error out */
903 if ((store.seen == 0 && value == NULL) ||
904 (store.seen > 1 && multi_replace == 0)) {
910 contents_sz = xsize_t(st.st_size);
911 contents = xmmap(NULL, contents_sz, PROT_READ,
912 MAP_PRIVATE, in_fd, 0);
918 for (i = 0, copy_begin = 0; i < store.seen; i++) {
919 if (store.offset[i] == 0) {
920 store.offset[i] = copy_end = contents_sz;
921 } else if (store.state != KEY_SEEN) {
922 copy_end = store.offset[i];
924 copy_end = find_beginning_of_line(
925 contents, contents_sz,
926 store.offset[i]-2, &new_line);
928 if (copy_end > 0 && contents[copy_end-1] != '\n')
931 /* write the first part of the config */
932 if (copy_end > copy_begin) {
933 if (write_in_full(fd, contents + copy_begin,
934 copy_end - copy_begin) <
935 copy_end - copy_begin)
938 write_in_full(fd, "\n", 1) != 1)
941 copy_begin = store.offset[i];
944 /* write the pair (value == NULL means unset) */
946 if (store.state == START) {
947 if (!store_write_section(fd, key))
950 if (!store_write_pair(fd, key, value))
954 /* write the rest of the config */
955 if (copy_begin < contents_sz)
956 if (write_in_full(fd, contents + copy_begin,
957 contents_sz - copy_begin) <
958 contents_sz - copy_begin)
961 munmap(contents, contents_sz);
964 if (commit_lock_file(lock) < 0) {
965 fprintf(stderr, "Cannot commit config file!\n");
971 * lock is committed, so don't try to roll it back below.
972 * NOTE: Since lockfile.c keeps a linked list of all created
973 * lock_file structures, it isn't safe to free(lock). It's
974 * better to just leave it hanging around.
981 rollback_lock_file(lock);
982 free(config_filename);
991 static int section_name_match (const char *buf, const char *name)
993 int i = 0, j = 0, dot = 0;
994 for (; buf[i] && buf[i] != ']'; i++) {
995 if (!dot && isspace(buf[i])) {
997 if (name[j++] != '.')
999 for (i++; isspace(buf[i]); i++)
1005 if (buf[i] == '\\' && dot)
1007 else if (buf[i] == '"' && dot) {
1008 for (i++; isspace(buf[i]); i++)
1012 if (buf[i] != name[j++])
1015 return (buf[i] == ']' && name[j] == 0);
1018 /* if new_name == NULL, the section is removed instead */
1019 int git_config_rename_section(const char *old_name, const char *new_name)
1021 int ret = 0, remove = 0;
1022 char *config_filename;
1023 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1027 config_filename = getenv(CONFIG_ENVIRONMENT);
1028 if (!config_filename) {
1029 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1030 if (!config_filename)
1031 config_filename = git_path("config");
1033 config_filename = xstrdup(config_filename);
1034 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1036 ret = error("Could not lock config file!");
1040 if (!(config_file = fopen(config_filename, "rb"))) {
1041 /* no config file means nothing to rename, no error */
1042 goto unlock_and_out;
1045 while (fgets(buf, sizeof(buf), config_file)) {
1048 for (i = 0; buf[i] && isspace(buf[i]); i++)
1050 if (buf[i] == '[') {
1051 /* it's a section */
1052 if (section_name_match (&buf[i+1], old_name)) {
1054 if (new_name == NULL) {
1058 store.baselen = strlen(new_name);
1059 if (!store_write_section(out_fd, new_name)) {
1060 ret = write_error();
1069 length = strlen(buf);
1070 if (write_in_full(out_fd, buf, length) != length) {
1071 ret = write_error();
1075 fclose(config_file);
1077 if (commit_lock_file(lock) < 0)
1078 ret = error("Cannot commit config file!");
1080 free(config_filename);
1085 * Call this to report error for your variable that should not
1086 * get a boolean value (i.e. "[my] var" means "true").
1088 int config_error_nonbool(const char *var)
1090 return error("Missing value for '%s'", var);