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 const char *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
));
250 /* sq_dequote will write over it */
253 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
254 ret
= error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
258 for (i
= 0; i
< nr
; i
++) {
259 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
272 static int get_next_char(void)
274 int c
= cf
->do_fgetc(cf
);
277 /* DOS like systems */
278 c
= cf
->do_fgetc(cf
);
281 cf
->do_ungetc(c
, cf
);
295 static char *parse_value(void)
297 int quote
= 0, comment
= 0, space
= 0;
299 strbuf_reset(&cf
->value
);
301 int c
= get_next_char();
307 return cf
->value
.buf
;
311 if (isspace(c
) && !quote
) {
317 if (c
== ';' || c
== '#') {
322 for (; space
; space
--)
323 strbuf_addch(&cf
->value
, ' ');
338 /* Some characters escape as themselves */
341 /* Reject unknown escape sequences */
345 strbuf_addch(&cf
->value
, c
);
352 strbuf_addch(&cf
->value
, c
);
356 static inline int iskeychar(int c
)
358 return isalnum(c
) || c
== '-';
361 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
367 /* Get the full name */
374 strbuf_addch(name
, tolower(c
));
377 while (c
== ' ' || c
== '\t')
384 value
= parse_value();
389 * We already consumed the \n, but we need linenr to point to
390 * the line we just parsed during the call to fn to get
391 * accurate line number in error messages.
394 ret
= fn(name
->buf
, value
, data
);
399 static int get_extended_base_var(struct strbuf
*name
, int c
)
403 goto error_incomplete_line
;
405 } while (isspace(c
));
407 /* We require the format to be '[base "extension"]' */
410 strbuf_addch(name
, '.');
413 int c
= get_next_char();
415 goto error_incomplete_line
;
421 goto error_incomplete_line
;
423 strbuf_addch(name
, c
);
427 if (get_next_char() != ']')
430 error_incomplete_line
:
435 static int get_base_var(struct strbuf
*name
)
438 int c
= get_next_char();
444 return get_extended_base_var(name
, c
);
445 if (!iskeychar(c
) && c
!= '.')
447 strbuf_addch(name
, tolower(c
));
451 static int git_parse_source(config_fn_t fn
, void *data
)
455 struct strbuf
*var
= &cf
->var
;
457 /* U+FEFF Byte Order Mark in UTF8 */
458 const char *bomptr
= utf8_bom
;
461 int c
= get_next_char();
462 if (bomptr
&& *bomptr
) {
463 /* We are at the file beginning; skip UTF8-encoded BOM
464 * if present. Sane editors won't put this in on their
465 * own, but e.g. Windows Notepad will do it happily. */
466 if (c
== (*bomptr
& 0377)) {
470 /* Do not tolerate partial BOM. */
471 if (bomptr
!= utf8_bom
)
473 /* No BOM at file beginning. Cool. */
483 if (comment
|| isspace(c
))
485 if (c
== '#' || c
== ';') {
490 /* Reset prior to determining a new stem */
492 if (get_base_var(var
) < 0 || var
->len
< 1)
494 strbuf_addch(var
, '.');
501 * Truncate the var name back to the section header
502 * stem prior to grabbing the suffix part of the name
505 strbuf_setlen(var
, baselen
);
506 strbuf_addch(var
, tolower(c
));
507 if (get_value(fn
, data
, var
) < 0)
510 if (cf
->die_on_error
)
511 die(_("bad config line %d in %s %s"), cf
->linenr
, cf
->origin_type
, cf
->name
);
513 return error(_("bad config line %d in %s %s"), cf
->linenr
, cf
->origin_type
, cf
->name
);
516 static int parse_unit_factor(const char *end
, uintmax_t *val
)
520 else if (!strcasecmp(end
, "k")) {
524 else if (!strcasecmp(end
, "m")) {
528 else if (!strcasecmp(end
, "g")) {
529 *val
*= 1024 * 1024 * 1024;
535 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
537 if (value
&& *value
) {
541 uintmax_t factor
= 1;
544 val
= strtoimax(value
, &end
, 0);
547 if (!parse_unit_factor(end
, &factor
)) {
553 if (uval
> max
|| labs(val
) > uval
) {
565 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
567 if (value
&& *value
) {
573 val
= strtoumax(value
, &end
, 0);
577 if (!parse_unit_factor(end
, &val
)) {
581 if (val
> max
|| oldval
> val
) {
592 static int git_parse_int(const char *value
, int *ret
)
595 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
601 static int git_parse_int64(const char *value
, int64_t *ret
)
604 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
610 int git_parse_ulong(const char *value
, unsigned long *ret
)
613 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
620 static void die_bad_number(const char *name
, const char *value
)
622 const char *reason
= errno
== ERANGE
?
628 if (cf
&& cf
->origin_type
&& cf
->name
)
629 die(_("bad numeric config value '%s' for '%s' in %s %s: %s"),
630 value
, name
, cf
->origin_type
, cf
->name
, reason
);
631 die(_("bad numeric config value '%s' for '%s': %s"), value
, name
, reason
);
634 int git_config_int(const char *name
, const char *value
)
637 if (!git_parse_int(value
, &ret
))
638 die_bad_number(name
, value
);
642 int64_t git_config_int64(const char *name
, const char *value
)
645 if (!git_parse_int64(value
, &ret
))
646 die_bad_number(name
, value
);
650 unsigned long git_config_ulong(const char *name
, const char *value
)
653 if (!git_parse_ulong(value
, &ret
))
654 die_bad_number(name
, value
);
658 int git_parse_maybe_bool(const char *value
)
664 if (!strcasecmp(value
, "true")
665 || !strcasecmp(value
, "yes")
666 || !strcasecmp(value
, "on"))
668 if (!strcasecmp(value
, "false")
669 || !strcasecmp(value
, "no")
670 || !strcasecmp(value
, "off"))
675 int git_config_maybe_bool(const char *name
, const char *value
)
677 int v
= git_parse_maybe_bool(value
);
680 if (git_parse_int(value
, &v
))
685 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
687 int v
= git_parse_maybe_bool(value
);
693 return git_config_int(name
, value
);
696 int git_config_bool(const char *name
, const char *value
)
699 return !!git_config_bool_or_int(name
, value
, &discard
);
702 int git_config_string(const char **dest
, const char *var
, const char *value
)
705 return config_error_nonbool(var
);
706 *dest
= xstrdup(value
);
710 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
713 return config_error_nonbool(var
);
714 *dest
= expand_user_path(value
);
716 die(_("failed to expand user dir in: '%s'"), value
);
720 static int git_default_core_config(const char *var
, const char *value
)
722 /* This needs a better name */
723 if (!strcmp(var
, "core.filemode")) {
724 trust_executable_bit
= git_config_bool(var
, value
);
727 if (!strcmp(var
, "core.trustctime")) {
728 trust_ctime
= git_config_bool(var
, value
);
731 if (!strcmp(var
, "core.checkstat")) {
732 if (!strcasecmp(value
, "default"))
734 else if (!strcasecmp(value
, "minimal"))
738 if (!strcmp(var
, "core.quotepath")) {
739 quote_path_fully
= git_config_bool(var
, value
);
743 if (!strcmp(var
, "core.symlinks")) {
744 has_symlinks
= git_config_bool(var
, value
);
748 if (!strcmp(var
, "core.ignorecase")) {
749 ignore_case
= git_config_bool(var
, value
);
753 if (!strcmp(var
, "core.attributesfile"))
754 return git_config_pathname(&git_attributes_file
, var
, value
);
756 if (!strcmp(var
, "core.hookspath"))
757 return git_config_pathname(&git_hooks_path
, var
, value
);
759 if (!strcmp(var
, "core.bare")) {
760 is_bare_repository_cfg
= git_config_bool(var
, value
);
764 if (!strcmp(var
, "core.ignorestat")) {
765 assume_unchanged
= git_config_bool(var
, value
);
769 if (!strcmp(var
, "core.prefersymlinkrefs")) {
770 prefer_symlink_refs
= git_config_bool(var
, value
);
774 if (!strcmp(var
, "core.logallrefupdates")) {
775 log_all_ref_updates
= git_config_bool(var
, value
);
779 if (!strcmp(var
, "core.warnambiguousrefs")) {
780 warn_ambiguous_refs
= git_config_bool(var
, value
);
784 if (!strcmp(var
, "core.abbrev")) {
785 int abbrev
= git_config_int(var
, value
);
786 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
788 default_abbrev
= abbrev
;
792 if (!strcmp(var
, "core.loosecompression")) {
793 int level
= git_config_int(var
, value
);
795 level
= Z_DEFAULT_COMPRESSION
;
796 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
797 die(_("bad zlib compression level %d"), level
);
798 zlib_compression_level
= level
;
799 zlib_compression_seen
= 1;
803 if (!strcmp(var
, "core.compression")) {
804 int level
= git_config_int(var
, value
);
806 level
= Z_DEFAULT_COMPRESSION
;
807 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
808 die(_("bad zlib compression level %d"), level
);
809 core_compression_level
= level
;
810 core_compression_seen
= 1;
811 if (!zlib_compression_seen
)
812 zlib_compression_level
= level
;
816 if (!strcmp(var
, "core.packedgitwindowsize")) {
817 int pgsz_x2
= getpagesize() * 2;
818 packed_git_window_size
= git_config_ulong(var
, value
);
820 /* This value must be multiple of (pagesize * 2) */
821 packed_git_window_size
/= pgsz_x2
;
822 if (packed_git_window_size
< 1)
823 packed_git_window_size
= 1;
824 packed_git_window_size
*= pgsz_x2
;
828 if (!strcmp(var
, "core.bigfilethreshold")) {
829 big_file_threshold
= git_config_ulong(var
, value
);
833 if (!strcmp(var
, "core.packedgitlimit")) {
834 packed_git_limit
= git_config_ulong(var
, value
);
838 if (!strcmp(var
, "core.deltabasecachelimit")) {
839 delta_base_cache_limit
= git_config_ulong(var
, value
);
843 if (!strcmp(var
, "core.autocrlf")) {
844 if (value
&& !strcasecmp(value
, "input")) {
845 auto_crlf
= AUTO_CRLF_INPUT
;
848 auto_crlf
= git_config_bool(var
, value
);
852 if (!strcmp(var
, "core.safecrlf")) {
853 if (value
&& !strcasecmp(value
, "warn")) {
854 safe_crlf
= SAFE_CRLF_WARN
;
857 safe_crlf
= git_config_bool(var
, value
);
861 if (!strcmp(var
, "core.eol")) {
862 if (value
&& !strcasecmp(value
, "lf"))
864 else if (value
&& !strcasecmp(value
, "crlf"))
866 else if (value
&& !strcasecmp(value
, "native"))
867 core_eol
= EOL_NATIVE
;
869 core_eol
= EOL_UNSET
;
873 if (!strcmp(var
, "core.notesref")) {
874 notes_ref_name
= xstrdup(value
);
878 if (!strcmp(var
, "core.pager"))
879 return git_config_string(&pager_program
, var
, value
);
881 if (!strcmp(var
, "core.editor"))
882 return git_config_string(&editor_program
, var
, value
);
884 if (!strcmp(var
, "core.commentchar")) {
886 return config_error_nonbool(var
);
887 else if (!strcasecmp(value
, "auto"))
888 auto_comment_line_char
= 1;
889 else if (value
[0] && !value
[1]) {
890 comment_line_char
= value
[0];
891 auto_comment_line_char
= 0;
893 return error("core.commentChar should only be one character");
897 if (!strcmp(var
, "core.askpass"))
898 return git_config_string(&askpass_program
, var
, value
);
900 if (!strcmp(var
, "core.excludesfile"))
901 return git_config_pathname(&excludes_file
, var
, value
);
903 if (!strcmp(var
, "core.whitespace")) {
905 return config_error_nonbool(var
);
906 whitespace_rule_cfg
= parse_whitespace_rule(value
);
910 if (!strcmp(var
, "core.fsyncobjectfiles")) {
911 fsync_object_files
= git_config_bool(var
, value
);
915 if (!strcmp(var
, "core.preloadindex")) {
916 core_preload_index
= git_config_bool(var
, value
);
920 if (!strcmp(var
, "core.createobject")) {
921 if (!strcmp(value
, "rename"))
922 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
923 else if (!strcmp(value
, "link"))
924 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
926 die(_("invalid mode for object creation: %s"), value
);
930 if (!strcmp(var
, "core.sparsecheckout")) {
931 core_apply_sparse_checkout
= git_config_bool(var
, value
);
935 if (!strcmp(var
, "core.precomposeunicode")) {
936 precomposed_unicode
= git_config_bool(var
, value
);
940 if (!strcmp(var
, "core.protecthfs")) {
941 protect_hfs
= git_config_bool(var
, value
);
945 if (!strcmp(var
, "core.protectntfs")) {
946 protect_ntfs
= git_config_bool(var
, value
);
950 if (!strcmp(var
, "core.hidedotfiles")) {
951 if (value
&& !strcasecmp(value
, "dotgitonly"))
952 hide_dotfiles
= HIDE_DOTFILES_DOTGITONLY
;
954 hide_dotfiles
= git_config_bool(var
, value
);
958 /* Add other config variables here and to Documentation/config.txt. */
962 static int git_default_i18n_config(const char *var
, const char *value
)
964 if (!strcmp(var
, "i18n.commitencoding"))
965 return git_config_string(&git_commit_encoding
, var
, value
);
967 if (!strcmp(var
, "i18n.logoutputencoding"))
968 return git_config_string(&git_log_output_encoding
, var
, value
);
970 /* Add other config variables here and to Documentation/config.txt. */
974 static int git_default_branch_config(const char *var
, const char *value
)
976 if (!strcmp(var
, "branch.autosetupmerge")) {
977 if (value
&& !strcasecmp(value
, "always")) {
978 git_branch_track
= BRANCH_TRACK_ALWAYS
;
981 git_branch_track
= git_config_bool(var
, value
);
984 if (!strcmp(var
, "branch.autosetuprebase")) {
986 return config_error_nonbool(var
);
987 else if (!strcmp(value
, "never"))
988 autorebase
= AUTOREBASE_NEVER
;
989 else if (!strcmp(value
, "local"))
990 autorebase
= AUTOREBASE_LOCAL
;
991 else if (!strcmp(value
, "remote"))
992 autorebase
= AUTOREBASE_REMOTE
;
993 else if (!strcmp(value
, "always"))
994 autorebase
= AUTOREBASE_ALWAYS
;
996 return error("malformed value for %s", var
);
1000 /* Add other config variables here and to Documentation/config.txt. */
1004 static int git_default_push_config(const char *var
, const char *value
)
1006 if (!strcmp(var
, "push.default")) {
1008 return config_error_nonbool(var
);
1009 else if (!strcmp(value
, "nothing"))
1010 push_default
= PUSH_DEFAULT_NOTHING
;
1011 else if (!strcmp(value
, "matching"))
1012 push_default
= PUSH_DEFAULT_MATCHING
;
1013 else if (!strcmp(value
, "simple"))
1014 push_default
= PUSH_DEFAULT_SIMPLE
;
1015 else if (!strcmp(value
, "upstream"))
1016 push_default
= PUSH_DEFAULT_UPSTREAM
;
1017 else if (!strcmp(value
, "tracking")) /* deprecated */
1018 push_default
= PUSH_DEFAULT_UPSTREAM
;
1019 else if (!strcmp(value
, "current"))
1020 push_default
= PUSH_DEFAULT_CURRENT
;
1022 error("malformed value for %s: %s", var
, value
);
1023 return error("Must be one of nothing, matching, simple, "
1024 "upstream or current.");
1029 /* Add other config variables here and to Documentation/config.txt. */
1033 static int git_default_mailmap_config(const char *var
, const char *value
)
1035 if (!strcmp(var
, "mailmap.file"))
1036 return git_config_pathname(&git_mailmap_file
, var
, value
);
1037 if (!strcmp(var
, "mailmap.blob"))
1038 return git_config_string(&git_mailmap_blob
, var
, value
);
1040 /* Add other config variables here and to Documentation/config.txt. */
1044 int git_default_config(const char *var
, const char *value
, void *dummy
)
1046 if (starts_with(var
, "core."))
1047 return git_default_core_config(var
, value
);
1049 if (starts_with(var
, "user."))
1050 return git_ident_config(var
, value
, dummy
);
1052 if (starts_with(var
, "i18n."))
1053 return git_default_i18n_config(var
, value
);
1055 if (starts_with(var
, "branch."))
1056 return git_default_branch_config(var
, value
);
1058 if (starts_with(var
, "push."))
1059 return git_default_push_config(var
, value
);
1061 if (starts_with(var
, "mailmap."))
1062 return git_default_mailmap_config(var
, value
);
1064 if (starts_with(var
, "advice."))
1065 return git_default_advice_config(var
, value
);
1067 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1068 pager_use_color
= git_config_bool(var
,value
);
1072 if (!strcmp(var
, "pack.packsizelimit")) {
1073 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1076 /* Add other config variables here and to Documentation/config.txt. */
1081 * All source specific fields in the union, die_on_error, name and the callbacks
1082 * fgetc, ungetc, ftell of top need to be initialized before calling
1085 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1089 /* push config-file parsing state stack */
1093 strbuf_init(&top
->value
, 1024);
1094 strbuf_init(&top
->var
, 1024);
1097 ret
= git_parse_source(fn
, data
);
1099 /* pop config-file parsing state stack */
1100 strbuf_release(&top
->value
);
1101 strbuf_release(&top
->var
);
1107 static int do_config_from_file(config_fn_t fn
,
1108 const char *origin_type
, const char *name
, const char *path
, FILE *f
,
1111 struct config_source top
;
1114 top
.origin_type
= origin_type
;
1117 top
.die_on_error
= 1;
1118 top
.do_fgetc
= config_file_fgetc
;
1119 top
.do_ungetc
= config_file_ungetc
;
1120 top
.do_ftell
= config_file_ftell
;
1122 return do_config_from(&top
, fn
, data
);
1125 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1127 return do_config_from_file(fn
, "standard input", "", NULL
, stdin
, data
);
1130 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1135 f
= fopen(filename
, "r");
1138 ret
= do_config_from_file(fn
, "file", filename
, filename
, f
, data
);
1145 int git_config_from_mem(config_fn_t fn
, const char *origin_type
,
1146 const char *name
, const char *buf
, size_t len
, void *data
)
1148 struct config_source top
;
1150 top
.u
.buf
.buf
= buf
;
1151 top
.u
.buf
.len
= len
;
1153 top
.origin_type
= origin_type
;
1156 top
.die_on_error
= 0;
1157 top
.do_fgetc
= config_buf_fgetc
;
1158 top
.do_ungetc
= config_buf_ungetc
;
1159 top
.do_ftell
= config_buf_ftell
;
1161 return do_config_from(&top
, fn
, data
);
1164 static int git_config_from_blob_sha1(config_fn_t fn
,
1166 const unsigned char *sha1
,
1169 enum object_type type
;
1174 buf
= read_sha1_file(sha1
, &type
, &size
);
1176 return error("unable to load config blob object '%s'", name
);
1177 if (type
!= OBJ_BLOB
) {
1179 return error("reference '%s' does not point to a blob", name
);
1182 ret
= git_config_from_mem(fn
, "blob", name
, buf
, size
, data
);
1188 static int git_config_from_blob_ref(config_fn_t fn
,
1192 unsigned char sha1
[20];
1194 if (get_sha1(name
, sha1
) < 0)
1195 return error("unable to resolve config blob '%s'", name
);
1196 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1199 const char *git_etc_gitconfig(void)
1201 static const char *system_wide
;
1203 system_wide
= system_path(ETC_GITCONFIG
);
1208 * Parse environment variable 'k' as a boolean (in various
1209 * possible spellings); if missing, use the default value 'def'.
1211 int git_env_bool(const char *k
, int def
)
1213 const char *v
= getenv(k
);
1214 return v
? git_config_bool(k
, v
) : def
;
1218 * Parse environment variable 'k' as ulong with possibly a unit
1219 * suffix; if missing, use the default value 'val'.
1221 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1223 const char *v
= getenv(k
);
1224 if (v
&& !git_parse_ulong(v
, &val
))
1225 die("failed to parse %s", k
);
1229 int git_config_system(void)
1231 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1234 static int do_git_config_sequence(config_fn_t fn
, void *data
)
1237 char *xdg_config
= xdg_config_home("config");
1238 char *user_config
= expand_user_path("~/.gitconfig");
1239 char *repo_config
= git_pathdup("config");
1241 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1242 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0))
1243 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1246 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1247 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1248 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1250 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1251 ret
+= git_config_from_file(fn
, user_config
, data
);
1253 current_parsing_scope
= CONFIG_SCOPE_REPO
;
1254 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0))
1255 ret
+= git_config_from_file(fn
, repo_config
, data
);
1257 current_parsing_scope
= CONFIG_SCOPE_CMDLINE
;
1258 if (git_config_from_parameters(fn
, data
) < 0)
1259 die(_("unable to parse command-line config"));
1261 current_parsing_scope
= CONFIG_SCOPE_UNKNOWN
;
1268 int git_config_with_options(config_fn_t fn
, void *data
,
1269 struct git_config_source
*config_source
,
1270 int respect_includes
)
1272 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1274 if (respect_includes
) {
1277 fn
= git_config_include
;
1282 * If we have a specific filename, use it. Otherwise, follow the
1283 * regular lookup sequence.
1285 if (config_source
&& config_source
->use_stdin
)
1286 return git_config_from_stdin(fn
, data
);
1287 else if (config_source
&& config_source
->file
)
1288 return git_config_from_file(fn
, config_source
->file
, data
);
1289 else if (config_source
&& config_source
->blob
)
1290 return git_config_from_blob_ref(fn
, config_source
->blob
, data
);
1292 return do_git_config_sequence(fn
, data
);
1295 static void git_config_raw(config_fn_t fn
, void *data
)
1297 if (git_config_with_options(fn
, data
, NULL
, 1) < 0)
1299 * git_config_with_options() normally returns only
1300 * zero, as most errors are fatal, and
1301 * non-fatal potential errors are guarded by "if"
1302 * statements that are entered only when no error is
1305 * If we ever encounter a non-fatal error, it means
1306 * something went really wrong and we should stop
1309 die(_("unknown error occurred while reading the configuration files"));
1312 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1315 struct string_list
*values
;
1316 struct config_set_element
*entry
;
1317 struct configset_list
*list
= &cs
->list
;
1319 for (i
= 0; i
< list
->nr
; i
++) {
1320 entry
= list
->items
[i
].e
;
1321 value_index
= list
->items
[i
].value_index
;
1322 values
= &entry
->value_list
;
1324 current_config_kvi
= values
->items
[value_index
].util
;
1326 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1327 git_die_config_linenr(entry
->key
,
1328 current_config_kvi
->filename
,
1329 current_config_kvi
->linenr
);
1331 current_config_kvi
= NULL
;
1335 static void git_config_check_init(void);
1337 void git_config(config_fn_t fn
, void *data
)
1339 git_config_check_init();
1340 configset_iter(&the_config_set
, fn
, data
);
1343 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
1345 struct config_set_element k
;
1346 struct config_set_element
*found_entry
;
1347 char *normalized_key
;
1349 * `key` may come from the user, so normalize it before using it
1350 * for querying entries from the hashmap.
1352 if (git_config_parse_key(key
, &normalized_key
, NULL
))
1355 hashmap_entry_init(&k
, strhash(normalized_key
));
1356 k
.key
= normalized_key
;
1357 found_entry
= hashmap_get(&cs
->config_hash
, &k
, NULL
);
1358 free(normalized_key
);
1362 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
1364 struct config_set_element
*e
;
1365 struct string_list_item
*si
;
1366 struct configset_list_item
*l_item
;
1367 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
1369 e
= configset_find_element(cs
, key
);
1371 * Since the keys are being fed by git_config*() callback mechanism, they
1372 * are already normalized. So simply add them without any further munging.
1375 e
= xmalloc(sizeof(*e
));
1376 hashmap_entry_init(e
, strhash(key
));
1377 e
->key
= xstrdup(key
);
1378 string_list_init(&e
->value_list
, 1);
1379 hashmap_add(&cs
->config_hash
, e
);
1381 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
1383 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
1384 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
1386 l_item
->value_index
= e
->value_list
.nr
- 1;
1389 die("BUG: configset_add_value has no source");
1391 kv_info
->filename
= strintern(cf
->name
);
1392 kv_info
->linenr
= cf
->linenr
;
1393 kv_info
->origin_type
= strintern(cf
->origin_type
);
1395 /* for values read from `git_config_from_parameters()` */
1396 kv_info
->filename
= NULL
;
1397 kv_info
->linenr
= -1;
1398 kv_info
->origin_type
= NULL
;
1400 kv_info
->scope
= current_parsing_scope
;
1406 static int config_set_element_cmp(const struct config_set_element
*e1
,
1407 const struct config_set_element
*e2
, const void *unused
)
1409 return strcmp(e1
->key
, e2
->key
);
1412 void git_configset_init(struct config_set
*cs
)
1414 hashmap_init(&cs
->config_hash
, (hashmap_cmp_fn
)config_set_element_cmp
, 0);
1415 cs
->hash_initialized
= 1;
1418 cs
->list
.items
= NULL
;
1421 void git_configset_clear(struct config_set
*cs
)
1423 struct config_set_element
*entry
;
1424 struct hashmap_iter iter
;
1425 if (!cs
->hash_initialized
)
1428 hashmap_iter_init(&cs
->config_hash
, &iter
);
1429 while ((entry
= hashmap_iter_next(&iter
))) {
1431 string_list_clear(&entry
->value_list
, 1);
1433 hashmap_free(&cs
->config_hash
, 1);
1434 cs
->hash_initialized
= 0;
1435 free(cs
->list
.items
);
1438 cs
->list
.items
= NULL
;
1441 static int config_set_callback(const char *key
, const char *value
, void *cb
)
1443 struct config_set
*cs
= cb
;
1444 configset_add_value(cs
, key
, value
);
1448 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
1450 return git_config_from_file(config_set_callback
, filename
, cs
);
1453 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
1455 const struct string_list
*values
= NULL
;
1457 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1458 * queried key in the files of the configset, the value returned will be the last
1459 * value in the value list for that key.
1461 values
= git_configset_get_value_multi(cs
, key
);
1465 assert(values
->nr
> 0);
1466 *value
= values
->items
[values
->nr
- 1].string
;
1470 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
1472 struct config_set_element
*e
= configset_find_element(cs
, key
);
1473 return e
? &e
->value_list
: NULL
;
1476 int git_configset_get_string_const(struct config_set
*cs
, const char *key
, const char **dest
)
1479 if (!git_configset_get_value(cs
, key
, &value
))
1480 return git_config_string(dest
, key
, value
);
1485 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
1487 return git_configset_get_string_const(cs
, key
, (const char **)dest
);
1490 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
1493 if (!git_configset_get_value(cs
, key
, &value
)) {
1494 *dest
= git_config_int(key
, value
);
1500 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
1503 if (!git_configset_get_value(cs
, key
, &value
)) {
1504 *dest
= git_config_ulong(key
, value
);
1510 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
1513 if (!git_configset_get_value(cs
, key
, &value
)) {
1514 *dest
= git_config_bool(key
, value
);
1520 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
1521 int *is_bool
, int *dest
)
1524 if (!git_configset_get_value(cs
, key
, &value
)) {
1525 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
1531 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
1534 if (!git_configset_get_value(cs
, key
, &value
)) {
1535 *dest
= git_config_maybe_bool(key
, value
);
1543 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
1546 if (!git_configset_get_value(cs
, key
, &value
))
1547 return git_config_pathname(dest
, key
, value
);
1552 static void git_config_check_init(void)
1554 if (the_config_set
.hash_initialized
)
1556 git_configset_init(&the_config_set
);
1557 git_config_raw(config_set_callback
, &the_config_set
);
1560 void git_config_clear(void)
1562 if (!the_config_set
.hash_initialized
)
1564 git_configset_clear(&the_config_set
);
1567 int git_config_get_value(const char *key
, const char **value
)
1569 git_config_check_init();
1570 return git_configset_get_value(&the_config_set
, key
, value
);
1573 const struct string_list
*git_config_get_value_multi(const char *key
)
1575 git_config_check_init();
1576 return git_configset_get_value_multi(&the_config_set
, key
);
1579 int git_config_get_string_const(const char *key
, const char **dest
)
1582 git_config_check_init();
1583 ret
= git_configset_get_string_const(&the_config_set
, key
, dest
);
1585 git_die_config(key
, NULL
);
1589 int git_config_get_string(const char *key
, char **dest
)
1591 git_config_check_init();
1592 return git_config_get_string_const(key
, (const char **)dest
);
1595 int git_config_get_int(const char *key
, int *dest
)
1597 git_config_check_init();
1598 return git_configset_get_int(&the_config_set
, key
, dest
);
1601 int git_config_get_ulong(const char *key
, unsigned long *dest
)
1603 git_config_check_init();
1604 return git_configset_get_ulong(&the_config_set
, key
, dest
);
1607 int git_config_get_bool(const char *key
, int *dest
)
1609 git_config_check_init();
1610 return git_configset_get_bool(&the_config_set
, key
, dest
);
1613 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
1615 git_config_check_init();
1616 return git_configset_get_bool_or_int(&the_config_set
, key
, is_bool
, dest
);
1619 int git_config_get_maybe_bool(const char *key
, int *dest
)
1621 git_config_check_init();
1622 return git_configset_get_maybe_bool(&the_config_set
, key
, dest
);
1625 int git_config_get_pathname(const char *key
, const char **dest
)
1628 git_config_check_init();
1629 ret
= git_configset_get_pathname(&the_config_set
, key
, dest
);
1631 git_die_config(key
, NULL
);
1635 int git_config_get_untracked_cache(void)
1640 /* Hack for test programs like test-dump-untracked-cache */
1641 if (ignore_untracked_cache_config
)
1644 if (!git_config_get_maybe_bool("core.untrackedcache", &val
))
1647 if (!git_config_get_value("core.untrackedcache", &v
)) {
1648 if (!strcasecmp(v
, "keep"))
1651 error("unknown core.untrackedCache value '%s'; "
1652 "using 'keep' default value", v
);
1656 return -1; /* default value */
1660 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
1663 die(_("unable to parse '%s' from command-line config"), key
);
1665 die(_("bad config variable '%s' in file '%s' at line %d"),
1666 key
, filename
, linenr
);
1669 NORETURN
__attribute__((format(printf
, 2, 3)))
1670 void git_die_config(const char *key
, const char *err
, ...)
1672 const struct string_list
*values
;
1673 struct key_value_info
*kv_info
;
1677 va_start(params
, err
);
1678 vreportf("error: ", err
, params
);
1681 values
= git_config_get_value_multi(key
);
1682 kv_info
= values
->items
[values
->nr
- 1].util
;
1683 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
1687 * Find all the stuff for git_config_set() below.
1694 regex_t
*value_regex
;
1697 unsigned int offset_alloc
;
1698 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1702 static int matches(const char *key
, const char *value
)
1704 if (strcmp(key
, store
.key
))
1705 return 0; /* not ours */
1706 if (!store
.value_regex
)
1707 return 1; /* always matches */
1708 if (store
.value_regex
== CONFIG_REGEX_NONE
)
1709 return 0; /* never matches */
1711 return store
.do_not_match
^
1712 (value
&& !regexec(store
.value_regex
, value
, 0, NULL
, 0));
1715 static int store_aux(const char *key
, const char *value
, void *cb
)
1720 switch (store
.state
) {
1722 if (matches(key
, value
)) {
1723 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1724 warning(_("%s has multiple values"), key
);
1727 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1728 store
.offset_alloc
);
1730 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1736 * What we are looking for is in store.key (both
1737 * section and var), and its section part is baselen
1738 * long. We found key (again, both section and var).
1739 * We would want to know if this key is in the same
1740 * section as what we are looking for. We already
1741 * know we are in the same section as what should
1744 ep
= strrchr(key
, '.');
1745 section_len
= ep
- key
;
1747 if ((section_len
!= store
.baselen
) ||
1748 memcmp(key
, store
.key
, section_len
+1)) {
1749 store
.state
= SECTION_END_SEEN
;
1754 * Do not increment matches: this is no match, but we
1755 * just made sure we are in the desired section.
1757 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1758 store
.offset_alloc
);
1759 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1761 case SECTION_END_SEEN
:
1763 if (matches(key
, value
)) {
1764 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1765 store
.offset_alloc
);
1766 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1767 store
.state
= KEY_SEEN
;
1770 if (strrchr(key
, '.') - key
== store
.baselen
&&
1771 !strncmp(key
, store
.key
, store
.baselen
)) {
1772 store
.state
= SECTION_SEEN
;
1773 ALLOC_GROW(store
.offset
,
1775 store
.offset_alloc
);
1776 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1783 static int write_error(const char *filename
)
1785 error("failed to write new configuration file %s", filename
);
1787 /* Same error code as "failed to rename". */
1791 static int store_write_section(int fd
, const char *key
)
1795 struct strbuf sb
= STRBUF_INIT
;
1797 dot
= memchr(key
, '.', store
.baselen
);
1799 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1800 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1801 if (key
[i
] == '"' || key
[i
] == '\\')
1802 strbuf_addch(&sb
, '\\');
1803 strbuf_addch(&sb
, key
[i
]);
1805 strbuf_addstr(&sb
, "\"]\n");
1807 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1810 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1811 strbuf_release(&sb
);
1816 static int store_write_pair(int fd
, const char *key
, const char *value
)
1819 int length
= strlen(key
+ store
.baselen
+ 1);
1820 const char *quote
= "";
1821 struct strbuf sb
= STRBUF_INIT
;
1824 * Check to see if the value needs to be surrounded with a dq pair.
1825 * Note that problematic characters are always backslash-quoted; this
1826 * check is about not losing leading or trailing SP and strings that
1827 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1828 * configuration parser.
1830 if (value
[0] == ' ')
1832 for (i
= 0; value
[i
]; i
++)
1833 if (value
[i
] == ';' || value
[i
] == '#')
1835 if (i
&& value
[i
- 1] == ' ')
1838 strbuf_addf(&sb
, "\t%.*s = %s",
1839 length
, key
+ store
.baselen
+ 1, quote
);
1841 for (i
= 0; value
[i
]; i
++)
1844 strbuf_addstr(&sb
, "\\n");
1847 strbuf_addstr(&sb
, "\\t");
1851 strbuf_addch(&sb
, '\\');
1853 strbuf_addch(&sb
, value
[i
]);
1856 strbuf_addf(&sb
, "%s\n", quote
);
1858 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1859 strbuf_release(&sb
);
1864 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1865 size_t offset_
, int *found_bracket
)
1867 size_t equal_offset
= size
, bracket_offset
= size
;
1871 for (offset
= offset_
-2; offset
> 0
1872 && contents
[offset
] != '\n'; offset
--)
1873 switch (contents
[offset
]) {
1874 case '=': equal_offset
= offset
; break;
1875 case ']': bracket_offset
= offset
; break;
1877 if (offset
> 0 && contents
[offset
-1] == '\\') {
1881 if (bracket_offset
< equal_offset
) {
1883 offset
= bracket_offset
+1;
1890 int git_config_set_in_file_gently(const char *config_filename
,
1891 const char *key
, const char *value
)
1893 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
1896 void git_config_set_in_file(const char *config_filename
,
1897 const char *key
, const char *value
)
1899 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1902 int git_config_set_gently(const char *key
, const char *value
)
1904 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
1907 void git_config_set(const char *key
, const char *value
)
1909 git_config_set_multivar(key
, value
, NULL
, 0);
1913 * Auxiliary function to sanity-check and split the key into the section
1914 * identifier and variable name.
1916 * Returns 0 on success, -1 when there is an invalid character in the key and
1917 * -2 if there is no section name in the key.
1919 * store_key - pointer to char* which will hold a copy of the key with
1920 * lowercase section and variable name
1921 * baselen - pointer to int which will hold the length of the
1922 * section + subsection part, can be NULL
1924 static int git_config_parse_key_1(const char *key
, char **store_key
, int *baselen_
, int quiet
)
1926 int i
, dot
, baselen
;
1927 const char *last_dot
= strrchr(key
, '.');
1930 * Since "key" actually contains the section name and the real
1931 * key name separated by a dot, we have to know where the dot is.
1934 if (last_dot
== NULL
|| last_dot
== key
) {
1936 error("key does not contain a section: %s", key
);
1937 return -CONFIG_NO_SECTION_OR_NAME
;
1942 error("key does not contain variable name: %s", key
);
1943 return -CONFIG_NO_SECTION_OR_NAME
;
1946 baselen
= last_dot
- key
;
1948 *baselen_
= baselen
;
1951 * Validate the key and while at it, lower case it for matching.
1954 *store_key
= xmallocz(strlen(key
));
1957 for (i
= 0; key
[i
]; i
++) {
1958 unsigned char c
= key
[i
];
1961 /* Leave the extended basename untouched.. */
1962 if (!dot
|| i
> baselen
) {
1963 if (!iskeychar(c
) ||
1964 (i
== baselen
+ 1 && !isalpha(c
))) {
1966 error("invalid key: %s", key
);
1967 goto out_free_ret_1
;
1970 } else if (c
== '\n') {
1972 error("invalid key (newline): %s", key
);
1973 goto out_free_ret_1
;
1976 (*store_key
)[i
] = c
;
1986 return -CONFIG_INVALID_KEY
;
1989 int git_config_parse_key(const char *key
, char **store_key
, int *baselen
)
1991 return git_config_parse_key_1(key
, store_key
, baselen
, 0);
1994 int git_config_key_is_valid(const char *key
)
1996 return !git_config_parse_key_1(key
, NULL
, NULL
, 1);
2000 * If value==NULL, unset in (remove from) config,
2001 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2002 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2003 * (only add a new one)
2004 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2005 * else all matching key/values (regardless how many) are removed,
2006 * before the new pair is written.
2008 * Returns 0 on success.
2010 * This function does this:
2012 * - it locks the config file by creating ".git/config.lock"
2014 * - it then parses the config using store_aux() as validator to find
2015 * the position on the key/value pair to replace. If it is to be unset,
2016 * it must be found exactly once.
2018 * - the config file is mmap()ed and the part before the match (if any) is
2019 * written to the lock file, then the changed part and the rest.
2021 * - the config file is removed and the lock file rename()d to it.
2024 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2025 const char *key
, const char *value
,
2026 const char *value_regex
,
2029 int fd
= -1, in_fd
= -1;
2031 struct lock_file
*lock
= NULL
;
2032 char *filename_buf
= NULL
;
2033 char *contents
= NULL
;
2036 /* parse-key returns negative; flip the sign to feed exit(3) */
2037 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2041 store
.multi_replace
= multi_replace
;
2043 if (!config_filename
)
2044 config_filename
= filename_buf
= git_pathdup("config");
2047 * The lock serves a purpose in addition to locking: the new
2048 * contents of .git/config will be written into it.
2050 lock
= xcalloc(1, sizeof(struct lock_file
));
2051 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2053 error_errno("could not lock config file %s", config_filename
);
2055 ret
= CONFIG_NO_LOCK
;
2060 * If .git/config does not exist yet, write a minimal version.
2062 in_fd
= open(config_filename
, O_RDONLY
);
2066 if ( ENOENT
!= errno
) {
2067 error_errno("opening %s", config_filename
);
2068 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2071 /* if nothing to unset, error out */
2072 if (value
== NULL
) {
2073 ret
= CONFIG_NOTHING_SET
;
2077 store
.key
= (char *)key
;
2078 if (!store_write_section(fd
, key
) ||
2079 !store_write_pair(fd
, key
, value
))
2083 size_t copy_begin
, copy_end
;
2084 int i
, new_line
= 0;
2086 if (value_regex
== NULL
)
2087 store
.value_regex
= NULL
;
2088 else if (value_regex
== CONFIG_REGEX_NONE
)
2089 store
.value_regex
= CONFIG_REGEX_NONE
;
2091 if (value_regex
[0] == '!') {
2092 store
.do_not_match
= 1;
2095 store
.do_not_match
= 0;
2097 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
2098 if (regcomp(store
.value_regex
, value_regex
,
2100 error("invalid pattern: %s", value_regex
);
2101 free(store
.value_regex
);
2102 ret
= CONFIG_INVALID_PATTERN
;
2107 ALLOC_GROW(store
.offset
, 1, store
.offset_alloc
);
2108 store
.offset
[0] = 0;
2109 store
.state
= START
;
2113 * After this, store.offset will contain the *end* offset
2114 * of the last match, or remain at 0 if no match was found.
2115 * As a side effect, we make sure to transform only a valid
2116 * existing config file.
2118 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
2119 error("invalid config file %s", config_filename
);
2121 if (store
.value_regex
!= NULL
&&
2122 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2123 regfree(store
.value_regex
);
2124 free(store
.value_regex
);
2126 ret
= CONFIG_INVALID_FILE
;
2131 if (store
.value_regex
!= NULL
&&
2132 store
.value_regex
!= CONFIG_REGEX_NONE
) {
2133 regfree(store
.value_regex
);
2134 free(store
.value_regex
);
2137 /* if nothing to unset, or too many matches, error out */
2138 if ((store
.seen
== 0 && value
== NULL
) ||
2139 (store
.seen
> 1 && multi_replace
== 0)) {
2140 ret
= CONFIG_NOTHING_SET
;
2145 contents_sz
= xsize_t(st
.st_size
);
2146 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
2147 MAP_PRIVATE
, in_fd
, 0);
2148 if (contents
== MAP_FAILED
) {
2149 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
2151 error_errno("unable to mmap '%s'", config_filename
);
2152 ret
= CONFIG_INVALID_FILE
;
2159 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2160 error_errno("chmod on %s failed", get_lock_file_path(lock
));
2161 ret
= CONFIG_NO_WRITE
;
2165 if (store
.seen
== 0)
2168 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
2169 if (store
.offset
[i
] == 0) {
2170 store
.offset
[i
] = copy_end
= contents_sz
;
2171 } else if (store
.state
!= KEY_SEEN
) {
2172 copy_end
= store
.offset
[i
];
2174 copy_end
= find_beginning_of_line(
2175 contents
, contents_sz
,
2176 store
.offset
[i
]-2, &new_line
);
2178 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
2181 /* write the first part of the config */
2182 if (copy_end
> copy_begin
) {
2183 if (write_in_full(fd
, contents
+ copy_begin
,
2184 copy_end
- copy_begin
) <
2185 copy_end
- copy_begin
)
2188 write_str_in_full(fd
, "\n") != 1)
2191 copy_begin
= store
.offset
[i
];
2194 /* write the pair (value == NULL means unset) */
2195 if (value
!= NULL
) {
2196 if (store
.state
== START
) {
2197 if (!store_write_section(fd
, key
))
2200 if (!store_write_pair(fd
, key
, value
))
2204 /* write the rest of the config */
2205 if (copy_begin
< contents_sz
)
2206 if (write_in_full(fd
, contents
+ copy_begin
,
2207 contents_sz
- copy_begin
) <
2208 contents_sz
- copy_begin
)
2211 munmap(contents
, contents_sz
);
2215 if (commit_lock_file(lock
) < 0) {
2216 error_errno("could not write config file %s", config_filename
);
2217 ret
= CONFIG_NO_WRITE
;
2223 * lock is committed, so don't try to roll it back below.
2224 * NOTE: Since lockfile.c keeps a linked list of all created
2225 * lock_file structures, it isn't safe to free(lock). It's
2226 * better to just leave it hanging around.
2231 /* Invalidate the config cache */
2236 rollback_lock_file(lock
);
2239 munmap(contents
, contents_sz
);
2245 ret
= write_error(get_lock_file_path(lock
));
2250 void git_config_set_multivar_in_file(const char *config_filename
,
2251 const char *key
, const char *value
,
2252 const char *value_regex
, int multi_replace
)
2254 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
2255 value_regex
, multi_replace
))
2258 die(_("could not set '%s' to '%s'"), key
, value
);
2260 die(_("could not unset '%s'"), key
);
2263 int git_config_set_multivar_gently(const char *key
, const char *value
,
2264 const char *value_regex
, int multi_replace
)
2266 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_regex
,
2270 void git_config_set_multivar(const char *key
, const char *value
,
2271 const char *value_regex
, int multi_replace
)
2273 git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
2277 static int section_name_match (const char *buf
, const char *name
)
2279 int i
= 0, j
= 0, dot
= 0;
2282 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
2283 if (!dot
&& isspace(buf
[i
])) {
2285 if (name
[j
++] != '.')
2287 for (i
++; isspace(buf
[i
]); i
++)
2293 if (buf
[i
] == '\\' && dot
)
2295 else if (buf
[i
] == '"' && dot
) {
2296 for (i
++; isspace(buf
[i
]); i
++)
2300 if (buf
[i
] != name
[j
++])
2303 if (buf
[i
] == ']' && name
[j
] == 0) {
2305 * We match, now just find the right length offset by
2306 * gobbling up any whitespace after it, as well
2309 for (; buf
[i
] && isspace(buf
[i
]); i
++)
2316 static int section_name_is_ok(const char *name
)
2318 /* Empty section names are bogus. */
2323 * Before a dot, we must be alphanumeric or dash. After the first dot,
2324 * anything goes, so we can stop checking.
2326 for (; *name
&& *name
!= '.'; name
++)
2327 if (*name
!= '-' && !isalnum(*name
))
2332 /* if new_name == NULL, the section is removed instead */
2333 int git_config_rename_section_in_file(const char *config_filename
,
2334 const char *old_name
, const char *new_name
)
2336 int ret
= 0, remove
= 0;
2337 char *filename_buf
= NULL
;
2338 struct lock_file
*lock
;
2344 if (new_name
&& !section_name_is_ok(new_name
)) {
2345 ret
= error("invalid section name: %s", new_name
);
2349 if (!config_filename
)
2350 config_filename
= filename_buf
= git_pathdup("config");
2352 lock
= xcalloc(1, sizeof(struct lock_file
));
2353 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
2355 ret
= error("could not lock config file %s", config_filename
);
2359 if (!(config_file
= fopen(config_filename
, "rb"))) {
2360 /* no config file means nothing to rename, no error */
2361 goto unlock_and_out
;
2364 fstat(fileno(config_file
), &st
);
2366 if (chmod(get_lock_file_path(lock
), st
.st_mode
& 07777) < 0) {
2367 ret
= error_errno("chmod on %s failed",
2368 get_lock_file_path(lock
));
2372 while (fgets(buf
, sizeof(buf
), config_file
)) {
2376 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
2378 if (buf
[i
] == '[') {
2379 /* it's a section */
2380 int offset
= section_name_match(&buf
[i
], old_name
);
2383 if (new_name
== NULL
) {
2387 store
.baselen
= strlen(new_name
);
2388 if (!store_write_section(out_fd
, new_name
)) {
2389 ret
= write_error(get_lock_file_path(lock
));
2393 * We wrote out the new section, with
2394 * a newline, now skip the old
2397 output
+= offset
+ i
;
2398 if (strlen(output
) > 0) {
2400 * More content means there's
2401 * a declaration to put on the
2402 * next line; indent with a
2413 length
= strlen(output
);
2414 if (write_in_full(out_fd
, output
, length
) != length
) {
2415 ret
= write_error(get_lock_file_path(lock
));
2419 fclose(config_file
);
2421 if (commit_lock_file(lock
) < 0)
2422 ret
= error_errno("could not write config file %s",
2429 int git_config_rename_section(const char *old_name
, const char *new_name
)
2431 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
2435 * Call this to report error for your variable that should not
2436 * get a boolean value (i.e. "[my] var" means "true").
2438 #undef config_error_nonbool
2439 int config_error_nonbool(const char *var
)
2441 return error("missing value for '%s'", var
);
2444 int parse_config_key(const char *var
,
2445 const char *section
,
2446 const char **subsection
, int *subsection_len
,
2449 int section_len
= strlen(section
);
2452 /* Does it start with "section." ? */
2453 if (!starts_with(var
, section
) || var
[section_len
] != '.')
2457 * Find the key; we don't know yet if we have a subsection, but we must
2458 * parse backwards from the end, since the subsection may have dots in
2461 dot
= strrchr(var
, '.');
2464 /* Did we have a subsection at all? */
2465 if (dot
== var
+ section_len
) {
2467 *subsection_len
= 0;
2470 *subsection
= var
+ section_len
+ 1;
2471 *subsection_len
= dot
- *subsection
;
2477 const char *current_config_origin_type(void)
2480 if (current_config_kvi
)
2481 type
= current_config_kvi
->origin_type
;
2483 type
= cf
->origin_type
;
2485 die("BUG: current_config_origin_type called outside config callback");
2486 return type
? type
: "command line";
2489 const char *current_config_name(void)
2492 if (current_config_kvi
)
2493 name
= current_config_kvi
->filename
;
2497 die("BUG: current_config_name called outside config callback");
2498 return name
? name
: "";
2501 enum config_scope
current_config_scope(void)
2503 if (current_config_kvi
)
2504 return current_config_kvi
->scope
;
2506 return current_parsing_scope
;