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 static void die_bad_config(const char *name
)
285 if (config_file_name
)
286 die("bad config value for '%s' in %s", name
, config_file_name
);
287 die("bad config value for '%s'", name
);
290 int git_config_int(const char *name
, const char *value
)
293 if (!git_parse_long(value
, &ret
))
294 die_bad_config(name
);
298 unsigned long git_config_ulong(const char *name
, const char *value
)
301 if (!git_parse_ulong(value
, &ret
))
302 die_bad_config(name
);
306 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
313 if (!strcasecmp(value
, "true") || !strcasecmp(value
, "yes"))
315 if (!strcasecmp(value
, "false") || !strcasecmp(value
, "no"))
318 return git_config_int(name
, value
);
321 int git_config_bool(const char *name
, const char *value
)
324 return !!git_config_bool_or_int(name
, value
, &discard
);
327 int git_config_string(const char **dest
, const char *var
, const char *value
)
330 return config_error_nonbool(var
);
331 *dest
= xstrdup(value
);
335 int git_default_config(const char *var
, const char *value
)
337 /* This needs a better name */
338 if (!strcmp(var
, "core.filemode")) {
339 trust_executable_bit
= git_config_bool(var
, value
);
343 if (!strcmp(var
, "core.quotepath")) {
344 quote_path_fully
= git_config_bool(var
, value
);
348 if (!strcmp(var
, "core.symlinks")) {
349 has_symlinks
= git_config_bool(var
, value
);
353 if (!strcmp(var
, "core.ignorecase")) {
354 ignore_case
= git_config_bool(var
, value
);
358 if (!strcmp(var
, "core.bare")) {
359 is_bare_repository_cfg
= git_config_bool(var
, value
);
363 if (!strcmp(var
, "core.ignorestat")) {
364 assume_unchanged
= git_config_bool(var
, value
);
368 if (!strcmp(var
, "core.prefersymlinkrefs")) {
369 prefer_symlink_refs
= git_config_bool(var
, value
);
373 if (!strcmp(var
, "core.logallrefupdates")) {
374 log_all_ref_updates
= git_config_bool(var
, value
);
378 if (!strcmp(var
, "core.warnambiguousrefs")) {
379 warn_ambiguous_refs
= git_config_bool(var
, value
);
383 if (!strcmp(var
, "core.loosecompression")) {
384 int level
= git_config_int(var
, value
);
386 level
= Z_DEFAULT_COMPRESSION
;
387 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
388 die("bad zlib compression level %d", level
);
389 zlib_compression_level
= level
;
390 zlib_compression_seen
= 1;
394 if (!strcmp(var
, "core.compression")) {
395 int level
= git_config_int(var
, value
);
397 level
= Z_DEFAULT_COMPRESSION
;
398 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
399 die("bad zlib compression level %d", level
);
400 core_compression_level
= level
;
401 core_compression_seen
= 1;
402 if (!zlib_compression_seen
)
403 zlib_compression_level
= level
;
407 if (!strcmp(var
, "core.packedgitwindowsize")) {
408 int pgsz_x2
= getpagesize() * 2;
409 packed_git_window_size
= git_config_int(var
, value
);
411 /* This value must be multiple of (pagesize * 2) */
412 packed_git_window_size
/= pgsz_x2
;
413 if (packed_git_window_size
< 1)
414 packed_git_window_size
= 1;
415 packed_git_window_size
*= pgsz_x2
;
419 if (!strcmp(var
, "core.packedgitlimit")) {
420 packed_git_limit
= git_config_int(var
, value
);
424 if (!strcmp(var
, "core.deltabasecachelimit")) {
425 delta_base_cache_limit
= git_config_int(var
, value
);
429 if (!strcmp(var
, "core.autocrlf")) {
430 if (value
&& !strcasecmp(value
, "input")) {
434 auto_crlf
= git_config_bool(var
, value
);
438 if (!strcmp(var
, "core.safecrlf")) {
439 if (value
&& !strcasecmp(value
, "warn")) {
440 safe_crlf
= SAFE_CRLF_WARN
;
443 safe_crlf
= git_config_bool(var
, value
);
447 if (!strcmp(var
, "user.name")) {
449 return config_error_nonbool(var
);
450 strlcpy(git_default_name
, value
, sizeof(git_default_name
));
454 if (!strcmp(var
, "user.email")) {
456 return config_error_nonbool(var
);
457 strlcpy(git_default_email
, value
, sizeof(git_default_email
));
461 if (!strcmp(var
, "i18n.commitencoding"))
462 return git_config_string(&git_commit_encoding
, var
, value
);
464 if (!strcmp(var
, "i18n.logoutputencoding"))
465 return git_config_string(&git_log_output_encoding
, var
, value
);
467 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
468 pager_use_color
= git_config_bool(var
,value
);
472 if (!strcmp(var
, "core.pager"))
473 return git_config_string(&pager_program
, var
, value
);
475 if (!strcmp(var
, "core.editor"))
476 return git_config_string(&editor_program
, var
, value
);
478 if (!strcmp(var
, "core.excludesfile"))
479 return git_config_string(&excludes_file
, var
, value
);
481 if (!strcmp(var
, "core.whitespace")) {
483 return config_error_nonbool(var
);
484 whitespace_rule_cfg
= parse_whitespace_rule(value
);
487 if (!strcmp(var
, "branch.autosetupmerge")) {
488 if (value
&& !strcasecmp(value
, "always")) {
489 git_branch_track
= BRANCH_TRACK_ALWAYS
;
492 git_branch_track
= git_config_bool(var
, value
);
495 if (!strcmp(var
, "branch.autosetuprebase")) {
497 return config_error_nonbool(var
);
498 else if (!strcmp(value
, "never"))
499 autorebase
= AUTOREBASE_NEVER
;
500 else if (!strcmp(value
, "local"))
501 autorebase
= AUTOREBASE_LOCAL
;
502 else if (!strcmp(value
, "remote"))
503 autorebase
= AUTOREBASE_REMOTE
;
504 else if (!strcmp(value
, "always"))
505 autorebase
= AUTOREBASE_ALWAYS
;
507 return error("Malformed value for %s", var
);
511 /* Add other config variables here and to Documentation/config.txt. */
515 int git_config_from_file(config_fn_t fn
, const char *filename
)
518 FILE *f
= fopen(filename
, "r");
523 config_file_name
= filename
;
526 ret
= git_parse_file(fn
);
528 config_file_name
= NULL
;
533 const char *git_etc_gitconfig(void)
535 static const char *system_wide
;
537 system_wide
= ETC_GITCONFIG
;
538 if (!is_absolute_path(system_wide
)) {
539 /* interpret path relative to exec-dir */
540 struct strbuf d
= STRBUF_INIT
;
541 strbuf_addf(&d
, "%s/%s", git_exec_path(), system_wide
);
542 system_wide
= strbuf_detach(&d
, NULL
);
548 int git_env_bool(const char *k
, int def
)
550 const char *v
= getenv(k
);
551 return v
? git_config_bool(k
, v
) : def
;
554 int git_config_system(void)
556 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
559 int git_config_global(void)
561 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
564 int git_config(config_fn_t fn
)
567 char *repo_config
= NULL
;
568 const char *home
= NULL
, *filename
;
570 /* $GIT_CONFIG makes git read _only_ the given config file,
571 * $GIT_CONFIG_LOCAL will make it process it in addition to the
572 * global config file, the same way it would the per-repository
573 * config file otherwise. */
574 filename
= getenv(CONFIG_ENVIRONMENT
);
576 if (git_config_system() && !access(git_etc_gitconfig(), R_OK
))
577 ret
+= git_config_from_file(fn
, git_etc_gitconfig());
578 home
= getenv("HOME");
579 filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
581 filename
= repo_config
= xstrdup(git_path("config"));
584 if (git_config_global() && home
) {
585 char *user_config
= xstrdup(mkpath("%s/.gitconfig", home
));
586 if (!access(user_config
, R_OK
))
587 ret
= git_config_from_file(fn
, user_config
);
591 ret
+= git_config_from_file(fn
, filename
);
597 * Find all the stuff for git_config_set() below.
600 #define MAX_MATCHES 512
606 regex_t
* value_regex
;
608 size_t offset
[MAX_MATCHES
];
609 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
613 static int matches(const char* key
, const char* value
)
615 return !strcmp(key
, store
.key
) &&
616 (store
.value_regex
== NULL
||
617 (store
.do_not_match
^
618 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
621 static int store_aux(const char* key
, const char* value
)
626 switch (store
.state
) {
628 if (matches(key
, value
)) {
629 if (store
.seen
== 1 && store
.multi_replace
== 0) {
630 warning("%s has multiple values", key
);
631 } else if (store
.seen
>= MAX_MATCHES
) {
632 error("too many matches for %s", key
);
636 store
.offset
[store
.seen
] = ftell(config_file
);
642 * What we are looking for is in store.key (both
643 * section and var), and its section part is baselen
644 * long. We found key (again, both section and var).
645 * We would want to know if this key is in the same
646 * section as what we are looking for. We already
647 * know we are in the same section as what should
650 ep
= strrchr(key
, '.');
651 section_len
= ep
- key
;
653 if ((section_len
!= store
.baselen
) ||
654 memcmp(key
, store
.key
, section_len
+1)) {
655 store
.state
= SECTION_END_SEEN
;
660 * Do not increment matches: this is no match, but we
661 * just made sure we are in the desired section.
663 store
.offset
[store
.seen
] = ftell(config_file
);
665 case SECTION_END_SEEN
:
667 if (matches(key
, value
)) {
668 store
.offset
[store
.seen
] = ftell(config_file
);
669 store
.state
= KEY_SEEN
;
672 if (strrchr(key
, '.') - key
== store
.baselen
&&
673 !strncmp(key
, store
.key
, store
.baselen
)) {
674 store
.state
= SECTION_SEEN
;
675 store
.offset
[store
.seen
] = ftell(config_file
);
682 static int write_error(const char *filename
)
684 error("failed to write new configuration file %s", filename
);
686 /* Same error code as "failed to rename". */
690 static int store_write_section(int fd
, const char* key
)
697 dot
= memchr(key
, '.', store
.baselen
);
699 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
700 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
702 strbuf_addch(&sb
, '\\');
703 strbuf_addch(&sb
, key
[i
]);
705 strbuf_addstr(&sb
, "\"]\n");
707 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
710 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
716 static int store_write_pair(int fd
, const char* key
, const char* value
)
719 int length
= strlen(key
+ store
.baselen
+ 1);
720 const char *quote
= "";
724 * Check to see if the value needs to be surrounded with a dq pair.
725 * Note that problematic characters are always backslash-quoted; this
726 * check is about not losing leading or trailing SP and strings that
727 * follow beginning-of-comment characters (i.e. ';' and '#') by the
728 * configuration parser.
732 for (i
= 0; value
[i
]; i
++)
733 if (value
[i
] == ';' || value
[i
] == '#')
735 if (i
&& value
[i
- 1] == ' ')
739 strbuf_addf(&sb
, "\t%.*s = %s",
740 length
, key
+ store
.baselen
+ 1, quote
);
742 for (i
= 0; value
[i
]; i
++)
745 strbuf_addstr(&sb
, "\\n");
748 strbuf_addstr(&sb
, "\\t");
752 strbuf_addch(&sb
, '\\');
754 strbuf_addch(&sb
, value
[i
]);
757 strbuf_addf(&sb
, "%s\n", quote
);
759 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
765 static ssize_t
find_beginning_of_line(const char* contents
, size_t size
,
766 size_t offset_
, int* found_bracket
)
768 size_t equal_offset
= size
, bracket_offset
= size
;
772 for (offset
= offset_
-2; offset
> 0
773 && contents
[offset
] != '\n'; offset
--)
774 switch (contents
[offset
]) {
775 case '=': equal_offset
= offset
; break;
776 case ']': bracket_offset
= offset
; break;
778 if (offset
> 0 && contents
[offset
-1] == '\\') {
782 if (bracket_offset
< equal_offset
) {
784 offset
= bracket_offset
+1;
791 int git_config_set(const char* key
, const char* value
)
793 return git_config_set_multivar(key
, value
, NULL
, 0);
797 * If value==NULL, unset in (remove from) config,
798 * if value_regex!=NULL, disregard key/value pairs where value does not match.
799 * if multi_replace==0, nothing, or only one matching key/value is replaced,
800 * else all matching key/values (regardless how many) are removed,
801 * before the new pair is written.
803 * Returns 0 on success.
805 * This function does this:
807 * - it locks the config file by creating ".git/config.lock"
809 * - it then parses the config using store_aux() as validator to find
810 * the position on the key/value pair to replace. If it is to be unset,
811 * it must be found exactly once.
813 * - the config file is mmap()ed and the part before the match (if any) is
814 * written to the lock file, then the changed part and the rest.
816 * - the config file is removed and the lock file rename()d to it.
819 int git_config_set_multivar(const char* key
, const char* value
,
820 const char* value_regex
, int multi_replace
)
825 char* config_filename
;
826 struct lock_file
*lock
= NULL
;
827 const char* last_dot
= strrchr(key
, '.');
829 config_filename
= getenv(CONFIG_ENVIRONMENT
);
830 if (!config_filename
) {
831 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
832 if (!config_filename
)
833 config_filename
= git_path("config");
835 config_filename
= xstrdup(config_filename
);
838 * Since "key" actually contains the section name and the real
839 * key name separated by a dot, we have to know where the dot is.
842 if (last_dot
== NULL
) {
843 error("key does not contain a section: %s", key
);
847 store
.baselen
= last_dot
- key
;
849 store
.multi_replace
= multi_replace
;
852 * Validate the key and while at it, lower case it for matching.
854 store
.key
= xmalloc(strlen(key
) + 1);
856 for (i
= 0; key
[i
]; i
++) {
857 unsigned char c
= key
[i
];
860 /* Leave the extended basename untouched.. */
861 if (!dot
|| i
> store
.baselen
) {
862 if (!iskeychar(c
) || (i
== store
.baselen
+1 && !isalpha(c
))) {
863 error("invalid key: %s", key
);
869 } else if (c
== '\n') {
870 error("invalid key (newline): %s", key
);
880 * The lock serves a purpose in addition to locking: the new
881 * contents of .git/config will be written into it.
883 lock
= xcalloc(sizeof(struct lock_file
), 1);
884 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
886 error("could not lock config file %s", config_filename
);
893 * If .git/config does not exist yet, write a minimal version.
895 in_fd
= open(config_filename
, O_RDONLY
);
899 if ( ENOENT
!= errno
) {
900 error("opening %s: %s", config_filename
,
902 ret
= 3; /* same as "invalid config file" */
905 /* if nothing to unset, error out */
911 store
.key
= (char*)key
;
912 if (!store_write_section(fd
, key
) ||
913 !store_write_pair(fd
, key
, value
))
918 size_t contents_sz
, copy_begin
, copy_end
;
921 if (value_regex
== NULL
)
922 store
.value_regex
= NULL
;
924 if (value_regex
[0] == '!') {
925 store
.do_not_match
= 1;
928 store
.do_not_match
= 0;
930 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
931 if (regcomp(store
.value_regex
, value_regex
,
933 error("invalid pattern: %s", value_regex
);
934 free(store
.value_regex
);
945 * After this, store.offset will contain the *end* offset
946 * of the last match, or remain at 0 if no match was found.
947 * As a side effect, we make sure to transform only a valid
948 * existing config file.
950 if (git_config_from_file(store_aux
, config_filename
)) {
951 error("invalid config file %s", config_filename
);
953 if (store
.value_regex
!= NULL
) {
954 regfree(store
.value_regex
);
955 free(store
.value_regex
);
962 if (store
.value_regex
!= NULL
) {
963 regfree(store
.value_regex
);
964 free(store
.value_regex
);
967 /* if nothing to unset, or too many matches, error out */
968 if ((store
.seen
== 0 && value
== NULL
) ||
969 (store
.seen
> 1 && multi_replace
== 0)) {
975 contents_sz
= xsize_t(st
.st_size
);
976 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
977 MAP_PRIVATE
, in_fd
, 0);
983 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
984 if (store
.offset
[i
] == 0) {
985 store
.offset
[i
] = copy_end
= contents_sz
;
986 } else if (store
.state
!= KEY_SEEN
) {
987 copy_end
= store
.offset
[i
];
989 copy_end
= find_beginning_of_line(
990 contents
, contents_sz
,
991 store
.offset
[i
]-2, &new_line
);
993 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
996 /* write the first part of the config */
997 if (copy_end
> copy_begin
) {
998 if (write_in_full(fd
, contents
+ copy_begin
,
999 copy_end
- copy_begin
) <
1000 copy_end
- copy_begin
)
1003 write_in_full(fd
, "\n", 1) != 1)
1006 copy_begin
= store
.offset
[i
];
1009 /* write the pair (value == NULL means unset) */
1010 if (value
!= NULL
) {
1011 if (store
.state
== START
) {
1012 if (!store_write_section(fd
, key
))
1015 if (!store_write_pair(fd
, key
, value
))
1019 /* write the rest of the config */
1020 if (copy_begin
< contents_sz
)
1021 if (write_in_full(fd
, contents
+ copy_begin
,
1022 contents_sz
- copy_begin
) <
1023 contents_sz
- copy_begin
)
1026 munmap(contents
, contents_sz
);
1029 if (commit_lock_file(lock
) < 0) {
1030 error("could not commit config file %s", config_filename
);
1036 * lock is committed, so don't try to roll it back below.
1037 * NOTE: Since lockfile.c keeps a linked list of all created
1038 * lock_file structures, it isn't safe to free(lock). It's
1039 * better to just leave it hanging around.
1046 rollback_lock_file(lock
);
1047 free(config_filename
);
1051 ret
= write_error(lock
->filename
);
1056 static int section_name_match (const char *buf
, const char *name
)
1058 int i
= 0, j
= 0, dot
= 0;
1059 for (; buf
[i
] && buf
[i
] != ']'; i
++) {
1060 if (!dot
&& isspace(buf
[i
])) {
1062 if (name
[j
++] != '.')
1064 for (i
++; isspace(buf
[i
]); i
++)
1070 if (buf
[i
] == '\\' && dot
)
1072 else if (buf
[i
] == '"' && dot
) {
1073 for (i
++; isspace(buf
[i
]); i
++)
1077 if (buf
[i
] != name
[j
++])
1080 return (buf
[i
] == ']' && name
[j
] == 0);
1083 /* if new_name == NULL, the section is removed instead */
1084 int git_config_rename_section(const char *old_name
, const char *new_name
)
1086 int ret
= 0, remove
= 0;
1087 char *config_filename
;
1088 struct lock_file
*lock
= xcalloc(sizeof(struct lock_file
), 1);
1092 config_filename
= getenv(CONFIG_ENVIRONMENT
);
1093 if (!config_filename
) {
1094 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
1095 if (!config_filename
)
1096 config_filename
= git_path("config");
1098 config_filename
= xstrdup(config_filename
);
1099 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1101 ret
= error("could not lock config file %s", config_filename
);
1105 if (!(config_file
= fopen(config_filename
, "rb"))) {
1106 /* no config file means nothing to rename, no error */
1107 goto unlock_and_out
;
1110 while (fgets(buf
, sizeof(buf
), config_file
)) {
1113 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1115 if (buf
[i
] == '[') {
1116 /* it's a section */
1117 if (section_name_match (&buf
[i
+1], old_name
)) {
1119 if (new_name
== NULL
) {
1123 store
.baselen
= strlen(new_name
);
1124 if (!store_write_section(out_fd
, new_name
)) {
1125 ret
= write_error(lock
->filename
);
1134 length
= strlen(buf
);
1135 if (write_in_full(out_fd
, buf
, length
) != length
) {
1136 ret
= write_error(lock
->filename
);
1140 fclose(config_file
);
1142 if (commit_lock_file(lock
) < 0)
1143 ret
= error("could not commit config file %s", config_filename
);
1145 free(config_filename
);
1150 * Call this to report error for your variable that should not
1151 * get a boolean value (i.e. "[my] var" means "true").
1153 int config_error_nonbool(const char *var
)
1155 return error("Missing value for '%s'", var
);