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(const char *name
, const char *value
)
312 if (!strcasecmp(value
, "true") || !strcasecmp(value
, "yes"))
314 if (!strcasecmp(value
, "false") || !strcasecmp(value
, "no"))
316 return git_config_int(name
, value
) != 0;
319 int git_config_string(const char **dest
, const char *var
, const char *value
)
322 return config_error_nonbool(var
);
323 *dest
= xstrdup(value
);
327 int git_default_config(const char *var
, const char *value
)
329 /* This needs a better name */
330 if (!strcmp(var
, "core.filemode")) {
331 trust_executable_bit
= git_config_bool(var
, value
);
335 if (!strcmp(var
, "core.quotepath")) {
336 quote_path_fully
= git_config_bool(var
, value
);
340 if (!strcmp(var
, "core.symlinks")) {
341 has_symlinks
= git_config_bool(var
, value
);
345 if (!strcmp(var
, "core.bare")) {
346 is_bare_repository_cfg
= git_config_bool(var
, value
);
350 if (!strcmp(var
, "core.ignorestat")) {
351 assume_unchanged
= git_config_bool(var
, value
);
355 if (!strcmp(var
, "core.prefersymlinkrefs")) {
356 prefer_symlink_refs
= git_config_bool(var
, value
);
360 if (!strcmp(var
, "core.logallrefupdates")) {
361 log_all_ref_updates
= git_config_bool(var
, value
);
365 if (!strcmp(var
, "core.warnambiguousrefs")) {
366 warn_ambiguous_refs
= git_config_bool(var
, value
);
370 if (!strcmp(var
, "core.loosecompression")) {
371 int level
= git_config_int(var
, value
);
373 level
= Z_DEFAULT_COMPRESSION
;
374 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
375 die("bad zlib compression level %d", level
);
376 zlib_compression_level
= level
;
377 zlib_compression_seen
= 1;
381 if (!strcmp(var
, "core.compression")) {
382 int level
= git_config_int(var
, value
);
384 level
= Z_DEFAULT_COMPRESSION
;
385 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
386 die("bad zlib compression level %d", level
);
387 core_compression_level
= level
;
388 core_compression_seen
= 1;
389 if (!zlib_compression_seen
)
390 zlib_compression_level
= level
;
394 if (!strcmp(var
, "core.packedgitwindowsize")) {
395 int pgsz_x2
= getpagesize() * 2;
396 packed_git_window_size
= git_config_int(var
, value
);
398 /* This value must be multiple of (pagesize * 2) */
399 packed_git_window_size
/= pgsz_x2
;
400 if (packed_git_window_size
< 1)
401 packed_git_window_size
= 1;
402 packed_git_window_size
*= pgsz_x2
;
406 if (!strcmp(var
, "core.packedgitlimit")) {
407 packed_git_limit
= git_config_int(var
, value
);
411 if (!strcmp(var
, "core.deltabasecachelimit")) {
412 delta_base_cache_limit
= git_config_int(var
, value
);
416 if (!strcmp(var
, "core.autocrlf")) {
417 if (value
&& !strcasecmp(value
, "input")) {
421 auto_crlf
= git_config_bool(var
, value
);
425 if (!strcmp(var
, "core.safecrlf")) {
426 if (value
&& !strcasecmp(value
, "warn")) {
427 safe_crlf
= SAFE_CRLF_WARN
;
430 safe_crlf
= git_config_bool(var
, value
);
434 if (!strcmp(var
, "user.name")) {
436 return config_error_nonbool(var
);
437 strlcpy(git_default_name
, value
, sizeof(git_default_name
));
441 if (!strcmp(var
, "user.email")) {
443 return config_error_nonbool(var
);
444 strlcpy(git_default_email
, value
, sizeof(git_default_email
));
448 if (!strcmp(var
, "i18n.commitencoding"))
449 return git_config_string(&git_commit_encoding
, var
, value
);
451 if (!strcmp(var
, "i18n.logoutputencoding"))
452 return git_config_string(&git_log_output_encoding
, var
, value
);
454 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
455 pager_use_color
= git_config_bool(var
,value
);
459 if (!strcmp(var
, "core.pager"))
460 return git_config_string(&pager_program
, var
, value
);
462 if (!strcmp(var
, "core.editor"))
463 return git_config_string(&editor_program
, var
, value
);
465 if (!strcmp(var
, "core.excludesfile"))
466 return git_config_string(&excludes_file
, var
, value
);
468 if (!strcmp(var
, "core.whitespace")) {
470 return config_error_nonbool(var
);
471 whitespace_rule_cfg
= parse_whitespace_rule(value
);
474 if (!strcmp(var
, "branch.autosetupmerge")) {
475 if (value
&& !strcasecmp(value
, "always")) {
476 git_branch_track
= BRANCH_TRACK_ALWAYS
;
479 git_branch_track
= git_config_bool(var
, value
);
483 /* Add other config variables here and to Documentation/config.txt. */
487 int git_config_from_file(config_fn_t fn
, const char *filename
)
490 FILE *f
= fopen(filename
, "r");
495 config_file_name
= filename
;
498 ret
= git_parse_file(fn
);
500 config_file_name
= NULL
;
505 const char *git_etc_gitconfig(void)
507 static const char *system_wide
;
509 system_wide
= ETC_GITCONFIG
;
510 if (!is_absolute_path(system_wide
)) {
511 /* interpret path relative to exec-dir */
512 struct strbuf d
= STRBUF_INIT
;
513 strbuf_addf(&d
, "%s/%s", git_exec_path(), system_wide
);
514 system_wide
= strbuf_detach(&d
, NULL
);
520 int git_env_bool(const char *k
, int def
)
522 const char *v
= getenv(k
);
523 return v
? git_config_bool(k
, v
) : def
;
526 int git_config_system(void)
528 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
531 int git_config_global(void)
533 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
536 int git_config(config_fn_t fn
)
539 char *repo_config
= NULL
;
540 const char *home
= NULL
, *filename
;
542 /* $GIT_CONFIG makes git read _only_ the given config file,
543 * $GIT_CONFIG_LOCAL will make it process it in addition to the
544 * global config file, the same way it would the per-repository
545 * config file otherwise. */
546 filename
= getenv(CONFIG_ENVIRONMENT
);
548 if (git_config_system() && !access(git_etc_gitconfig(), R_OK
))
549 ret
+= git_config_from_file(fn
, git_etc_gitconfig());
550 home
= getenv("HOME");
551 filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
553 filename
= repo_config
= xstrdup(git_path("config"));
556 if (git_config_global() && home
) {
557 char *user_config
= xstrdup(mkpath("%s/.gitconfig", home
));
558 if (!access(user_config
, R_OK
))
559 ret
= git_config_from_file(fn
, user_config
);
563 ret
+= git_config_from_file(fn
, filename
);
569 * Find all the stuff for git_config_set() below.
572 #define MAX_MATCHES 512
578 regex_t
* value_regex
;
580 size_t offset
[MAX_MATCHES
];
581 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
585 static int matches(const char* key
, const char* value
)
587 return !strcmp(key
, store
.key
) &&
588 (store
.value_regex
== NULL
||
589 (store
.do_not_match
^
590 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
593 static int store_aux(const char* key
, const char* value
)
598 switch (store
.state
) {
600 if (matches(key
, value
)) {
601 if (store
.seen
== 1 && store
.multi_replace
== 0) {
603 "Warning: %s has multiple values\n",
605 } else if (store
.seen
>= MAX_MATCHES
) {
606 fprintf(stderr
, "Too many matches\n");
610 store
.offset
[store
.seen
] = ftell(config_file
);
616 * What we are looking for is in store.key (both
617 * section and var), and its section part is baselen
618 * long. We found key (again, both section and var).
619 * We would want to know if this key is in the same
620 * section as what we are looking for. We already
621 * know we are in the same section as what should
624 ep
= strrchr(key
, '.');
625 section_len
= ep
- key
;
627 if ((section_len
!= store
.baselen
) ||
628 memcmp(key
, store
.key
, section_len
+1)) {
629 store
.state
= SECTION_END_SEEN
;
634 * Do not increment matches: this is no match, but we
635 * just made sure we are in the desired section.
637 store
.offset
[store
.seen
] = ftell(config_file
);
639 case SECTION_END_SEEN
:
641 if (matches(key
, value
)) {
642 store
.offset
[store
.seen
] = ftell(config_file
);
643 store
.state
= KEY_SEEN
;
646 if (strrchr(key
, '.') - key
== store
.baselen
&&
647 !strncmp(key
, store
.key
, store
.baselen
)) {
648 store
.state
= SECTION_SEEN
;
649 store
.offset
[store
.seen
] = ftell(config_file
);
656 static int write_error(void)
658 fprintf(stderr
, "Failed to write new configuration file\n");
660 /* Same error code as "failed to rename". */
664 static int store_write_section(int fd
, const char* key
)
671 dot
= memchr(key
, '.', store
.baselen
);
673 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
674 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
676 strbuf_addch(&sb
, '\\');
677 strbuf_addch(&sb
, key
[i
]);
679 strbuf_addstr(&sb
, "\"]\n");
681 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
684 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
690 static int store_write_pair(int fd
, const char* key
, const char* value
)
693 int length
= strlen(key
+ store
.baselen
+ 1);
694 const char *quote
= "";
698 * Check to see if the value needs to be surrounded with a dq pair.
699 * Note that problematic characters are always backslash-quoted; this
700 * check is about not losing leading or trailing SP and strings that
701 * follow beginning-of-comment characters (i.e. ';' and '#') by the
702 * configuration parser.
706 for (i
= 0; value
[i
]; i
++)
707 if (value
[i
] == ';' || value
[i
] == '#')
709 if (i
&& value
[i
- 1] == ' ')
713 strbuf_addf(&sb
, "\t%.*s = %s",
714 length
, key
+ store
.baselen
+ 1, quote
);
716 for (i
= 0; value
[i
]; i
++)
719 strbuf_addstr(&sb
, "\\n");
722 strbuf_addstr(&sb
, "\\t");
726 strbuf_addch(&sb
, '\\');
728 strbuf_addch(&sb
, value
[i
]);
731 strbuf_addf(&sb
, "%s\n", quote
);
733 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
739 static ssize_t
find_beginning_of_line(const char* contents
, size_t size
,
740 size_t offset_
, int* found_bracket
)
742 size_t equal_offset
= size
, bracket_offset
= size
;
746 for (offset
= offset_
-2; offset
> 0
747 && contents
[offset
] != '\n'; offset
--)
748 switch (contents
[offset
]) {
749 case '=': equal_offset
= offset
; break;
750 case ']': bracket_offset
= offset
; break;
752 if (offset
> 0 && contents
[offset
-1] == '\\') {
756 if (bracket_offset
< equal_offset
) {
758 offset
= bracket_offset
+1;
765 int git_config_set(const char* key
, const char* value
)
767 return git_config_set_multivar(key
, value
, NULL
, 0);
771 * If value==NULL, unset in (remove from) config,
772 * if value_regex!=NULL, disregard key/value pairs where value does not match.
773 * if multi_replace==0, nothing, or only one matching key/value is replaced,
774 * else all matching key/values (regardless how many) are removed,
775 * before the new pair is written.
777 * Returns 0 on success.
779 * This function does this:
781 * - it locks the config file by creating ".git/config.lock"
783 * - it then parses the config using store_aux() as validator to find
784 * the position on the key/value pair to replace. If it is to be unset,
785 * it must be found exactly once.
787 * - the config file is mmap()ed and the part before the match (if any) is
788 * written to the lock file, then the changed part and the rest.
790 * - the config file is removed and the lock file rename()d to it.
793 int git_config_set_multivar(const char* key
, const char* value
,
794 const char* value_regex
, int multi_replace
)
799 char* config_filename
;
800 struct lock_file
*lock
= NULL
;
801 const char* last_dot
= strrchr(key
, '.');
803 config_filename
= getenv(CONFIG_ENVIRONMENT
);
804 if (!config_filename
) {
805 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
806 if (!config_filename
)
807 config_filename
= git_path("config");
809 config_filename
= xstrdup(config_filename
);
812 * Since "key" actually contains the section name and the real
813 * key name separated by a dot, we have to know where the dot is.
816 if (last_dot
== NULL
) {
817 fprintf(stderr
, "key does not contain a section: %s\n", key
);
821 store
.baselen
= last_dot
- key
;
823 store
.multi_replace
= multi_replace
;
826 * Validate the key and while at it, lower case it for matching.
828 store
.key
= xmalloc(strlen(key
) + 1);
830 for (i
= 0; key
[i
]; i
++) {
831 unsigned char c
= key
[i
];
834 /* Leave the extended basename untouched.. */
835 if (!dot
|| i
> store
.baselen
) {
836 if (!iskeychar(c
) || (i
== store
.baselen
+1 && !isalpha(c
))) {
837 fprintf(stderr
, "invalid key: %s\n", key
);
843 } else if (c
== '\n') {
844 fprintf(stderr
, "invalid key (newline): %s\n", key
);
854 * The lock serves a purpose in addition to locking: the new
855 * contents of .git/config will be written into it.
857 lock
= xcalloc(sizeof(struct lock_file
), 1);
858 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
860 fprintf(stderr
, "could not lock config file\n");
867 * If .git/config does not exist yet, write a minimal version.
869 in_fd
= open(config_filename
, O_RDONLY
);
873 if ( ENOENT
!= errno
) {
874 error("opening %s: %s", config_filename
,
876 ret
= 3; /* same as "invalid config file" */
879 /* if nothing to unset, error out */
885 store
.key
= (char*)key
;
886 if (!store_write_section(fd
, key
) ||
887 !store_write_pair(fd
, key
, value
))
892 size_t contents_sz
, copy_begin
, copy_end
;
895 if (value_regex
== NULL
)
896 store
.value_regex
= NULL
;
898 if (value_regex
[0] == '!') {
899 store
.do_not_match
= 1;
902 store
.do_not_match
= 0;
904 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
905 if (regcomp(store
.value_regex
, value_regex
,
907 fprintf(stderr
, "Invalid pattern: %s\n",
909 free(store
.value_regex
);
920 * After this, store.offset will contain the *end* offset
921 * of the last match, or remain at 0 if no match was found.
922 * As a side effect, we make sure to transform only a valid
923 * existing config file.
925 if (git_config_from_file(store_aux
, config_filename
)) {
926 fprintf(stderr
, "invalid config file\n");
928 if (store
.value_regex
!= NULL
) {
929 regfree(store
.value_regex
);
930 free(store
.value_regex
);
937 if (store
.value_regex
!= NULL
) {
938 regfree(store
.value_regex
);
939 free(store
.value_regex
);
942 /* if nothing to unset, or too many matches, error out */
943 if ((store
.seen
== 0 && value
== NULL
) ||
944 (store
.seen
> 1 && multi_replace
== 0)) {
950 contents_sz
= xsize_t(st
.st_size
);
951 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
952 MAP_PRIVATE
, in_fd
, 0);
958 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
959 if (store
.offset
[i
] == 0) {
960 store
.offset
[i
] = copy_end
= contents_sz
;
961 } else if (store
.state
!= KEY_SEEN
) {
962 copy_end
= store
.offset
[i
];
964 copy_end
= find_beginning_of_line(
965 contents
, contents_sz
,
966 store
.offset
[i
]-2, &new_line
);
968 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
971 /* write the first part of the config */
972 if (copy_end
> copy_begin
) {
973 if (write_in_full(fd
, contents
+ copy_begin
,
974 copy_end
- copy_begin
) <
975 copy_end
- copy_begin
)
978 write_in_full(fd
, "\n", 1) != 1)
981 copy_begin
= store
.offset
[i
];
984 /* write the pair (value == NULL means unset) */
986 if (store
.state
== START
) {
987 if (!store_write_section(fd
, key
))
990 if (!store_write_pair(fd
, key
, value
))
994 /* write the rest of the config */
995 if (copy_begin
< contents_sz
)
996 if (write_in_full(fd
, contents
+ copy_begin
,
997 contents_sz
- copy_begin
) <
998 contents_sz
- copy_begin
)
1001 munmap(contents
, contents_sz
);
1004 if (commit_lock_file(lock
) < 0) {
1005 fprintf(stderr
, "Cannot commit config file!\n");
1011 * lock is committed, so don't try to roll it back below.
1012 * NOTE: Since lockfile.c keeps a linked list of all created
1013 * lock_file structures, it isn't safe to free(lock). It's
1014 * better to just leave it hanging around.
1021 rollback_lock_file(lock
);
1022 free(config_filename
);
1026 ret
= write_error();
1031 static int section_name_match (const char *buf
, const char *name
)
1033 int i
= 0, j
= 0, dot
= 0;
1034 for (; buf
[i
] && buf
[i
] != ']'; i
++) {
1035 if (!dot
&& isspace(buf
[i
])) {
1037 if (name
[j
++] != '.')
1039 for (i
++; isspace(buf
[i
]); i
++)
1045 if (buf
[i
] == '\\' && dot
)
1047 else if (buf
[i
] == '"' && dot
) {
1048 for (i
++; isspace(buf
[i
]); i
++)
1052 if (buf
[i
] != name
[j
++])
1055 return (buf
[i
] == ']' && name
[j
] == 0);
1058 /* if new_name == NULL, the section is removed instead */
1059 int git_config_rename_section(const char *old_name
, const char *new_name
)
1061 int ret
= 0, remove
= 0;
1062 char *config_filename
;
1063 struct lock_file
*lock
= xcalloc(sizeof(struct lock_file
), 1);
1067 config_filename
= getenv(CONFIG_ENVIRONMENT
);
1068 if (!config_filename
) {
1069 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
1070 if (!config_filename
)
1071 config_filename
= git_path("config");
1073 config_filename
= xstrdup(config_filename
);
1074 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1076 ret
= error("Could not lock config file!");
1080 if (!(config_file
= fopen(config_filename
, "rb"))) {
1081 /* no config file means nothing to rename, no error */
1082 goto unlock_and_out
;
1085 while (fgets(buf
, sizeof(buf
), config_file
)) {
1088 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1090 if (buf
[i
] == '[') {
1091 /* it's a section */
1092 if (section_name_match (&buf
[i
+1], old_name
)) {
1094 if (new_name
== NULL
) {
1098 store
.baselen
= strlen(new_name
);
1099 if (!store_write_section(out_fd
, new_name
)) {
1100 ret
= write_error();
1109 length
= strlen(buf
);
1110 if (write_in_full(out_fd
, buf
, length
) != length
) {
1111 ret
= write_error();
1115 fclose(config_file
);
1117 if (commit_lock_file(lock
) < 0)
1118 ret
= error("Cannot commit config file!");
1120 free(config_filename
);
1125 * Call this to report error for your variable that should not
1126 * get a boolean value (i.e. "[my] var" means "true").
1128 int config_error_nonbool(const char *var
)
1130 return error("Missing value for '%s'", var
);