2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
14 #include "string-list.h"
17 struct config_source
{
18 struct config_source
*prev
;
27 enum config_origin_type origin_type
;
36 int (*do_fgetc
)(struct config_source
*c
);
37 int (*do_ungetc
)(int c
, struct config_source
*conf
);
38 long (*do_ftell
)(struct config_source
*c
);
42 * These variables record the "current" config source, which
43 * can be accessed by parsing callbacks.
45 * The "cf" variable will be non-NULL only when we are actually parsing a real
46 * config source (file, blob, cmdline, etc).
48 * The "current_config_kvi" variable will be non-NULL only when we are feeding
49 * cached config from a configset into a callback.
51 * They should generally never be non-NULL at the same time. If they are both
52 * NULL, then we aren't parsing anything (and depending on the function looking
53 * at the variables, it's either a bug for it to be called in the first place,
54 * or it's a function which can be reused for non-config purposes, and should
55 * fall back to some sane behavior).
57 static struct config_source
*cf
;
58 static struct key_value_info
*current_config_kvi
;
61 * Similar to the variables above, this gives access to the "scope" of the
62 * current value (repo, global, etc). For cached values, it can be found via
63 * the current_config_kvi as above. During parsing, the current value can be
64 * found in this variable. It's not part of "cf" because it transcends a single
65 * file (i.e., a file included from .git/config is still in "repo" scope).
67 static enum config_scope current_parsing_scope
;
69 static int core_compression_seen
;
70 static int pack_compression_seen
;
71 static int zlib_compression_seen
;
74 * Default config_set that contains key-value pairs from the usual set of config
75 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
76 * config file and the global /etc/gitconfig)
78 static struct config_set the_config_set
;
80 static int config_file_fgetc(struct config_source
*conf
)
82 return getc_unlocked(conf
->u
.file
);
85 static int config_file_ungetc(int c
, struct config_source
*conf
)
87 return ungetc(c
, conf
->u
.file
);
90 static long config_file_ftell(struct config_source
*conf
)
92 return ftell(conf
->u
.file
);
96 static int config_buf_fgetc(struct config_source
*conf
)
98 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
99 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
104 static int config_buf_ungetc(int c
, struct config_source
*conf
)
106 if (conf
->u
.buf
.pos
> 0) {
108 if (conf
->u
.buf
.buf
[conf
->u
.buf
.pos
] != c
)
109 die("BUG: config_buf can only ungetc the same character");
116 static long config_buf_ftell(struct config_source
*conf
)
118 return conf
->u
.buf
.pos
;
121 #define MAX_INCLUDE_DEPTH 10
122 static const char include_depth_advice
[] =
123 "exceeded maximum include depth (%d) while including\n"
127 "Do you have circular includes?";
128 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
131 struct strbuf buf
= STRBUF_INIT
;
135 return config_error_nonbool("include.path");
137 expanded
= expand_user_path(path
);
139 return error("could not expand include path '%s'", path
);
143 * Use an absolute path as-is, but interpret relative paths
144 * based on the including config file.
146 if (!is_absolute_path(path
)) {
149 if (!cf
|| !cf
->path
)
150 return error("relative config includes must come from files");
152 slash
= find_last_dir_sep(cf
->path
);
154 strbuf_add(&buf
, cf
->path
, slash
- cf
->path
+ 1);
155 strbuf_addstr(&buf
, path
);
159 if (!access_or_die(path
, R_OK
, 0)) {
160 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
161 die(include_depth_advice
, MAX_INCLUDE_DEPTH
, path
,
163 cf
->name
? cf
->name
:
165 ret
= git_config_from_file(git_config_include
, path
, inc
);
168 strbuf_release(&buf
);
173 int git_config_include(const char *var
, const char *value
, void *data
)
175 struct config_include_data
*inc
= data
;
179 * Pass along all values, including "include" directives; this makes it
180 * possible to query information on the includes themselves.
182 ret
= inc
->fn(var
, value
, inc
->data
);
186 if (!strcmp(var
, "include.path"))
187 ret
= handle_path_include(value
, inc
);
191 void git_config_push_parameter(const char *text
)
193 struct strbuf env
= STRBUF_INIT
;
194 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
196 strbuf_addstr(&env
, old
);
197 strbuf_addch(&env
, ' ');
199 sq_quote_buf(&env
, text
);
200 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
201 strbuf_release(&env
);
204 static inline int iskeychar(int c
)
206 return isalnum(c
) || c
== '-';
210 * Auxiliary function to sanity-check and split the key into the section
211 * identifier and variable name.
213 * Returns 0 on success, -1 when there is an invalid character in the key and
214 * -2 if there is no section name in the key.
216 * store_key - pointer to char* which will hold a copy of the key with
217 * lowercase section and variable name
218 * baselen - pointer to int which will hold the length of the
219 * section + subsection part, can be NULL
221 static int git_config_parse_key_1(const char *key
, char **store_key
, int *baselen_
, int quiet
)
224 const char *last_dot
= strrchr(key
, '.');
227 * Since "key" actually contains the section name and the real
228 * key name separated by a dot, we have to know where the dot is.
231 if (last_dot
== NULL
|| last_dot
== key
) {
233 error("key does not contain a section: %s", key
);
234 return -CONFIG_NO_SECTION_OR_NAME
;
239 error("key does not contain variable name: %s", key
);
240 return -CONFIG_NO_SECTION_OR_NAME
;
243 baselen
= last_dot
- key
;
248 * Validate the key and while at it, lower case it for matching.
251 *store_key
= xmallocz(strlen(key
));
254 for (i
= 0; key
[i
]; i
++) {
255 unsigned char c
= key
[i
];
258 /* Leave the extended basename untouched.. */
259 if (!dot
|| i
> baselen
) {
261 (i
== baselen
+ 1 && !isalpha(c
))) {
263 error("invalid key: %s", key
);
267 } else if (c
== '\n') {
269 error("invalid key (newline): %s", key
);
283 return -CONFIG_INVALID_KEY
;
286 int git_config_parse_key(const char *key
, char **store_key
, int *baselen
)
288 return git_config_parse_key_1(key
, store_key
, baselen
, 0);
291 int git_config_key_is_valid(const char *key
)
293 return !git_config_parse_key_1(key
, NULL
, NULL
, 1);
296 int git_config_parse_parameter(const char *text
,
297 config_fn_t fn
, void *data
)
300 char *canonical_name
;
301 struct strbuf
**pair
;
304 pair
= strbuf_split_str(text
, '=', 2);
306 return error("bogus config parameter: %s", text
);
308 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
309 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
310 value
= pair
[1] ? pair
[1]->buf
: "";
315 strbuf_trim(pair
[0]);
317 strbuf_list_free(pair
);
318 return error("bogus config parameter: %s", text
);
321 if (git_config_parse_key(pair
[0]->buf
, &canonical_name
, NULL
)) {
324 ret
= (fn(canonical_name
, value
, data
) < 0) ? -1 : 0;
325 free(canonical_name
);
327 strbuf_list_free(pair
);
331 int git_config_from_parameters(config_fn_t fn
, void *data
)
333 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
336 const char **argv
= NULL
;
337 int nr
= 0, alloc
= 0;
339 struct config_source source
;
344 memset(&source
, 0, sizeof(source
));
346 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
349 /* sq_dequote will write over it */
352 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
353 ret
= error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
357 for (i
= 0; i
< nr
; i
++) {
358 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
371 static int get_next_char(void)
373 int c
= cf
->do_fgetc(cf
);
376 /* DOS like systems */
377 c
= cf
->do_fgetc(cf
);
380 cf
->do_ungetc(c
, cf
);
394 static char *parse_value(void)
396 int quote
= 0, comment
= 0, space
= 0;
398 strbuf_reset(&cf
->value
);
400 int c
= get_next_char();
406 return cf
->value
.buf
;
410 if (isspace(c
) && !quote
) {
416 if (c
== ';' || c
== '#') {
421 for (; space
; space
--)
422 strbuf_addch(&cf
->value
, ' ');
437 /* Some characters escape as themselves */
440 /* Reject unknown escape sequences */
444 strbuf_addch(&cf
->value
, c
);
451 strbuf_addch(&cf
->value
, c
);
455 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
461 /* Get the full name */
468 strbuf_addch(name
, tolower(c
));
471 while (c
== ' ' || c
== '\t')
478 value
= parse_value();
483 * We already consumed the \n, but we need linenr to point to
484 * the line we just parsed during the call to fn to get
485 * accurate line number in error messages.
488 ret
= fn(name
->buf
, value
, data
);
493 static int get_extended_base_var(struct strbuf
*name
, int c
)
497 goto error_incomplete_line
;
499 } while (isspace(c
));
501 /* We require the format to be '[base "extension"]' */
504 strbuf_addch(name
, '.');
507 int c
= get_next_char();
509 goto error_incomplete_line
;
515 goto error_incomplete_line
;
517 strbuf_addch(name
, c
);
521 if (get_next_char() != ']')
524 error_incomplete_line
:
529 static int get_base_var(struct strbuf
*name
)
532 int c
= get_next_char();
538 return get_extended_base_var(name
, c
);
539 if (!iskeychar(c
) && c
!= '.')
541 strbuf_addch(name
, tolower(c
));
545 static int git_parse_source(config_fn_t fn
, void *data
)
549 struct strbuf
*var
= &cf
->var
;
550 int error_return
= 0;
551 char *error_msg
= NULL
;
553 /* U+FEFF Byte Order Mark in UTF8 */
554 const char *bomptr
= utf8_bom
;
557 int c
= get_next_char();
558 if (bomptr
&& *bomptr
) {
559 /* We are at the file beginning; skip UTF8-encoded BOM
560 * if present. Sane editors won't put this in on their
561 * own, but e.g. Windows Notepad will do it happily. */
562 if (c
== (*bomptr
& 0377)) {
566 /* Do not tolerate partial BOM. */
567 if (bomptr
!= utf8_bom
)
569 /* No BOM at file beginning. Cool. */
579 if (comment
|| isspace(c
))
581 if (c
== '#' || c
== ';') {
586 /* Reset prior to determining a new stem */
588 if (get_base_var(var
) < 0 || var
->len
< 1)
590 strbuf_addch(var
, '.');
597 * Truncate the var name back to the section header
598 * stem prior to grabbing the suffix part of the name
601 strbuf_setlen(var
, baselen
);
602 strbuf_addch(var
, tolower(c
));
603 if (get_value(fn
, data
, var
) < 0)
607 switch (cf
->origin_type
) {
608 case CONFIG_ORIGIN_BLOB
:
609 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
610 cf
->linenr
, cf
->name
);
612 case CONFIG_ORIGIN_FILE
:
613 error_msg
= xstrfmt(_("bad config line %d in file %s"),
614 cf
->linenr
, cf
->name
);
616 case CONFIG_ORIGIN_STDIN
:
617 error_msg
= xstrfmt(_("bad config line %d in standard input"),
620 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
621 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
622 cf
->linenr
, cf
->name
);
624 case CONFIG_ORIGIN_CMDLINE
:
625 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
626 cf
->linenr
, cf
->name
);
629 error_msg
= xstrfmt(_("bad config line %d in %s"),
630 cf
->linenr
, cf
->name
);
633 if (cf
->die_on_error
)
634 die("%s", error_msg
);
636 error_return
= error("%s", error_msg
);
642 static int parse_unit_factor(const char *end
, uintmax_t *val
)
646 else if (!strcasecmp(end
, "k")) {
650 else if (!strcasecmp(end
, "m")) {
654 else if (!strcasecmp(end
, "g")) {
655 *val
*= 1024 * 1024 * 1024;
661 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
663 if (value
&& *value
) {
667 uintmax_t factor
= 1;
670 val
= strtoimax(value
, &end
, 0);
673 if (!parse_unit_factor(end
, &factor
)) {
679 if (uval
> max
|| labs(val
) > uval
) {
691 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
693 if (value
&& *value
) {
699 val
= strtoumax(value
, &end
, 0);
703 if (!parse_unit_factor(end
, &val
)) {
707 if (val
> max
|| oldval
> val
) {
718 static int git_parse_int(const char *value
, int *ret
)
721 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
727 static int git_parse_int64(const char *value
, int64_t *ret
)
730 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
736 int git_parse_ulong(const char *value
, unsigned long *ret
)
739 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
746 static void die_bad_number(const char *name
, const char *value
)
748 const char * error_type
= (errno
== ERANGE
)? _("out of range"):_("invalid unit");
753 if (!(cf
&& cf
->name
))
754 die(_("bad numeric config value '%s' for '%s': %s"),
755 value
, name
, error_type
);
757 switch (cf
->origin_type
) {
758 case CONFIG_ORIGIN_BLOB
:
759 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
760 value
, name
, cf
->name
, error_type
);
761 case CONFIG_ORIGIN_FILE
:
762 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
763 value
, name
, cf
->name
, error_type
);
764 case CONFIG_ORIGIN_STDIN
:
765 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
766 value
, name
, error_type
);
767 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
768 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
769 value
, name
, cf
->name
, error_type
);
770 case CONFIG_ORIGIN_CMDLINE
:
771 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
772 value
, name
, cf
->name
, error_type
);
774 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
775 value
, name
, cf
->name
, error_type
);
779 int git_config_int(const char *name
, const char *value
)
782 if (!git_parse_int(value
, &ret
))
783 die_bad_number(name
, value
);
787 int64_t git_config_int64(const char *name
, const char *value
)
790 if (!git_parse_int64(value
, &ret
))
791 die_bad_number(name
, value
);
795 unsigned long git_config_ulong(const char *name
, const char *value
)
798 if (!git_parse_ulong(value
, &ret
))
799 die_bad_number(name
, value
);
803 int git_parse_maybe_bool(const char *value
)
809 if (!strcasecmp(value
, "true")
810 || !strcasecmp(value
, "yes")
811 || !strcasecmp(value
, "on"))
813 if (!strcasecmp(value
, "false")
814 || !strcasecmp(value
, "no")
815 || !strcasecmp(value
, "off"))
820 int git_config_maybe_bool(const char *name
, const char *value
)
822 int v
= git_parse_maybe_bool(value
);
825 if (git_parse_int(value
, &v
))
830 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
832 int v
= git_parse_maybe_bool(value
);
838 return git_config_int(name
, value
);
841 int git_config_bool(const char *name
, const char *value
)
844 return !!git_config_bool_or_int(name
, value
, &discard
);
847 int git_config_string(const char **dest
, const char *var
, const char *value
)
850 return config_error_nonbool(var
);
851 *dest
= xstrdup(value
);
855 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
858 return config_error_nonbool(var
);
859 *dest
= expand_user_path(value
);
861 die(_("failed to expand user dir in: '%s'"), value
);
865 static int git_default_core_config(const char *var
, const char *value
)
867 /* This needs a better name */
868 if (!strcmp(var
, "core.filemode")) {
869 trust_executable_bit
= git_config_bool(var
, value
);
872 if (!strcmp(var
, "core.trustctime")) {
873 trust_ctime
= git_config_bool(var
, value
);
876 if (!strcmp(var
, "core.checkstat")) {
877 if (!strcasecmp(value
, "default"))
879 else if (!strcasecmp(value
, "minimal"))
883 if (!strcmp(var
, "core.quotepath")) {
884 quote_path_fully
= git_config_bool(var
, value
);
888 if (!strcmp(var
, "core.symlinks")) {
889 has_symlinks
= git_config_bool(var
, value
);
893 if (!strcmp(var
, "core.ignorecase")) {
894 ignore_case
= git_config_bool(var
, value
);
898 if (!strcmp(var
, "core.attributesfile"))
899 return git_config_pathname(&git_attributes_file
, var
, value
);
901 if (!strcmp(var
, "core.hookspath"))
902 return git_config_pathname(&git_hooks_path
, var
, value
);
904 if (!strcmp(var
, "core.bare")) {
905 is_bare_repository_cfg
= git_config_bool(var
, value
);
909 if (!strcmp(var
, "core.ignorestat")) {
910 assume_unchanged
= git_config_bool(var
, value
);
914 if (!strcmp(var
, "core.prefersymlinkrefs")) {
915 prefer_symlink_refs
= git_config_bool(var
, value
);
919 if (!strcmp(var
, "core.logallrefupdates")) {
920 if (value
&& !strcasecmp(value
, "always"))
921 log_all_ref_updates
= LOG_REFS_ALWAYS
;
922 else if (git_config_bool(var
, value
))
923 log_all_ref_updates
= LOG_REFS_NORMAL
;
925 log_all_ref_updates
= LOG_REFS_NONE
;
929 if (!strcmp(var
, "core.warnambiguousrefs")) {
930 warn_ambiguous_refs
= git_config_bool(var
, value
);
934 if (!strcmp(var
, "core.abbrev")) {
936 return config_error_nonbool(var
);
937 if (!strcasecmp(value
, "auto"))
940 int abbrev
= git_config_int(var
, value
);
941 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
942 return error("abbrev length out of range: %d", abbrev
);
943 default_abbrev
= abbrev
;
948 if (!strcmp(var
, "core.disambiguate"))
949 return set_disambiguate_hint_config(var
, value
);
951 if (!strcmp(var
, "core.loosecompression")) {
952 int level
= git_config_int(var
, value
);
954 level
= Z_DEFAULT_COMPRESSION
;
955 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
956 die(_("bad zlib compression level %d"), level
);
957 zlib_compression_level
= level
;
958 zlib_compression_seen
= 1;
962 if (!strcmp(var
, "core.compression")) {
963 int level
= git_config_int(var
, value
);
965 level
= Z_DEFAULT_COMPRESSION
;
966 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
967 die(_("bad zlib compression level %d"), level
);
968 core_compression_level
= level
;
969 core_compression_seen
= 1;
970 if (!zlib_compression_seen
)
971 zlib_compression_level
= level
;
972 if (!pack_compression_seen
)
973 pack_compression_level
= level
;
977 if (!strcmp(var
, "core.packedgitwindowsize")) {
978 int pgsz_x2
= getpagesize() * 2;
979 packed_git_window_size
= git_config_ulong(var
, value
);
981 /* This value must be multiple of (pagesize * 2) */
982 packed_git_window_size
/= pgsz_x2
;
983 if (packed_git_window_size
< 1)
984 packed_git_window_size
= 1;
985 packed_git_window_size
*= pgsz_x2
;
989 if (!strcmp(var
, "core.bigfilethreshold")) {
990 big_file_threshold
= git_config_ulong(var
, value
);
994 if (!strcmp(var
, "core.packedgitlimit")) {
995 packed_git_limit
= git_config_ulong(var
, value
);
999 if (!strcmp(var
, "core.deltabasecachelimit")) {
1000 delta_base_cache_limit
= git_config_ulong(var
, value
);
1004 if (!strcmp(var
, "core.autocrlf")) {
1005 if (value
&& !strcasecmp(value
, "input")) {
1006 auto_crlf
= AUTO_CRLF_INPUT
;
1009 auto_crlf
= git_config_bool(var
, value
);
1013 if (!strcmp(var
, "core.safecrlf")) {
1014 if (value
&& !strcasecmp(value
, "warn")) {
1015 safe_crlf
= SAFE_CRLF_WARN
;
1018 safe_crlf
= git_config_bool(var
, value
);
1022 if (!strcmp(var
, "core.eol")) {
1023 if (value
&& !strcasecmp(value
, "lf"))
1025 else if (value
&& !strcasecmp(value
, "crlf"))
1026 core_eol
= EOL_CRLF
;
1027 else if (value
&& !strcasecmp(value
, "native"))
1028 core_eol
= EOL_NATIVE
;
1030 core_eol
= EOL_UNSET
;
1034 if (!strcmp(var
, "core.notesref")) {
1035 notes_ref_name
= xstrdup(value
);
1039 if (!strcmp(var
, "core.editor"))
1040 return git_config_string(&editor_program
, var
, value
);
1042 if (!strcmp(var
, "core.commentchar")) {
1044 return config_error_nonbool(var
);
1045 else if (!strcasecmp(value
, "auto"))
1046 auto_comment_line_char
= 1;
1047 else if (value
[0] && !value
[1]) {
1048 comment_line_char
= value
[0];
1049 auto_comment_line_char
= 0;
1051 return error("core.commentChar should only be one character");
1055 if (!strcmp(var
, "core.askpass"))
1056 return git_config_string(&askpass_program
, var
, value
);
1058 if (!strcmp(var
, "core.excludesfile"))
1059 return git_config_pathname(&excludes_file
, var
, value
);
1061 if (!strcmp(var
, "core.whitespace")) {
1063 return config_error_nonbool(var
);
1064 whitespace_rule_cfg
= parse_whitespace_rule(value
);
1068 if (!strcmp(var
, "core.fsyncobjectfiles")) {
1069 fsync_object_files
= git_config_bool(var
, value
);
1073 if (!strcmp(var
, "core.preloadindex")) {
1074 core_preload_index
= git_config_bool(var
, value
);
1078 if (!strcmp(var
, "core.createobject")) {
1079 if (!strcmp(value
, "rename"))
1080 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
1081 else if (!strcmp(value
, "link"))
1082 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
1084 die(_("invalid mode for object creation: %s"), value
);
1088 if (!strcmp(var
, "core.sparsecheckout")) {
1089 core_apply_sparse_checkout
= git_config_bool(var
, value
);
1093 if (!strcmp(var
, "core.precomposeunicode")) {
1094 precomposed_unicode
= git_config_bool(var
, value
);
1098 if (!strcmp(var
, "core.protecthfs")) {
1099 protect_hfs
= git_config_bool(var
, value
);
1103 if (!strcmp(var
, "core.protectntfs")) {
1104 protect_ntfs
= git_config_bool(var
, value
);
1108 if (!strcmp(var
, "core.hidedotfiles")) {
1109 if (value
&& !strcasecmp(value
, "dotgitonly"))
1110 hide_dotfiles
= HIDE_DOTFILES_DOTGITONLY
;
1112 hide_dotfiles
= git_config_bool(var
, value
);
1116 /* Add other config variables here and to Documentation/config.txt. */
1120 static int git_default_i18n_config(const char *var
, const char *value
)
1122 if (!strcmp(var
, "i18n.commitencoding"))
1123 return git_config_string(&git_commit_encoding
, var
, value
);
1125 if (!strcmp(var
, "i18n.logoutputencoding"))
1126 return git_config_string(&git_log_output_encoding
, var
, value
);
1128 /* Add other config variables here and to Documentation/config.txt. */
1132 static int git_default_branch_config(const char *var
, const char *value
)
1134 if (!strcmp(var
, "branch.autosetupmerge")) {
1135 if (value
&& !strcasecmp(value
, "always")) {
1136 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1139 git_branch_track
= git_config_bool(var
, value
);
1142 if (!strcmp(var
, "branch.autosetuprebase")) {
1144 return config_error_nonbool(var
);
1145 else if (!strcmp(value
, "never"))
1146 autorebase
= AUTOREBASE_NEVER
;
1147 else if (!strcmp(value
, "local"))
1148 autorebase
= AUTOREBASE_LOCAL
;
1149 else if (!strcmp(value
, "remote"))
1150 autorebase
= AUTOREBASE_REMOTE
;
1151 else if (!strcmp(value
, "always"))
1152 autorebase
= AUTOREBASE_ALWAYS
;
1154 return error("malformed value for %s", var
);
1158 /* Add other config variables here and to Documentation/config.txt. */
1162 static int git_default_push_config(const char *var
, const char *value
)
1164 if (!strcmp(var
, "push.default")) {
1166 return config_error_nonbool(var
);
1167 else if (!strcmp(value
, "nothing"))
1168 push_default
= PUSH_DEFAULT_NOTHING
;
1169 else if (!strcmp(value
, "matching"))
1170 push_default
= PUSH_DEFAULT_MATCHING
;
1171 else if (!strcmp(value
, "simple"))
1172 push_default
= PUSH_DEFAULT_SIMPLE
;
1173 else if (!strcmp(value
, "upstream"))
1174 push_default
= PUSH_DEFAULT_UPSTREAM
;
1175 else if (!strcmp(value
, "tracking")) /* deprecated */
1176 push_default
= PUSH_DEFAULT_UPSTREAM
;
1177 else if (!strcmp(value
, "current"))
1178 push_default
= PUSH_DEFAULT_CURRENT
;
1180 error("malformed value for %s: %s", var
, value
);
1181 return error("Must be one of nothing, matching, simple, "
1182 "upstream or current.");
1187 /* Add other config variables here and to Documentation/config.txt. */
1191 static int git_default_mailmap_config(const char *var
, const char *value
)
1193 if (!strcmp(var
, "mailmap.file"))
1194 return git_config_pathname(&git_mailmap_file
, var
, value
);
1195 if (!strcmp(var
, "mailmap.blob"))
1196 return git_config_string(&git_mailmap_blob
, var
, value
);
1198 /* Add other config variables here and to Documentation/config.txt. */
1202 int git_default_config(const char *var
, const char *value
, void *dummy
)
1204 if (starts_with(var
, "core."))
1205 return git_default_core_config(var
, value
);
1207 if (starts_with(var
, "user."))
1208 return git_ident_config(var
, value
, dummy
);
1210 if (starts_with(var
, "i18n."))
1211 return git_default_i18n_config(var
, value
);
1213 if (starts_with(var
, "branch."))
1214 return git_default_branch_config(var
, value
);
1216 if (starts_with(var
, "push."))
1217 return git_default_push_config(var
, value
);
1219 if (starts_with(var
, "mailmap."))
1220 return git_default_mailmap_config(var
, value
);
1222 if (starts_with(var
, "advice."))
1223 return git_default_advice_config(var
, value
);
1225 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1226 pager_use_color
= git_config_bool(var
,value
);
1230 if (!strcmp(var
, "pack.packsizelimit")) {
1231 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1235 if (!strcmp(var
, "pack.compression")) {
1236 int level
= git_config_int(var
, value
);
1238 level
= Z_DEFAULT_COMPRESSION
;
1239 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1240 die(_("bad pack compression level %d"), level
);
1241 pack_compression_level
= level
;
1242 pack_compression_seen
= 1;
1246 /* Add other config variables here and to Documentation/config.txt. */
1251 * All source specific fields in the union, die_on_error, name and the callbacks
1252 * fgetc, ungetc, ftell of top need to be initialized before calling
1255 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1259 /* push config-file parsing state stack */
1263 strbuf_init(&top
->value
, 1024);
1264 strbuf_init(&top
->var
, 1024);
1267 ret
= git_parse_source(fn
, data
);
1269 /* pop config-file parsing state stack */
1270 strbuf_release(&top
->value
);
1271 strbuf_release(&top
->var
);
1277 static int do_config_from_file(config_fn_t fn
,
1278 const enum config_origin_type origin_type
,
1279 const char *name
, const char *path
, FILE *f
,
1282 struct config_source top
;
1285 top
.origin_type
= origin_type
;
1288 top
.die_on_error
= 1;
1289 top
.do_fgetc
= config_file_fgetc
;
1290 top
.do_ungetc
= config_file_ungetc
;
1291 top
.do_ftell
= config_file_ftell
;
1293 return do_config_from(&top
, fn
, data
);
1296 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1298 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
, data
);
1301 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1306 f
= fopen(filename
, "r");
1309 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
, filename
, f
, data
);
1316 int git_config_from_mem(config_fn_t fn
, const enum config_origin_type origin_type
,
1317 const char *name
, const char *buf
, size_t len
, void *data
)
1319 struct config_source top
;
1321 top
.u
.buf
.buf
= buf
;
1322 top
.u
.buf
.len
= len
;
1324 top
.origin_type
= origin_type
;
1327 top
.die_on_error
= 0;
1328 top
.do_fgetc
= config_buf_fgetc
;
1329 top
.do_ungetc
= config_buf_ungetc
;
1330 top
.do_ftell
= config_buf_ftell
;
1332 return do_config_from(&top
, fn
, data
);
1335 int git_config_from_blob_sha1(config_fn_t fn
,
1337 const unsigned char *sha1
,
1340 enum object_type type
;
1345 buf
= read_sha1_file(sha1
, &type
, &size
);
1347 return error("unable to load config blob object '%s'", name
);
1348 if (type
!= OBJ_BLOB
) {
1350 return error("reference '%s' does not point to a blob", name
);
1353 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
, data
);
1359 static int git_config_from_blob_ref(config_fn_t fn
,
1363 unsigned char sha1
[20];
1365 if (get_sha1(name
, sha1
) < 0)
1366 return error("unable to resolve config blob '%s'", name
);
1367 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1370 const char *git_etc_gitconfig(void)
1372 static const char *system_wide
;
1374 system_wide
= system_path(ETC_GITCONFIG
);
1379 * Parse environment variable 'k' as a boolean (in various
1380 * possible spellings); if missing, use the default value 'def'.
1382 int git_env_bool(const char *k
, int def
)
1384 const char *v
= getenv(k
);
1385 return v
? git_config_bool(k
, v
) : def
;
1389 * Parse environment variable 'k' as ulong with possibly a unit
1390 * suffix; if missing, use the default value 'val'.
1392 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1394 const char *v
= getenv(k
);
1395 if (v
&& !git_parse_ulong(v
, &val
))
1396 die("failed to parse %s", k
);
1400 int git_config_system(void)
1402 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1405 static int do_git_config_sequence(config_fn_t fn
, void *data
)
1408 char *xdg_config
= xdg_config_home("config");
1409 char *user_config
= expand_user_path("~/.gitconfig");
1410 char *repo_config
= have_git_dir() ? git_pathdup("config") : NULL
;
1412 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1413 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0))
1414 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1417 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1418 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1419 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1421 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1422 ret
+= git_config_from_file(fn
, user_config
, data
);
1424 current_parsing_scope
= CONFIG_SCOPE_REPO
;
1425 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0))
1426 ret
+= git_config_from_file(fn
, repo_config
, data
);
1428 current_parsing_scope
= CONFIG_SCOPE_CMDLINE
;
1429 if (git_config_from_parameters(fn
, data
) < 0)
1430 die(_("unable to parse command-line config"));
1432 current_parsing_scope
= CONFIG_SCOPE_UNKNOWN
;
1439 int git_config_with_options(config_fn_t fn
, void *data
,
1440 struct git_config_source
*config_source
,
1441 int respect_includes
)
1443 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1445 if (respect_includes
) {
1448 fn
= git_config_include
;
1453 * If we have a specific filename, use it. Otherwise, follow the
1454 * regular lookup sequence.
1456 if (config_source
&& config_source
->use_stdin
)
1457 return git_config_from_stdin(fn
, data
);
1458 else if (config_source
&& config_source
->file
)
1459 return git_config_from_file(fn
, config_source
->file
, data
);
1460 else if (config_source
&& config_source
->blob
)
1461 return git_config_from_blob_ref(fn
, config_source
->blob
, data
);
1463 return do_git_config_sequence(fn
, data
);
1466 static void git_config_raw(config_fn_t fn
, void *data
)
1468 if (git_config_with_options(fn
, data
, NULL
, 1) < 0)
1470 * git_config_with_options() normally returns only
1471 * zero, as most errors are fatal, and
1472 * non-fatal potential errors are guarded by "if"
1473 * statements that are entered only when no error is
1476 * If we ever encounter a non-fatal error, it means
1477 * something went really wrong and we should stop
1480 die(_("unknown error occurred while reading the configuration files"));
1483 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1486 struct string_list
*values
;
1487 struct config_set_element
*entry
;
1488 struct configset_list
*list
= &cs
->list
;
1490 for (i
= 0; i
< list
->nr
; i
++) {
1491 entry
= list
->items
[i
].e
;
1492 value_index
= list
->items
[i
].value_index
;
1493 values
= &entry
->value_list
;
1495 current_config_kvi
= values
->items
[value_index
].util
;
1497 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1498 git_die_config_linenr(entry
->key
,
1499 current_config_kvi
->filename
,
1500 current_config_kvi
->linenr
);
1502 current_config_kvi
= NULL
;
1506 static void git_config_check_init(void);
1508 void git_config(config_fn_t fn
, void *data
)
1510 git_config_check_init();
1511 configset_iter(&the_config_set
, fn
, data
);
1514 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
1516 struct config_set_element k
;
1517 struct config_set_element
*found_entry
;
1518 char *normalized_key
;
1520 * `key` may come from the user, so normalize it before using it
1521 * for querying entries from the hashmap.
1523 if (git_config_parse_key(key
, &normalized_key
, NULL
))
1526 hashmap_entry_init(&k
, strhash(normalized_key
));
1527 k
.key
= normalized_key
;
1528 found_entry
= hashmap_get(&cs
->config_hash
, &k
, NULL
);
1529 free(normalized_key
);
1533 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
1535 struct config_set_element
*e
;
1536 struct string_list_item
*si
;
1537 struct configset_list_item
*l_item
;
1538 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
1540 e
= configset_find_element(cs
, key
);
1542 * Since the keys are being fed by git_config*() callback mechanism, they
1543 * are already normalized. So simply add them without any further munging.
1546 e
= xmalloc(sizeof(*e
));
1547 hashmap_entry_init(e
, strhash(key
));
1548 e
->key
= xstrdup(key
);
1549 string_list_init(&e
->value_list
, 1);
1550 hashmap_add(&cs
->config_hash
, e
);
1552 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
1554 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
1555 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
1557 l_item
->value_index
= e
->value_list
.nr
- 1;
1560 die("BUG: configset_add_value has no source");
1562 kv_info
->filename
= strintern(cf
->name
);
1563 kv_info
->linenr
= cf
->linenr
;
1564 kv_info
->origin_type
= cf
->origin_type
;
1566 /* for values read from `git_config_from_parameters()` */
1567 kv_info
->filename
= NULL
;
1568 kv_info
->linenr
= -1;
1569 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
1571 kv_info
->scope
= current_parsing_scope
;
1577 static int config_set_element_cmp(const struct config_set_element
*e1
,
1578 const struct config_set_element
*e2
, const void *unused
)
1580 return strcmp(e1
->key
, e2
->key
);
1583 void git_configset_init(struct config_set
*cs
)
1585 hashmap_init(&cs
->config_hash
, (hashmap_cmp_fn
)config_set_element_cmp
, 0);
1586 cs
->hash_initialized
= 1;
1589 cs
->list
.items
= NULL
;
1592 void git_configset_clear(struct config_set
*cs
)
1594 struct config_set_element
*entry
;
1595 struct hashmap_iter iter
;
1596 if (!cs
->hash_initialized
)
1599 hashmap_iter_init(&cs
->config_hash
, &iter
);
1600 while ((entry
= hashmap_iter_next(&iter
))) {
1602 string_list_clear(&entry
->value_list
, 1);
1604 hashmap_free(&cs
->config_hash
, 1);
1605 cs
->hash_initialized
= 0;
1606 free(cs
->list
.items
);
1609 cs
->list
.items
= NULL
;
1612 static int config_set_callback(const char *key
, const char *value
, void *cb
)
1614 struct config_set
*cs
= cb
;
1615 configset_add_value(cs
, key
, value
);
1619 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
1621 return git_config_from_file(config_set_callback
, filename
, cs
);
1624 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
1626 const struct string_list
*values
= NULL
;
1628 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1629 * queried key in the files of the configset, the value returned will be the last
1630 * value in the value list for that key.
1632 values
= git_configset_get_value_multi(cs
, key
);
1636 assert(values
->nr
> 0);
1637 *value
= values
->items
[values
->nr
- 1].string
;
1641 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
1643 struct config_set_element
*e
= configset_find_element(cs
, key
);
1644 return e
? &e
->value_list
: NULL
;
1647 int git_configset_get_string_const(struct config_set
*cs
, const char *key
, const char **dest
)
1650 if (!git_configset_get_value(cs
, key
, &value
))
1651 return git_config_string(dest
, key
, value
);
1656 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
1658 return git_configset_get_string_const(cs
, key
, (const char **)dest
);
1661 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
1664 if (!git_configset_get_value(cs
, key
, &value
)) {
1665 *dest
= git_config_int(key
, value
);
1671 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
1674 if (!git_configset_get_value(cs
, key
, &value
)) {
1675 *dest
= git_config_ulong(key
, value
);
1681 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
1684 if (!git_configset_get_value(cs
, key
, &value
)) {
1685 *dest
= git_config_bool(key
, value
);
1691 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
1692 int *is_bool
, int *dest
)
1695 if (!git_configset_get_value(cs
, key
, &value
)) {
1696 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
1702 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
1705 if (!git_configset_get_value(cs
, key
, &value
)) {
1706 *dest
= git_config_maybe_bool(key
, value
);
1714 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
1717 if (!git_configset_get_value(cs
, key
, &value
))
1718 return git_config_pathname(dest
, key
, value
);
1723 static void git_config_check_init(void)
1725 if (the_config_set
.hash_initialized
)
1727 git_configset_init(&the_config_set
);
1728 git_config_raw(config_set_callback
, &the_config_set
);
1731 void git_config_clear(void)
1733 if (!the_config_set
.hash_initialized
)
1735 git_configset_clear(&the_config_set
);
1738 int git_config_get_value(const char *key
, const char **value
)
1740 git_config_check_init();
1741 return git_configset_get_value(&the_config_set
, key
, value
);
1744 const struct string_list
*git_config_get_value_multi(const char *key
)
1746 git_config_check_init();
1747 return git_configset_get_value_multi(&the_config_set
, key
);
1750 int git_config_get_string_const(const char *key
, const char **dest
)
1753 git_config_check_init();
1754 ret
= git_configset_get_string_const(&the_config_set
, key
, dest
);
1756 git_die_config(key
, NULL
);
1760 int git_config_get_string(const char *key
, char **dest
)
1762 git_config_check_init();
1763 return git_config_get_string_const(key
, (const char **)dest
);
1766 int git_config_get_int(const char *key
, int *dest
)
1768 git_config_check_init();
1769 return git_configset_get_int(&the_config_set
, key
, dest
);
1772 int git_config_get_ulong(const char *key
, unsigned long *dest
)
1774 git_config_check_init();
1775 return git_configset_get_ulong(&the_config_set
, key
, dest
);
1778 int git_config_get_bool(const char *key
, int *dest
)
1780 git_config_check_init();
1781 return git_configset_get_bool(&the_config_set
, key
, dest
);
1784 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
1786 git_config_check_init();
1787 return git_configset_get_bool_or_int(&the_config_set
, key
, is_bool
, dest
);
1790 int git_config_get_maybe_bool(const char *key
, int *dest
)
1792 git_config_check_init();
1793 return git_configset_get_maybe_bool(&the_config_set
, key
, dest
);
1796 int git_config_get_pathname(const char *key
, const char **dest
)
1799 git_config_check_init();
1800 ret
= git_configset_get_pathname(&the_config_set
, key
, dest
);
1802 git_die_config(key
, NULL
);
1806 int git_config_get_expiry(const char *key
, const char **output
)
1808 int ret
= git_config_get_string_const(key
, output
);
1811 if (strcmp(*output
, "now")) {
1812 unsigned long now
= approxidate("now");
1813 if (approxidate(*output
) >= now
)
1814 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
1819 int git_config_get_untracked_cache(void)
1824 /* Hack for test programs like test-dump-untracked-cache */
1825 if (ignore_untracked_cache_config
)
1828 if (!git_config_get_maybe_bool("core.untrackedcache", &val
))
1831 if (!git_config_get_value("core.untrackedcache", &v
)) {
1832 if (!strcasecmp(v
, "keep"))
1835 error(_("unknown core.untrackedCache value '%s'; "
1836 "using 'keep' default value"), v
);
1840 return -1; /* default value */
1843 int git_config_get_split_index(void)
1847 if (!git_config_get_maybe_bool("core.splitindex", &val
))
1850 return -1; /* default value */
1853 int git_config_get_max_percent_split_change(void)
1857 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
1858 if (0 <= val
&& val
<= 100)
1861 return error(_("splitIndex.maxPercentChange value '%d' "
1862 "should be between 0 and 100"), val
);
1865 return -1; /* default value */
1869 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
1872 die(_("unable to parse '%s' from command-line config"), key
);
1874 die(_("bad config variable '%s' in file '%s' at line %d"),
1875 key
, filename
, linenr
);
1878 NORETURN
__attribute__((format(printf
, 2, 3)))
1879 void git_die_config(const char *key
, const char *err
, ...)
1881 const struct string_list
*values
;
1882 struct key_value_info
*kv_info
;
1886 va_start(params
, err
);
1887 vreportf("error: ", err
, params
);
1890 values
= git_config_get_value_multi(key
);
1891 kv_info
= values
->items
[values
->nr
- 1].util
;
1892 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
1896 * Find all the stuff for git_config_set() below.
1903 regex_t
*value_regex
;
1906 unsigned int offset_alloc
;
1907 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1911 static int matches(const char *key
, const char *value
)
1913 if (strcmp(key
, store
.key
))
1914 return 0; /* not ours */
1915 if (!store
.value_regex
)
1916 return 1; /* always matches */
1917 if (store
.value_regex
== CONFIG_REGEX_NONE
)
1918 return 0; /* never matches */
1920 return store
.do_not_match
^
1921 (value
&& !regexec(store
.value_regex
, value
, 0, NULL
, 0));
1924 static int store_aux(const char *key
, const char *value
, void *cb
)
1929 switch (store
.state
) {
1931 if (matches(key
, value
)) {
1932 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1933 warning(_("%s has multiple values"), key
);
1936 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1937 store
.offset_alloc
);
1939 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1945 * What we are looking for is in store.key (both
1946 * section and var), and its section part is baselen
1947 * long. We found key (again, both section and var).
1948 * We would want to know if this key is in the same
1949 * section as what we are looking for. We already
1950 * know we are in the same section as what should
1953 ep
= strrchr(key
, '.');
1954 section_len
= ep
- key
;
1956 if ((section_len
!= store
.baselen
) ||
1957 memcmp(key
, store
.key
, section_len
+1)) {
1958 store
.state
= SECTION_END_SEEN
;
1963 * Do not increment matches: this is no match, but we
1964 * just made sure we are in the desired section.
1966 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1967 store
.offset_alloc
);
1968 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1970 case SECTION_END_SEEN
:
1972 if (matches(key
, value
)) {
1973 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1974 store
.offset_alloc
);
1975 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1976 store
.state
= KEY_SEEN
;
1979 if (strrchr(key
, '.') - key
== store
.baselen
&&
1980 !strncmp(key
, store
.key
, store
.baselen
)) {
1981 store
.state
= SECTION_SEEN
;
1982 ALLOC_GROW(store
.offset
,
1984 store
.offset_alloc
);
1985 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1992 static int write_error(const char *filename
)
1994 error("failed to write new configuration file %s", filename
);
1996 /* Same error code as "failed to rename". */
2000 static int store_write_section(int fd
, const char *key
)
2004 struct strbuf sb
= STRBUF_INIT
;
2006 dot
= memchr(key
, '.', store
.baselen
);
2008 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
2009 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
2010 if (key
[i
] == '"' || key
[i
] == '\\')
2011 strbuf_addch(&sb
, '\\');
2012 strbuf_addch(&sb
, key
[i
]);
2014 strbuf_addstr(&sb
, "\"]\n");
2016 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
2019 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
2020 strbuf_release(&sb
);
2025 static int store_write_pair(int fd
, const char *key
, const char *value
)
2028 int length
= strlen(key
+ store
.baselen
+ 1);
2029 const char *quote
= "";
2030 struct strbuf sb
= STRBUF_INIT
;
2033 * Check to see if the value needs to be surrounded with a dq pair.
2034 * Note that problematic characters are always backslash-quoted; this
2035 * check is about not losing leading or trailing SP and strings that
2036 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2037 * configuration parser.
2039 if (value
[0] == ' ')
2041 for (i
= 0; value
[i
]; i
++)
2042 if (value
[i
] == ';' || value
[i
] == '#')
2044 if (i
&& value
[i
- 1] == ' ')
2047 strbuf_addf(&sb
, "\t%.*s = %s",
2048 length
, key
+ store
.baselen
+ 1, quote
);
2050 for (i
= 0; value
[i
]; i
++)
2053 strbuf_addstr(&sb
, "\\n");
2056 strbuf_addstr(&sb
, "\\t");
2060 strbuf_addch(&sb
, '\\');
2062 strbuf_addch(&sb
, value
[i
]);
2065 strbuf_addf(&sb
, "%s\n", quote
);
2067 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
2068 strbuf_release(&sb
);
2073 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
2074 size_t offset_
, int *found_bracket
)
2076 size_t equal_offset
= size
, bracket_offset
= size
;
2080 for (offset
= offset_
-2; offset
> 0
2081 && contents
[offset
] != '\n'; offset
--)
2082 switch (contents
[offset
]) {
2083 case '=': equal_offset
= offset
; break;
2084 case ']': bracket_offset
= offset
; break;
2086 if (offset
> 0 && contents
[offset
-1] == '\\') {
2090 if (bracket_offset
< equal_offset
) {
2092 offset
= bracket_offset
+1;
2099 int git_config_set_in_file_gently(const char *config_filename
,
2100 const char *key
, const char *value
)
2102 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
2105 void git_config_set_in_file(const char *config_filename
,
2106 const char *key
, const char *value
)
2108 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
2111 int git_config_set_gently(const char *key
, const char *value
)
2113 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
2116 void git_config_set(const char *key
, const char *value
)
2118 git_config_set_multivar(key
, value
, NULL
, 0);
2122 * If value==NULL, unset in (remove from) config,
2123 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2124 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2125 * (only add a new one)
2126 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2127 * else all matching key/values (regardless how many) are removed,
2128 * before the new pair is written.
2130 * Returns 0 on success.
2132 * This function does this:
2134 * - it locks the config file by creating ".git/config.lock"
2136 * - it then parses the config using store_aux() as validator to find
2137 * the position on the key/value pair to replace. If it is to be unset,
2138 * it must be found exactly once.
2140 * - the config file is mmap()ed and the part before the match (if any) is
2141 * written to the lock file, then the changed part and the rest.
2143 * - the config file is removed and the lock file rename()d to it.
2146 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2147 const char *key
, const char *value
,
2148 const char *value_regex
,
2151 int fd
= -1, in_fd
= -1;
2153 struct lock_file
*lock
= NULL
;
2154 char *filename_buf
= NULL
;
2155 char *contents
= NULL
;
2158 /* parse-key returns negative; flip the sign to feed exit(3) */
2159 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2163 store
.multi_replace
= multi_replace
;
2165 if (!config_filename
)
2166 config_filename
= filename_buf
= git_pathdup("config");
2169 * The lock serves a purpose in addition to locking: the new
2170 * contents of .git/config will be written into it.
2172 lock
= xcalloc(1, sizeof(struct lock_file
));
2173 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2175 error_errno("could not lock config file %s", config_filename
);
2177 ret
= CONFIG_NO_LOCK
;
2182 * If .git/config does not exist yet, write a minimal version.
2184 in_fd
= open(config_filename
, O_RDONLY
);
2188 if ( ENOENT
!= errno
) {
2189 error_errno("opening %s", config_filename
);
2190 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2193 /* if nothing to unset, error out */
2194 if (value
== NULL
) {
2195 ret
= CONFIG_NOTHING_SET
;
2199 store
.key
= (char *)key
;
2200 if (!store_write_section(fd
, key
) ||
2201 !store_write_pair(fd
, key
, value
))
2205 size_t copy_begin
, copy_end
;
2206 int i
, new_line
= 0;
2208 if (value_regex
== NULL
)
2209 store
.value_regex
= NULL
;
2210 else if (value_regex
== CONFIG_REGEX_NONE
)
2211 store
.value_regex
= CONFIG_REGEX_NONE
;
2213 if (value_regex
[0] == '!') {
2214 store
.do_not_match
= 1;
2217 store
.do_not_match
= 0;
2219 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
2220 if (regcomp(store
.value_regex
, value_regex
,
2222 error("invalid pattern: %s", value_regex
);
2223 free(store
.value_regex
);
2224 ret
= CONFIG_INVALID_PATTERN
;
2229 ALLOC_GROW(store
.offset
, 1, store
.offset_alloc
);
2230 store
.offset
[0] = 0;
2231 store
.state
= START
;
2235 * After this, store.offset will contain the *end* offset
2236 * of the last match, or remain at 0 if no match was found.
2237 * As a side effect, we make sure to transform only a valid
2238 * existing config file.
2240 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
2241 error("invalid config file %s", config_filename
);
2243 if (store
.value_regex
!= NULL
&&
2244 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2245 regfree(store
.value_regex
);
2246 free(store
.value_regex
);
2248 ret
= CONFIG_INVALID_FILE
;
2253 if (store
.value_regex
!= NULL
&&
2254 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2255 regfree(store
.value_regex
);
2256 free(store
.value_regex
);
2259 /* if nothing to unset, or too many matches, error out */
2260 if ((store
.seen
== 0 && value
== NULL
) ||
2261 (store
.seen
> 1 && multi_replace
== 0)) {
2262 ret
= CONFIG_NOTHING_SET
;
2266 if (fstat(in_fd
, &st
) == -1) {
2267 error_errno(_("fstat on %s failed"), config_filename
);
2268 ret
= CONFIG_INVALID_FILE
;
2272 contents_sz
= xsize_t(st
.st_size
);
2273 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
2274 MAP_PRIVATE
, in_fd
, 0);
2275 if (contents
== MAP_FAILED
) {
2276 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
2278 error_errno("unable to mmap '%s'", config_filename
);
2279 ret
= CONFIG_INVALID_FILE
;
2286 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2287 error_errno("chmod on %s failed", get_lock_file_path(lock
));
2288 ret
= CONFIG_NO_WRITE
;
2292 if (store
.seen
== 0)
2295 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
2296 if (store
.offset
[i
] == 0) {
2297 store
.offset
[i
] = copy_end
= contents_sz
;
2298 } else if (store
.state
!= KEY_SEEN
) {
2299 copy_end
= store
.offset
[i
];
2301 copy_end
= find_beginning_of_line(
2302 contents
, contents_sz
,
2303 store
.offset
[i
]-2, &new_line
);
2305 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
2308 /* write the first part of the config */
2309 if (copy_end
> copy_begin
) {
2310 if (write_in_full(fd
, contents
+ copy_begin
,
2311 copy_end
- copy_begin
) <
2312 copy_end
- copy_begin
)
2315 write_str_in_full(fd
, "\n") != 1)
2318 copy_begin
= store
.offset
[i
];
2321 /* write the pair (value == NULL means unset) */
2322 if (value
!= NULL
) {
2323 if (store
.state
== START
) {
2324 if (!store_write_section(fd
, key
))
2327 if (!store_write_pair(fd
, key
, value
))
2331 /* write the rest of the config */
2332 if (copy_begin
< contents_sz
)
2333 if (write_in_full(fd
, contents
+ copy_begin
,
2334 contents_sz
- copy_begin
) <
2335 contents_sz
- copy_begin
)
2338 munmap(contents
, contents_sz
);
2342 if (commit_lock_file(lock
) < 0) {
2343 error_errno("could not write config file %s", config_filename
);
2344 ret
= CONFIG_NO_WRITE
;
2350 * lock is committed, so don't try to roll it back below.
2351 * NOTE: Since lockfile.c keeps a linked list of all created
2352 * lock_file structures, it isn't safe to free(lock). It's
2353 * better to just leave it hanging around.
2358 /* Invalidate the config cache */
2363 rollback_lock_file(lock
);
2366 munmap(contents
, contents_sz
);
2372 ret
= write_error(get_lock_file_path(lock
));
2377 void git_config_set_multivar_in_file(const char *config_filename
,
2378 const char *key
, const char *value
,
2379 const char *value_regex
, int multi_replace
)
2381 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
2382 value_regex
, multi_replace
))
2385 die(_("could not set '%s' to '%s'"), key
, value
);
2387 die(_("could not unset '%s'"), key
);
2390 int git_config_set_multivar_gently(const char *key
, const char *value
,
2391 const char *value_regex
, int multi_replace
)
2393 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_regex
,
2397 void git_config_set_multivar(const char *key
, const char *value
,
2398 const char *value_regex
, int multi_replace
)
2400 git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
2404 static int section_name_match (const char *buf
, const char *name
)
2406 int i
= 0, j
= 0, dot
= 0;
2409 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
2410 if (!dot
&& isspace(buf
[i
])) {
2412 if (name
[j
++] != '.')
2414 for (i
++; isspace(buf
[i
]); i
++)
2420 if (buf
[i
] == '\\' && dot
)
2422 else if (buf
[i
] == '"' && dot
) {
2423 for (i
++; isspace(buf
[i
]); i
++)
2427 if (buf
[i
] != name
[j
++])
2430 if (buf
[i
] == ']' && name
[j
] == 0) {
2432 * We match, now just find the right length offset by
2433 * gobbling up any whitespace after it, as well
2436 for (; buf
[i
] && isspace(buf
[i
]); i
++)
2443 static int section_name_is_ok(const char *name
)
2445 /* Empty section names are bogus. */
2450 * Before a dot, we must be alphanumeric or dash. After the first dot,
2451 * anything goes, so we can stop checking.
2453 for (; *name
&& *name
!= '.'; name
++)
2454 if (*name
!= '-' && !isalnum(*name
))
2459 /* if new_name == NULL, the section is removed instead */
2460 int git_config_rename_section_in_file(const char *config_filename
,
2461 const char *old_name
, const char *new_name
)
2463 int ret
= 0, remove
= 0;
2464 char *filename_buf
= NULL
;
2465 struct lock_file
*lock
;
2471 if (new_name
&& !section_name_is_ok(new_name
)) {
2472 ret
= error("invalid section name: %s", new_name
);
2473 goto out_no_rollback
;
2476 if (!config_filename
)
2477 config_filename
= filename_buf
= git_pathdup("config");
2479 lock
= xcalloc(1, sizeof(struct lock_file
));
2480 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2482 ret
= error("could not lock config file %s", config_filename
);
2486 if (!(config_file
= fopen(config_filename
, "rb"))) {
2487 /* no config file means nothing to rename, no error */
2488 goto commit_and_out
;
2491 if (fstat(fileno(config_file
), &st
) == -1) {
2492 ret
= error_errno(_("fstat on %s failed"), config_filename
);
2496 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2497 ret
= error_errno("chmod on %s failed",
2498 get_lock_file_path(lock
));
2502 while (fgets(buf
, sizeof(buf
), config_file
)) {
2506 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
2508 if (buf
[i
] == '[') {
2509 /* it's a section */
2510 int offset
= section_name_match(&buf
[i
], old_name
);
2513 if (new_name
== NULL
) {
2517 store
.baselen
= strlen(new_name
);
2518 if (!store_write_section(out_fd
, new_name
)) {
2519 ret
= write_error(get_lock_file_path(lock
));
2523 * We wrote out the new section, with
2524 * a newline, now skip the old
2527 output
+= offset
+ i
;
2528 if (strlen(output
) > 0) {
2530 * More content means there's
2531 * a declaration to put on the
2532 * next line; indent with a
2543 length
= strlen(output
);
2544 if (write_in_full(out_fd
, output
, length
) != length
) {
2545 ret
= write_error(get_lock_file_path(lock
));
2549 fclose(config_file
);
2551 if (commit_lock_file(lock
) < 0)
2552 ret
= error_errno("could not write config file %s",
2555 rollback_lock_file(lock
);
2561 int git_config_rename_section(const char *old_name
, const char *new_name
)
2563 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
2567 * Call this to report error for your variable that should not
2568 * get a boolean value (i.e. "[my] var" means "true").
2570 #undef config_error_nonbool
2571 int config_error_nonbool(const char *var
)
2573 return error("missing value for '%s'", var
);
2576 int parse_config_key(const char *var
,
2577 const char *section
,
2578 const char **subsection
, int *subsection_len
,
2583 /* Does it start with "section." ? */
2584 if (!skip_prefix(var
, section
, &var
) || *var
!= '.')
2588 * Find the key; we don't know yet if we have a subsection, but we must
2589 * parse backwards from the end, since the subsection may have dots in
2592 dot
= strrchr(var
, '.');
2595 /* Did we have a subsection at all? */
2599 *subsection_len
= 0;
2605 *subsection
= var
+ 1;
2606 *subsection_len
= dot
- *subsection
;
2612 const char *current_config_origin_type(void)
2615 if (current_config_kvi
)
2616 type
= current_config_kvi
->origin_type
;
2618 type
= cf
->origin_type
;
2620 die("BUG: current_config_origin_type called outside config callback");
2623 case CONFIG_ORIGIN_BLOB
:
2625 case CONFIG_ORIGIN_FILE
:
2627 case CONFIG_ORIGIN_STDIN
:
2628 return "standard input";
2629 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
2630 return "submodule-blob";
2631 case CONFIG_ORIGIN_CMDLINE
:
2632 return "command line";
2634 die("BUG: unknown config origin type");
2638 const char *current_config_name(void)
2641 if (current_config_kvi
)
2642 name
= current_config_kvi
->filename
;
2646 die("BUG: current_config_name called outside config callback");
2647 return name
? name
: "";
2650 enum config_scope
current_config_scope(void)
2652 if (current_config_kvi
)
2653 return current_config_kvi
->scope
;
2655 return current_parsing_scope
;