2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
13 struct config_source
{
14 struct config_source
*prev
;
31 int (*do_fgetc
)(struct config_source
*c
);
32 int (*do_ungetc
)(int c
, struct config_source
*conf
);
33 long (*do_ftell
)(struct config_source
*c
);
36 static struct config_source
*cf
;
38 static int zlib_compression_seen
;
40 static int config_file_fgetc(struct config_source
*conf
)
42 return fgetc(conf
->u
.file
);
45 static int config_file_ungetc(int c
, struct config_source
*conf
)
47 return ungetc(c
, conf
->u
.file
);
50 static long config_file_ftell(struct config_source
*conf
)
52 return ftell(conf
->u
.file
);
56 static int config_buf_fgetc(struct config_source
*conf
)
58 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
59 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
64 static int config_buf_ungetc(int c
, struct config_source
*conf
)
66 if (conf
->u
.buf
.pos
> 0)
67 return conf
->u
.buf
.buf
[--conf
->u
.buf
.pos
];
72 static long config_buf_ftell(struct config_source
*conf
)
74 return conf
->u
.buf
.pos
;
77 #define MAX_INCLUDE_DEPTH 10
78 static const char include_depth_advice
[] =
79 "exceeded maximum include depth (%d) while including\n"
83 "Do you have circular includes?";
84 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
87 struct strbuf buf
= STRBUF_INIT
;
91 return config_error_nonbool("include.path");
93 expanded
= expand_user_path(path
);
95 return error("Could not expand include path '%s'", path
);
99 * Use an absolute path as-is, but interpret relative paths
100 * based on the including config file.
102 if (!is_absolute_path(path
)) {
105 if (!cf
|| !cf
->path
)
106 return error("relative config includes must come from files");
108 slash
= find_last_dir_sep(cf
->path
);
110 strbuf_add(&buf
, cf
->path
, slash
- cf
->path
+ 1);
111 strbuf_addstr(&buf
, path
);
115 if (!access_or_die(path
, R_OK
, 0)) {
116 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
117 die(include_depth_advice
, MAX_INCLUDE_DEPTH
, path
,
118 cf
&& cf
->name
? cf
->name
: "the command line");
119 ret
= git_config_from_file(git_config_include
, path
, inc
);
122 strbuf_release(&buf
);
127 int git_config_include(const char *var
, const char *value
, void *data
)
129 struct config_include_data
*inc
= data
;
134 * Pass along all values, including "include" directives; this makes it
135 * possible to query information on the includes themselves.
137 ret
= inc
->fn(var
, value
, inc
->data
);
141 type
= skip_prefix(var
, "include.");
145 if (!strcmp(type
, "path"))
146 ret
= handle_path_include(value
, inc
);
150 static void lowercase(char *p
)
156 void git_config_push_parameter(const char *text
)
158 struct strbuf env
= STRBUF_INIT
;
159 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
161 strbuf_addstr(&env
, old
);
162 strbuf_addch(&env
, ' ');
164 sq_quote_buf(&env
, text
);
165 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
166 strbuf_release(&env
);
169 int git_config_parse_parameter(const char *text
,
170 config_fn_t fn
, void *data
)
172 struct strbuf
**pair
;
173 pair
= strbuf_split_str(text
, '=', 2);
175 return error("bogus config parameter: %s", text
);
176 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=')
177 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
178 strbuf_trim(pair
[0]);
180 strbuf_list_free(pair
);
181 return error("bogus config parameter: %s", text
);
183 lowercase(pair
[0]->buf
);
184 if (fn(pair
[0]->buf
, pair
[1] ? pair
[1]->buf
: NULL
, data
) < 0) {
185 strbuf_list_free(pair
);
188 strbuf_list_free(pair
);
192 int git_config_from_parameters(config_fn_t fn
, void *data
)
194 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
196 const char **argv
= NULL
;
197 int nr
= 0, alloc
= 0;
202 /* sq_dequote will write over it */
205 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
207 return error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
210 for (i
= 0; i
< nr
; i
++) {
211 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
223 static int get_next_char(void)
225 int c
= cf
->do_fgetc(cf
);
228 /* DOS like systems */
229 c
= cf
->do_fgetc(cf
);
231 cf
->do_ungetc(c
, cf
);
244 static char *parse_value(void)
246 int quote
= 0, comment
= 0, space
= 0;
248 strbuf_reset(&cf
->value
);
250 int c
= get_next_char();
256 return cf
->value
.buf
;
260 if (isspace(c
) && !quote
) {
266 if (c
== ';' || c
== '#') {
271 for (; space
; space
--)
272 strbuf_addch(&cf
->value
, ' ');
287 /* Some characters escape as themselves */
290 /* Reject unknown escape sequences */
294 strbuf_addch(&cf
->value
, c
);
301 strbuf_addch(&cf
->value
, c
);
305 static inline int iskeychar(int c
)
307 return isalnum(c
) || c
== '-';
310 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
315 /* Get the full name */
322 strbuf_addch(name
, tolower(c
));
325 while (c
== ' ' || c
== '\t')
332 value
= parse_value();
336 return fn(name
->buf
, value
, data
);
339 static int get_extended_base_var(struct strbuf
*name
, int c
)
343 goto error_incomplete_line
;
345 } while (isspace(c
));
347 /* We require the format to be '[base "extension"]' */
350 strbuf_addch(name
, '.');
353 int c
= get_next_char();
355 goto error_incomplete_line
;
361 goto error_incomplete_line
;
363 strbuf_addch(name
, c
);
367 if (get_next_char() != ']')
370 error_incomplete_line
:
375 static int get_base_var(struct strbuf
*name
)
378 int c
= get_next_char();
384 return get_extended_base_var(name
, c
);
385 if (!iskeychar(c
) && c
!= '.')
387 strbuf_addch(name
, tolower(c
));
391 static int git_parse_source(config_fn_t fn
, void *data
)
395 struct strbuf
*var
= &cf
->var
;
397 /* U+FEFF Byte Order Mark in UTF8 */
398 static const unsigned char *utf8_bom
= (unsigned char *) "\xef\xbb\xbf";
399 const unsigned char *bomptr
= utf8_bom
;
402 int c
= get_next_char();
403 if (bomptr
&& *bomptr
) {
404 /* We are at the file beginning; skip UTF8-encoded BOM
405 * if present. Sane editors won't put this in on their
406 * own, but e.g. Windows Notepad will do it happily. */
407 if ((unsigned char) c
== *bomptr
) {
411 /* Do not tolerate partial BOM. */
412 if (bomptr
!= utf8_bom
)
414 /* No BOM at file beginning. Cool. */
424 if (comment
|| isspace(c
))
426 if (c
== '#' || c
== ';') {
431 /* Reset prior to determining a new stem */
433 if (get_base_var(var
) < 0 || var
->len
< 1)
435 strbuf_addch(var
, '.');
442 * Truncate the var name back to the section header
443 * stem prior to grabbing the suffix part of the name
446 strbuf_setlen(var
, baselen
);
447 strbuf_addch(var
, tolower(c
));
448 if (get_value(fn
, data
, var
) < 0)
451 if (cf
->die_on_error
)
452 die("bad config file line %d in %s", cf
->linenr
, cf
->name
);
454 return error("bad config file line %d in %s", cf
->linenr
, cf
->name
);
457 static int parse_unit_factor(const char *end
, uintmax_t *val
)
461 else if (!strcasecmp(end
, "k")) {
465 else if (!strcasecmp(end
, "m")) {
469 else if (!strcasecmp(end
, "g")) {
470 *val
*= 1024 * 1024 * 1024;
476 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
478 if (value
&& *value
) {
482 uintmax_t factor
= 1;
485 val
= strtoimax(value
, &end
, 0);
488 if (!parse_unit_factor(end
, &factor
)) {
494 if (uval
> max
|| abs(val
) > uval
) {
506 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
508 if (value
&& *value
) {
514 val
= strtoumax(value
, &end
, 0);
518 if (!parse_unit_factor(end
, &val
)) {
522 if (val
> max
|| oldval
> val
) {
533 static int git_parse_int(const char *value
, int *ret
)
536 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
542 static int git_parse_int64(const char *value
, int64_t *ret
)
545 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
551 int git_parse_ulong(const char *value
, unsigned long *ret
)
554 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
561 static void die_bad_number(const char *name
, const char *value
)
563 const char *reason
= errno
== ERANGE
?
570 die("bad numeric config value '%s' for '%s' in %s: %s",
571 value
, name
, cf
->name
, reason
);
572 die("bad numeric config value '%s' for '%s': %s", value
, name
, reason
);
575 int git_config_int(const char *name
, const char *value
)
578 if (!git_parse_int(value
, &ret
))
579 die_bad_number(name
, value
);
583 int64_t git_config_int64(const char *name
, const char *value
)
586 if (!git_parse_int64(value
, &ret
))
587 die_bad_number(name
, value
);
591 unsigned long git_config_ulong(const char *name
, const char *value
)
594 if (!git_parse_ulong(value
, &ret
))
595 die_bad_number(name
, value
);
599 static int git_config_maybe_bool_text(const char *name
, const char *value
)
605 if (!strcasecmp(value
, "true")
606 || !strcasecmp(value
, "yes")
607 || !strcasecmp(value
, "on"))
609 if (!strcasecmp(value
, "false")
610 || !strcasecmp(value
, "no")
611 || !strcasecmp(value
, "off"))
616 int git_config_maybe_bool(const char *name
, const char *value
)
618 int v
= git_config_maybe_bool_text(name
, value
);
621 if (git_parse_int(value
, &v
))
626 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
628 int v
= git_config_maybe_bool_text(name
, value
);
634 return git_config_int(name
, value
);
637 int git_config_bool(const char *name
, const char *value
)
640 return !!git_config_bool_or_int(name
, value
, &discard
);
643 int git_config_string(const char **dest
, const char *var
, const char *value
)
646 return config_error_nonbool(var
);
647 *dest
= xstrdup(value
);
651 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
654 return config_error_nonbool(var
);
655 *dest
= expand_user_path(value
);
657 die("Failed to expand user dir in: '%s'", value
);
661 static int git_default_core_config(const char *var
, const char *value
)
663 /* This needs a better name */
664 if (!strcmp(var
, "core.filemode")) {
665 trust_executable_bit
= git_config_bool(var
, value
);
668 if (!strcmp(var
, "core.trustctime")) {
669 trust_ctime
= git_config_bool(var
, value
);
672 if (!strcmp(var
, "core.checkstat")) {
673 if (!strcasecmp(value
, "default"))
675 else if (!strcasecmp(value
, "minimal"))
679 if (!strcmp(var
, "core.quotepath")) {
680 quote_path_fully
= git_config_bool(var
, value
);
684 if (!strcmp(var
, "core.symlinks")) {
685 has_symlinks
= git_config_bool(var
, value
);
689 if (!strcmp(var
, "core.ignorecase")) {
690 ignore_case
= git_config_bool(var
, value
);
694 if (!strcmp(var
, "core.attributesfile"))
695 return git_config_pathname(&git_attributes_file
, var
, value
);
697 if (!strcmp(var
, "core.bare")) {
698 is_bare_repository_cfg
= git_config_bool(var
, value
);
702 if (!strcmp(var
, "core.ignorestat")) {
703 assume_unchanged
= git_config_bool(var
, value
);
707 if (!strcmp(var
, "core.prefersymlinkrefs")) {
708 prefer_symlink_refs
= git_config_bool(var
, value
);
712 if (!strcmp(var
, "core.logallrefupdates")) {
713 log_all_ref_updates
= git_config_bool(var
, value
);
717 if (!strcmp(var
, "core.warnambiguousrefs")) {
718 warn_ambiguous_refs
= git_config_bool(var
, value
);
722 if (!strcmp(var
, "core.abbrev")) {
723 int abbrev
= git_config_int(var
, value
);
724 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
726 default_abbrev
= abbrev
;
730 if (!strcmp(var
, "core.loosecompression")) {
731 int level
= git_config_int(var
, value
);
733 level
= Z_DEFAULT_COMPRESSION
;
734 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
735 die("bad zlib compression level %d", level
);
736 zlib_compression_level
= level
;
737 zlib_compression_seen
= 1;
741 if (!strcmp(var
, "core.compression")) {
742 int level
= git_config_int(var
, value
);
744 level
= Z_DEFAULT_COMPRESSION
;
745 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
746 die("bad zlib compression level %d", level
);
747 core_compression_level
= level
;
748 core_compression_seen
= 1;
749 if (!zlib_compression_seen
)
750 zlib_compression_level
= level
;
754 if (!strcmp(var
, "core.packedgitwindowsize")) {
755 int pgsz_x2
= getpagesize() * 2;
756 packed_git_window_size
= git_config_ulong(var
, value
);
758 /* This value must be multiple of (pagesize * 2) */
759 packed_git_window_size
/= pgsz_x2
;
760 if (packed_git_window_size
< 1)
761 packed_git_window_size
= 1;
762 packed_git_window_size
*= pgsz_x2
;
766 if (!strcmp(var
, "core.bigfilethreshold")) {
767 big_file_threshold
= git_config_ulong(var
, value
);
771 if (!strcmp(var
, "core.packedgitlimit")) {
772 packed_git_limit
= git_config_ulong(var
, value
);
776 if (!strcmp(var
, "core.deltabasecachelimit")) {
777 delta_base_cache_limit
= git_config_ulong(var
, value
);
781 if (!strcmp(var
, "core.autocrlf")) {
782 if (value
&& !strcasecmp(value
, "input")) {
783 if (core_eol
== EOL_CRLF
)
784 return error("core.autocrlf=input conflicts with core.eol=crlf");
785 auto_crlf
= AUTO_CRLF_INPUT
;
788 auto_crlf
= git_config_bool(var
, value
);
792 if (!strcmp(var
, "core.safecrlf")) {
793 if (value
&& !strcasecmp(value
, "warn")) {
794 safe_crlf
= SAFE_CRLF_WARN
;
797 safe_crlf
= git_config_bool(var
, value
);
801 if (!strcmp(var
, "core.eol")) {
802 if (value
&& !strcasecmp(value
, "lf"))
804 else if (value
&& !strcasecmp(value
, "crlf"))
806 else if (value
&& !strcasecmp(value
, "native"))
807 core_eol
= EOL_NATIVE
;
809 core_eol
= EOL_UNSET
;
810 if (core_eol
== EOL_CRLF
&& auto_crlf
== AUTO_CRLF_INPUT
)
811 return error("core.autocrlf=input conflicts with core.eol=crlf");
815 if (!strcmp(var
, "core.notesref")) {
816 notes_ref_name
= xstrdup(value
);
820 if (!strcmp(var
, "core.pager"))
821 return git_config_string(&pager_program
, var
, value
);
823 if (!strcmp(var
, "core.editor"))
824 return git_config_string(&editor_program
, var
, value
);
826 if (!strcmp(var
, "core.commentchar")) {
828 int ret
= git_config_string(&comment
, var
, value
);
831 else if (comment
[0] && !comment
[1]) {
832 comment_line_char
= comment
[0];
834 return error("core.commentChar should only be one character");
838 if (!strcmp(var
, "core.askpass"))
839 return git_config_string(&askpass_program
, var
, value
);
841 if (!strcmp(var
, "core.excludesfile"))
842 return git_config_pathname(&excludes_file
, var
, value
);
844 if (!strcmp(var
, "core.whitespace")) {
846 return config_error_nonbool(var
);
847 whitespace_rule_cfg
= parse_whitespace_rule(value
);
851 if (!strcmp(var
, "core.fsyncobjectfiles")) {
852 fsync_object_files
= git_config_bool(var
, value
);
856 if (!strcmp(var
, "core.preloadindex")) {
857 core_preload_index
= git_config_bool(var
, value
);
861 if (!strcmp(var
, "core.createobject")) {
862 if (!strcmp(value
, "rename"))
863 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
864 else if (!strcmp(value
, "link"))
865 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
867 die("Invalid mode for object creation: %s", value
);
871 if (!strcmp(var
, "core.sparsecheckout")) {
872 core_apply_sparse_checkout
= git_config_bool(var
, value
);
876 if (!strcmp(var
, "core.precomposeunicode")) {
877 precomposed_unicode
= git_config_bool(var
, value
);
881 /* Add other config variables here and to Documentation/config.txt. */
885 static int git_default_i18n_config(const char *var
, const char *value
)
887 if (!strcmp(var
, "i18n.commitencoding"))
888 return git_config_string(&git_commit_encoding
, var
, value
);
890 if (!strcmp(var
, "i18n.logoutputencoding"))
891 return git_config_string(&git_log_output_encoding
, var
, value
);
893 /* Add other config variables here and to Documentation/config.txt. */
897 static int git_default_branch_config(const char *var
, const char *value
)
899 if (!strcmp(var
, "branch.autosetupmerge")) {
900 if (value
&& !strcasecmp(value
, "always")) {
901 git_branch_track
= BRANCH_TRACK_ALWAYS
;
904 git_branch_track
= git_config_bool(var
, value
);
907 if (!strcmp(var
, "branch.autosetuprebase")) {
909 return config_error_nonbool(var
);
910 else if (!strcmp(value
, "never"))
911 autorebase
= AUTOREBASE_NEVER
;
912 else if (!strcmp(value
, "local"))
913 autorebase
= AUTOREBASE_LOCAL
;
914 else if (!strcmp(value
, "remote"))
915 autorebase
= AUTOREBASE_REMOTE
;
916 else if (!strcmp(value
, "always"))
917 autorebase
= AUTOREBASE_ALWAYS
;
919 return error("Malformed value for %s", var
);
923 /* Add other config variables here and to Documentation/config.txt. */
927 static int git_default_push_config(const char *var
, const char *value
)
929 if (!strcmp(var
, "push.default")) {
931 return config_error_nonbool(var
);
932 else if (!strcmp(value
, "nothing"))
933 push_default
= PUSH_DEFAULT_NOTHING
;
934 else if (!strcmp(value
, "matching"))
935 push_default
= PUSH_DEFAULT_MATCHING
;
936 else if (!strcmp(value
, "simple"))
937 push_default
= PUSH_DEFAULT_SIMPLE
;
938 else if (!strcmp(value
, "upstream"))
939 push_default
= PUSH_DEFAULT_UPSTREAM
;
940 else if (!strcmp(value
, "tracking")) /* deprecated */
941 push_default
= PUSH_DEFAULT_UPSTREAM
;
942 else if (!strcmp(value
, "current"))
943 push_default
= PUSH_DEFAULT_CURRENT
;
945 error("Malformed value for %s: %s", var
, value
);
946 return error("Must be one of nothing, matching, simple, "
947 "upstream or current.");
952 /* Add other config variables here and to Documentation/config.txt. */
956 static int git_default_mailmap_config(const char *var
, const char *value
)
958 if (!strcmp(var
, "mailmap.file"))
959 return git_config_string(&git_mailmap_file
, var
, value
);
960 if (!strcmp(var
, "mailmap.blob"))
961 return git_config_string(&git_mailmap_blob
, var
, value
);
963 /* Add other config variables here and to Documentation/config.txt. */
967 int git_default_config(const char *var
, const char *value
, void *dummy
)
969 if (starts_with(var
, "core."))
970 return git_default_core_config(var
, value
);
972 if (starts_with(var
, "user."))
973 return git_ident_config(var
, value
, dummy
);
975 if (starts_with(var
, "i18n."))
976 return git_default_i18n_config(var
, value
);
978 if (starts_with(var
, "branch."))
979 return git_default_branch_config(var
, value
);
981 if (starts_with(var
, "push."))
982 return git_default_push_config(var
, value
);
984 if (starts_with(var
, "mailmap."))
985 return git_default_mailmap_config(var
, value
);
987 if (starts_with(var
, "advice."))
988 return git_default_advice_config(var
, value
);
990 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
991 pager_use_color
= git_config_bool(var
,value
);
995 if (!strcmp(var
, "pack.packsizelimit")) {
996 pack_size_limit_cfg
= git_config_ulong(var
, value
);
999 /* Add other config variables here and to Documentation/config.txt. */
1004 * All source specific fields in the union, die_on_error, name and the callbacks
1005 * fgetc, ungetc, ftell of top need to be initialized before calling
1008 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1012 /* push config-file parsing state stack */
1016 strbuf_init(&top
->value
, 1024);
1017 strbuf_init(&top
->var
, 1024);
1020 ret
= git_parse_source(fn
, data
);
1022 /* pop config-file parsing state stack */
1023 strbuf_release(&top
->value
);
1024 strbuf_release(&top
->var
);
1030 static int do_config_from_file(config_fn_t fn
,
1031 const char *name
, const char *path
, FILE *f
, void *data
)
1033 struct config_source top
;
1038 top
.die_on_error
= 1;
1039 top
.do_fgetc
= config_file_fgetc
;
1040 top
.do_ungetc
= config_file_ungetc
;
1041 top
.do_ftell
= config_file_ftell
;
1043 return do_config_from(&top
, fn
, data
);
1046 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1048 return do_config_from_file(fn
, "<stdin>", NULL
, stdin
, data
);
1051 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1056 f
= fopen(filename
, "r");
1058 ret
= do_config_from_file(fn
, filename
, filename
, f
, data
);
1064 int git_config_from_buf(config_fn_t fn
, const char *name
, const char *buf
,
1065 size_t len
, void *data
)
1067 struct config_source top
;
1069 top
.u
.buf
.buf
= buf
;
1070 top
.u
.buf
.len
= len
;
1074 top
.die_on_error
= 0;
1075 top
.do_fgetc
= config_buf_fgetc
;
1076 top
.do_ungetc
= config_buf_ungetc
;
1077 top
.do_ftell
= config_buf_ftell
;
1079 return do_config_from(&top
, fn
, data
);
1082 static int git_config_from_blob_sha1(config_fn_t fn
,
1084 const unsigned char *sha1
,
1087 enum object_type type
;
1092 buf
= read_sha1_file(sha1
, &type
, &size
);
1094 return error("unable to load config blob object '%s'", name
);
1095 if (type
!= OBJ_BLOB
) {
1097 return error("reference '%s' does not point to a blob", name
);
1100 ret
= git_config_from_buf(fn
, name
, buf
, size
, data
);
1106 static int git_config_from_blob_ref(config_fn_t fn
,
1110 unsigned char sha1
[20];
1112 if (get_sha1(name
, sha1
) < 0)
1113 return error("unable to resolve config blob '%s'", name
);
1114 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1117 const char *git_etc_gitconfig(void)
1119 static const char *system_wide
;
1121 system_wide
= system_path(ETC_GITCONFIG
);
1125 int git_env_bool(const char *k
, int def
)
1127 const char *v
= getenv(k
);
1128 return v
? git_config_bool(k
, v
) : def
;
1131 int git_config_system(void)
1133 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1136 int git_config_early(config_fn_t fn
, void *data
, const char *repo_config
)
1138 int ret
= 0, found
= 0;
1139 char *xdg_config
= NULL
;
1140 char *user_config
= NULL
;
1142 home_config_paths(&user_config
, &xdg_config
, "config");
1144 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0)) {
1145 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1150 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
)) {
1151 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1155 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
)) {
1156 ret
+= git_config_from_file(fn
, user_config
, data
);
1160 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0)) {
1161 ret
+= git_config_from_file(fn
, repo_config
, data
);
1165 switch (git_config_from_parameters(fn
, data
)) {
1166 case -1: /* error */
1167 die("unable to parse command-line config");
1169 case 0: /* found nothing */
1171 default: /* found at least one item */
1178 return ret
== 0 ? found
: ret
;
1181 int git_config_with_options(config_fn_t fn
, void *data
,
1182 struct git_config_source
*config_source
,
1183 int respect_includes
)
1185 char *repo_config
= NULL
;
1187 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1189 if (respect_includes
) {
1192 fn
= git_config_include
;
1197 * If we have a specific filename, use it. Otherwise, follow the
1198 * regular lookup sequence.
1200 if (config_source
&& config_source
->use_stdin
)
1201 return git_config_from_stdin(fn
, data
);
1202 else if (config_source
&& config_source
->file
)
1203 return git_config_from_file(fn
, config_source
->file
, data
);
1204 else if (config_source
&& config_source
->blob
)
1205 return git_config_from_blob_ref(fn
, config_source
->blob
, data
);
1207 repo_config
= git_pathdup("config");
1208 ret
= git_config_early(fn
, data
, repo_config
);
1214 int git_config(config_fn_t fn
, void *data
)
1216 return git_config_with_options(fn
, data
, NULL
, 1);
1220 * Find all the stuff for git_config_set() below.
1227 regex_t
*value_regex
;
1230 unsigned int offset_alloc
;
1231 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1235 static int matches(const char *key
, const char *value
)
1237 return !strcmp(key
, store
.key
) &&
1238 (store
.value_regex
== NULL
||
1239 (store
.do_not_match
^
1240 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
1243 static int store_aux(const char *key
, const char *value
, void *cb
)
1248 switch (store
.state
) {
1250 if (matches(key
, value
)) {
1251 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1252 warning("%s has multiple values", key
);
1255 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1256 store
.offset_alloc
);
1258 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1264 * What we are looking for is in store.key (both
1265 * section and var), and its section part is baselen
1266 * long. We found key (again, both section and var).
1267 * We would want to know if this key is in the same
1268 * section as what we are looking for. We already
1269 * know we are in the same section as what should
1272 ep
= strrchr(key
, '.');
1273 section_len
= ep
- key
;
1275 if ((section_len
!= store
.baselen
) ||
1276 memcmp(key
, store
.key
, section_len
+1)) {
1277 store
.state
= SECTION_END_SEEN
;
1282 * Do not increment matches: this is no match, but we
1283 * just made sure we are in the desired section.
1285 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1286 store
.offset_alloc
);
1287 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1289 case SECTION_END_SEEN
:
1291 if (matches(key
, value
)) {
1292 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1293 store
.offset_alloc
);
1294 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1295 store
.state
= KEY_SEEN
;
1298 if (strrchr(key
, '.') - key
== store
.baselen
&&
1299 !strncmp(key
, store
.key
, store
.baselen
)) {
1300 store
.state
= SECTION_SEEN
;
1301 ALLOC_GROW(store
.offset
,
1303 store
.offset_alloc
);
1304 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1311 static int write_error(const char *filename
)
1313 error("failed to write new configuration file %s", filename
);
1315 /* Same error code as "failed to rename". */
1319 static int store_write_section(int fd
, const char *key
)
1323 struct strbuf sb
= STRBUF_INIT
;
1325 dot
= memchr(key
, '.', store
.baselen
);
1327 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1328 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1329 if (key
[i
] == '"' || key
[i
] == '\\')
1330 strbuf_addch(&sb
, '\\');
1331 strbuf_addch(&sb
, key
[i
]);
1333 strbuf_addstr(&sb
, "\"]\n");
1335 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1338 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1339 strbuf_release(&sb
);
1344 static int store_write_pair(int fd
, const char *key
, const char *value
)
1347 int length
= strlen(key
+ store
.baselen
+ 1);
1348 const char *quote
= "";
1349 struct strbuf sb
= STRBUF_INIT
;
1352 * Check to see if the value needs to be surrounded with a dq pair.
1353 * Note that problematic characters are always backslash-quoted; this
1354 * check is about not losing leading or trailing SP and strings that
1355 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1356 * configuration parser.
1358 if (value
[0] == ' ')
1360 for (i
= 0; value
[i
]; i
++)
1361 if (value
[i
] == ';' || value
[i
] == '#')
1363 if (i
&& value
[i
- 1] == ' ')
1366 strbuf_addf(&sb
, "\t%.*s = %s",
1367 length
, key
+ store
.baselen
+ 1, quote
);
1369 for (i
= 0; value
[i
]; i
++)
1372 strbuf_addstr(&sb
, "\\n");
1375 strbuf_addstr(&sb
, "\\t");
1379 strbuf_addch(&sb
, '\\');
1381 strbuf_addch(&sb
, value
[i
]);
1384 strbuf_addf(&sb
, "%s\n", quote
);
1386 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1387 strbuf_release(&sb
);
1392 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1393 size_t offset_
, int *found_bracket
)
1395 size_t equal_offset
= size
, bracket_offset
= size
;
1399 for (offset
= offset_
-2; offset
> 0
1400 && contents
[offset
] != '\n'; offset
--)
1401 switch (contents
[offset
]) {
1402 case '=': equal_offset
= offset
; break;
1403 case ']': bracket_offset
= offset
; break;
1405 if (offset
> 0 && contents
[offset
-1] == '\\') {
1409 if (bracket_offset
< equal_offset
) {
1411 offset
= bracket_offset
+1;
1418 int git_config_set_in_file(const char *config_filename
,
1419 const char *key
, const char *value
)
1421 return git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1424 int git_config_set(const char *key
, const char *value
)
1426 return git_config_set_multivar(key
, value
, NULL
, 0);
1430 * Auxiliary function to sanity-check and split the key into the section
1431 * identifier and variable name.
1433 * Returns 0 on success, -1 when there is an invalid character in the key and
1434 * -2 if there is no section name in the key.
1436 * store_key - pointer to char* which will hold a copy of the key with
1437 * lowercase section and variable name
1438 * baselen - pointer to int which will hold the length of the
1439 * section + subsection part, can be NULL
1441 int git_config_parse_key(const char *key
, char **store_key
, int *baselen_
)
1443 int i
, dot
, baselen
;
1444 const char *last_dot
= strrchr(key
, '.');
1447 * Since "key" actually contains the section name and the real
1448 * key name separated by a dot, we have to know where the dot is.
1451 if (last_dot
== NULL
|| last_dot
== key
) {
1452 error("key does not contain a section: %s", key
);
1453 return -CONFIG_NO_SECTION_OR_NAME
;
1457 error("key does not contain variable name: %s", key
);
1458 return -CONFIG_NO_SECTION_OR_NAME
;
1461 baselen
= last_dot
- key
;
1463 *baselen_
= baselen
;
1466 * Validate the key and while at it, lower case it for matching.
1468 *store_key
= xmalloc(strlen(key
) + 1);
1471 for (i
= 0; key
[i
]; i
++) {
1472 unsigned char c
= key
[i
];
1475 /* Leave the extended basename untouched.. */
1476 if (!dot
|| i
> baselen
) {
1477 if (!iskeychar(c
) ||
1478 (i
== baselen
+ 1 && !isalpha(c
))) {
1479 error("invalid key: %s", key
);
1480 goto out_free_ret_1
;
1483 } else if (c
== '\n') {
1484 error("invalid key (newline): %s", key
);
1485 goto out_free_ret_1
;
1487 (*store_key
)[i
] = c
;
1489 (*store_key
)[i
] = 0;
1496 return -CONFIG_INVALID_KEY
;
1500 * If value==NULL, unset in (remove from) config,
1501 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1502 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1503 * else all matching key/values (regardless how many) are removed,
1504 * before the new pair is written.
1506 * Returns 0 on success.
1508 * This function does this:
1510 * - it locks the config file by creating ".git/config.lock"
1512 * - it then parses the config using store_aux() as validator to find
1513 * the position on the key/value pair to replace. If it is to be unset,
1514 * it must be found exactly once.
1516 * - the config file is mmap()ed and the part before the match (if any) is
1517 * written to the lock file, then the changed part and the rest.
1519 * - the config file is removed and the lock file rename()d to it.
1522 int git_config_set_multivar_in_file(const char *config_filename
,
1523 const char *key
, const char *value
,
1524 const char *value_regex
, int multi_replace
)
1528 struct lock_file
*lock
= NULL
;
1529 char *filename_buf
= NULL
;
1531 /* parse-key returns negative; flip the sign to feed exit(3) */
1532 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
1536 store
.multi_replace
= multi_replace
;
1538 if (!config_filename
)
1539 config_filename
= filename_buf
= git_pathdup("config");
1542 * The lock serves a purpose in addition to locking: the new
1543 * contents of .git/config will be written into it.
1545 lock
= xcalloc(sizeof(struct lock_file
), 1);
1546 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1548 error("could not lock config file %s: %s", config_filename
, strerror(errno
));
1550 ret
= CONFIG_NO_LOCK
;
1555 * If .git/config does not exist yet, write a minimal version.
1557 in_fd
= open(config_filename
, O_RDONLY
);
1561 if ( ENOENT
!= errno
) {
1562 error("opening %s: %s", config_filename
,
1564 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
1567 /* if nothing to unset, error out */
1568 if (value
== NULL
) {
1569 ret
= CONFIG_NOTHING_SET
;
1573 store
.key
= (char *)key
;
1574 if (!store_write_section(fd
, key
) ||
1575 !store_write_pair(fd
, key
, value
))
1580 size_t contents_sz
, copy_begin
, copy_end
;
1581 int i
, new_line
= 0;
1583 if (value_regex
== NULL
)
1584 store
.value_regex
= NULL
;
1586 if (value_regex
[0] == '!') {
1587 store
.do_not_match
= 1;
1590 store
.do_not_match
= 0;
1592 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
1593 if (regcomp(store
.value_regex
, value_regex
,
1595 error("invalid pattern: %s", value_regex
);
1596 free(store
.value_regex
);
1597 ret
= CONFIG_INVALID_PATTERN
;
1602 ALLOC_GROW(store
.offset
, 1, store
.offset_alloc
);
1603 store
.offset
[0] = 0;
1604 store
.state
= START
;
1608 * After this, store.offset will contain the *end* offset
1609 * of the last match, or remain at 0 if no match was found.
1610 * As a side effect, we make sure to transform only a valid
1611 * existing config file.
1613 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
1614 error("invalid config file %s", config_filename
);
1616 if (store
.value_regex
!= NULL
) {
1617 regfree(store
.value_regex
);
1618 free(store
.value_regex
);
1620 ret
= CONFIG_INVALID_FILE
;
1625 if (store
.value_regex
!= NULL
) {
1626 regfree(store
.value_regex
);
1627 free(store
.value_regex
);
1630 /* if nothing to unset, or too many matches, error out */
1631 if ((store
.seen
== 0 && value
== NULL
) ||
1632 (store
.seen
> 1 && multi_replace
== 0)) {
1633 ret
= CONFIG_NOTHING_SET
;
1638 contents_sz
= xsize_t(st
.st_size
);
1639 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
1640 MAP_PRIVATE
, in_fd
, 0);
1643 if (store
.seen
== 0)
1646 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
1647 if (store
.offset
[i
] == 0) {
1648 store
.offset
[i
] = copy_end
= contents_sz
;
1649 } else if (store
.state
!= KEY_SEEN
) {
1650 copy_end
= store
.offset
[i
];
1652 copy_end
= find_beginning_of_line(
1653 contents
, contents_sz
,
1654 store
.offset
[i
]-2, &new_line
);
1656 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
1659 /* write the first part of the config */
1660 if (copy_end
> copy_begin
) {
1661 if (write_in_full(fd
, contents
+ copy_begin
,
1662 copy_end
- copy_begin
) <
1663 copy_end
- copy_begin
)
1666 write_str_in_full(fd
, "\n") != 1)
1669 copy_begin
= store
.offset
[i
];
1672 /* write the pair (value == NULL means unset) */
1673 if (value
!= NULL
) {
1674 if (store
.state
== START
) {
1675 if (!store_write_section(fd
, key
))
1678 if (!store_write_pair(fd
, key
, value
))
1682 /* write the rest of the config */
1683 if (copy_begin
< contents_sz
)
1684 if (write_in_full(fd
, contents
+ copy_begin
,
1685 contents_sz
- copy_begin
) <
1686 contents_sz
- copy_begin
)
1689 munmap(contents
, contents_sz
);
1692 if (commit_lock_file(lock
) < 0) {
1693 error("could not commit config file %s", config_filename
);
1694 ret
= CONFIG_NO_WRITE
;
1699 * lock is committed, so don't try to roll it back below.
1700 * NOTE: Since lockfile.c keeps a linked list of all created
1701 * lock_file structures, it isn't safe to free(lock). It's
1702 * better to just leave it hanging around.
1709 rollback_lock_file(lock
);
1714 ret
= write_error(lock
->filename
);
1719 int git_config_set_multivar(const char *key
, const char *value
,
1720 const char *value_regex
, int multi_replace
)
1722 return git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
1726 static int section_name_match (const char *buf
, const char *name
)
1728 int i
= 0, j
= 0, dot
= 0;
1731 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
1732 if (!dot
&& isspace(buf
[i
])) {
1734 if (name
[j
++] != '.')
1736 for (i
++; isspace(buf
[i
]); i
++)
1742 if (buf
[i
] == '\\' && dot
)
1744 else if (buf
[i
] == '"' && dot
) {
1745 for (i
++; isspace(buf
[i
]); i
++)
1749 if (buf
[i
] != name
[j
++])
1752 if (buf
[i
] == ']' && name
[j
] == 0) {
1754 * We match, now just find the right length offset by
1755 * gobbling up any whitespace after it, as well
1758 for (; buf
[i
] && isspace(buf
[i
]); i
++)
1765 static int section_name_is_ok(const char *name
)
1767 /* Empty section names are bogus. */
1772 * Before a dot, we must be alphanumeric or dash. After the first dot,
1773 * anything goes, so we can stop checking.
1775 for (; *name
&& *name
!= '.'; name
++)
1776 if (*name
!= '-' && !isalnum(*name
))
1781 /* if new_name == NULL, the section is removed instead */
1782 int git_config_rename_section_in_file(const char *config_filename
,
1783 const char *old_name
, const char *new_name
)
1785 int ret
= 0, remove
= 0;
1786 char *filename_buf
= NULL
;
1787 struct lock_file
*lock
;
1792 if (new_name
&& !section_name_is_ok(new_name
)) {
1793 ret
= error("invalid section name: %s", new_name
);
1797 if (!config_filename
)
1798 config_filename
= filename_buf
= git_pathdup("config");
1800 lock
= xcalloc(sizeof(struct lock_file
), 1);
1801 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1803 ret
= error("could not lock config file %s", config_filename
);
1807 if (!(config_file
= fopen(config_filename
, "rb"))) {
1808 /* no config file means nothing to rename, no error */
1809 goto unlock_and_out
;
1812 while (fgets(buf
, sizeof(buf
), config_file
)) {
1816 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1818 if (buf
[i
] == '[') {
1819 /* it's a section */
1820 int offset
= section_name_match(&buf
[i
], old_name
);
1823 if (new_name
== NULL
) {
1827 store
.baselen
= strlen(new_name
);
1828 if (!store_write_section(out_fd
, new_name
)) {
1829 ret
= write_error(lock
->filename
);
1833 * We wrote out the new section, with
1834 * a newline, now skip the old
1837 output
+= offset
+ i
;
1838 if (strlen(output
) > 0) {
1840 * More content means there's
1841 * a declaration to put on the
1842 * next line; indent with a
1853 length
= strlen(output
);
1854 if (write_in_full(out_fd
, output
, length
) != length
) {
1855 ret
= write_error(lock
->filename
);
1859 fclose(config_file
);
1861 if (commit_lock_file(lock
) < 0)
1862 ret
= error("could not commit config file %s", config_filename
);
1868 int git_config_rename_section(const char *old_name
, const char *new_name
)
1870 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
1874 * Call this to report error for your variable that should not
1875 * get a boolean value (i.e. "[my] var" means "true").
1877 #undef config_error_nonbool
1878 int config_error_nonbool(const char *var
)
1880 return error("Missing value for '%s'", var
);
1883 int parse_config_key(const char *var
,
1884 const char *section
,
1885 const char **subsection
, int *subsection_len
,
1888 int section_len
= strlen(section
);
1891 /* Does it start with "section." ? */
1892 if (!starts_with(var
, section
) || var
[section_len
] != '.')
1896 * Find the key; we don't know yet if we have a subsection, but we must
1897 * parse backwards from the end, since the subsection may have dots in
1900 dot
= strrchr(var
, '.');
1903 /* Did we have a subsection at all? */
1904 if (dot
== var
+ section_len
) {
1906 *subsection_len
= 0;
1909 *subsection
= var
+ section_len
+ 1;
1910 *subsection_len
= dot
- *subsection
;