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_env_bool(const char *k
, int def
)
497 const char *v
= getenv(k
);
498 return v
? git_config_bool(k
, v
) : def
;
501 int git_config_system(void)
503 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
506 int git_config_global(void)
508 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
511 int git_config(config_fn_t fn
)
514 char *repo_config
= NULL
;
515 const char *home
= NULL
, *filename
;
517 /* $GIT_CONFIG makes git read _only_ the given config file,
518 * $GIT_CONFIG_LOCAL will make it process it in addition to the
519 * global config file, the same way it would the per-repository
520 * config file otherwise. */
521 filename
= getenv(CONFIG_ENVIRONMENT
);
523 if (git_config_system() && !access(git_etc_gitconfig(), R_OK
))
524 ret
+= git_config_from_file(fn
, git_etc_gitconfig());
525 home
= getenv("HOME");
526 filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
528 filename
= repo_config
= xstrdup(git_path("config"));
531 if (git_config_global() && home
) {
532 char *user_config
= xstrdup(mkpath("%s/.gitconfig", home
));
533 if (!access(user_config
, R_OK
))
534 ret
= git_config_from_file(fn
, user_config
);
538 ret
+= git_config_from_file(fn
, filename
);
544 * Find all the stuff for git_config_set() below.
547 #define MAX_MATCHES 512
553 regex_t
* value_regex
;
555 size_t offset
[MAX_MATCHES
];
556 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
560 static int matches(const char* key
, const char* value
)
562 return !strcmp(key
, store
.key
) &&
563 (store
.value_regex
== NULL
||
564 (store
.do_not_match
^
565 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
568 static int store_aux(const char* key
, const char* value
)
573 switch (store
.state
) {
575 if (matches(key
, value
)) {
576 if (store
.seen
== 1 && store
.multi_replace
== 0) {
578 "Warning: %s has multiple values\n",
580 } else if (store
.seen
>= MAX_MATCHES
) {
581 fprintf(stderr
, "Too many matches\n");
585 store
.offset
[store
.seen
] = ftell(config_file
);
591 * What we are looking for is in store.key (both
592 * section and var), and its section part is baselen
593 * long. We found key (again, both section and var).
594 * We would want to know if this key is in the same
595 * section as what we are looking for. We already
596 * know we are in the same section as what should
599 ep
= strrchr(key
, '.');
600 section_len
= ep
- key
;
602 if ((section_len
!= store
.baselen
) ||
603 memcmp(key
, store
.key
, section_len
+1)) {
604 store
.state
= SECTION_END_SEEN
;
609 * Do not increment matches: this is no match, but we
610 * just made sure we are in the desired section.
612 store
.offset
[store
.seen
] = ftell(config_file
);
614 case SECTION_END_SEEN
:
616 if (matches(key
, value
)) {
617 store
.offset
[store
.seen
] = ftell(config_file
);
618 store
.state
= KEY_SEEN
;
621 if (strrchr(key
, '.') - key
== store
.baselen
&&
622 !strncmp(key
, store
.key
, store
.baselen
)) {
623 store
.state
= SECTION_SEEN
;
624 store
.offset
[store
.seen
] = ftell(config_file
);
631 static int write_error(void)
633 fprintf(stderr
, "Failed to write new configuration file\n");
635 /* Same error code as "failed to rename". */
639 static int store_write_section(int fd
, const char* key
)
646 dot
= memchr(key
, '.', store
.baselen
);
648 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
649 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
651 strbuf_addch(&sb
, '\\');
652 strbuf_addch(&sb
, key
[i
]);
654 strbuf_addstr(&sb
, "\"]\n");
656 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
659 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
665 static int store_write_pair(int fd
, const char* key
, const char* value
)
668 int length
= strlen(key
+ store
.baselen
+ 1);
669 const char *quote
= "";
673 * Check to see if the value needs to be surrounded with a dq pair.
674 * Note that problematic characters are always backslash-quoted; this
675 * check is about not losing leading or trailing SP and strings that
676 * follow beginning-of-comment characters (i.e. ';' and '#') by the
677 * configuration parser.
681 for (i
= 0; value
[i
]; i
++)
682 if (value
[i
] == ';' || value
[i
] == '#')
684 if (i
&& value
[i
- 1] == ' ')
688 strbuf_addf(&sb
, "\t%.*s = %s",
689 length
, key
+ store
.baselen
+ 1, quote
);
691 for (i
= 0; value
[i
]; i
++)
694 strbuf_addstr(&sb
, "\\n");
697 strbuf_addstr(&sb
, "\\t");
701 strbuf_addch(&sb
, '\\');
703 strbuf_addch(&sb
, value
[i
]);
706 strbuf_addf(&sb
, "%s\n", quote
);
708 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
714 static ssize_t
find_beginning_of_line(const char* contents
, size_t size
,
715 size_t offset_
, int* found_bracket
)
717 size_t equal_offset
= size
, bracket_offset
= size
;
720 for (offset
= offset_
-2; offset
> 0
721 && contents
[offset
] != '\n'; offset
--)
722 switch (contents
[offset
]) {
723 case '=': equal_offset
= offset
; break;
724 case ']': bracket_offset
= offset
; break;
726 if (bracket_offset
< equal_offset
) {
728 offset
= bracket_offset
+1;
735 int git_config_set(const char* key
, const char* value
)
737 return git_config_set_multivar(key
, value
, NULL
, 0);
741 * If value==NULL, unset in (remove from) config,
742 * if value_regex!=NULL, disregard key/value pairs where value does not match.
743 * if multi_replace==0, nothing, or only one matching key/value is replaced,
744 * else all matching key/values (regardless how many) are removed,
745 * before the new pair is written.
747 * Returns 0 on success.
749 * This function does this:
751 * - it locks the config file by creating ".git/config.lock"
753 * - it then parses the config using store_aux() as validator to find
754 * the position on the key/value pair to replace. If it is to be unset,
755 * it must be found exactly once.
757 * - the config file is mmap()ed and the part before the match (if any) is
758 * written to the lock file, then the changed part and the rest.
760 * - the config file is removed and the lock file rename()d to it.
763 int git_config_set_multivar(const char* key
, const char* value
,
764 const char* value_regex
, int multi_replace
)
769 char* config_filename
;
770 struct lock_file
*lock
= NULL
;
771 const char* last_dot
= strrchr(key
, '.');
773 config_filename
= getenv(CONFIG_ENVIRONMENT
);
774 if (!config_filename
) {
775 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
776 if (!config_filename
)
777 config_filename
= git_path("config");
779 config_filename
= xstrdup(config_filename
);
782 * Since "key" actually contains the section name and the real
783 * key name separated by a dot, we have to know where the dot is.
786 if (last_dot
== NULL
) {
787 fprintf(stderr
, "key does not contain a section: %s\n", key
);
791 store
.baselen
= last_dot
- key
;
793 store
.multi_replace
= multi_replace
;
796 * Validate the key and while at it, lower case it for matching.
798 store
.key
= xmalloc(strlen(key
) + 1);
800 for (i
= 0; key
[i
]; i
++) {
801 unsigned char c
= key
[i
];
804 /* Leave the extended basename untouched.. */
805 if (!dot
|| i
> store
.baselen
) {
806 if (!iskeychar(c
) || (i
== store
.baselen
+1 && !isalpha(c
))) {
807 fprintf(stderr
, "invalid key: %s\n", key
);
813 } else if (c
== '\n') {
814 fprintf(stderr
, "invalid key (newline): %s\n", key
);
824 * The lock serves a purpose in addition to locking: the new
825 * contents of .git/config will be written into it.
827 lock
= xcalloc(sizeof(struct lock_file
), 1);
828 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
830 fprintf(stderr
, "could not lock config file\n");
837 * If .git/config does not exist yet, write a minimal version.
839 in_fd
= open(config_filename
, O_RDONLY
);
843 if ( ENOENT
!= errno
) {
844 error("opening %s: %s", config_filename
,
846 ret
= 3; /* same as "invalid config file" */
849 /* if nothing to unset, error out */
855 store
.key
= (char*)key
;
856 if (!store_write_section(fd
, key
) ||
857 !store_write_pair(fd
, key
, value
))
862 size_t contents_sz
, copy_begin
, copy_end
;
865 if (value_regex
== NULL
)
866 store
.value_regex
= NULL
;
868 if (value_regex
[0] == '!') {
869 store
.do_not_match
= 1;
872 store
.do_not_match
= 0;
874 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
875 if (regcomp(store
.value_regex
, value_regex
,
877 fprintf(stderr
, "Invalid pattern: %s\n",
879 free(store
.value_regex
);
890 * After this, store.offset will contain the *end* offset
891 * of the last match, or remain at 0 if no match was found.
892 * As a side effect, we make sure to transform only a valid
893 * existing config file.
895 if (git_config_from_file(store_aux
, config_filename
)) {
896 fprintf(stderr
, "invalid config file\n");
898 if (store
.value_regex
!= NULL
) {
899 regfree(store
.value_regex
);
900 free(store
.value_regex
);
907 if (store
.value_regex
!= NULL
) {
908 regfree(store
.value_regex
);
909 free(store
.value_regex
);
912 /* if nothing to unset, or too many matches, error out */
913 if ((store
.seen
== 0 && value
== NULL
) ||
914 (store
.seen
> 1 && multi_replace
== 0)) {
920 contents_sz
= xsize_t(st
.st_size
);
921 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
922 MAP_PRIVATE
, in_fd
, 0);
928 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
929 if (store
.offset
[i
] == 0) {
930 store
.offset
[i
] = copy_end
= contents_sz
;
931 } else if (store
.state
!= KEY_SEEN
) {
932 copy_end
= store
.offset
[i
];
934 copy_end
= find_beginning_of_line(
935 contents
, contents_sz
,
936 store
.offset
[i
]-2, &new_line
);
938 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
941 /* write the first part of the config */
942 if (copy_end
> copy_begin
) {
943 if (write_in_full(fd
, contents
+ copy_begin
,
944 copy_end
- copy_begin
) <
945 copy_end
- copy_begin
)
948 write_in_full(fd
, "\n", 1) != 1)
951 copy_begin
= store
.offset
[i
];
954 /* write the pair (value == NULL means unset) */
956 if (store
.state
== START
) {
957 if (!store_write_section(fd
, key
))
960 if (!store_write_pair(fd
, key
, value
))
964 /* write the rest of the config */
965 if (copy_begin
< contents_sz
)
966 if (write_in_full(fd
, contents
+ copy_begin
,
967 contents_sz
- copy_begin
) <
968 contents_sz
- copy_begin
)
971 munmap(contents
, contents_sz
);
974 if (commit_lock_file(lock
) < 0) {
975 fprintf(stderr
, "Cannot commit config file!\n");
981 * lock is committed, so don't try to roll it back below.
982 * NOTE: Since lockfile.c keeps a linked list of all created
983 * lock_file structures, it isn't safe to free(lock). It's
984 * better to just leave it hanging around.
991 rollback_lock_file(lock
);
992 free(config_filename
);
1001 static int section_name_match (const char *buf
, const char *name
)
1003 int i
= 0, j
= 0, dot
= 0;
1004 for (; buf
[i
] && buf
[i
] != ']'; i
++) {
1005 if (!dot
&& isspace(buf
[i
])) {
1007 if (name
[j
++] != '.')
1009 for (i
++; isspace(buf
[i
]); i
++)
1015 if (buf
[i
] == '\\' && dot
)
1017 else if (buf
[i
] == '"' && dot
) {
1018 for (i
++; isspace(buf
[i
]); i
++)
1022 if (buf
[i
] != name
[j
++])
1025 return (buf
[i
] == ']' && name
[j
] == 0);
1028 /* if new_name == NULL, the section is removed instead */
1029 int git_config_rename_section(const char *old_name
, const char *new_name
)
1031 int ret
= 0, remove
= 0;
1032 char *config_filename
;
1033 struct lock_file
*lock
= xcalloc(sizeof(struct lock_file
), 1);
1037 config_filename
= getenv(CONFIG_ENVIRONMENT
);
1038 if (!config_filename
) {
1039 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
1040 if (!config_filename
)
1041 config_filename
= git_path("config");
1043 config_filename
= xstrdup(config_filename
);
1044 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1046 ret
= error("Could not lock config file!");
1050 if (!(config_file
= fopen(config_filename
, "rb"))) {
1051 /* no config file means nothing to rename, no error */
1052 goto unlock_and_out
;
1055 while (fgets(buf
, sizeof(buf
), config_file
)) {
1058 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1060 if (buf
[i
] == '[') {
1061 /* it's a section */
1062 if (section_name_match (&buf
[i
+1], old_name
)) {
1064 if (new_name
== NULL
) {
1068 store
.baselen
= strlen(new_name
);
1069 if (!store_write_section(out_fd
, new_name
)) {
1070 ret
= write_error();
1079 length
= strlen(buf
);
1080 if (write_in_full(out_fd
, buf
, length
) != length
) {
1081 ret
= write_error();
1085 fclose(config_file
);
1087 if (commit_lock_file(lock
) < 0)
1088 ret
= error("Cannot commit config file!");
1090 free(config_filename
);