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 int git_config_parse_parameter(const char *text
,
205 config_fn_t fn
, void *data
)
208 struct strbuf
**pair
;
210 pair
= strbuf_split_str(text
, '=', 2);
212 return error("bogus config parameter: %s", text
);
214 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
215 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
216 value
= pair
[1] ? pair
[1]->buf
: "";
221 strbuf_trim(pair
[0]);
223 strbuf_list_free(pair
);
224 return error("bogus config parameter: %s", text
);
226 strbuf_tolower(pair
[0]);
227 if (fn(pair
[0]->buf
, value
, data
) < 0) {
228 strbuf_list_free(pair
);
231 strbuf_list_free(pair
);
235 int git_config_from_parameters(config_fn_t fn
, void *data
)
237 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
240 const char **argv
= NULL
;
241 int nr
= 0, alloc
= 0;
243 struct config_source source
;
248 memset(&source
, 0, sizeof(source
));
250 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
253 /* sq_dequote will write over it */
256 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
257 ret
= error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
261 for (i
= 0; i
< nr
; i
++) {
262 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
275 static int get_next_char(void)
277 int c
= cf
->do_fgetc(cf
);
280 /* DOS like systems */
281 c
= cf
->do_fgetc(cf
);
284 cf
->do_ungetc(c
, cf
);
298 static char *parse_value(void)
300 int quote
= 0, comment
= 0, space
= 0;
302 strbuf_reset(&cf
->value
);
304 int c
= get_next_char();
310 return cf
->value
.buf
;
314 if (isspace(c
) && !quote
) {
320 if (c
== ';' || c
== '#') {
325 for (; space
; space
--)
326 strbuf_addch(&cf
->value
, ' ');
341 /* Some characters escape as themselves */
344 /* Reject unknown escape sequences */
348 strbuf_addch(&cf
->value
, c
);
355 strbuf_addch(&cf
->value
, c
);
359 static inline int iskeychar(int c
)
361 return isalnum(c
) || c
== '-';
364 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
370 /* Get the full name */
377 strbuf_addch(name
, tolower(c
));
380 while (c
== ' ' || c
== '\t')
387 value
= parse_value();
392 * We already consumed the \n, but we need linenr to point to
393 * the line we just parsed during the call to fn to get
394 * accurate line number in error messages.
397 ret
= fn(name
->buf
, value
, data
);
402 static int get_extended_base_var(struct strbuf
*name
, int c
)
406 goto error_incomplete_line
;
408 } while (isspace(c
));
410 /* We require the format to be '[base "extension"]' */
413 strbuf_addch(name
, '.');
416 int c
= get_next_char();
418 goto error_incomplete_line
;
424 goto error_incomplete_line
;
426 strbuf_addch(name
, c
);
430 if (get_next_char() != ']')
433 error_incomplete_line
:
438 static int get_base_var(struct strbuf
*name
)
441 int c
= get_next_char();
447 return get_extended_base_var(name
, c
);
448 if (!iskeychar(c
) && c
!= '.')
450 strbuf_addch(name
, tolower(c
));
454 static int git_parse_source(config_fn_t fn
, void *data
)
458 struct strbuf
*var
= &cf
->var
;
459 int error_return
= 0;
460 char *error_msg
= NULL
;
462 /* U+FEFF Byte Order Mark in UTF8 */
463 const char *bomptr
= utf8_bom
;
466 int c
= get_next_char();
467 if (bomptr
&& *bomptr
) {
468 /* We are at the file beginning; skip UTF8-encoded BOM
469 * if present. Sane editors won't put this in on their
470 * own, but e.g. Windows Notepad will do it happily. */
471 if (c
== (*bomptr
& 0377)) {
475 /* Do not tolerate partial BOM. */
476 if (bomptr
!= utf8_bom
)
478 /* No BOM at file beginning. Cool. */
488 if (comment
|| isspace(c
))
490 if (c
== '#' || c
== ';') {
495 /* Reset prior to determining a new stem */
497 if (get_base_var(var
) < 0 || var
->len
< 1)
499 strbuf_addch(var
, '.');
506 * Truncate the var name back to the section header
507 * stem prior to grabbing the suffix part of the name
510 strbuf_setlen(var
, baselen
);
511 strbuf_addch(var
, tolower(c
));
512 if (get_value(fn
, data
, var
) < 0)
516 switch (cf
->origin_type
) {
517 case CONFIG_ORIGIN_BLOB
:
518 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
519 cf
->linenr
, cf
->name
);
521 case CONFIG_ORIGIN_FILE
:
522 error_msg
= xstrfmt(_("bad config line %d in file %s"),
523 cf
->linenr
, cf
->name
);
525 case CONFIG_ORIGIN_STDIN
:
526 error_msg
= xstrfmt(_("bad config line %d in standard input"),
529 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
530 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
531 cf
->linenr
, cf
->name
);
533 case CONFIG_ORIGIN_CMDLINE
:
534 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
535 cf
->linenr
, cf
->name
);
538 error_msg
= xstrfmt(_("bad config line %d in %s"),
539 cf
->linenr
, cf
->name
);
542 if (cf
->die_on_error
)
543 die("%s", error_msg
);
545 error_return
= error("%s", error_msg
);
551 static int parse_unit_factor(const char *end
, uintmax_t *val
)
555 else if (!strcasecmp(end
, "k")) {
559 else if (!strcasecmp(end
, "m")) {
563 else if (!strcasecmp(end
, "g")) {
564 *val
*= 1024 * 1024 * 1024;
570 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
572 if (value
&& *value
) {
576 uintmax_t factor
= 1;
579 val
= strtoimax(value
, &end
, 0);
582 if (!parse_unit_factor(end
, &factor
)) {
588 if (uval
> max
|| labs(val
) > uval
) {
600 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
602 if (value
&& *value
) {
608 val
= strtoumax(value
, &end
, 0);
612 if (!parse_unit_factor(end
, &val
)) {
616 if (val
> max
|| oldval
> val
) {
627 static int git_parse_int(const char *value
, int *ret
)
630 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
636 static int git_parse_int64(const char *value
, int64_t *ret
)
639 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
645 int git_parse_ulong(const char *value
, unsigned long *ret
)
648 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
655 static void die_bad_number(const char *name
, const char *value
)
657 const char * error_type
= (errno
== ERANGE
)? _("out of range"):_("invalid unit");
662 if (!(cf
&& cf
->name
))
663 die(_("bad numeric config value '%s' for '%s': %s"),
664 value
, name
, error_type
);
666 switch (cf
->origin_type
) {
667 case CONFIG_ORIGIN_BLOB
:
668 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
669 value
, name
, cf
->name
, error_type
);
670 case CONFIG_ORIGIN_FILE
:
671 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
672 value
, name
, cf
->name
, error_type
);
673 case CONFIG_ORIGIN_STDIN
:
674 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
675 value
, name
, error_type
);
676 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
677 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
678 value
, name
, cf
->name
, error_type
);
679 case CONFIG_ORIGIN_CMDLINE
:
680 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
681 value
, name
, cf
->name
, error_type
);
683 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
684 value
, name
, cf
->name
, error_type
);
688 int git_config_int(const char *name
, const char *value
)
691 if (!git_parse_int(value
, &ret
))
692 die_bad_number(name
, value
);
696 int64_t git_config_int64(const char *name
, const char *value
)
699 if (!git_parse_int64(value
, &ret
))
700 die_bad_number(name
, value
);
704 unsigned long git_config_ulong(const char *name
, const char *value
)
707 if (!git_parse_ulong(value
, &ret
))
708 die_bad_number(name
, value
);
712 int git_parse_maybe_bool(const char *value
)
718 if (!strcasecmp(value
, "true")
719 || !strcasecmp(value
, "yes")
720 || !strcasecmp(value
, "on"))
722 if (!strcasecmp(value
, "false")
723 || !strcasecmp(value
, "no")
724 || !strcasecmp(value
, "off"))
729 int git_config_maybe_bool(const char *name
, const char *value
)
731 int v
= git_parse_maybe_bool(value
);
734 if (git_parse_int(value
, &v
))
739 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
741 int v
= git_parse_maybe_bool(value
);
747 return git_config_int(name
, value
);
750 int git_config_bool(const char *name
, const char *value
)
753 return !!git_config_bool_or_int(name
, value
, &discard
);
756 int git_config_string(const char **dest
, const char *var
, const char *value
)
759 return config_error_nonbool(var
);
760 *dest
= xstrdup(value
);
764 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
767 return config_error_nonbool(var
);
768 *dest
= expand_user_path(value
);
770 die(_("failed to expand user dir in: '%s'"), value
);
774 static int git_default_core_config(const char *var
, const char *value
)
776 /* This needs a better name */
777 if (!strcmp(var
, "core.filemode")) {
778 trust_executable_bit
= git_config_bool(var
, value
);
781 if (!strcmp(var
, "core.trustctime")) {
782 trust_ctime
= git_config_bool(var
, value
);
785 if (!strcmp(var
, "core.checkstat")) {
786 if (!strcasecmp(value
, "default"))
788 else if (!strcasecmp(value
, "minimal"))
792 if (!strcmp(var
, "core.quotepath")) {
793 quote_path_fully
= git_config_bool(var
, value
);
797 if (!strcmp(var
, "core.symlinks")) {
798 has_symlinks
= git_config_bool(var
, value
);
802 if (!strcmp(var
, "core.ignorecase")) {
803 ignore_case
= git_config_bool(var
, value
);
807 if (!strcmp(var
, "core.attributesfile"))
808 return git_config_pathname(&git_attributes_file
, var
, value
);
810 if (!strcmp(var
, "core.hookspath"))
811 return git_config_pathname(&git_hooks_path
, var
, value
);
813 if (!strcmp(var
, "core.bare")) {
814 is_bare_repository_cfg
= git_config_bool(var
, value
);
818 if (!strcmp(var
, "core.ignorestat")) {
819 assume_unchanged
= git_config_bool(var
, value
);
823 if (!strcmp(var
, "core.prefersymlinkrefs")) {
824 prefer_symlink_refs
= git_config_bool(var
, value
);
828 if (!strcmp(var
, "core.logallrefupdates")) {
829 log_all_ref_updates
= git_config_bool(var
, value
);
833 if (!strcmp(var
, "core.warnambiguousrefs")) {
834 warn_ambiguous_refs
= git_config_bool(var
, value
);
838 if (!strcmp(var
, "core.abbrev")) {
840 return config_error_nonbool(var
);
841 if (!strcasecmp(value
, "auto"))
844 int abbrev
= git_config_int(var
, value
);
845 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
846 return error("abbrev length out of range: %d", abbrev
);
847 default_abbrev
= abbrev
;
852 if (!strcmp(var
, "core.disambiguate"))
853 return set_disambiguate_hint_config(var
, value
);
855 if (!strcmp(var
, "core.loosecompression")) {
856 int level
= git_config_int(var
, value
);
858 level
= Z_DEFAULT_COMPRESSION
;
859 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
860 die(_("bad zlib compression level %d"), level
);
861 zlib_compression_level
= level
;
862 zlib_compression_seen
= 1;
866 if (!strcmp(var
, "core.compression")) {
867 int level
= git_config_int(var
, value
);
869 level
= Z_DEFAULT_COMPRESSION
;
870 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
871 die(_("bad zlib compression level %d"), level
);
872 core_compression_level
= level
;
873 core_compression_seen
= 1;
874 if (!zlib_compression_seen
)
875 zlib_compression_level
= level
;
876 if (!pack_compression_seen
)
877 pack_compression_level
= level
;
881 if (!strcmp(var
, "core.packedgitwindowsize")) {
882 int pgsz_x2
= getpagesize() * 2;
883 packed_git_window_size
= git_config_ulong(var
, value
);
885 /* This value must be multiple of (pagesize * 2) */
886 packed_git_window_size
/= pgsz_x2
;
887 if (packed_git_window_size
< 1)
888 packed_git_window_size
= 1;
889 packed_git_window_size
*= pgsz_x2
;
893 if (!strcmp(var
, "core.bigfilethreshold")) {
894 big_file_threshold
= git_config_ulong(var
, value
);
898 if (!strcmp(var
, "core.packedgitlimit")) {
899 packed_git_limit
= git_config_ulong(var
, value
);
903 if (!strcmp(var
, "core.deltabasecachelimit")) {
904 delta_base_cache_limit
= git_config_ulong(var
, value
);
908 if (!strcmp(var
, "core.autocrlf")) {
909 if (value
&& !strcasecmp(value
, "input")) {
910 auto_crlf
= AUTO_CRLF_INPUT
;
913 auto_crlf
= git_config_bool(var
, value
);
917 if (!strcmp(var
, "core.safecrlf")) {
918 if (value
&& !strcasecmp(value
, "warn")) {
919 safe_crlf
= SAFE_CRLF_WARN
;
922 safe_crlf
= git_config_bool(var
, value
);
926 if (!strcmp(var
, "core.eol")) {
927 if (value
&& !strcasecmp(value
, "lf"))
929 else if (value
&& !strcasecmp(value
, "crlf"))
931 else if (value
&& !strcasecmp(value
, "native"))
932 core_eol
= EOL_NATIVE
;
934 core_eol
= EOL_UNSET
;
938 if (!strcmp(var
, "core.notesref")) {
939 notes_ref_name
= xstrdup(value
);
943 if (!strcmp(var
, "core.editor"))
944 return git_config_string(&editor_program
, var
, value
);
946 if (!strcmp(var
, "core.commentchar")) {
948 return config_error_nonbool(var
);
949 else if (!strcasecmp(value
, "auto"))
950 auto_comment_line_char
= 1;
951 else if (value
[0] && !value
[1]) {
952 comment_line_char
= value
[0];
953 auto_comment_line_char
= 0;
955 return error("core.commentChar should only be one character");
959 if (!strcmp(var
, "core.askpass"))
960 return git_config_string(&askpass_program
, var
, value
);
962 if (!strcmp(var
, "core.excludesfile"))
963 return git_config_pathname(&excludes_file
, var
, value
);
965 if (!strcmp(var
, "core.whitespace")) {
967 return config_error_nonbool(var
);
968 whitespace_rule_cfg
= parse_whitespace_rule(value
);
972 if (!strcmp(var
, "core.fsyncobjectfiles")) {
973 fsync_object_files
= git_config_bool(var
, value
);
977 if (!strcmp(var
, "core.preloadindex")) {
978 core_preload_index
= git_config_bool(var
, value
);
982 if (!strcmp(var
, "core.createobject")) {
983 if (!strcmp(value
, "rename"))
984 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
985 else if (!strcmp(value
, "link"))
986 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
988 die(_("invalid mode for object creation: %s"), value
);
992 if (!strcmp(var
, "core.sparsecheckout")) {
993 core_apply_sparse_checkout
= git_config_bool(var
, value
);
997 if (!strcmp(var
, "core.precomposeunicode")) {
998 precomposed_unicode
= git_config_bool(var
, value
);
1002 if (!strcmp(var
, "core.protecthfs")) {
1003 protect_hfs
= git_config_bool(var
, value
);
1007 if (!strcmp(var
, "core.protectntfs")) {
1008 protect_ntfs
= git_config_bool(var
, value
);
1012 if (!strcmp(var
, "core.hidedotfiles")) {
1013 if (value
&& !strcasecmp(value
, "dotgitonly"))
1014 hide_dotfiles
= HIDE_DOTFILES_DOTGITONLY
;
1016 hide_dotfiles
= git_config_bool(var
, value
);
1020 /* Add other config variables here and to Documentation/config.txt. */
1024 static int git_default_i18n_config(const char *var
, const char *value
)
1026 if (!strcmp(var
, "i18n.commitencoding"))
1027 return git_config_string(&git_commit_encoding
, var
, value
);
1029 if (!strcmp(var
, "i18n.logoutputencoding"))
1030 return git_config_string(&git_log_output_encoding
, var
, value
);
1032 /* Add other config variables here and to Documentation/config.txt. */
1036 static int git_default_branch_config(const char *var
, const char *value
)
1038 if (!strcmp(var
, "branch.autosetupmerge")) {
1039 if (value
&& !strcasecmp(value
, "always")) {
1040 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1043 git_branch_track
= git_config_bool(var
, value
);
1046 if (!strcmp(var
, "branch.autosetuprebase")) {
1048 return config_error_nonbool(var
);
1049 else if (!strcmp(value
, "never"))
1050 autorebase
= AUTOREBASE_NEVER
;
1051 else if (!strcmp(value
, "local"))
1052 autorebase
= AUTOREBASE_LOCAL
;
1053 else if (!strcmp(value
, "remote"))
1054 autorebase
= AUTOREBASE_REMOTE
;
1055 else if (!strcmp(value
, "always"))
1056 autorebase
= AUTOREBASE_ALWAYS
;
1058 return error("malformed value for %s", var
);
1062 /* Add other config variables here and to Documentation/config.txt. */
1066 static int git_default_push_config(const char *var
, const char *value
)
1068 if (!strcmp(var
, "push.default")) {
1070 return config_error_nonbool(var
);
1071 else if (!strcmp(value
, "nothing"))
1072 push_default
= PUSH_DEFAULT_NOTHING
;
1073 else if (!strcmp(value
, "matching"))
1074 push_default
= PUSH_DEFAULT_MATCHING
;
1075 else if (!strcmp(value
, "simple"))
1076 push_default
= PUSH_DEFAULT_SIMPLE
;
1077 else if (!strcmp(value
, "upstream"))
1078 push_default
= PUSH_DEFAULT_UPSTREAM
;
1079 else if (!strcmp(value
, "tracking")) /* deprecated */
1080 push_default
= PUSH_DEFAULT_UPSTREAM
;
1081 else if (!strcmp(value
, "current"))
1082 push_default
= PUSH_DEFAULT_CURRENT
;
1084 error("malformed value for %s: %s", var
, value
);
1085 return error("Must be one of nothing, matching, simple, "
1086 "upstream or current.");
1091 /* Add other config variables here and to Documentation/config.txt. */
1095 static int git_default_mailmap_config(const char *var
, const char *value
)
1097 if (!strcmp(var
, "mailmap.file"))
1098 return git_config_pathname(&git_mailmap_file
, var
, value
);
1099 if (!strcmp(var
, "mailmap.blob"))
1100 return git_config_string(&git_mailmap_blob
, var
, value
);
1102 /* Add other config variables here and to Documentation/config.txt. */
1106 int git_default_config(const char *var
, const char *value
, void *dummy
)
1108 if (starts_with(var
, "core."))
1109 return git_default_core_config(var
, value
);
1111 if (starts_with(var
, "user."))
1112 return git_ident_config(var
, value
, dummy
);
1114 if (starts_with(var
, "i18n."))
1115 return git_default_i18n_config(var
, value
);
1117 if (starts_with(var
, "branch."))
1118 return git_default_branch_config(var
, value
);
1120 if (starts_with(var
, "push."))
1121 return git_default_push_config(var
, value
);
1123 if (starts_with(var
, "mailmap."))
1124 return git_default_mailmap_config(var
, value
);
1126 if (starts_with(var
, "advice."))
1127 return git_default_advice_config(var
, value
);
1129 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1130 pager_use_color
= git_config_bool(var
,value
);
1134 if (!strcmp(var
, "pack.packsizelimit")) {
1135 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1139 if (!strcmp(var
, "pack.compression")) {
1140 int level
= git_config_int(var
, value
);
1142 level
= Z_DEFAULT_COMPRESSION
;
1143 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1144 die(_("bad pack compression level %d"), level
);
1145 pack_compression_level
= level
;
1146 pack_compression_seen
= 1;
1150 /* Add other config variables here and to Documentation/config.txt. */
1155 * All source specific fields in the union, die_on_error, name and the callbacks
1156 * fgetc, ungetc, ftell of top need to be initialized before calling
1159 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1163 /* push config-file parsing state stack */
1167 strbuf_init(&top
->value
, 1024);
1168 strbuf_init(&top
->var
, 1024);
1171 ret
= git_parse_source(fn
, data
);
1173 /* pop config-file parsing state stack */
1174 strbuf_release(&top
->value
);
1175 strbuf_release(&top
->var
);
1181 static int do_config_from_file(config_fn_t fn
,
1182 const enum config_origin_type origin_type
,
1183 const char *name
, const char *path
, FILE *f
,
1186 struct config_source top
;
1189 top
.origin_type
= origin_type
;
1192 top
.die_on_error
= 1;
1193 top
.do_fgetc
= config_file_fgetc
;
1194 top
.do_ungetc
= config_file_ungetc
;
1195 top
.do_ftell
= config_file_ftell
;
1197 return do_config_from(&top
, fn
, data
);
1200 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1202 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
, data
);
1205 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1210 f
= fopen(filename
, "r");
1213 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
, filename
, f
, data
);
1220 int git_config_from_mem(config_fn_t fn
, const enum config_origin_type origin_type
,
1221 const char *name
, const char *buf
, size_t len
, void *data
)
1223 struct config_source top
;
1225 top
.u
.buf
.buf
= buf
;
1226 top
.u
.buf
.len
= len
;
1228 top
.origin_type
= origin_type
;
1231 top
.die_on_error
= 0;
1232 top
.do_fgetc
= config_buf_fgetc
;
1233 top
.do_ungetc
= config_buf_ungetc
;
1234 top
.do_ftell
= config_buf_ftell
;
1236 return do_config_from(&top
, fn
, data
);
1239 static int git_config_from_blob_sha1(config_fn_t fn
,
1241 const unsigned char *sha1
,
1244 enum object_type type
;
1249 buf
= read_sha1_file(sha1
, &type
, &size
);
1251 return error("unable to load config blob object '%s'", name
);
1252 if (type
!= OBJ_BLOB
) {
1254 return error("reference '%s' does not point to a blob", name
);
1257 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
, data
);
1263 static int git_config_from_blob_ref(config_fn_t fn
,
1267 unsigned char sha1
[20];
1269 if (get_sha1(name
, sha1
) < 0)
1270 return error("unable to resolve config blob '%s'", name
);
1271 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1274 const char *git_etc_gitconfig(void)
1276 static const char *system_wide
;
1278 system_wide
= system_path(ETC_GITCONFIG
);
1283 * Parse environment variable 'k' as a boolean (in various
1284 * possible spellings); if missing, use the default value 'def'.
1286 int git_env_bool(const char *k
, int def
)
1288 const char *v
= getenv(k
);
1289 return v
? git_config_bool(k
, v
) : def
;
1293 * Parse environment variable 'k' as ulong with possibly a unit
1294 * suffix; if missing, use the default value 'val'.
1296 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1298 const char *v
= getenv(k
);
1299 if (v
&& !git_parse_ulong(v
, &val
))
1300 die("failed to parse %s", k
);
1304 int git_config_system(void)
1306 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1309 static int do_git_config_sequence(config_fn_t fn
, void *data
)
1312 char *xdg_config
= xdg_config_home("config");
1313 char *user_config
= expand_user_path("~/.gitconfig");
1314 char *repo_config
= have_git_dir() ? git_pathdup("config") : NULL
;
1316 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1317 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0))
1318 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1321 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1322 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1323 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1325 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1326 ret
+= git_config_from_file(fn
, user_config
, data
);
1328 current_parsing_scope
= CONFIG_SCOPE_REPO
;
1329 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0))
1330 ret
+= git_config_from_file(fn
, repo_config
, data
);
1332 current_parsing_scope
= CONFIG_SCOPE_CMDLINE
;
1333 if (git_config_from_parameters(fn
, data
) < 0)
1334 die(_("unable to parse command-line config"));
1336 current_parsing_scope
= CONFIG_SCOPE_UNKNOWN
;
1343 int git_config_with_options(config_fn_t fn
, void *data
,
1344 struct git_config_source
*config_source
,
1345 int respect_includes
)
1347 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1349 if (respect_includes
) {
1352 fn
= git_config_include
;
1357 * If we have a specific filename, use it. Otherwise, follow the
1358 * regular lookup sequence.
1360 if (config_source
&& config_source
->use_stdin
)
1361 return git_config_from_stdin(fn
, data
);
1362 else if (config_source
&& config_source
->file
)
1363 return git_config_from_file(fn
, config_source
->file
, data
);
1364 else if (config_source
&& config_source
->blob
)
1365 return git_config_from_blob_ref(fn
, config_source
->blob
, data
);
1367 return do_git_config_sequence(fn
, data
);
1370 static void git_config_raw(config_fn_t fn
, void *data
)
1372 if (git_config_with_options(fn
, data
, NULL
, 1) < 0)
1374 * git_config_with_options() normally returns only
1375 * zero, as most errors are fatal, and
1376 * non-fatal potential errors are guarded by "if"
1377 * statements that are entered only when no error is
1380 * If we ever encounter a non-fatal error, it means
1381 * something went really wrong and we should stop
1384 die(_("unknown error occurred while reading the configuration files"));
1387 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1390 struct string_list
*values
;
1391 struct config_set_element
*entry
;
1392 struct configset_list
*list
= &cs
->list
;
1394 for (i
= 0; i
< list
->nr
; i
++) {
1395 entry
= list
->items
[i
].e
;
1396 value_index
= list
->items
[i
].value_index
;
1397 values
= &entry
->value_list
;
1399 current_config_kvi
= values
->items
[value_index
].util
;
1401 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1402 git_die_config_linenr(entry
->key
,
1403 current_config_kvi
->filename
,
1404 current_config_kvi
->linenr
);
1406 current_config_kvi
= NULL
;
1410 static void git_config_check_init(void);
1412 void git_config(config_fn_t fn
, void *data
)
1414 git_config_check_init();
1415 configset_iter(&the_config_set
, fn
, data
);
1418 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
1420 struct config_set_element k
;
1421 struct config_set_element
*found_entry
;
1422 char *normalized_key
;
1424 * `key` may come from the user, so normalize it before using it
1425 * for querying entries from the hashmap.
1427 if (git_config_parse_key(key
, &normalized_key
, NULL
))
1430 hashmap_entry_init(&k
, strhash(normalized_key
));
1431 k
.key
= normalized_key
;
1432 found_entry
= hashmap_get(&cs
->config_hash
, &k
, NULL
);
1433 free(normalized_key
);
1437 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
1439 struct config_set_element
*e
;
1440 struct string_list_item
*si
;
1441 struct configset_list_item
*l_item
;
1442 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
1444 e
= configset_find_element(cs
, key
);
1446 * Since the keys are being fed by git_config*() callback mechanism, they
1447 * are already normalized. So simply add them without any further munging.
1450 e
= xmalloc(sizeof(*e
));
1451 hashmap_entry_init(e
, strhash(key
));
1452 e
->key
= xstrdup(key
);
1453 string_list_init(&e
->value_list
, 1);
1454 hashmap_add(&cs
->config_hash
, e
);
1456 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
1458 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
1459 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
1461 l_item
->value_index
= e
->value_list
.nr
- 1;
1464 die("BUG: configset_add_value has no source");
1466 kv_info
->filename
= strintern(cf
->name
);
1467 kv_info
->linenr
= cf
->linenr
;
1468 kv_info
->origin_type
= cf
->origin_type
;
1470 /* for values read from `git_config_from_parameters()` */
1471 kv_info
->filename
= NULL
;
1472 kv_info
->linenr
= -1;
1473 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
1475 kv_info
->scope
= current_parsing_scope
;
1481 static int config_set_element_cmp(const struct config_set_element
*e1
,
1482 const struct config_set_element
*e2
, const void *unused
)
1484 return strcmp(e1
->key
, e2
->key
);
1487 void git_configset_init(struct config_set
*cs
)
1489 hashmap_init(&cs
->config_hash
, (hashmap_cmp_fn
)config_set_element_cmp
, 0);
1490 cs
->hash_initialized
= 1;
1493 cs
->list
.items
= NULL
;
1496 void git_configset_clear(struct config_set
*cs
)
1498 struct config_set_element
*entry
;
1499 struct hashmap_iter iter
;
1500 if (!cs
->hash_initialized
)
1503 hashmap_iter_init(&cs
->config_hash
, &iter
);
1504 while ((entry
= hashmap_iter_next(&iter
))) {
1506 string_list_clear(&entry
->value_list
, 1);
1508 hashmap_free(&cs
->config_hash
, 1);
1509 cs
->hash_initialized
= 0;
1510 free(cs
->list
.items
);
1513 cs
->list
.items
= NULL
;
1516 static int config_set_callback(const char *key
, const char *value
, void *cb
)
1518 struct config_set
*cs
= cb
;
1519 configset_add_value(cs
, key
, value
);
1523 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
1525 return git_config_from_file(config_set_callback
, filename
, cs
);
1528 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
1530 const struct string_list
*values
= NULL
;
1532 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1533 * queried key in the files of the configset, the value returned will be the last
1534 * value in the value list for that key.
1536 values
= git_configset_get_value_multi(cs
, key
);
1540 assert(values
->nr
> 0);
1541 *value
= values
->items
[values
->nr
- 1].string
;
1545 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
1547 struct config_set_element
*e
= configset_find_element(cs
, key
);
1548 return e
? &e
->value_list
: NULL
;
1551 int git_configset_get_string_const(struct config_set
*cs
, const char *key
, const char **dest
)
1554 if (!git_configset_get_value(cs
, key
, &value
))
1555 return git_config_string(dest
, key
, value
);
1560 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
1562 return git_configset_get_string_const(cs
, key
, (const char **)dest
);
1565 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
1568 if (!git_configset_get_value(cs
, key
, &value
)) {
1569 *dest
= git_config_int(key
, value
);
1575 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
1578 if (!git_configset_get_value(cs
, key
, &value
)) {
1579 *dest
= git_config_ulong(key
, value
);
1585 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
1588 if (!git_configset_get_value(cs
, key
, &value
)) {
1589 *dest
= git_config_bool(key
, value
);
1595 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
1596 int *is_bool
, int *dest
)
1599 if (!git_configset_get_value(cs
, key
, &value
)) {
1600 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
1606 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
1609 if (!git_configset_get_value(cs
, key
, &value
)) {
1610 *dest
= git_config_maybe_bool(key
, value
);
1618 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
1621 if (!git_configset_get_value(cs
, key
, &value
))
1622 return git_config_pathname(dest
, key
, value
);
1627 static void git_config_check_init(void)
1629 if (the_config_set
.hash_initialized
)
1631 git_configset_init(&the_config_set
);
1632 git_config_raw(config_set_callback
, &the_config_set
);
1635 void git_config_clear(void)
1637 if (!the_config_set
.hash_initialized
)
1639 git_configset_clear(&the_config_set
);
1642 int git_config_get_value(const char *key
, const char **value
)
1644 git_config_check_init();
1645 return git_configset_get_value(&the_config_set
, key
, value
);
1648 const struct string_list
*git_config_get_value_multi(const char *key
)
1650 git_config_check_init();
1651 return git_configset_get_value_multi(&the_config_set
, key
);
1654 int git_config_get_string_const(const char *key
, const char **dest
)
1657 git_config_check_init();
1658 ret
= git_configset_get_string_const(&the_config_set
, key
, dest
);
1660 git_die_config(key
, NULL
);
1664 int git_config_get_string(const char *key
, char **dest
)
1666 git_config_check_init();
1667 return git_config_get_string_const(key
, (const char **)dest
);
1670 int git_config_get_int(const char *key
, int *dest
)
1672 git_config_check_init();
1673 return git_configset_get_int(&the_config_set
, key
, dest
);
1676 int git_config_get_ulong(const char *key
, unsigned long *dest
)
1678 git_config_check_init();
1679 return git_configset_get_ulong(&the_config_set
, key
, dest
);
1682 int git_config_get_bool(const char *key
, int *dest
)
1684 git_config_check_init();
1685 return git_configset_get_bool(&the_config_set
, key
, dest
);
1688 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
1690 git_config_check_init();
1691 return git_configset_get_bool_or_int(&the_config_set
, key
, is_bool
, dest
);
1694 int git_config_get_maybe_bool(const char *key
, int *dest
)
1696 git_config_check_init();
1697 return git_configset_get_maybe_bool(&the_config_set
, key
, dest
);
1700 int git_config_get_pathname(const char *key
, const char **dest
)
1703 git_config_check_init();
1704 ret
= git_configset_get_pathname(&the_config_set
, key
, dest
);
1706 git_die_config(key
, NULL
);
1710 int git_config_get_untracked_cache(void)
1715 /* Hack for test programs like test-dump-untracked-cache */
1716 if (ignore_untracked_cache_config
)
1719 if (!git_config_get_maybe_bool("core.untrackedcache", &val
))
1722 if (!git_config_get_value("core.untrackedcache", &v
)) {
1723 if (!strcasecmp(v
, "keep"))
1726 error("unknown core.untrackedCache value '%s'; "
1727 "using 'keep' default value", v
);
1731 return -1; /* default value */
1735 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
1738 die(_("unable to parse '%s' from command-line config"), key
);
1740 die(_("bad config variable '%s' in file '%s' at line %d"),
1741 key
, filename
, linenr
);
1744 NORETURN
__attribute__((format(printf
, 2, 3)))
1745 void git_die_config(const char *key
, const char *err
, ...)
1747 const struct string_list
*values
;
1748 struct key_value_info
*kv_info
;
1752 va_start(params
, err
);
1753 vreportf("error: ", err
, params
);
1756 values
= git_config_get_value_multi(key
);
1757 kv_info
= values
->items
[values
->nr
- 1].util
;
1758 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
1762 * Find all the stuff for git_config_set() below.
1769 regex_t
*value_regex
;
1772 unsigned int offset_alloc
;
1773 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1777 static int matches(const char *key
, const char *value
)
1779 if (strcmp(key
, store
.key
))
1780 return 0; /* not ours */
1781 if (!store
.value_regex
)
1782 return 1; /* always matches */
1783 if (store
.value_regex
== CONFIG_REGEX_NONE
)
1784 return 0; /* never matches */
1786 return store
.do_not_match
^
1787 (value
&& !regexec(store
.value_regex
, value
, 0, NULL
, 0));
1790 static int store_aux(const char *key
, const char *value
, void *cb
)
1795 switch (store
.state
) {
1797 if (matches(key
, value
)) {
1798 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1799 warning(_("%s has multiple values"), key
);
1802 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1803 store
.offset_alloc
);
1805 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1811 * What we are looking for is in store.key (both
1812 * section and var), and its section part is baselen
1813 * long. We found key (again, both section and var).
1814 * We would want to know if this key is in the same
1815 * section as what we are looking for. We already
1816 * know we are in the same section as what should
1819 ep
= strrchr(key
, '.');
1820 section_len
= ep
- key
;
1822 if ((section_len
!= store
.baselen
) ||
1823 memcmp(key
, store
.key
, section_len
+1)) {
1824 store
.state
= SECTION_END_SEEN
;
1829 * Do not increment matches: this is no match, but we
1830 * just made sure we are in the desired section.
1832 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1833 store
.offset_alloc
);
1834 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1836 case SECTION_END_SEEN
:
1838 if (matches(key
, value
)) {
1839 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1840 store
.offset_alloc
);
1841 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1842 store
.state
= KEY_SEEN
;
1845 if (strrchr(key
, '.') - key
== store
.baselen
&&
1846 !strncmp(key
, store
.key
, store
.baselen
)) {
1847 store
.state
= SECTION_SEEN
;
1848 ALLOC_GROW(store
.offset
,
1850 store
.offset_alloc
);
1851 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1858 static int write_error(const char *filename
)
1860 error("failed to write new configuration file %s", filename
);
1862 /* Same error code as "failed to rename". */
1866 static int store_write_section(int fd
, const char *key
)
1870 struct strbuf sb
= STRBUF_INIT
;
1872 dot
= memchr(key
, '.', store
.baselen
);
1874 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1875 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1876 if (key
[i
] == '"' || key
[i
] == '\\')
1877 strbuf_addch(&sb
, '\\');
1878 strbuf_addch(&sb
, key
[i
]);
1880 strbuf_addstr(&sb
, "\"]\n");
1882 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1885 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1886 strbuf_release(&sb
);
1891 static int store_write_pair(int fd
, const char *key
, const char *value
)
1894 int length
= strlen(key
+ store
.baselen
+ 1);
1895 const char *quote
= "";
1896 struct strbuf sb
= STRBUF_INIT
;
1899 * Check to see if the value needs to be surrounded with a dq pair.
1900 * Note that problematic characters are always backslash-quoted; this
1901 * check is about not losing leading or trailing SP and strings that
1902 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1903 * configuration parser.
1905 if (value
[0] == ' ')
1907 for (i
= 0; value
[i
]; i
++)
1908 if (value
[i
] == ';' || value
[i
] == '#')
1910 if (i
&& value
[i
- 1] == ' ')
1913 strbuf_addf(&sb
, "\t%.*s = %s",
1914 length
, key
+ store
.baselen
+ 1, quote
);
1916 for (i
= 0; value
[i
]; i
++)
1919 strbuf_addstr(&sb
, "\\n");
1922 strbuf_addstr(&sb
, "\\t");
1926 strbuf_addch(&sb
, '\\');
1928 strbuf_addch(&sb
, value
[i
]);
1931 strbuf_addf(&sb
, "%s\n", quote
);
1933 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1934 strbuf_release(&sb
);
1939 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1940 size_t offset_
, int *found_bracket
)
1942 size_t equal_offset
= size
, bracket_offset
= size
;
1946 for (offset
= offset_
-2; offset
> 0
1947 && contents
[offset
] != '\n'; offset
--)
1948 switch (contents
[offset
]) {
1949 case '=': equal_offset
= offset
; break;
1950 case ']': bracket_offset
= offset
; break;
1952 if (offset
> 0 && contents
[offset
-1] == '\\') {
1956 if (bracket_offset
< equal_offset
) {
1958 offset
= bracket_offset
+1;
1965 int git_config_set_in_file_gently(const char *config_filename
,
1966 const char *key
, const char *value
)
1968 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
1971 void git_config_set_in_file(const char *config_filename
,
1972 const char *key
, const char *value
)
1974 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1977 int git_config_set_gently(const char *key
, const char *value
)
1979 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
1982 void git_config_set(const char *key
, const char *value
)
1984 git_config_set_multivar(key
, value
, NULL
, 0);
1988 * Auxiliary function to sanity-check and split the key into the section
1989 * identifier and variable name.
1991 * Returns 0 on success, -1 when there is an invalid character in the key and
1992 * -2 if there is no section name in the key.
1994 * store_key - pointer to char* which will hold a copy of the key with
1995 * lowercase section and variable name
1996 * baselen - pointer to int which will hold the length of the
1997 * section + subsection part, can be NULL
1999 static int git_config_parse_key_1(const char *key
, char **store_key
, int *baselen_
, int quiet
)
2001 int i
, dot
, baselen
;
2002 const char *last_dot
= strrchr(key
, '.');
2005 * Since "key" actually contains the section name and the real
2006 * key name separated by a dot, we have to know where the dot is.
2009 if (last_dot
== NULL
|| last_dot
== key
) {
2011 error("key does not contain a section: %s", key
);
2012 return -CONFIG_NO_SECTION_OR_NAME
;
2017 error("key does not contain variable name: %s", key
);
2018 return -CONFIG_NO_SECTION_OR_NAME
;
2021 baselen
= last_dot
- key
;
2023 *baselen_
= baselen
;
2026 * Validate the key and while at it, lower case it for matching.
2029 *store_key
= xmallocz(strlen(key
));
2032 for (i
= 0; key
[i
]; i
++) {
2033 unsigned char c
= key
[i
];
2036 /* Leave the extended basename untouched.. */
2037 if (!dot
|| i
> baselen
) {
2038 if (!iskeychar(c
) ||
2039 (i
== baselen
+ 1 && !isalpha(c
))) {
2041 error("invalid key: %s", key
);
2042 goto out_free_ret_1
;
2045 } else if (c
== '\n') {
2047 error("invalid key (newline): %s", key
);
2048 goto out_free_ret_1
;
2051 (*store_key
)[i
] = c
;
2061 return -CONFIG_INVALID_KEY
;
2064 int git_config_parse_key(const char *key
, char **store_key
, int *baselen
)
2066 return git_config_parse_key_1(key
, store_key
, baselen
, 0);
2069 int git_config_key_is_valid(const char *key
)
2071 return !git_config_parse_key_1(key
, NULL
, NULL
, 1);
2075 * If value==NULL, unset in (remove from) config,
2076 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2077 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2078 * (only add a new one)
2079 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2080 * else all matching key/values (regardless how many) are removed,
2081 * before the new pair is written.
2083 * Returns 0 on success.
2085 * This function does this:
2087 * - it locks the config file by creating ".git/config.lock"
2089 * - it then parses the config using store_aux() as validator to find
2090 * the position on the key/value pair to replace. If it is to be unset,
2091 * it must be found exactly once.
2093 * - the config file is mmap()ed and the part before the match (if any) is
2094 * written to the lock file, then the changed part and the rest.
2096 * - the config file is removed and the lock file rename()d to it.
2099 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2100 const char *key
, const char *value
,
2101 const char *value_regex
,
2104 int fd
= -1, in_fd
= -1;
2106 struct lock_file
*lock
= NULL
;
2107 char *filename_buf
= NULL
;
2108 char *contents
= NULL
;
2111 /* parse-key returns negative; flip the sign to feed exit(3) */
2112 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2116 store
.multi_replace
= multi_replace
;
2118 if (!config_filename
)
2119 config_filename
= filename_buf
= git_pathdup("config");
2122 * The lock serves a purpose in addition to locking: the new
2123 * contents of .git/config will be written into it.
2125 lock
= xcalloc(1, sizeof(struct lock_file
));
2126 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2128 error_errno("could not lock config file %s", config_filename
);
2130 ret
= CONFIG_NO_LOCK
;
2135 * If .git/config does not exist yet, write a minimal version.
2137 in_fd
= open(config_filename
, O_RDONLY
);
2141 if ( ENOENT
!= errno
) {
2142 error_errno("opening %s", config_filename
);
2143 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2146 /* if nothing to unset, error out */
2147 if (value
== NULL
) {
2148 ret
= CONFIG_NOTHING_SET
;
2152 store
.key
= (char *)key
;
2153 if (!store_write_section(fd
, key
) ||
2154 !store_write_pair(fd
, key
, value
))
2158 size_t copy_begin
, copy_end
;
2159 int i
, new_line
= 0;
2161 if (value_regex
== NULL
)
2162 store
.value_regex
= NULL
;
2163 else if (value_regex
== CONFIG_REGEX_NONE
)
2164 store
.value_regex
= CONFIG_REGEX_NONE
;
2166 if (value_regex
[0] == '!') {
2167 store
.do_not_match
= 1;
2170 store
.do_not_match
= 0;
2172 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
2173 if (regcomp(store
.value_regex
, value_regex
,
2175 error("invalid pattern: %s", value_regex
);
2176 free(store
.value_regex
);
2177 ret
= CONFIG_INVALID_PATTERN
;
2182 ALLOC_GROW(store
.offset
, 1, store
.offset_alloc
);
2183 store
.offset
[0] = 0;
2184 store
.state
= START
;
2188 * After this, store.offset will contain the *end* offset
2189 * of the last match, or remain at 0 if no match was found.
2190 * As a side effect, we make sure to transform only a valid
2191 * existing config file.
2193 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
2194 error("invalid config file %s", config_filename
);
2196 if (store
.value_regex
!= NULL
&&
2197 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2198 regfree(store
.value_regex
);
2199 free(store
.value_regex
);
2201 ret
= CONFIG_INVALID_FILE
;
2206 if (store
.value_regex
!= NULL
&&
2207 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2208 regfree(store
.value_regex
);
2209 free(store
.value_regex
);
2212 /* if nothing to unset, or too many matches, error out */
2213 if ((store
.seen
== 0 && value
== NULL
) ||
2214 (store
.seen
> 1 && multi_replace
== 0)) {
2215 ret
= CONFIG_NOTHING_SET
;
2219 if (fstat(in_fd
, &st
) == -1) {
2220 error_errno(_("fstat on %s failed"), config_filename
);
2221 ret
= CONFIG_INVALID_FILE
;
2225 contents_sz
= xsize_t(st
.st_size
);
2226 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
2227 MAP_PRIVATE
, in_fd
, 0);
2228 if (contents
== MAP_FAILED
) {
2229 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
2231 error_errno("unable to mmap '%s'", config_filename
);
2232 ret
= CONFIG_INVALID_FILE
;
2239 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2240 error_errno("chmod on %s failed", get_lock_file_path(lock
));
2241 ret
= CONFIG_NO_WRITE
;
2245 if (store
.seen
== 0)
2248 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
2249 if (store
.offset
[i
] == 0) {
2250 store
.offset
[i
] = copy_end
= contents_sz
;
2251 } else if (store
.state
!= KEY_SEEN
) {
2252 copy_end
= store
.offset
[i
];
2254 copy_end
= find_beginning_of_line(
2255 contents
, contents_sz
,
2256 store
.offset
[i
]-2, &new_line
);
2258 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
2261 /* write the first part of the config */
2262 if (copy_end
> copy_begin
) {
2263 if (write_in_full(fd
, contents
+ copy_begin
,
2264 copy_end
- copy_begin
) <
2265 copy_end
- copy_begin
)
2268 write_str_in_full(fd
, "\n") != 1)
2271 copy_begin
= store
.offset
[i
];
2274 /* write the pair (value == NULL means unset) */
2275 if (value
!= NULL
) {
2276 if (store
.state
== START
) {
2277 if (!store_write_section(fd
, key
))
2280 if (!store_write_pair(fd
, key
, value
))
2284 /* write the rest of the config */
2285 if (copy_begin
< contents_sz
)
2286 if (write_in_full(fd
, contents
+ copy_begin
,
2287 contents_sz
- copy_begin
) <
2288 contents_sz
- copy_begin
)
2291 munmap(contents
, contents_sz
);
2295 if (commit_lock_file(lock
) < 0) {
2296 error_errno("could not write config file %s", config_filename
);
2297 ret
= CONFIG_NO_WRITE
;
2303 * lock is committed, so don't try to roll it back below.
2304 * NOTE: Since lockfile.c keeps a linked list of all created
2305 * lock_file structures, it isn't safe to free(lock). It's
2306 * better to just leave it hanging around.
2311 /* Invalidate the config cache */
2316 rollback_lock_file(lock
);
2319 munmap(contents
, contents_sz
);
2325 ret
= write_error(get_lock_file_path(lock
));
2330 void git_config_set_multivar_in_file(const char *config_filename
,
2331 const char *key
, const char *value
,
2332 const char *value_regex
, int multi_replace
)
2334 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
2335 value_regex
, multi_replace
))
2338 die(_("could not set '%s' to '%s'"), key
, value
);
2340 die(_("could not unset '%s'"), key
);
2343 int git_config_set_multivar_gently(const char *key
, const char *value
,
2344 const char *value_regex
, int multi_replace
)
2346 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_regex
,
2350 void git_config_set_multivar(const char *key
, const char *value
,
2351 const char *value_regex
, int multi_replace
)
2353 git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
2357 static int section_name_match (const char *buf
, const char *name
)
2359 int i
= 0, j
= 0, dot
= 0;
2362 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
2363 if (!dot
&& isspace(buf
[i
])) {
2365 if (name
[j
++] != '.')
2367 for (i
++; isspace(buf
[i
]); i
++)
2373 if (buf
[i
] == '\\' && dot
)
2375 else if (buf
[i
] == '"' && dot
) {
2376 for (i
++; isspace(buf
[i
]); i
++)
2380 if (buf
[i
] != name
[j
++])
2383 if (buf
[i
] == ']' && name
[j
] == 0) {
2385 * We match, now just find the right length offset by
2386 * gobbling up any whitespace after it, as well
2389 for (; buf
[i
] && isspace(buf
[i
]); i
++)
2396 static int section_name_is_ok(const char *name
)
2398 /* Empty section names are bogus. */
2403 * Before a dot, we must be alphanumeric or dash. After the first dot,
2404 * anything goes, so we can stop checking.
2406 for (; *name
&& *name
!= '.'; name
++)
2407 if (*name
!= '-' && !isalnum(*name
))
2412 /* if new_name == NULL, the section is removed instead */
2413 int git_config_rename_section_in_file(const char *config_filename
,
2414 const char *old_name
, const char *new_name
)
2416 int ret
= 0, remove
= 0;
2417 char *filename_buf
= NULL
;
2418 struct lock_file
*lock
;
2424 if (new_name
&& !section_name_is_ok(new_name
)) {
2425 ret
= error("invalid section name: %s", new_name
);
2426 goto out_no_rollback
;
2429 if (!config_filename
)
2430 config_filename
= filename_buf
= git_pathdup("config");
2432 lock
= xcalloc(1, sizeof(struct lock_file
));
2433 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2435 ret
= error("could not lock config file %s", config_filename
);
2439 if (!(config_file
= fopen(config_filename
, "rb"))) {
2440 /* no config file means nothing to rename, no error */
2441 goto commit_and_out
;
2444 if (fstat(fileno(config_file
), &st
) == -1) {
2445 ret
= error_errno(_("fstat on %s failed"), config_filename
);
2449 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2450 ret
= error_errno("chmod on %s failed",
2451 get_lock_file_path(lock
));
2455 while (fgets(buf
, sizeof(buf
), config_file
)) {
2459 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
2461 if (buf
[i
] == '[') {
2462 /* it's a section */
2463 int offset
= section_name_match(&buf
[i
], old_name
);
2466 if (new_name
== NULL
) {
2470 store
.baselen
= strlen(new_name
);
2471 if (!store_write_section(out_fd
, new_name
)) {
2472 ret
= write_error(get_lock_file_path(lock
));
2476 * We wrote out the new section, with
2477 * a newline, now skip the old
2480 output
+= offset
+ i
;
2481 if (strlen(output
) > 0) {
2483 * More content means there's
2484 * a declaration to put on the
2485 * next line; indent with a
2496 length
= strlen(output
);
2497 if (write_in_full(out_fd
, output
, length
) != length
) {
2498 ret
= write_error(get_lock_file_path(lock
));
2502 fclose(config_file
);
2504 if (commit_lock_file(lock
) < 0)
2505 ret
= error_errno("could not write config file %s",
2508 rollback_lock_file(lock
);
2514 int git_config_rename_section(const char *old_name
, const char *new_name
)
2516 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
2520 * Call this to report error for your variable that should not
2521 * get a boolean value (i.e. "[my] var" means "true").
2523 #undef config_error_nonbool
2524 int config_error_nonbool(const char *var
)
2526 return error("missing value for '%s'", var
);
2529 int parse_config_key(const char *var
,
2530 const char *section
,
2531 const char **subsection
, int *subsection_len
,
2534 int section_len
= strlen(section
);
2537 /* Does it start with "section." ? */
2538 if (!starts_with(var
, section
) || var
[section_len
] != '.')
2542 * Find the key; we don't know yet if we have a subsection, but we must
2543 * parse backwards from the end, since the subsection may have dots in
2546 dot
= strrchr(var
, '.');
2549 /* Did we have a subsection at all? */
2550 if (dot
== var
+ section_len
) {
2552 *subsection_len
= 0;
2555 *subsection
= var
+ section_len
+ 1;
2556 *subsection_len
= dot
- *subsection
;
2562 const char *current_config_origin_type(void)
2565 if (current_config_kvi
)
2566 type
= current_config_kvi
->origin_type
;
2568 type
= cf
->origin_type
;
2570 die("BUG: current_config_origin_type called outside config callback");
2573 case CONFIG_ORIGIN_BLOB
:
2575 case CONFIG_ORIGIN_FILE
:
2577 case CONFIG_ORIGIN_STDIN
:
2578 return "standard input";
2579 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
2580 return "submodule-blob";
2581 case CONFIG_ORIGIN_CMDLINE
:
2582 return "command line";
2584 die("BUG: unknown config origin type");
2588 const char *current_config_name(void)
2591 if (current_config_kvi
)
2592 name
= current_config_kvi
->filename
;
2596 die("BUG: current_config_name called outside config callback");
2597 return name
? name
: "";
2600 enum config_scope
current_config_scope(void)
2602 if (current_config_kvi
)
2603 return current_config_kvi
->scope
;
2605 return current_parsing_scope
;