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 const char *git_etc_gitconfig(void)
464 return ETC_GITCONFIG;
467 int git_config(config_fn_t fn)
470 char *repo_config = NULL;
471 const char *home = NULL, *filename;
473 /* $GIT_CONFIG makes git read _only_ the given config file,
474 * $GIT_CONFIG_LOCAL will make it process it in addition to the
475 * global config file, the same way it would the per-repository
476 * config file otherwise. */
477 filename = getenv(CONFIG_ENVIRONMENT);
479 if (!access(git_etc_gitconfig(), R_OK))
480 ret += git_config_from_file(fn, git_etc_gitconfig());
481 home = getenv("HOME");
482 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
484 filename = repo_config = xstrdup(git_path("config"));
488 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
489 if (!access(user_config, R_OK))
490 ret = git_config_from_file(fn, user_config);
494 ret += git_config_from_file(fn, filename);
500 * Find all the stuff for git_config_set() below.
503 #define MAX_MATCHES 512
509 regex_t* value_regex;
511 size_t offset[MAX_MATCHES];
512 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
516 static int matches(const char* key, const char* value)
518 return !strcmp(key, store.key) &&
519 (store.value_regex == NULL ||
520 (store.do_not_match ^
521 !regexec(store.value_regex, value, 0, NULL, 0)));
524 static int store_aux(const char* key, const char* value)
529 switch (store.state) {
531 if (matches(key, value)) {
532 if (store.seen == 1 && store.multi_replace == 0) {
534 "Warning: %s has multiple values\n",
536 } else if (store.seen >= MAX_MATCHES) {
537 fprintf(stderr, "Too many matches\n");
541 store.offset[store.seen] = ftell(config_file);
547 * What we are looking for is in store.key (both
548 * section and var), and its section part is baselen
549 * long. We found key (again, both section and var).
550 * We would want to know if this key is in the same
551 * section as what we are looking for. We already
552 * know we are in the same section as what should
555 ep = strrchr(key, '.');
556 section_len = ep - key;
558 if ((section_len != store.baselen) ||
559 memcmp(key, store.key, section_len+1)) {
560 store.state = SECTION_END_SEEN;
565 * Do not increment matches: this is no match, but we
566 * just made sure we are in the desired section.
568 store.offset[store.seen] = ftell(config_file);
570 case SECTION_END_SEEN:
572 if (matches(key, value)) {
573 store.offset[store.seen] = ftell(config_file);
574 store.state = KEY_SEEN;
577 if (strrchr(key, '.') - key == store.baselen &&
578 !strncmp(key, store.key, store.baselen)) {
579 store.state = SECTION_SEEN;
580 store.offset[store.seen] = ftell(config_file);
587 static int write_error(void)
589 fprintf(stderr, "Failed to write new configuration file\n");
591 /* Same error code as "failed to rename". */
595 static int store_write_section(int fd, const char* key)
597 const char *dot = strchr(key, '.');
598 int len1 = store.baselen, len2 = -1;
600 dot = strchr(key, '.');
602 int dotlen = dot - key;
604 len2 = len1 - dotlen - 1;
609 if (write_in_full(fd, "[", 1) != 1 ||
610 write_in_full(fd, key, len1) != len1)
613 if (write_in_full(fd, " \"", 2) != 2)
615 while (--len2 >= 0) {
616 unsigned char c = *++dot;
618 if (write_in_full(fd, "\\", 1) != 1)
620 if (write_in_full(fd, &c, 1) != 1)
623 if (write_in_full(fd, "\"", 1) != 1)
626 if (write_in_full(fd, "]\n", 2) != 2)
632 static int store_write_pair(int fd, const char* key, const char* value)
635 int length = strlen(key+store.baselen+1);
638 /* Check to see if the value needs to be quoted. */
641 for (i = 0; value[i]; i++)
642 if (value[i] == ';' || value[i] == '#')
644 if (value[i-1] == ' ')
647 if (write_in_full(fd, "\t", 1) != 1 ||
648 write_in_full(fd, key+store.baselen+1, length) != length ||
649 write_in_full(fd, " = ", 3) != 3)
651 if (quote && write_in_full(fd, "\"", 1) != 1)
653 for (i = 0; value[i]; i++)
656 if (write_in_full(fd, "\\n", 2) != 2)
660 if (write_in_full(fd, "\\t", 2) != 2)
665 if (write_in_full(fd, "\\", 1) != 1)
668 if (write_in_full(fd, value+i, 1) != 1)
672 if (quote && write_in_full(fd, "\"", 1) != 1)
674 if (write_in_full(fd, "\n", 1) != 1)
679 static ssize_t find_beginning_of_line(const char* contents, size_t size,
680 size_t offset_, int* found_bracket)
682 size_t equal_offset = size, bracket_offset = size;
685 for (offset = offset_-2; offset > 0
686 && contents[offset] != '\n'; offset--)
687 switch (contents[offset]) {
688 case '=': equal_offset = offset; break;
689 case ']': bracket_offset = offset; break;
691 if (bracket_offset < equal_offset) {
693 offset = bracket_offset+1;
700 int git_config_set(const char* key, const char* value)
702 return git_config_set_multivar(key, value, NULL, 0);
706 * If value==NULL, unset in (remove from) config,
707 * if value_regex!=NULL, disregard key/value pairs where value does not match.
708 * if multi_replace==0, nothing, or only one matching key/value is replaced,
709 * else all matching key/values (regardless how many) are removed,
710 * before the new pair is written.
712 * Returns 0 on success.
714 * This function does this:
716 * - it locks the config file by creating ".git/config.lock"
718 * - it then parses the config using store_aux() as validator to find
719 * the position on the key/value pair to replace. If it is to be unset,
720 * it must be found exactly once.
722 * - the config file is mmap()ed and the part before the match (if any) is
723 * written to the lock file, then the changed part and the rest.
725 * - the config file is removed and the lock file rename()d to it.
728 int git_config_set_multivar(const char* key, const char* value,
729 const char* value_regex, int multi_replace)
734 char* config_filename;
735 struct lock_file *lock = NULL;
736 const char* last_dot = strrchr(key, '.');
738 config_filename = getenv(CONFIG_ENVIRONMENT);
739 if (!config_filename) {
740 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
741 if (!config_filename)
742 config_filename = git_path("config");
744 config_filename = xstrdup(config_filename);
747 * Since "key" actually contains the section name and the real
748 * key name separated by a dot, we have to know where the dot is.
751 if (last_dot == NULL) {
752 fprintf(stderr, "key does not contain a section: %s\n", key);
756 store.baselen = last_dot - key;
758 store.multi_replace = multi_replace;
761 * Validate the key and while at it, lower case it for matching.
763 store.key = xmalloc(strlen(key) + 1);
765 for (i = 0; key[i]; i++) {
766 unsigned char c = key[i];
769 /* Leave the extended basename untouched.. */
770 if (!dot || i > store.baselen) {
771 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
772 fprintf(stderr, "invalid key: %s\n", key);
778 } else if (c == '\n') {
779 fprintf(stderr, "invalid key (newline): %s\n", key);
789 * The lock serves a purpose in addition to locking: the new
790 * contents of .git/config will be written into it.
792 lock = xcalloc(sizeof(struct lock_file), 1);
793 fd = hold_lock_file_for_update(lock, config_filename, 0);
795 fprintf(stderr, "could not lock config file\n");
802 * If .git/config does not exist yet, write a minimal version.
804 in_fd = open(config_filename, O_RDONLY);
808 if ( ENOENT != errno ) {
809 error("opening %s: %s", config_filename,
811 ret = 3; /* same as "invalid config file" */
814 /* if nothing to unset, error out */
820 store.key = (char*)key;
821 if (!store_write_section(fd, key) ||
822 !store_write_pair(fd, key, value))
827 size_t contents_sz, copy_begin, copy_end;
830 if (value_regex == NULL)
831 store.value_regex = NULL;
833 if (value_regex[0] == '!') {
834 store.do_not_match = 1;
837 store.do_not_match = 0;
839 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
840 if (regcomp(store.value_regex, value_regex,
842 fprintf(stderr, "Invalid pattern: %s\n",
844 free(store.value_regex);
855 * After this, store.offset will contain the *end* offset
856 * of the last match, or remain at 0 if no match was found.
857 * As a side effect, we make sure to transform only a valid
858 * existing config file.
860 if (git_config_from_file(store_aux, config_filename)) {
861 fprintf(stderr, "invalid config file\n");
863 if (store.value_regex != NULL) {
864 regfree(store.value_regex);
865 free(store.value_regex);
872 if (store.value_regex != NULL) {
873 regfree(store.value_regex);
874 free(store.value_regex);
877 /* if nothing to unset, or too many matches, error out */
878 if ((store.seen == 0 && value == NULL) ||
879 (store.seen > 1 && multi_replace == 0)) {
885 contents_sz = xsize_t(st.st_size);
886 contents = xmmap(NULL, contents_sz, PROT_READ,
887 MAP_PRIVATE, in_fd, 0);
893 for (i = 0, copy_begin = 0; i < store.seen; i++) {
894 if (store.offset[i] == 0) {
895 store.offset[i] = copy_end = contents_sz;
896 } else if (store.state != KEY_SEEN) {
897 copy_end = store.offset[i];
899 copy_end = find_beginning_of_line(
900 contents, contents_sz,
901 store.offset[i]-2, &new_line);
903 /* write the first part of the config */
904 if (copy_end > copy_begin) {
905 if (write_in_full(fd, contents + copy_begin,
906 copy_end - copy_begin) <
907 copy_end - copy_begin)
910 write_in_full(fd, "\n", 1) != 1)
913 copy_begin = store.offset[i];
916 /* write the pair (value == NULL means unset) */
918 if (store.state == START) {
919 if (!store_write_section(fd, key))
922 if (!store_write_pair(fd, key, value))
926 /* write the rest of the config */
927 if (copy_begin < contents_sz)
928 if (write_in_full(fd, contents + copy_begin,
929 contents_sz - copy_begin) <
930 contents_sz - copy_begin)
933 munmap(contents, contents_sz);
936 if (close(fd) || commit_lock_file(lock) < 0) {
937 fprintf(stderr, "Cannot commit config file!\n");
942 /* fd is closed, so don't try to close it below. */
945 * lock is committed, so don't try to roll it back below.
946 * NOTE: Since lockfile.c keeps a linked list of all created
947 * lock_file structures, it isn't safe to free(lock). It's
948 * better to just leave it hanging around.
957 rollback_lock_file(lock);
958 free(config_filename);
967 static int section_name_match (const char *buf, const char *name)
969 int i = 0, j = 0, dot = 0;
970 for (; buf[i] && buf[i] != ']'; i++) {
971 if (!dot && isspace(buf[i])) {
973 if (name[j++] != '.')
975 for (i++; isspace(buf[i]); i++)
981 if (buf[i] == '\\' && dot)
983 else if (buf[i] == '"' && dot) {
984 for (i++; isspace(buf[i]); i++)
988 if (buf[i] != name[j++])
991 return (buf[i] == ']' && name[j] == 0);
994 /* if new_name == NULL, the section is removed instead */
995 int git_config_rename_section(const char *old_name, const char *new_name)
997 int ret = 0, remove = 0;
998 char *config_filename;
999 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1003 config_filename = getenv(CONFIG_ENVIRONMENT);
1004 if (!config_filename) {
1005 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1006 if (!config_filename)
1007 config_filename = git_path("config");
1009 config_filename = xstrdup(config_filename);
1010 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1012 ret = error("Could not lock config file!");
1016 if (!(config_file = fopen(config_filename, "rb"))) {
1017 /* no config file means nothing to rename, no error */
1018 goto unlock_and_out;
1021 while (fgets(buf, sizeof(buf), config_file)) {
1024 for (i = 0; buf[i] && isspace(buf[i]); i++)
1026 if (buf[i] == '[') {
1027 /* it's a section */
1028 if (section_name_match (&buf[i+1], old_name)) {
1030 if (new_name == NULL) {
1034 store.baselen = strlen(new_name);
1035 if (!store_write_section(out_fd, new_name)) {
1036 ret = write_error();
1045 length = strlen(buf);
1046 if (write_in_full(out_fd, buf, length) != length) {
1047 ret = write_error();
1051 fclose(config_file);
1053 if (close(out_fd) || commit_lock_file(lock) < 0)
1054 ret = error("Cannot commit config file!");
1056 free(config_filename);