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 zlib_compression_seen;
18 static int get_next_char(void)
24 if ((f = config_file) != NULL) {
27 /* DOS like systems */
44 static char *parse_value(void)
46 static char value[1024];
47 int quote = 0, comment = 0, len = 0, space = 0;
50 int c = get_next_char();
51 if (len >= sizeof(value))
61 if (isspace(c) && !quote) {
66 if (c == ';' || c == '#') {
90 /* Some characters escape as themselves */
93 /* Reject unknown escape sequences */
108 static inline int iskeychar(int c)
110 return isalnum(c) || c == '-';
113 static int get_value(config_fn_t fn, char *name, unsigned int len)
118 /* Get the full name */
125 name[len++] = tolower(c);
130 while (c == ' ' || c == '\t')
137 value = parse_value();
141 return fn(name, value);
144 static int get_extended_base_var(char *name, int baselen, int c)
150 } while (isspace(c));
152 /* We require the format to be '[base "extension"]' */
155 name[baselen++] = '.';
158 int c = get_next_char();
169 if (baselen > MAXNAME / 2)
174 if (get_next_char() != ']')
179 static int get_base_var(char *name)
184 int c = get_next_char();
190 return get_extended_base_var(name, baselen, c);
191 if (!iskeychar(c) && c != '.')
193 if (baselen > MAXNAME / 2)
195 name[baselen++] = tolower(c);
199 static int git_parse_file(config_fn_t fn)
203 static char var[MAXNAME];
206 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 unsigned long get_unit_factor(const char *end)
241 else if (!strcasecmp(end, "k"))
243 else if (!strcasecmp(end, "m"))
245 else if (!strcasecmp(end, "g"))
246 return 1024 * 1024 * 1024;
247 die("unknown unit: '%s'", end);
250 int git_parse_long(const char *value, long *ret)
252 if (value && *value) {
254 long val = strtol(value, &end, 0);
255 *ret = val * get_unit_factor(end);
261 int git_parse_ulong(const char *value, unsigned long *ret)
263 if (value && *value) {
265 unsigned long val = strtoul(value, &end, 0);
266 *ret = val * get_unit_factor(end);
272 int git_config_int(const char *name, const char *value)
275 if (!git_parse_long(value, &ret))
276 die("bad config value for '%s' in %s", name, config_file_name);
280 unsigned long git_config_ulong(const char *name, const char *value)
283 if (!git_parse_ulong(value, &ret))
284 die("bad config value for '%s' in %s", name, config_file_name);
288 int git_config_bool(const char *name, const char *value)
294 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
296 if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
298 return git_config_int(name, value) != 0;
301 int git_default_config(const char *var, const char *value)
303 /* This needs a better name */
304 if (!strcmp(var, "core.filemode")) {
305 trust_executable_bit = git_config_bool(var, value);
309 if (!strcmp(var, "core.quotepath")) {
310 quote_path_fully = git_config_bool(var, value);
314 if (!strcmp(var, "core.symlinks")) {
315 has_symlinks = git_config_bool(var, value);
319 if (!strcmp(var, "core.bare")) {
320 is_bare_repository_cfg = git_config_bool(var, value);
324 if (!strcmp(var, "core.ignorestat")) {
325 assume_unchanged = git_config_bool(var, value);
329 if (!strcmp(var, "core.prefersymlinkrefs")) {
330 prefer_symlink_refs = git_config_bool(var, value);
334 if (!strcmp(var, "core.logallrefupdates")) {
335 log_all_ref_updates = git_config_bool(var, value);
339 if (!strcmp(var, "core.warnambiguousrefs")) {
340 warn_ambiguous_refs = git_config_bool(var, value);
344 if (!strcmp(var, "core.loosecompression")) {
345 int level = git_config_int(var, value);
347 level = Z_DEFAULT_COMPRESSION;
348 else if (level < 0 || level > Z_BEST_COMPRESSION)
349 die("bad zlib compression level %d", level);
350 zlib_compression_level = level;
351 zlib_compression_seen = 1;
355 if (!strcmp(var, "core.compression")) {
356 int level = git_config_int(var, value);
358 level = Z_DEFAULT_COMPRESSION;
359 else if (level < 0 || level > Z_BEST_COMPRESSION)
360 die("bad zlib compression level %d", level);
361 core_compression_level = level;
362 core_compression_seen = 1;
363 if (!zlib_compression_seen)
364 zlib_compression_level = level;
368 if (!strcmp(var, "core.packedgitwindowsize")) {
369 int pgsz_x2 = getpagesize() * 2;
370 packed_git_window_size = git_config_int(var, value);
372 /* This value must be multiple of (pagesize * 2) */
373 packed_git_window_size /= pgsz_x2;
374 if (packed_git_window_size < 1)
375 packed_git_window_size = 1;
376 packed_git_window_size *= pgsz_x2;
380 if (!strcmp(var, "core.packedgitlimit")) {
381 packed_git_limit = git_config_int(var, value);
385 if (!strcmp(var, "core.deltabasecachelimit")) {
386 delta_base_cache_limit = git_config_int(var, value);
390 if (!strcmp(var, "core.autocrlf")) {
391 if (value && !strcasecmp(value, "input")) {
395 auto_crlf = git_config_bool(var, value);
399 if (!strcmp(var, "user.name")) {
400 strlcpy(git_default_name, value, sizeof(git_default_name));
404 if (!strcmp(var, "user.email")) {
405 strlcpy(git_default_email, value, sizeof(git_default_email));
409 if (!strcmp(var, "i18n.commitencoding")) {
410 git_commit_encoding = xstrdup(value);
414 if (!strcmp(var, "i18n.logoutputencoding")) {
415 git_log_output_encoding = xstrdup(value);
420 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
421 pager_use_color = git_config_bool(var,value);
425 if (!strcmp(var, "core.pager")) {
426 pager_program = xstrdup(value);
430 if (!strcmp(var, "core.editor")) {
431 editor_program = xstrdup(value);
435 if (!strcmp(var, "core.excludesfile")) {
437 die("core.excludesfile without value");
438 excludes_file = xstrdup(value);
442 /* Add other config variables here and to Documentation/config.txt. */
446 int git_config_from_file(config_fn_t fn, const char *filename)
449 FILE *f = fopen(filename, "r");
454 config_file_name = filename;
456 ret = git_parse_file(fn);
458 config_file_name = NULL;
463 const char *git_etc_gitconfig(void)
465 static const char *system_wide;
467 system_wide = ETC_GITCONFIG;
468 if (!is_absolute_path(system_wide)) {
469 /* interpret path relative to exec-dir */
470 const char *exec_path = git_exec_path();
471 system_wide = prefix_path(exec_path, strlen(exec_path),
478 int git_config(config_fn_t fn)
481 char *repo_config = NULL;
482 const char *home = NULL, *filename;
484 /* $GIT_CONFIG makes git read _only_ the given config file,
485 * $GIT_CONFIG_LOCAL will make it process it in addition to the
486 * global config file, the same way it would the per-repository
487 * config file otherwise. */
488 filename = getenv(CONFIG_ENVIRONMENT);
490 if (!access(git_etc_gitconfig(), R_OK))
491 ret += git_config_from_file(fn, git_etc_gitconfig());
492 home = getenv("HOME");
493 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
495 filename = repo_config = xstrdup(git_path("config"));
499 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
500 if (!access(user_config, R_OK))
501 ret = git_config_from_file(fn, user_config);
505 ret += git_config_from_file(fn, filename);
511 * Find all the stuff for git_config_set() below.
514 #define MAX_MATCHES 512
520 regex_t* value_regex;
522 size_t offset[MAX_MATCHES];
523 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
527 static int matches(const char* key, const char* value)
529 return !strcmp(key, store.key) &&
530 (store.value_regex == NULL ||
531 (store.do_not_match ^
532 !regexec(store.value_regex, value, 0, NULL, 0)));
535 static int store_aux(const char* key, const char* value)
540 switch (store.state) {
542 if (matches(key, value)) {
543 if (store.seen == 1 && store.multi_replace == 0) {
545 "Warning: %s has multiple values\n",
547 } else if (store.seen >= MAX_MATCHES) {
548 fprintf(stderr, "Too many matches\n");
552 store.offset[store.seen] = ftell(config_file);
558 * What we are looking for is in store.key (both
559 * section and var), and its section part is baselen
560 * long. We found key (again, both section and var).
561 * We would want to know if this key is in the same
562 * section as what we are looking for. We already
563 * know we are in the same section as what should
566 ep = strrchr(key, '.');
567 section_len = ep - key;
569 if ((section_len != store.baselen) ||
570 memcmp(key, store.key, section_len+1)) {
571 store.state = SECTION_END_SEEN;
576 * Do not increment matches: this is no match, but we
577 * just made sure we are in the desired section.
579 store.offset[store.seen] = ftell(config_file);
581 case SECTION_END_SEEN:
583 if (matches(key, value)) {
584 store.offset[store.seen] = ftell(config_file);
585 store.state = KEY_SEEN;
588 if (strrchr(key, '.') - key == store.baselen &&
589 !strncmp(key, store.key, store.baselen)) {
590 store.state = SECTION_SEEN;
591 store.offset[store.seen] = ftell(config_file);
598 static int write_error(void)
600 fprintf(stderr, "Failed to write new configuration file\n");
602 /* Same error code as "failed to rename". */
606 static int store_write_section(int fd, const char* key)
608 const char *dot = strchr(key, '.');
609 int len1 = store.baselen, len2 = -1;
611 dot = strchr(key, '.');
613 int dotlen = dot - key;
615 len2 = len1 - dotlen - 1;
620 if (write_in_full(fd, "[", 1) != 1 ||
621 write_in_full(fd, key, len1) != len1)
624 if (write_in_full(fd, " \"", 2) != 2)
626 while (--len2 >= 0) {
627 unsigned char c = *++dot;
629 if (write_in_full(fd, "\\", 1) != 1)
631 if (write_in_full(fd, &c, 1) != 1)
634 if (write_in_full(fd, "\"", 1) != 1)
637 if (write_in_full(fd, "]\n", 2) != 2)
643 static int store_write_pair(int fd, const char* key, const char* value)
646 int length = strlen(key+store.baselen+1);
650 * Check to see if the value needs to be surrounded with a dq pair.
651 * Note that problematic characters are always backslash-quoted; this
652 * check is about not losing leading or trailing SP and strings that
653 * follow beginning-of-comment characters (i.e. ';' and '#') by the
654 * configuration parser.
658 for (i = 0; value[i]; i++)
659 if (value[i] == ';' || value[i] == '#')
661 if (i && value[i-1] == ' ')
664 if (write_in_full(fd, "\t", 1) != 1 ||
665 write_in_full(fd, key+store.baselen+1, length) != length ||
666 write_in_full(fd, " = ", 3) != 3)
668 if (quote && write_in_full(fd, "\"", 1) != 1)
670 for (i = 0; value[i]; i++)
673 if (write_in_full(fd, "\\n", 2) != 2)
677 if (write_in_full(fd, "\\t", 2) != 2)
682 if (write_in_full(fd, "\\", 1) != 1)
685 if (write_in_full(fd, value+i, 1) != 1)
689 if (quote && write_in_full(fd, "\"", 1) != 1)
691 if (write_in_full(fd, "\n", 1) != 1)
696 static ssize_t find_beginning_of_line(const char* contents, size_t size,
697 size_t offset_, int* found_bracket)
699 size_t equal_offset = size, bracket_offset = size;
702 for (offset = offset_-2; offset > 0
703 && contents[offset] != '\n'; offset--)
704 switch (contents[offset]) {
705 case '=': equal_offset = offset; break;
706 case ']': bracket_offset = offset; break;
708 if (bracket_offset < equal_offset) {
710 offset = bracket_offset+1;
717 int git_config_set(const char* key, const char* value)
719 return git_config_set_multivar(key, value, NULL, 0);
723 * If value==NULL, unset in (remove from) config,
724 * if value_regex!=NULL, disregard key/value pairs where value does not match.
725 * if multi_replace==0, nothing, or only one matching key/value is replaced,
726 * else all matching key/values (regardless how many) are removed,
727 * before the new pair is written.
729 * Returns 0 on success.
731 * This function does this:
733 * - it locks the config file by creating ".git/config.lock"
735 * - it then parses the config using store_aux() as validator to find
736 * the position on the key/value pair to replace. If it is to be unset,
737 * it must be found exactly once.
739 * - the config file is mmap()ed and the part before the match (if any) is
740 * written to the lock file, then the changed part and the rest.
742 * - the config file is removed and the lock file rename()d to it.
745 int git_config_set_multivar(const char* key, const char* value,
746 const char* value_regex, int multi_replace)
751 char* config_filename;
752 struct lock_file *lock = NULL;
753 const char* last_dot = strrchr(key, '.');
755 config_filename = getenv(CONFIG_ENVIRONMENT);
756 if (!config_filename) {
757 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
758 if (!config_filename)
759 config_filename = git_path("config");
761 config_filename = xstrdup(config_filename);
764 * Since "key" actually contains the section name and the real
765 * key name separated by a dot, we have to know where the dot is.
768 if (last_dot == NULL) {
769 fprintf(stderr, "key does not contain a section: %s\n", key);
773 store.baselen = last_dot - key;
775 store.multi_replace = multi_replace;
778 * Validate the key and while at it, lower case it for matching.
780 store.key = xmalloc(strlen(key) + 1);
782 for (i = 0; key[i]; i++) {
783 unsigned char c = key[i];
786 /* Leave the extended basename untouched.. */
787 if (!dot || i > store.baselen) {
788 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
789 fprintf(stderr, "invalid key: %s\n", key);
795 } else if (c == '\n') {
796 fprintf(stderr, "invalid key (newline): %s\n", key);
806 * The lock serves a purpose in addition to locking: the new
807 * contents of .git/config will be written into it.
809 lock = xcalloc(sizeof(struct lock_file), 1);
810 fd = hold_lock_file_for_update(lock, config_filename, 0);
812 fprintf(stderr, "could not lock config file\n");
819 * If .git/config does not exist yet, write a minimal version.
821 in_fd = open(config_filename, O_RDONLY);
825 if ( ENOENT != errno ) {
826 error("opening %s: %s", config_filename,
828 ret = 3; /* same as "invalid config file" */
831 /* if nothing to unset, error out */
837 store.key = (char*)key;
838 if (!store_write_section(fd, key) ||
839 !store_write_pair(fd, key, value))
844 size_t contents_sz, copy_begin, copy_end;
847 if (value_regex == NULL)
848 store.value_regex = NULL;
850 if (value_regex[0] == '!') {
851 store.do_not_match = 1;
854 store.do_not_match = 0;
856 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
857 if (regcomp(store.value_regex, value_regex,
859 fprintf(stderr, "Invalid pattern: %s\n",
861 free(store.value_regex);
872 * After this, store.offset will contain the *end* offset
873 * of the last match, or remain at 0 if no match was found.
874 * As a side effect, we make sure to transform only a valid
875 * existing config file.
877 if (git_config_from_file(store_aux, config_filename)) {
878 fprintf(stderr, "invalid config file\n");
880 if (store.value_regex != NULL) {
881 regfree(store.value_regex);
882 free(store.value_regex);
889 if (store.value_regex != NULL) {
890 regfree(store.value_regex);
891 free(store.value_regex);
894 /* if nothing to unset, or too many matches, error out */
895 if ((store.seen == 0 && value == NULL) ||
896 (store.seen > 1 && multi_replace == 0)) {
902 contents_sz = xsize_t(st.st_size);
903 contents = xmmap(NULL, contents_sz, PROT_READ,
904 MAP_PRIVATE, in_fd, 0);
910 for (i = 0, copy_begin = 0; i < store.seen; i++) {
911 if (store.offset[i] == 0) {
912 store.offset[i] = copy_end = contents_sz;
913 } else if (store.state != KEY_SEEN) {
914 copy_end = store.offset[i];
916 copy_end = find_beginning_of_line(
917 contents, contents_sz,
918 store.offset[i]-2, &new_line);
920 /* write the first part of the config */
921 if (copy_end > copy_begin) {
922 if (write_in_full(fd, contents + copy_begin,
923 copy_end - copy_begin) <
924 copy_end - copy_begin)
927 write_in_full(fd, "\n", 1) != 1)
930 copy_begin = store.offset[i];
933 /* write the pair (value == NULL means unset) */
935 if (store.state == START) {
936 if (!store_write_section(fd, key))
939 if (!store_write_pair(fd, key, value))
943 /* write the rest of the config */
944 if (copy_begin < contents_sz)
945 if (write_in_full(fd, contents + copy_begin,
946 contents_sz - copy_begin) <
947 contents_sz - copy_begin)
950 munmap(contents, contents_sz);
953 if (close(fd) || commit_lock_file(lock) < 0) {
954 fprintf(stderr, "Cannot commit config file!\n");
959 /* fd is closed, so don't try to close it below. */
962 * lock is committed, so don't try to roll it back below.
963 * NOTE: Since lockfile.c keeps a linked list of all created
964 * lock_file structures, it isn't safe to free(lock). It's
965 * better to just leave it hanging around.
974 rollback_lock_file(lock);
975 free(config_filename);
984 static int section_name_match (const char *buf, const char *name)
986 int i = 0, j = 0, dot = 0;
987 for (; buf[i] && buf[i] != ']'; i++) {
988 if (!dot && isspace(buf[i])) {
990 if (name[j++] != '.')
992 for (i++; isspace(buf[i]); i++)
998 if (buf[i] == '\\' && dot)
1000 else if (buf[i] == '"' && dot) {
1001 for (i++; isspace(buf[i]); i++)
1005 if (buf[i] != name[j++])
1008 return (buf[i] == ']' && name[j] == 0);
1011 /* if new_name == NULL, the section is removed instead */
1012 int git_config_rename_section(const char *old_name, const char *new_name)
1014 int ret = 0, remove = 0;
1015 char *config_filename;
1016 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1020 config_filename = getenv(CONFIG_ENVIRONMENT);
1021 if (!config_filename) {
1022 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1023 if (!config_filename)
1024 config_filename = git_path("config");
1026 config_filename = xstrdup(config_filename);
1027 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1029 ret = error("Could not lock config file!");
1033 if (!(config_file = fopen(config_filename, "rb"))) {
1034 /* no config file means nothing to rename, no error */
1035 goto unlock_and_out;
1038 while (fgets(buf, sizeof(buf), config_file)) {
1041 for (i = 0; buf[i] && isspace(buf[i]); i++)
1043 if (buf[i] == '[') {
1044 /* it's a section */
1045 if (section_name_match (&buf[i+1], old_name)) {
1047 if (new_name == NULL) {
1051 store.baselen = strlen(new_name);
1052 if (!store_write_section(out_fd, new_name)) {
1053 ret = write_error();
1062 length = strlen(buf);
1063 if (write_in_full(out_fd, buf, length) != length) {
1064 ret = write_error();
1068 fclose(config_file);
1070 if (close(out_fd) || commit_lock_file(lock) < 0)
1071 ret = error("Cannot commit config file!");
1073 free(config_filename);