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"
26 struct config_source
{
27 struct config_source
*prev
;
36 enum config_origin_type origin_type
;
39 enum config_error_action default_error_action
;
45 unsigned subsection_case_sensitive
: 1;
47 int (*do_fgetc
)(struct config_source
*c
);
48 int (*do_ungetc
)(int c
, struct config_source
*conf
);
49 long (*do_ftell
)(struct config_source
*c
);
53 * These variables record the "current" config source, which
54 * can be accessed by parsing callbacks.
56 * The "cf" variable will be non-NULL only when we are actually parsing a real
57 * config source (file, blob, cmdline, etc).
59 * The "current_config_kvi" variable will be non-NULL only when we are feeding
60 * cached config from a configset into a callback.
62 * They should generally never be non-NULL at the same time. If they are both
63 * NULL, then we aren't parsing anything (and depending on the function looking
64 * at the variables, it's either a bug for it to be called in the first place,
65 * or it's a function which can be reused for non-config purposes, and should
66 * fall back to some sane behavior).
68 static struct config_source
*cf
;
69 static struct key_value_info
*current_config_kvi
;
72 * Similar to the variables above, this gives access to the "scope" of the
73 * current value (repo, global, etc). For cached values, it can be found via
74 * the current_config_kvi as above. During parsing, the current value can be
75 * found in this variable. It's not part of "cf" because it transcends a single
76 * file (i.e., a file included from .git/config is still in "repo" scope).
78 static enum config_scope current_parsing_scope
;
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 struct config_include_data
{
128 const struct config_options
*opts
;
129 struct git_config_source
*config_source
;
132 * All remote URLs discovered when reading all config files.
134 struct string_list
*remote_urls
;
136 #define CONFIG_INCLUDE_INIT { 0 }
138 static int git_config_include(const char *var
, const char *value
, void *data
);
140 #define MAX_INCLUDE_DEPTH 10
141 static const char include_depth_advice
[] = N_(
142 "exceeded maximum include depth (%d) while including\n"
146 "This might be due to circular includes.");
147 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
150 struct strbuf buf
= STRBUF_INIT
;
154 return config_error_nonbool("include.path");
156 expanded
= interpolate_path(path
, 0);
158 return error(_("could not expand include path '%s'"), path
);
162 * Use an absolute path as-is, but interpret relative paths
163 * based on the including config file.
165 if (!is_absolute_path(path
)) {
168 if (!cf
|| !cf
->path
) {
169 ret
= error(_("relative config includes must come from files"));
173 slash
= find_last_dir_sep(cf
->path
);
175 strbuf_add(&buf
, cf
->path
, slash
- cf
->path
+ 1);
176 strbuf_addstr(&buf
, path
);
180 if (!access_or_die(path
, R_OK
, 0)) {
181 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
182 die(_(include_depth_advice
), MAX_INCLUDE_DEPTH
, path
,
184 cf
->name
? cf
->name
:
186 ret
= git_config_from_file(git_config_include
, path
, inc
);
190 strbuf_release(&buf
);
195 static void add_trailing_starstar_for_dir(struct strbuf
*pat
)
197 if (pat
->len
&& is_dir_sep(pat
->buf
[pat
->len
- 1]))
198 strbuf_addstr(pat
, "**");
201 static int prepare_include_condition_pattern(struct strbuf
*pat
)
203 struct strbuf path
= STRBUF_INIT
;
207 expanded
= interpolate_path(pat
->buf
, 1);
210 strbuf_addstr(pat
, expanded
);
214 if (pat
->buf
[0] == '.' && is_dir_sep(pat
->buf
[1])) {
217 if (!cf
|| !cf
->path
)
218 return error(_("relative config include "
219 "conditionals must come from files"));
221 strbuf_realpath(&path
, cf
->path
, 1);
222 slash
= find_last_dir_sep(path
.buf
);
224 BUG("how is this possible?");
225 strbuf_splice(pat
, 0, 1, path
.buf
, slash
- path
.buf
);
226 prefix
= slash
- path
.buf
+ 1 /* slash */;
227 } else if (!is_absolute_path(pat
->buf
))
228 strbuf_insertstr(pat
, 0, "**/");
230 add_trailing_starstar_for_dir(pat
);
232 strbuf_release(&path
);
236 static int include_by_gitdir(const struct config_options
*opts
,
237 const char *cond
, size_t cond_len
, int icase
)
239 struct strbuf text
= STRBUF_INIT
;
240 struct strbuf pattern
= STRBUF_INIT
;
243 int already_tried_absolute
= 0;
246 git_dir
= opts
->git_dir
;
250 strbuf_realpath(&text
, git_dir
, 1);
251 strbuf_add(&pattern
, cond
, cond_len
);
252 prefix
= prepare_include_condition_pattern(&pattern
);
260 * perform literal matching on the prefix part so that
261 * any wildcard character in it can't create side effects.
263 if (text
.len
< prefix
)
265 if (!icase
&& strncmp(pattern
.buf
, text
.buf
, prefix
))
267 if (icase
&& strncasecmp(pattern
.buf
, text
.buf
, prefix
))
271 ret
= !wildmatch(pattern
.buf
+ prefix
, text
.buf
+ prefix
,
272 WM_PATHNAME
| (icase
? WM_CASEFOLD
: 0));
274 if (!ret
&& !already_tried_absolute
) {
276 * We've tried e.g. matching gitdir:~/work, but if
277 * ~/work is a symlink to /mnt/storage/work
278 * strbuf_realpath() will expand it, so the rule won't
279 * match. Let's match against a
280 * strbuf_add_absolute_path() version of the path,
281 * which'll do the right thing
284 strbuf_add_absolute_path(&text
, git_dir
);
285 already_tried_absolute
= 1;
289 strbuf_release(&pattern
);
290 strbuf_release(&text
);
294 static int include_by_branch(const char *cond
, size_t cond_len
)
298 struct strbuf pattern
= STRBUF_INIT
;
299 const char *refname
= !the_repository
->gitdir
?
300 NULL
: resolve_ref_unsafe("HEAD", 0, NULL
, &flags
);
301 const char *shortname
;
303 if (!refname
|| !(flags
& REF_ISSYMREF
) ||
304 !skip_prefix(refname
, "refs/heads/", &shortname
))
307 strbuf_add(&pattern
, cond
, cond_len
);
308 add_trailing_starstar_for_dir(&pattern
);
309 ret
= !wildmatch(pattern
.buf
, shortname
, WM_PATHNAME
);
310 strbuf_release(&pattern
);
314 static int add_remote_url(const char *var
, const char *value
, void *data
)
316 struct string_list
*remote_urls
= data
;
317 const char *remote_name
;
318 size_t remote_name_len
;
321 if (!parse_config_key(var
, "remote", &remote_name
, &remote_name_len
,
325 string_list_append(remote_urls
, value
);
329 static void populate_remote_urls(struct config_include_data
*inc
)
331 struct config_options opts
;
333 struct config_source
*store_cf
= cf
;
334 struct key_value_info
*store_kvi
= current_config_kvi
;
335 enum config_scope store_scope
= current_parsing_scope
;
338 opts
.unconditional_remote_url
= 1;
341 current_config_kvi
= NULL
;
342 current_parsing_scope
= 0;
344 inc
->remote_urls
= xmalloc(sizeof(*inc
->remote_urls
));
345 string_list_init_dup(inc
->remote_urls
);
346 config_with_options(add_remote_url
, inc
->remote_urls
, inc
->config_source
, &opts
);
349 current_config_kvi
= store_kvi
;
350 current_parsing_scope
= store_scope
;
353 static int forbid_remote_url(const char *var
, const char *value
, void *data
)
355 const char *remote_name
;
356 size_t remote_name_len
;
359 if (!parse_config_key(var
, "remote", &remote_name
, &remote_name_len
,
363 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
367 static int at_least_one_url_matches_glob(const char *glob
, int glob_len
,
368 struct string_list
*remote_urls
)
370 struct strbuf pattern
= STRBUF_INIT
;
371 struct string_list_item
*url_item
;
374 strbuf_add(&pattern
, glob
, glob_len
);
375 for_each_string_list_item(url_item
, remote_urls
) {
376 if (!wildmatch(pattern
.buf
, url_item
->string
, WM_PATHNAME
)) {
381 strbuf_release(&pattern
);
385 static int include_by_remote_url(struct config_include_data
*inc
,
386 const char *cond
, size_t cond_len
)
388 if (inc
->opts
->unconditional_remote_url
)
390 if (!inc
->remote_urls
)
391 populate_remote_urls(inc
);
392 return at_least_one_url_matches_glob(cond
, cond_len
,
396 static int include_condition_is_true(struct config_include_data
*inc
,
397 const char *cond
, size_t cond_len
)
399 const struct config_options
*opts
= inc
->opts
;
401 if (skip_prefix_mem(cond
, cond_len
, "gitdir:", &cond
, &cond_len
))
402 return include_by_gitdir(opts
, cond
, cond_len
, 0);
403 else if (skip_prefix_mem(cond
, cond_len
, "gitdir/i:", &cond
, &cond_len
))
404 return include_by_gitdir(opts
, cond
, cond_len
, 1);
405 else if (skip_prefix_mem(cond
, cond_len
, "onbranch:", &cond
, &cond_len
))
406 return include_by_branch(cond
, cond_len
);
407 else if (skip_prefix_mem(cond
, cond_len
, "hasconfig:remote.*.url:", &cond
,
409 return include_by_remote_url(inc
, cond
, cond_len
);
411 /* unknown conditionals are always false */
415 static int git_config_include(const char *var
, const char *value
, void *data
)
417 struct config_include_data
*inc
= data
;
418 const char *cond
, *key
;
423 * Pass along all values, including "include" directives; this makes it
424 * possible to query information on the includes themselves.
426 ret
= inc
->fn(var
, value
, inc
->data
);
430 if (!strcmp(var
, "include.path"))
431 ret
= handle_path_include(value
, inc
);
433 if (!parse_config_key(var
, "includeif", &cond
, &cond_len
, &key
) &&
434 cond
&& include_condition_is_true(inc
, cond
, cond_len
) &&
435 !strcmp(key
, "path")) {
436 config_fn_t old_fn
= inc
->fn
;
438 if (inc
->opts
->unconditional_remote_url
)
439 inc
->fn
= forbid_remote_url
;
440 ret
= handle_path_include(value
, inc
);
447 static void git_config_push_split_parameter(const char *key
, const char *value
)
449 struct strbuf env
= STRBUF_INIT
;
450 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
452 strbuf_addstr(&env
, old
);
453 strbuf_addch(&env
, ' ');
455 sq_quote_buf(&env
, key
);
456 strbuf_addch(&env
, '=');
458 sq_quote_buf(&env
, value
);
459 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
460 strbuf_release(&env
);
463 void git_config_push_parameter(const char *text
)
470 * section.subsection=with=equals.key=value
472 * we cannot tell if it means:
474 * [section "subsection=with=equals"]
480 * subsection = with=equals.key=value
482 * We parse left-to-right for the first "=", meaning we'll prefer to
483 * keep the value intact over the subsection. This is historical, but
484 * also sensible since values are more likely to contain odd or
485 * untrusted input than a section name.
487 * A missing equals is explicitly allowed (as a bool-only entry).
489 value
= strchr(text
, '=');
491 char *key
= xmemdupz(text
, value
- text
);
492 git_config_push_split_parameter(key
, value
+ 1);
495 git_config_push_split_parameter(text
, NULL
);
499 void git_config_push_env(const char *spec
)
502 const char *env_name
;
503 const char *env_value
;
505 env_name
= strrchr(spec
, '=');
507 die(_("invalid config format: %s"), spec
);
508 key
= xmemdupz(spec
, env_name
- spec
);
511 die(_("missing environment variable name for configuration '%.*s'"),
512 (int)(env_name
- spec
- 1), spec
);
514 env_value
= getenv(env_name
);
516 die(_("missing environment variable '%s' for configuration '%.*s'"),
517 env_name
, (int)(env_name
- spec
- 1), spec
);
519 git_config_push_split_parameter(key
, env_value
);
523 static inline int iskeychar(int c
)
525 return isalnum(c
) || c
== '-';
529 * Auxiliary function to sanity-check and split the key into the section
530 * identifier and variable name.
532 * Returns 0 on success, -1 when there is an invalid character in the key and
533 * -2 if there is no section name in the key.
535 * store_key - pointer to char* which will hold a copy of the key with
536 * lowercase section and variable name
537 * baselen - pointer to size_t which will hold the length of the
538 * section + subsection part, can be NULL
540 int git_config_parse_key(const char *key
, char **store_key
, size_t *baselen_
)
544 const char *last_dot
= strrchr(key
, '.');
547 * Since "key" actually contains the section name and the real
548 * key name separated by a dot, we have to know where the dot is.
551 if (last_dot
== NULL
|| last_dot
== key
) {
552 error(_("key does not contain a section: %s"), key
);
553 return -CONFIG_NO_SECTION_OR_NAME
;
557 error(_("key does not contain variable name: %s"), key
);
558 return -CONFIG_NO_SECTION_OR_NAME
;
561 baselen
= last_dot
- key
;
566 * Validate the key and while at it, lower case it for matching.
568 *store_key
= xmallocz(strlen(key
));
571 for (i
= 0; key
[i
]; i
++) {
572 unsigned char c
= key
[i
];
575 /* Leave the extended basename untouched.. */
576 if (!dot
|| i
> baselen
) {
578 (i
== baselen
+ 1 && !isalpha(c
))) {
579 error(_("invalid key: %s"), key
);
583 } else if (c
== '\n') {
584 error(_("invalid key (newline): %s"), key
);
593 FREE_AND_NULL(*store_key
);
594 return -CONFIG_INVALID_KEY
;
597 static int config_parse_pair(const char *key
, const char *value
,
598 config_fn_t fn
, void *data
)
600 char *canonical_name
;
604 return error(_("empty config key"));
605 if (git_config_parse_key(key
, &canonical_name
, NULL
))
608 ret
= (fn(canonical_name
, value
, data
) < 0) ? -1 : 0;
609 free(canonical_name
);
613 int git_config_parse_parameter(const char *text
,
614 config_fn_t fn
, void *data
)
617 struct strbuf
**pair
;
620 pair
= strbuf_split_str(text
, '=', 2);
622 return error(_("bogus config parameter: %s"), text
);
624 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
625 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
626 value
= pair
[1] ? pair
[1]->buf
: "";
631 strbuf_trim(pair
[0]);
633 strbuf_list_free(pair
);
634 return error(_("bogus config parameter: %s"), text
);
637 ret
= config_parse_pair(pair
[0]->buf
, value
, fn
, data
);
638 strbuf_list_free(pair
);
642 static int parse_config_env_list(char *env
, config_fn_t fn
, void *data
)
645 while (cur
&& *cur
) {
646 const char *key
= sq_dequote_step(cur
, &cur
);
648 return error(_("bogus format in %s"),
649 CONFIG_DATA_ENVIRONMENT
);
651 if (!cur
|| isspace(*cur
)) {
652 /* old-style 'key=value' */
653 if (git_config_parse_parameter(key
, fn
, data
) < 0)
656 else if (*cur
== '=') {
657 /* new-style 'key'='value' */
663 value
= sq_dequote_step(cur
, &cur
);
664 if (!value
|| (cur
&& !isspace(*cur
))) {
665 return error(_("bogus format in %s"),
666 CONFIG_DATA_ENVIRONMENT
);
668 } else if (!*cur
|| isspace(*cur
)) {
669 /* implicit bool: 'key'= */
672 return error(_("bogus format in %s"),
673 CONFIG_DATA_ENVIRONMENT
);
676 if (config_parse_pair(key
, value
, fn
, data
) < 0)
681 return error(_("bogus format in %s"),
682 CONFIG_DATA_ENVIRONMENT
);
686 while (isspace(*cur
))
693 int git_config_from_parameters(config_fn_t fn
, void *data
)
696 struct strbuf envvar
= STRBUF_INIT
;
697 struct strvec to_free
= STRVEC_INIT
;
700 struct config_source source
;
702 memset(&source
, 0, sizeof(source
));
704 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
707 env
= getenv(CONFIG_COUNT_ENVIRONMENT
);
713 count
= strtoul(env
, &endp
, 10);
715 ret
= error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT
);
718 if (count
> INT_MAX
) {
719 ret
= error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT
);
723 for (i
= 0; i
< count
; i
++) {
724 const char *key
, *value
;
726 strbuf_addf(&envvar
, "GIT_CONFIG_KEY_%d", i
);
727 key
= getenv_safe(&to_free
, envvar
.buf
);
729 ret
= error(_("missing config key %s"), envvar
.buf
);
732 strbuf_reset(&envvar
);
734 strbuf_addf(&envvar
, "GIT_CONFIG_VALUE_%d", i
);
735 value
= getenv_safe(&to_free
, envvar
.buf
);
737 ret
= error(_("missing config value %s"), envvar
.buf
);
740 strbuf_reset(&envvar
);
742 if (config_parse_pair(key
, value
, fn
, data
) < 0) {
749 env
= getenv(CONFIG_DATA_ENVIRONMENT
);
751 /* sq_dequote will write over it */
753 if (parse_config_env_list(envw
, fn
, data
) < 0) {
760 strbuf_release(&envvar
);
761 strvec_clear(&to_free
);
767 static int get_next_char(void)
769 int c
= cf
->do_fgetc(cf
);
772 /* DOS like systems */
773 c
= cf
->do_fgetc(cf
);
776 cf
->do_ungetc(c
, cf
);
781 if (c
!= EOF
&& ++cf
->total_len
> INT_MAX
) {
783 * This is an absurdly long config file; refuse to parse
784 * further in order to protect downstream code from integer
785 * overflows. Note that we can't return an error specifically,
786 * but we can mark EOF and put trash in the return value,
787 * which will trigger a parse error.
803 static char *parse_value(void)
805 int quote
= 0, comment
= 0, space
= 0;
807 strbuf_reset(&cf
->value
);
809 int c
= get_next_char();
815 return cf
->value
.buf
;
819 if (isspace(c
) && !quote
) {
825 if (c
== ';' || c
== '#') {
830 for (; space
; space
--)
831 strbuf_addch(&cf
->value
, ' ');
846 /* Some characters escape as themselves */
849 /* Reject unknown escape sequences */
853 strbuf_addch(&cf
->value
, c
);
860 strbuf_addch(&cf
->value
, c
);
864 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
870 /* Get the full name */
877 strbuf_addch(name
, tolower(c
));
880 while (c
== ' ' || c
== '\t')
887 value
= parse_value();
892 * We already consumed the \n, but we need linenr to point to
893 * the line we just parsed during the call to fn to get
894 * accurate line number in error messages.
897 ret
= fn(name
->buf
, value
, data
);
903 static int get_extended_base_var(struct strbuf
*name
, int c
)
905 cf
->subsection_case_sensitive
= 0;
908 goto error_incomplete_line
;
910 } while (isspace(c
));
912 /* We require the format to be '[base "extension"]' */
915 strbuf_addch(name
, '.');
918 int c
= get_next_char();
920 goto error_incomplete_line
;
926 goto error_incomplete_line
;
928 strbuf_addch(name
, c
);
932 if (get_next_char() != ']')
935 error_incomplete_line
:
940 static int get_base_var(struct strbuf
*name
)
942 cf
->subsection_case_sensitive
= 1;
944 int c
= get_next_char();
950 return get_extended_base_var(name
, c
);
951 if (!iskeychar(c
) && c
!= '.')
953 strbuf_addch(name
, tolower(c
));
957 struct parse_event_data
{
958 enum config_event_t previous_type
;
959 size_t previous_offset
;
960 const struct config_options
*opts
;
963 static int do_event(enum config_event_t type
, struct parse_event_data
*data
)
967 if (!data
->opts
|| !data
->opts
->event_fn
)
970 if (type
== CONFIG_EVENT_WHITESPACE
&&
971 data
->previous_type
== type
)
974 offset
= cf
->do_ftell(cf
);
976 * At EOF, the parser always "inserts" an extra '\n', therefore
977 * the end offset of the event is the current file position, otherwise
978 * we will already have advanced to the next event.
980 if (type
!= CONFIG_EVENT_EOF
)
983 if (data
->previous_type
!= CONFIG_EVENT_EOF
&&
984 data
->opts
->event_fn(data
->previous_type
, data
->previous_offset
,
985 offset
, data
->opts
->event_fn_data
) < 0)
988 data
->previous_type
= type
;
989 data
->previous_offset
= offset
;
994 static int git_parse_source(config_fn_t fn
, void *data
,
995 const struct config_options
*opts
)
999 struct strbuf
*var
= &cf
->var
;
1000 int error_return
= 0;
1001 char *error_msg
= NULL
;
1003 /* U+FEFF Byte Order Mark in UTF8 */
1004 const char *bomptr
= utf8_bom
;
1006 /* For the parser event callback */
1007 struct parse_event_data event_data
= {
1008 CONFIG_EVENT_EOF
, 0, opts
1014 c
= get_next_char();
1015 if (bomptr
&& *bomptr
) {
1016 /* We are at the file beginning; skip UTF8-encoded BOM
1017 * if present. Sane editors won't put this in on their
1018 * own, but e.g. Windows Notepad will do it happily. */
1019 if (c
== (*bomptr
& 0377)) {
1023 /* Do not tolerate partial BOM. */
1024 if (bomptr
!= utf8_bom
)
1026 /* No BOM at file beginning. Cool. */
1032 if (do_event(CONFIG_EVENT_EOF
, &event_data
) < 0)
1036 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
1044 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
1048 if (c
== '#' || c
== ';') {
1049 if (do_event(CONFIG_EVENT_COMMENT
, &event_data
) < 0)
1055 if (do_event(CONFIG_EVENT_SECTION
, &event_data
) < 0)
1058 /* Reset prior to determining a new stem */
1060 if (get_base_var(var
) < 0 || var
->len
< 1)
1062 strbuf_addch(var
, '.');
1069 if (do_event(CONFIG_EVENT_ENTRY
, &event_data
) < 0)
1073 * Truncate the var name back to the section header
1074 * stem prior to grabbing the suffix part of the name
1077 strbuf_setlen(var
, baselen
);
1078 strbuf_addch(var
, tolower(c
));
1079 if (get_value(fn
, data
, var
) < 0)
1083 if (do_event(CONFIG_EVENT_ERROR
, &event_data
) < 0)
1086 switch (cf
->origin_type
) {
1087 case CONFIG_ORIGIN_BLOB
:
1088 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
1089 cf
->linenr
, cf
->name
);
1091 case CONFIG_ORIGIN_FILE
:
1092 error_msg
= xstrfmt(_("bad config line %d in file %s"),
1093 cf
->linenr
, cf
->name
);
1095 case CONFIG_ORIGIN_STDIN
:
1096 error_msg
= xstrfmt(_("bad config line %d in standard input"),
1099 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1100 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
1101 cf
->linenr
, cf
->name
);
1103 case CONFIG_ORIGIN_CMDLINE
:
1104 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
1105 cf
->linenr
, cf
->name
);
1108 error_msg
= xstrfmt(_("bad config line %d in %s"),
1109 cf
->linenr
, cf
->name
);
1112 switch (opts
&& opts
->error_action
?
1113 opts
->error_action
:
1114 cf
->default_error_action
) {
1115 case CONFIG_ERROR_DIE
:
1116 die("%s", error_msg
);
1118 case CONFIG_ERROR_ERROR
:
1119 error_return
= error("%s", error_msg
);
1121 case CONFIG_ERROR_SILENT
:
1124 case CONFIG_ERROR_UNSET
:
1125 BUG("config error action unset");
1129 return error_return
;
1132 static uintmax_t get_unit_factor(const char *end
)
1136 else if (!strcasecmp(end
, "k"))
1138 else if (!strcasecmp(end
, "m"))
1140 else if (!strcasecmp(end
, "g"))
1141 return 1024 * 1024 * 1024;
1145 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
1147 if (value
&& *value
) {
1154 val
= strtoimax(value
, &end
, 0);
1155 if (errno
== ERANGE
)
1157 factor
= get_unit_factor(end
);
1162 uval
= val
< 0 ? -val
: val
;
1163 if (unsigned_mult_overflows(factor
, uval
) ||
1164 factor
* uval
> max
) {
1176 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
1178 if (value
&& *value
) {
1184 val
= strtoumax(value
, &end
, 0);
1185 if (errno
== ERANGE
)
1187 factor
= get_unit_factor(end
);
1192 if (unsigned_mult_overflows(factor
, val
) ||
1193 factor
* val
> max
) {
1205 static int git_parse_int(const char *value
, int *ret
)
1208 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
1214 static int git_parse_int64(const char *value
, int64_t *ret
)
1217 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
1223 int git_parse_ulong(const char *value
, unsigned long *ret
)
1226 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
1232 int git_parse_ssize_t(const char *value
, ssize_t
*ret
)
1235 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(ssize_t
)))
1242 static void die_bad_number(const char *name
, const char *value
)
1244 const char *error_type
= (errno
== ERANGE
) ?
1245 N_("out of range") : N_("invalid unit");
1246 const char *bad_numeric
= N_("bad numeric config value '%s' for '%s': %s");
1251 if (!(cf
&& cf
->name
))
1252 die(_(bad_numeric
), value
, name
, _(error_type
));
1254 switch (cf
->origin_type
) {
1255 case CONFIG_ORIGIN_BLOB
:
1256 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1257 value
, name
, cf
->name
, _(error_type
));
1258 case CONFIG_ORIGIN_FILE
:
1259 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1260 value
, name
, cf
->name
, _(error_type
));
1261 case CONFIG_ORIGIN_STDIN
:
1262 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1263 value
, name
, _(error_type
));
1264 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1265 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1266 value
, name
, cf
->name
, _(error_type
));
1267 case CONFIG_ORIGIN_CMDLINE
:
1268 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1269 value
, name
, cf
->name
, _(error_type
));
1271 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1272 value
, name
, cf
->name
, _(error_type
));
1276 int git_config_int(const char *name
, const char *value
)
1279 if (!git_parse_int(value
, &ret
))
1280 die_bad_number(name
, value
);
1284 int64_t git_config_int64(const char *name
, const char *value
)
1287 if (!git_parse_int64(value
, &ret
))
1288 die_bad_number(name
, value
);
1292 unsigned long git_config_ulong(const char *name
, const char *value
)
1295 if (!git_parse_ulong(value
, &ret
))
1296 die_bad_number(name
, value
);
1300 ssize_t
git_config_ssize_t(const char *name
, const char *value
)
1303 if (!git_parse_ssize_t(value
, &ret
))
1304 die_bad_number(name
, value
);
1308 static int git_parse_maybe_bool_text(const char *value
)
1314 if (!strcasecmp(value
, "true")
1315 || !strcasecmp(value
, "yes")
1316 || !strcasecmp(value
, "on"))
1318 if (!strcasecmp(value
, "false")
1319 || !strcasecmp(value
, "no")
1320 || !strcasecmp(value
, "off"))
1325 int git_parse_maybe_bool(const char *value
)
1327 int v
= git_parse_maybe_bool_text(value
);
1330 if (git_parse_int(value
, &v
))
1335 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
1337 int v
= git_parse_maybe_bool_text(value
);
1343 return git_config_int(name
, value
);
1346 int git_config_bool(const char *name
, const char *value
)
1348 int v
= git_parse_maybe_bool(value
);
1350 die(_("bad boolean config value '%s' for '%s'"), value
, name
);
1354 int git_config_string(const char **dest
, const char *var
, const char *value
)
1357 return config_error_nonbool(var
);
1358 *dest
= xstrdup(value
);
1362 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
1365 return config_error_nonbool(var
);
1366 *dest
= interpolate_path(value
, 0);
1368 die(_("failed to expand user dir in: '%s'"), value
);
1372 int git_config_expiry_date(timestamp_t
*timestamp
, const char *var
, const char *value
)
1375 return config_error_nonbool(var
);
1376 if (parse_expiry_date(value
, timestamp
))
1377 return error(_("'%s' for '%s' is not a valid timestamp"),
1382 int git_config_color(char *dest
, const char *var
, const char *value
)
1385 return config_error_nonbool(var
);
1386 if (color_parse(value
, dest
) < 0)
1391 static int git_default_core_config(const char *var
, const char *value
, void *cb
)
1393 /* This needs a better name */
1394 if (!strcmp(var
, "core.filemode")) {
1395 trust_executable_bit
= git_config_bool(var
, value
);
1398 if (!strcmp(var
, "core.trustctime")) {
1399 trust_ctime
= git_config_bool(var
, value
);
1402 if (!strcmp(var
, "core.checkstat")) {
1403 if (!strcasecmp(value
, "default"))
1405 else if (!strcasecmp(value
, "minimal"))
1409 if (!strcmp(var
, "core.quotepath")) {
1410 quote_path_fully
= git_config_bool(var
, value
);
1414 if (!strcmp(var
, "core.symlinks")) {
1415 has_symlinks
= git_config_bool(var
, value
);
1419 if (!strcmp(var
, "core.ignorecase")) {
1420 ignore_case
= git_config_bool(var
, value
);
1424 if (!strcmp(var
, "core.attributesfile"))
1425 return git_config_pathname(&git_attributes_file
, var
, value
);
1427 if (!strcmp(var
, "core.hookspath"))
1428 return git_config_pathname(&git_hooks_path
, var
, value
);
1430 if (!strcmp(var
, "core.bare")) {
1431 is_bare_repository_cfg
= git_config_bool(var
, value
);
1435 if (!strcmp(var
, "core.ignorestat")) {
1436 assume_unchanged
= git_config_bool(var
, value
);
1440 if (!strcmp(var
, "core.prefersymlinkrefs")) {
1441 prefer_symlink_refs
= git_config_bool(var
, value
);
1445 if (!strcmp(var
, "core.logallrefupdates")) {
1446 if (value
&& !strcasecmp(value
, "always"))
1447 log_all_ref_updates
= LOG_REFS_ALWAYS
;
1448 else if (git_config_bool(var
, value
))
1449 log_all_ref_updates
= LOG_REFS_NORMAL
;
1451 log_all_ref_updates
= LOG_REFS_NONE
;
1455 if (!strcmp(var
, "core.warnambiguousrefs")) {
1456 warn_ambiguous_refs
= git_config_bool(var
, value
);
1460 if (!strcmp(var
, "core.abbrev")) {
1462 return config_error_nonbool(var
);
1463 if (!strcasecmp(value
, "auto"))
1464 default_abbrev
= -1;
1465 else if (!git_parse_maybe_bool_text(value
))
1466 default_abbrev
= the_hash_algo
->hexsz
;
1468 int abbrev
= git_config_int(var
, value
);
1469 if (abbrev
< minimum_abbrev
|| abbrev
> the_hash_algo
->hexsz
)
1470 return error(_("abbrev length out of range: %d"), abbrev
);
1471 default_abbrev
= abbrev
;
1476 if (!strcmp(var
, "core.disambiguate"))
1477 return set_disambiguate_hint_config(var
, value
);
1479 if (!strcmp(var
, "core.loosecompression")) {
1480 int level
= git_config_int(var
, value
);
1482 level
= Z_DEFAULT_COMPRESSION
;
1483 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1484 die(_("bad zlib compression level %d"), level
);
1485 zlib_compression_level
= level
;
1486 zlib_compression_seen
= 1;
1490 if (!strcmp(var
, "core.compression")) {
1491 int level
= git_config_int(var
, value
);
1493 level
= Z_DEFAULT_COMPRESSION
;
1494 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1495 die(_("bad zlib compression level %d"), level
);
1496 if (!zlib_compression_seen
)
1497 zlib_compression_level
= level
;
1498 if (!pack_compression_seen
)
1499 pack_compression_level
= level
;
1503 if (!strcmp(var
, "core.packedgitwindowsize")) {
1504 int pgsz_x2
= getpagesize() * 2;
1505 packed_git_window_size
= git_config_ulong(var
, value
);
1507 /* This value must be multiple of (pagesize * 2) */
1508 packed_git_window_size
/= pgsz_x2
;
1509 if (packed_git_window_size
< 1)
1510 packed_git_window_size
= 1;
1511 packed_git_window_size
*= pgsz_x2
;
1515 if (!strcmp(var
, "core.bigfilethreshold")) {
1516 big_file_threshold
= git_config_ulong(var
, value
);
1520 if (!strcmp(var
, "core.packedgitlimit")) {
1521 packed_git_limit
= git_config_ulong(var
, value
);
1525 if (!strcmp(var
, "core.deltabasecachelimit")) {
1526 delta_base_cache_limit
= git_config_ulong(var
, value
);
1530 if (!strcmp(var
, "core.autocrlf")) {
1531 if (value
&& !strcasecmp(value
, "input")) {
1532 auto_crlf
= AUTO_CRLF_INPUT
;
1535 auto_crlf
= git_config_bool(var
, value
);
1539 if (!strcmp(var
, "core.safecrlf")) {
1541 if (value
&& !strcasecmp(value
, "warn")) {
1542 global_conv_flags_eol
= CONV_EOL_RNDTRP_WARN
;
1545 eol_rndtrp_die
= git_config_bool(var
, value
);
1546 global_conv_flags_eol
= eol_rndtrp_die
?
1547 CONV_EOL_RNDTRP_DIE
: 0;
1551 if (!strcmp(var
, "core.eol")) {
1552 if (value
&& !strcasecmp(value
, "lf"))
1554 else if (value
&& !strcasecmp(value
, "crlf"))
1555 core_eol
= EOL_CRLF
;
1556 else if (value
&& !strcasecmp(value
, "native"))
1557 core_eol
= EOL_NATIVE
;
1559 core_eol
= EOL_UNSET
;
1563 if (!strcmp(var
, "core.checkroundtripencoding")) {
1564 check_roundtrip_encoding
= xstrdup(value
);
1568 if (!strcmp(var
, "core.notesref")) {
1569 notes_ref_name
= xstrdup(value
);
1573 if (!strcmp(var
, "core.editor"))
1574 return git_config_string(&editor_program
, var
, value
);
1576 if (!strcmp(var
, "core.commentchar")) {
1578 return config_error_nonbool(var
);
1579 else if (!strcasecmp(value
, "auto"))
1580 auto_comment_line_char
= 1;
1581 else if (value
[0] && !value
[1]) {
1582 comment_line_char
= value
[0];
1583 auto_comment_line_char
= 0;
1585 return error(_("core.commentChar should only be one character"));
1589 if (!strcmp(var
, "core.askpass"))
1590 return git_config_string(&askpass_program
, var
, value
);
1592 if (!strcmp(var
, "core.excludesfile"))
1593 return git_config_pathname(&excludes_file
, var
, value
);
1595 if (!strcmp(var
, "core.whitespace")) {
1597 return config_error_nonbool(var
);
1598 whitespace_rule_cfg
= parse_whitespace_rule(value
);
1602 if (!strcmp(var
, "core.fsyncobjectfiles")) {
1603 fsync_object_files
= git_config_bool(var
, value
);
1607 if (!strcmp(var
, "core.preloadindex")) {
1608 core_preload_index
= git_config_bool(var
, value
);
1612 if (!strcmp(var
, "core.createobject")) {
1613 if (!strcmp(value
, "rename"))
1614 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
1615 else if (!strcmp(value
, "link"))
1616 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
1618 die(_("invalid mode for object creation: %s"), value
);
1622 if (!strcmp(var
, "core.sparsecheckout")) {
1623 core_apply_sparse_checkout
= git_config_bool(var
, value
);
1627 if (!strcmp(var
, "core.sparsecheckoutcone")) {
1628 core_sparse_checkout_cone
= git_config_bool(var
, value
);
1632 if (!strcmp(var
, "core.precomposeunicode")) {
1633 precomposed_unicode
= git_config_bool(var
, value
);
1637 if (!strcmp(var
, "core.protecthfs")) {
1638 protect_hfs
= git_config_bool(var
, value
);
1642 if (!strcmp(var
, "core.protectntfs")) {
1643 protect_ntfs
= git_config_bool(var
, value
);
1647 if (!strcmp(var
, "core.usereplacerefs")) {
1648 read_replace_refs
= git_config_bool(var
, value
);
1652 /* Add other config variables here and to Documentation/config.txt. */
1653 return platform_core_config(var
, value
, cb
);
1656 static int git_default_i18n_config(const char *var
, const char *value
)
1658 if (!strcmp(var
, "i18n.commitencoding"))
1659 return git_config_string(&git_commit_encoding
, var
, value
);
1661 if (!strcmp(var
, "i18n.logoutputencoding"))
1662 return git_config_string(&git_log_output_encoding
, var
, value
);
1664 /* Add other config variables here and to Documentation/config.txt. */
1668 static int git_default_branch_config(const char *var
, const char *value
)
1670 if (!strcmp(var
, "branch.autosetupmerge")) {
1671 if (value
&& !strcmp(value
, "always")) {
1672 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1674 } else if (value
&& !strcmp(value
, "inherit")) {
1675 git_branch_track
= BRANCH_TRACK_INHERIT
;
1678 git_branch_track
= git_config_bool(var
, value
);
1681 if (!strcmp(var
, "branch.autosetuprebase")) {
1683 return config_error_nonbool(var
);
1684 else if (!strcmp(value
, "never"))
1685 autorebase
= AUTOREBASE_NEVER
;
1686 else if (!strcmp(value
, "local"))
1687 autorebase
= AUTOREBASE_LOCAL
;
1688 else if (!strcmp(value
, "remote"))
1689 autorebase
= AUTOREBASE_REMOTE
;
1690 else if (!strcmp(value
, "always"))
1691 autorebase
= AUTOREBASE_ALWAYS
;
1693 return error(_("malformed value for %s"), var
);
1697 /* Add other config variables here and to Documentation/config.txt. */
1701 static int git_default_push_config(const char *var
, const char *value
)
1703 if (!strcmp(var
, "push.default")) {
1705 return config_error_nonbool(var
);
1706 else if (!strcmp(value
, "nothing"))
1707 push_default
= PUSH_DEFAULT_NOTHING
;
1708 else if (!strcmp(value
, "matching"))
1709 push_default
= PUSH_DEFAULT_MATCHING
;
1710 else if (!strcmp(value
, "simple"))
1711 push_default
= PUSH_DEFAULT_SIMPLE
;
1712 else if (!strcmp(value
, "upstream"))
1713 push_default
= PUSH_DEFAULT_UPSTREAM
;
1714 else if (!strcmp(value
, "tracking")) /* deprecated */
1715 push_default
= PUSH_DEFAULT_UPSTREAM
;
1716 else if (!strcmp(value
, "current"))
1717 push_default
= PUSH_DEFAULT_CURRENT
;
1719 error(_("malformed value for %s: %s"), var
, value
);
1720 return error(_("must be one of nothing, matching, simple, "
1721 "upstream or current"));
1726 /* Add other config variables here and to Documentation/config.txt. */
1730 static int git_default_mailmap_config(const char *var
, const char *value
)
1732 if (!strcmp(var
, "mailmap.file"))
1733 return git_config_pathname(&git_mailmap_file
, var
, value
);
1734 if (!strcmp(var
, "mailmap.blob"))
1735 return git_config_string(&git_mailmap_blob
, var
, value
);
1737 /* Add other config variables here and to Documentation/config.txt. */
1741 int git_default_config(const char *var
, const char *value
, void *cb
)
1743 if (starts_with(var
, "core."))
1744 return git_default_core_config(var
, value
, cb
);
1746 if (starts_with(var
, "user.") ||
1747 starts_with(var
, "author.") ||
1748 starts_with(var
, "committer."))
1749 return git_ident_config(var
, value
, cb
);
1751 if (starts_with(var
, "i18n."))
1752 return git_default_i18n_config(var
, value
);
1754 if (starts_with(var
, "branch."))
1755 return git_default_branch_config(var
, value
);
1757 if (starts_with(var
, "push."))
1758 return git_default_push_config(var
, value
);
1760 if (starts_with(var
, "mailmap."))
1761 return git_default_mailmap_config(var
, value
);
1763 if (starts_with(var
, "advice.") || starts_with(var
, "color.advice"))
1764 return git_default_advice_config(var
, value
);
1766 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1767 pager_use_color
= git_config_bool(var
,value
);
1771 if (!strcmp(var
, "pack.packsizelimit")) {
1772 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1776 if (!strcmp(var
, "pack.compression")) {
1777 int level
= git_config_int(var
, value
);
1779 level
= Z_DEFAULT_COMPRESSION
;
1780 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1781 die(_("bad pack compression level %d"), level
);
1782 pack_compression_level
= level
;
1783 pack_compression_seen
= 1;
1787 /* Add other config variables here and to Documentation/config.txt. */
1792 * All source specific fields in the union, die_on_error, name and the callbacks
1793 * fgetc, ungetc, ftell of top need to be initialized before calling
1796 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
,
1797 const struct config_options
*opts
)
1801 /* push config-file parsing state stack */
1806 strbuf_init(&top
->value
, 1024);
1807 strbuf_init(&top
->var
, 1024);
1810 ret
= git_parse_source(fn
, data
, opts
);
1812 /* pop config-file parsing state stack */
1813 strbuf_release(&top
->value
);
1814 strbuf_release(&top
->var
);
1820 static int do_config_from_file(config_fn_t fn
,
1821 const enum config_origin_type origin_type
,
1822 const char *name
, const char *path
, FILE *f
,
1823 void *data
, const struct config_options
*opts
)
1825 struct config_source top
;
1829 top
.origin_type
= origin_type
;
1832 top
.default_error_action
= CONFIG_ERROR_DIE
;
1833 top
.do_fgetc
= config_file_fgetc
;
1834 top
.do_ungetc
= config_file_ungetc
;
1835 top
.do_ftell
= config_file_ftell
;
1838 ret
= do_config_from(&top
, fn
, data
, opts
);
1843 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1845 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
,
1849 int git_config_from_file_with_options(config_fn_t fn
, const char *filename
,
1851 const struct config_options
*opts
)
1856 f
= fopen_or_warn(filename
, "r");
1858 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
,
1859 filename
, f
, data
, opts
);
1865 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1867 return git_config_from_file_with_options(fn
, filename
, data
, NULL
);
1870 int git_config_from_mem(config_fn_t fn
,
1871 const enum config_origin_type origin_type
,
1872 const char *name
, const char *buf
, size_t len
,
1873 void *data
, const struct config_options
*opts
)
1875 struct config_source top
;
1877 top
.u
.buf
.buf
= buf
;
1878 top
.u
.buf
.len
= len
;
1880 top
.origin_type
= origin_type
;
1883 top
.default_error_action
= CONFIG_ERROR_ERROR
;
1884 top
.do_fgetc
= config_buf_fgetc
;
1885 top
.do_ungetc
= config_buf_ungetc
;
1886 top
.do_ftell
= config_buf_ftell
;
1888 return do_config_from(&top
, fn
, data
, opts
);
1891 int git_config_from_blob_oid(config_fn_t fn
,
1893 struct repository
*repo
,
1894 const struct object_id
*oid
,
1897 enum object_type type
;
1902 buf
= repo_read_object_file(repo
, oid
, &type
, &size
);
1904 return error(_("unable to load config blob object '%s'"), name
);
1905 if (type
!= OBJ_BLOB
) {
1907 return error(_("reference '%s' does not point to a blob"), name
);
1910 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
,
1917 static int git_config_from_blob_ref(config_fn_t fn
,
1918 struct repository
*repo
,
1922 struct object_id oid
;
1924 if (repo_get_oid(repo
, name
, &oid
) < 0)
1925 return error(_("unable to resolve config blob '%s'"), name
);
1926 return git_config_from_blob_oid(fn
, name
, repo
, &oid
, data
);
1929 char *git_system_config(void)
1931 char *system_config
= xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1933 system_config
= system_path(ETC_GITCONFIG
);
1934 normalize_path_copy(system_config
, system_config
);
1935 return system_config
;
1938 void git_global_config(char **user_out
, char **xdg_out
)
1940 char *user_config
= xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1941 char *xdg_config
= NULL
;
1944 user_config
= interpolate_path("~/.gitconfig", 0);
1945 xdg_config
= xdg_config_home("config");
1948 *user_out
= user_config
;
1949 *xdg_out
= xdg_config
;
1953 * Parse environment variable 'k' as a boolean (in various
1954 * possible spellings); if missing, use the default value 'def'.
1956 int git_env_bool(const char *k
, int def
)
1958 const char *v
= getenv(k
);
1959 return v
? git_config_bool(k
, v
) : def
;
1963 * Parse environment variable 'k' as ulong with possibly a unit
1964 * suffix; if missing, use the default value 'val'.
1966 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1968 const char *v
= getenv(k
);
1969 if (v
&& !git_parse_ulong(v
, &val
))
1970 die(_("failed to parse %s"), k
);
1974 int git_config_system(void)
1976 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1979 static int do_git_config_sequence(const struct config_options
*opts
,
1980 config_fn_t fn
, void *data
)
1983 char *system_config
= git_system_config();
1984 char *xdg_config
= NULL
;
1985 char *user_config
= NULL
;
1987 enum config_scope prev_parsing_scope
= current_parsing_scope
;
1989 if (opts
->commondir
)
1990 repo_config
= mkpathdup("%s/config", opts
->commondir
);
1991 else if (opts
->git_dir
)
1992 BUG("git_dir without commondir");
1996 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1997 if (git_config_system() && system_config
&&
1998 !access_or_die(system_config
, R_OK
,
1999 opts
->system_gently
? ACCESS_EACCES_OK
: 0))
2000 ret
+= git_config_from_file(fn
, system_config
, data
);
2002 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
2003 git_global_config(&user_config
, &xdg_config
);
2005 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
2006 ret
+= git_config_from_file(fn
, xdg_config
, data
);
2008 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
2009 ret
+= git_config_from_file(fn
, user_config
, data
);
2011 current_parsing_scope
= CONFIG_SCOPE_LOCAL
;
2012 if (!opts
->ignore_repo
&& repo_config
&&
2013 !access_or_die(repo_config
, R_OK
, 0))
2014 ret
+= git_config_from_file(fn
, repo_config
, data
);
2016 current_parsing_scope
= CONFIG_SCOPE_WORKTREE
;
2017 if (!opts
->ignore_worktree
&& repository_format_worktree_config
) {
2018 char *path
= git_pathdup("config.worktree");
2019 if (!access_or_die(path
, R_OK
, 0))
2020 ret
+= git_config_from_file(fn
, path
, data
);
2024 current_parsing_scope
= CONFIG_SCOPE_COMMAND
;
2025 if (!opts
->ignore_cmdline
&& git_config_from_parameters(fn
, data
) < 0)
2026 die(_("unable to parse command-line config"));
2028 current_parsing_scope
= prev_parsing_scope
;
2029 free(system_config
);
2036 int config_with_options(config_fn_t fn
, void *data
,
2037 struct git_config_source
*config_source
,
2038 const struct config_options
*opts
)
2040 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
2043 if (opts
->respect_includes
) {
2047 inc
.config_source
= config_source
;
2048 fn
= git_config_include
;
2053 current_parsing_scope
= config_source
->scope
;
2056 * If we have a specific filename, use it. Otherwise, follow the
2057 * regular lookup sequence.
2059 if (config_source
&& config_source
->use_stdin
) {
2060 ret
= git_config_from_stdin(fn
, data
);
2061 } else if (config_source
&& config_source
->file
) {
2062 ret
= git_config_from_file(fn
, config_source
->file
, data
);
2063 } else if (config_source
&& config_source
->blob
) {
2064 struct repository
*repo
= config_source
->repo
?
2065 config_source
->repo
: the_repository
;
2066 ret
= git_config_from_blob_ref(fn
, repo
, config_source
->blob
,
2069 ret
= do_git_config_sequence(opts
, fn
, data
);
2072 if (inc
.remote_urls
) {
2073 string_list_clear(inc
.remote_urls
, 0);
2074 FREE_AND_NULL(inc
.remote_urls
);
2079 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
2082 struct string_list
*values
;
2083 struct config_set_element
*entry
;
2084 struct configset_list
*list
= &cs
->list
;
2086 for (i
= 0; i
< list
->nr
; i
++) {
2087 entry
= list
->items
[i
].e
;
2088 value_index
= list
->items
[i
].value_index
;
2089 values
= &entry
->value_list
;
2091 current_config_kvi
= values
->items
[value_index
].util
;
2093 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
2094 git_die_config_linenr(entry
->key
,
2095 current_config_kvi
->filename
,
2096 current_config_kvi
->linenr
);
2098 current_config_kvi
= NULL
;
2102 void read_early_config(config_fn_t cb
, void *data
)
2104 struct config_options opts
= {0};
2105 struct strbuf commondir
= STRBUF_INIT
;
2106 struct strbuf gitdir
= STRBUF_INIT
;
2108 opts
.respect_includes
= 1;
2110 if (have_git_dir()) {
2111 opts
.commondir
= get_git_common_dir();
2112 opts
.git_dir
= get_git_dir();
2114 * When setup_git_directory() was not yet asked to discover the
2115 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2116 * is any repository config we should use (but unlike
2117 * setup_git_directory_gently(), no global state is changed, most
2118 * notably, the current working directory is still the same after the
2121 } else if (!discover_git_directory(&commondir
, &gitdir
)) {
2122 opts
.commondir
= commondir
.buf
;
2123 opts
.git_dir
= gitdir
.buf
;
2126 config_with_options(cb
, data
, NULL
, &opts
);
2128 strbuf_release(&commondir
);
2129 strbuf_release(&gitdir
);
2133 * Read config but only enumerate system and global settings.
2134 * Omit any repo-local, worktree-local, or command-line settings.
2136 void read_very_early_config(config_fn_t cb
, void *data
)
2138 struct config_options opts
= { 0 };
2140 opts
.respect_includes
= 1;
2141 opts
.ignore_repo
= 1;
2142 opts
.ignore_worktree
= 1;
2143 opts
.ignore_cmdline
= 1;
2144 opts
.system_gently
= 1;
2146 config_with_options(cb
, data
, NULL
, &opts
);
2149 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
2151 struct config_set_element k
;
2152 struct config_set_element
*found_entry
;
2153 char *normalized_key
;
2155 * `key` may come from the user, so normalize it before using it
2156 * for querying entries from the hashmap.
2158 if (git_config_parse_key(key
, &normalized_key
, NULL
))
2161 hashmap_entry_init(&k
.ent
, strhash(normalized_key
));
2162 k
.key
= normalized_key
;
2163 found_entry
= hashmap_get_entry(&cs
->config_hash
, &k
, ent
, NULL
);
2164 free(normalized_key
);
2168 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
2170 struct config_set_element
*e
;
2171 struct string_list_item
*si
;
2172 struct configset_list_item
*l_item
;
2173 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
2175 e
= configset_find_element(cs
, key
);
2177 * Since the keys are being fed by git_config*() callback mechanism, they
2178 * are already normalized. So simply add them without any further munging.
2181 e
= xmalloc(sizeof(*e
));
2182 hashmap_entry_init(&e
->ent
, strhash(key
));
2183 e
->key
= xstrdup(key
);
2184 string_list_init_dup(&e
->value_list
);
2185 hashmap_add(&cs
->config_hash
, &e
->ent
);
2187 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
2189 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
2190 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
2192 l_item
->value_index
= e
->value_list
.nr
- 1;
2195 BUG("configset_add_value has no source");
2197 kv_info
->filename
= strintern(cf
->name
);
2198 kv_info
->linenr
= cf
->linenr
;
2199 kv_info
->origin_type
= cf
->origin_type
;
2201 /* for values read from `git_config_from_parameters()` */
2202 kv_info
->filename
= NULL
;
2203 kv_info
->linenr
= -1;
2204 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
2206 kv_info
->scope
= current_parsing_scope
;
2212 static int config_set_element_cmp(const void *unused_cmp_data
,
2213 const struct hashmap_entry
*eptr
,
2214 const struct hashmap_entry
*entry_or_key
,
2215 const void *unused_keydata
)
2217 const struct config_set_element
*e1
, *e2
;
2219 e1
= container_of(eptr
, const struct config_set_element
, ent
);
2220 e2
= container_of(entry_or_key
, const struct config_set_element
, ent
);
2222 return strcmp(e1
->key
, e2
->key
);
2225 void git_configset_init(struct config_set
*cs
)
2227 hashmap_init(&cs
->config_hash
, config_set_element_cmp
, NULL
, 0);
2228 cs
->hash_initialized
= 1;
2231 cs
->list
.items
= NULL
;
2234 void git_configset_clear(struct config_set
*cs
)
2236 struct config_set_element
*entry
;
2237 struct hashmap_iter iter
;
2238 if (!cs
->hash_initialized
)
2241 hashmap_for_each_entry(&cs
->config_hash
, &iter
, entry
,
2242 ent
/* member name */) {
2244 string_list_clear(&entry
->value_list
, 1);
2246 hashmap_clear_and_free(&cs
->config_hash
, struct config_set_element
, ent
);
2247 cs
->hash_initialized
= 0;
2248 free(cs
->list
.items
);
2251 cs
->list
.items
= NULL
;
2254 static int config_set_callback(const char *key
, const char *value
, void *cb
)
2256 struct config_set
*cs
= cb
;
2257 configset_add_value(cs
, key
, value
);
2261 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
2263 return git_config_from_file(config_set_callback
, filename
, cs
);
2266 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
2268 const struct string_list
*values
= NULL
;
2270 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2271 * queried key in the files of the configset, the value returned will be the last
2272 * value in the value list for that key.
2274 values
= git_configset_get_value_multi(cs
, key
);
2278 assert(values
->nr
> 0);
2279 *value
= values
->items
[values
->nr
- 1].string
;
2283 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
2285 struct config_set_element
*e
= configset_find_element(cs
, key
);
2286 return e
? &e
->value_list
: NULL
;
2289 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
2292 if (!git_configset_get_value(cs
, key
, &value
))
2293 return git_config_string((const char **)dest
, key
, value
);
2298 static int git_configset_get_string_tmp(struct config_set
*cs
, const char *key
,
2302 if (!git_configset_get_value(cs
, key
, &value
)) {
2304 return config_error_nonbool(key
);
2312 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
2315 if (!git_configset_get_value(cs
, key
, &value
)) {
2316 *dest
= git_config_int(key
, value
);
2322 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
2325 if (!git_configset_get_value(cs
, key
, &value
)) {
2326 *dest
= git_config_ulong(key
, value
);
2332 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
2335 if (!git_configset_get_value(cs
, key
, &value
)) {
2336 *dest
= git_config_bool(key
, value
);
2342 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
2343 int *is_bool
, int *dest
)
2346 if (!git_configset_get_value(cs
, key
, &value
)) {
2347 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
2353 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
2356 if (!git_configset_get_value(cs
, key
, &value
)) {
2357 *dest
= git_parse_maybe_bool(value
);
2365 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
2368 if (!git_configset_get_value(cs
, key
, &value
))
2369 return git_config_pathname(dest
, key
, value
);
2374 /* Functions use to read configuration from a repository */
2375 static void repo_read_config(struct repository
*repo
)
2377 struct config_options opts
= { 0 };
2379 opts
.respect_includes
= 1;
2380 opts
.commondir
= repo
->commondir
;
2381 opts
.git_dir
= repo
->gitdir
;
2384 CALLOC_ARRAY(repo
->config
, 1);
2386 git_configset_clear(repo
->config
);
2388 git_configset_init(repo
->config
);
2390 if (config_with_options(config_set_callback
, repo
->config
, NULL
, &opts
) < 0)
2392 * config_with_options() normally returns only
2393 * zero, as most errors are fatal, and
2394 * non-fatal potential errors are guarded by "if"
2395 * statements that are entered only when no error is
2398 * If we ever encounter a non-fatal error, it means
2399 * something went really wrong and we should stop
2402 die(_("unknown error occurred while reading the configuration files"));
2405 static void git_config_check_init(struct repository
*repo
)
2407 if (repo
->config
&& repo
->config
->hash_initialized
)
2409 repo_read_config(repo
);
2412 static void repo_config_clear(struct repository
*repo
)
2414 if (!repo
->config
|| !repo
->config
->hash_initialized
)
2416 git_configset_clear(repo
->config
);
2419 void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
)
2421 git_config_check_init(repo
);
2422 configset_iter(repo
->config
, fn
, data
);
2425 int repo_config_get_value(struct repository
*repo
,
2426 const char *key
, const char **value
)
2428 git_config_check_init(repo
);
2429 return git_configset_get_value(repo
->config
, key
, value
);
2432 const struct string_list
*repo_config_get_value_multi(struct repository
*repo
,
2435 git_config_check_init(repo
);
2436 return git_configset_get_value_multi(repo
->config
, key
);
2439 int repo_config_get_string(struct repository
*repo
,
2440 const char *key
, char **dest
)
2443 git_config_check_init(repo
);
2444 ret
= git_configset_get_string(repo
->config
, key
, dest
);
2446 git_die_config(key
, NULL
);
2450 int repo_config_get_string_tmp(struct repository
*repo
,
2451 const char *key
, const char **dest
)
2454 git_config_check_init(repo
);
2455 ret
= git_configset_get_string_tmp(repo
->config
, key
, dest
);
2457 git_die_config(key
, NULL
);
2461 int repo_config_get_int(struct repository
*repo
,
2462 const char *key
, int *dest
)
2464 git_config_check_init(repo
);
2465 return git_configset_get_int(repo
->config
, key
, dest
);
2468 int repo_config_get_ulong(struct repository
*repo
,
2469 const char *key
, unsigned long *dest
)
2471 git_config_check_init(repo
);
2472 return git_configset_get_ulong(repo
->config
, key
, dest
);
2475 int repo_config_get_bool(struct repository
*repo
,
2476 const char *key
, int *dest
)
2478 git_config_check_init(repo
);
2479 return git_configset_get_bool(repo
->config
, key
, dest
);
2482 int repo_config_get_bool_or_int(struct repository
*repo
,
2483 const char *key
, int *is_bool
, int *dest
)
2485 git_config_check_init(repo
);
2486 return git_configset_get_bool_or_int(repo
->config
, key
, is_bool
, dest
);
2489 int repo_config_get_maybe_bool(struct repository
*repo
,
2490 const char *key
, int *dest
)
2492 git_config_check_init(repo
);
2493 return git_configset_get_maybe_bool(repo
->config
, key
, dest
);
2496 int repo_config_get_pathname(struct repository
*repo
,
2497 const char *key
, const char **dest
)
2500 git_config_check_init(repo
);
2501 ret
= git_configset_get_pathname(repo
->config
, key
, dest
);
2503 git_die_config(key
, NULL
);
2507 /* Functions used historically to read configuration from 'the_repository' */
2508 void git_config(config_fn_t fn
, void *data
)
2510 repo_config(the_repository
, fn
, data
);
2513 void git_config_clear(void)
2515 repo_config_clear(the_repository
);
2518 int git_config_get_value(const char *key
, const char **value
)
2520 return repo_config_get_value(the_repository
, key
, value
);
2523 const struct string_list
*git_config_get_value_multi(const char *key
)
2525 return repo_config_get_value_multi(the_repository
, key
);
2528 int git_config_get_string(const char *key
, char **dest
)
2530 return repo_config_get_string(the_repository
, key
, dest
);
2533 int git_config_get_string_tmp(const char *key
, const char **dest
)
2535 return repo_config_get_string_tmp(the_repository
, key
, dest
);
2538 int git_config_get_int(const char *key
, int *dest
)
2540 return repo_config_get_int(the_repository
, key
, dest
);
2543 int git_config_get_ulong(const char *key
, unsigned long *dest
)
2545 return repo_config_get_ulong(the_repository
, key
, dest
);
2548 int git_config_get_bool(const char *key
, int *dest
)
2550 return repo_config_get_bool(the_repository
, key
, dest
);
2553 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
2555 return repo_config_get_bool_or_int(the_repository
, key
, is_bool
, dest
);
2558 int git_config_get_maybe_bool(const char *key
, int *dest
)
2560 return repo_config_get_maybe_bool(the_repository
, key
, dest
);
2563 int git_config_get_pathname(const char *key
, const char **dest
)
2565 return repo_config_get_pathname(the_repository
, key
, dest
);
2568 int git_config_get_expiry(const char *key
, const char **output
)
2570 int ret
= git_config_get_string(key
, (char **)output
);
2573 if (strcmp(*output
, "now")) {
2574 timestamp_t now
= approxidate("now");
2575 if (approxidate(*output
) >= now
)
2576 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
2581 int git_config_get_expiry_in_days(const char *key
, timestamp_t
*expiry
, timestamp_t now
)
2583 const char *expiry_string
;
2587 if (git_config_get_string_tmp(key
, &expiry_string
))
2588 return 1; /* no such thing */
2590 if (git_parse_signed(expiry_string
, &days
, maximum_signed_value_of_type(int))) {
2591 const int scale
= 86400;
2592 *expiry
= now
- days
* scale
;
2596 if (!parse_expiry_date(expiry_string
, &when
)) {
2600 return -1; /* thing exists but cannot be parsed */
2603 int git_config_get_split_index(void)
2607 if (!git_config_get_maybe_bool("core.splitindex", &val
))
2610 return -1; /* default value */
2613 int git_config_get_max_percent_split_change(void)
2617 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
2618 if (0 <= val
&& val
<= 100)
2621 return error(_("splitIndex.maxPercentChange value '%d' "
2622 "should be between 0 and 100"), val
);
2625 return -1; /* default value */
2628 int git_config_get_fsmonitor(void)
2630 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor
))
2631 core_fsmonitor
= getenv("GIT_TEST_FSMONITOR");
2633 if (core_fsmonitor
&& !*core_fsmonitor
)
2634 core_fsmonitor
= NULL
;
2642 int git_config_get_index_threads(int *dest
)
2646 val
= git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2652 if (!git_config_get_bool_or_int("index.threads", &is_bool
, &val
)) {
2654 *dest
= val
? 0 : 1;
2664 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
2667 die(_("unable to parse '%s' from command-line config"), key
);
2669 die(_("bad config variable '%s' in file '%s' at line %d"),
2670 key
, filename
, linenr
);
2673 NORETURN
__attribute__((format(printf
, 2, 3)))
2674 void git_die_config(const char *key
, const char *err
, ...)
2676 const struct string_list
*values
;
2677 struct key_value_info
*kv_info
;
2678 report_fn error_fn
= get_error_routine();
2682 va_start(params
, err
);
2683 error_fn(err
, params
);
2686 values
= git_config_get_value_multi(key
);
2687 kv_info
= values
->items
[values
->nr
- 1].util
;
2688 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
2692 * Find all the stuff for git_config_set() below.
2695 struct config_store_data
{
2699 const char *fixed_value
;
2700 regex_t
*value_pattern
;
2704 enum config_event_t type
;
2705 int is_keys_section
;
2707 unsigned int parsed_nr
, parsed_alloc
, *seen
, seen_nr
, seen_alloc
;
2708 unsigned int key_seen
:1, section_seen
:1, is_keys_section
:1;
2711 static void config_store_data_clear(struct config_store_data
*store
)
2714 if (store
->value_pattern
!= NULL
&&
2715 store
->value_pattern
!= CONFIG_REGEX_NONE
) {
2716 regfree(store
->value_pattern
);
2717 free(store
->value_pattern
);
2719 free(store
->parsed
);
2721 memset(store
, 0, sizeof(*store
));
2724 static int matches(const char *key
, const char *value
,
2725 const struct config_store_data
*store
)
2727 if (strcmp(key
, store
->key
))
2728 return 0; /* not ours */
2729 if (store
->fixed_value
)
2730 return !strcmp(store
->fixed_value
, value
);
2731 if (!store
->value_pattern
)
2732 return 1; /* always matches */
2733 if (store
->value_pattern
== CONFIG_REGEX_NONE
)
2734 return 0; /* never matches */
2736 return store
->do_not_match
^
2737 (value
&& !regexec(store
->value_pattern
, value
, 0, NULL
, 0));
2740 static int store_aux_event(enum config_event_t type
,
2741 size_t begin
, size_t end
, void *data
)
2743 struct config_store_data
*store
= data
;
2745 ALLOC_GROW(store
->parsed
, store
->parsed_nr
+ 1, store
->parsed_alloc
);
2746 store
->parsed
[store
->parsed_nr
].begin
= begin
;
2747 store
->parsed
[store
->parsed_nr
].end
= end
;
2748 store
->parsed
[store
->parsed_nr
].type
= type
;
2750 if (type
== CONFIG_EVENT_SECTION
) {
2751 int (*cmpfn
)(const char *, const char *, size_t);
2753 if (cf
->var
.len
< 2 || cf
->var
.buf
[cf
->var
.len
- 1] != '.')
2754 return error(_("invalid section name '%s'"), cf
->var
.buf
);
2756 if (cf
->subsection_case_sensitive
)
2757 cmpfn
= strncasecmp
;
2761 /* Is this the section we were looking for? */
2762 store
->is_keys_section
=
2763 store
->parsed
[store
->parsed_nr
].is_keys_section
=
2764 cf
->var
.len
- 1 == store
->baselen
&&
2765 !cmpfn(cf
->var
.buf
, store
->key
, store
->baselen
);
2766 if (store
->is_keys_section
) {
2767 store
->section_seen
= 1;
2768 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2770 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2779 static int store_aux(const char *key
, const char *value
, void *cb
)
2781 struct config_store_data
*store
= cb
;
2783 if (store
->key_seen
) {
2784 if (matches(key
, value
, store
)) {
2785 if (store
->seen_nr
== 1 && store
->multi_replace
== 0) {
2786 warning(_("%s has multiple values"), key
);
2789 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2792 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2795 } else if (store
->is_keys_section
) {
2797 * Do not increment matches yet: this may not be a match, but we
2798 * are in the desired section.
2800 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1, store
->seen_alloc
);
2801 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2802 store
->section_seen
= 1;
2804 if (matches(key
, value
, store
)) {
2806 store
->key_seen
= 1;
2813 static int write_error(const char *filename
)
2815 error(_("failed to write new configuration file %s"), filename
);
2817 /* Same error code as "failed to rename". */
2821 static struct strbuf
store_create_section(const char *key
,
2822 const struct config_store_data
*store
)
2826 struct strbuf sb
= STRBUF_INIT
;
2828 dot
= memchr(key
, '.', store
->baselen
);
2830 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
2831 for (i
= dot
- key
+ 1; i
< store
->baselen
; i
++) {
2832 if (key
[i
] == '"' || key
[i
] == '\\')
2833 strbuf_addch(&sb
, '\\');
2834 strbuf_addch(&sb
, key
[i
]);
2836 strbuf_addstr(&sb
, "\"]\n");
2838 strbuf_addch(&sb
, '[');
2839 strbuf_add(&sb
, key
, store
->baselen
);
2840 strbuf_addstr(&sb
, "]\n");
2846 static ssize_t
write_section(int fd
, const char *key
,
2847 const struct config_store_data
*store
)
2849 struct strbuf sb
= store_create_section(key
, store
);
2852 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2853 strbuf_release(&sb
);
2858 static ssize_t
write_pair(int fd
, const char *key
, const char *value
,
2859 const struct config_store_data
*store
)
2863 const char *quote
= "";
2864 struct strbuf sb
= STRBUF_INIT
;
2867 * Check to see if the value needs to be surrounded with a dq pair.
2868 * Note that problematic characters are always backslash-quoted; this
2869 * check is about not losing leading or trailing SP and strings that
2870 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2871 * configuration parser.
2873 if (value
[0] == ' ')
2875 for (i
= 0; value
[i
]; i
++)
2876 if (value
[i
] == ';' || value
[i
] == '#')
2878 if (i
&& value
[i
- 1] == ' ')
2881 strbuf_addf(&sb
, "\t%s = %s", key
+ store
->baselen
+ 1, quote
);
2883 for (i
= 0; value
[i
]; i
++)
2886 strbuf_addstr(&sb
, "\\n");
2889 strbuf_addstr(&sb
, "\\t");
2893 strbuf_addch(&sb
, '\\');
2896 strbuf_addch(&sb
, value
[i
]);
2899 strbuf_addf(&sb
, "%s\n", quote
);
2901 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2902 strbuf_release(&sb
);
2908 * If we are about to unset the last key(s) in a section, and if there are
2909 * no comments surrounding (or included in) the section, we will want to
2910 * extend begin/end to remove the entire section.
2912 * Note: the parameter `seen_ptr` points to the index into the store.seen
2913 * array. * This index may be incremented if a section has more than one
2914 * entry (which all are to be removed).
2916 static void maybe_remove_section(struct config_store_data
*store
,
2917 size_t *begin_offset
, size_t *end_offset
,
2921 int i
, seen
, section_seen
= 0;
2924 * First, ensure that this is the first key, and that there are no
2925 * comments before the entry nor before the section header.
2928 for (i
= store
->seen
[seen
]; i
> 0; i
--) {
2929 enum config_event_t type
= store
->parsed
[i
- 1].type
;
2931 if (type
== CONFIG_EVENT_COMMENT
)
2932 /* There is a comment before this entry or section */
2934 if (type
== CONFIG_EVENT_ENTRY
) {
2936 /* This is not the section's first entry. */
2938 /* We encountered no comment before the section. */
2941 if (type
== CONFIG_EVENT_SECTION
) {
2942 if (!store
->parsed
[i
- 1].is_keys_section
)
2947 begin
= store
->parsed
[i
].begin
;
2950 * Next, make sure that we are removing the last key(s) in the section,
2951 * and that there are no comments that are possibly about the current
2954 for (i
= store
->seen
[seen
] + 1; i
< store
->parsed_nr
; i
++) {
2955 enum config_event_t type
= store
->parsed
[i
].type
;
2957 if (type
== CONFIG_EVENT_COMMENT
)
2959 if (type
== CONFIG_EVENT_SECTION
) {
2960 if (store
->parsed
[i
].is_keys_section
)
2964 if (type
== CONFIG_EVENT_ENTRY
) {
2965 if (++seen
< store
->seen_nr
&&
2966 i
== store
->seen
[seen
])
2967 /* We want to remove this entry, too */
2969 /* There is another entry in this section. */
2975 * We are really removing the last entry/entries from this section, and
2976 * there are no enclosed or surrounding comments. Remove the entire,
2977 * now-empty section.
2980 *begin_offset
= begin
;
2981 if (i
< store
->parsed_nr
)
2982 *end_offset
= store
->parsed
[i
].begin
;
2984 *end_offset
= store
->parsed
[store
->parsed_nr
- 1].end
;
2987 int git_config_set_in_file_gently(const char *config_filename
,
2988 const char *key
, const char *value
)
2990 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
2993 void git_config_set_in_file(const char *config_filename
,
2994 const char *key
, const char *value
)
2996 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
2999 int git_config_set_gently(const char *key
, const char *value
)
3001 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
3004 int repo_config_set_worktree_gently(struct repository
*r
,
3005 const char *key
, const char *value
)
3007 /* Only use worktree-specific config if it is is already enabled. */
3008 if (repository_format_worktree_config
) {
3009 char *file
= repo_git_path(r
, "config.worktree");
3010 int ret
= git_config_set_multivar_in_file_gently(
3011 file
, key
, value
, NULL
, 0);
3015 return repo_config_set_multivar_gently(r
, key
, value
, NULL
, 0);
3018 void git_config_set(const char *key
, const char *value
)
3020 git_config_set_multivar(key
, value
, NULL
, 0);
3022 trace2_cmd_set_config(key
, value
);
3026 * If value==NULL, unset in (remove from) config,
3027 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3028 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3029 * (only add a new one)
3030 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3031 * key/values are removed before a single new pair is written. If the
3032 * flag is not present, then replace only the first match.
3034 * Returns 0 on success.
3036 * This function does this:
3038 * - it locks the config file by creating ".git/config.lock"
3040 * - it then parses the config using store_aux() as validator to find
3041 * the position on the key/value pair to replace. If it is to be unset,
3042 * it must be found exactly once.
3044 * - the config file is mmap()ed and the part before the match (if any) is
3045 * written to the lock file, then the changed part and the rest.
3047 * - the config file is removed and the lock file rename()d to it.
3050 int git_config_set_multivar_in_file_gently(const char *config_filename
,
3051 const char *key
, const char *value
,
3052 const char *value_pattern
,
3055 int fd
= -1, in_fd
= -1;
3057 struct lock_file lock
= LOCK_INIT
;
3058 char *filename_buf
= NULL
;
3059 char *contents
= NULL
;
3061 struct config_store_data store
;
3063 memset(&store
, 0, sizeof(store
));
3065 /* parse-key returns negative; flip the sign to feed exit(3) */
3066 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
3070 store
.multi_replace
= (flags
& CONFIG_FLAGS_MULTI_REPLACE
) != 0;
3072 if (!config_filename
)
3073 config_filename
= filename_buf
= git_pathdup("config");
3076 * The lock serves a purpose in addition to locking: the new
3077 * contents of .git/config will be written into it.
3079 fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3081 error_errno(_("could not lock config file %s"), config_filename
);
3082 ret
= CONFIG_NO_LOCK
;
3087 * If .git/config does not exist yet, write a minimal version.
3089 in_fd
= open(config_filename
, O_RDONLY
);
3091 if ( ENOENT
!= errno
) {
3092 error_errno(_("opening %s"), config_filename
);
3093 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
3096 /* if nothing to unset, error out */
3097 if (value
== NULL
) {
3098 ret
= CONFIG_NOTHING_SET
;
3103 store
.key
= xstrdup(key
);
3104 if (write_section(fd
, key
, &store
) < 0 ||
3105 write_pair(fd
, key
, value
, &store
) < 0)
3109 size_t copy_begin
, copy_end
;
3110 int i
, new_line
= 0;
3111 struct config_options opts
;
3113 if (value_pattern
== NULL
)
3114 store
.value_pattern
= NULL
;
3115 else if (value_pattern
== CONFIG_REGEX_NONE
)
3116 store
.value_pattern
= CONFIG_REGEX_NONE
;
3117 else if (flags
& CONFIG_FLAGS_FIXED_VALUE
)
3118 store
.fixed_value
= value_pattern
;
3120 if (value_pattern
[0] == '!') {
3121 store
.do_not_match
= 1;
3124 store
.do_not_match
= 0;
3126 store
.value_pattern
= (regex_t
*)xmalloc(sizeof(regex_t
));
3127 if (regcomp(store
.value_pattern
, value_pattern
,
3129 error(_("invalid pattern: %s"), value_pattern
);
3130 FREE_AND_NULL(store
.value_pattern
);
3131 ret
= CONFIG_INVALID_PATTERN
;
3136 ALLOC_GROW(store
.parsed
, 1, store
.parsed_alloc
);
3137 store
.parsed
[0].end
= 0;
3139 memset(&opts
, 0, sizeof(opts
));
3140 opts
.event_fn
= store_aux_event
;
3141 opts
.event_fn_data
= &store
;
3144 * After this, store.parsed will contain offsets of all the
3145 * parsed elements, and store.seen will contain a list of
3146 * matches, as indices into store.parsed.
3148 * As a side effect, we make sure to transform only a valid
3149 * existing config file.
3151 if (git_config_from_file_with_options(store_aux
,
3154 error(_("invalid config file %s"), config_filename
);
3155 ret
= CONFIG_INVALID_FILE
;
3159 /* if nothing to unset, or too many matches, error out */
3160 if ((store
.seen_nr
== 0 && value
== NULL
) ||
3161 (store
.seen_nr
> 1 && !store
.multi_replace
)) {
3162 ret
= CONFIG_NOTHING_SET
;
3166 if (fstat(in_fd
, &st
) == -1) {
3167 error_errno(_("fstat on %s failed"), config_filename
);
3168 ret
= CONFIG_INVALID_FILE
;
3172 contents_sz
= xsize_t(st
.st_size
);
3173 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
3174 MAP_PRIVATE
, in_fd
, 0);
3175 if (contents
== MAP_FAILED
) {
3176 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
3178 error_errno(_("unable to mmap '%s'%s"),
3179 config_filename
, mmap_os_err());
3180 ret
= CONFIG_INVALID_FILE
;
3187 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3188 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock
));
3189 ret
= CONFIG_NO_WRITE
;
3193 if (store
.seen_nr
== 0) {
3194 if (!store
.seen_alloc
) {
3195 /* Did not see key nor section */
3196 ALLOC_GROW(store
.seen
, 1, store
.seen_alloc
);
3197 store
.seen
[0] = store
.parsed_nr
3198 - !!store
.parsed_nr
;
3203 for (i
= 0, copy_begin
= 0; i
< store
.seen_nr
; i
++) {
3205 int j
= store
.seen
[i
];
3208 if (!store
.key_seen
) {
3209 copy_end
= store
.parsed
[j
].end
;
3210 /* include '\n' when copying section header */
3211 if (copy_end
> 0 && copy_end
< contents_sz
&&
3212 contents
[copy_end
- 1] != '\n' &&
3213 contents
[copy_end
] == '\n')
3215 replace_end
= copy_end
;
3217 replace_end
= store
.parsed
[j
].end
;
3218 copy_end
= store
.parsed
[j
].begin
;
3220 maybe_remove_section(&store
,
3224 * Swallow preceding white-space on the same
3227 while (copy_end
> 0 ) {
3228 char c
= contents
[copy_end
- 1];
3230 if (isspace(c
) && c
!= '\n')
3237 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
3240 /* write the first part of the config */
3241 if (copy_end
> copy_begin
) {
3242 if (write_in_full(fd
, contents
+ copy_begin
,
3243 copy_end
- copy_begin
) < 0)
3246 write_str_in_full(fd
, "\n") < 0)
3249 copy_begin
= replace_end
;
3252 /* write the pair (value == NULL means unset) */
3253 if (value
!= NULL
) {
3254 if (!store
.section_seen
) {
3255 if (write_section(fd
, key
, &store
) < 0)
3258 if (write_pair(fd
, key
, value
, &store
) < 0)
3262 /* write the rest of the config */
3263 if (copy_begin
< contents_sz
)
3264 if (write_in_full(fd
, contents
+ copy_begin
,
3265 contents_sz
- copy_begin
) < 0)
3268 munmap(contents
, contents_sz
);
3272 if (commit_lock_file(&lock
) < 0) {
3273 error_errno(_("could not write config file %s"), config_filename
);
3274 ret
= CONFIG_NO_WRITE
;
3280 /* Invalidate the config cache */
3284 rollback_lock_file(&lock
);
3287 munmap(contents
, contents_sz
);
3290 config_store_data_clear(&store
);
3294 ret
= write_error(get_lock_file_path(&lock
));
3299 void git_config_set_multivar_in_file(const char *config_filename
,
3300 const char *key
, const char *value
,
3301 const char *value_pattern
, unsigned flags
)
3303 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
3304 value_pattern
, flags
))
3307 die(_("could not set '%s' to '%s'"), key
, value
);
3309 die(_("could not unset '%s'"), key
);
3312 int git_config_set_multivar_gently(const char *key
, const char *value
,
3313 const char *value_pattern
, unsigned flags
)
3315 return repo_config_set_multivar_gently(the_repository
, key
, value
,
3316 value_pattern
, flags
);
3319 int repo_config_set_multivar_gently(struct repository
*r
, const char *key
,
3321 const char *value_pattern
, unsigned flags
)
3323 char *file
= repo_git_path(r
, "config");
3324 int res
= git_config_set_multivar_in_file_gently(file
,
3332 void git_config_set_multivar(const char *key
, const char *value
,
3333 const char *value_pattern
, unsigned flags
)
3335 git_config_set_multivar_in_file(git_path("config"),
3336 key
, value
, value_pattern
,
3340 static int section_name_match (const char *buf
, const char *name
)
3342 int i
= 0, j
= 0, dot
= 0;
3345 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
3346 if (!dot
&& isspace(buf
[i
])) {
3348 if (name
[j
++] != '.')
3350 for (i
++; isspace(buf
[i
]); i
++)
3356 if (buf
[i
] == '\\' && dot
)
3358 else if (buf
[i
] == '"' && dot
) {
3359 for (i
++; isspace(buf
[i
]); i
++)
3363 if (buf
[i
] != name
[j
++])
3366 if (buf
[i
] == ']' && name
[j
] == 0) {
3368 * We match, now just find the right length offset by
3369 * gobbling up any whitespace after it, as well
3372 for (; buf
[i
] && isspace(buf
[i
]); i
++)
3379 static int section_name_is_ok(const char *name
)
3381 /* Empty section names are bogus. */
3386 * Before a dot, we must be alphanumeric or dash. After the first dot,
3387 * anything goes, so we can stop checking.
3389 for (; *name
&& *name
!= '.'; name
++)
3390 if (*name
!= '-' && !isalnum(*name
))
3395 /* if new_name == NULL, the section is removed instead */
3396 static int git_config_copy_or_rename_section_in_file(const char *config_filename
,
3397 const char *old_name
,
3398 const char *new_name
, int copy
)
3400 int ret
= 0, remove
= 0;
3401 char *filename_buf
= NULL
;
3402 struct lock_file lock
= LOCK_INIT
;
3405 FILE *config_file
= NULL
;
3407 struct strbuf copystr
= STRBUF_INIT
;
3408 struct config_store_data store
;
3410 memset(&store
, 0, sizeof(store
));
3412 if (new_name
&& !section_name_is_ok(new_name
)) {
3413 ret
= error(_("invalid section name: %s"), new_name
);
3414 goto out_no_rollback
;
3417 if (!config_filename
)
3418 config_filename
= filename_buf
= git_pathdup("config");
3420 out_fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3422 ret
= error(_("could not lock config file %s"), config_filename
);
3426 if (!(config_file
= fopen(config_filename
, "rb"))) {
3427 ret
= warn_on_fopen_errors(config_filename
);
3430 /* no config file means nothing to rename, no error */
3431 goto commit_and_out
;
3434 if (fstat(fileno(config_file
), &st
) == -1) {
3435 ret
= error_errno(_("fstat on %s failed"), config_filename
);
3439 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3440 ret
= error_errno(_("chmod on %s failed"),
3441 get_lock_file_path(&lock
));
3445 while (fgets(buf
, sizeof(buf
), config_file
)) {
3450 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
3452 if (buf
[i
] == '[') {
3453 /* it's a section */
3458 * When encountering a new section under -c we
3459 * need to flush out any section we're already
3460 * coping and begin anew. There might be
3461 * multiple [branch "$name"] sections.
3463 if (copystr
.len
> 0) {
3464 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3465 ret
= write_error(get_lock_file_path(&lock
));
3468 strbuf_reset(©str
);
3471 offset
= section_name_match(&buf
[i
], old_name
);
3474 if (new_name
== NULL
) {
3478 store
.baselen
= strlen(new_name
);
3480 if (write_section(out_fd
, new_name
, &store
) < 0) {
3481 ret
= write_error(get_lock_file_path(&lock
));
3485 * We wrote out the new section, with
3486 * a newline, now skip the old
3489 output
+= offset
+ i
;
3490 if (strlen(output
) > 0) {
3492 * More content means there's
3493 * a declaration to put on the
3494 * next line; indent with a
3501 copystr
= store_create_section(new_name
, &store
);
3508 length
= strlen(output
);
3510 if (!is_section
&& copystr
.len
> 0) {
3511 strbuf_add(©str
, output
, length
);
3514 if (write_in_full(out_fd
, output
, length
) < 0) {
3515 ret
= write_error(get_lock_file_path(&lock
));
3521 * Copy a trailing section at the end of the config, won't be
3522 * flushed by the usual "flush because we have a new section
3523 * logic in the loop above.
3525 if (copystr
.len
> 0) {
3526 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3527 ret
= write_error(get_lock_file_path(&lock
));
3530 strbuf_reset(©str
);
3533 fclose(config_file
);
3536 if (commit_lock_file(&lock
) < 0)
3537 ret
= error_errno(_("could not write config file %s"),
3541 fclose(config_file
);
3542 rollback_lock_file(&lock
);
3545 config_store_data_clear(&store
);
3549 int git_config_rename_section_in_file(const char *config_filename
,
3550 const char *old_name
, const char *new_name
)
3552 return git_config_copy_or_rename_section_in_file(config_filename
,
3553 old_name
, new_name
, 0);
3556 int git_config_rename_section(const char *old_name
, const char *new_name
)
3558 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
3561 int git_config_copy_section_in_file(const char *config_filename
,
3562 const char *old_name
, const char *new_name
)
3564 return git_config_copy_or_rename_section_in_file(config_filename
,
3565 old_name
, new_name
, 1);
3568 int git_config_copy_section(const char *old_name
, const char *new_name
)
3570 return git_config_copy_section_in_file(NULL
, old_name
, new_name
);
3574 * Call this to report error for your variable that should not
3575 * get a boolean value (i.e. "[my] var" means "true").
3577 #undef config_error_nonbool
3578 int config_error_nonbool(const char *var
)
3580 return error(_("missing value for '%s'"), var
);
3583 int parse_config_key(const char *var
,
3584 const char *section
,
3585 const char **subsection
, size_t *subsection_len
,
3590 /* Does it start with "section." ? */
3591 if (!skip_prefix(var
, section
, &var
) || *var
!= '.')
3595 * Find the key; we don't know yet if we have a subsection, but we must
3596 * parse backwards from the end, since the subsection may have dots in
3599 dot
= strrchr(var
, '.');
3602 /* Did we have a subsection at all? */
3606 *subsection_len
= 0;
3612 *subsection
= var
+ 1;
3613 *subsection_len
= dot
- *subsection
;
3619 const char *current_config_origin_type(void)
3622 if (current_config_kvi
)
3623 type
= current_config_kvi
->origin_type
;
3625 type
= cf
->origin_type
;
3627 BUG("current_config_origin_type called outside config callback");
3630 case CONFIG_ORIGIN_BLOB
:
3632 case CONFIG_ORIGIN_FILE
:
3634 case CONFIG_ORIGIN_STDIN
:
3635 return "standard input";
3636 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
3637 return "submodule-blob";
3638 case CONFIG_ORIGIN_CMDLINE
:
3639 return "command line";
3641 BUG("unknown config origin type");
3645 const char *config_scope_name(enum config_scope scope
)
3648 case CONFIG_SCOPE_SYSTEM
:
3650 case CONFIG_SCOPE_GLOBAL
:
3652 case CONFIG_SCOPE_LOCAL
:
3654 case CONFIG_SCOPE_WORKTREE
:
3656 case CONFIG_SCOPE_COMMAND
:
3658 case CONFIG_SCOPE_SUBMODULE
:
3665 const char *current_config_name(void)
3668 if (current_config_kvi
)
3669 name
= current_config_kvi
->filename
;
3673 BUG("current_config_name called outside config callback");
3674 return name
? name
: "";
3677 enum config_scope
current_config_scope(void)
3679 if (current_config_kvi
)
3680 return current_config_kvi
->scope
;
3682 return current_parsing_scope
;
3685 int current_config_line(void)
3687 if (current_config_kvi
)
3688 return current_config_kvi
->linenr
;
3693 int lookup_config(const char **mapping
, int nr_mapping
, const char *var
)
3697 for (i
= 0; i
< nr_mapping
; i
++) {
3698 const char *name
= mapping
[i
];
3700 if (name
&& !strcasecmp(var
, name
))