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 /* Add other config variables here and to Documentation/config.txt. */
433 int git_config_from_file(config_fn_t fn, const char *filename)
436 FILE *f = fopen(filename, "r");
441 config_file_name = filename;
443 ret = git_parse_file(fn);
445 config_file_name = NULL;
450 int git_config(config_fn_t fn)
453 char *repo_config = NULL;
454 const char *home = NULL, *filename;
456 /* $GIT_CONFIG makes git read _only_ the given config file,
457 * $GIT_CONFIG_LOCAL will make it process it in addition to the
458 * global config file, the same way it would the per-repository
459 * config file otherwise. */
460 filename = getenv(CONFIG_ENVIRONMENT);
462 if (!access(ETC_GITCONFIG, R_OK))
463 ret += git_config_from_file(fn, ETC_GITCONFIG);
464 home = getenv("HOME");
465 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
467 filename = repo_config = xstrdup(git_path("config"));
471 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
472 if (!access(user_config, R_OK))
473 ret = git_config_from_file(fn, user_config);
477 ret += git_config_from_file(fn, filename);
483 * Find all the stuff for git_config_set() below.
486 #define MAX_MATCHES 512
492 regex_t* value_regex;
494 size_t offset[MAX_MATCHES];
495 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
499 static int matches(const char* key, const char* value)
501 return !strcmp(key, store.key) &&
502 (store.value_regex == NULL ||
503 (store.do_not_match ^
504 !regexec(store.value_regex, value, 0, NULL, 0)));
507 static int store_aux(const char* key, const char* value)
512 switch (store.state) {
514 if (matches(key, value)) {
515 if (store.seen == 1 && store.multi_replace == 0) {
517 "Warning: %s has multiple values\n",
519 } else if (store.seen >= MAX_MATCHES) {
520 fprintf(stderr, "Too many matches\n");
524 store.offset[store.seen] = ftell(config_file);
530 * What we are looking for is in store.key (both
531 * section and var), and its section part is baselen
532 * long. We found key (again, both section and var).
533 * We would want to know if this key is in the same
534 * section as what we are looking for. We already
535 * know we are in the same section as what should
538 ep = strrchr(key, '.');
539 section_len = ep - key;
541 if ((section_len != store.baselen) ||
542 memcmp(key, store.key, section_len+1)) {
543 store.state = SECTION_END_SEEN;
548 * Do not increment matches: this is no match, but we
549 * just made sure we are in the desired section.
551 store.offset[store.seen] = ftell(config_file);
553 case SECTION_END_SEEN:
555 if (matches(key, value)) {
556 store.offset[store.seen] = ftell(config_file);
557 store.state = KEY_SEEN;
560 if (strrchr(key, '.') - key == store.baselen &&
561 !strncmp(key, store.key, store.baselen)) {
562 store.state = SECTION_SEEN;
563 store.offset[store.seen] = ftell(config_file);
570 static int write_error(void)
572 fprintf(stderr, "Failed to write new configuration file\n");
574 /* Same error code as "failed to rename". */
578 static int store_write_section(int fd, const char* key)
580 const char *dot = strchr(key, '.');
581 int len1 = store.baselen, len2 = -1;
583 dot = strchr(key, '.');
585 int dotlen = dot - key;
587 len2 = len1 - dotlen - 1;
592 if (write_in_full(fd, "[", 1) != 1 ||
593 write_in_full(fd, key, len1) != len1)
596 if (write_in_full(fd, " \"", 2) != 2)
598 while (--len2 >= 0) {
599 unsigned char c = *++dot;
601 if (write_in_full(fd, "\\", 1) != 1)
603 if (write_in_full(fd, &c, 1) != 1)
606 if (write_in_full(fd, "\"", 1) != 1)
609 if (write_in_full(fd, "]\n", 2) != 2)
615 static int store_write_pair(int fd, const char* key, const char* value)
618 int length = strlen(key+store.baselen+1);
621 /* Check to see if the value needs to be quoted. */
624 for (i = 0; value[i]; i++)
625 if (value[i] == ';' || value[i] == '#')
627 if (value[i-1] == ' ')
630 if (write_in_full(fd, "\t", 1) != 1 ||
631 write_in_full(fd, key+store.baselen+1, length) != length ||
632 write_in_full(fd, " = ", 3) != 3)
634 if (quote && write_in_full(fd, "\"", 1) != 1)
636 for (i = 0; value[i]; i++)
639 if (write_in_full(fd, "\\n", 2) != 2)
643 if (write_in_full(fd, "\\t", 2) != 2)
648 if (write_in_full(fd, "\\", 1) != 1)
651 if (write_in_full(fd, value+i, 1) != 1)
655 if (quote && write_in_full(fd, "\"", 1) != 1)
657 if (write_in_full(fd, "\n", 1) != 1)
662 static ssize_t find_beginning_of_line(const char* contents, size_t size,
663 size_t offset_, int* found_bracket)
665 size_t equal_offset = size, bracket_offset = size;
668 for (offset = offset_-2; offset > 0
669 && contents[offset] != '\n'; offset--)
670 switch (contents[offset]) {
671 case '=': equal_offset = offset; break;
672 case ']': bracket_offset = offset; break;
674 if (bracket_offset < equal_offset) {
676 offset = bracket_offset+1;
683 int git_config_set(const char* key, const char* value)
685 return git_config_set_multivar(key, value, NULL, 0);
689 * If value==NULL, unset in (remove from) config,
690 * if value_regex!=NULL, disregard key/value pairs where value does not match.
691 * if multi_replace==0, nothing, or only one matching key/value is replaced,
692 * else all matching key/values (regardless how many) are removed,
693 * before the new pair is written.
695 * Returns 0 on success.
697 * This function does this:
699 * - it locks the config file by creating ".git/config.lock"
701 * - it then parses the config using store_aux() as validator to find
702 * the position on the key/value pair to replace. If it is to be unset,
703 * it must be found exactly once.
705 * - the config file is mmap()ed and the part before the match (if any) is
706 * written to the lock file, then the changed part and the rest.
708 * - the config file is removed and the lock file rename()d to it.
711 int git_config_set_multivar(const char* key, const char* value,
712 const char* value_regex, int multi_replace)
717 char* config_filename;
718 struct lock_file *lock = NULL;
719 const char* last_dot = strrchr(key, '.');
721 config_filename = getenv(CONFIG_ENVIRONMENT);
722 if (!config_filename) {
723 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
724 if (!config_filename)
725 config_filename = git_path("config");
727 config_filename = xstrdup(config_filename);
730 * Since "key" actually contains the section name and the real
731 * key name separated by a dot, we have to know where the dot is.
734 if (last_dot == NULL) {
735 fprintf(stderr, "key does not contain a section: %s\n", key);
739 store.baselen = last_dot - key;
741 store.multi_replace = multi_replace;
744 * Validate the key and while at it, lower case it for matching.
746 store.key = xmalloc(strlen(key) + 1);
748 for (i = 0; key[i]; i++) {
749 unsigned char c = key[i];
752 /* Leave the extended basename untouched.. */
753 if (!dot || i > store.baselen) {
754 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
755 fprintf(stderr, "invalid key: %s\n", key);
761 } else if (c == '\n') {
762 fprintf(stderr, "invalid key (newline): %s\n", key);
772 * The lock serves a purpose in addition to locking: the new
773 * contents of .git/config will be written into it.
775 lock = xcalloc(sizeof(struct lock_file), 1);
776 fd = hold_lock_file_for_update(lock, config_filename, 0);
778 fprintf(stderr, "could not lock config file\n");
785 * If .git/config does not exist yet, write a minimal version.
787 in_fd = open(config_filename, O_RDONLY);
791 if ( ENOENT != errno ) {
792 error("opening %s: %s", config_filename,
794 ret = 3; /* same as "invalid config file" */
797 /* if nothing to unset, error out */
803 store.key = (char*)key;
804 if (!store_write_section(fd, key) ||
805 !store_write_pair(fd, key, value))
810 size_t contents_sz, copy_begin, copy_end;
813 if (value_regex == NULL)
814 store.value_regex = NULL;
816 if (value_regex[0] == '!') {
817 store.do_not_match = 1;
820 store.do_not_match = 0;
822 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
823 if (regcomp(store.value_regex, value_regex,
825 fprintf(stderr, "Invalid pattern: %s\n",
827 free(store.value_regex);
838 * After this, store.offset will contain the *end* offset
839 * of the last match, or remain at 0 if no match was found.
840 * As a side effect, we make sure to transform only a valid
841 * existing config file.
843 if (git_config_from_file(store_aux, config_filename)) {
844 fprintf(stderr, "invalid config file\n");
846 if (store.value_regex != NULL) {
847 regfree(store.value_regex);
848 free(store.value_regex);
855 if (store.value_regex != NULL) {
856 regfree(store.value_regex);
857 free(store.value_regex);
860 /* if nothing to unset, or too many matches, error out */
861 if ((store.seen == 0 && value == NULL) ||
862 (store.seen > 1 && multi_replace == 0)) {
868 contents_sz = xsize_t(st.st_size);
869 contents = xmmap(NULL, contents_sz, PROT_READ,
870 MAP_PRIVATE, in_fd, 0);
876 for (i = 0, copy_begin = 0; i < store.seen; i++) {
877 if (store.offset[i] == 0) {
878 store.offset[i] = copy_end = contents_sz;
879 } else if (store.state != KEY_SEEN) {
880 copy_end = store.offset[i];
882 copy_end = find_beginning_of_line(
883 contents, contents_sz,
884 store.offset[i]-2, &new_line);
886 /* write the first part of the config */
887 if (copy_end > copy_begin) {
888 if (write_in_full(fd, contents + copy_begin,
889 copy_end - copy_begin) <
890 copy_end - copy_begin)
893 write_in_full(fd, "\n", 1) != 1)
896 copy_begin = store.offset[i];
899 /* write the pair (value == NULL means unset) */
901 if (store.state == START) {
902 if (!store_write_section(fd, key))
905 if (!store_write_pair(fd, key, value))
909 /* write the rest of the config */
910 if (copy_begin < contents_sz)
911 if (write_in_full(fd, contents + copy_begin,
912 contents_sz - copy_begin) <
913 contents_sz - copy_begin)
916 munmap(contents, contents_sz);
919 if (close(fd) || commit_lock_file(lock) < 0) {
920 fprintf(stderr, "Cannot commit config file!\n");
925 /* fd is closed, so don't try to close it below. */
928 * lock is committed, so don't try to roll it back below.
929 * NOTE: Since lockfile.c keeps a linked list of all created
930 * lock_file structures, it isn't safe to free(lock). It's
931 * better to just leave it hanging around.
940 rollback_lock_file(lock);
941 free(config_filename);
950 static int section_name_match (const char *buf, const char *name)
952 int i = 0, j = 0, dot = 0;
953 for (; buf[i] && buf[i] != ']'; i++) {
954 if (!dot && isspace(buf[i])) {
956 if (name[j++] != '.')
958 for (i++; isspace(buf[i]); i++)
964 if (buf[i] == '\\' && dot)
966 else if (buf[i] == '"' && dot) {
967 for (i++; isspace(buf[i]); i++)
971 if (buf[i] != name[j++])
974 return (buf[i] == ']' && name[j] == 0);
977 /* if new_name == NULL, the section is removed instead */
978 int git_config_rename_section(const char *old_name, const char *new_name)
980 int ret = 0, remove = 0;
981 char *config_filename;
982 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
986 config_filename = getenv(CONFIG_ENVIRONMENT);
987 if (!config_filename) {
988 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
989 if (!config_filename)
990 config_filename = git_path("config");
992 config_filename = xstrdup(config_filename);
993 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
995 ret = error("Could not lock config file!");
999 if (!(config_file = fopen(config_filename, "rb"))) {
1000 /* no config file means nothing to rename, no error */
1001 goto unlock_and_out;
1004 while (fgets(buf, sizeof(buf), config_file)) {
1007 for (i = 0; buf[i] && isspace(buf[i]); i++)
1009 if (buf[i] == '[') {
1010 /* it's a section */
1011 if (section_name_match (&buf[i+1], old_name)) {
1013 if (new_name == NULL) {
1017 store.baselen = strlen(new_name);
1018 if (!store_write_section(out_fd, new_name)) {
1019 ret = write_error();
1028 length = strlen(buf);
1029 if (write_in_full(out_fd, buf, length) != length) {
1030 ret = write_error();
1034 fclose(config_file);
1036 if (close(out_fd) || commit_lock_file(lock) < 0)
1037 ret = error("Cannot commit config file!");
1039 free(config_filename);