2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
12 static FILE *config_file;
13 static const char *config_file_name;
14 static int config_linenr;
15 static int zlib_compression_seen;
17 static int get_next_char(void)
23 if ((f = config_file) != NULL) {
26 /* DOS like systems */
43 static char *parse_value(void)
45 static char value[1024];
46 int quote = 0, comment = 0, len = 0, space = 0;
49 int c = get_next_char();
50 if (len >= sizeof(value))
60 if (isspace(c) && !quote) {
65 if (c == ';' || c == '#') {
89 /* Some characters escape as themselves */
92 /* Reject unknown escape sequences */
107 static inline int iskeychar(int c)
109 return isalnum(c) || c == '-';
112 static int get_value(config_fn_t fn, char *name, unsigned int len)
117 /* Get the full name */
124 name[len++] = tolower(c);
129 while (c == ' ' || c == '\t')
136 value = parse_value();
140 return fn(name, value);
143 static int get_extended_base_var(char *name, int baselen, int c)
149 } while (isspace(c));
151 /* We require the format to be '[base "extension"]' */
154 name[baselen++] = '.';
157 int c = get_next_char();
168 if (baselen > MAXNAME / 2)
173 if (get_next_char() != ']')
178 static int get_base_var(char *name)
183 int c = get_next_char();
189 return get_extended_base_var(name, baselen, c);
190 if (!iskeychar(c) && c != '.')
192 if (baselen > MAXNAME / 2)
194 name[baselen++] = tolower(c);
198 static int git_parse_file(config_fn_t fn)
202 static char var[MAXNAME];
205 int c = get_next_char();
213 if (comment || isspace(c))
215 if (c == '#' || c == ';') {
220 baselen = get_base_var(var);
223 var[baselen++] = '.';
229 var[baselen] = tolower(c);
230 if (get_value(fn, var, baselen+1) < 0)
233 die("bad config file line %d in %s", config_linenr, config_file_name);
236 static unsigned long get_unit_factor(const char *end)
240 else if (!strcasecmp(end, "k"))
242 else if (!strcasecmp(end, "m"))
244 else if (!strcasecmp(end, "g"))
245 return 1024 * 1024 * 1024;
246 die("unknown unit: '%s'", end);
249 int git_parse_long(const char *value, long *ret)
251 if (value && *value) {
253 long val = strtol(value, &end, 0);
254 *ret = val * get_unit_factor(end);
260 int git_parse_ulong(const char *value, unsigned long *ret)
262 if (value && *value) {
264 unsigned long val = strtoul(value, &end, 0);
265 *ret = val * get_unit_factor(end);
271 int git_config_int(const char *name, const char *value)
274 if (!git_parse_long(value, &ret))
275 die("bad config value for '%s' in %s", name, config_file_name);
279 unsigned long git_config_ulong(const char *name, const char *value)
282 if (!git_parse_ulong(value, &ret))
283 die("bad config value for '%s' in %s", name, config_file_name);
287 int git_config_bool(const char *name, const char *value)
293 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
295 if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
297 return git_config_int(name, value) != 0;
300 int git_default_config(const char *var, const char *value)
302 /* This needs a better name */
303 if (!strcmp(var, "core.filemode")) {
304 trust_executable_bit = git_config_bool(var, value);
308 if (!strcmp(var, "core.quotepath")) {
309 quote_path_fully = git_config_bool(var, value);
313 if (!strcmp(var, "core.symlinks")) {
314 has_symlinks = git_config_bool(var, value);
318 if (!strcmp(var, "core.bare")) {
319 is_bare_repository_cfg = git_config_bool(var, value);
323 if (!strcmp(var, "core.ignorestat")) {
324 assume_unchanged = git_config_bool(var, value);
328 if (!strcmp(var, "core.prefersymlinkrefs")) {
329 prefer_symlink_refs = git_config_bool(var, value);
333 if (!strcmp(var, "core.logallrefupdates")) {
334 log_all_ref_updates = git_config_bool(var, value);
338 if (!strcmp(var, "core.warnambiguousrefs")) {
339 warn_ambiguous_refs = git_config_bool(var, value);
343 if (!strcmp(var, "core.loosecompression")) {
344 int level = git_config_int(var, value);
346 level = Z_DEFAULT_COMPRESSION;
347 else if (level < 0 || level > Z_BEST_COMPRESSION)
348 die("bad zlib compression level %d", level);
349 zlib_compression_level = level;
350 zlib_compression_seen = 1;
354 if (!strcmp(var, "core.compression")) {
355 int level = git_config_int(var, value);
357 level = Z_DEFAULT_COMPRESSION;
358 else if (level < 0 || level > Z_BEST_COMPRESSION)
359 die("bad zlib compression level %d", level);
360 core_compression_level = level;
361 core_compression_seen = 1;
362 if (!zlib_compression_seen)
363 zlib_compression_level = level;
367 if (!strcmp(var, "core.packedgitwindowsize")) {
368 int pgsz_x2 = getpagesize() * 2;
369 packed_git_window_size = git_config_int(var, value);
371 /* This value must be multiple of (pagesize * 2) */
372 packed_git_window_size /= pgsz_x2;
373 if (packed_git_window_size < 1)
374 packed_git_window_size = 1;
375 packed_git_window_size *= pgsz_x2;
379 if (!strcmp(var, "core.packedgitlimit")) {
380 packed_git_limit = git_config_int(var, value);
384 if (!strcmp(var, "core.deltabasecachelimit")) {
385 delta_base_cache_limit = git_config_int(var, value);
389 if (!strcmp(var, "core.autocrlf")) {
390 if (value && !strcasecmp(value, "input")) {
394 auto_crlf = git_config_bool(var, value);
398 if (!strcmp(var, "user.name")) {
399 strlcpy(git_default_name, value, sizeof(git_default_name));
403 if (!strcmp(var, "user.email")) {
404 strlcpy(git_default_email, value, sizeof(git_default_email));
408 if (!strcmp(var, "i18n.commitencoding")) {
409 git_commit_encoding = xstrdup(value);
413 if (!strcmp(var, "i18n.logoutputencoding")) {
414 git_log_output_encoding = xstrdup(value);
419 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
420 pager_use_color = git_config_bool(var,value);
424 if (!strcmp(var, "core.pager")) {
425 pager_program = xstrdup(value);
429 if (!strcmp(var, "core.editor")) {
430 editor_program = xstrdup(value);
434 if (!strcmp(var, "core.excludesfile")) {
436 die("core.excludesfile without value");
437 excludes_file = xstrdup(value);
441 /* Add other config variables here and to Documentation/config.txt. */
445 int git_config_from_file(config_fn_t fn, const char *filename)
448 FILE *f = fopen(filename, "r");
453 config_file_name = filename;
455 ret = git_parse_file(fn);
457 config_file_name = NULL;
462 int git_config(config_fn_t fn)
465 char *repo_config = NULL;
466 const char *home = NULL, *filename;
468 /* $GIT_CONFIG makes git read _only_ the given config file,
469 * $GIT_CONFIG_LOCAL will make it process it in addition to the
470 * global config file, the same way it would the per-repository
471 * config file otherwise. */
472 filename = getenv(CONFIG_ENVIRONMENT);
474 if (!access(ETC_GITCONFIG, R_OK))
475 ret += git_config_from_file(fn, ETC_GITCONFIG);
476 home = getenv("HOME");
477 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
479 filename = repo_config = xstrdup(git_path("config"));
483 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
484 if (!access(user_config, R_OK))
485 ret = git_config_from_file(fn, user_config);
489 ret += git_config_from_file(fn, filename);
495 * Find all the stuff for git_config_set() below.
498 #define MAX_MATCHES 512
504 regex_t* value_regex;
506 size_t offset[MAX_MATCHES];
507 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
511 static int matches(const char* key, const char* value)
513 return !strcmp(key, store.key) &&
514 (store.value_regex == NULL ||
515 (store.do_not_match ^
516 !regexec(store.value_regex, value, 0, NULL, 0)));
519 static int store_aux(const char* key, const char* value)
524 switch (store.state) {
526 if (matches(key, value)) {
527 if (store.seen == 1 && store.multi_replace == 0) {
529 "Warning: %s has multiple values\n",
531 } else if (store.seen >= MAX_MATCHES) {
532 fprintf(stderr, "Too many matches\n");
536 store.offset[store.seen] = ftell(config_file);
542 * What we are looking for is in store.key (both
543 * section and var), and its section part is baselen
544 * long. We found key (again, both section and var).
545 * We would want to know if this key is in the same
546 * section as what we are looking for. We already
547 * know we are in the same section as what should
550 ep = strrchr(key, '.');
551 section_len = ep - key;
553 if ((section_len != store.baselen) ||
554 memcmp(key, store.key, section_len+1)) {
555 store.state = SECTION_END_SEEN;
560 * Do not increment matches: this is no match, but we
561 * just made sure we are in the desired section.
563 store.offset[store.seen] = ftell(config_file);
565 case SECTION_END_SEEN:
567 if (matches(key, value)) {
568 store.offset[store.seen] = ftell(config_file);
569 store.state = KEY_SEEN;
572 if (strrchr(key, '.') - key == store.baselen &&
573 !strncmp(key, store.key, store.baselen)) {
574 store.state = SECTION_SEEN;
575 store.offset[store.seen] = ftell(config_file);
582 static int write_error(void)
584 fprintf(stderr, "Failed to write new configuration file\n");
586 /* Same error code as "failed to rename". */
590 static int store_write_section(int fd, const char* key)
592 const char *dot = strchr(key, '.');
593 int len1 = store.baselen, len2 = -1;
595 dot = strchr(key, '.');
597 int dotlen = dot - key;
599 len2 = len1 - dotlen - 1;
604 if (write_in_full(fd, "[", 1) != 1 ||
605 write_in_full(fd, key, len1) != len1)
608 if (write_in_full(fd, " \"", 2) != 2)
610 while (--len2 >= 0) {
611 unsigned char c = *++dot;
613 if (write_in_full(fd, "\\", 1) != 1)
615 if (write_in_full(fd, &c, 1) != 1)
618 if (write_in_full(fd, "\"", 1) != 1)
621 if (write_in_full(fd, "]\n", 2) != 2)
627 static int store_write_pair(int fd, const char* key, const char* value)
630 int length = strlen(key+store.baselen+1);
634 * Check to see if the value needs to be surrounded with a dq pair.
635 * Note that problematic characters are always backslash-quoted; this
636 * check is about not losing leading or trailing SP and strings that
637 * follow beginning-of-comment characters (i.e. ';' and '#') by the
638 * configuration parser.
642 for (i = 0; value[i]; i++)
643 if (value[i] == ';' || value[i] == '#')
645 if (i && value[i-1] == ' ')
648 if (write_in_full(fd, "\t", 1) != 1 ||
649 write_in_full(fd, key+store.baselen+1, length) != length ||
650 write_in_full(fd, " = ", 3) != 3)
652 if (quote && write_in_full(fd, "\"", 1) != 1)
654 for (i = 0; value[i]; i++)
657 if (write_in_full(fd, "\\n", 2) != 2)
661 if (write_in_full(fd, "\\t", 2) != 2)
666 if (write_in_full(fd, "\\", 1) != 1)
669 if (write_in_full(fd, value+i, 1) != 1)
673 if (quote && write_in_full(fd, "\"", 1) != 1)
675 if (write_in_full(fd, "\n", 1) != 1)
680 static ssize_t find_beginning_of_line(const char* contents, size_t size,
681 size_t offset_, int* found_bracket)
683 size_t equal_offset = size, bracket_offset = size;
686 for (offset = offset_-2; offset > 0
687 && contents[offset] != '\n'; offset--)
688 switch (contents[offset]) {
689 case '=': equal_offset = offset; break;
690 case ']': bracket_offset = offset; break;
692 if (bracket_offset < equal_offset) {
694 offset = bracket_offset+1;
701 int git_config_set(const char* key, const char* value)
703 return git_config_set_multivar(key, value, NULL, 0);
707 * If value==NULL, unset in (remove from) config,
708 * if value_regex!=NULL, disregard key/value pairs where value does not match.
709 * if multi_replace==0, nothing, or only one matching key/value is replaced,
710 * else all matching key/values (regardless how many) are removed,
711 * before the new pair is written.
713 * Returns 0 on success.
715 * This function does this:
717 * - it locks the config file by creating ".git/config.lock"
719 * - it then parses the config using store_aux() as validator to find
720 * the position on the key/value pair to replace. If it is to be unset,
721 * it must be found exactly once.
723 * - the config file is mmap()ed and the part before the match (if any) is
724 * written to the lock file, then the changed part and the rest.
726 * - the config file is removed and the lock file rename()d to it.
729 int git_config_set_multivar(const char* key, const char* value,
730 const char* value_regex, int multi_replace)
735 char* config_filename;
736 struct lock_file *lock = NULL;
737 const char* last_dot = strrchr(key, '.');
739 config_filename = getenv(CONFIG_ENVIRONMENT);
740 if (!config_filename) {
741 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
742 if (!config_filename)
743 config_filename = git_path("config");
745 config_filename = xstrdup(config_filename);
748 * Since "key" actually contains the section name and the real
749 * key name separated by a dot, we have to know where the dot is.
752 if (last_dot == NULL) {
753 fprintf(stderr, "key does not contain a section: %s\n", key);
757 store.baselen = last_dot - key;
759 store.multi_replace = multi_replace;
762 * Validate the key and while at it, lower case it for matching.
764 store.key = xmalloc(strlen(key) + 1);
766 for (i = 0; key[i]; i++) {
767 unsigned char c = key[i];
770 /* Leave the extended basename untouched.. */
771 if (!dot || i > store.baselen) {
772 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
773 fprintf(stderr, "invalid key: %s\n", key);
779 } else if (c == '\n') {
780 fprintf(stderr, "invalid key (newline): %s\n", key);
790 * The lock serves a purpose in addition to locking: the new
791 * contents of .git/config will be written into it.
793 lock = xcalloc(sizeof(struct lock_file), 1);
794 fd = hold_lock_file_for_update(lock, config_filename, 0);
796 fprintf(stderr, "could not lock config file\n");
803 * If .git/config does not exist yet, write a minimal version.
805 in_fd = open(config_filename, O_RDONLY);
809 if ( ENOENT != errno ) {
810 error("opening %s: %s", config_filename,
812 ret = 3; /* same as "invalid config file" */
815 /* if nothing to unset, error out */
821 store.key = (char*)key;
822 if (!store_write_section(fd, key) ||
823 !store_write_pair(fd, key, value))
828 size_t contents_sz, copy_begin, copy_end;
831 if (value_regex == NULL)
832 store.value_regex = NULL;
834 if (value_regex[0] == '!') {
835 store.do_not_match = 1;
838 store.do_not_match = 0;
840 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
841 if (regcomp(store.value_regex, value_regex,
843 fprintf(stderr, "Invalid pattern: %s\n",
845 free(store.value_regex);
856 * After this, store.offset will contain the *end* offset
857 * of the last match, or remain at 0 if no match was found.
858 * As a side effect, we make sure to transform only a valid
859 * existing config file.
861 if (git_config_from_file(store_aux, config_filename)) {
862 fprintf(stderr, "invalid config file\n");
864 if (store.value_regex != NULL) {
865 regfree(store.value_regex);
866 free(store.value_regex);
873 if (store.value_regex != NULL) {
874 regfree(store.value_regex);
875 free(store.value_regex);
878 /* if nothing to unset, or too many matches, error out */
879 if ((store.seen == 0 && value == NULL) ||
880 (store.seen > 1 && multi_replace == 0)) {
886 contents_sz = xsize_t(st.st_size);
887 contents = xmmap(NULL, contents_sz, PROT_READ,
888 MAP_PRIVATE, in_fd, 0);
894 for (i = 0, copy_begin = 0; i < store.seen; i++) {
895 if (store.offset[i] == 0) {
896 store.offset[i] = copy_end = contents_sz;
897 } else if (store.state != KEY_SEEN) {
898 copy_end = store.offset[i];
900 copy_end = find_beginning_of_line(
901 contents, contents_sz,
902 store.offset[i]-2, &new_line);
904 /* write the first part of the config */
905 if (copy_end > copy_begin) {
906 if (write_in_full(fd, contents + copy_begin,
907 copy_end - copy_begin) <
908 copy_end - copy_begin)
911 write_in_full(fd, "\n", 1) != 1)
914 copy_begin = store.offset[i];
917 /* write the pair (value == NULL means unset) */
919 if (store.state == START) {
920 if (!store_write_section(fd, key))
923 if (!store_write_pair(fd, key, value))
927 /* write the rest of the config */
928 if (copy_begin < contents_sz)
929 if (write_in_full(fd, contents + copy_begin,
930 contents_sz - copy_begin) <
931 contents_sz - copy_begin)
934 munmap(contents, contents_sz);
937 if (close(fd) || commit_lock_file(lock) < 0) {
938 fprintf(stderr, "Cannot commit config file!\n");
943 /* fd is closed, so don't try to close it below. */
946 * lock is committed, so don't try to roll it back below.
947 * NOTE: Since lockfile.c keeps a linked list of all created
948 * lock_file structures, it isn't safe to free(lock). It's
949 * better to just leave it hanging around.
958 rollback_lock_file(lock);
959 free(config_filename);
968 static int section_name_match (const char *buf, const char *name)
970 int i = 0, j = 0, dot = 0;
971 for (; buf[i] && buf[i] != ']'; i++) {
972 if (!dot && isspace(buf[i])) {
974 if (name[j++] != '.')
976 for (i++; isspace(buf[i]); i++)
982 if (buf[i] == '\\' && dot)
984 else if (buf[i] == '"' && dot) {
985 for (i++; isspace(buf[i]); i++)
989 if (buf[i] != name[j++])
992 return (buf[i] == ']' && name[j] == 0);
995 /* if new_name == NULL, the section is removed instead */
996 int git_config_rename_section(const char *old_name, const char *new_name)
998 int ret = 0, remove = 0;
999 char *config_filename;
1000 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1004 config_filename = getenv(CONFIG_ENVIRONMENT);
1005 if (!config_filename) {
1006 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1007 if (!config_filename)
1008 config_filename = git_path("config");
1010 config_filename = xstrdup(config_filename);
1011 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1013 ret = error("Could not lock config file!");
1017 if (!(config_file = fopen(config_filename, "rb"))) {
1018 /* no config file means nothing to rename, no error */
1019 goto unlock_and_out;
1022 while (fgets(buf, sizeof(buf), config_file)) {
1025 for (i = 0; buf[i] && isspace(buf[i]); i++)
1027 if (buf[i] == '[') {
1028 /* it's a section */
1029 if (section_name_match (&buf[i+1], old_name)) {
1031 if (new_name == NULL) {
1035 store.baselen = strlen(new_name);
1036 if (!store_write_section(out_fd, new_name)) {
1037 ret = write_error();
1046 length = strlen(buf);
1047 if (write_in_full(out_fd, buf, length) != length) {
1048 ret = write_error();
1052 fclose(config_file);
1054 if (close(out_fd) || commit_lock_file(lock) < 0)
1055 ret = error("Cannot commit config file!");
1057 free(config_filename);