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")) {
837 int abbrev
= git_config_int(var
, value
);
838 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
840 default_abbrev
= abbrev
;
844 if (!strcmp(var
, "core.loosecompression")) {
845 int level
= git_config_int(var
, value
);
847 level
= Z_DEFAULT_COMPRESSION
;
848 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
849 die(_("bad zlib compression level %d"), level
);
850 zlib_compression_level
= level
;
851 zlib_compression_seen
= 1;
855 if (!strcmp(var
, "core.compression")) {
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 core_compression_level
= level
;
862 core_compression_seen
= 1;
863 if (!zlib_compression_seen
)
864 zlib_compression_level
= level
;
868 if (!strcmp(var
, "core.packedgitwindowsize")) {
869 int pgsz_x2
= getpagesize() * 2;
870 packed_git_window_size
= git_config_ulong(var
, value
);
872 /* This value must be multiple of (pagesize * 2) */
873 packed_git_window_size
/= pgsz_x2
;
874 if (packed_git_window_size
< 1)
875 packed_git_window_size
= 1;
876 packed_git_window_size
*= pgsz_x2
;
880 if (!strcmp(var
, "core.bigfilethreshold")) {
881 big_file_threshold
= git_config_ulong(var
, value
);
885 if (!strcmp(var
, "core.packedgitlimit")) {
886 packed_git_limit
= git_config_ulong(var
, value
);
890 if (!strcmp(var
, "core.deltabasecachelimit")) {
891 delta_base_cache_limit
= git_config_ulong(var
, value
);
895 if (!strcmp(var
, "core.autocrlf")) {
896 if (value
&& !strcasecmp(value
, "input")) {
897 auto_crlf
= AUTO_CRLF_INPUT
;
900 auto_crlf
= git_config_bool(var
, value
);
904 if (!strcmp(var
, "core.safecrlf")) {
905 if (value
&& !strcasecmp(value
, "warn")) {
906 safe_crlf
= SAFE_CRLF_WARN
;
909 safe_crlf
= git_config_bool(var
, value
);
913 if (!strcmp(var
, "core.eol")) {
914 if (value
&& !strcasecmp(value
, "lf"))
916 else if (value
&& !strcasecmp(value
, "crlf"))
918 else if (value
&& !strcasecmp(value
, "native"))
919 core_eol
= EOL_NATIVE
;
921 core_eol
= EOL_UNSET
;
925 if (!strcmp(var
, "core.notesref")) {
926 notes_ref_name
= xstrdup(value
);
930 if (!strcmp(var
, "core.editor"))
931 return git_config_string(&editor_program
, var
, value
);
933 if (!strcmp(var
, "core.commentchar")) {
935 return config_error_nonbool(var
);
936 else if (!strcasecmp(value
, "auto"))
937 auto_comment_line_char
= 1;
938 else if (value
[0] && !value
[1]) {
939 comment_line_char
= value
[0];
940 auto_comment_line_char
= 0;
942 return error("core.commentChar should only be one character");
946 if (!strcmp(var
, "core.askpass"))
947 return git_config_string(&askpass_program
, var
, value
);
949 if (!strcmp(var
, "core.excludesfile"))
950 return git_config_pathname(&excludes_file
, var
, value
);
952 if (!strcmp(var
, "core.whitespace")) {
954 return config_error_nonbool(var
);
955 whitespace_rule_cfg
= parse_whitespace_rule(value
);
959 if (!strcmp(var
, "core.fsyncobjectfiles")) {
960 fsync_object_files
= git_config_bool(var
, value
);
964 if (!strcmp(var
, "core.preloadindex")) {
965 core_preload_index
= git_config_bool(var
, value
);
969 if (!strcmp(var
, "core.createobject")) {
970 if (!strcmp(value
, "rename"))
971 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
972 else if (!strcmp(value
, "link"))
973 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
975 die(_("invalid mode for object creation: %s"), value
);
979 if (!strcmp(var
, "core.sparsecheckout")) {
980 core_apply_sparse_checkout
= git_config_bool(var
, value
);
984 if (!strcmp(var
, "core.precomposeunicode")) {
985 precomposed_unicode
= git_config_bool(var
, value
);
989 if (!strcmp(var
, "core.protecthfs")) {
990 protect_hfs
= git_config_bool(var
, value
);
994 if (!strcmp(var
, "core.protectntfs")) {
995 protect_ntfs
= git_config_bool(var
, value
);
999 if (!strcmp(var
, "core.hidedotfiles")) {
1000 if (value
&& !strcasecmp(value
, "dotgitonly"))
1001 hide_dotfiles
= HIDE_DOTFILES_DOTGITONLY
;
1003 hide_dotfiles
= git_config_bool(var
, value
);
1007 /* Add other config variables here and to Documentation/config.txt. */
1011 static int git_default_i18n_config(const char *var
, const char *value
)
1013 if (!strcmp(var
, "i18n.commitencoding"))
1014 return git_config_string(&git_commit_encoding
, var
, value
);
1016 if (!strcmp(var
, "i18n.logoutputencoding"))
1017 return git_config_string(&git_log_output_encoding
, var
, value
);
1019 /* Add other config variables here and to Documentation/config.txt. */
1023 static int git_default_branch_config(const char *var
, const char *value
)
1025 if (!strcmp(var
, "branch.autosetupmerge")) {
1026 if (value
&& !strcasecmp(value
, "always")) {
1027 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1030 git_branch_track
= git_config_bool(var
, value
);
1033 if (!strcmp(var
, "branch.autosetuprebase")) {
1035 return config_error_nonbool(var
);
1036 else if (!strcmp(value
, "never"))
1037 autorebase
= AUTOREBASE_NEVER
;
1038 else if (!strcmp(value
, "local"))
1039 autorebase
= AUTOREBASE_LOCAL
;
1040 else if (!strcmp(value
, "remote"))
1041 autorebase
= AUTOREBASE_REMOTE
;
1042 else if (!strcmp(value
, "always"))
1043 autorebase
= AUTOREBASE_ALWAYS
;
1045 return error("malformed value for %s", var
);
1049 /* Add other config variables here and to Documentation/config.txt. */
1053 static int git_default_push_config(const char *var
, const char *value
)
1055 if (!strcmp(var
, "push.default")) {
1057 return config_error_nonbool(var
);
1058 else if (!strcmp(value
, "nothing"))
1059 push_default
= PUSH_DEFAULT_NOTHING
;
1060 else if (!strcmp(value
, "matching"))
1061 push_default
= PUSH_DEFAULT_MATCHING
;
1062 else if (!strcmp(value
, "simple"))
1063 push_default
= PUSH_DEFAULT_SIMPLE
;
1064 else if (!strcmp(value
, "upstream"))
1065 push_default
= PUSH_DEFAULT_UPSTREAM
;
1066 else if (!strcmp(value
, "tracking")) /* deprecated */
1067 push_default
= PUSH_DEFAULT_UPSTREAM
;
1068 else if (!strcmp(value
, "current"))
1069 push_default
= PUSH_DEFAULT_CURRENT
;
1071 error("malformed value for %s: %s", var
, value
);
1072 return error("Must be one of nothing, matching, simple, "
1073 "upstream or current.");
1078 /* Add other config variables here and to Documentation/config.txt. */
1082 static int git_default_mailmap_config(const char *var
, const char *value
)
1084 if (!strcmp(var
, "mailmap.file"))
1085 return git_config_pathname(&git_mailmap_file
, var
, value
);
1086 if (!strcmp(var
, "mailmap.blob"))
1087 return git_config_string(&git_mailmap_blob
, var
, value
);
1089 /* Add other config variables here and to Documentation/config.txt. */
1093 int git_default_config(const char *var
, const char *value
, void *dummy
)
1095 if (starts_with(var
, "core."))
1096 return git_default_core_config(var
, value
);
1098 if (starts_with(var
, "user."))
1099 return git_ident_config(var
, value
, dummy
);
1101 if (starts_with(var
, "i18n."))
1102 return git_default_i18n_config(var
, value
);
1104 if (starts_with(var
, "branch."))
1105 return git_default_branch_config(var
, value
);
1107 if (starts_with(var
, "push."))
1108 return git_default_push_config(var
, value
);
1110 if (starts_with(var
, "mailmap."))
1111 return git_default_mailmap_config(var
, value
);
1113 if (starts_with(var
, "advice."))
1114 return git_default_advice_config(var
, value
);
1116 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1117 pager_use_color
= git_config_bool(var
,value
);
1121 if (!strcmp(var
, "pack.packsizelimit")) {
1122 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1125 /* Add other config variables here and to Documentation/config.txt. */
1130 * All source specific fields in the union, die_on_error, name and the callbacks
1131 * fgetc, ungetc, ftell of top need to be initialized before calling
1134 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1138 /* push config-file parsing state stack */
1142 strbuf_init(&top
->value
, 1024);
1143 strbuf_init(&top
->var
, 1024);
1146 ret
= git_parse_source(fn
, data
);
1148 /* pop config-file parsing state stack */
1149 strbuf_release(&top
->value
);
1150 strbuf_release(&top
->var
);
1156 static int do_config_from_file(config_fn_t fn
,
1157 const enum config_origin_type origin_type
,
1158 const char *name
, const char *path
, FILE *f
,
1161 struct config_source top
;
1164 top
.origin_type
= origin_type
;
1167 top
.die_on_error
= 1;
1168 top
.do_fgetc
= config_file_fgetc
;
1169 top
.do_ungetc
= config_file_ungetc
;
1170 top
.do_ftell
= config_file_ftell
;
1172 return do_config_from(&top
, fn
, data
);
1175 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1177 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
, data
);
1180 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1185 f
= fopen(filename
, "r");
1188 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
, filename
, f
, data
);
1195 int git_config_from_mem(config_fn_t fn
, const enum config_origin_type origin_type
,
1196 const char *name
, const char *buf
, size_t len
, void *data
)
1198 struct config_source top
;
1200 top
.u
.buf
.buf
= buf
;
1201 top
.u
.buf
.len
= len
;
1203 top
.origin_type
= origin_type
;
1206 top
.die_on_error
= 0;
1207 top
.do_fgetc
= config_buf_fgetc
;
1208 top
.do_ungetc
= config_buf_ungetc
;
1209 top
.do_ftell
= config_buf_ftell
;
1211 return do_config_from(&top
, fn
, data
);
1214 static int git_config_from_blob_sha1(config_fn_t fn
,
1216 const unsigned char *sha1
,
1219 enum object_type type
;
1224 buf
= read_sha1_file(sha1
, &type
, &size
);
1226 return error("unable to load config blob object '%s'", name
);
1227 if (type
!= OBJ_BLOB
) {
1229 return error("reference '%s' does not point to a blob", name
);
1232 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
, data
);
1238 static int git_config_from_blob_ref(config_fn_t fn
,
1242 unsigned char sha1
[20];
1244 if (get_sha1(name
, sha1
) < 0)
1245 return error("unable to resolve config blob '%s'", name
);
1246 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1249 const char *git_etc_gitconfig(void)
1251 static const char *system_wide
;
1253 system_wide
= system_path(ETC_GITCONFIG
);
1258 * Parse environment variable 'k' as a boolean (in various
1259 * possible spellings); if missing, use the default value 'def'.
1261 int git_env_bool(const char *k
, int def
)
1263 const char *v
= getenv(k
);
1264 return v
? git_config_bool(k
, v
) : def
;
1268 * Parse environment variable 'k' as ulong with possibly a unit
1269 * suffix; if missing, use the default value 'val'.
1271 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1273 const char *v
= getenv(k
);
1274 if (v
&& !git_parse_ulong(v
, &val
))
1275 die("failed to parse %s", k
);
1279 int git_config_system(void)
1281 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1284 static int do_git_config_sequence(config_fn_t fn
, void *data
)
1287 char *xdg_config
= xdg_config_home("config");
1288 char *user_config
= expand_user_path("~/.gitconfig");
1289 char *repo_config
= have_git_dir() ? git_pathdup("config") : NULL
;
1291 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1292 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0))
1293 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1296 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1297 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1298 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1300 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1301 ret
+= git_config_from_file(fn
, user_config
, data
);
1303 current_parsing_scope
= CONFIG_SCOPE_REPO
;
1304 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0))
1305 ret
+= git_config_from_file(fn
, repo_config
, data
);
1307 current_parsing_scope
= CONFIG_SCOPE_CMDLINE
;
1308 if (git_config_from_parameters(fn
, data
) < 0)
1309 die(_("unable to parse command-line config"));
1311 current_parsing_scope
= CONFIG_SCOPE_UNKNOWN
;
1318 int git_config_with_options(config_fn_t fn
, void *data
,
1319 struct git_config_source
*config_source
,
1320 int respect_includes
)
1322 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1324 if (respect_includes
) {
1327 fn
= git_config_include
;
1332 * If we have a specific filename, use it. Otherwise, follow the
1333 * regular lookup sequence.
1335 if (config_source
&& config_source
->use_stdin
)
1336 return git_config_from_stdin(fn
, data
);
1337 else if (config_source
&& config_source
->file
)
1338 return git_config_from_file(fn
, config_source
->file
, data
);
1339 else if (config_source
&& config_source
->blob
)
1340 return git_config_from_blob_ref(fn
, config_source
->blob
, data
);
1342 return do_git_config_sequence(fn
, data
);
1345 static void git_config_raw(config_fn_t fn
, void *data
)
1347 if (git_config_with_options(fn
, data
, NULL
, 1) < 0)
1349 * git_config_with_options() normally returns only
1350 * zero, as most errors are fatal, and
1351 * non-fatal potential errors are guarded by "if"
1352 * statements that are entered only when no error is
1355 * If we ever encounter a non-fatal error, it means
1356 * something went really wrong and we should stop
1359 die(_("unknown error occurred while reading the configuration files"));
1362 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1365 struct string_list
*values
;
1366 struct config_set_element
*entry
;
1367 struct configset_list
*list
= &cs
->list
;
1369 for (i
= 0; i
< list
->nr
; i
++) {
1370 entry
= list
->items
[i
].e
;
1371 value_index
= list
->items
[i
].value_index
;
1372 values
= &entry
->value_list
;
1374 current_config_kvi
= values
->items
[value_index
].util
;
1376 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1377 git_die_config_linenr(entry
->key
,
1378 current_config_kvi
->filename
,
1379 current_config_kvi
->linenr
);
1381 current_config_kvi
= NULL
;
1385 static void git_config_check_init(void);
1387 void git_config(config_fn_t fn
, void *data
)
1389 git_config_check_init();
1390 configset_iter(&the_config_set
, fn
, data
);
1393 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
1395 struct config_set_element k
;
1396 struct config_set_element
*found_entry
;
1397 char *normalized_key
;
1399 * `key` may come from the user, so normalize it before using it
1400 * for querying entries from the hashmap.
1402 if (git_config_parse_key(key
, &normalized_key
, NULL
))
1405 hashmap_entry_init(&k
, strhash(normalized_key
));
1406 k
.key
= normalized_key
;
1407 found_entry
= hashmap_get(&cs
->config_hash
, &k
, NULL
);
1408 free(normalized_key
);
1412 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
1414 struct config_set_element
*e
;
1415 struct string_list_item
*si
;
1416 struct configset_list_item
*l_item
;
1417 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
1419 e
= configset_find_element(cs
, key
);
1421 * Since the keys are being fed by git_config*() callback mechanism, they
1422 * are already normalized. So simply add them without any further munging.
1425 e
= xmalloc(sizeof(*e
));
1426 hashmap_entry_init(e
, strhash(key
));
1427 e
->key
= xstrdup(key
);
1428 string_list_init(&e
->value_list
, 1);
1429 hashmap_add(&cs
->config_hash
, e
);
1431 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
1433 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
1434 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
1436 l_item
->value_index
= e
->value_list
.nr
- 1;
1439 die("BUG: configset_add_value has no source");
1441 kv_info
->filename
= strintern(cf
->name
);
1442 kv_info
->linenr
= cf
->linenr
;
1443 kv_info
->origin_type
= cf
->origin_type
;
1445 /* for values read from `git_config_from_parameters()` */
1446 kv_info
->filename
= NULL
;
1447 kv_info
->linenr
= -1;
1448 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
1450 kv_info
->scope
= current_parsing_scope
;
1456 static int config_set_element_cmp(const struct config_set_element
*e1
,
1457 const struct config_set_element
*e2
, const void *unused
)
1459 return strcmp(e1
->key
, e2
->key
);
1462 void git_configset_init(struct config_set
*cs
)
1464 hashmap_init(&cs
->config_hash
, (hashmap_cmp_fn
)config_set_element_cmp
, 0);
1465 cs
->hash_initialized
= 1;
1468 cs
->list
.items
= NULL
;
1471 void git_configset_clear(struct config_set
*cs
)
1473 struct config_set_element
*entry
;
1474 struct hashmap_iter iter
;
1475 if (!cs
->hash_initialized
)
1478 hashmap_iter_init(&cs
->config_hash
, &iter
);
1479 while ((entry
= hashmap_iter_next(&iter
))) {
1481 string_list_clear(&entry
->value_list
, 1);
1483 hashmap_free(&cs
->config_hash
, 1);
1484 cs
->hash_initialized
= 0;
1485 free(cs
->list
.items
);
1488 cs
->list
.items
= NULL
;
1491 static int config_set_callback(const char *key
, const char *value
, void *cb
)
1493 struct config_set
*cs
= cb
;
1494 configset_add_value(cs
, key
, value
);
1498 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
1500 return git_config_from_file(config_set_callback
, filename
, cs
);
1503 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
1505 const struct string_list
*values
= NULL
;
1507 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1508 * queried key in the files of the configset, the value returned will be the last
1509 * value in the value list for that key.
1511 values
= git_configset_get_value_multi(cs
, key
);
1515 assert(values
->nr
> 0);
1516 *value
= values
->items
[values
->nr
- 1].string
;
1520 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
1522 struct config_set_element
*e
= configset_find_element(cs
, key
);
1523 return e
? &e
->value_list
: NULL
;
1526 int git_configset_get_string_const(struct config_set
*cs
, const char *key
, const char **dest
)
1529 if (!git_configset_get_value(cs
, key
, &value
))
1530 return git_config_string(dest
, key
, value
);
1535 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
1537 return git_configset_get_string_const(cs
, key
, (const char **)dest
);
1540 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
1543 if (!git_configset_get_value(cs
, key
, &value
)) {
1544 *dest
= git_config_int(key
, value
);
1550 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
1553 if (!git_configset_get_value(cs
, key
, &value
)) {
1554 *dest
= git_config_ulong(key
, value
);
1560 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
1563 if (!git_configset_get_value(cs
, key
, &value
)) {
1564 *dest
= git_config_bool(key
, value
);
1570 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
1571 int *is_bool
, int *dest
)
1574 if (!git_configset_get_value(cs
, key
, &value
)) {
1575 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
1581 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
1584 if (!git_configset_get_value(cs
, key
, &value
)) {
1585 *dest
= git_config_maybe_bool(key
, value
);
1593 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
1596 if (!git_configset_get_value(cs
, key
, &value
))
1597 return git_config_pathname(dest
, key
, value
);
1602 static void git_config_check_init(void)
1604 if (the_config_set
.hash_initialized
)
1606 git_configset_init(&the_config_set
);
1607 git_config_raw(config_set_callback
, &the_config_set
);
1610 void git_config_clear(void)
1612 if (!the_config_set
.hash_initialized
)
1614 git_configset_clear(&the_config_set
);
1617 int git_config_get_value(const char *key
, const char **value
)
1619 git_config_check_init();
1620 return git_configset_get_value(&the_config_set
, key
, value
);
1623 const struct string_list
*git_config_get_value_multi(const char *key
)
1625 git_config_check_init();
1626 return git_configset_get_value_multi(&the_config_set
, key
);
1629 int git_config_get_string_const(const char *key
, const char **dest
)
1632 git_config_check_init();
1633 ret
= git_configset_get_string_const(&the_config_set
, key
, dest
);
1635 git_die_config(key
, NULL
);
1639 int git_config_get_string(const char *key
, char **dest
)
1641 git_config_check_init();
1642 return git_config_get_string_const(key
, (const char **)dest
);
1645 int git_config_get_int(const char *key
, int *dest
)
1647 git_config_check_init();
1648 return git_configset_get_int(&the_config_set
, key
, dest
);
1651 int git_config_get_ulong(const char *key
, unsigned long *dest
)
1653 git_config_check_init();
1654 return git_configset_get_ulong(&the_config_set
, key
, dest
);
1657 int git_config_get_bool(const char *key
, int *dest
)
1659 git_config_check_init();
1660 return git_configset_get_bool(&the_config_set
, key
, dest
);
1663 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
1665 git_config_check_init();
1666 return git_configset_get_bool_or_int(&the_config_set
, key
, is_bool
, dest
);
1669 int git_config_get_maybe_bool(const char *key
, int *dest
)
1671 git_config_check_init();
1672 return git_configset_get_maybe_bool(&the_config_set
, key
, dest
);
1675 int git_config_get_pathname(const char *key
, const char **dest
)
1678 git_config_check_init();
1679 ret
= git_configset_get_pathname(&the_config_set
, key
, dest
);
1681 git_die_config(key
, NULL
);
1685 int git_config_get_untracked_cache(void)
1690 /* Hack for test programs like test-dump-untracked-cache */
1691 if (ignore_untracked_cache_config
)
1694 if (!git_config_get_maybe_bool("core.untrackedcache", &val
))
1697 if (!git_config_get_value("core.untrackedcache", &v
)) {
1698 if (!strcasecmp(v
, "keep"))
1701 error("unknown core.untrackedCache value '%s'; "
1702 "using 'keep' default value", v
);
1706 return -1; /* default value */
1710 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
1713 die(_("unable to parse '%s' from command-line config"), key
);
1715 die(_("bad config variable '%s' in file '%s' at line %d"),
1716 key
, filename
, linenr
);
1719 NORETURN
__attribute__((format(printf
, 2, 3)))
1720 void git_die_config(const char *key
, const char *err
, ...)
1722 const struct string_list
*values
;
1723 struct key_value_info
*kv_info
;
1727 va_start(params
, err
);
1728 vreportf("error: ", err
, params
);
1731 values
= git_config_get_value_multi(key
);
1732 kv_info
= values
->items
[values
->nr
- 1].util
;
1733 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
1737 * Find all the stuff for git_config_set() below.
1744 regex_t
*value_regex
;
1747 unsigned int offset_alloc
;
1748 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1752 static int matches(const char *key
, const char *value
)
1754 if (strcmp(key
, store
.key
))
1755 return 0; /* not ours */
1756 if (!store
.value_regex
)
1757 return 1; /* always matches */
1758 if (store
.value_regex
== CONFIG_REGEX_NONE
)
1759 return 0; /* never matches */
1761 return store
.do_not_match
^
1762 (value
&& !regexec(store
.value_regex
, value
, 0, NULL
, 0));
1765 static int store_aux(const char *key
, const char *value
, void *cb
)
1770 switch (store
.state
) {
1772 if (matches(key
, value
)) {
1773 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1774 warning(_("%s has multiple values"), key
);
1777 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1778 store
.offset_alloc
);
1780 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1786 * What we are looking for is in store.key (both
1787 * section and var), and its section part is baselen
1788 * long. We found key (again, both section and var).
1789 * We would want to know if this key is in the same
1790 * section as what we are looking for. We already
1791 * know we are in the same section as what should
1794 ep
= strrchr(key
, '.');
1795 section_len
= ep
- key
;
1797 if ((section_len
!= store
.baselen
) ||
1798 memcmp(key
, store
.key
, section_len
+1)) {
1799 store
.state
= SECTION_END_SEEN
;
1804 * Do not increment matches: this is no match, but we
1805 * just made sure we are in the desired section.
1807 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1808 store
.offset_alloc
);
1809 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1811 case SECTION_END_SEEN
:
1813 if (matches(key
, value
)) {
1814 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1815 store
.offset_alloc
);
1816 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1817 store
.state
= KEY_SEEN
;
1820 if (strrchr(key
, '.') - key
== store
.baselen
&&
1821 !strncmp(key
, store
.key
, store
.baselen
)) {
1822 store
.state
= SECTION_SEEN
;
1823 ALLOC_GROW(store
.offset
,
1825 store
.offset_alloc
);
1826 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1833 static int write_error(const char *filename
)
1835 error("failed to write new configuration file %s", filename
);
1837 /* Same error code as "failed to rename". */
1841 static int store_write_section(int fd
, const char *key
)
1845 struct strbuf sb
= STRBUF_INIT
;
1847 dot
= memchr(key
, '.', store
.baselen
);
1849 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1850 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1851 if (key
[i
] == '"' || key
[i
] == '\\')
1852 strbuf_addch(&sb
, '\\');
1853 strbuf_addch(&sb
, key
[i
]);
1855 strbuf_addstr(&sb
, "\"]\n");
1857 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1860 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1861 strbuf_release(&sb
);
1866 static int store_write_pair(int fd
, const char *key
, const char *value
)
1869 int length
= strlen(key
+ store
.baselen
+ 1);
1870 const char *quote
= "";
1871 struct strbuf sb
= STRBUF_INIT
;
1874 * Check to see if the value needs to be surrounded with a dq pair.
1875 * Note that problematic characters are always backslash-quoted; this
1876 * check is about not losing leading or trailing SP and strings that
1877 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1878 * configuration parser.
1880 if (value
[0] == ' ')
1882 for (i
= 0; value
[i
]; i
++)
1883 if (value
[i
] == ';' || value
[i
] == '#')
1885 if (i
&& value
[i
- 1] == ' ')
1888 strbuf_addf(&sb
, "\t%.*s = %s",
1889 length
, key
+ store
.baselen
+ 1, quote
);
1891 for (i
= 0; value
[i
]; i
++)
1894 strbuf_addstr(&sb
, "\\n");
1897 strbuf_addstr(&sb
, "\\t");
1901 strbuf_addch(&sb
, '\\');
1903 strbuf_addch(&sb
, value
[i
]);
1906 strbuf_addf(&sb
, "%s\n", quote
);
1908 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1909 strbuf_release(&sb
);
1914 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1915 size_t offset_
, int *found_bracket
)
1917 size_t equal_offset
= size
, bracket_offset
= size
;
1921 for (offset
= offset_
-2; offset
> 0
1922 && contents
[offset
] != '\n'; offset
--)
1923 switch (contents
[offset
]) {
1924 case '=': equal_offset
= offset
; break;
1925 case ']': bracket_offset
= offset
; break;
1927 if (offset
> 0 && contents
[offset
-1] == '\\') {
1931 if (bracket_offset
< equal_offset
) {
1933 offset
= bracket_offset
+1;
1940 int git_config_set_in_file_gently(const char *config_filename
,
1941 const char *key
, const char *value
)
1943 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
1946 void git_config_set_in_file(const char *config_filename
,
1947 const char *key
, const char *value
)
1949 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1952 int git_config_set_gently(const char *key
, const char *value
)
1954 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
1957 void git_config_set(const char *key
, const char *value
)
1959 git_config_set_multivar(key
, value
, NULL
, 0);
1963 * Auxiliary function to sanity-check and split the key into the section
1964 * identifier and variable name.
1966 * Returns 0 on success, -1 when there is an invalid character in the key and
1967 * -2 if there is no section name in the key.
1969 * store_key - pointer to char* which will hold a copy of the key with
1970 * lowercase section and variable name
1971 * baselen - pointer to int which will hold the length of the
1972 * section + subsection part, can be NULL
1974 static int git_config_parse_key_1(const char *key
, char **store_key
, int *baselen_
, int quiet
)
1976 int i
, dot
, baselen
;
1977 const char *last_dot
= strrchr(key
, '.');
1980 * Since "key" actually contains the section name and the real
1981 * key name separated by a dot, we have to know where the dot is.
1984 if (last_dot
== NULL
|| last_dot
== key
) {
1986 error("key does not contain a section: %s", key
);
1987 return -CONFIG_NO_SECTION_OR_NAME
;
1992 error("key does not contain variable name: %s", key
);
1993 return -CONFIG_NO_SECTION_OR_NAME
;
1996 baselen
= last_dot
- key
;
1998 *baselen_
= baselen
;
2001 * Validate the key and while at it, lower case it for matching.
2004 *store_key
= xmallocz(strlen(key
));
2007 for (i
= 0; key
[i
]; i
++) {
2008 unsigned char c
= key
[i
];
2011 /* Leave the extended basename untouched.. */
2012 if (!dot
|| i
> baselen
) {
2013 if (!iskeychar(c
) ||
2014 (i
== baselen
+ 1 && !isalpha(c
))) {
2016 error("invalid key: %s", key
);
2017 goto out_free_ret_1
;
2020 } else if (c
== '\n') {
2022 error("invalid key (newline): %s", key
);
2023 goto out_free_ret_1
;
2026 (*store_key
)[i
] = c
;
2036 return -CONFIG_INVALID_KEY
;
2039 int git_config_parse_key(const char *key
, char **store_key
, int *baselen
)
2041 return git_config_parse_key_1(key
, store_key
, baselen
, 0);
2044 int git_config_key_is_valid(const char *key
)
2046 return !git_config_parse_key_1(key
, NULL
, NULL
, 1);
2050 * If value==NULL, unset in (remove from) config,
2051 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2052 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2053 * (only add a new one)
2054 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2055 * else all matching key/values (regardless how many) are removed,
2056 * before the new pair is written.
2058 * Returns 0 on success.
2060 * This function does this:
2062 * - it locks the config file by creating ".git/config.lock"
2064 * - it then parses the config using store_aux() as validator to find
2065 * the position on the key/value pair to replace. If it is to be unset,
2066 * it must be found exactly once.
2068 * - the config file is mmap()ed and the part before the match (if any) is
2069 * written to the lock file, then the changed part and the rest.
2071 * - the config file is removed and the lock file rename()d to it.
2074 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2075 const char *key
, const char *value
,
2076 const char *value_regex
,
2079 int fd
= -1, in_fd
= -1;
2081 struct lock_file
*lock
= NULL
;
2082 char *filename_buf
= NULL
;
2083 char *contents
= NULL
;
2086 /* parse-key returns negative; flip the sign to feed exit(3) */
2087 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2091 store
.multi_replace
= multi_replace
;
2093 if (!config_filename
)
2094 config_filename
= filename_buf
= git_pathdup("config");
2097 * The lock serves a purpose in addition to locking: the new
2098 * contents of .git/config will be written into it.
2100 lock
= xcalloc(1, sizeof(struct lock_file
));
2101 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2103 error_errno("could not lock config file %s", config_filename
);
2105 ret
= CONFIG_NO_LOCK
;
2110 * If .git/config does not exist yet, write a minimal version.
2112 in_fd
= open(config_filename
, O_RDONLY
);
2116 if ( ENOENT
!= errno
) {
2117 error_errno("opening %s", config_filename
);
2118 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2121 /* if nothing to unset, error out */
2122 if (value
== NULL
) {
2123 ret
= CONFIG_NOTHING_SET
;
2127 store
.key
= (char *)key
;
2128 if (!store_write_section(fd
, key
) ||
2129 !store_write_pair(fd
, key
, value
))
2133 size_t copy_begin
, copy_end
;
2134 int i
, new_line
= 0;
2136 if (value_regex
== NULL
)
2137 store
.value_regex
= NULL
;
2138 else if (value_regex
== CONFIG_REGEX_NONE
)
2139 store
.value_regex
= CONFIG_REGEX_NONE
;
2141 if (value_regex
[0] == '!') {
2142 store
.do_not_match
= 1;
2145 store
.do_not_match
= 0;
2147 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
2148 if (regcomp(store
.value_regex
, value_regex
,
2150 error("invalid pattern: %s", value_regex
);
2151 free(store
.value_regex
);
2152 ret
= CONFIG_INVALID_PATTERN
;
2157 ALLOC_GROW(store
.offset
, 1, store
.offset_alloc
);
2158 store
.offset
[0] = 0;
2159 store
.state
= START
;
2163 * After this, store.offset will contain the *end* offset
2164 * of the last match, or remain at 0 if no match was found.
2165 * As a side effect, we make sure to transform only a valid
2166 * existing config file.
2168 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
2169 error("invalid config file %s", config_filename
);
2171 if (store
.value_regex
!= NULL
&&
2172 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2173 regfree(store
.value_regex
);
2174 free(store
.value_regex
);
2176 ret
= CONFIG_INVALID_FILE
;
2181 if (store
.value_regex
!= NULL
&&
2182 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2183 regfree(store
.value_regex
);
2184 free(store
.value_regex
);
2187 /* if nothing to unset, or too many matches, error out */
2188 if ((store
.seen
== 0 && value
== NULL
) ||
2189 (store
.seen
> 1 && multi_replace
== 0)) {
2190 ret
= CONFIG_NOTHING_SET
;
2195 contents_sz
= xsize_t(st
.st_size
);
2196 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
2197 MAP_PRIVATE
, in_fd
, 0);
2198 if (contents
== MAP_FAILED
) {
2199 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
2201 error_errno("unable to mmap '%s'", config_filename
);
2202 ret
= CONFIG_INVALID_FILE
;
2209 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2210 error_errno("chmod on %s failed", get_lock_file_path(lock
));
2211 ret
= CONFIG_NO_WRITE
;
2215 if (store
.seen
== 0)
2218 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
2219 if (store
.offset
[i
] == 0) {
2220 store
.offset
[i
] = copy_end
= contents_sz
;
2221 } else if (store
.state
!= KEY_SEEN
) {
2222 copy_end
= store
.offset
[i
];
2224 copy_end
= find_beginning_of_line(
2225 contents
, contents_sz
,
2226 store
.offset
[i
]-2, &new_line
);
2228 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
2231 /* write the first part of the config */
2232 if (copy_end
> copy_begin
) {
2233 if (write_in_full(fd
, contents
+ copy_begin
,
2234 copy_end
- copy_begin
) <
2235 copy_end
- copy_begin
)
2238 write_str_in_full(fd
, "\n") != 1)
2241 copy_begin
= store
.offset
[i
];
2244 /* write the pair (value == NULL means unset) */
2245 if (value
!= NULL
) {
2246 if (store
.state
== START
) {
2247 if (!store_write_section(fd
, key
))
2250 if (!store_write_pair(fd
, key
, value
))
2254 /* write the rest of the config */
2255 if (copy_begin
< contents_sz
)
2256 if (write_in_full(fd
, contents
+ copy_begin
,
2257 contents_sz
- copy_begin
) <
2258 contents_sz
- copy_begin
)
2261 munmap(contents
, contents_sz
);
2265 if (commit_lock_file(lock
) < 0) {
2266 error_errno("could not write config file %s", config_filename
);
2267 ret
= CONFIG_NO_WRITE
;
2273 * lock is committed, so don't try to roll it back below.
2274 * NOTE: Since lockfile.c keeps a linked list of all created
2275 * lock_file structures, it isn't safe to free(lock). It's
2276 * better to just leave it hanging around.
2281 /* Invalidate the config cache */
2286 rollback_lock_file(lock
);
2289 munmap(contents
, contents_sz
);
2295 ret
= write_error(get_lock_file_path(lock
));
2300 void git_config_set_multivar_in_file(const char *config_filename
,
2301 const char *key
, const char *value
,
2302 const char *value_regex
, int multi_replace
)
2304 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
2305 value_regex
, multi_replace
))
2308 die(_("could not set '%s' to '%s'"), key
, value
);
2310 die(_("could not unset '%s'"), key
);
2313 int git_config_set_multivar_gently(const char *key
, const char *value
,
2314 const char *value_regex
, int multi_replace
)
2316 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_regex
,
2320 void git_config_set_multivar(const char *key
, const char *value
,
2321 const char *value_regex
, int multi_replace
)
2323 git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
2327 static int section_name_match (const char *buf
, const char *name
)
2329 int i
= 0, j
= 0, dot
= 0;
2332 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
2333 if (!dot
&& isspace(buf
[i
])) {
2335 if (name
[j
++] != '.')
2337 for (i
++; isspace(buf
[i
]); i
++)
2343 if (buf
[i
] == '\\' && dot
)
2345 else if (buf
[i
] == '"' && dot
) {
2346 for (i
++; isspace(buf
[i
]); i
++)
2350 if (buf
[i
] != name
[j
++])
2353 if (buf
[i
] == ']' && name
[j
] == 0) {
2355 * We match, now just find the right length offset by
2356 * gobbling up any whitespace after it, as well
2359 for (; buf
[i
] && isspace(buf
[i
]); i
++)
2366 static int section_name_is_ok(const char *name
)
2368 /* Empty section names are bogus. */
2373 * Before a dot, we must be alphanumeric or dash. After the first dot,
2374 * anything goes, so we can stop checking.
2376 for (; *name
&& *name
!= '.'; name
++)
2377 if (*name
!= '-' && !isalnum(*name
))
2382 /* if new_name == NULL, the section is removed instead */
2383 int git_config_rename_section_in_file(const char *config_filename
,
2384 const char *old_name
, const char *new_name
)
2386 int ret
= 0, remove
= 0;
2387 char *filename_buf
= NULL
;
2388 struct lock_file
*lock
;
2394 if (new_name
&& !section_name_is_ok(new_name
)) {
2395 ret
= error("invalid section name: %s", new_name
);
2399 if (!config_filename
)
2400 config_filename
= filename_buf
= git_pathdup("config");
2402 lock
= xcalloc(1, sizeof(struct lock_file
));
2403 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2405 ret
= error("could not lock config file %s", config_filename
);
2409 if (!(config_file
= fopen(config_filename
, "rb"))) {
2410 /* no config file means nothing to rename, no error */
2411 goto unlock_and_out
;
2414 fstat(fileno(config_file
), &st
);
2416 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2417 ret
= error_errno("chmod on %s failed",
2418 get_lock_file_path(lock
));
2422 while (fgets(buf
, sizeof(buf
), config_file
)) {
2426 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
2428 if (buf
[i
] == '[') {
2429 /* it's a section */
2430 int offset
= section_name_match(&buf
[i
], old_name
);
2433 if (new_name
== NULL
) {
2437 store
.baselen
= strlen(new_name
);
2438 if (!store_write_section(out_fd
, new_name
)) {
2439 ret
= write_error(get_lock_file_path(lock
));
2443 * We wrote out the new section, with
2444 * a newline, now skip the old
2447 output
+= offset
+ i
;
2448 if (strlen(output
) > 0) {
2450 * More content means there's
2451 * a declaration to put on the
2452 * next line; indent with a
2463 length
= strlen(output
);
2464 if (write_in_full(out_fd
, output
, length
) != length
) {
2465 ret
= write_error(get_lock_file_path(lock
));
2469 fclose(config_file
);
2471 if (commit_lock_file(lock
) < 0)
2472 ret
= error_errno("could not write config file %s",
2479 int git_config_rename_section(const char *old_name
, const char *new_name
)
2481 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
2485 * Call this to report error for your variable that should not
2486 * get a boolean value (i.e. "[my] var" means "true").
2488 #undef config_error_nonbool
2489 int config_error_nonbool(const char *var
)
2491 return error("missing value for '%s'", var
);
2494 int parse_config_key(const char *var
,
2495 const char *section
,
2496 const char **subsection
, int *subsection_len
,
2499 int section_len
= strlen(section
);
2502 /* Does it start with "section." ? */
2503 if (!starts_with(var
, section
) || var
[section_len
] != '.')
2507 * Find the key; we don't know yet if we have a subsection, but we must
2508 * parse backwards from the end, since the subsection may have dots in
2511 dot
= strrchr(var
, '.');
2514 /* Did we have a subsection at all? */
2515 if (dot
== var
+ section_len
) {
2517 *subsection_len
= 0;
2520 *subsection
= var
+ section_len
+ 1;
2521 *subsection_len
= dot
- *subsection
;
2527 const char *current_config_origin_type(void)
2530 if (current_config_kvi
)
2531 type
= current_config_kvi
->origin_type
;
2533 type
= cf
->origin_type
;
2535 die("BUG: current_config_origin_type called outside config callback");
2538 case CONFIG_ORIGIN_BLOB
:
2540 case CONFIG_ORIGIN_FILE
:
2542 case CONFIG_ORIGIN_STDIN
:
2543 return "standard input";
2544 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
2545 return "submodule-blob";
2546 case CONFIG_ORIGIN_CMDLINE
:
2547 return "command line";
2549 die("BUG: unknown config origin type");
2553 const char *current_config_name(void)
2556 if (current_config_kvi
)
2557 name
= current_config_kvi
->filename
;
2561 die("BUG: current_config_name called outside config callback");
2562 return name
? name
: "";
2565 enum config_scope
current_config_scope(void)
2567 if (current_config_kvi
)
2568 return current_config_kvi
->scope
;
2570 return current_parsing_scope
;