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")) {
451 return config_error_nonbool(var
);
452 excludes_file
= xstrdup(value
);
456 if (!strcmp(var
, "core.whitespace")) {
458 return config_error_nonbool(var
);
459 whitespace_rule_cfg
= parse_whitespace_rule(value
);
463 /* Add other config variables here and to Documentation/config.txt. */
467 int git_config_from_file(config_fn_t fn
, const char *filename
)
470 FILE *f
= fopen(filename
, "r");
475 config_file_name
= filename
;
478 ret
= git_parse_file(fn
);
480 config_file_name
= NULL
;
485 const char *git_etc_gitconfig(void)
487 static const char *system_wide
;
489 system_wide
= ETC_GITCONFIG
;
490 if (!is_absolute_path(system_wide
)) {
491 /* interpret path relative to exec-dir */
492 const char *exec_path
= git_exec_path();
493 system_wide
= prefix_path(exec_path
, strlen(exec_path
),
500 int git_config(config_fn_t fn
)
503 char *repo_config
= NULL
;
504 const char *home
= NULL
, *filename
;
506 /* $GIT_CONFIG makes git read _only_ the given config file,
507 * $GIT_CONFIG_LOCAL will make it process it in addition to the
508 * global config file, the same way it would the per-repository
509 * config file otherwise. */
510 filename
= getenv(CONFIG_ENVIRONMENT
);
512 if (!access(git_etc_gitconfig(), R_OK
))
513 ret
+= git_config_from_file(fn
, git_etc_gitconfig());
514 home
= getenv("HOME");
515 filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
517 filename
= repo_config
= xstrdup(git_path("config"));
521 char *user_config
= xstrdup(mkpath("%s/.gitconfig", home
));
522 if (!access(user_config
, R_OK
))
523 ret
= git_config_from_file(fn
, user_config
);
527 ret
+= git_config_from_file(fn
, filename
);
533 * Find all the stuff for git_config_set() below.
536 #define MAX_MATCHES 512
542 regex_t
* value_regex
;
544 size_t offset
[MAX_MATCHES
];
545 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
549 static int matches(const char* key
, const char* value
)
551 return !strcmp(key
, store
.key
) &&
552 (store
.value_regex
== NULL
||
553 (store
.do_not_match
^
554 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
557 static int store_aux(const char* key
, const char* value
)
562 switch (store
.state
) {
564 if (matches(key
, value
)) {
565 if (store
.seen
== 1 && store
.multi_replace
== 0) {
567 "Warning: %s has multiple values\n",
569 } else if (store
.seen
>= MAX_MATCHES
) {
570 fprintf(stderr
, "Too many matches\n");
574 store
.offset
[store
.seen
] = ftell(config_file
);
580 * What we are looking for is in store.key (both
581 * section and var), and its section part is baselen
582 * long. We found key (again, both section and var).
583 * We would want to know if this key is in the same
584 * section as what we are looking for. We already
585 * know we are in the same section as what should
588 ep
= strrchr(key
, '.');
589 section_len
= ep
- key
;
591 if ((section_len
!= store
.baselen
) ||
592 memcmp(key
, store
.key
, section_len
+1)) {
593 store
.state
= SECTION_END_SEEN
;
598 * Do not increment matches: this is no match, but we
599 * just made sure we are in the desired section.
601 store
.offset
[store
.seen
] = ftell(config_file
);
603 case SECTION_END_SEEN
:
605 if (matches(key
, value
)) {
606 store
.offset
[store
.seen
] = ftell(config_file
);
607 store
.state
= KEY_SEEN
;
610 if (strrchr(key
, '.') - key
== store
.baselen
&&
611 !strncmp(key
, store
.key
, store
.baselen
)) {
612 store
.state
= SECTION_SEEN
;
613 store
.offset
[store
.seen
] = ftell(config_file
);
620 static int write_error(void)
622 fprintf(stderr
, "Failed to write new configuration file\n");
624 /* Same error code as "failed to rename". */
628 static int store_write_section(int fd
, const char* key
)
635 dot
= memchr(key
, '.', store
.baselen
);
637 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
638 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
640 strbuf_addch(&sb
, '\\');
641 strbuf_addch(&sb
, key
[i
]);
643 strbuf_addstr(&sb
, "\"]\n");
645 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
648 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
654 static int store_write_pair(int fd
, const char* key
, const char* value
)
657 int length
= strlen(key
+ store
.baselen
+ 1);
658 const char *quote
= "";
662 * Check to see if the value needs to be surrounded with a dq pair.
663 * Note that problematic characters are always backslash-quoted; this
664 * check is about not losing leading or trailing SP and strings that
665 * follow beginning-of-comment characters (i.e. ';' and '#') by the
666 * configuration parser.
670 for (i
= 0; value
[i
]; i
++)
671 if (value
[i
] == ';' || value
[i
] == '#')
673 if (i
&& value
[i
- 1] == ' ')
677 strbuf_addf(&sb
, "\t%.*s = %s",
678 length
, key
+ store
.baselen
+ 1, quote
);
680 for (i
= 0; value
[i
]; i
++)
683 strbuf_addstr(&sb
, "\\n");
686 strbuf_addstr(&sb
, "\\t");
690 strbuf_addch(&sb
, '\\');
692 strbuf_addch(&sb
, value
[i
]);
695 strbuf_addf(&sb
, "%s\n", quote
);
697 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
703 static ssize_t
find_beginning_of_line(const char* contents
, size_t size
,
704 size_t offset_
, int* found_bracket
)
706 size_t equal_offset
= size
, bracket_offset
= size
;
710 for (offset
= offset_
-2; offset
> 0
711 && contents
[offset
] != '\n'; offset
--)
712 switch (contents
[offset
]) {
713 case '=': equal_offset
= offset
; break;
714 case ']': bracket_offset
= offset
; break;
716 if (offset
> 0 && contents
[offset
-1] == '\\') {
720 if (bracket_offset
< equal_offset
) {
722 offset
= bracket_offset
+1;
729 int git_config_set(const char* key
, const char* value
)
731 return git_config_set_multivar(key
, value
, NULL
, 0);
735 * If value==NULL, unset in (remove from) config,
736 * if value_regex!=NULL, disregard key/value pairs where value does not match.
737 * if multi_replace==0, nothing, or only one matching key/value is replaced,
738 * else all matching key/values (regardless how many) are removed,
739 * before the new pair is written.
741 * Returns 0 on success.
743 * This function does this:
745 * - it locks the config file by creating ".git/config.lock"
747 * - it then parses the config using store_aux() as validator to find
748 * the position on the key/value pair to replace. If it is to be unset,
749 * it must be found exactly once.
751 * - the config file is mmap()ed and the part before the match (if any) is
752 * written to the lock file, then the changed part and the rest.
754 * - the config file is removed and the lock file rename()d to it.
757 int git_config_set_multivar(const char* key
, const char* value
,
758 const char* value_regex
, int multi_replace
)
763 char* config_filename
;
764 struct lock_file
*lock
= NULL
;
765 const char* last_dot
= strrchr(key
, '.');
767 config_filename
= getenv(CONFIG_ENVIRONMENT
);
768 if (!config_filename
) {
769 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
770 if (!config_filename
)
771 config_filename
= git_path("config");
773 config_filename
= xstrdup(config_filename
);
776 * Since "key" actually contains the section name and the real
777 * key name separated by a dot, we have to know where the dot is.
780 if (last_dot
== NULL
) {
781 fprintf(stderr
, "key does not contain a section: %s\n", key
);
785 store
.baselen
= last_dot
- key
;
787 store
.multi_replace
= multi_replace
;
790 * Validate the key and while at it, lower case it for matching.
792 store
.key
= xmalloc(strlen(key
) + 1);
794 for (i
= 0; key
[i
]; i
++) {
795 unsigned char c
= key
[i
];
798 /* Leave the extended basename untouched.. */
799 if (!dot
|| i
> store
.baselen
) {
800 if (!iskeychar(c
) || (i
== store
.baselen
+1 && !isalpha(c
))) {
801 fprintf(stderr
, "invalid key: %s\n", key
);
807 } else if (c
== '\n') {
808 fprintf(stderr
, "invalid key (newline): %s\n", key
);
818 * The lock serves a purpose in addition to locking: the new
819 * contents of .git/config will be written into it.
821 lock
= xcalloc(sizeof(struct lock_file
), 1);
822 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
824 fprintf(stderr
, "could not lock config file\n");
831 * If .git/config does not exist yet, write a minimal version.
833 in_fd
= open(config_filename
, O_RDONLY
);
837 if ( ENOENT
!= errno
) {
838 error("opening %s: %s", config_filename
,
840 ret
= 3; /* same as "invalid config file" */
843 /* if nothing to unset, error out */
849 store
.key
= (char*)key
;
850 if (!store_write_section(fd
, key
) ||
851 !store_write_pair(fd
, key
, value
))
856 size_t contents_sz
, copy_begin
, copy_end
;
859 if (value_regex
== NULL
)
860 store
.value_regex
= NULL
;
862 if (value_regex
[0] == '!') {
863 store
.do_not_match
= 1;
866 store
.do_not_match
= 0;
868 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
869 if (regcomp(store
.value_regex
, value_regex
,
871 fprintf(stderr
, "Invalid pattern: %s\n",
873 free(store
.value_regex
);
884 * After this, store.offset will contain the *end* offset
885 * of the last match, or remain at 0 if no match was found.
886 * As a side effect, we make sure to transform only a valid
887 * existing config file.
889 if (git_config_from_file(store_aux
, config_filename
)) {
890 fprintf(stderr
, "invalid config file\n");
892 if (store
.value_regex
!= NULL
) {
893 regfree(store
.value_regex
);
894 free(store
.value_regex
);
901 if (store
.value_regex
!= NULL
) {
902 regfree(store
.value_regex
);
903 free(store
.value_regex
);
906 /* if nothing to unset, or too many matches, error out */
907 if ((store
.seen
== 0 && value
== NULL
) ||
908 (store
.seen
> 1 && multi_replace
== 0)) {
914 contents_sz
= xsize_t(st
.st_size
);
915 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
916 MAP_PRIVATE
, in_fd
, 0);
922 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
923 if (store
.offset
[i
] == 0) {
924 store
.offset
[i
] = copy_end
= contents_sz
;
925 } else if (store
.state
!= KEY_SEEN
) {
926 copy_end
= store
.offset
[i
];
928 copy_end
= find_beginning_of_line(
929 contents
, contents_sz
,
930 store
.offset
[i
]-2, &new_line
);
932 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
935 /* write the first part of the config */
936 if (copy_end
> copy_begin
) {
937 if (write_in_full(fd
, contents
+ copy_begin
,
938 copy_end
- copy_begin
) <
939 copy_end
- copy_begin
)
942 write_in_full(fd
, "\n", 1) != 1)
945 copy_begin
= store
.offset
[i
];
948 /* write the pair (value == NULL means unset) */
950 if (store
.state
== START
) {
951 if (!store_write_section(fd
, key
))
954 if (!store_write_pair(fd
, key
, value
))
958 /* write the rest of the config */
959 if (copy_begin
< contents_sz
)
960 if (write_in_full(fd
, contents
+ copy_begin
,
961 contents_sz
- copy_begin
) <
962 contents_sz
- copy_begin
)
965 munmap(contents
, contents_sz
);
968 if (commit_lock_file(lock
) < 0) {
969 fprintf(stderr
, "Cannot commit config file!\n");
975 * lock is committed, so don't try to roll it back below.
976 * NOTE: Since lockfile.c keeps a linked list of all created
977 * lock_file structures, it isn't safe to free(lock). It's
978 * better to just leave it hanging around.
985 rollback_lock_file(lock
);
986 free(config_filename
);
995 static int section_name_match (const char *buf
, const char *name
)
997 int i
= 0, j
= 0, dot
= 0;
998 for (; buf
[i
] && buf
[i
] != ']'; i
++) {
999 if (!dot
&& isspace(buf
[i
])) {
1001 if (name
[j
++] != '.')
1003 for (i
++; isspace(buf
[i
]); i
++)
1009 if (buf
[i
] == '\\' && dot
)
1011 else if (buf
[i
] == '"' && dot
) {
1012 for (i
++; isspace(buf
[i
]); i
++)
1016 if (buf
[i
] != name
[j
++])
1019 return (buf
[i
] == ']' && name
[j
] == 0);
1022 /* if new_name == NULL, the section is removed instead */
1023 int git_config_rename_section(const char *old_name
, const char *new_name
)
1025 int ret
= 0, remove
= 0;
1026 char *config_filename
;
1027 struct lock_file
*lock
= xcalloc(sizeof(struct lock_file
), 1);
1031 config_filename
= getenv(CONFIG_ENVIRONMENT
);
1032 if (!config_filename
) {
1033 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
1034 if (!config_filename
)
1035 config_filename
= git_path("config");
1037 config_filename
= xstrdup(config_filename
);
1038 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1040 ret
= error("Could not lock config file!");
1044 if (!(config_file
= fopen(config_filename
, "rb"))) {
1045 /* no config file means nothing to rename, no error */
1046 goto unlock_and_out
;
1049 while (fgets(buf
, sizeof(buf
), config_file
)) {
1052 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1054 if (buf
[i
] == '[') {
1055 /* it's a section */
1056 if (section_name_match (&buf
[i
+1], old_name
)) {
1058 if (new_name
== NULL
) {
1062 store
.baselen
= strlen(new_name
);
1063 if (!store_write_section(out_fd
, new_name
)) {
1064 ret
= write_error();
1073 length
= strlen(buf
);
1074 if (write_in_full(out_fd
, buf
, length
) != length
) {
1075 ret
= write_error();
1079 fclose(config_file
);
1081 if (commit_lock_file(lock
) < 0)
1082 ret
= error("Cannot commit config file!");
1084 free(config_filename
);
1089 * Call this to report error for your variable that should not
1090 * get a boolean value (i.e. "[my] var" means "true").
1092 int config_error_nonbool(const char *var
)
1094 return error("Missing value for '%s'", var
);