2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
11 #include "environment.h"
12 #include "repository.h"
18 #include "string-list.h"
19 #include "object-store.h"
25 struct config_source
{
26 struct config_source
*prev
;
35 enum config_origin_type origin_type
;
38 enum config_error_action default_error_action
;
44 unsigned subsection_case_sensitive
: 1;
46 int (*do_fgetc
)(struct config_source
*c
);
47 int (*do_ungetc
)(int c
, struct config_source
*conf
);
48 long (*do_ftell
)(struct config_source
*c
);
52 * These variables record the "current" config source, which
53 * can be accessed by parsing callbacks.
55 * The "cf" variable will be non-NULL only when we are actually parsing a real
56 * config source (file, blob, cmdline, etc).
58 * The "current_config_kvi" variable will be non-NULL only when we are feeding
59 * cached config from a configset into a callback.
61 * They should generally never be non-NULL at the same time. If they are both
62 * NULL, then we aren't parsing anything (and depending on the function looking
63 * at the variables, it's either a bug for it to be called in the first place,
64 * or it's a function which can be reused for non-config purposes, and should
65 * fall back to some sane behavior).
67 static struct config_source
*cf
;
68 static struct key_value_info
*current_config_kvi
;
71 * Similar to the variables above, this gives access to the "scope" of the
72 * current value (repo, global, etc). For cached values, it can be found via
73 * the current_config_kvi as above. During parsing, the current value can be
74 * found in this variable. It's not part of "cf" because it transcends a single
75 * file (i.e., a file included from .git/config is still in "repo" scope).
77 static enum config_scope current_parsing_scope
;
79 static int core_compression_seen
;
80 static int pack_compression_seen
;
81 static int zlib_compression_seen
;
83 static int config_file_fgetc(struct config_source
*conf
)
85 return getc_unlocked(conf
->u
.file
);
88 static int config_file_ungetc(int c
, struct config_source
*conf
)
90 return ungetc(c
, conf
->u
.file
);
93 static long config_file_ftell(struct config_source
*conf
)
95 return ftell(conf
->u
.file
);
99 static int config_buf_fgetc(struct config_source
*conf
)
101 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
102 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
107 static int config_buf_ungetc(int c
, struct config_source
*conf
)
109 if (conf
->u
.buf
.pos
> 0) {
111 if (conf
->u
.buf
.buf
[conf
->u
.buf
.pos
] != c
)
112 BUG("config_buf can only ungetc the same character");
119 static long config_buf_ftell(struct config_source
*conf
)
121 return conf
->u
.buf
.pos
;
124 #define MAX_INCLUDE_DEPTH 10
125 static const char include_depth_advice
[] = N_(
126 "exceeded maximum include depth (%d) while including\n"
130 "This might be due to circular includes.");
131 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
134 struct strbuf buf
= STRBUF_INIT
;
138 return config_error_nonbool("include.path");
140 expanded
= interpolate_path(path
, 0);
142 return error(_("could not expand include path '%s'"), path
);
146 * Use an absolute path as-is, but interpret relative paths
147 * based on the including config file.
149 if (!is_absolute_path(path
)) {
152 if (!cf
|| !cf
->path
)
153 return error(_("relative config includes must come from files"));
155 slash
= find_last_dir_sep(cf
->path
);
157 strbuf_add(&buf
, cf
->path
, slash
- cf
->path
+ 1);
158 strbuf_addstr(&buf
, path
);
162 if (!access_or_die(path
, R_OK
, 0)) {
163 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
164 die(_(include_depth_advice
), MAX_INCLUDE_DEPTH
, path
,
166 cf
->name
? cf
->name
:
168 ret
= git_config_from_file(git_config_include
, path
, inc
);
171 strbuf_release(&buf
);
176 static void add_trailing_starstar_for_dir(struct strbuf
*pat
)
178 if (pat
->len
&& is_dir_sep(pat
->buf
[pat
->len
- 1]))
179 strbuf_addstr(pat
, "**");
182 static int prepare_include_condition_pattern(struct strbuf
*pat
)
184 struct strbuf path
= STRBUF_INIT
;
188 expanded
= interpolate_path(pat
->buf
, 1);
191 strbuf_addstr(pat
, expanded
);
195 if (pat
->buf
[0] == '.' && is_dir_sep(pat
->buf
[1])) {
198 if (!cf
|| !cf
->path
)
199 return error(_("relative config include "
200 "conditionals must come from files"));
202 strbuf_realpath(&path
, cf
->path
, 1);
203 slash
= find_last_dir_sep(path
.buf
);
205 BUG("how is this possible?");
206 strbuf_splice(pat
, 0, 1, path
.buf
, slash
- path
.buf
);
207 prefix
= slash
- path
.buf
+ 1 /* slash */;
208 } else if (!is_absolute_path(pat
->buf
))
209 strbuf_insertstr(pat
, 0, "**/");
211 add_trailing_starstar_for_dir(pat
);
213 strbuf_release(&path
);
217 static int include_by_gitdir(const struct config_options
*opts
,
218 const char *cond
, size_t cond_len
, int icase
)
220 struct strbuf text
= STRBUF_INIT
;
221 struct strbuf pattern
= STRBUF_INIT
;
224 int already_tried_absolute
= 0;
227 git_dir
= opts
->git_dir
;
231 strbuf_realpath(&text
, git_dir
, 1);
232 strbuf_add(&pattern
, cond
, cond_len
);
233 prefix
= prepare_include_condition_pattern(&pattern
);
241 * perform literal matching on the prefix part so that
242 * any wildcard character in it can't create side effects.
244 if (text
.len
< prefix
)
246 if (!icase
&& strncmp(pattern
.buf
, text
.buf
, prefix
))
248 if (icase
&& strncasecmp(pattern
.buf
, text
.buf
, prefix
))
252 ret
= !wildmatch(pattern
.buf
+ prefix
, text
.buf
+ prefix
,
253 WM_PATHNAME
| (icase
? WM_CASEFOLD
: 0));
255 if (!ret
&& !already_tried_absolute
) {
257 * We've tried e.g. matching gitdir:~/work, but if
258 * ~/work is a symlink to /mnt/storage/work
259 * strbuf_realpath() will expand it, so the rule won't
260 * match. Let's match against a
261 * strbuf_add_absolute_path() version of the path,
262 * which'll do the right thing
265 strbuf_add_absolute_path(&text
, git_dir
);
266 already_tried_absolute
= 1;
270 strbuf_release(&pattern
);
271 strbuf_release(&text
);
275 static int include_by_branch(const char *cond
, size_t cond_len
)
279 struct strbuf pattern
= STRBUF_INIT
;
280 const char *refname
= !the_repository
->gitdir
?
281 NULL
: resolve_ref_unsafe("HEAD", 0, NULL
, &flags
);
282 const char *shortname
;
284 if (!refname
|| !(flags
& REF_ISSYMREF
) ||
285 !skip_prefix(refname
, "refs/heads/", &shortname
))
288 strbuf_add(&pattern
, cond
, cond_len
);
289 add_trailing_starstar_for_dir(&pattern
);
290 ret
= !wildmatch(pattern
.buf
, shortname
, WM_PATHNAME
);
291 strbuf_release(&pattern
);
295 static int include_condition_is_true(const struct config_options
*opts
,
296 const char *cond
, size_t cond_len
)
299 if (skip_prefix_mem(cond
, cond_len
, "gitdir:", &cond
, &cond_len
))
300 return include_by_gitdir(opts
, cond
, cond_len
, 0);
301 else if (skip_prefix_mem(cond
, cond_len
, "gitdir/i:", &cond
, &cond_len
))
302 return include_by_gitdir(opts
, cond
, cond_len
, 1);
303 else if (skip_prefix_mem(cond
, cond_len
, "onbranch:", &cond
, &cond_len
))
304 return include_by_branch(cond
, cond_len
);
306 /* unknown conditionals are always false */
310 int git_config_include(const char *var
, const char *value
, void *data
)
312 struct config_include_data
*inc
= data
;
313 const char *cond
, *key
;
318 * Pass along all values, including "include" directives; this makes it
319 * possible to query information on the includes themselves.
321 ret
= inc
->fn(var
, value
, inc
->data
);
325 if (!strcmp(var
, "include.path"))
326 ret
= handle_path_include(value
, inc
);
328 if (!parse_config_key(var
, "includeif", &cond
, &cond_len
, &key
) &&
329 (cond
&& include_condition_is_true(inc
->opts
, cond
, cond_len
)) &&
330 !strcmp(key
, "path"))
331 ret
= handle_path_include(value
, inc
);
336 static void git_config_push_split_parameter(const char *key
, const char *value
)
338 struct strbuf env
= STRBUF_INIT
;
339 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
341 strbuf_addstr(&env
, old
);
342 strbuf_addch(&env
, ' ');
344 sq_quote_buf(&env
, key
);
345 strbuf_addch(&env
, '=');
347 sq_quote_buf(&env
, value
);
348 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
349 strbuf_release(&env
);
352 void git_config_push_parameter(const char *text
)
359 * section.subsection=with=equals.key=value
361 * we cannot tell if it means:
363 * [section "subsection=with=equals"]
369 * subsection = with=equals.key=value
371 * We parse left-to-right for the first "=", meaning we'll prefer to
372 * keep the value intact over the subsection. This is historical, but
373 * also sensible since values are more likely to contain odd or
374 * untrusted input than a section name.
376 * A missing equals is explicitly allowed (as a bool-only entry).
378 value
= strchr(text
, '=');
380 char *key
= xmemdupz(text
, value
- text
);
381 git_config_push_split_parameter(key
, value
+ 1);
384 git_config_push_split_parameter(text
, NULL
);
388 void git_config_push_env(const char *spec
)
391 const char *env_name
;
392 const char *env_value
;
394 env_name
= strrchr(spec
, '=');
396 die(_("invalid config format: %s"), spec
);
397 key
= xmemdupz(spec
, env_name
- spec
);
400 die(_("missing environment variable name for configuration '%.*s'"),
401 (int)(env_name
- spec
- 1), spec
);
403 env_value
= getenv(env_name
);
405 die(_("missing environment variable '%s' for configuration '%.*s'"),
406 env_name
, (int)(env_name
- spec
- 1), spec
);
408 git_config_push_split_parameter(key
, env_value
);
412 static inline int iskeychar(int c
)
414 return isalnum(c
) || c
== '-';
418 * Auxiliary function to sanity-check and split the key into the section
419 * identifier and variable name.
421 * Returns 0 on success, -1 when there is an invalid character in the key and
422 * -2 if there is no section name in the key.
424 * store_key - pointer to char* which will hold a copy of the key with
425 * lowercase section and variable name
426 * baselen - pointer to size_t which will hold the length of the
427 * section + subsection part, can be NULL
429 static int git_config_parse_key_1(const char *key
, char **store_key
, size_t *baselen_
, int quiet
)
433 const char *last_dot
= strrchr(key
, '.');
436 * Since "key" actually contains the section name and the real
437 * key name separated by a dot, we have to know where the dot is.
440 if (last_dot
== NULL
|| last_dot
== key
) {
442 error(_("key does not contain a section: %s"), key
);
443 return -CONFIG_NO_SECTION_OR_NAME
;
448 error(_("key does not contain variable name: %s"), key
);
449 return -CONFIG_NO_SECTION_OR_NAME
;
452 baselen
= last_dot
- key
;
457 * Validate the key and while at it, lower case it for matching.
460 *store_key
= xmallocz(strlen(key
));
463 for (i
= 0; key
[i
]; i
++) {
464 unsigned char c
= key
[i
];
467 /* Leave the extended basename untouched.. */
468 if (!dot
|| i
> baselen
) {
470 (i
== baselen
+ 1 && !isalpha(c
))) {
472 error(_("invalid key: %s"), key
);
476 } else if (c
== '\n') {
478 error(_("invalid key (newline): %s"), key
);
489 FREE_AND_NULL(*store_key
);
491 return -CONFIG_INVALID_KEY
;
494 int git_config_parse_key(const char *key
, char **store_key
, size_t *baselen
)
496 return git_config_parse_key_1(key
, store_key
, baselen
, 0);
499 int git_config_key_is_valid(const char *key
)
501 return !git_config_parse_key_1(key
, NULL
, NULL
, 1);
504 static int config_parse_pair(const char *key
, const char *value
,
505 config_fn_t fn
, void *data
)
507 char *canonical_name
;
511 return error(_("empty config key"));
512 if (git_config_parse_key(key
, &canonical_name
, NULL
))
515 ret
= (fn(canonical_name
, value
, data
) < 0) ? -1 : 0;
516 free(canonical_name
);
520 int git_config_parse_parameter(const char *text
,
521 config_fn_t fn
, void *data
)
524 struct strbuf
**pair
;
527 pair
= strbuf_split_str(text
, '=', 2);
529 return error(_("bogus config parameter: %s"), text
);
531 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
532 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
533 value
= pair
[1] ? pair
[1]->buf
: "";
538 strbuf_trim(pair
[0]);
540 strbuf_list_free(pair
);
541 return error(_("bogus config parameter: %s"), text
);
544 ret
= config_parse_pair(pair
[0]->buf
, value
, fn
, data
);
545 strbuf_list_free(pair
);
549 static int parse_config_env_list(char *env
, config_fn_t fn
, void *data
)
552 while (cur
&& *cur
) {
553 const char *key
= sq_dequote_step(cur
, &cur
);
555 return error(_("bogus format in %s"),
556 CONFIG_DATA_ENVIRONMENT
);
558 if (!cur
|| isspace(*cur
)) {
559 /* old-style 'key=value' */
560 if (git_config_parse_parameter(key
, fn
, data
) < 0)
563 else if (*cur
== '=') {
564 /* new-style 'key'='value' */
570 value
= sq_dequote_step(cur
, &cur
);
571 if (!value
|| (cur
&& !isspace(*cur
))) {
572 return error(_("bogus format in %s"),
573 CONFIG_DATA_ENVIRONMENT
);
575 } else if (!*cur
|| isspace(*cur
)) {
576 /* implicit bool: 'key'= */
579 return error(_("bogus format in %s"),
580 CONFIG_DATA_ENVIRONMENT
);
583 if (config_parse_pair(key
, value
, fn
, data
) < 0)
588 return error(_("bogus format in %s"),
589 CONFIG_DATA_ENVIRONMENT
);
593 while (isspace(*cur
))
600 int git_config_from_parameters(config_fn_t fn
, void *data
)
603 struct strbuf envvar
= STRBUF_INIT
;
604 struct strvec to_free
= STRVEC_INIT
;
607 struct config_source source
;
609 memset(&source
, 0, sizeof(source
));
611 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
614 env
= getenv(CONFIG_COUNT_ENVIRONMENT
);
620 count
= strtoul(env
, &endp
, 10);
622 ret
= error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT
);
625 if (count
> INT_MAX
) {
626 ret
= error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT
);
630 for (i
= 0; i
< count
; i
++) {
631 const char *key
, *value
;
633 strbuf_addf(&envvar
, "GIT_CONFIG_KEY_%d", i
);
634 key
= getenv_safe(&to_free
, envvar
.buf
);
636 ret
= error(_("missing config key %s"), envvar
.buf
);
639 strbuf_reset(&envvar
);
641 strbuf_addf(&envvar
, "GIT_CONFIG_VALUE_%d", i
);
642 value
= getenv_safe(&to_free
, envvar
.buf
);
644 ret
= error(_("missing config value %s"), envvar
.buf
);
647 strbuf_reset(&envvar
);
649 if (config_parse_pair(key
, value
, fn
, data
) < 0) {
656 env
= getenv(CONFIG_DATA_ENVIRONMENT
);
658 /* sq_dequote will write over it */
660 if (parse_config_env_list(envw
, fn
, data
) < 0) {
667 strbuf_release(&envvar
);
668 strvec_clear(&to_free
);
674 static int get_next_char(void)
676 int c
= cf
->do_fgetc(cf
);
679 /* DOS like systems */
680 c
= cf
->do_fgetc(cf
);
683 cf
->do_ungetc(c
, cf
);
688 if (c
!= EOF
&& ++cf
->total_len
> INT_MAX
) {
690 * This is an absurdly long config file; refuse to parse
691 * further in order to protect downstream code from integer
692 * overflows. Note that we can't return an error specifically,
693 * but we can mark EOF and put trash in the return value,
694 * which will trigger a parse error.
710 static char *parse_value(void)
712 int quote
= 0, comment
= 0, space
= 0;
714 strbuf_reset(&cf
->value
);
716 int c
= get_next_char();
722 return cf
->value
.buf
;
726 if (isspace(c
) && !quote
) {
732 if (c
== ';' || c
== '#') {
737 for (; space
; space
--)
738 strbuf_addch(&cf
->value
, ' ');
753 /* Some characters escape as themselves */
756 /* Reject unknown escape sequences */
760 strbuf_addch(&cf
->value
, c
);
767 strbuf_addch(&cf
->value
, c
);
771 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
777 /* Get the full name */
784 strbuf_addch(name
, tolower(c
));
787 while (c
== ' ' || c
== '\t')
794 value
= parse_value();
799 * We already consumed the \n, but we need linenr to point to
800 * the line we just parsed during the call to fn to get
801 * accurate line number in error messages.
804 ret
= fn(name
->buf
, value
, data
);
810 static int get_extended_base_var(struct strbuf
*name
, int c
)
812 cf
->subsection_case_sensitive
= 0;
815 goto error_incomplete_line
;
817 } while (isspace(c
));
819 /* We require the format to be '[base "extension"]' */
822 strbuf_addch(name
, '.');
825 int c
= get_next_char();
827 goto error_incomplete_line
;
833 goto error_incomplete_line
;
835 strbuf_addch(name
, c
);
839 if (get_next_char() != ']')
842 error_incomplete_line
:
847 static int get_base_var(struct strbuf
*name
)
849 cf
->subsection_case_sensitive
= 1;
851 int c
= get_next_char();
857 return get_extended_base_var(name
, c
);
858 if (!iskeychar(c
) && c
!= '.')
860 strbuf_addch(name
, tolower(c
));
864 struct parse_event_data
{
865 enum config_event_t previous_type
;
866 size_t previous_offset
;
867 const struct config_options
*opts
;
870 static int do_event(enum config_event_t type
, struct parse_event_data
*data
)
874 if (!data
->opts
|| !data
->opts
->event_fn
)
877 if (type
== CONFIG_EVENT_WHITESPACE
&&
878 data
->previous_type
== type
)
881 offset
= cf
->do_ftell(cf
);
883 * At EOF, the parser always "inserts" an extra '\n', therefore
884 * the end offset of the event is the current file position, otherwise
885 * we will already have advanced to the next event.
887 if (type
!= CONFIG_EVENT_EOF
)
890 if (data
->previous_type
!= CONFIG_EVENT_EOF
&&
891 data
->opts
->event_fn(data
->previous_type
, data
->previous_offset
,
892 offset
, data
->opts
->event_fn_data
) < 0)
895 data
->previous_type
= type
;
896 data
->previous_offset
= offset
;
901 static int git_parse_source(config_fn_t fn
, void *data
,
902 const struct config_options
*opts
)
906 struct strbuf
*var
= &cf
->var
;
907 int error_return
= 0;
908 char *error_msg
= NULL
;
910 /* U+FEFF Byte Order Mark in UTF8 */
911 const char *bomptr
= utf8_bom
;
913 /* For the parser event callback */
914 struct parse_event_data event_data
= {
915 CONFIG_EVENT_EOF
, 0, opts
922 if (bomptr
&& *bomptr
) {
923 /* We are at the file beginning; skip UTF8-encoded BOM
924 * if present. Sane editors won't put this in on their
925 * own, but e.g. Windows Notepad will do it happily. */
926 if (c
== (*bomptr
& 0377)) {
930 /* Do not tolerate partial BOM. */
931 if (bomptr
!= utf8_bom
)
933 /* No BOM at file beginning. Cool. */
939 if (do_event(CONFIG_EVENT_EOF
, &event_data
) < 0)
943 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
951 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
955 if (c
== '#' || c
== ';') {
956 if (do_event(CONFIG_EVENT_COMMENT
, &event_data
) < 0)
962 if (do_event(CONFIG_EVENT_SECTION
, &event_data
) < 0)
965 /* Reset prior to determining a new stem */
967 if (get_base_var(var
) < 0 || var
->len
< 1)
969 strbuf_addch(var
, '.');
976 if (do_event(CONFIG_EVENT_ENTRY
, &event_data
) < 0)
980 * Truncate the var name back to the section header
981 * stem prior to grabbing the suffix part of the name
984 strbuf_setlen(var
, baselen
);
985 strbuf_addch(var
, tolower(c
));
986 if (get_value(fn
, data
, var
) < 0)
990 if (do_event(CONFIG_EVENT_ERROR
, &event_data
) < 0)
993 switch (cf
->origin_type
) {
994 case CONFIG_ORIGIN_BLOB
:
995 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
996 cf
->linenr
, cf
->name
);
998 case CONFIG_ORIGIN_FILE
:
999 error_msg
= xstrfmt(_("bad config line %d in file %s"),
1000 cf
->linenr
, cf
->name
);
1002 case CONFIG_ORIGIN_STDIN
:
1003 error_msg
= xstrfmt(_("bad config line %d in standard input"),
1006 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1007 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
1008 cf
->linenr
, cf
->name
);
1010 case CONFIG_ORIGIN_CMDLINE
:
1011 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
1012 cf
->linenr
, cf
->name
);
1015 error_msg
= xstrfmt(_("bad config line %d in %s"),
1016 cf
->linenr
, cf
->name
);
1019 switch (opts
&& opts
->error_action
?
1020 opts
->error_action
:
1021 cf
->default_error_action
) {
1022 case CONFIG_ERROR_DIE
:
1023 die("%s", error_msg
);
1025 case CONFIG_ERROR_ERROR
:
1026 error_return
= error("%s", error_msg
);
1028 case CONFIG_ERROR_SILENT
:
1031 case CONFIG_ERROR_UNSET
:
1032 BUG("config error action unset");
1036 return error_return
;
1039 static uintmax_t get_unit_factor(const char *end
)
1043 else if (!strcasecmp(end
, "k"))
1045 else if (!strcasecmp(end
, "m"))
1047 else if (!strcasecmp(end
, "g"))
1048 return 1024 * 1024 * 1024;
1052 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
1054 if (value
&& *value
) {
1061 val
= strtoimax(value
, &end
, 0);
1062 if (errno
== ERANGE
)
1064 factor
= get_unit_factor(end
);
1069 uval
= val
< 0 ? -val
: val
;
1070 if (unsigned_mult_overflows(factor
, uval
) ||
1071 factor
* uval
> max
) {
1083 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
1085 if (value
&& *value
) {
1091 val
= strtoumax(value
, &end
, 0);
1092 if (errno
== ERANGE
)
1094 factor
= get_unit_factor(end
);
1099 if (unsigned_mult_overflows(factor
, val
) ||
1100 factor
* val
> max
) {
1112 static int git_parse_int(const char *value
, int *ret
)
1115 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
1121 static int git_parse_int64(const char *value
, int64_t *ret
)
1124 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
1130 int git_parse_ulong(const char *value
, unsigned long *ret
)
1133 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
1139 int git_parse_ssize_t(const char *value
, ssize_t
*ret
)
1142 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(ssize_t
)))
1149 static void die_bad_number(const char *name
, const char *value
)
1151 const char *error_type
= (errno
== ERANGE
) ?
1152 N_("out of range") : N_("invalid unit");
1153 const char *bad_numeric
= N_("bad numeric config value '%s' for '%s': %s");
1158 if (!(cf
&& cf
->name
))
1159 die(_(bad_numeric
), value
, name
, _(error_type
));
1161 switch (cf
->origin_type
) {
1162 case CONFIG_ORIGIN_BLOB
:
1163 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1164 value
, name
, cf
->name
, _(error_type
));
1165 case CONFIG_ORIGIN_FILE
:
1166 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1167 value
, name
, cf
->name
, _(error_type
));
1168 case CONFIG_ORIGIN_STDIN
:
1169 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1170 value
, name
, _(error_type
));
1171 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1172 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1173 value
, name
, cf
->name
, _(error_type
));
1174 case CONFIG_ORIGIN_CMDLINE
:
1175 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1176 value
, name
, cf
->name
, _(error_type
));
1178 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1179 value
, name
, cf
->name
, _(error_type
));
1183 int git_config_int(const char *name
, const char *value
)
1186 if (!git_parse_int(value
, &ret
))
1187 die_bad_number(name
, value
);
1191 int64_t git_config_int64(const char *name
, const char *value
)
1194 if (!git_parse_int64(value
, &ret
))
1195 die_bad_number(name
, value
);
1199 unsigned long git_config_ulong(const char *name
, const char *value
)
1202 if (!git_parse_ulong(value
, &ret
))
1203 die_bad_number(name
, value
);
1207 ssize_t
git_config_ssize_t(const char *name
, const char *value
)
1210 if (!git_parse_ssize_t(value
, &ret
))
1211 die_bad_number(name
, value
);
1215 static int git_parse_maybe_bool_text(const char *value
)
1221 if (!strcasecmp(value
, "true")
1222 || !strcasecmp(value
, "yes")
1223 || !strcasecmp(value
, "on"))
1225 if (!strcasecmp(value
, "false")
1226 || !strcasecmp(value
, "no")
1227 || !strcasecmp(value
, "off"))
1232 int git_parse_maybe_bool(const char *value
)
1234 int v
= git_parse_maybe_bool_text(value
);
1237 if (git_parse_int(value
, &v
))
1242 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
1244 int v
= git_parse_maybe_bool_text(value
);
1250 return git_config_int(name
, value
);
1253 int git_config_bool(const char *name
, const char *value
)
1255 int v
= git_parse_maybe_bool(value
);
1257 die(_("bad boolean config value '%s' for '%s'"), value
, name
);
1261 int git_config_string(const char **dest
, const char *var
, const char *value
)
1264 return config_error_nonbool(var
);
1265 *dest
= xstrdup(value
);
1269 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
1272 return config_error_nonbool(var
);
1273 *dest
= interpolate_path(value
, 0);
1275 die(_("failed to expand user dir in: '%s'"), value
);
1279 int git_config_expiry_date(timestamp_t
*timestamp
, const char *var
, const char *value
)
1282 return config_error_nonbool(var
);
1283 if (parse_expiry_date(value
, timestamp
))
1284 return error(_("'%s' for '%s' is not a valid timestamp"),
1289 int git_config_color(char *dest
, const char *var
, const char *value
)
1292 return config_error_nonbool(var
);
1293 if (color_parse(value
, dest
) < 0)
1298 static int git_default_core_config(const char *var
, const char *value
, void *cb
)
1300 /* This needs a better name */
1301 if (!strcmp(var
, "core.filemode")) {
1302 trust_executable_bit
= git_config_bool(var
, value
);
1305 if (!strcmp(var
, "core.trustctime")) {
1306 trust_ctime
= git_config_bool(var
, value
);
1309 if (!strcmp(var
, "core.checkstat")) {
1310 if (!strcasecmp(value
, "default"))
1312 else if (!strcasecmp(value
, "minimal"))
1316 if (!strcmp(var
, "core.quotepath")) {
1317 quote_path_fully
= git_config_bool(var
, value
);
1321 if (!strcmp(var
, "core.symlinks")) {
1322 has_symlinks
= git_config_bool(var
, value
);
1326 if (!strcmp(var
, "core.ignorecase")) {
1327 ignore_case
= git_config_bool(var
, value
);
1331 if (!strcmp(var
, "core.attributesfile"))
1332 return git_config_pathname(&git_attributes_file
, var
, value
);
1334 if (!strcmp(var
, "core.hookspath"))
1335 return git_config_pathname(&git_hooks_path
, var
, value
);
1337 if (!strcmp(var
, "core.bare")) {
1338 is_bare_repository_cfg
= git_config_bool(var
, value
);
1342 if (!strcmp(var
, "core.ignorestat")) {
1343 assume_unchanged
= git_config_bool(var
, value
);
1347 if (!strcmp(var
, "core.prefersymlinkrefs")) {
1348 prefer_symlink_refs
= git_config_bool(var
, value
);
1352 if (!strcmp(var
, "core.logallrefupdates")) {
1353 if (value
&& !strcasecmp(value
, "always"))
1354 log_all_ref_updates
= LOG_REFS_ALWAYS
;
1355 else if (git_config_bool(var
, value
))
1356 log_all_ref_updates
= LOG_REFS_NORMAL
;
1358 log_all_ref_updates
= LOG_REFS_NONE
;
1362 if (!strcmp(var
, "core.warnambiguousrefs")) {
1363 warn_ambiguous_refs
= git_config_bool(var
, value
);
1367 if (!strcmp(var
, "core.abbrev")) {
1369 return config_error_nonbool(var
);
1370 if (!strcasecmp(value
, "auto"))
1371 default_abbrev
= -1;
1372 else if (!git_parse_maybe_bool_text(value
))
1373 default_abbrev
= the_hash_algo
->hexsz
;
1375 int abbrev
= git_config_int(var
, value
);
1376 if (abbrev
< minimum_abbrev
|| abbrev
> the_hash_algo
->hexsz
)
1377 return error(_("abbrev length out of range: %d"), abbrev
);
1378 default_abbrev
= abbrev
;
1383 if (!strcmp(var
, "core.disambiguate"))
1384 return set_disambiguate_hint_config(var
, value
);
1386 if (!strcmp(var
, "core.loosecompression")) {
1387 int level
= git_config_int(var
, value
);
1389 level
= Z_DEFAULT_COMPRESSION
;
1390 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1391 die(_("bad zlib compression level %d"), level
);
1392 zlib_compression_level
= level
;
1393 zlib_compression_seen
= 1;
1397 if (!strcmp(var
, "core.compression")) {
1398 int level
= git_config_int(var
, value
);
1400 level
= Z_DEFAULT_COMPRESSION
;
1401 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1402 die(_("bad zlib compression level %d"), level
);
1403 core_compression_level
= level
;
1404 core_compression_seen
= 1;
1405 if (!zlib_compression_seen
)
1406 zlib_compression_level
= level
;
1407 if (!pack_compression_seen
)
1408 pack_compression_level
= level
;
1412 if (!strcmp(var
, "core.packedgitwindowsize")) {
1413 int pgsz_x2
= getpagesize() * 2;
1414 packed_git_window_size
= git_config_ulong(var
, value
);
1416 /* This value must be multiple of (pagesize * 2) */
1417 packed_git_window_size
/= pgsz_x2
;
1418 if (packed_git_window_size
< 1)
1419 packed_git_window_size
= 1;
1420 packed_git_window_size
*= pgsz_x2
;
1424 if (!strcmp(var
, "core.bigfilethreshold")) {
1425 big_file_threshold
= git_config_ulong(var
, value
);
1429 if (!strcmp(var
, "core.packedgitlimit")) {
1430 packed_git_limit
= git_config_ulong(var
, value
);
1434 if (!strcmp(var
, "core.deltabasecachelimit")) {
1435 delta_base_cache_limit
= git_config_ulong(var
, value
);
1439 if (!strcmp(var
, "core.autocrlf")) {
1440 if (value
&& !strcasecmp(value
, "input")) {
1441 auto_crlf
= AUTO_CRLF_INPUT
;
1444 auto_crlf
= git_config_bool(var
, value
);
1448 if (!strcmp(var
, "core.safecrlf")) {
1450 if (value
&& !strcasecmp(value
, "warn")) {
1451 global_conv_flags_eol
= CONV_EOL_RNDTRP_WARN
;
1454 eol_rndtrp_die
= git_config_bool(var
, value
);
1455 global_conv_flags_eol
= eol_rndtrp_die
?
1456 CONV_EOL_RNDTRP_DIE
: 0;
1460 if (!strcmp(var
, "core.eol")) {
1461 if (value
&& !strcasecmp(value
, "lf"))
1463 else if (value
&& !strcasecmp(value
, "crlf"))
1464 core_eol
= EOL_CRLF
;
1465 else if (value
&& !strcasecmp(value
, "native"))
1466 core_eol
= EOL_NATIVE
;
1468 core_eol
= EOL_UNSET
;
1472 if (!strcmp(var
, "core.checkroundtripencoding")) {
1473 check_roundtrip_encoding
= xstrdup(value
);
1477 if (!strcmp(var
, "core.notesref")) {
1478 notes_ref_name
= xstrdup(value
);
1482 if (!strcmp(var
, "core.editor"))
1483 return git_config_string(&editor_program
, var
, value
);
1485 if (!strcmp(var
, "core.commentchar")) {
1487 return config_error_nonbool(var
);
1488 else if (!strcasecmp(value
, "auto"))
1489 auto_comment_line_char
= 1;
1490 else if (value
[0] && !value
[1]) {
1491 comment_line_char
= value
[0];
1492 auto_comment_line_char
= 0;
1494 return error(_("core.commentChar should only be one character"));
1498 if (!strcmp(var
, "core.askpass"))
1499 return git_config_string(&askpass_program
, var
, value
);
1501 if (!strcmp(var
, "core.excludesfile"))
1502 return git_config_pathname(&excludes_file
, var
, value
);
1504 if (!strcmp(var
, "core.whitespace")) {
1506 return config_error_nonbool(var
);
1507 whitespace_rule_cfg
= parse_whitespace_rule(value
);
1511 if (!strcmp(var
, "core.fsyncobjectfiles")) {
1512 fsync_object_files
= git_config_bool(var
, value
);
1516 if (!strcmp(var
, "core.preloadindex")) {
1517 core_preload_index
= git_config_bool(var
, value
);
1521 if (!strcmp(var
, "core.createobject")) {
1522 if (!strcmp(value
, "rename"))
1523 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
1524 else if (!strcmp(value
, "link"))
1525 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
1527 die(_("invalid mode for object creation: %s"), value
);
1531 if (!strcmp(var
, "core.sparsecheckout")) {
1532 core_apply_sparse_checkout
= git_config_bool(var
, value
);
1536 if (!strcmp(var
, "core.sparsecheckoutcone")) {
1537 core_sparse_checkout_cone
= git_config_bool(var
, value
);
1541 if (!strcmp(var
, "core.precomposeunicode")) {
1542 precomposed_unicode
= git_config_bool(var
, value
);
1546 if (!strcmp(var
, "core.protecthfs")) {
1547 protect_hfs
= git_config_bool(var
, value
);
1551 if (!strcmp(var
, "core.protectntfs")) {
1552 protect_ntfs
= git_config_bool(var
, value
);
1556 if (!strcmp(var
, "core.usereplacerefs")) {
1557 read_replace_refs
= git_config_bool(var
, value
);
1561 /* Add other config variables here and to Documentation/config.txt. */
1562 return platform_core_config(var
, value
, cb
);
1565 static int git_default_i18n_config(const char *var
, const char *value
)
1567 if (!strcmp(var
, "i18n.commitencoding"))
1568 return git_config_string(&git_commit_encoding
, var
, value
);
1570 if (!strcmp(var
, "i18n.logoutputencoding"))
1571 return git_config_string(&git_log_output_encoding
, var
, value
);
1573 /* Add other config variables here and to Documentation/config.txt. */
1577 static int git_default_branch_config(const char *var
, const char *value
)
1579 if (!strcmp(var
, "branch.autosetupmerge")) {
1580 if (value
&& !strcasecmp(value
, "always")) {
1581 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1584 git_branch_track
= git_config_bool(var
, value
);
1587 if (!strcmp(var
, "branch.autosetuprebase")) {
1589 return config_error_nonbool(var
);
1590 else if (!strcmp(value
, "never"))
1591 autorebase
= AUTOREBASE_NEVER
;
1592 else if (!strcmp(value
, "local"))
1593 autorebase
= AUTOREBASE_LOCAL
;
1594 else if (!strcmp(value
, "remote"))
1595 autorebase
= AUTOREBASE_REMOTE
;
1596 else if (!strcmp(value
, "always"))
1597 autorebase
= AUTOREBASE_ALWAYS
;
1599 return error(_("malformed value for %s"), var
);
1603 /* Add other config variables here and to Documentation/config.txt. */
1607 static int git_default_push_config(const char *var
, const char *value
)
1609 if (!strcmp(var
, "push.default")) {
1611 return config_error_nonbool(var
);
1612 else if (!strcmp(value
, "nothing"))
1613 push_default
= PUSH_DEFAULT_NOTHING
;
1614 else if (!strcmp(value
, "matching"))
1615 push_default
= PUSH_DEFAULT_MATCHING
;
1616 else if (!strcmp(value
, "simple"))
1617 push_default
= PUSH_DEFAULT_SIMPLE
;
1618 else if (!strcmp(value
, "upstream"))
1619 push_default
= PUSH_DEFAULT_UPSTREAM
;
1620 else if (!strcmp(value
, "tracking")) /* deprecated */
1621 push_default
= PUSH_DEFAULT_UPSTREAM
;
1622 else if (!strcmp(value
, "current"))
1623 push_default
= PUSH_DEFAULT_CURRENT
;
1625 error(_("malformed value for %s: %s"), var
, value
);
1626 return error(_("must be one of nothing, matching, simple, "
1627 "upstream or current"));
1632 /* Add other config variables here and to Documentation/config.txt. */
1636 static int git_default_mailmap_config(const char *var
, const char *value
)
1638 if (!strcmp(var
, "mailmap.file"))
1639 return git_config_pathname(&git_mailmap_file
, var
, value
);
1640 if (!strcmp(var
, "mailmap.blob"))
1641 return git_config_string(&git_mailmap_blob
, var
, value
);
1643 /* Add other config variables here and to Documentation/config.txt. */
1647 int git_default_config(const char *var
, const char *value
, void *cb
)
1649 if (starts_with(var
, "core."))
1650 return git_default_core_config(var
, value
, cb
);
1652 if (starts_with(var
, "user.") ||
1653 starts_with(var
, "author.") ||
1654 starts_with(var
, "committer."))
1655 return git_ident_config(var
, value
, cb
);
1657 if (starts_with(var
, "i18n."))
1658 return git_default_i18n_config(var
, value
);
1660 if (starts_with(var
, "branch."))
1661 return git_default_branch_config(var
, value
);
1663 if (starts_with(var
, "push."))
1664 return git_default_push_config(var
, value
);
1666 if (starts_with(var
, "mailmap."))
1667 return git_default_mailmap_config(var
, value
);
1669 if (starts_with(var
, "advice.") || starts_with(var
, "color.advice"))
1670 return git_default_advice_config(var
, value
);
1672 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1673 pager_use_color
= git_config_bool(var
,value
);
1677 if (!strcmp(var
, "pack.packsizelimit")) {
1678 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1682 if (!strcmp(var
, "pack.compression")) {
1683 int level
= git_config_int(var
, value
);
1685 level
= Z_DEFAULT_COMPRESSION
;
1686 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1687 die(_("bad pack compression level %d"), level
);
1688 pack_compression_level
= level
;
1689 pack_compression_seen
= 1;
1693 /* Add other config variables here and to Documentation/config.txt. */
1698 * All source specific fields in the union, die_on_error, name and the callbacks
1699 * fgetc, ungetc, ftell of top need to be initialized before calling
1702 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
,
1703 const struct config_options
*opts
)
1707 /* push config-file parsing state stack */
1712 strbuf_init(&top
->value
, 1024);
1713 strbuf_init(&top
->var
, 1024);
1716 ret
= git_parse_source(fn
, data
, opts
);
1718 /* pop config-file parsing state stack */
1719 strbuf_release(&top
->value
);
1720 strbuf_release(&top
->var
);
1726 static int do_config_from_file(config_fn_t fn
,
1727 const enum config_origin_type origin_type
,
1728 const char *name
, const char *path
, FILE *f
,
1729 void *data
, const struct config_options
*opts
)
1731 struct config_source top
;
1735 top
.origin_type
= origin_type
;
1738 top
.default_error_action
= CONFIG_ERROR_DIE
;
1739 top
.do_fgetc
= config_file_fgetc
;
1740 top
.do_ungetc
= config_file_ungetc
;
1741 top
.do_ftell
= config_file_ftell
;
1744 ret
= do_config_from(&top
, fn
, data
, opts
);
1749 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1751 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
,
1755 int git_config_from_file_with_options(config_fn_t fn
, const char *filename
,
1757 const struct config_options
*opts
)
1762 f
= fopen_or_warn(filename
, "r");
1764 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
,
1765 filename
, f
, data
, opts
);
1771 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1773 return git_config_from_file_with_options(fn
, filename
, data
, NULL
);
1776 int git_config_from_mem(config_fn_t fn
,
1777 const enum config_origin_type origin_type
,
1778 const char *name
, const char *buf
, size_t len
,
1779 void *data
, const struct config_options
*opts
)
1781 struct config_source top
;
1783 top
.u
.buf
.buf
= buf
;
1784 top
.u
.buf
.len
= len
;
1786 top
.origin_type
= origin_type
;
1789 top
.default_error_action
= CONFIG_ERROR_ERROR
;
1790 top
.do_fgetc
= config_buf_fgetc
;
1791 top
.do_ungetc
= config_buf_ungetc
;
1792 top
.do_ftell
= config_buf_ftell
;
1794 return do_config_from(&top
, fn
, data
, opts
);
1797 int git_config_from_blob_oid(config_fn_t fn
,
1799 const struct object_id
*oid
,
1802 enum object_type type
;
1807 buf
= read_object_file(oid
, &type
, &size
);
1809 return error(_("unable to load config blob object '%s'"), name
);
1810 if (type
!= OBJ_BLOB
) {
1812 return error(_("reference '%s' does not point to a blob"), name
);
1815 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
,
1822 static int git_config_from_blob_ref(config_fn_t fn
,
1826 struct object_id oid
;
1828 if (get_oid(name
, &oid
) < 0)
1829 return error(_("unable to resolve config blob '%s'"), name
);
1830 return git_config_from_blob_oid(fn
, name
, &oid
, data
);
1833 char *git_system_config(void)
1835 char *system_config
= xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1837 system_config
= system_path(ETC_GITCONFIG
);
1838 normalize_path_copy(system_config
, system_config
);
1839 return system_config
;
1842 void git_global_config(char **user_out
, char **xdg_out
)
1844 char *user_config
= xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1845 char *xdg_config
= NULL
;
1848 user_config
= interpolate_path("~/.gitconfig", 0);
1849 xdg_config
= xdg_config_home("config");
1852 *user_out
= user_config
;
1853 *xdg_out
= xdg_config
;
1857 * Parse environment variable 'k' as a boolean (in various
1858 * possible spellings); if missing, use the default value 'def'.
1860 int git_env_bool(const char *k
, int def
)
1862 const char *v
= getenv(k
);
1863 return v
? git_config_bool(k
, v
) : def
;
1867 * Parse environment variable 'k' as ulong with possibly a unit
1868 * suffix; if missing, use the default value 'val'.
1870 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1872 const char *v
= getenv(k
);
1873 if (v
&& !git_parse_ulong(v
, &val
))
1874 die(_("failed to parse %s"), k
);
1878 int git_config_system(void)
1880 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1883 static int do_git_config_sequence(const struct config_options
*opts
,
1884 config_fn_t fn
, void *data
)
1887 char *system_config
= git_system_config();
1888 char *xdg_config
= NULL
;
1889 char *user_config
= NULL
;
1891 enum config_scope prev_parsing_scope
= current_parsing_scope
;
1893 if (opts
->commondir
)
1894 repo_config
= mkpathdup("%s/config", opts
->commondir
);
1895 else if (opts
->git_dir
)
1896 BUG("git_dir without commondir");
1900 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1901 if (git_config_system() && system_config
&&
1902 !access_or_die(system_config
, R_OK
,
1903 opts
->system_gently
? ACCESS_EACCES_OK
: 0))
1904 ret
+= git_config_from_file(fn
, system_config
, data
);
1906 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1907 git_global_config(&user_config
, &xdg_config
);
1909 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1910 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1912 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1913 ret
+= git_config_from_file(fn
, user_config
, data
);
1915 current_parsing_scope
= CONFIG_SCOPE_LOCAL
;
1916 if (!opts
->ignore_repo
&& repo_config
&&
1917 !access_or_die(repo_config
, R_OK
, 0))
1918 ret
+= git_config_from_file(fn
, repo_config
, data
);
1920 current_parsing_scope
= CONFIG_SCOPE_WORKTREE
;
1921 if (!opts
->ignore_worktree
&& repository_format_worktree_config
) {
1922 char *path
= git_pathdup("config.worktree");
1923 if (!access_or_die(path
, R_OK
, 0))
1924 ret
+= git_config_from_file(fn
, path
, data
);
1928 current_parsing_scope
= CONFIG_SCOPE_COMMAND
;
1929 if (!opts
->ignore_cmdline
&& git_config_from_parameters(fn
, data
) < 0)
1930 die(_("unable to parse command-line config"));
1932 current_parsing_scope
= prev_parsing_scope
;
1933 free(system_config
);
1940 int config_with_options(config_fn_t fn
, void *data
,
1941 struct git_config_source
*config_source
,
1942 const struct config_options
*opts
)
1944 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1946 if (opts
->respect_includes
) {
1950 fn
= git_config_include
;
1955 current_parsing_scope
= config_source
->scope
;
1958 * If we have a specific filename, use it. Otherwise, follow the
1959 * regular lookup sequence.
1961 if (config_source
&& config_source
->use_stdin
)
1962 return git_config_from_stdin(fn
, data
);
1963 else if (config_source
&& config_source
->file
)
1964 return git_config_from_file(fn
, config_source
->file
, data
);
1965 else if (config_source
&& config_source
->blob
)
1966 return git_config_from_blob_ref(fn
, config_source
->blob
, data
);
1968 return do_git_config_sequence(opts
, fn
, data
);
1971 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1974 struct string_list
*values
;
1975 struct config_set_element
*entry
;
1976 struct configset_list
*list
= &cs
->list
;
1978 for (i
= 0; i
< list
->nr
; i
++) {
1979 entry
= list
->items
[i
].e
;
1980 value_index
= list
->items
[i
].value_index
;
1981 values
= &entry
->value_list
;
1983 current_config_kvi
= values
->items
[value_index
].util
;
1985 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1986 git_die_config_linenr(entry
->key
,
1987 current_config_kvi
->filename
,
1988 current_config_kvi
->linenr
);
1990 current_config_kvi
= NULL
;
1994 void read_early_config(config_fn_t cb
, void *data
)
1996 struct config_options opts
= {0};
1997 struct strbuf commondir
= STRBUF_INIT
;
1998 struct strbuf gitdir
= STRBUF_INIT
;
2000 opts
.respect_includes
= 1;
2002 if (have_git_dir()) {
2003 opts
.commondir
= get_git_common_dir();
2004 opts
.git_dir
= get_git_dir();
2006 * When setup_git_directory() was not yet asked to discover the
2007 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2008 * is any repository config we should use (but unlike
2009 * setup_git_directory_gently(), no global state is changed, most
2010 * notably, the current working directory is still the same after the
2013 } else if (!discover_git_directory(&commondir
, &gitdir
)) {
2014 opts
.commondir
= commondir
.buf
;
2015 opts
.git_dir
= gitdir
.buf
;
2018 config_with_options(cb
, data
, NULL
, &opts
);
2020 strbuf_release(&commondir
);
2021 strbuf_release(&gitdir
);
2025 * Read config but only enumerate system and global settings.
2026 * Omit any repo-local, worktree-local, or command-line settings.
2028 void read_very_early_config(config_fn_t cb
, void *data
)
2030 struct config_options opts
= { 0 };
2032 opts
.respect_includes
= 1;
2033 opts
.ignore_repo
= 1;
2034 opts
.ignore_worktree
= 1;
2035 opts
.ignore_cmdline
= 1;
2036 opts
.system_gently
= 1;
2038 config_with_options(cb
, data
, NULL
, &opts
);
2041 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
2043 struct config_set_element k
;
2044 struct config_set_element
*found_entry
;
2045 char *normalized_key
;
2047 * `key` may come from the user, so normalize it before using it
2048 * for querying entries from the hashmap.
2050 if (git_config_parse_key(key
, &normalized_key
, NULL
))
2053 hashmap_entry_init(&k
.ent
, strhash(normalized_key
));
2054 k
.key
= normalized_key
;
2055 found_entry
= hashmap_get_entry(&cs
->config_hash
, &k
, ent
, NULL
);
2056 free(normalized_key
);
2060 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
2062 struct config_set_element
*e
;
2063 struct string_list_item
*si
;
2064 struct configset_list_item
*l_item
;
2065 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
2067 e
= configset_find_element(cs
, key
);
2069 * Since the keys are being fed by git_config*() callback mechanism, they
2070 * are already normalized. So simply add them without any further munging.
2073 e
= xmalloc(sizeof(*e
));
2074 hashmap_entry_init(&e
->ent
, strhash(key
));
2075 e
->key
= xstrdup(key
);
2076 string_list_init_dup(&e
->value_list
);
2077 hashmap_add(&cs
->config_hash
, &e
->ent
);
2079 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
2081 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
2082 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
2084 l_item
->value_index
= e
->value_list
.nr
- 1;
2087 BUG("configset_add_value has no source");
2089 kv_info
->filename
= strintern(cf
->name
);
2090 kv_info
->linenr
= cf
->linenr
;
2091 kv_info
->origin_type
= cf
->origin_type
;
2093 /* for values read from `git_config_from_parameters()` */
2094 kv_info
->filename
= NULL
;
2095 kv_info
->linenr
= -1;
2096 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
2098 kv_info
->scope
= current_parsing_scope
;
2104 static int config_set_element_cmp(const void *unused_cmp_data
,
2105 const struct hashmap_entry
*eptr
,
2106 const struct hashmap_entry
*entry_or_key
,
2107 const void *unused_keydata
)
2109 const struct config_set_element
*e1
, *e2
;
2111 e1
= container_of(eptr
, const struct config_set_element
, ent
);
2112 e2
= container_of(entry_or_key
, const struct config_set_element
, ent
);
2114 return strcmp(e1
->key
, e2
->key
);
2117 void git_configset_init(struct config_set
*cs
)
2119 hashmap_init(&cs
->config_hash
, config_set_element_cmp
, NULL
, 0);
2120 cs
->hash_initialized
= 1;
2123 cs
->list
.items
= NULL
;
2126 void git_configset_clear(struct config_set
*cs
)
2128 struct config_set_element
*entry
;
2129 struct hashmap_iter iter
;
2130 if (!cs
->hash_initialized
)
2133 hashmap_for_each_entry(&cs
->config_hash
, &iter
, entry
,
2134 ent
/* member name */) {
2136 string_list_clear(&entry
->value_list
, 1);
2138 hashmap_clear_and_free(&cs
->config_hash
, struct config_set_element
, ent
);
2139 cs
->hash_initialized
= 0;
2140 free(cs
->list
.items
);
2143 cs
->list
.items
= NULL
;
2146 static int config_set_callback(const char *key
, const char *value
, void *cb
)
2148 struct config_set
*cs
= cb
;
2149 configset_add_value(cs
, key
, value
);
2153 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
2155 return git_config_from_file(config_set_callback
, filename
, cs
);
2158 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
2160 const struct string_list
*values
= NULL
;
2162 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2163 * queried key in the files of the configset, the value returned will be the last
2164 * value in the value list for that key.
2166 values
= git_configset_get_value_multi(cs
, key
);
2170 assert(values
->nr
> 0);
2171 *value
= values
->items
[values
->nr
- 1].string
;
2175 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
2177 struct config_set_element
*e
= configset_find_element(cs
, key
);
2178 return e
? &e
->value_list
: NULL
;
2181 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
2184 if (!git_configset_get_value(cs
, key
, &value
))
2185 return git_config_string((const char **)dest
, key
, value
);
2190 int git_configset_get_string_tmp(struct config_set
*cs
, const char *key
,
2194 if (!git_configset_get_value(cs
, key
, &value
)) {
2196 return config_error_nonbool(key
);
2204 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
2207 if (!git_configset_get_value(cs
, key
, &value
)) {
2208 *dest
= git_config_int(key
, value
);
2214 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
2217 if (!git_configset_get_value(cs
, key
, &value
)) {
2218 *dest
= git_config_ulong(key
, value
);
2224 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
2227 if (!git_configset_get_value(cs
, key
, &value
)) {
2228 *dest
= git_config_bool(key
, value
);
2234 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
2235 int *is_bool
, int *dest
)
2238 if (!git_configset_get_value(cs
, key
, &value
)) {
2239 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
2245 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
2248 if (!git_configset_get_value(cs
, key
, &value
)) {
2249 *dest
= git_parse_maybe_bool(value
);
2257 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
2260 if (!git_configset_get_value(cs
, key
, &value
))
2261 return git_config_pathname(dest
, key
, value
);
2266 /* Functions use to read configuration from a repository */
2267 static void repo_read_config(struct repository
*repo
)
2269 struct config_options opts
= { 0 };
2271 opts
.respect_includes
= 1;
2272 opts
.commondir
= repo
->commondir
;
2273 opts
.git_dir
= repo
->gitdir
;
2276 CALLOC_ARRAY(repo
->config
, 1);
2278 git_configset_clear(repo
->config
);
2280 git_configset_init(repo
->config
);
2282 if (config_with_options(config_set_callback
, repo
->config
, NULL
, &opts
) < 0)
2284 * config_with_options() normally returns only
2285 * zero, as most errors are fatal, and
2286 * non-fatal potential errors are guarded by "if"
2287 * statements that are entered only when no error is
2290 * If we ever encounter a non-fatal error, it means
2291 * something went really wrong and we should stop
2294 die(_("unknown error occurred while reading the configuration files"));
2297 static void git_config_check_init(struct repository
*repo
)
2299 if (repo
->config
&& repo
->config
->hash_initialized
)
2301 repo_read_config(repo
);
2304 static void repo_config_clear(struct repository
*repo
)
2306 if (!repo
->config
|| !repo
->config
->hash_initialized
)
2308 git_configset_clear(repo
->config
);
2311 void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
)
2313 git_config_check_init(repo
);
2314 configset_iter(repo
->config
, fn
, data
);
2317 int repo_config_get_value(struct repository
*repo
,
2318 const char *key
, const char **value
)
2320 git_config_check_init(repo
);
2321 return git_configset_get_value(repo
->config
, key
, value
);
2324 const struct string_list
*repo_config_get_value_multi(struct repository
*repo
,
2327 git_config_check_init(repo
);
2328 return git_configset_get_value_multi(repo
->config
, key
);
2331 int repo_config_get_string(struct repository
*repo
,
2332 const char *key
, char **dest
)
2335 git_config_check_init(repo
);
2336 ret
= git_configset_get_string(repo
->config
, key
, dest
);
2338 git_die_config(key
, NULL
);
2342 int repo_config_get_string_tmp(struct repository
*repo
,
2343 const char *key
, const char **dest
)
2346 git_config_check_init(repo
);
2347 ret
= git_configset_get_string_tmp(repo
->config
, key
, dest
);
2349 git_die_config(key
, NULL
);
2353 int repo_config_get_int(struct repository
*repo
,
2354 const char *key
, int *dest
)
2356 git_config_check_init(repo
);
2357 return git_configset_get_int(repo
->config
, key
, dest
);
2360 int repo_config_get_ulong(struct repository
*repo
,
2361 const char *key
, unsigned long *dest
)
2363 git_config_check_init(repo
);
2364 return git_configset_get_ulong(repo
->config
, key
, dest
);
2367 int repo_config_get_bool(struct repository
*repo
,
2368 const char *key
, int *dest
)
2370 git_config_check_init(repo
);
2371 return git_configset_get_bool(repo
->config
, key
, dest
);
2374 int repo_config_get_bool_or_int(struct repository
*repo
,
2375 const char *key
, int *is_bool
, int *dest
)
2377 git_config_check_init(repo
);
2378 return git_configset_get_bool_or_int(repo
->config
, key
, is_bool
, dest
);
2381 int repo_config_get_maybe_bool(struct repository
*repo
,
2382 const char *key
, int *dest
)
2384 git_config_check_init(repo
);
2385 return git_configset_get_maybe_bool(repo
->config
, key
, dest
);
2388 int repo_config_get_pathname(struct repository
*repo
,
2389 const char *key
, const char **dest
)
2392 git_config_check_init(repo
);
2393 ret
= git_configset_get_pathname(repo
->config
, key
, dest
);
2395 git_die_config(key
, NULL
);
2399 /* Functions used historically to read configuration from 'the_repository' */
2400 void git_config(config_fn_t fn
, void *data
)
2402 repo_config(the_repository
, fn
, data
);
2405 void git_config_clear(void)
2407 repo_config_clear(the_repository
);
2410 int git_config_get_value(const char *key
, const char **value
)
2412 return repo_config_get_value(the_repository
, key
, value
);
2415 const struct string_list
*git_config_get_value_multi(const char *key
)
2417 return repo_config_get_value_multi(the_repository
, key
);
2420 int git_config_get_string(const char *key
, char **dest
)
2422 return repo_config_get_string(the_repository
, key
, dest
);
2425 int git_config_get_string_tmp(const char *key
, const char **dest
)
2427 return repo_config_get_string_tmp(the_repository
, key
, dest
);
2430 int git_config_get_int(const char *key
, int *dest
)
2432 return repo_config_get_int(the_repository
, key
, dest
);
2435 int git_config_get_ulong(const char *key
, unsigned long *dest
)
2437 return repo_config_get_ulong(the_repository
, key
, dest
);
2440 int git_config_get_bool(const char *key
, int *dest
)
2442 return repo_config_get_bool(the_repository
, key
, dest
);
2445 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
2447 return repo_config_get_bool_or_int(the_repository
, key
, is_bool
, dest
);
2450 int git_config_get_maybe_bool(const char *key
, int *dest
)
2452 return repo_config_get_maybe_bool(the_repository
, key
, dest
);
2455 int git_config_get_pathname(const char *key
, const char **dest
)
2457 return repo_config_get_pathname(the_repository
, key
, dest
);
2460 int git_config_get_expiry(const char *key
, const char **output
)
2462 int ret
= git_config_get_string(key
, (char **)output
);
2465 if (strcmp(*output
, "now")) {
2466 timestamp_t now
= approxidate("now");
2467 if (approxidate(*output
) >= now
)
2468 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
2473 int git_config_get_expiry_in_days(const char *key
, timestamp_t
*expiry
, timestamp_t now
)
2475 const char *expiry_string
;
2479 if (git_config_get_string_tmp(key
, &expiry_string
))
2480 return 1; /* no such thing */
2482 if (git_parse_signed(expiry_string
, &days
, maximum_signed_value_of_type(int))) {
2483 const int scale
= 86400;
2484 *expiry
= now
- days
* scale
;
2488 if (!parse_expiry_date(expiry_string
, &when
)) {
2492 return -1; /* thing exists but cannot be parsed */
2495 int git_config_get_split_index(void)
2499 if (!git_config_get_maybe_bool("core.splitindex", &val
))
2502 return -1; /* default value */
2505 int git_config_get_max_percent_split_change(void)
2509 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
2510 if (0 <= val
&& val
<= 100)
2513 return error(_("splitIndex.maxPercentChange value '%d' "
2514 "should be between 0 and 100"), val
);
2517 return -1; /* default value */
2520 int git_config_get_fsmonitor(void)
2522 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor
))
2523 core_fsmonitor
= getenv("GIT_TEST_FSMONITOR");
2525 if (core_fsmonitor
&& !*core_fsmonitor
)
2526 core_fsmonitor
= NULL
;
2534 int git_config_get_index_threads(int *dest
)
2538 val
= git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2544 if (!git_config_get_bool_or_int("index.threads", &is_bool
, &val
)) {
2546 *dest
= val
? 0 : 1;
2556 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
2559 die(_("unable to parse '%s' from command-line config"), key
);
2561 die(_("bad config variable '%s' in file '%s' at line %d"),
2562 key
, filename
, linenr
);
2565 NORETURN
__attribute__((format(printf
, 2, 3)))
2566 void git_die_config(const char *key
, const char *err
, ...)
2568 const struct string_list
*values
;
2569 struct key_value_info
*kv_info
;
2573 va_start(params
, err
);
2574 vreportf("error: ", err
, params
);
2577 values
= git_config_get_value_multi(key
);
2578 kv_info
= values
->items
[values
->nr
- 1].util
;
2579 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
2583 * Find all the stuff for git_config_set() below.
2586 struct config_store_data
{
2590 const char *fixed_value
;
2591 regex_t
*value_pattern
;
2595 enum config_event_t type
;
2596 int is_keys_section
;
2598 unsigned int parsed_nr
, parsed_alloc
, *seen
, seen_nr
, seen_alloc
;
2599 unsigned int key_seen
:1, section_seen
:1, is_keys_section
:1;
2602 static void config_store_data_clear(struct config_store_data
*store
)
2605 if (store
->value_pattern
!= NULL
&&
2606 store
->value_pattern
!= CONFIG_REGEX_NONE
) {
2607 regfree(store
->value_pattern
);
2608 free(store
->value_pattern
);
2610 free(store
->parsed
);
2612 memset(store
, 0, sizeof(*store
));
2615 static int matches(const char *key
, const char *value
,
2616 const struct config_store_data
*store
)
2618 if (strcmp(key
, store
->key
))
2619 return 0; /* not ours */
2620 if (store
->fixed_value
)
2621 return !strcmp(store
->fixed_value
, value
);
2622 if (!store
->value_pattern
)
2623 return 1; /* always matches */
2624 if (store
->value_pattern
== CONFIG_REGEX_NONE
)
2625 return 0; /* never matches */
2627 return store
->do_not_match
^
2628 (value
&& !regexec(store
->value_pattern
, value
, 0, NULL
, 0));
2631 static int store_aux_event(enum config_event_t type
,
2632 size_t begin
, size_t end
, void *data
)
2634 struct config_store_data
*store
= data
;
2636 ALLOC_GROW(store
->parsed
, store
->parsed_nr
+ 1, store
->parsed_alloc
);
2637 store
->parsed
[store
->parsed_nr
].begin
= begin
;
2638 store
->parsed
[store
->parsed_nr
].end
= end
;
2639 store
->parsed
[store
->parsed_nr
].type
= type
;
2641 if (type
== CONFIG_EVENT_SECTION
) {
2642 int (*cmpfn
)(const char *, const char *, size_t);
2644 if (cf
->var
.len
< 2 || cf
->var
.buf
[cf
->var
.len
- 1] != '.')
2645 return error(_("invalid section name '%s'"), cf
->var
.buf
);
2647 if (cf
->subsection_case_sensitive
)
2648 cmpfn
= strncasecmp
;
2652 /* Is this the section we were looking for? */
2653 store
->is_keys_section
=
2654 store
->parsed
[store
->parsed_nr
].is_keys_section
=
2655 cf
->var
.len
- 1 == store
->baselen
&&
2656 !cmpfn(cf
->var
.buf
, store
->key
, store
->baselen
);
2657 if (store
->is_keys_section
) {
2658 store
->section_seen
= 1;
2659 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2661 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2670 static int store_aux(const char *key
, const char *value
, void *cb
)
2672 struct config_store_data
*store
= cb
;
2674 if (store
->key_seen
) {
2675 if (matches(key
, value
, store
)) {
2676 if (store
->seen_nr
== 1 && store
->multi_replace
== 0) {
2677 warning(_("%s has multiple values"), key
);
2680 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2683 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2686 } else if (store
->is_keys_section
) {
2688 * Do not increment matches yet: this may not be a match, but we
2689 * are in the desired section.
2691 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1, store
->seen_alloc
);
2692 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2693 store
->section_seen
= 1;
2695 if (matches(key
, value
, store
)) {
2697 store
->key_seen
= 1;
2704 static int write_error(const char *filename
)
2706 error(_("failed to write new configuration file %s"), filename
);
2708 /* Same error code as "failed to rename". */
2712 static struct strbuf
store_create_section(const char *key
,
2713 const struct config_store_data
*store
)
2717 struct strbuf sb
= STRBUF_INIT
;
2719 dot
= memchr(key
, '.', store
->baselen
);
2721 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
2722 for (i
= dot
- key
+ 1; i
< store
->baselen
; i
++) {
2723 if (key
[i
] == '"' || key
[i
] == '\\')
2724 strbuf_addch(&sb
, '\\');
2725 strbuf_addch(&sb
, key
[i
]);
2727 strbuf_addstr(&sb
, "\"]\n");
2729 strbuf_addch(&sb
, '[');
2730 strbuf_add(&sb
, key
, store
->baselen
);
2731 strbuf_addstr(&sb
, "]\n");
2737 static ssize_t
write_section(int fd
, const char *key
,
2738 const struct config_store_data
*store
)
2740 struct strbuf sb
= store_create_section(key
, store
);
2743 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2744 strbuf_release(&sb
);
2749 static ssize_t
write_pair(int fd
, const char *key
, const char *value
,
2750 const struct config_store_data
*store
)
2754 const char *quote
= "";
2755 struct strbuf sb
= STRBUF_INIT
;
2758 * Check to see if the value needs to be surrounded with a dq pair.
2759 * Note that problematic characters are always backslash-quoted; this
2760 * check is about not losing leading or trailing SP and strings that
2761 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2762 * configuration parser.
2764 if (value
[0] == ' ')
2766 for (i
= 0; value
[i
]; i
++)
2767 if (value
[i
] == ';' || value
[i
] == '#')
2769 if (i
&& value
[i
- 1] == ' ')
2772 strbuf_addf(&sb
, "\t%s = %s", key
+ store
->baselen
+ 1, quote
);
2774 for (i
= 0; value
[i
]; i
++)
2777 strbuf_addstr(&sb
, "\\n");
2780 strbuf_addstr(&sb
, "\\t");
2784 strbuf_addch(&sb
, '\\');
2787 strbuf_addch(&sb
, value
[i
]);
2790 strbuf_addf(&sb
, "%s\n", quote
);
2792 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2793 strbuf_release(&sb
);
2799 * If we are about to unset the last key(s) in a section, and if there are
2800 * no comments surrounding (or included in) the section, we will want to
2801 * extend begin/end to remove the entire section.
2803 * Note: the parameter `seen_ptr` points to the index into the store.seen
2804 * array. * This index may be incremented if a section has more than one
2805 * entry (which all are to be removed).
2807 static void maybe_remove_section(struct config_store_data
*store
,
2808 size_t *begin_offset
, size_t *end_offset
,
2812 int i
, seen
, section_seen
= 0;
2815 * First, ensure that this is the first key, and that there are no
2816 * comments before the entry nor before the section header.
2819 for (i
= store
->seen
[seen
]; i
> 0; i
--) {
2820 enum config_event_t type
= store
->parsed
[i
- 1].type
;
2822 if (type
== CONFIG_EVENT_COMMENT
)
2823 /* There is a comment before this entry or section */
2825 if (type
== CONFIG_EVENT_ENTRY
) {
2827 /* This is not the section's first entry. */
2829 /* We encountered no comment before the section. */
2832 if (type
== CONFIG_EVENT_SECTION
) {
2833 if (!store
->parsed
[i
- 1].is_keys_section
)
2838 begin
= store
->parsed
[i
].begin
;
2841 * Next, make sure that we are removing the last key(s) in the section,
2842 * and that there are no comments that are possibly about the current
2845 for (i
= store
->seen
[seen
] + 1; i
< store
->parsed_nr
; i
++) {
2846 enum config_event_t type
= store
->parsed
[i
].type
;
2848 if (type
== CONFIG_EVENT_COMMENT
)
2850 if (type
== CONFIG_EVENT_SECTION
) {
2851 if (store
->parsed
[i
].is_keys_section
)
2855 if (type
== CONFIG_EVENT_ENTRY
) {
2856 if (++seen
< store
->seen_nr
&&
2857 i
== store
->seen
[seen
])
2858 /* We want to remove this entry, too */
2860 /* There is another entry in this section. */
2866 * We are really removing the last entry/entries from this section, and
2867 * there are no enclosed or surrounding comments. Remove the entire,
2868 * now-empty section.
2871 *begin_offset
= begin
;
2872 if (i
< store
->parsed_nr
)
2873 *end_offset
= store
->parsed
[i
].begin
;
2875 *end_offset
= store
->parsed
[store
->parsed_nr
- 1].end
;
2878 int git_config_set_in_file_gently(const char *config_filename
,
2879 const char *key
, const char *value
)
2881 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
2884 void git_config_set_in_file(const char *config_filename
,
2885 const char *key
, const char *value
)
2887 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
2890 int git_config_set_gently(const char *key
, const char *value
)
2892 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
2895 void git_config_set(const char *key
, const char *value
)
2897 git_config_set_multivar(key
, value
, NULL
, 0);
2899 trace2_cmd_set_config(key
, value
);
2903 * If value==NULL, unset in (remove from) config,
2904 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
2905 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
2906 * (only add a new one)
2907 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
2908 * key/values are removed before a single new pair is written. If the
2909 * flag is not present, then replace only the first match.
2911 * Returns 0 on success.
2913 * This function does this:
2915 * - it locks the config file by creating ".git/config.lock"
2917 * - it then parses the config using store_aux() as validator to find
2918 * the position on the key/value pair to replace. If it is to be unset,
2919 * it must be found exactly once.
2921 * - the config file is mmap()ed and the part before the match (if any) is
2922 * written to the lock file, then the changed part and the rest.
2924 * - the config file is removed and the lock file rename()d to it.
2927 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2928 const char *key
, const char *value
,
2929 const char *value_pattern
,
2932 int fd
= -1, in_fd
= -1;
2934 struct lock_file lock
= LOCK_INIT
;
2935 char *filename_buf
= NULL
;
2936 char *contents
= NULL
;
2938 struct config_store_data store
;
2940 memset(&store
, 0, sizeof(store
));
2942 /* parse-key returns negative; flip the sign to feed exit(3) */
2943 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2947 store
.multi_replace
= (flags
& CONFIG_FLAGS_MULTI_REPLACE
) != 0;
2949 if (!config_filename
)
2950 config_filename
= filename_buf
= git_pathdup("config");
2953 * The lock serves a purpose in addition to locking: the new
2954 * contents of .git/config will be written into it.
2956 fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
2958 error_errno(_("could not lock config file %s"), config_filename
);
2959 ret
= CONFIG_NO_LOCK
;
2964 * If .git/config does not exist yet, write a minimal version.
2966 in_fd
= open(config_filename
, O_RDONLY
);
2968 if ( ENOENT
!= errno
) {
2969 error_errno(_("opening %s"), config_filename
);
2970 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2973 /* if nothing to unset, error out */
2974 if (value
== NULL
) {
2975 ret
= CONFIG_NOTHING_SET
;
2980 store
.key
= xstrdup(key
);
2981 if (write_section(fd
, key
, &store
) < 0 ||
2982 write_pair(fd
, key
, value
, &store
) < 0)
2986 size_t copy_begin
, copy_end
;
2987 int i
, new_line
= 0;
2988 struct config_options opts
;
2990 if (value_pattern
== NULL
)
2991 store
.value_pattern
= NULL
;
2992 else if (value_pattern
== CONFIG_REGEX_NONE
)
2993 store
.value_pattern
= CONFIG_REGEX_NONE
;
2994 else if (flags
& CONFIG_FLAGS_FIXED_VALUE
)
2995 store
.fixed_value
= value_pattern
;
2997 if (value_pattern
[0] == '!') {
2998 store
.do_not_match
= 1;
3001 store
.do_not_match
= 0;
3003 store
.value_pattern
= (regex_t
*)xmalloc(sizeof(regex_t
));
3004 if (regcomp(store
.value_pattern
, value_pattern
,
3006 error(_("invalid pattern: %s"), value_pattern
);
3007 FREE_AND_NULL(store
.value_pattern
);
3008 ret
= CONFIG_INVALID_PATTERN
;
3013 ALLOC_GROW(store
.parsed
, 1, store
.parsed_alloc
);
3014 store
.parsed
[0].end
= 0;
3016 memset(&opts
, 0, sizeof(opts
));
3017 opts
.event_fn
= store_aux_event
;
3018 opts
.event_fn_data
= &store
;
3021 * After this, store.parsed will contain offsets of all the
3022 * parsed elements, and store.seen will contain a list of
3023 * matches, as indices into store.parsed.
3025 * As a side effect, we make sure to transform only a valid
3026 * existing config file.
3028 if (git_config_from_file_with_options(store_aux
,
3031 error(_("invalid config file %s"), config_filename
);
3032 ret
= CONFIG_INVALID_FILE
;
3036 /* if nothing to unset, or too many matches, error out */
3037 if ((store
.seen_nr
== 0 && value
== NULL
) ||
3038 (store
.seen_nr
> 1 && !store
.multi_replace
)) {
3039 ret
= CONFIG_NOTHING_SET
;
3043 if (fstat(in_fd
, &st
) == -1) {
3044 error_errno(_("fstat on %s failed"), config_filename
);
3045 ret
= CONFIG_INVALID_FILE
;
3049 contents_sz
= xsize_t(st
.st_size
);
3050 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
3051 MAP_PRIVATE
, in_fd
, 0);
3052 if (contents
== MAP_FAILED
) {
3053 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
3055 error_errno(_("unable to mmap '%s'%s"),
3056 config_filename
, mmap_os_err());
3057 ret
= CONFIG_INVALID_FILE
;
3064 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3065 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock
));
3066 ret
= CONFIG_NO_WRITE
;
3070 if (store
.seen_nr
== 0) {
3071 if (!store
.seen_alloc
) {
3072 /* Did not see key nor section */
3073 ALLOC_GROW(store
.seen
, 1, store
.seen_alloc
);
3074 store
.seen
[0] = store
.parsed_nr
3075 - !!store
.parsed_nr
;
3080 for (i
= 0, copy_begin
= 0; i
< store
.seen_nr
; i
++) {
3082 int j
= store
.seen
[i
];
3085 if (!store
.key_seen
) {
3086 copy_end
= store
.parsed
[j
].end
;
3087 /* include '\n' when copying section header */
3088 if (copy_end
> 0 && copy_end
< contents_sz
&&
3089 contents
[copy_end
- 1] != '\n' &&
3090 contents
[copy_end
] == '\n')
3092 replace_end
= copy_end
;
3094 replace_end
= store
.parsed
[j
].end
;
3095 copy_end
= store
.parsed
[j
].begin
;
3097 maybe_remove_section(&store
,
3101 * Swallow preceding white-space on the same
3104 while (copy_end
> 0 ) {
3105 char c
= contents
[copy_end
- 1];
3107 if (isspace(c
) && c
!= '\n')
3114 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
3117 /* write the first part of the config */
3118 if (copy_end
> copy_begin
) {
3119 if (write_in_full(fd
, contents
+ copy_begin
,
3120 copy_end
- copy_begin
) < 0)
3123 write_str_in_full(fd
, "\n") < 0)
3126 copy_begin
= replace_end
;
3129 /* write the pair (value == NULL means unset) */
3130 if (value
!= NULL
) {
3131 if (!store
.section_seen
) {
3132 if (write_section(fd
, key
, &store
) < 0)
3135 if (write_pair(fd
, key
, value
, &store
) < 0)
3139 /* write the rest of the config */
3140 if (copy_begin
< contents_sz
)
3141 if (write_in_full(fd
, contents
+ copy_begin
,
3142 contents_sz
- copy_begin
) < 0)
3145 munmap(contents
, contents_sz
);
3149 if (commit_lock_file(&lock
) < 0) {
3150 error_errno(_("could not write config file %s"), config_filename
);
3151 ret
= CONFIG_NO_WRITE
;
3157 /* Invalidate the config cache */
3161 rollback_lock_file(&lock
);
3164 munmap(contents
, contents_sz
);
3167 config_store_data_clear(&store
);
3171 ret
= write_error(get_lock_file_path(&lock
));
3176 void git_config_set_multivar_in_file(const char *config_filename
,
3177 const char *key
, const char *value
,
3178 const char *value_pattern
, unsigned flags
)
3180 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
3181 value_pattern
, flags
))
3184 die(_("could not set '%s' to '%s'"), key
, value
);
3186 die(_("could not unset '%s'"), key
);
3189 int git_config_set_multivar_gently(const char *key
, const char *value
,
3190 const char *value_pattern
, unsigned flags
)
3192 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_pattern
,
3196 void git_config_set_multivar(const char *key
, const char *value
,
3197 const char *value_pattern
, unsigned flags
)
3199 git_config_set_multivar_in_file(NULL
, key
, value
, value_pattern
,
3203 static int section_name_match (const char *buf
, const char *name
)
3205 int i
= 0, j
= 0, dot
= 0;
3208 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
3209 if (!dot
&& isspace(buf
[i
])) {
3211 if (name
[j
++] != '.')
3213 for (i
++; isspace(buf
[i
]); i
++)
3219 if (buf
[i
] == '\\' && dot
)
3221 else if (buf
[i
] == '"' && dot
) {
3222 for (i
++; isspace(buf
[i
]); i
++)
3226 if (buf
[i
] != name
[j
++])
3229 if (buf
[i
] == ']' && name
[j
] == 0) {
3231 * We match, now just find the right length offset by
3232 * gobbling up any whitespace after it, as well
3235 for (; buf
[i
] && isspace(buf
[i
]); i
++)
3242 static int section_name_is_ok(const char *name
)
3244 /* Empty section names are bogus. */
3249 * Before a dot, we must be alphanumeric or dash. After the first dot,
3250 * anything goes, so we can stop checking.
3252 for (; *name
&& *name
!= '.'; name
++)
3253 if (*name
!= '-' && !isalnum(*name
))
3258 /* if new_name == NULL, the section is removed instead */
3259 static int git_config_copy_or_rename_section_in_file(const char *config_filename
,
3260 const char *old_name
,
3261 const char *new_name
, int copy
)
3263 int ret
= 0, remove
= 0;
3264 char *filename_buf
= NULL
;
3265 struct lock_file lock
= LOCK_INIT
;
3268 FILE *config_file
= NULL
;
3270 struct strbuf copystr
= STRBUF_INIT
;
3271 struct config_store_data store
;
3273 memset(&store
, 0, sizeof(store
));
3275 if (new_name
&& !section_name_is_ok(new_name
)) {
3276 ret
= error(_("invalid section name: %s"), new_name
);
3277 goto out_no_rollback
;
3280 if (!config_filename
)
3281 config_filename
= filename_buf
= git_pathdup("config");
3283 out_fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3285 ret
= error(_("could not lock config file %s"), config_filename
);
3289 if (!(config_file
= fopen(config_filename
, "rb"))) {
3290 ret
= warn_on_fopen_errors(config_filename
);
3293 /* no config file means nothing to rename, no error */
3294 goto commit_and_out
;
3297 if (fstat(fileno(config_file
), &st
) == -1) {
3298 ret
= error_errno(_("fstat on %s failed"), config_filename
);
3302 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3303 ret
= error_errno(_("chmod on %s failed"),
3304 get_lock_file_path(&lock
));
3308 while (fgets(buf
, sizeof(buf
), config_file
)) {
3313 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
3315 if (buf
[i
] == '[') {
3316 /* it's a section */
3321 * When encountering a new section under -c we
3322 * need to flush out any section we're already
3323 * coping and begin anew. There might be
3324 * multiple [branch "$name"] sections.
3326 if (copystr
.len
> 0) {
3327 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3328 ret
= write_error(get_lock_file_path(&lock
));
3331 strbuf_reset(©str
);
3334 offset
= section_name_match(&buf
[i
], old_name
);
3337 if (new_name
== NULL
) {
3341 store
.baselen
= strlen(new_name
);
3343 if (write_section(out_fd
, new_name
, &store
) < 0) {
3344 ret
= write_error(get_lock_file_path(&lock
));
3348 * We wrote out the new section, with
3349 * a newline, now skip the old
3352 output
+= offset
+ i
;
3353 if (strlen(output
) > 0) {
3355 * More content means there's
3356 * a declaration to put on the
3357 * next line; indent with a
3364 copystr
= store_create_section(new_name
, &store
);
3371 length
= strlen(output
);
3373 if (!is_section
&& copystr
.len
> 0) {
3374 strbuf_add(©str
, output
, length
);
3377 if (write_in_full(out_fd
, output
, length
) < 0) {
3378 ret
= write_error(get_lock_file_path(&lock
));
3384 * Copy a trailing section at the end of the config, won't be
3385 * flushed by the usual "flush because we have a new section
3386 * logic in the loop above.
3388 if (copystr
.len
> 0) {
3389 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3390 ret
= write_error(get_lock_file_path(&lock
));
3393 strbuf_reset(©str
);
3396 fclose(config_file
);
3399 if (commit_lock_file(&lock
) < 0)
3400 ret
= error_errno(_("could not write config file %s"),
3404 fclose(config_file
);
3405 rollback_lock_file(&lock
);
3408 config_store_data_clear(&store
);
3412 int git_config_rename_section_in_file(const char *config_filename
,
3413 const char *old_name
, const char *new_name
)
3415 return git_config_copy_or_rename_section_in_file(config_filename
,
3416 old_name
, new_name
, 0);
3419 int git_config_rename_section(const char *old_name
, const char *new_name
)
3421 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
3424 int git_config_copy_section_in_file(const char *config_filename
,
3425 const char *old_name
, const char *new_name
)
3427 return git_config_copy_or_rename_section_in_file(config_filename
,
3428 old_name
, new_name
, 1);
3431 int git_config_copy_section(const char *old_name
, const char *new_name
)
3433 return git_config_copy_section_in_file(NULL
, old_name
, new_name
);
3437 * Call this to report error for your variable that should not
3438 * get a boolean value (i.e. "[my] var" means "true").
3440 #undef config_error_nonbool
3441 int config_error_nonbool(const char *var
)
3443 return error(_("missing value for '%s'"), var
);
3446 int parse_config_key(const char *var
,
3447 const char *section
,
3448 const char **subsection
, size_t *subsection_len
,
3453 /* Does it start with "section." ? */
3454 if (!skip_prefix(var
, section
, &var
) || *var
!= '.')
3458 * Find the key; we don't know yet if we have a subsection, but we must
3459 * parse backwards from the end, since the subsection may have dots in
3462 dot
= strrchr(var
, '.');
3465 /* Did we have a subsection at all? */
3469 *subsection_len
= 0;
3475 *subsection
= var
+ 1;
3476 *subsection_len
= dot
- *subsection
;
3482 const char *current_config_origin_type(void)
3485 if (current_config_kvi
)
3486 type
= current_config_kvi
->origin_type
;
3488 type
= cf
->origin_type
;
3490 BUG("current_config_origin_type called outside config callback");
3493 case CONFIG_ORIGIN_BLOB
:
3495 case CONFIG_ORIGIN_FILE
:
3497 case CONFIG_ORIGIN_STDIN
:
3498 return "standard input";
3499 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
3500 return "submodule-blob";
3501 case CONFIG_ORIGIN_CMDLINE
:
3502 return "command line";
3504 BUG("unknown config origin type");
3508 const char *config_scope_name(enum config_scope scope
)
3511 case CONFIG_SCOPE_SYSTEM
:
3513 case CONFIG_SCOPE_GLOBAL
:
3515 case CONFIG_SCOPE_LOCAL
:
3517 case CONFIG_SCOPE_WORKTREE
:
3519 case CONFIG_SCOPE_COMMAND
:
3521 case CONFIG_SCOPE_SUBMODULE
:
3528 const char *current_config_name(void)
3531 if (current_config_kvi
)
3532 name
= current_config_kvi
->filename
;
3536 BUG("current_config_name called outside config callback");
3537 return name
? name
: "";
3540 enum config_scope
current_config_scope(void)
3542 if (current_config_kvi
)
3543 return current_config_kvi
->scope
;
3545 return current_parsing_scope
;
3548 int current_config_line(void)
3550 if (current_config_kvi
)
3551 return current_config_kvi
->linenr
;
3556 int lookup_config(const char **mapping
, int nr_mapping
, const char *var
)
3560 for (i
= 0; i
< nr_mapping
; i
++) {
3561 const char *name
= mapping
[i
];
3563 if (name
&& !strcasecmp(var
, name
))