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 zlib_compression_seen
;
72 * Default config_set that contains key-value pairs from the usual set of config
73 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
74 * config file and the global /etc/gitconfig)
76 static struct config_set the_config_set
;
78 static int config_file_fgetc(struct config_source
*conf
)
80 return getc_unlocked(conf
->u
.file
);
83 static int config_file_ungetc(int c
, struct config_source
*conf
)
85 return ungetc(c
, conf
->u
.file
);
88 static long config_file_ftell(struct config_source
*conf
)
90 return ftell(conf
->u
.file
);
94 static int config_buf_fgetc(struct config_source
*conf
)
96 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
97 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
102 static int config_buf_ungetc(int c
, struct config_source
*conf
)
104 if (conf
->u
.buf
.pos
> 0) {
106 if (conf
->u
.buf
.buf
[conf
->u
.buf
.pos
] != c
)
107 die("BUG: config_buf can only ungetc the same character");
114 static long config_buf_ftell(struct config_source
*conf
)
116 return conf
->u
.buf
.pos
;
119 #define MAX_INCLUDE_DEPTH 10
120 static const char include_depth_advice
[] =
121 "exceeded maximum include depth (%d) while including\n"
125 "Do you have circular includes?";
126 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
129 struct strbuf buf
= STRBUF_INIT
;
133 return config_error_nonbool("include.path");
135 expanded
= expand_user_path(path
);
137 return error("could not expand include path '%s'", path
);
141 * Use an absolute path as-is, but interpret relative paths
142 * based on the including config file.
144 if (!is_absolute_path(path
)) {
147 if (!cf
|| !cf
->path
)
148 return error("relative config includes must come from files");
150 slash
= find_last_dir_sep(cf
->path
);
152 strbuf_add(&buf
, cf
->path
, slash
- cf
->path
+ 1);
153 strbuf_addstr(&buf
, path
);
157 if (!access_or_die(path
, R_OK
, 0)) {
158 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
159 die(include_depth_advice
, MAX_INCLUDE_DEPTH
, path
,
161 cf
->name
? cf
->name
:
163 ret
= git_config_from_file(git_config_include
, path
, inc
);
166 strbuf_release(&buf
);
171 int git_config_include(const char *var
, const char *value
, void *data
)
173 struct config_include_data
*inc
= data
;
177 * Pass along all values, including "include" directives; this makes it
178 * possible to query information on the includes themselves.
180 ret
= inc
->fn(var
, value
, inc
->data
);
184 if (!strcmp(var
, "include.path"))
185 ret
= handle_path_include(value
, inc
);
189 void git_config_push_parameter(const char *text
)
191 struct strbuf env
= STRBUF_INIT
;
192 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
194 strbuf_addstr(&env
, old
);
195 strbuf_addch(&env
, ' ');
197 sq_quote_buf(&env
, text
);
198 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
199 strbuf_release(&env
);
202 int git_config_parse_parameter(const char *text
,
203 config_fn_t fn
, void *data
)
206 struct strbuf
**pair
;
208 pair
= strbuf_split_str(text
, '=', 2);
210 return error("bogus config parameter: %s", text
);
212 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
213 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
214 value
= pair
[1] ? pair
[1]->buf
: "";
219 strbuf_trim(pair
[0]);
221 strbuf_list_free(pair
);
222 return error("bogus config parameter: %s", text
);
224 strbuf_tolower(pair
[0]);
225 if (fn(pair
[0]->buf
, value
, data
) < 0) {
226 strbuf_list_free(pair
);
229 strbuf_list_free(pair
);
233 int git_config_from_parameters(config_fn_t fn
, void *data
)
235 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
238 const char **argv
= NULL
;
239 int nr
= 0, alloc
= 0;
241 struct config_source source
;
246 memset(&source
, 0, sizeof(source
));
248 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
251 /* sq_dequote will write over it */
254 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
255 ret
= error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
259 for (i
= 0; i
< nr
; i
++) {
260 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
273 static int get_next_char(void)
275 int c
= cf
->do_fgetc(cf
);
278 /* DOS like systems */
279 c
= cf
->do_fgetc(cf
);
282 cf
->do_ungetc(c
, cf
);
296 static char *parse_value(void)
298 int quote
= 0, comment
= 0, space
= 0;
300 strbuf_reset(&cf
->value
);
302 int c
= get_next_char();
308 return cf
->value
.buf
;
312 if (isspace(c
) && !quote
) {
318 if (c
== ';' || c
== '#') {
323 for (; space
; space
--)
324 strbuf_addch(&cf
->value
, ' ');
339 /* Some characters escape as themselves */
342 /* Reject unknown escape sequences */
346 strbuf_addch(&cf
->value
, c
);
353 strbuf_addch(&cf
->value
, c
);
357 static inline int iskeychar(int c
)
359 return isalnum(c
) || c
== '-';
362 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
368 /* Get the full name */
375 strbuf_addch(name
, tolower(c
));
378 while (c
== ' ' || c
== '\t')
385 value
= parse_value();
390 * We already consumed the \n, but we need linenr to point to
391 * the line we just parsed during the call to fn to get
392 * accurate line number in error messages.
395 ret
= fn(name
->buf
, value
, data
);
400 static int get_extended_base_var(struct strbuf
*name
, int c
)
404 goto error_incomplete_line
;
406 } while (isspace(c
));
408 /* We require the format to be '[base "extension"]' */
411 strbuf_addch(name
, '.');
414 int c
= get_next_char();
416 goto error_incomplete_line
;
422 goto error_incomplete_line
;
424 strbuf_addch(name
, c
);
428 if (get_next_char() != ']')
431 error_incomplete_line
:
436 static int get_base_var(struct strbuf
*name
)
439 int c
= get_next_char();
445 return get_extended_base_var(name
, c
);
446 if (!iskeychar(c
) && c
!= '.')
448 strbuf_addch(name
, tolower(c
));
452 static int git_parse_source(config_fn_t fn
, void *data
)
456 struct strbuf
*var
= &cf
->var
;
457 int error_return
= 0;
458 char *error_msg
= NULL
;
460 /* U+FEFF Byte Order Mark in UTF8 */
461 const char *bomptr
= utf8_bom
;
464 int c
= get_next_char();
465 if (bomptr
&& *bomptr
) {
466 /* We are at the file beginning; skip UTF8-encoded BOM
467 * if present. Sane editors won't put this in on their
468 * own, but e.g. Windows Notepad will do it happily. */
469 if (c
== (*bomptr
& 0377)) {
473 /* Do not tolerate partial BOM. */
474 if (bomptr
!= utf8_bom
)
476 /* No BOM at file beginning. Cool. */
486 if (comment
|| isspace(c
))
488 if (c
== '#' || c
== ';') {
493 /* Reset prior to determining a new stem */
495 if (get_base_var(var
) < 0 || var
->len
< 1)
497 strbuf_addch(var
, '.');
504 * Truncate the var name back to the section header
505 * stem prior to grabbing the suffix part of the name
508 strbuf_setlen(var
, baselen
);
509 strbuf_addch(var
, tolower(c
));
510 if (get_value(fn
, data
, var
) < 0)
514 switch (cf
->origin_type
) {
515 case CONFIG_ORIGIN_BLOB
:
516 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
517 cf
->linenr
, cf
->name
);
519 case CONFIG_ORIGIN_FILE
:
520 error_msg
= xstrfmt(_("bad config line %d in file %s"),
521 cf
->linenr
, cf
->name
);
523 case CONFIG_ORIGIN_STDIN
:
524 error_msg
= xstrfmt(_("bad config line %d in standard input"),
527 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
528 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
529 cf
->linenr
, cf
->name
);
531 case CONFIG_ORIGIN_CMDLINE
:
532 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
533 cf
->linenr
, cf
->name
);
536 error_msg
= xstrfmt(_("bad config line %d in %s"),
537 cf
->linenr
, cf
->name
);
540 if (cf
->die_on_error
)
541 die("%s", error_msg
);
543 error_return
= error("%s", error_msg
);
549 static int parse_unit_factor(const char *end
, uintmax_t *val
)
553 else if (!strcasecmp(end
, "k")) {
557 else if (!strcasecmp(end
, "m")) {
561 else if (!strcasecmp(end
, "g")) {
562 *val
*= 1024 * 1024 * 1024;
568 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
570 if (value
&& *value
) {
574 uintmax_t factor
= 1;
577 val
= strtoimax(value
, &end
, 0);
580 if (!parse_unit_factor(end
, &factor
)) {
586 if (uval
> max
|| labs(val
) > uval
) {
598 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
600 if (value
&& *value
) {
606 val
= strtoumax(value
, &end
, 0);
610 if (!parse_unit_factor(end
, &val
)) {
614 if (val
> max
|| oldval
> val
) {
625 static int git_parse_int(const char *value
, int *ret
)
628 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
634 static int git_parse_int64(const char *value
, int64_t *ret
)
637 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
643 int git_parse_ulong(const char *value
, unsigned long *ret
)
646 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
653 static void die_bad_number(const char *name
, const char *value
)
655 const char * error_type
= (errno
== ERANGE
)? _("out of range"):_("invalid unit");
660 if (!(cf
&& cf
->name
))
661 die(_("bad numeric config value '%s' for '%s': %s"),
662 value
, name
, error_type
);
664 switch (cf
->origin_type
) {
665 case CONFIG_ORIGIN_BLOB
:
666 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
667 value
, name
, cf
->name
, error_type
);
668 case CONFIG_ORIGIN_FILE
:
669 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
670 value
, name
, cf
->name
, error_type
);
671 case CONFIG_ORIGIN_STDIN
:
672 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
673 value
, name
, error_type
);
674 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
675 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
676 value
, name
, cf
->name
, error_type
);
677 case CONFIG_ORIGIN_CMDLINE
:
678 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
679 value
, name
, cf
->name
, error_type
);
681 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
682 value
, name
, cf
->name
, error_type
);
686 int git_config_int(const char *name
, const char *value
)
689 if (!git_parse_int(value
, &ret
))
690 die_bad_number(name
, value
);
694 int64_t git_config_int64(const char *name
, const char *value
)
697 if (!git_parse_int64(value
, &ret
))
698 die_bad_number(name
, value
);
702 unsigned long git_config_ulong(const char *name
, const char *value
)
705 if (!git_parse_ulong(value
, &ret
))
706 die_bad_number(name
, value
);
710 int git_parse_maybe_bool(const char *value
)
716 if (!strcasecmp(value
, "true")
717 || !strcasecmp(value
, "yes")
718 || !strcasecmp(value
, "on"))
720 if (!strcasecmp(value
, "false")
721 || !strcasecmp(value
, "no")
722 || !strcasecmp(value
, "off"))
727 int git_config_maybe_bool(const char *name
, const char *value
)
729 int v
= git_parse_maybe_bool(value
);
732 if (git_parse_int(value
, &v
))
737 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
739 int v
= git_parse_maybe_bool(value
);
745 return git_config_int(name
, value
);
748 int git_config_bool(const char *name
, const char *value
)
751 return !!git_config_bool_or_int(name
, value
, &discard
);
754 int git_config_string(const char **dest
, const char *var
, const char *value
)
757 return config_error_nonbool(var
);
758 *dest
= xstrdup(value
);
762 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
765 return config_error_nonbool(var
);
766 *dest
= expand_user_path(value
);
768 die(_("failed to expand user dir in: '%s'"), value
);
772 static int git_default_core_config(const char *var
, const char *value
)
774 /* This needs a better name */
775 if (!strcmp(var
, "core.filemode")) {
776 trust_executable_bit
= git_config_bool(var
, value
);
779 if (!strcmp(var
, "core.trustctime")) {
780 trust_ctime
= git_config_bool(var
, value
);
783 if (!strcmp(var
, "core.checkstat")) {
784 if (!strcasecmp(value
, "default"))
786 else if (!strcasecmp(value
, "minimal"))
790 if (!strcmp(var
, "core.quotepath")) {
791 quote_path_fully
= git_config_bool(var
, value
);
795 if (!strcmp(var
, "core.symlinks")) {
796 has_symlinks
= git_config_bool(var
, value
);
800 if (!strcmp(var
, "core.ignorecase")) {
801 ignore_case
= git_config_bool(var
, value
);
805 if (!strcmp(var
, "core.attributesfile"))
806 return git_config_pathname(&git_attributes_file
, var
, value
);
808 if (!strcmp(var
, "core.hookspath"))
809 return git_config_pathname(&git_hooks_path
, var
, value
);
811 if (!strcmp(var
, "core.bare")) {
812 is_bare_repository_cfg
= git_config_bool(var
, value
);
816 if (!strcmp(var
, "core.ignorestat")) {
817 assume_unchanged
= git_config_bool(var
, value
);
821 if (!strcmp(var
, "core.prefersymlinkrefs")) {
822 prefer_symlink_refs
= git_config_bool(var
, value
);
826 if (!strcmp(var
, "core.logallrefupdates")) {
827 log_all_ref_updates
= git_config_bool(var
, value
);
831 if (!strcmp(var
, "core.warnambiguousrefs")) {
832 warn_ambiguous_refs
= git_config_bool(var
, value
);
836 if (!strcmp(var
, "core.abbrev")) {
838 return config_error_nonbool(var
);
839 if (!strcasecmp(value
, "auto"))
842 int abbrev
= git_config_int(var
, value
);
843 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
844 return error("abbrev length out of range: %d", abbrev
);
845 default_abbrev
= abbrev
;
850 if (!strcmp(var
, "core.disambiguate"))
851 return set_disambiguate_hint_config(var
, value
);
853 if (!strcmp(var
, "core.loosecompression")) {
854 int level
= git_config_int(var
, value
);
856 level
= Z_DEFAULT_COMPRESSION
;
857 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
858 die(_("bad zlib compression level %d"), level
);
859 zlib_compression_level
= level
;
860 zlib_compression_seen
= 1;
864 if (!strcmp(var
, "core.compression")) {
865 int level
= git_config_int(var
, value
);
867 level
= Z_DEFAULT_COMPRESSION
;
868 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
869 die(_("bad zlib compression level %d"), level
);
870 core_compression_level
= level
;
871 core_compression_seen
= 1;
872 if (!zlib_compression_seen
)
873 zlib_compression_level
= level
;
877 if (!strcmp(var
, "core.packedgitwindowsize")) {
878 int pgsz_x2
= getpagesize() * 2;
879 packed_git_window_size
= git_config_ulong(var
, value
);
881 /* This value must be multiple of (pagesize * 2) */
882 packed_git_window_size
/= pgsz_x2
;
883 if (packed_git_window_size
< 1)
884 packed_git_window_size
= 1;
885 packed_git_window_size
*= pgsz_x2
;
889 if (!strcmp(var
, "core.bigfilethreshold")) {
890 big_file_threshold
= git_config_ulong(var
, value
);
894 if (!strcmp(var
, "core.packedgitlimit")) {
895 packed_git_limit
= git_config_ulong(var
, value
);
899 if (!strcmp(var
, "core.deltabasecachelimit")) {
900 delta_base_cache_limit
= git_config_ulong(var
, value
);
904 if (!strcmp(var
, "core.autocrlf")) {
905 if (value
&& !strcasecmp(value
, "input")) {
906 auto_crlf
= AUTO_CRLF_INPUT
;
909 auto_crlf
= git_config_bool(var
, value
);
913 if (!strcmp(var
, "core.safecrlf")) {
914 if (value
&& !strcasecmp(value
, "warn")) {
915 safe_crlf
= SAFE_CRLF_WARN
;
918 safe_crlf
= git_config_bool(var
, value
);
922 if (!strcmp(var
, "core.eol")) {
923 if (value
&& !strcasecmp(value
, "lf"))
925 else if (value
&& !strcasecmp(value
, "crlf"))
927 else if (value
&& !strcasecmp(value
, "native"))
928 core_eol
= EOL_NATIVE
;
930 core_eol
= EOL_UNSET
;
934 if (!strcmp(var
, "core.notesref")) {
935 notes_ref_name
= xstrdup(value
);
939 if (!strcmp(var
, "core.editor"))
940 return git_config_string(&editor_program
, var
, value
);
942 if (!strcmp(var
, "core.commentchar")) {
944 return config_error_nonbool(var
);
945 else if (!strcasecmp(value
, "auto"))
946 auto_comment_line_char
= 1;
947 else if (value
[0] && !value
[1]) {
948 comment_line_char
= value
[0];
949 auto_comment_line_char
= 0;
951 return error("core.commentChar should only be one character");
955 if (!strcmp(var
, "core.askpass"))
956 return git_config_string(&askpass_program
, var
, value
);
958 if (!strcmp(var
, "core.excludesfile"))
959 return git_config_pathname(&excludes_file
, var
, value
);
961 if (!strcmp(var
, "core.whitespace")) {
963 return config_error_nonbool(var
);
964 whitespace_rule_cfg
= parse_whitespace_rule(value
);
968 if (!strcmp(var
, "core.fsyncobjectfiles")) {
969 fsync_object_files
= git_config_bool(var
, value
);
973 if (!strcmp(var
, "core.preloadindex")) {
974 core_preload_index
= git_config_bool(var
, value
);
978 if (!strcmp(var
, "core.createobject")) {
979 if (!strcmp(value
, "rename"))
980 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
981 else if (!strcmp(value
, "link"))
982 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
984 die(_("invalid mode for object creation: %s"), value
);
988 if (!strcmp(var
, "core.sparsecheckout")) {
989 core_apply_sparse_checkout
= git_config_bool(var
, value
);
993 if (!strcmp(var
, "core.precomposeunicode")) {
994 precomposed_unicode
= git_config_bool(var
, value
);
998 if (!strcmp(var
, "core.protecthfs")) {
999 protect_hfs
= git_config_bool(var
, value
);
1003 if (!strcmp(var
, "core.protectntfs")) {
1004 protect_ntfs
= git_config_bool(var
, value
);
1008 if (!strcmp(var
, "core.hidedotfiles")) {
1009 if (value
&& !strcasecmp(value
, "dotgitonly"))
1010 hide_dotfiles
= HIDE_DOTFILES_DOTGITONLY
;
1012 hide_dotfiles
= git_config_bool(var
, value
);
1016 /* Add other config variables here and to Documentation/config.txt. */
1020 static int git_default_i18n_config(const char *var
, const char *value
)
1022 if (!strcmp(var
, "i18n.commitencoding"))
1023 return git_config_string(&git_commit_encoding
, var
, value
);
1025 if (!strcmp(var
, "i18n.logoutputencoding"))
1026 return git_config_string(&git_log_output_encoding
, var
, value
);
1028 /* Add other config variables here and to Documentation/config.txt. */
1032 static int git_default_branch_config(const char *var
, const char *value
)
1034 if (!strcmp(var
, "branch.autosetupmerge")) {
1035 if (value
&& !strcasecmp(value
, "always")) {
1036 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1039 git_branch_track
= git_config_bool(var
, value
);
1042 if (!strcmp(var
, "branch.autosetuprebase")) {
1044 return config_error_nonbool(var
);
1045 else if (!strcmp(value
, "never"))
1046 autorebase
= AUTOREBASE_NEVER
;
1047 else if (!strcmp(value
, "local"))
1048 autorebase
= AUTOREBASE_LOCAL
;
1049 else if (!strcmp(value
, "remote"))
1050 autorebase
= AUTOREBASE_REMOTE
;
1051 else if (!strcmp(value
, "always"))
1052 autorebase
= AUTOREBASE_ALWAYS
;
1054 return error("malformed value for %s", var
);
1058 /* Add other config variables here and to Documentation/config.txt. */
1062 static int git_default_push_config(const char *var
, const char *value
)
1064 if (!strcmp(var
, "push.default")) {
1066 return config_error_nonbool(var
);
1067 else if (!strcmp(value
, "nothing"))
1068 push_default
= PUSH_DEFAULT_NOTHING
;
1069 else if (!strcmp(value
, "matching"))
1070 push_default
= PUSH_DEFAULT_MATCHING
;
1071 else if (!strcmp(value
, "simple"))
1072 push_default
= PUSH_DEFAULT_SIMPLE
;
1073 else if (!strcmp(value
, "upstream"))
1074 push_default
= PUSH_DEFAULT_UPSTREAM
;
1075 else if (!strcmp(value
, "tracking")) /* deprecated */
1076 push_default
= PUSH_DEFAULT_UPSTREAM
;
1077 else if (!strcmp(value
, "current"))
1078 push_default
= PUSH_DEFAULT_CURRENT
;
1080 error("malformed value for %s: %s", var
, value
);
1081 return error("Must be one of nothing, matching, simple, "
1082 "upstream or current.");
1087 /* Add other config variables here and to Documentation/config.txt. */
1091 static int git_default_mailmap_config(const char *var
, const char *value
)
1093 if (!strcmp(var
, "mailmap.file"))
1094 return git_config_pathname(&git_mailmap_file
, var
, value
);
1095 if (!strcmp(var
, "mailmap.blob"))
1096 return git_config_string(&git_mailmap_blob
, var
, value
);
1098 /* Add other config variables here and to Documentation/config.txt. */
1102 int git_default_config(const char *var
, const char *value
, void *dummy
)
1104 if (starts_with(var
, "core."))
1105 return git_default_core_config(var
, value
);
1107 if (starts_with(var
, "user."))
1108 return git_ident_config(var
, value
, dummy
);
1110 if (starts_with(var
, "i18n."))
1111 return git_default_i18n_config(var
, value
);
1113 if (starts_with(var
, "branch."))
1114 return git_default_branch_config(var
, value
);
1116 if (starts_with(var
, "push."))
1117 return git_default_push_config(var
, value
);
1119 if (starts_with(var
, "mailmap."))
1120 return git_default_mailmap_config(var
, value
);
1122 if (starts_with(var
, "advice."))
1123 return git_default_advice_config(var
, value
);
1125 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1126 pager_use_color
= git_config_bool(var
,value
);
1130 if (!strcmp(var
, "pack.packsizelimit")) {
1131 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1134 /* Add other config variables here and to Documentation/config.txt. */
1139 * All source specific fields in the union, die_on_error, name and the callbacks
1140 * fgetc, ungetc, ftell of top need to be initialized before calling
1143 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1147 /* push config-file parsing state stack */
1151 strbuf_init(&top
->value
, 1024);
1152 strbuf_init(&top
->var
, 1024);
1155 ret
= git_parse_source(fn
, data
);
1157 /* pop config-file parsing state stack */
1158 strbuf_release(&top
->value
);
1159 strbuf_release(&top
->var
);
1165 static int do_config_from_file(config_fn_t fn
,
1166 const enum config_origin_type origin_type
,
1167 const char *name
, const char *path
, FILE *f
,
1170 struct config_source top
;
1173 top
.origin_type
= origin_type
;
1176 top
.die_on_error
= 1;
1177 top
.do_fgetc
= config_file_fgetc
;
1178 top
.do_ungetc
= config_file_ungetc
;
1179 top
.do_ftell
= config_file_ftell
;
1181 return do_config_from(&top
, fn
, data
);
1184 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1186 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
, data
);
1189 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1194 f
= fopen(filename
, "r");
1197 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
, filename
, f
, data
);
1204 int git_config_from_mem(config_fn_t fn
, const enum config_origin_type origin_type
,
1205 const char *name
, const char *buf
, size_t len
, void *data
)
1207 struct config_source top
;
1209 top
.u
.buf
.buf
= buf
;
1210 top
.u
.buf
.len
= len
;
1212 top
.origin_type
= origin_type
;
1215 top
.die_on_error
= 0;
1216 top
.do_fgetc
= config_buf_fgetc
;
1217 top
.do_ungetc
= config_buf_ungetc
;
1218 top
.do_ftell
= config_buf_ftell
;
1220 return do_config_from(&top
, fn
, data
);
1223 static int git_config_from_blob_sha1(config_fn_t fn
,
1225 const unsigned char *sha1
,
1228 enum object_type type
;
1233 buf
= read_sha1_file(sha1
, &type
, &size
);
1235 return error("unable to load config blob object '%s'", name
);
1236 if (type
!= OBJ_BLOB
) {
1238 return error("reference '%s' does not point to a blob", name
);
1241 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
, data
);
1247 static int git_config_from_blob_ref(config_fn_t fn
,
1251 unsigned char sha1
[20];
1253 if (get_sha1(name
, sha1
) < 0)
1254 return error("unable to resolve config blob '%s'", name
);
1255 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1258 const char *git_etc_gitconfig(void)
1260 static const char *system_wide
;
1262 system_wide
= system_path(ETC_GITCONFIG
);
1267 * Parse environment variable 'k' as a boolean (in various
1268 * possible spellings); if missing, use the default value 'def'.
1270 int git_env_bool(const char *k
, int def
)
1272 const char *v
= getenv(k
);
1273 return v
? git_config_bool(k
, v
) : def
;
1277 * Parse environment variable 'k' as ulong with possibly a unit
1278 * suffix; if missing, use the default value 'val'.
1280 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1282 const char *v
= getenv(k
);
1283 if (v
&& !git_parse_ulong(v
, &val
))
1284 die("failed to parse %s", k
);
1288 int git_config_system(void)
1290 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1293 static int do_git_config_sequence(config_fn_t fn
, void *data
)
1296 char *xdg_config
= xdg_config_home("config");
1297 char *user_config
= expand_user_path("~/.gitconfig");
1298 char *repo_config
= have_git_dir() ? git_pathdup("config") : NULL
;
1300 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1301 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0))
1302 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1305 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1306 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1307 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1309 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1310 ret
+= git_config_from_file(fn
, user_config
, data
);
1312 current_parsing_scope
= CONFIG_SCOPE_REPO
;
1313 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0))
1314 ret
+= git_config_from_file(fn
, repo_config
, data
);
1316 current_parsing_scope
= CONFIG_SCOPE_CMDLINE
;
1317 if (git_config_from_parameters(fn
, data
) < 0)
1318 die(_("unable to parse command-line config"));
1320 current_parsing_scope
= CONFIG_SCOPE_UNKNOWN
;
1327 int git_config_with_options(config_fn_t fn
, void *data
,
1328 struct git_config_source
*config_source
,
1329 int respect_includes
)
1331 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1333 if (respect_includes
) {
1336 fn
= git_config_include
;
1341 * If we have a specific filename, use it. Otherwise, follow the
1342 * regular lookup sequence.
1344 if (config_source
&& config_source
->use_stdin
)
1345 return git_config_from_stdin(fn
, data
);
1346 else if (config_source
&& config_source
->file
)
1347 return git_config_from_file(fn
, config_source
->file
, data
);
1348 else if (config_source
&& config_source
->blob
)
1349 return git_config_from_blob_ref(fn
, config_source
->blob
, data
);
1351 return do_git_config_sequence(fn
, data
);
1354 static void git_config_raw(config_fn_t fn
, void *data
)
1356 if (git_config_with_options(fn
, data
, NULL
, 1) < 0)
1358 * git_config_with_options() normally returns only
1359 * zero, as most errors are fatal, and
1360 * non-fatal potential errors are guarded by "if"
1361 * statements that are entered only when no error is
1364 * If we ever encounter a non-fatal error, it means
1365 * something went really wrong and we should stop
1368 die(_("unknown error occurred while reading the configuration files"));
1371 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1374 struct string_list
*values
;
1375 struct config_set_element
*entry
;
1376 struct configset_list
*list
= &cs
->list
;
1378 for (i
= 0; i
< list
->nr
; i
++) {
1379 entry
= list
->items
[i
].e
;
1380 value_index
= list
->items
[i
].value_index
;
1381 values
= &entry
->value_list
;
1383 current_config_kvi
= values
->items
[value_index
].util
;
1385 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1386 git_die_config_linenr(entry
->key
,
1387 current_config_kvi
->filename
,
1388 current_config_kvi
->linenr
);
1390 current_config_kvi
= NULL
;
1394 static void git_config_check_init(void);
1396 void git_config(config_fn_t fn
, void *data
)
1398 git_config_check_init();
1399 configset_iter(&the_config_set
, fn
, data
);
1402 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
1404 struct config_set_element k
;
1405 struct config_set_element
*found_entry
;
1406 char *normalized_key
;
1408 * `key` may come from the user, so normalize it before using it
1409 * for querying entries from the hashmap.
1411 if (git_config_parse_key(key
, &normalized_key
, NULL
))
1414 hashmap_entry_init(&k
, strhash(normalized_key
));
1415 k
.key
= normalized_key
;
1416 found_entry
= hashmap_get(&cs
->config_hash
, &k
, NULL
);
1417 free(normalized_key
);
1421 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
1423 struct config_set_element
*e
;
1424 struct string_list_item
*si
;
1425 struct configset_list_item
*l_item
;
1426 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
1428 e
= configset_find_element(cs
, key
);
1430 * Since the keys are being fed by git_config*() callback mechanism, they
1431 * are already normalized. So simply add them without any further munging.
1434 e
= xmalloc(sizeof(*e
));
1435 hashmap_entry_init(e
, strhash(key
));
1436 e
->key
= xstrdup(key
);
1437 string_list_init(&e
->value_list
, 1);
1438 hashmap_add(&cs
->config_hash
, e
);
1440 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
1442 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
1443 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
1445 l_item
->value_index
= e
->value_list
.nr
- 1;
1448 die("BUG: configset_add_value has no source");
1450 kv_info
->filename
= strintern(cf
->name
);
1451 kv_info
->linenr
= cf
->linenr
;
1452 kv_info
->origin_type
= cf
->origin_type
;
1454 /* for values read from `git_config_from_parameters()` */
1455 kv_info
->filename
= NULL
;
1456 kv_info
->linenr
= -1;
1457 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
1459 kv_info
->scope
= current_parsing_scope
;
1465 static int config_set_element_cmp(const struct config_set_element
*e1
,
1466 const struct config_set_element
*e2
, const void *unused
)
1468 return strcmp(e1
->key
, e2
->key
);
1471 void git_configset_init(struct config_set
*cs
)
1473 hashmap_init(&cs
->config_hash
, (hashmap_cmp_fn
)config_set_element_cmp
, 0);
1474 cs
->hash_initialized
= 1;
1477 cs
->list
.items
= NULL
;
1480 void git_configset_clear(struct config_set
*cs
)
1482 struct config_set_element
*entry
;
1483 struct hashmap_iter iter
;
1484 if (!cs
->hash_initialized
)
1487 hashmap_iter_init(&cs
->config_hash
, &iter
);
1488 while ((entry
= hashmap_iter_next(&iter
))) {
1490 string_list_clear(&entry
->value_list
, 1);
1492 hashmap_free(&cs
->config_hash
, 1);
1493 cs
->hash_initialized
= 0;
1494 free(cs
->list
.items
);
1497 cs
->list
.items
= NULL
;
1500 static int config_set_callback(const char *key
, const char *value
, void *cb
)
1502 struct config_set
*cs
= cb
;
1503 configset_add_value(cs
, key
, value
);
1507 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
1509 return git_config_from_file(config_set_callback
, filename
, cs
);
1512 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
1514 const struct string_list
*values
= NULL
;
1516 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1517 * queried key in the files of the configset, the value returned will be the last
1518 * value in the value list for that key.
1520 values
= git_configset_get_value_multi(cs
, key
);
1524 assert(values
->nr
> 0);
1525 *value
= values
->items
[values
->nr
- 1].string
;
1529 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
1531 struct config_set_element
*e
= configset_find_element(cs
, key
);
1532 return e
? &e
->value_list
: NULL
;
1535 int git_configset_get_string_const(struct config_set
*cs
, const char *key
, const char **dest
)
1538 if (!git_configset_get_value(cs
, key
, &value
))
1539 return git_config_string(dest
, key
, value
);
1544 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
1546 return git_configset_get_string_const(cs
, key
, (const char **)dest
);
1549 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
1552 if (!git_configset_get_value(cs
, key
, &value
)) {
1553 *dest
= git_config_int(key
, value
);
1559 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
1562 if (!git_configset_get_value(cs
, key
, &value
)) {
1563 *dest
= git_config_ulong(key
, value
);
1569 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
1572 if (!git_configset_get_value(cs
, key
, &value
)) {
1573 *dest
= git_config_bool(key
, value
);
1579 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
1580 int *is_bool
, int *dest
)
1583 if (!git_configset_get_value(cs
, key
, &value
)) {
1584 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
1590 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
1593 if (!git_configset_get_value(cs
, key
, &value
)) {
1594 *dest
= git_config_maybe_bool(key
, value
);
1602 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
1605 if (!git_configset_get_value(cs
, key
, &value
))
1606 return git_config_pathname(dest
, key
, value
);
1611 static void git_config_check_init(void)
1613 if (the_config_set
.hash_initialized
)
1615 git_configset_init(&the_config_set
);
1616 git_config_raw(config_set_callback
, &the_config_set
);
1619 void git_config_clear(void)
1621 if (!the_config_set
.hash_initialized
)
1623 git_configset_clear(&the_config_set
);
1626 int git_config_get_value(const char *key
, const char **value
)
1628 git_config_check_init();
1629 return git_configset_get_value(&the_config_set
, key
, value
);
1632 const struct string_list
*git_config_get_value_multi(const char *key
)
1634 git_config_check_init();
1635 return git_configset_get_value_multi(&the_config_set
, key
);
1638 int git_config_get_string_const(const char *key
, const char **dest
)
1641 git_config_check_init();
1642 ret
= git_configset_get_string_const(&the_config_set
, key
, dest
);
1644 git_die_config(key
, NULL
);
1648 int git_config_get_string(const char *key
, char **dest
)
1650 git_config_check_init();
1651 return git_config_get_string_const(key
, (const char **)dest
);
1654 int git_config_get_int(const char *key
, int *dest
)
1656 git_config_check_init();
1657 return git_configset_get_int(&the_config_set
, key
, dest
);
1660 int git_config_get_ulong(const char *key
, unsigned long *dest
)
1662 git_config_check_init();
1663 return git_configset_get_ulong(&the_config_set
, key
, dest
);
1666 int git_config_get_bool(const char *key
, int *dest
)
1668 git_config_check_init();
1669 return git_configset_get_bool(&the_config_set
, key
, dest
);
1672 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
1674 git_config_check_init();
1675 return git_configset_get_bool_or_int(&the_config_set
, key
, is_bool
, dest
);
1678 int git_config_get_maybe_bool(const char *key
, int *dest
)
1680 git_config_check_init();
1681 return git_configset_get_maybe_bool(&the_config_set
, key
, dest
);
1684 int git_config_get_pathname(const char *key
, const char **dest
)
1687 git_config_check_init();
1688 ret
= git_configset_get_pathname(&the_config_set
, key
, dest
);
1690 git_die_config(key
, NULL
);
1694 int git_config_get_untracked_cache(void)
1699 /* Hack for test programs like test-dump-untracked-cache */
1700 if (ignore_untracked_cache_config
)
1703 if (!git_config_get_maybe_bool("core.untrackedcache", &val
))
1706 if (!git_config_get_value("core.untrackedcache", &v
)) {
1707 if (!strcasecmp(v
, "keep"))
1710 error("unknown core.untrackedCache value '%s'; "
1711 "using 'keep' default value", v
);
1715 return -1; /* default value */
1719 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
1722 die(_("unable to parse '%s' from command-line config"), key
);
1724 die(_("bad config variable '%s' in file '%s' at line %d"),
1725 key
, filename
, linenr
);
1728 NORETURN
__attribute__((format(printf
, 2, 3)))
1729 void git_die_config(const char *key
, const char *err
, ...)
1731 const struct string_list
*values
;
1732 struct key_value_info
*kv_info
;
1736 va_start(params
, err
);
1737 vreportf("error: ", err
, params
);
1740 values
= git_config_get_value_multi(key
);
1741 kv_info
= values
->items
[values
->nr
- 1].util
;
1742 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
1746 * Find all the stuff for git_config_set() below.
1753 regex_t
*value_regex
;
1756 unsigned int offset_alloc
;
1757 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1761 static int matches(const char *key
, const char *value
)
1763 if (strcmp(key
, store
.key
))
1764 return 0; /* not ours */
1765 if (!store
.value_regex
)
1766 return 1; /* always matches */
1767 if (store
.value_regex
== CONFIG_REGEX_NONE
)
1768 return 0; /* never matches */
1770 return store
.do_not_match
^
1771 (value
&& !regexec(store
.value_regex
, value
, 0, NULL
, 0));
1774 static int store_aux(const char *key
, const char *value
, void *cb
)
1779 switch (store
.state
) {
1781 if (matches(key
, value
)) {
1782 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1783 warning(_("%s has multiple values"), key
);
1786 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1787 store
.offset_alloc
);
1789 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1795 * What we are looking for is in store.key (both
1796 * section and var), and its section part is baselen
1797 * long. We found key (again, both section and var).
1798 * We would want to know if this key is in the same
1799 * section as what we are looking for. We already
1800 * know we are in the same section as what should
1803 ep
= strrchr(key
, '.');
1804 section_len
= ep
- key
;
1806 if ((section_len
!= store
.baselen
) ||
1807 memcmp(key
, store
.key
, section_len
+1)) {
1808 store
.state
= SECTION_END_SEEN
;
1813 * Do not increment matches: this is no match, but we
1814 * just made sure we are in the desired section.
1816 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1817 store
.offset_alloc
);
1818 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1820 case SECTION_END_SEEN
:
1822 if (matches(key
, value
)) {
1823 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1824 store
.offset_alloc
);
1825 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1826 store
.state
= KEY_SEEN
;
1829 if (strrchr(key
, '.') - key
== store
.baselen
&&
1830 !strncmp(key
, store
.key
, store
.baselen
)) {
1831 store
.state
= SECTION_SEEN
;
1832 ALLOC_GROW(store
.offset
,
1834 store
.offset_alloc
);
1835 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1842 static int write_error(const char *filename
)
1844 error("failed to write new configuration file %s", filename
);
1846 /* Same error code as "failed to rename". */
1850 static int store_write_section(int fd
, const char *key
)
1854 struct strbuf sb
= STRBUF_INIT
;
1856 dot
= memchr(key
, '.', store
.baselen
);
1858 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1859 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1860 if (key
[i
] == '"' || key
[i
] == '\\')
1861 strbuf_addch(&sb
, '\\');
1862 strbuf_addch(&sb
, key
[i
]);
1864 strbuf_addstr(&sb
, "\"]\n");
1866 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1869 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1870 strbuf_release(&sb
);
1875 static int store_write_pair(int fd
, const char *key
, const char *value
)
1878 int length
= strlen(key
+ store
.baselen
+ 1);
1879 const char *quote
= "";
1880 struct strbuf sb
= STRBUF_INIT
;
1883 * Check to see if the value needs to be surrounded with a dq pair.
1884 * Note that problematic characters are always backslash-quoted; this
1885 * check is about not losing leading or trailing SP and strings that
1886 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1887 * configuration parser.
1889 if (value
[0] == ' ')
1891 for (i
= 0; value
[i
]; i
++)
1892 if (value
[i
] == ';' || value
[i
] == '#')
1894 if (i
&& value
[i
- 1] == ' ')
1897 strbuf_addf(&sb
, "\t%.*s = %s",
1898 length
, key
+ store
.baselen
+ 1, quote
);
1900 for (i
= 0; value
[i
]; i
++)
1903 strbuf_addstr(&sb
, "\\n");
1906 strbuf_addstr(&sb
, "\\t");
1910 strbuf_addch(&sb
, '\\');
1912 strbuf_addch(&sb
, value
[i
]);
1915 strbuf_addf(&sb
, "%s\n", quote
);
1917 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1918 strbuf_release(&sb
);
1923 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1924 size_t offset_
, int *found_bracket
)
1926 size_t equal_offset
= size
, bracket_offset
= size
;
1930 for (offset
= offset_
-2; offset
> 0
1931 && contents
[offset
] != '\n'; offset
--)
1932 switch (contents
[offset
]) {
1933 case '=': equal_offset
= offset
; break;
1934 case ']': bracket_offset
= offset
; break;
1936 if (offset
> 0 && contents
[offset
-1] == '\\') {
1940 if (bracket_offset
< equal_offset
) {
1942 offset
= bracket_offset
+1;
1949 int git_config_set_in_file_gently(const char *config_filename
,
1950 const char *key
, const char *value
)
1952 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
1955 void git_config_set_in_file(const char *config_filename
,
1956 const char *key
, const char *value
)
1958 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1961 int git_config_set_gently(const char *key
, const char *value
)
1963 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
1966 void git_config_set(const char *key
, const char *value
)
1968 git_config_set_multivar(key
, value
, NULL
, 0);
1972 * Auxiliary function to sanity-check and split the key into the section
1973 * identifier and variable name.
1975 * Returns 0 on success, -1 when there is an invalid character in the key and
1976 * -2 if there is no section name in the key.
1978 * store_key - pointer to char* which will hold a copy of the key with
1979 * lowercase section and variable name
1980 * baselen - pointer to int which will hold the length of the
1981 * section + subsection part, can be NULL
1983 static int git_config_parse_key_1(const char *key
, char **store_key
, int *baselen_
, int quiet
)
1985 int i
, dot
, baselen
;
1986 const char *last_dot
= strrchr(key
, '.');
1989 * Since "key" actually contains the section name and the real
1990 * key name separated by a dot, we have to know where the dot is.
1993 if (last_dot
== NULL
|| last_dot
== key
) {
1995 error("key does not contain a section: %s", key
);
1996 return -CONFIG_NO_SECTION_OR_NAME
;
2001 error("key does not contain variable name: %s", key
);
2002 return -CONFIG_NO_SECTION_OR_NAME
;
2005 baselen
= last_dot
- key
;
2007 *baselen_
= baselen
;
2010 * Validate the key and while at it, lower case it for matching.
2013 *store_key
= xmallocz(strlen(key
));
2016 for (i
= 0; key
[i
]; i
++) {
2017 unsigned char c
= key
[i
];
2020 /* Leave the extended basename untouched.. */
2021 if (!dot
|| i
> baselen
) {
2022 if (!iskeychar(c
) ||
2023 (i
== baselen
+ 1 && !isalpha(c
))) {
2025 error("invalid key: %s", key
);
2026 goto out_free_ret_1
;
2029 } else if (c
== '\n') {
2031 error("invalid key (newline): %s", key
);
2032 goto out_free_ret_1
;
2035 (*store_key
)[i
] = c
;
2045 return -CONFIG_INVALID_KEY
;
2048 int git_config_parse_key(const char *key
, char **store_key
, int *baselen
)
2050 return git_config_parse_key_1(key
, store_key
, baselen
, 0);
2053 int git_config_key_is_valid(const char *key
)
2055 return !git_config_parse_key_1(key
, NULL
, NULL
, 1);
2059 * If value==NULL, unset in (remove from) config,
2060 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2061 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2062 * (only add a new one)
2063 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2064 * else all matching key/values (regardless how many) are removed,
2065 * before the new pair is written.
2067 * Returns 0 on success.
2069 * This function does this:
2071 * - it locks the config file by creating ".git/config.lock"
2073 * - it then parses the config using store_aux() as validator to find
2074 * the position on the key/value pair to replace. If it is to be unset,
2075 * it must be found exactly once.
2077 * - the config file is mmap()ed and the part before the match (if any) is
2078 * written to the lock file, then the changed part and the rest.
2080 * - the config file is removed and the lock file rename()d to it.
2083 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2084 const char *key
, const char *value
,
2085 const char *value_regex
,
2088 int fd
= -1, in_fd
= -1;
2090 struct lock_file
*lock
= NULL
;
2091 char *filename_buf
= NULL
;
2092 char *contents
= NULL
;
2095 /* parse-key returns negative; flip the sign to feed exit(3) */
2096 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2100 store
.multi_replace
= multi_replace
;
2102 if (!config_filename
)
2103 config_filename
= filename_buf
= git_pathdup("config");
2106 * The lock serves a purpose in addition to locking: the new
2107 * contents of .git/config will be written into it.
2109 lock
= xcalloc(1, sizeof(struct lock_file
));
2110 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2112 error_errno("could not lock config file %s", config_filename
);
2114 ret
= CONFIG_NO_LOCK
;
2119 * If .git/config does not exist yet, write a minimal version.
2121 in_fd
= open(config_filename
, O_RDONLY
);
2125 if ( ENOENT
!= errno
) {
2126 error_errno("opening %s", config_filename
);
2127 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2130 /* if nothing to unset, error out */
2131 if (value
== NULL
) {
2132 ret
= CONFIG_NOTHING_SET
;
2136 store
.key
= (char *)key
;
2137 if (!store_write_section(fd
, key
) ||
2138 !store_write_pair(fd
, key
, value
))
2142 size_t copy_begin
, copy_end
;
2143 int i
, new_line
= 0;
2145 if (value_regex
== NULL
)
2146 store
.value_regex
= NULL
;
2147 else if (value_regex
== CONFIG_REGEX_NONE
)
2148 store
.value_regex
= CONFIG_REGEX_NONE
;
2150 if (value_regex
[0] == '!') {
2151 store
.do_not_match
= 1;
2154 store
.do_not_match
= 0;
2156 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
2157 if (regcomp(store
.value_regex
, value_regex
,
2159 error("invalid pattern: %s", value_regex
);
2160 free(store
.value_regex
);
2161 ret
= CONFIG_INVALID_PATTERN
;
2166 ALLOC_GROW(store
.offset
, 1, store
.offset_alloc
);
2167 store
.offset
[0] = 0;
2168 store
.state
= START
;
2172 * After this, store.offset will contain the *end* offset
2173 * of the last match, or remain at 0 if no match was found.
2174 * As a side effect, we make sure to transform only a valid
2175 * existing config file.
2177 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
2178 error("invalid config file %s", config_filename
);
2180 if (store
.value_regex
!= NULL
&&
2181 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2182 regfree(store
.value_regex
);
2183 free(store
.value_regex
);
2185 ret
= CONFIG_INVALID_FILE
;
2190 if (store
.value_regex
!= NULL
&&
2191 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2192 regfree(store
.value_regex
);
2193 free(store
.value_regex
);
2196 /* if nothing to unset, or too many matches, error out */
2197 if ((store
.seen
== 0 && value
== NULL
) ||
2198 (store
.seen
> 1 && multi_replace
== 0)) {
2199 ret
= CONFIG_NOTHING_SET
;
2204 contents_sz
= xsize_t(st
.st_size
);
2205 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
2206 MAP_PRIVATE
, in_fd
, 0);
2207 if (contents
== MAP_FAILED
) {
2208 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
2210 error_errno("unable to mmap '%s'", config_filename
);
2211 ret
= CONFIG_INVALID_FILE
;
2218 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2219 error_errno("chmod on %s failed", get_lock_file_path(lock
));
2220 ret
= CONFIG_NO_WRITE
;
2224 if (store
.seen
== 0)
2227 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
2228 if (store
.offset
[i
] == 0) {
2229 store
.offset
[i
] = copy_end
= contents_sz
;
2230 } else if (store
.state
!= KEY_SEEN
) {
2231 copy_end
= store
.offset
[i
];
2233 copy_end
= find_beginning_of_line(
2234 contents
, contents_sz
,
2235 store
.offset
[i
]-2, &new_line
);
2237 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
2240 /* write the first part of the config */
2241 if (copy_end
> copy_begin
) {
2242 if (write_in_full(fd
, contents
+ copy_begin
,
2243 copy_end
- copy_begin
) <
2244 copy_end
- copy_begin
)
2247 write_str_in_full(fd
, "\n") != 1)
2250 copy_begin
= store
.offset
[i
];
2253 /* write the pair (value == NULL means unset) */
2254 if (value
!= NULL
) {
2255 if (store
.state
== START
) {
2256 if (!store_write_section(fd
, key
))
2259 if (!store_write_pair(fd
, key
, value
))
2263 /* write the rest of the config */
2264 if (copy_begin
< contents_sz
)
2265 if (write_in_full(fd
, contents
+ copy_begin
,
2266 contents_sz
- copy_begin
) <
2267 contents_sz
- copy_begin
)
2270 munmap(contents
, contents_sz
);
2274 if (commit_lock_file(lock
) < 0) {
2275 error_errno("could not write config file %s", config_filename
);
2276 ret
= CONFIG_NO_WRITE
;
2282 * lock is committed, so don't try to roll it back below.
2283 * NOTE: Since lockfile.c keeps a linked list of all created
2284 * lock_file structures, it isn't safe to free(lock). It's
2285 * better to just leave it hanging around.
2290 /* Invalidate the config cache */
2295 rollback_lock_file(lock
);
2298 munmap(contents
, contents_sz
);
2304 ret
= write_error(get_lock_file_path(lock
));
2309 void git_config_set_multivar_in_file(const char *config_filename
,
2310 const char *key
, const char *value
,
2311 const char *value_regex
, int multi_replace
)
2313 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
2314 value_regex
, multi_replace
))
2317 die(_("could not set '%s' to '%s'"), key
, value
);
2319 die(_("could not unset '%s'"), key
);
2322 int git_config_set_multivar_gently(const char *key
, const char *value
,
2323 const char *value_regex
, int multi_replace
)
2325 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_regex
,
2329 void git_config_set_multivar(const char *key
, const char *value
,
2330 const char *value_regex
, int multi_replace
)
2332 git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
2336 static int section_name_match (const char *buf
, const char *name
)
2338 int i
= 0, j
= 0, dot
= 0;
2341 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
2342 if (!dot
&& isspace(buf
[i
])) {
2344 if (name
[j
++] != '.')
2346 for (i
++; isspace(buf
[i
]); i
++)
2352 if (buf
[i
] == '\\' && dot
)
2354 else if (buf
[i
] == '"' && dot
) {
2355 for (i
++; isspace(buf
[i
]); i
++)
2359 if (buf
[i
] != name
[j
++])
2362 if (buf
[i
] == ']' && name
[j
] == 0) {
2364 * We match, now just find the right length offset by
2365 * gobbling up any whitespace after it, as well
2368 for (; buf
[i
] && isspace(buf
[i
]); i
++)
2375 static int section_name_is_ok(const char *name
)
2377 /* Empty section names are bogus. */
2382 * Before a dot, we must be alphanumeric or dash. After the first dot,
2383 * anything goes, so we can stop checking.
2385 for (; *name
&& *name
!= '.'; name
++)
2386 if (*name
!= '-' && !isalnum(*name
))
2391 /* if new_name == NULL, the section is removed instead */
2392 int git_config_rename_section_in_file(const char *config_filename
,
2393 const char *old_name
, const char *new_name
)
2395 int ret
= 0, remove
= 0;
2396 char *filename_buf
= NULL
;
2397 struct lock_file
*lock
;
2403 if (new_name
&& !section_name_is_ok(new_name
)) {
2404 ret
= error("invalid section name: %s", new_name
);
2408 if (!config_filename
)
2409 config_filename
= filename_buf
= git_pathdup("config");
2411 lock
= xcalloc(1, sizeof(struct lock_file
));
2412 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2414 ret
= error("could not lock config file %s", config_filename
);
2418 if (!(config_file
= fopen(config_filename
, "rb"))) {
2419 /* no config file means nothing to rename, no error */
2420 goto unlock_and_out
;
2423 fstat(fileno(config_file
), &st
);
2425 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2426 ret
= error_errno("chmod on %s failed",
2427 get_lock_file_path(lock
));
2431 while (fgets(buf
, sizeof(buf
), config_file
)) {
2435 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
2437 if (buf
[i
] == '[') {
2438 /* it's a section */
2439 int offset
= section_name_match(&buf
[i
], old_name
);
2442 if (new_name
== NULL
) {
2446 store
.baselen
= strlen(new_name
);
2447 if (!store_write_section(out_fd
, new_name
)) {
2448 ret
= write_error(get_lock_file_path(lock
));
2452 * We wrote out the new section, with
2453 * a newline, now skip the old
2456 output
+= offset
+ i
;
2457 if (strlen(output
) > 0) {
2459 * More content means there's
2460 * a declaration to put on the
2461 * next line; indent with a
2472 length
= strlen(output
);
2473 if (write_in_full(out_fd
, output
, length
) != length
) {
2474 ret
= write_error(get_lock_file_path(lock
));
2478 fclose(config_file
);
2480 if (commit_lock_file(lock
) < 0)
2481 ret
= error_errno("could not write config file %s",
2488 int git_config_rename_section(const char *old_name
, const char *new_name
)
2490 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
2494 * Call this to report error for your variable that should not
2495 * get a boolean value (i.e. "[my] var" means "true").
2497 #undef config_error_nonbool
2498 int config_error_nonbool(const char *var
)
2500 return error("missing value for '%s'", var
);
2503 int parse_config_key(const char *var
,
2504 const char *section
,
2505 const char **subsection
, int *subsection_len
,
2508 int section_len
= strlen(section
);
2511 /* Does it start with "section." ? */
2512 if (!starts_with(var
, section
) || var
[section_len
] != '.')
2516 * Find the key; we don't know yet if we have a subsection, but we must
2517 * parse backwards from the end, since the subsection may have dots in
2520 dot
= strrchr(var
, '.');
2523 /* Did we have a subsection at all? */
2524 if (dot
== var
+ section_len
) {
2526 *subsection_len
= 0;
2529 *subsection
= var
+ section_len
+ 1;
2530 *subsection_len
= dot
- *subsection
;
2536 const char *current_config_origin_type(void)
2539 if (current_config_kvi
)
2540 type
= current_config_kvi
->origin_type
;
2542 type
= cf
->origin_type
;
2544 die("BUG: current_config_origin_type called outside config callback");
2547 case CONFIG_ORIGIN_BLOB
:
2549 case CONFIG_ORIGIN_FILE
:
2551 case CONFIG_ORIGIN_STDIN
:
2552 return "standard input";
2553 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
2554 return "submodule-blob";
2555 case CONFIG_ORIGIN_CMDLINE
:
2556 return "command line";
2558 die("BUG: unknown config origin type");
2562 const char *current_config_name(void)
2565 if (current_config_kvi
)
2566 name
= current_config_kvi
->filename
;
2570 die("BUG: current_config_name called outside config callback");
2571 return name
? name
: "";
2574 enum config_scope
current_config_scope(void)
2576 if (current_config_kvi
)
2577 return current_config_kvi
->scope
;
2579 return current_parsing_scope
;