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, "core.safecrlf")) {
419 if (value && !strcasecmp(value, "warn")) {
420 safe_crlf = SAFE_CRLF_WARN;
423 safe_crlf = git_config_bool(var, value);
427 if (!strcmp(var, "user.name")) {
429 return config_error_nonbool(var);
430 strlcpy(git_default_name, value, sizeof(git_default_name));
434 if (!strcmp(var, "user.email")) {
436 return config_error_nonbool(var);
437 strlcpy(git_default_email, value, sizeof(git_default_email));
441 if (!strcmp(var, "i18n.commitencoding"))
442 return git_config_string(&git_commit_encoding, var, value);
444 if (!strcmp(var, "i18n.logoutputencoding"))
445 return git_config_string(&git_log_output_encoding, var, value);
447 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
448 pager_use_color = git_config_bool(var,value);
452 if (!strcmp(var, "core.pager"))
453 return git_config_string(&pager_program, var, value);
455 if (!strcmp(var, "core.editor"))
456 return git_config_string(&editor_program, var, value);
458 if (!strcmp(var, "core.excludesfile"))
459 return git_config_string(&excludes_file, var, value);
461 if (!strcmp(var, "core.whitespace")) {
463 return config_error_nonbool(var);
464 whitespace_rule_cfg = parse_whitespace_rule(value);
468 /* Add other config variables here and to Documentation/config.txt. */
472 int git_config_from_file(config_fn_t fn, const char *filename)
475 FILE *f = fopen(filename, "r");
480 config_file_name = filename;
483 ret = git_parse_file(fn);
485 config_file_name = NULL;
490 const char *git_etc_gitconfig(void)
492 static const char *system_wide;
494 system_wide = ETC_GITCONFIG;
495 if (!is_absolute_path(system_wide)) {
496 /* interpret path relative to exec-dir */
497 struct strbuf d = STRBUF_INIT;
498 strbuf_addf(&d, "%s/%s", git_exec_path(), system_wide);
499 system_wide = strbuf_detach(&d, NULL);
505 int git_env_bool(const char *k, int def)
507 const char *v = getenv(k);
508 return v ? git_config_bool(k, v) : def;
511 int git_config_system(void)
513 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
516 int git_config_global(void)
518 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
521 int git_config(config_fn_t fn)
524 char *repo_config = NULL;
525 const char *home = NULL, *filename;
527 /* $GIT_CONFIG makes git read _only_ the given config file,
528 * $GIT_CONFIG_LOCAL will make it process it in addition to the
529 * global config file, the same way it would the per-repository
530 * config file otherwise. */
531 filename = getenv(CONFIG_ENVIRONMENT);
533 if (git_config_system() && !access(git_etc_gitconfig(), R_OK))
534 ret += git_config_from_file(fn, git_etc_gitconfig());
535 home = getenv("HOME");
536 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
538 filename = repo_config = xstrdup(git_path("config"));
541 if (git_config_global() && home) {
542 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
543 if (!access(user_config, R_OK))
544 ret = git_config_from_file(fn, user_config);
548 ret += git_config_from_file(fn, filename);
554 * Find all the stuff for git_config_set() below.
557 #define MAX_MATCHES 512
563 regex_t* value_regex;
565 size_t offset[MAX_MATCHES];
566 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
570 static int matches(const char* key, const char* value)
572 return !strcmp(key, store.key) &&
573 (store.value_regex == NULL ||
574 (store.do_not_match ^
575 !regexec(store.value_regex, value, 0, NULL, 0)));
578 static int store_aux(const char* key, const char* value)
583 switch (store.state) {
585 if (matches(key, value)) {
586 if (store.seen == 1 && store.multi_replace == 0) {
588 "Warning: %s has multiple values\n",
590 } else if (store.seen >= MAX_MATCHES) {
591 fprintf(stderr, "Too many matches\n");
595 store.offset[store.seen] = ftell(config_file);
601 * What we are looking for is in store.key (both
602 * section and var), and its section part is baselen
603 * long. We found key (again, both section and var).
604 * We would want to know if this key is in the same
605 * section as what we are looking for. We already
606 * know we are in the same section as what should
609 ep = strrchr(key, '.');
610 section_len = ep - key;
612 if ((section_len != store.baselen) ||
613 memcmp(key, store.key, section_len+1)) {
614 store.state = SECTION_END_SEEN;
619 * Do not increment matches: this is no match, but we
620 * just made sure we are in the desired section.
622 store.offset[store.seen] = ftell(config_file);
624 case SECTION_END_SEEN:
626 if (matches(key, value)) {
627 store.offset[store.seen] = ftell(config_file);
628 store.state = KEY_SEEN;
631 if (strrchr(key, '.') - key == store.baselen &&
632 !strncmp(key, store.key, store.baselen)) {
633 store.state = SECTION_SEEN;
634 store.offset[store.seen] = ftell(config_file);
641 static int write_error(void)
643 fprintf(stderr, "Failed to write new configuration file\n");
645 /* Same error code as "failed to rename". */
649 static int store_write_section(int fd, const char* key)
656 dot = memchr(key, '.', store.baselen);
658 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
659 for (i = dot - key + 1; i < store.baselen; i++) {
661 strbuf_addch(&sb, '\\');
662 strbuf_addch(&sb, key[i]);
664 strbuf_addstr(&sb, "\"]\n");
666 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
669 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
675 static int store_write_pair(int fd, const char* key, const char* value)
678 int length = strlen(key + store.baselen + 1);
679 const char *quote = "";
683 * Check to see if the value needs to be surrounded with a dq pair.
684 * Note that problematic characters are always backslash-quoted; this
685 * check is about not losing leading or trailing SP and strings that
686 * follow beginning-of-comment characters (i.e. ';' and '#') by the
687 * configuration parser.
691 for (i = 0; value[i]; i++)
692 if (value[i] == ';' || value[i] == '#')
694 if (i && value[i - 1] == ' ')
698 strbuf_addf(&sb, "\t%.*s = %s",
699 length, key + store.baselen + 1, quote);
701 for (i = 0; value[i]; i++)
704 strbuf_addstr(&sb, "\\n");
707 strbuf_addstr(&sb, "\\t");
711 strbuf_addch(&sb, '\\');
713 strbuf_addch(&sb, value[i]);
716 strbuf_addf(&sb, "%s\n", quote);
718 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
724 static ssize_t find_beginning_of_line(const char* contents, size_t size,
725 size_t offset_, int* found_bracket)
727 size_t equal_offset = size, bracket_offset = size;
731 for (offset = offset_-2; offset > 0
732 && contents[offset] != '\n'; offset--)
733 switch (contents[offset]) {
734 case '=': equal_offset = offset; break;
735 case ']': bracket_offset = offset; break;
737 if (offset > 0 && contents[offset-1] == '\\') {
741 if (bracket_offset < equal_offset) {
743 offset = bracket_offset+1;
750 int git_config_set(const char* key, const char* value)
752 return git_config_set_multivar(key, value, NULL, 0);
756 * If value==NULL, unset in (remove from) config,
757 * if value_regex!=NULL, disregard key/value pairs where value does not match.
758 * if multi_replace==0, nothing, or only one matching key/value is replaced,
759 * else all matching key/values (regardless how many) are removed,
760 * before the new pair is written.
762 * Returns 0 on success.
764 * This function does this:
766 * - it locks the config file by creating ".git/config.lock"
768 * - it then parses the config using store_aux() as validator to find
769 * the position on the key/value pair to replace. If it is to be unset,
770 * it must be found exactly once.
772 * - the config file is mmap()ed and the part before the match (if any) is
773 * written to the lock file, then the changed part and the rest.
775 * - the config file is removed and the lock file rename()d to it.
778 int git_config_set_multivar(const char* key, const char* value,
779 const char* value_regex, int multi_replace)
784 char* config_filename;
785 struct lock_file *lock = NULL;
786 const char* last_dot = strrchr(key, '.');
788 config_filename = getenv(CONFIG_ENVIRONMENT);
789 if (!config_filename) {
790 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
791 if (!config_filename)
792 config_filename = git_path("config");
794 config_filename = xstrdup(config_filename);
797 * Since "key" actually contains the section name and the real
798 * key name separated by a dot, we have to know where the dot is.
801 if (last_dot == NULL) {
802 fprintf(stderr, "key does not contain a section: %s\n", key);
806 store.baselen = last_dot - key;
808 store.multi_replace = multi_replace;
811 * Validate the key and while at it, lower case it for matching.
813 store.key = xmalloc(strlen(key) + 1);
815 for (i = 0; key[i]; i++) {
816 unsigned char c = key[i];
819 /* Leave the extended basename untouched.. */
820 if (!dot || i > store.baselen) {
821 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
822 fprintf(stderr, "invalid key: %s\n", key);
828 } else if (c == '\n') {
829 fprintf(stderr, "invalid key (newline): %s\n", key);
839 * The lock serves a purpose in addition to locking: the new
840 * contents of .git/config will be written into it.
842 lock = xcalloc(sizeof(struct lock_file), 1);
843 fd = hold_lock_file_for_update(lock, config_filename, 0);
845 fprintf(stderr, "could not lock config file\n");
852 * If .git/config does not exist yet, write a minimal version.
854 in_fd = open(config_filename, O_RDONLY);
858 if ( ENOENT != errno ) {
859 error("opening %s: %s", config_filename,
861 ret = 3; /* same as "invalid config file" */
864 /* if nothing to unset, error out */
870 store.key = (char*)key;
871 if (!store_write_section(fd, key) ||
872 !store_write_pair(fd, key, value))
877 size_t contents_sz, copy_begin, copy_end;
880 if (value_regex == NULL)
881 store.value_regex = NULL;
883 if (value_regex[0] == '!') {
884 store.do_not_match = 1;
887 store.do_not_match = 0;
889 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
890 if (regcomp(store.value_regex, value_regex,
892 fprintf(stderr, "Invalid pattern: %s\n",
894 free(store.value_regex);
905 * After this, store.offset will contain the *end* offset
906 * of the last match, or remain at 0 if no match was found.
907 * As a side effect, we make sure to transform only a valid
908 * existing config file.
910 if (git_config_from_file(store_aux, config_filename)) {
911 fprintf(stderr, "invalid config file\n");
913 if (store.value_regex != NULL) {
914 regfree(store.value_regex);
915 free(store.value_regex);
922 if (store.value_regex != NULL) {
923 regfree(store.value_regex);
924 free(store.value_regex);
927 /* if nothing to unset, or too many matches, error out */
928 if ((store.seen == 0 && value == NULL) ||
929 (store.seen > 1 && multi_replace == 0)) {
935 contents_sz = xsize_t(st.st_size);
936 contents = xmmap(NULL, contents_sz, PROT_READ,
937 MAP_PRIVATE, in_fd, 0);
943 for (i = 0, copy_begin = 0; i < store.seen; i++) {
944 if (store.offset[i] == 0) {
945 store.offset[i] = copy_end = contents_sz;
946 } else if (store.state != KEY_SEEN) {
947 copy_end = store.offset[i];
949 copy_end = find_beginning_of_line(
950 contents, contents_sz,
951 store.offset[i]-2, &new_line);
953 if (copy_end > 0 && contents[copy_end-1] != '\n')
956 /* write the first part of the config */
957 if (copy_end > copy_begin) {
958 if (write_in_full(fd, contents + copy_begin,
959 copy_end - copy_begin) <
960 copy_end - copy_begin)
963 write_in_full(fd, "\n", 1) != 1)
966 copy_begin = store.offset[i];
969 /* write the pair (value == NULL means unset) */
971 if (store.state == START) {
972 if (!store_write_section(fd, key))
975 if (!store_write_pair(fd, key, value))
979 /* write the rest of the config */
980 if (copy_begin < contents_sz)
981 if (write_in_full(fd, contents + copy_begin,
982 contents_sz - copy_begin) <
983 contents_sz - copy_begin)
986 munmap(contents, contents_sz);
989 if (commit_lock_file(lock) < 0) {
990 fprintf(stderr, "Cannot commit config file!\n");
996 * lock is committed, so don't try to roll it back below.
997 * NOTE: Since lockfile.c keeps a linked list of all created
998 * lock_file structures, it isn't safe to free(lock). It's
999 * better to just leave it hanging around.
1006 rollback_lock_file(lock);
1007 free(config_filename);
1011 ret = write_error();
1016 static int section_name_match (const char *buf, const char *name)
1018 int i = 0, j = 0, dot = 0;
1019 for (; buf[i] && buf[i] != ']'; i++) {
1020 if (!dot && isspace(buf[i])) {
1022 if (name[j++] != '.')
1024 for (i++; isspace(buf[i]); i++)
1030 if (buf[i] == '\\' && dot)
1032 else if (buf[i] == '"' && dot) {
1033 for (i++; isspace(buf[i]); i++)
1037 if (buf[i] != name[j++])
1040 return (buf[i] == ']' && name[j] == 0);
1043 /* if new_name == NULL, the section is removed instead */
1044 int git_config_rename_section(const char *old_name, const char *new_name)
1046 int ret = 0, remove = 0;
1047 char *config_filename;
1048 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1052 config_filename = getenv(CONFIG_ENVIRONMENT);
1053 if (!config_filename) {
1054 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1055 if (!config_filename)
1056 config_filename = git_path("config");
1058 config_filename = xstrdup(config_filename);
1059 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1061 ret = error("Could not lock config file!");
1065 if (!(config_file = fopen(config_filename, "rb"))) {
1066 /* no config file means nothing to rename, no error */
1067 goto unlock_and_out;
1070 while (fgets(buf, sizeof(buf), config_file)) {
1073 for (i = 0; buf[i] && isspace(buf[i]); i++)
1075 if (buf[i] == '[') {
1076 /* it's a section */
1077 if (section_name_match (&buf[i+1], old_name)) {
1079 if (new_name == NULL) {
1083 store.baselen = strlen(new_name);
1084 if (!store_write_section(out_fd, new_name)) {
1085 ret = write_error();
1094 length = strlen(buf);
1095 if (write_in_full(out_fd, buf, length) != length) {
1096 ret = write_error();
1100 fclose(config_file);
1102 if (commit_lock_file(lock) < 0)
1103 ret = error("Cannot commit config file!");
1105 free(config_filename);
1110 * Call this to report error for your variable that should not
1111 * get a boolean value (i.e. "[my] var" means "true").
1113 int config_error_nonbool(const char *var)
1115 return error("Missing value for '%s'", var);