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_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;
473 ret = git_parse_file(fn);
475 config_file_name = NULL;
480 const char *git_etc_gitconfig(void)
482 static const char *system_wide;
484 system_wide = ETC_GITCONFIG;
485 if (!is_absolute_path(system_wide)) {
486 /* interpret path relative to exec-dir */
487 struct strbuf d = STRBUF_INIT;
488 strbuf_addf(&d, "%s/%s", git_exec_path(), system_wide);
489 system_wide = strbuf_detach(&d, NULL);
495 int git_config(config_fn_t fn)
498 char *repo_config = NULL;
499 const char *home = NULL, *filename;
501 /* $GIT_CONFIG makes git read _only_ the given config file,
502 * $GIT_CONFIG_LOCAL will make it process it in addition to the
503 * global config file, the same way it would the per-repository
504 * config file otherwise. */
505 filename = getenv(CONFIG_ENVIRONMENT);
507 if (!access(git_etc_gitconfig(), R_OK))
508 ret += git_config_from_file(fn, git_etc_gitconfig());
509 home = getenv("HOME");
510 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
512 filename = repo_config = xstrdup(git_path("config"));
516 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
517 if (!access(user_config, R_OK))
518 ret = git_config_from_file(fn, user_config);
522 ret += git_config_from_file(fn, filename);
528 * Find all the stuff for git_config_set() below.
531 #define MAX_MATCHES 512
537 regex_t* value_regex;
539 size_t offset[MAX_MATCHES];
540 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
544 static int matches(const char* key, const char* value)
546 return !strcmp(key, store.key) &&
547 (store.value_regex == NULL ||
548 (store.do_not_match ^
549 !regexec(store.value_regex, value, 0, NULL, 0)));
552 static int store_aux(const char* key, const char* value)
557 switch (store.state) {
559 if (matches(key, value)) {
560 if (store.seen == 1 && store.multi_replace == 0) {
562 "Warning: %s has multiple values\n",
564 } else if (store.seen >= MAX_MATCHES) {
565 fprintf(stderr, "Too many matches\n");
569 store.offset[store.seen] = ftell(config_file);
575 * What we are looking for is in store.key (both
576 * section and var), and its section part is baselen
577 * long. We found key (again, both section and var).
578 * We would want to know if this key is in the same
579 * section as what we are looking for. We already
580 * know we are in the same section as what should
583 ep = strrchr(key, '.');
584 section_len = ep - key;
586 if ((section_len != store.baselen) ||
587 memcmp(key, store.key, section_len+1)) {
588 store.state = SECTION_END_SEEN;
593 * Do not increment matches: this is no match, but we
594 * just made sure we are in the desired section.
596 store.offset[store.seen] = ftell(config_file);
598 case SECTION_END_SEEN:
600 if (matches(key, value)) {
601 store.offset[store.seen] = ftell(config_file);
602 store.state = KEY_SEEN;
605 if (strrchr(key, '.') - key == store.baselen &&
606 !strncmp(key, store.key, store.baselen)) {
607 store.state = SECTION_SEEN;
608 store.offset[store.seen] = ftell(config_file);
615 static int write_error(void)
617 fprintf(stderr, "Failed to write new configuration file\n");
619 /* Same error code as "failed to rename". */
623 static int store_write_section(int fd, const char* key)
630 dot = memchr(key, '.', store.baselen);
632 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
633 for (i = dot - key + 1; i < store.baselen; i++) {
635 strbuf_addch(&sb, '\\');
636 strbuf_addch(&sb, key[i]);
638 strbuf_addstr(&sb, "\"]\n");
640 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
643 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
649 static int store_write_pair(int fd, const char* key, const char* value)
652 int length = strlen(key + store.baselen + 1);
653 const char *quote = "";
657 * Check to see if the value needs to be surrounded with a dq pair.
658 * Note that problematic characters are always backslash-quoted; this
659 * check is about not losing leading or trailing SP and strings that
660 * follow beginning-of-comment characters (i.e. ';' and '#') by the
661 * configuration parser.
665 for (i = 0; value[i]; i++)
666 if (value[i] == ';' || value[i] == '#')
668 if (i && value[i - 1] == ' ')
672 strbuf_addf(&sb, "\t%.*s = %s",
673 length, key + store.baselen + 1, quote);
675 for (i = 0; value[i]; i++)
678 strbuf_addstr(&sb, "\\n");
681 strbuf_addstr(&sb, "\\t");
685 strbuf_addch(&sb, '\\');
687 strbuf_addch(&sb, value[i]);
690 strbuf_addf(&sb, "%s\n", quote);
692 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
698 static ssize_t find_beginning_of_line(const char* contents, size_t size,
699 size_t offset_, int* found_bracket)
701 size_t equal_offset = size, bracket_offset = size;
704 for (offset = offset_-2; offset > 0
705 && contents[offset] != '\n'; offset--)
706 switch (contents[offset]) {
707 case '=': equal_offset = offset; break;
708 case ']': bracket_offset = offset; break;
710 if (bracket_offset < equal_offset) {
712 offset = bracket_offset+1;
719 int git_config_set(const char* key, const char* value)
721 return git_config_set_multivar(key, value, NULL, 0);
725 * If value==NULL, unset in (remove from) config,
726 * if value_regex!=NULL, disregard key/value pairs where value does not match.
727 * if multi_replace==0, nothing, or only one matching key/value is replaced,
728 * else all matching key/values (regardless how many) are removed,
729 * before the new pair is written.
731 * Returns 0 on success.
733 * This function does this:
735 * - it locks the config file by creating ".git/config.lock"
737 * - it then parses the config using store_aux() as validator to find
738 * the position on the key/value pair to replace. If it is to be unset,
739 * it must be found exactly once.
741 * - the config file is mmap()ed and the part before the match (if any) is
742 * written to the lock file, then the changed part and the rest.
744 * - the config file is removed and the lock file rename()d to it.
747 int git_config_set_multivar(const char* key, const char* value,
748 const char* value_regex, int multi_replace)
753 char* config_filename;
754 struct lock_file *lock = NULL;
755 const char* last_dot = strrchr(key, '.');
757 config_filename = getenv(CONFIG_ENVIRONMENT);
758 if (!config_filename) {
759 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
760 if (!config_filename)
761 config_filename = git_path("config");
763 config_filename = xstrdup(config_filename);
766 * Since "key" actually contains the section name and the real
767 * key name separated by a dot, we have to know where the dot is.
770 if (last_dot == NULL) {
771 fprintf(stderr, "key does not contain a section: %s\n", key);
775 store.baselen = last_dot - key;
777 store.multi_replace = multi_replace;
780 * Validate the key and while at it, lower case it for matching.
782 store.key = xmalloc(strlen(key) + 1);
784 for (i = 0; key[i]; i++) {
785 unsigned char c = key[i];
788 /* Leave the extended basename untouched.. */
789 if (!dot || i > store.baselen) {
790 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
791 fprintf(stderr, "invalid key: %s\n", key);
797 } else if (c == '\n') {
798 fprintf(stderr, "invalid key (newline): %s\n", key);
808 * The lock serves a purpose in addition to locking: the new
809 * contents of .git/config will be written into it.
811 lock = xcalloc(sizeof(struct lock_file), 1);
812 fd = hold_lock_file_for_update(lock, config_filename, 0);
814 fprintf(stderr, "could not lock config file\n");
821 * If .git/config does not exist yet, write a minimal version.
823 in_fd = open(config_filename, O_RDONLY);
827 if ( ENOENT != errno ) {
828 error("opening %s: %s", config_filename,
830 ret = 3; /* same as "invalid config file" */
833 /* if nothing to unset, error out */
839 store.key = (char*)key;
840 if (!store_write_section(fd, key) ||
841 !store_write_pair(fd, key, value))
846 size_t contents_sz, copy_begin, copy_end;
849 if (value_regex == NULL)
850 store.value_regex = NULL;
852 if (value_regex[0] == '!') {
853 store.do_not_match = 1;
856 store.do_not_match = 0;
858 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
859 if (regcomp(store.value_regex, value_regex,
861 fprintf(stderr, "Invalid pattern: %s\n",
863 free(store.value_regex);
874 * After this, store.offset will contain the *end* offset
875 * of the last match, or remain at 0 if no match was found.
876 * As a side effect, we make sure to transform only a valid
877 * existing config file.
879 if (git_config_from_file(store_aux, config_filename)) {
880 fprintf(stderr, "invalid config file\n");
882 if (store.value_regex != NULL) {
883 regfree(store.value_regex);
884 free(store.value_regex);
891 if (store.value_regex != NULL) {
892 regfree(store.value_regex);
893 free(store.value_regex);
896 /* if nothing to unset, or too many matches, error out */
897 if ((store.seen == 0 && value == NULL) ||
898 (store.seen > 1 && multi_replace == 0)) {
904 contents_sz = xsize_t(st.st_size);
905 contents = xmmap(NULL, contents_sz, PROT_READ,
906 MAP_PRIVATE, in_fd, 0);
912 for (i = 0, copy_begin = 0; i < store.seen; i++) {
913 if (store.offset[i] == 0) {
914 store.offset[i] = copy_end = contents_sz;
915 } else if (store.state != KEY_SEEN) {
916 copy_end = store.offset[i];
918 copy_end = find_beginning_of_line(
919 contents, contents_sz,
920 store.offset[i]-2, &new_line);
922 if (copy_end > 0 && contents[copy_end-1] != '\n')
925 /* write the first part of the config */
926 if (copy_end > copy_begin) {
927 if (write_in_full(fd, contents + copy_begin,
928 copy_end - copy_begin) <
929 copy_end - copy_begin)
932 write_in_full(fd, "\n", 1) != 1)
935 copy_begin = store.offset[i];
938 /* write the pair (value == NULL means unset) */
940 if (store.state == START) {
941 if (!store_write_section(fd, key))
944 if (!store_write_pair(fd, key, value))
948 /* write the rest of the config */
949 if (copy_begin < contents_sz)
950 if (write_in_full(fd, contents + copy_begin,
951 contents_sz - copy_begin) <
952 contents_sz - copy_begin)
955 munmap(contents, contents_sz);
958 if (commit_lock_file(lock) < 0) {
959 fprintf(stderr, "Cannot commit config file!\n");
965 * lock is committed, so don't try to roll it back below.
966 * NOTE: Since lockfile.c keeps a linked list of all created
967 * lock_file structures, it isn't safe to free(lock). It's
968 * 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 (commit_lock_file(lock) < 0)
1072 ret = error("Cannot commit config file!");
1074 free(config_filename);