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 zlib_compression_seen
;
18 static int get_next_char(void)
24 if ((f
= config_file
) != NULL
) {
27 /* DOS like systems */
44 static char *parse_value(void)
46 static char value
[1024];
47 int quote
= 0, comment
= 0, len
= 0, space
= 0;
50 int c
= get_next_char();
51 if (len
>= sizeof(value
))
61 if (isspace(c
) && !quote
) {
66 if (c
== ';' || c
== '#') {
90 /* Some characters escape as themselves */
93 /* Reject unknown escape sequences */
108 static inline int iskeychar(int c
)
110 return isalnum(c
) || c
== '-';
113 static int get_value(config_fn_t fn
, char *name
, unsigned int len
)
118 /* Get the full name */
125 name
[len
++] = tolower(c
);
130 while (c
== ' ' || c
== '\t')
137 value
= parse_value();
141 return fn(name
, value
);
144 static int get_extended_base_var(char *name
, int baselen
, int c
)
150 } while (isspace(c
));
152 /* We require the format to be '[base "extension"]' */
155 name
[baselen
++] = '.';
158 int c
= get_next_char();
169 if (baselen
> MAXNAME
/ 2)
174 if (get_next_char() != ']')
179 static int get_base_var(char *name
)
184 int c
= get_next_char();
190 return get_extended_base_var(name
, baselen
, c
);
191 if (!iskeychar(c
) && c
!= '.')
193 if (baselen
> MAXNAME
/ 2)
195 name
[baselen
++] = tolower(c
);
199 static int git_parse_file(config_fn_t fn
)
203 static char var
[MAXNAME
];
206 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 unsigned long get_unit_factor(const char *end
)
241 else if (!strcasecmp(end
, "k"))
243 else if (!strcasecmp(end
, "m"))
245 else if (!strcasecmp(end
, "g"))
246 return 1024 * 1024 * 1024;
247 die("unknown unit: '%s'", end
);
250 int git_parse_long(const char *value
, long *ret
)
252 if (value
&& *value
) {
254 long val
= strtol(value
, &end
, 0);
255 *ret
= val
* get_unit_factor(end
);
261 int git_parse_ulong(const char *value
, unsigned long *ret
)
263 if (value
&& *value
) {
265 unsigned long val
= strtoul(value
, &end
, 0);
266 *ret
= val
* get_unit_factor(end
);
272 int git_config_int(const char *name
, const char *value
)
275 if (!git_parse_long(value
, &ret
))
276 die("bad config value for '%s' in %s", name
, config_file_name
);
280 unsigned long git_config_ulong(const char *name
, const char *value
)
283 if (!git_parse_ulong(value
, &ret
))
284 die("bad config value for '%s' in %s", name
, config_file_name
);
288 int git_config_bool(const char *name
, const char *value
)
294 if (!strcasecmp(value
, "true") || !strcasecmp(value
, "yes"))
296 if (!strcasecmp(value
, "false") || !strcasecmp(value
, "no"))
298 return git_config_int(name
, value
) != 0;
301 int git_default_config(const char *var
, const char *value
)
303 /* This needs a better name */
304 if (!strcmp(var
, "core.filemode")) {
305 trust_executable_bit
= git_config_bool(var
, value
);
309 if (!strcmp(var
, "core.quotepath")) {
310 quote_path_fully
= git_config_bool(var
, value
);
314 if (!strcmp(var
, "core.symlinks")) {
315 has_symlinks
= git_config_bool(var
, value
);
319 if (!strcmp(var
, "core.bare")) {
320 is_bare_repository_cfg
= git_config_bool(var
, value
);
324 if (!strcmp(var
, "core.ignorestat")) {
325 assume_unchanged
= git_config_bool(var
, value
);
329 if (!strcmp(var
, "core.prefersymlinkrefs")) {
330 prefer_symlink_refs
= git_config_bool(var
, value
);
334 if (!strcmp(var
, "core.logallrefupdates")) {
335 log_all_ref_updates
= git_config_bool(var
, value
);
339 if (!strcmp(var
, "core.warnambiguousrefs")) {
340 warn_ambiguous_refs
= git_config_bool(var
, value
);
344 if (!strcmp(var
, "core.loosecompression")) {
345 int level
= git_config_int(var
, value
);
347 level
= Z_DEFAULT_COMPRESSION
;
348 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
349 die("bad zlib compression level %d", level
);
350 zlib_compression_level
= level
;
351 zlib_compression_seen
= 1;
355 if (!strcmp(var
, "core.compression")) {
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 core_compression_level
= level
;
362 core_compression_seen
= 1;
363 if (!zlib_compression_seen
)
364 zlib_compression_level
= level
;
368 if (!strcmp(var
, "core.packedgitwindowsize")) {
369 int pgsz_x2
= getpagesize() * 2;
370 packed_git_window_size
= git_config_int(var
, value
);
372 /* This value must be multiple of (pagesize * 2) */
373 packed_git_window_size
/= pgsz_x2
;
374 if (packed_git_window_size
< 1)
375 packed_git_window_size
= 1;
376 packed_git_window_size
*= pgsz_x2
;
380 if (!strcmp(var
, "core.packedgitlimit")) {
381 packed_git_limit
= git_config_int(var
, value
);
385 if (!strcmp(var
, "core.deltabasecachelimit")) {
386 delta_base_cache_limit
= git_config_int(var
, value
);
390 if (!strcmp(var
, "core.autocrlf")) {
391 if (value
&& !strcasecmp(value
, "input")) {
395 auto_crlf
= git_config_bool(var
, value
);
399 if (!strcmp(var
, "user.name")) {
400 strlcpy(git_default_name
, value
, sizeof(git_default_name
));
404 if (!strcmp(var
, "user.email")) {
405 strlcpy(git_default_email
, value
, sizeof(git_default_email
));
409 if (!strcmp(var
, "i18n.commitencoding")) {
410 git_commit_encoding
= xstrdup(value
);
414 if (!strcmp(var
, "i18n.logoutputencoding")) {
415 git_log_output_encoding
= xstrdup(value
);
420 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
421 pager_use_color
= git_config_bool(var
,value
);
425 if (!strcmp(var
, "core.pager")) {
426 pager_program
= xstrdup(value
);
430 if (!strcmp(var
, "core.editor")) {
431 editor_program
= xstrdup(value
);
435 if (!strcmp(var
, "core.excludesfile")) {
437 die("core.excludesfile without value");
438 excludes_file
= xstrdup(value
);
442 if (!strcmp(var
, "core.whitespace")) {
443 whitespace_rule_cfg
= parse_whitespace_rule(value
);
447 /* Add other config variables here and to Documentation/config.txt. */
451 int git_config_from_file(config_fn_t fn
, const char *filename
)
454 FILE *f
= fopen(filename
, "r");
459 config_file_name
= filename
;
461 ret
= git_parse_file(fn
);
463 config_file_name
= NULL
;
468 const char *git_etc_gitconfig(void)
470 static const char *system_wide
;
472 system_wide
= ETC_GITCONFIG
;
473 if (!is_absolute_path(system_wide
)) {
474 /* interpret path relative to exec-dir */
475 const char *exec_path
= git_exec_path();
476 system_wide
= prefix_path(exec_path
, strlen(exec_path
),
483 int git_config(config_fn_t fn
)
486 char *repo_config
= NULL
;
487 const char *home
= NULL
, *filename
;
489 /* $GIT_CONFIG makes git read _only_ the given config file,
490 * $GIT_CONFIG_LOCAL will make it process it in addition to the
491 * global config file, the same way it would the per-repository
492 * config file otherwise. */
493 filename
= getenv(CONFIG_ENVIRONMENT
);
495 if (!access(git_etc_gitconfig(), R_OK
))
496 ret
+= git_config_from_file(fn
, git_etc_gitconfig());
497 home
= getenv("HOME");
498 filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
500 filename
= repo_config
= xstrdup(git_path("config"));
504 char *user_config
= xstrdup(mkpath("%s/.gitconfig", home
));
505 if (!access(user_config
, R_OK
))
506 ret
= git_config_from_file(fn
, user_config
);
510 ret
+= git_config_from_file(fn
, filename
);
516 * Find all the stuff for git_config_set() below.
519 #define MAX_MATCHES 512
525 regex_t
* value_regex
;
527 size_t offset
[MAX_MATCHES
];
528 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
532 static int matches(const char* key
, const char* value
)
534 return !strcmp(key
, store
.key
) &&
535 (store
.value_regex
== NULL
||
536 (store
.do_not_match
^
537 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
540 static int store_aux(const char* key
, const char* value
)
545 switch (store
.state
) {
547 if (matches(key
, value
)) {
548 if (store
.seen
== 1 && store
.multi_replace
== 0) {
550 "Warning: %s has multiple values\n",
552 } else if (store
.seen
>= MAX_MATCHES
) {
553 fprintf(stderr
, "Too many matches\n");
557 store
.offset
[store
.seen
] = ftell(config_file
);
563 * What we are looking for is in store.key (both
564 * section and var), and its section part is baselen
565 * long. We found key (again, both section and var).
566 * We would want to know if this key is in the same
567 * section as what we are looking for. We already
568 * know we are in the same section as what should
571 ep
= strrchr(key
, '.');
572 section_len
= ep
- key
;
574 if ((section_len
!= store
.baselen
) ||
575 memcmp(key
, store
.key
, section_len
+1)) {
576 store
.state
= SECTION_END_SEEN
;
581 * Do not increment matches: this is no match, but we
582 * just made sure we are in the desired section.
584 store
.offset
[store
.seen
] = ftell(config_file
);
586 case SECTION_END_SEEN
:
588 if (matches(key
, value
)) {
589 store
.offset
[store
.seen
] = ftell(config_file
);
590 store
.state
= KEY_SEEN
;
593 if (strrchr(key
, '.') - key
== store
.baselen
&&
594 !strncmp(key
, store
.key
, store
.baselen
)) {
595 store
.state
= SECTION_SEEN
;
596 store
.offset
[store
.seen
] = ftell(config_file
);
603 static int write_error(void)
605 fprintf(stderr
, "Failed to write new configuration file\n");
607 /* Same error code as "failed to rename". */
611 static int store_write_section(int fd
, const char* key
)
618 dot
= memchr(key
, '.', store
.baselen
);
620 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
621 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
623 strbuf_addch(&sb
, '\\');
624 strbuf_addch(&sb
, key
[i
]);
626 strbuf_addstr(&sb
, "\"]\n");
628 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
631 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
637 static int store_write_pair(int fd
, const char* key
, const char* value
)
640 int length
= strlen(key
+ store
.baselen
+ 1);
641 const char *quote
= "";
645 * Check to see if the value needs to be surrounded with a dq pair.
646 * Note that problematic characters are always backslash-quoted; this
647 * check is about not losing leading or trailing SP and strings that
648 * follow beginning-of-comment characters (i.e. ';' and '#') by the
649 * configuration parser.
653 for (i
= 0; value
[i
]; i
++)
654 if (value
[i
] == ';' || value
[i
] == '#')
656 if (i
&& value
[i
- 1] == ' ')
660 strbuf_addf(&sb
, "\t%.*s = %s",
661 length
, key
+ store
.baselen
+ 1, quote
);
663 for (i
= 0; value
[i
]; i
++)
666 strbuf_addstr(&sb
, "\\n");
669 strbuf_addstr(&sb
, "\\t");
673 strbuf_addch(&sb
, '\\');
675 strbuf_addch(&sb
, value
[i
]);
678 strbuf_addf(&sb
, "%s\n", quote
);
680 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
686 static ssize_t
find_beginning_of_line(const char* contents
, size_t size
,
687 size_t offset_
, int* found_bracket
)
689 size_t equal_offset
= size
, bracket_offset
= size
;
692 for (offset
= offset_
-2; offset
> 0
693 && contents
[offset
] != '\n'; offset
--)
694 switch (contents
[offset
]) {
695 case '=': equal_offset
= offset
; break;
696 case ']': bracket_offset
= offset
; break;
698 if (bracket_offset
< equal_offset
) {
700 offset
= bracket_offset
+1;
707 int git_config_set(const char* key
, const char* value
)
709 return git_config_set_multivar(key
, value
, NULL
, 0);
713 * If value==NULL, unset in (remove from) config,
714 * if value_regex!=NULL, disregard key/value pairs where value does not match.
715 * if multi_replace==0, nothing, or only one matching key/value is replaced,
716 * else all matching key/values (regardless how many) are removed,
717 * before the new pair is written.
719 * Returns 0 on success.
721 * This function does this:
723 * - it locks the config file by creating ".git/config.lock"
725 * - it then parses the config using store_aux() as validator to find
726 * the position on the key/value pair to replace. If it is to be unset,
727 * it must be found exactly once.
729 * - the config file is mmap()ed and the part before the match (if any) is
730 * written to the lock file, then the changed part and the rest.
732 * - the config file is removed and the lock file rename()d to it.
735 int git_config_set_multivar(const char* key
, const char* value
,
736 const char* value_regex
, int multi_replace
)
741 char* config_filename
;
742 struct lock_file
*lock
= NULL
;
743 const char* last_dot
= strrchr(key
, '.');
745 config_filename
= getenv(CONFIG_ENVIRONMENT
);
746 if (!config_filename
) {
747 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
748 if (!config_filename
)
749 config_filename
= git_path("config");
751 config_filename
= xstrdup(config_filename
);
754 * Since "key" actually contains the section name and the real
755 * key name separated by a dot, we have to know where the dot is.
758 if (last_dot
== NULL
) {
759 fprintf(stderr
, "key does not contain a section: %s\n", key
);
763 store
.baselen
= last_dot
- key
;
765 store
.multi_replace
= multi_replace
;
768 * Validate the key and while at it, lower case it for matching.
770 store
.key
= xmalloc(strlen(key
) + 1);
772 for (i
= 0; key
[i
]; i
++) {
773 unsigned char c
= key
[i
];
776 /* Leave the extended basename untouched.. */
777 if (!dot
|| i
> store
.baselen
) {
778 if (!iskeychar(c
) || (i
== store
.baselen
+1 && !isalpha(c
))) {
779 fprintf(stderr
, "invalid key: %s\n", key
);
785 } else if (c
== '\n') {
786 fprintf(stderr
, "invalid key (newline): %s\n", key
);
796 * The lock serves a purpose in addition to locking: the new
797 * contents of .git/config will be written into it.
799 lock
= xcalloc(sizeof(struct lock_file
), 1);
800 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
802 fprintf(stderr
, "could not lock config file\n");
809 * If .git/config does not exist yet, write a minimal version.
811 in_fd
= open(config_filename
, O_RDONLY
);
815 if ( ENOENT
!= errno
) {
816 error("opening %s: %s", config_filename
,
818 ret
= 3; /* same as "invalid config file" */
821 /* if nothing to unset, error out */
827 store
.key
= (char*)key
;
828 if (!store_write_section(fd
, key
) ||
829 !store_write_pair(fd
, key
, value
))
834 size_t contents_sz
, copy_begin
, copy_end
;
837 if (value_regex
== NULL
)
838 store
.value_regex
= NULL
;
840 if (value_regex
[0] == '!') {
841 store
.do_not_match
= 1;
844 store
.do_not_match
= 0;
846 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
847 if (regcomp(store
.value_regex
, value_regex
,
849 fprintf(stderr
, "Invalid pattern: %s\n",
851 free(store
.value_regex
);
862 * After this, store.offset will contain the *end* offset
863 * of the last match, or remain at 0 if no match was found.
864 * As a side effect, we make sure to transform only a valid
865 * existing config file.
867 if (git_config_from_file(store_aux
, config_filename
)) {
868 fprintf(stderr
, "invalid config file\n");
870 if (store
.value_regex
!= NULL
) {
871 regfree(store
.value_regex
);
872 free(store
.value_regex
);
879 if (store
.value_regex
!= NULL
) {
880 regfree(store
.value_regex
);
881 free(store
.value_regex
);
884 /* if nothing to unset, or too many matches, error out */
885 if ((store
.seen
== 0 && value
== NULL
) ||
886 (store
.seen
> 1 && multi_replace
== 0)) {
892 contents_sz
= xsize_t(st
.st_size
);
893 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
894 MAP_PRIVATE
, in_fd
, 0);
900 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
901 if (store
.offset
[i
] == 0) {
902 store
.offset
[i
] = copy_end
= contents_sz
;
903 } else if (store
.state
!= KEY_SEEN
) {
904 copy_end
= store
.offset
[i
];
906 copy_end
= find_beginning_of_line(
907 contents
, contents_sz
,
908 store
.offset
[i
]-2, &new_line
);
910 /* write the first part of the config */
911 if (copy_end
> copy_begin
) {
912 if (write_in_full(fd
, contents
+ copy_begin
,
913 copy_end
- copy_begin
) <
914 copy_end
- copy_begin
)
917 write_in_full(fd
, "\n", 1) != 1)
920 copy_begin
= store
.offset
[i
];
923 /* write the pair (value == NULL means unset) */
925 if (store
.state
== START
) {
926 if (!store_write_section(fd
, key
))
929 if (!store_write_pair(fd
, key
, value
))
933 /* write the rest of the config */
934 if (copy_begin
< contents_sz
)
935 if (write_in_full(fd
, contents
+ copy_begin
,
936 contents_sz
- copy_begin
) <
937 contents_sz
- copy_begin
)
940 munmap(contents
, contents_sz
);
943 if (close(fd
) || commit_lock_file(lock
) < 0) {
944 fprintf(stderr
, "Cannot commit config file!\n");
949 /* fd is closed, so don't try to close it below. */
952 * lock is committed, so don't try to roll it back below.
953 * NOTE: Since lockfile.c keeps a linked list of all created
954 * lock_file structures, it isn't safe to free(lock). It's
955 * better to just leave it hanging around.
964 rollback_lock_file(lock
);
965 free(config_filename
);
974 static int section_name_match (const char *buf
, const char *name
)
976 int i
= 0, j
= 0, dot
= 0;
977 for (; buf
[i
] && buf
[i
] != ']'; i
++) {
978 if (!dot
&& isspace(buf
[i
])) {
980 if (name
[j
++] != '.')
982 for (i
++; isspace(buf
[i
]); i
++)
988 if (buf
[i
] == '\\' && dot
)
990 else if (buf
[i
] == '"' && dot
) {
991 for (i
++; isspace(buf
[i
]); i
++)
995 if (buf
[i
] != name
[j
++])
998 return (buf
[i
] == ']' && name
[j
] == 0);
1001 /* if new_name == NULL, the section is removed instead */
1002 int git_config_rename_section(const char *old_name
, const char *new_name
)
1004 int ret
= 0, remove
= 0;
1005 char *config_filename
;
1006 struct lock_file
*lock
= xcalloc(sizeof(struct lock_file
), 1);
1010 config_filename
= getenv(CONFIG_ENVIRONMENT
);
1011 if (!config_filename
) {
1012 config_filename
= getenv(CONFIG_LOCAL_ENVIRONMENT
);
1013 if (!config_filename
)
1014 config_filename
= git_path("config");
1016 config_filename
= xstrdup(config_filename
);
1017 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1019 ret
= error("Could not lock config file!");
1023 if (!(config_file
= fopen(config_filename
, "rb"))) {
1024 /* no config file means nothing to rename, no error */
1025 goto unlock_and_out
;
1028 while (fgets(buf
, sizeof(buf
), config_file
)) {
1031 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1033 if (buf
[i
] == '[') {
1034 /* it's a section */
1035 if (section_name_match (&buf
[i
+1], old_name
)) {
1037 if (new_name
== NULL
) {
1041 store
.baselen
= strlen(new_name
);
1042 if (!store_write_section(out_fd
, new_name
)) {
1043 ret
= write_error();
1052 length
= strlen(buf
);
1053 if (write_in_full(out_fd
, buf
, length
) != length
) {
1054 ret
= write_error();
1058 fclose(config_file
);
1060 if (close(out_fd
) || commit_lock_file(lock
) < 0)
1061 ret
= error("Cannot commit config file!");
1063 free(config_filename
);