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, "user.name")) {
420 return config_error_nonbool(var);
421 strlcpy(git_default_name, value, sizeof(git_default_name));
425 if (!strcmp(var, "user.email")) {
427 return config_error_nonbool(var);
428 strlcpy(git_default_email, value, sizeof(git_default_email));
432 if (!strcmp(var, "i18n.commitencoding"))
433 return git_config_string(&git_commit_encoding, var, value);
435 if (!strcmp(var, "i18n.logoutputencoding"))
436 return git_config_string(&git_log_output_encoding, var, value);
438 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
439 pager_use_color = git_config_bool(var,value);
443 if (!strcmp(var, "core.pager"))
444 return git_config_string(&pager_program, var, value);
446 if (!strcmp(var, "core.editor"))
447 return git_config_string(&editor_program, var, value);
449 if (!strcmp(var, "core.excludesfile"))
450 return git_config_string(&excludes_file, var, value);
452 if (!strcmp(var, "core.whitespace")) {
454 return config_error_nonbool(var);
455 whitespace_rule_cfg = parse_whitespace_rule(value);
459 /* Add other config variables here and to Documentation/config.txt. */
463 int git_config_from_file(config_fn_t fn, const char *filename)
466 FILE *f = fopen(filename, "r");
471 config_file_name = filename;
474 ret = git_parse_file(fn);
476 config_file_name = NULL;
481 const char *git_etc_gitconfig(void)
483 static const char *system_wide;
485 system_wide = ETC_GITCONFIG;
486 if (!is_absolute_path(system_wide)) {
487 /* interpret path relative to exec-dir */
488 struct strbuf d = STRBUF_INIT;
489 strbuf_addf(&d, "%s/%s", git_exec_path(), system_wide);
490 system_wide = strbuf_detach(&d, NULL);
496 int git_env_bool(const char *k, int def)
498 const char *v = getenv(k);
499 return v ? git_config_bool(k, v) : def;
502 int git_config_system(void)
504 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
507 int git_config_global(void)
509 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
512 int git_config(config_fn_t fn)
515 char *repo_config = NULL;
516 const char *home = NULL, *filename;
518 /* $GIT_CONFIG makes git read _only_ the given config file,
519 * $GIT_CONFIG_LOCAL will make it process it in addition to the
520 * global config file, the same way it would the per-repository
521 * config file otherwise. */
522 filename = getenv(CONFIG_ENVIRONMENT);
524 if (git_config_system() && !access(git_etc_gitconfig(), R_OK))
525 ret += git_config_from_file(fn, git_etc_gitconfig());
526 home = getenv("HOME");
527 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
529 filename = repo_config = xstrdup(git_path("config"));
532 if (git_config_global() && home) {
533 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
534 if (!access(user_config, R_OK))
535 ret = git_config_from_file(fn, user_config);
539 ret += git_config_from_file(fn, filename);
545 * Find all the stuff for git_config_set() below.
548 #define MAX_MATCHES 512
554 regex_t* value_regex;
556 size_t offset[MAX_MATCHES];
557 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
561 static int matches(const char* key, const char* value)
563 return !strcmp(key, store.key) &&
564 (store.value_regex == NULL ||
565 (store.do_not_match ^
566 !regexec(store.value_regex, value, 0, NULL, 0)));
569 static int store_aux(const char* key, const char* value)
574 switch (store.state) {
576 if (matches(key, value)) {
577 if (store.seen == 1 && store.multi_replace == 0) {
579 "Warning: %s has multiple values\n",
581 } else if (store.seen >= MAX_MATCHES) {
582 fprintf(stderr, "Too many matches\n");
586 store.offset[store.seen] = ftell(config_file);
592 * What we are looking for is in store.key (both
593 * section and var), and its section part is baselen
594 * long. We found key (again, both section and var).
595 * We would want to know if this key is in the same
596 * section as what we are looking for. We already
597 * know we are in the same section as what should
600 ep = strrchr(key, '.');
601 section_len = ep - key;
603 if ((section_len != store.baselen) ||
604 memcmp(key, store.key, section_len+1)) {
605 store.state = SECTION_END_SEEN;
610 * Do not increment matches: this is no match, but we
611 * just made sure we are in the desired section.
613 store.offset[store.seen] = ftell(config_file);
615 case SECTION_END_SEEN:
617 if (matches(key, value)) {
618 store.offset[store.seen] = ftell(config_file);
619 store.state = KEY_SEEN;
622 if (strrchr(key, '.') - key == store.baselen &&
623 !strncmp(key, store.key, store.baselen)) {
624 store.state = SECTION_SEEN;
625 store.offset[store.seen] = ftell(config_file);
632 static int write_error(void)
634 fprintf(stderr, "Failed to write new configuration file\n");
636 /* Same error code as "failed to rename". */
640 static int store_write_section(int fd, const char* key)
647 dot = memchr(key, '.', store.baselen);
649 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
650 for (i = dot - key + 1; i < store.baselen; i++) {
652 strbuf_addch(&sb, '\\');
653 strbuf_addch(&sb, key[i]);
655 strbuf_addstr(&sb, "\"]\n");
657 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
660 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
666 static int store_write_pair(int fd, const char* key, const char* value)
669 int length = strlen(key + store.baselen + 1);
670 const char *quote = "";
674 * Check to see if the value needs to be surrounded with a dq pair.
675 * Note that problematic characters are always backslash-quoted; this
676 * check is about not losing leading or trailing SP and strings that
677 * follow beginning-of-comment characters (i.e. ';' and '#') by the
678 * configuration parser.
682 for (i = 0; value[i]; i++)
683 if (value[i] == ';' || value[i] == '#')
685 if (i && value[i - 1] == ' ')
689 strbuf_addf(&sb, "\t%.*s = %s",
690 length, key + store.baselen + 1, quote);
692 for (i = 0; value[i]; i++)
695 strbuf_addstr(&sb, "\\n");
698 strbuf_addstr(&sb, "\\t");
702 strbuf_addch(&sb, '\\');
704 strbuf_addch(&sb, value[i]);
707 strbuf_addf(&sb, "%s\n", quote);
709 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
715 static ssize_t find_beginning_of_line(const char* contents, size_t size,
716 size_t offset_, int* found_bracket)
718 size_t equal_offset = size, bracket_offset = size;
722 for (offset = offset_-2; offset > 0
723 && contents[offset] != '\n'; offset--)
724 switch (contents[offset]) {
725 case '=': equal_offset = offset; break;
726 case ']': bracket_offset = offset; break;
728 if (offset > 0 && contents[offset-1] == '\\') {
732 if (bracket_offset < equal_offset) {
734 offset = bracket_offset+1;
741 int git_config_set(const char* key, const char* value)
743 return git_config_set_multivar(key, value, NULL, 0);
747 * If value==NULL, unset in (remove from) config,
748 * if value_regex!=NULL, disregard key/value pairs where value does not match.
749 * if multi_replace==0, nothing, or only one matching key/value is replaced,
750 * else all matching key/values (regardless how many) are removed,
751 * before the new pair is written.
753 * Returns 0 on success.
755 * This function does this:
757 * - it locks the config file by creating ".git/config.lock"
759 * - it then parses the config using store_aux() as validator to find
760 * the position on the key/value pair to replace. If it is to be unset,
761 * it must be found exactly once.
763 * - the config file is mmap()ed and the part before the match (if any) is
764 * written to the lock file, then the changed part and the rest.
766 * - the config file is removed and the lock file rename()d to it.
769 int git_config_set_multivar(const char* key, const char* value,
770 const char* value_regex, int multi_replace)
775 char* config_filename;
776 struct lock_file *lock = NULL;
777 const char* last_dot = strrchr(key, '.');
779 config_filename = getenv(CONFIG_ENVIRONMENT);
780 if (!config_filename) {
781 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
782 if (!config_filename)
783 config_filename = git_path("config");
785 config_filename = xstrdup(config_filename);
788 * Since "key" actually contains the section name and the real
789 * key name separated by a dot, we have to know where the dot is.
792 if (last_dot == NULL) {
793 fprintf(stderr, "key does not contain a section: %s\n", key);
797 store.baselen = last_dot - key;
799 store.multi_replace = multi_replace;
802 * Validate the key and while at it, lower case it for matching.
804 store.key = xmalloc(strlen(key) + 1);
806 for (i = 0; key[i]; i++) {
807 unsigned char c = key[i];
810 /* Leave the extended basename untouched.. */
811 if (!dot || i > store.baselen) {
812 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
813 fprintf(stderr, "invalid key: %s\n", key);
819 } else if (c == '\n') {
820 fprintf(stderr, "invalid key (newline): %s\n", key);
830 * The lock serves a purpose in addition to locking: the new
831 * contents of .git/config will be written into it.
833 lock = xcalloc(sizeof(struct lock_file), 1);
834 fd = hold_lock_file_for_update(lock, config_filename, 0);
836 fprintf(stderr, "could not lock config file\n");
843 * If .git/config does not exist yet, write a minimal version.
845 in_fd = open(config_filename, O_RDONLY);
849 if ( ENOENT != errno ) {
850 error("opening %s: %s", config_filename,
852 ret = 3; /* same as "invalid config file" */
855 /* if nothing to unset, error out */
861 store.key = (char*)key;
862 if (!store_write_section(fd, key) ||
863 !store_write_pair(fd, key, value))
868 size_t contents_sz, copy_begin, copy_end;
871 if (value_regex == NULL)
872 store.value_regex = NULL;
874 if (value_regex[0] == '!') {
875 store.do_not_match = 1;
878 store.do_not_match = 0;
880 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
881 if (regcomp(store.value_regex, value_regex,
883 fprintf(stderr, "Invalid pattern: %s\n",
885 free(store.value_regex);
896 * After this, store.offset will contain the *end* offset
897 * of the last match, or remain at 0 if no match was found.
898 * As a side effect, we make sure to transform only a valid
899 * existing config file.
901 if (git_config_from_file(store_aux, config_filename)) {
902 fprintf(stderr, "invalid config file\n");
904 if (store.value_regex != NULL) {
905 regfree(store.value_regex);
906 free(store.value_regex);
913 if (store.value_regex != NULL) {
914 regfree(store.value_regex);
915 free(store.value_regex);
918 /* if nothing to unset, or too many matches, error out */
919 if ((store.seen == 0 && value == NULL) ||
920 (store.seen > 1 && multi_replace == 0)) {
926 contents_sz = xsize_t(st.st_size);
927 contents = xmmap(NULL, contents_sz, PROT_READ,
928 MAP_PRIVATE, in_fd, 0);
934 for (i = 0, copy_begin = 0; i < store.seen; i++) {
935 if (store.offset[i] == 0) {
936 store.offset[i] = copy_end = contents_sz;
937 } else if (store.state != KEY_SEEN) {
938 copy_end = store.offset[i];
940 copy_end = find_beginning_of_line(
941 contents, contents_sz,
942 store.offset[i]-2, &new_line);
944 if (copy_end > 0 && contents[copy_end-1] != '\n')
947 /* write the first part of the config */
948 if (copy_end > copy_begin) {
949 if (write_in_full(fd, contents + copy_begin,
950 copy_end - copy_begin) <
951 copy_end - copy_begin)
954 write_in_full(fd, "\n", 1) != 1)
957 copy_begin = store.offset[i];
960 /* write the pair (value == NULL means unset) */
962 if (store.state == START) {
963 if (!store_write_section(fd, key))
966 if (!store_write_pair(fd, key, value))
970 /* write the rest of the config */
971 if (copy_begin < contents_sz)
972 if (write_in_full(fd, contents + copy_begin,
973 contents_sz - copy_begin) <
974 contents_sz - copy_begin)
977 munmap(contents, contents_sz);
980 if (commit_lock_file(lock) < 0) {
981 fprintf(stderr, "Cannot commit config file!\n");
987 * lock is committed, so don't try to roll it back below.
988 * NOTE: Since lockfile.c keeps a linked list of all created
989 * lock_file structures, it isn't safe to free(lock). It's
990 * better to just leave it hanging around.
997 rollback_lock_file(lock);
998 free(config_filename);
1002 ret = write_error();
1007 static int section_name_match (const char *buf, const char *name)
1009 int i = 0, j = 0, dot = 0;
1010 for (; buf[i] && buf[i] != ']'; i++) {
1011 if (!dot && isspace(buf[i])) {
1013 if (name[j++] != '.')
1015 for (i++; isspace(buf[i]); i++)
1021 if (buf[i] == '\\' && dot)
1023 else if (buf[i] == '"' && dot) {
1024 for (i++; isspace(buf[i]); i++)
1028 if (buf[i] != name[j++])
1031 return (buf[i] == ']' && name[j] == 0);
1034 /* if new_name == NULL, the section is removed instead */
1035 int git_config_rename_section(const char *old_name, const char *new_name)
1037 int ret = 0, remove = 0;
1038 char *config_filename;
1039 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1043 config_filename = getenv(CONFIG_ENVIRONMENT);
1044 if (!config_filename) {
1045 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
1046 if (!config_filename)
1047 config_filename = git_path("config");
1049 config_filename = xstrdup(config_filename);
1050 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1052 ret = error("Could not lock config file!");
1056 if (!(config_file = fopen(config_filename, "rb"))) {
1057 /* no config file means nothing to rename, no error */
1058 goto unlock_and_out;
1061 while (fgets(buf, sizeof(buf), config_file)) {
1064 for (i = 0; buf[i] && isspace(buf[i]); i++)
1066 if (buf[i] == '[') {
1067 /* it's a section */
1068 if (section_name_match (&buf[i+1], old_name)) {
1070 if (new_name == NULL) {
1074 store.baselen = strlen(new_name);
1075 if (!store_write_section(out_fd, new_name)) {
1076 ret = write_error();
1085 length = strlen(buf);
1086 if (write_in_full(out_fd, buf, length) != length) {
1087 ret = write_error();
1091 fclose(config_file);
1093 if (commit_lock_file(lock) < 0)
1094 ret = error("Cannot commit config file!");
1096 free(config_filename);
1101 * Call this to report error for your variable that should not
1102 * get a boolean value (i.e. "[my] var" means "true").
1104 int config_error_nonbool(const char *var)
1106 return error("Missing value for '%s'", var);