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 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_default_config(const char *var, const char *value)
314 /* This needs a better name */
315 if (!strcmp(var, "core.filemode")) {
316 trust_executable_bit = git_config_bool(var, value);
320 if (!strcmp(var, "core.quotepath")) {
321 quote_path_fully = git_config_bool(var, value);
325 if (!strcmp(var, "core.symlinks")) {
326 has_symlinks = git_config_bool(var, value);
330 if (!strcmp(var, "core.bare")) {
331 is_bare_repository_cfg = git_config_bool(var, value);
335 if (!strcmp(var, "core.ignorestat")) {
336 assume_unchanged = git_config_bool(var, value);
340 if (!strcmp(var, "core.prefersymlinkrefs")) {
341 prefer_symlink_refs = git_config_bool(var, value);
345 if (!strcmp(var, "core.logallrefupdates")) {
346 log_all_ref_updates = git_config_bool(var, value);
350 if (!strcmp(var, "core.warnambiguousrefs")) {
351 warn_ambiguous_refs = git_config_bool(var, value);
355 if (!strcmp(var, "core.loosecompression")) {
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 zlib_compression_level = level;
362 zlib_compression_seen = 1;
366 if (!strcmp(var, "core.compression")) {
367 int level = git_config_int(var, value);
369 level = Z_DEFAULT_COMPRESSION;
370 else if (level < 0 || level > Z_BEST_COMPRESSION)
371 die("bad zlib compression level %d", level);
372 core_compression_level = level;
373 core_compression_seen = 1;
374 if (!zlib_compression_seen)
375 zlib_compression_level = level;
379 if (!strcmp(var, "core.packedgitwindowsize")) {
380 int pgsz_x2 = getpagesize() * 2;
381 packed_git_window_size = git_config_int(var, value);
383 /* This value must be multiple of (pagesize * 2) */
384 packed_git_window_size /= pgsz_x2;
385 if (packed_git_window_size < 1)
386 packed_git_window_size = 1;
387 packed_git_window_size *= pgsz_x2;
391 if (!strcmp(var, "core.packedgitlimit")) {
392 packed_git_limit = git_config_int(var, value);
396 if (!strcmp(var, "core.deltabasecachelimit")) {
397 delta_base_cache_limit = git_config_int(var, value);
401 if (!strcmp(var, "core.autocrlf")) {
402 if (value && !strcasecmp(value, "input")) {
406 auto_crlf = git_config_bool(var, value);
410 if (!strcmp(var, "user.name")) {
411 strlcpy(git_default_name, value, sizeof(git_default_name));
415 if (!strcmp(var, "user.email")) {
416 strlcpy(git_default_email, value, sizeof(git_default_email));
420 if (!strcmp(var, "i18n.commitencoding")) {
421 git_commit_encoding = xstrdup(value);
425 if (!strcmp(var, "i18n.logoutputencoding")) {
426 git_log_output_encoding = xstrdup(value);
431 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
432 pager_use_color = git_config_bool(var,value);
436 if (!strcmp(var, "core.pager")) {
437 pager_program = xstrdup(value);
441 if (!strcmp(var, "core.editor")) {
442 editor_program = xstrdup(value);
446 if (!strcmp(var, "core.excludesfile")) {
448 die("core.excludesfile without value");
449 excludes_file = xstrdup(value);
453 if (!strcmp(var, "core.whitespace")) {
454 whitespace_rule_cfg = parse_whitespace_rule(value);
458 /* Add other config variables here and to Documentation/config.txt. */
462 int git_config_from_file(config_fn_t fn, const char *filename)
465 FILE *f = fopen(filename, "r");
470 config_file_name = filename;
472 ret = git_parse_file(fn);
474 config_file_name = NULL;
479 const char *git_etc_gitconfig(void)
481 static const char *system_wide;
483 system_wide = ETC_GITCONFIG;
484 if (!is_absolute_path(system_wide)) {
485 /* interpret path relative to exec-dir */
486 const char *exec_path = git_exec_path();
487 system_wide = prefix_path(exec_path, strlen(exec_path),
494 int git_config(config_fn_t fn)
497 char *repo_config = NULL;
498 const char *home = NULL, *filename;
500 /* $GIT_CONFIG makes git read _only_ the given config file,
501 * $GIT_CONFIG_LOCAL will make it process it in addition to the
502 * global config file, the same way it would the per-repository
503 * config file otherwise. */
504 filename = getenv(CONFIG_ENVIRONMENT);
506 if (!access(git_etc_gitconfig(), R_OK))
507 ret += git_config_from_file(fn, git_etc_gitconfig());
508 home = getenv("HOME");
509 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
511 filename = repo_config = xstrdup(git_path("config"));
515 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
516 if (!access(user_config, R_OK))
517 ret = git_config_from_file(fn, user_config);
521 ret += git_config_from_file(fn, filename);
527 * Find all the stuff for git_config_set() below.
530 #define MAX_MATCHES 512
536 regex_t* value_regex;
538 size_t offset[MAX_MATCHES];
539 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
543 static int matches(const char* key, const char* value)
545 return !strcmp(key, store.key) &&
546 (store.value_regex == NULL ||
547 (store.do_not_match ^
548 !regexec(store.value_regex, value, 0, NULL, 0)));
551 static int store_aux(const char* key, const char* value)
556 switch (store.state) {
558 if (matches(key, value)) {
559 if (store.seen == 1 && store.multi_replace == 0) {
561 "Warning: %s has multiple values\n",
563 } else if (store.seen >= MAX_MATCHES) {
564 fprintf(stderr, "Too many matches\n");
568 store.offset[store.seen] = ftell(config_file);
574 * What we are looking for is in store.key (both
575 * section and var), and its section part is baselen
576 * long. We found key (again, both section and var).
577 * We would want to know if this key is in the same
578 * section as what we are looking for. We already
579 * know we are in the same section as what should
582 ep = strrchr(key, '.');
583 section_len = ep - key;
585 if ((section_len != store.baselen) ||
586 memcmp(key, store.key, section_len+1)) {
587 store.state = SECTION_END_SEEN;
592 * Do not increment matches: this is no match, but we
593 * just made sure we are in the desired section.
595 store.offset[store.seen] = ftell(config_file);
597 case SECTION_END_SEEN:
599 if (matches(key, value)) {
600 store.offset[store.seen] = ftell(config_file);
601 store.state = KEY_SEEN;
604 if (strrchr(key, '.') - key == store.baselen &&
605 !strncmp(key, store.key, store.baselen)) {
606 store.state = SECTION_SEEN;
607 store.offset[store.seen] = ftell(config_file);
614 static int write_error(void)
616 fprintf(stderr, "Failed to write new configuration file\n");
618 /* Same error code as "failed to rename". */
622 static int store_write_section(int fd, const char* key)
629 dot = memchr(key, '.', store.baselen);
631 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
632 for (i = dot - key + 1; i < store.baselen; i++) {
634 strbuf_addch(&sb, '\\');
635 strbuf_addch(&sb, key[i]);
637 strbuf_addstr(&sb, "\"]\n");
639 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
642 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
648 static int store_write_pair(int fd, const char* key, const char* value)
651 int length = strlen(key + store.baselen + 1);
652 const char *quote = "";
656 * Check to see if the value needs to be surrounded with a dq pair.
657 * Note that problematic characters are always backslash-quoted; this
658 * check is about not losing leading or trailing SP and strings that
659 * follow beginning-of-comment characters (i.e. ';' and '#') by the
660 * configuration parser.
664 for (i = 0; value[i]; i++)
665 if (value[i] == ';' || value[i] == '#')
667 if (i && value[i - 1] == ' ')
671 strbuf_addf(&sb, "\t%.*s = %s",
672 length, key + store.baselen + 1, quote);
674 for (i = 0; value[i]; i++)
677 strbuf_addstr(&sb, "\\n");
680 strbuf_addstr(&sb, "\\t");
684 strbuf_addch(&sb, '\\');
686 strbuf_addch(&sb, value[i]);
689 strbuf_addf(&sb, "%s\n", quote);
691 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
697 static ssize_t find_beginning_of_line(const char* contents, size_t size,
698 size_t offset_, int* found_bracket)
700 size_t equal_offset = size, bracket_offset = size;
703 for (offset = offset_-2; offset > 0
704 && contents[offset] != '\n'; offset--)
705 switch (contents[offset]) {
706 case '=': equal_offset = offset; break;
707 case ']': bracket_offset = offset; break;
709 if (bracket_offset < equal_offset) {
711 offset = bracket_offset+1;
718 int git_config_set(const char* key, const char* value)
720 return git_config_set_multivar(key, value, NULL, 0);
724 * If value==NULL, unset in (remove from) config,
725 * if value_regex!=NULL, disregard key/value pairs where value does not match.
726 * if multi_replace==0, nothing, or only one matching key/value is replaced,
727 * else all matching key/values (regardless how many) are removed,
728 * before the new pair is written.
730 * Returns 0 on success.
732 * This function does this:
734 * - it locks the config file by creating ".git/config.lock"
736 * - it then parses the config using store_aux() as validator to find
737 * the position on the key/value pair to replace. If it is to be unset,
738 * it must be found exactly once.
740 * - the config file is mmap()ed and the part before the match (if any) is
741 * written to the lock file, then the changed part and the rest.
743 * - the config file is removed and the lock file rename()d to it.
746 int git_config_set_multivar(const char* key, const char* value,
747 const char* value_regex, int multi_replace)
752 char* config_filename;
753 struct lock_file *lock = NULL;
754 const char* last_dot = strrchr(key, '.');
756 config_filename = getenv(CONFIG_ENVIRONMENT);
757 if (!config_filename) {
758 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
759 if (!config_filename)
760 config_filename = git_path("config");
762 config_filename = xstrdup(config_filename);
765 * Since "key" actually contains the section name and the real
766 * key name separated by a dot, we have to know where the dot is.
769 if (last_dot == NULL) {
770 fprintf(stderr, "key does not contain a section: %s\n", key);
774 store.baselen = last_dot - key;
776 store.multi_replace = multi_replace;
779 * Validate the key and while at it, lower case it for matching.
781 store.key = xmalloc(strlen(key) + 1);
783 for (i = 0; key[i]; i++) {
784 unsigned char c = key[i];
787 /* Leave the extended basename untouched.. */
788 if (!dot || i > store.baselen) {
789 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
790 fprintf(stderr, "invalid key: %s\n", key);
796 } else if (c == '\n') {
797 fprintf(stderr, "invalid key (newline): %s\n", key);
807 * The lock serves a purpose in addition to locking: the new
808 * contents of .git/config will be written into it.
810 lock = xcalloc(sizeof(struct lock_file), 1);
811 fd = hold_lock_file_for_update(lock, config_filename, 0);
813 fprintf(stderr, "could not lock config file\n");
820 * If .git/config does not exist yet, write a minimal version.
822 in_fd = open(config_filename, O_RDONLY);
826 if ( ENOENT != errno ) {
827 error("opening %s: %s", config_filename,
829 ret = 3; /* same as "invalid config file" */
832 /* if nothing to unset, error out */
838 store.key = (char*)key;
839 if (!store_write_section(fd, key) ||
840 !store_write_pair(fd, key, value))
845 size_t contents_sz, copy_begin, copy_end;
848 if (value_regex == NULL)
849 store.value_regex = NULL;
851 if (value_regex[0] == '!') {
852 store.do_not_match = 1;
855 store.do_not_match = 0;
857 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
858 if (regcomp(store.value_regex, value_regex,
860 fprintf(stderr, "Invalid pattern: %s\n",
862 free(store.value_regex);
873 * After this, store.offset will contain the *end* offset
874 * of the last match, or remain at 0 if no match was found.
875 * As a side effect, we make sure to transform only a valid
876 * existing config file.
878 if (git_config_from_file(store_aux, config_filename)) {
879 fprintf(stderr, "invalid config file\n");
881 if (store.value_regex != NULL) {
882 regfree(store.value_regex);
883 free(store.value_regex);
890 if (store.value_regex != NULL) {
891 regfree(store.value_regex);
892 free(store.value_regex);
895 /* if nothing to unset, or too many matches, error out */
896 if ((store.seen == 0 && value == NULL) ||
897 (store.seen > 1 && multi_replace == 0)) {
903 contents_sz = xsize_t(st.st_size);
904 contents = xmmap(NULL, contents_sz, PROT_READ,
905 MAP_PRIVATE, in_fd, 0);
911 for (i = 0, copy_begin = 0; i < store.seen; i++) {
912 if (store.offset[i] == 0) {
913 store.offset[i] = copy_end = contents_sz;
914 } else if (store.state != KEY_SEEN) {
915 copy_end = store.offset[i];
917 copy_end = find_beginning_of_line(
918 contents, contents_sz,
919 store.offset[i]-2, &new_line);
921 /* write the first part of the config */
922 if (copy_end > copy_begin) {
923 if (write_in_full(fd, contents + copy_begin,
924 copy_end - copy_begin) <
925 copy_end - copy_begin)
928 write_in_full(fd, "\n", 1) != 1)
931 copy_begin = store.offset[i];
934 /* write the pair (value == NULL means unset) */
936 if (store.state == START) {
937 if (!store_write_section(fd, key))
940 if (!store_write_pair(fd, key, value))
944 /* write the rest of the config */
945 if (copy_begin < contents_sz)
946 if (write_in_full(fd, contents + copy_begin,
947 contents_sz - copy_begin) <
948 contents_sz - copy_begin)
951 munmap(contents, contents_sz);
954 if (close(fd) || commit_lock_file(lock) < 0) {
955 fprintf(stderr, "Cannot commit config file!\n");
960 /* fd is closed, so don't try to close it below. */
963 * lock is committed, so don't try to roll it back below.
964 * NOTE: Since lockfile.c keeps a linked list of all created
965 * lock_file structures, it isn't safe to free(lock). It's
966 * better to just leave it hanging around.
975 rollback_lock_file(lock);
976 free(config_filename);
985 static int section_name_match (const char *buf, const char *name)
987 int i = 0, j = 0, dot = 0;
988 for (; buf[i] && buf[i] != ']'; i++) {
989 if (!dot && isspace(buf[i])) {
991 if (name[j++] != '.')
993 for (i++; isspace(buf[i]); i++)
999 if (buf[i] == '\\' && dot)
1001 else if (buf[i] == '"' && dot) {
1002 for (i++; isspace(buf[i]); i++)
1006 if (buf[i] != name[j++])
1009 return (buf[i] == ']' && name[j] == 0);
1012 /* if new_name == NULL, the section is removed instead */
1013 int git_config_rename_section(const char *old_name, const char *new_name)
1015 int ret = 0, remove = 0;
1016 char *config_filename;
1017 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1021 config_filename = getenv(CONFIG_ENVIRONMENT);
1022 if (!config_filename) {
1023 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1024 if (!config_filename)
1025 config_filename = git_path("config");
1027 config_filename = xstrdup(config_filename);
1028 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1030 ret = error("Could not lock config file!");
1034 if (!(config_file = fopen(config_filename, "rb"))) {
1035 /* no config file means nothing to rename, no error */
1036 goto unlock_and_out;
1039 while (fgets(buf, sizeof(buf), config_file)) {
1042 for (i = 0; buf[i] && isspace(buf[i]); i++)
1044 if (buf[i] == '[') {
1045 /* it's a section */
1046 if (section_name_match (&buf[i+1], old_name)) {
1048 if (new_name == NULL) {
1052 store.baselen = strlen(new_name);
1053 if (!store_write_section(out_fd, new_name)) {
1054 ret = write_error();
1063 length = strlen(buf);
1064 if (write_in_full(out_fd, buf, length) != length) {
1065 ret = write_error();
1069 fclose(config_file);
1071 if (close(out_fd) || commit_lock_file(lock) < 0)
1072 ret = error("Cannot commit config file!");
1074 free(config_filename);