2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
8 #include "git-compat-util.h"
16 #include "environment.h"
19 #include "repository.h"
26 #include "string-list.h"
27 #include "object-name.h"
28 #include "object-store-ll.h"
34 #include "replace-object.h"
39 #include "wildmatch.h"
43 #include "write-or-die.h"
45 struct config_source
{
46 struct config_source
*prev
;
55 enum config_origin_type origin_type
;
58 enum config_error_action default_error_action
;
64 unsigned subsection_case_sensitive
: 1;
66 int (*do_fgetc
)(struct config_source
*c
);
67 int (*do_ungetc
)(int c
, struct config_source
*conf
);
68 long (*do_ftell
)(struct config_source
*c
);
70 #define CONFIG_SOURCE_INIT { 0 }
72 struct config_reader
{
74 * These members record the "current" config source, which can be
75 * accessed by parsing callbacks.
77 * The "source" variable will be non-NULL only when we are actually
78 * parsing a real config source (file, blob, cmdline, etc).
80 * The "config_kvi" variable will be non-NULL only when we are feeding
81 * cached config from a configset into a callback.
83 * They cannot be non-NULL at the same time. If they are both NULL, then
84 * we aren't parsing anything (and depending on the function looking at
85 * the variables, it's either a bug for it to be called in the first
86 * place, or it's a function which can be reused for non-config
87 * purposes, and should fall back to some sane behavior).
89 struct config_source
*source
;
90 struct key_value_info
*config_kvi
;
92 * The "scope" of the current config source being parsed (repo, global,
93 * etc). Like "source", this is only set when parsing a config source.
94 * It's not part of "source" because it transcends a single file (i.e.,
95 * a file included from .git/config is still in "repo" scope).
97 * When iterating through a configset, the equivalent value is
98 * "config_kvi.scope" (see above).
100 enum config_scope parsing_scope
;
103 * Where possible, prefer to accept "struct config_reader" as an arg than to use
104 * "the_reader". "the_reader" should only be used if that is infeasible, e.g. in
107 static struct config_reader the_reader
;
109 static inline void config_reader_push_source(struct config_reader
*reader
,
110 struct config_source
*top
)
112 top
->prev
= reader
->source
;
113 reader
->source
= top
;
116 static inline struct config_source
*config_reader_pop_source(struct config_reader
*reader
)
118 struct config_source
*ret
;
120 BUG("tried to pop config source, but we weren't reading config");
121 ret
= reader
->source
;
122 reader
->source
= reader
->source
->prev
;
126 static inline void config_reader_set_kvi(struct config_reader
*reader
,
127 struct key_value_info
*kvi
)
129 reader
->config_kvi
= kvi
;
132 static inline void config_reader_set_scope(struct config_reader
*reader
,
133 enum config_scope scope
)
135 reader
->parsing_scope
= scope
;
138 static int pack_compression_seen
;
139 static int zlib_compression_seen
;
142 * Config that comes from trusted scopes, namely:
143 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
144 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
145 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
147 * This is declared here for code cleanliness, but unlike the other
148 * static variables, this does not hold config parser state.
150 static struct config_set protected_config
;
152 static int config_file_fgetc(struct config_source
*conf
)
154 return getc_unlocked(conf
->u
.file
);
157 static int config_file_ungetc(int c
, struct config_source
*conf
)
159 return ungetc(c
, conf
->u
.file
);
162 static long config_file_ftell(struct config_source
*conf
)
164 return ftell(conf
->u
.file
);
168 static int config_buf_fgetc(struct config_source
*conf
)
170 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
171 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
176 static int config_buf_ungetc(int c
, struct config_source
*conf
)
178 if (conf
->u
.buf
.pos
> 0) {
180 if (conf
->u
.buf
.buf
[conf
->u
.buf
.pos
] != c
)
181 BUG("config_buf can only ungetc the same character");
188 static long config_buf_ftell(struct config_source
*conf
)
190 return conf
->u
.buf
.pos
;
193 struct config_include_data
{
197 const struct config_options
*opts
;
198 struct git_config_source
*config_source
;
199 struct repository
*repo
;
200 struct config_reader
*config_reader
;
203 * All remote URLs discovered when reading all config files.
205 struct string_list
*remote_urls
;
207 #define CONFIG_INCLUDE_INIT { 0 }
209 static int git_config_include(const char *var
, const char *value
, void *data
);
211 #define MAX_INCLUDE_DEPTH 10
212 static const char include_depth_advice
[] = N_(
213 "exceeded maximum include depth (%d) while including\n"
217 "This might be due to circular includes.");
218 static int handle_path_include(struct config_source
*cs
, const char *path
,
219 struct config_include_data
*inc
)
222 struct strbuf buf
= STRBUF_INIT
;
226 return config_error_nonbool("include.path");
228 expanded
= interpolate_path(path
, 0);
230 return error(_("could not expand include path '%s'"), path
);
234 * Use an absolute path as-is, but interpret relative paths
235 * based on the including config file.
237 if (!is_absolute_path(path
)) {
240 if (!cs
|| !cs
->path
) {
241 ret
= error(_("relative config includes must come from files"));
245 slash
= find_last_dir_sep(cs
->path
);
247 strbuf_add(&buf
, cs
->path
, slash
- cs
->path
+ 1);
248 strbuf_addstr(&buf
, path
);
252 if (!access_or_die(path
, R_OK
, 0)) {
253 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
254 die(_(include_depth_advice
), MAX_INCLUDE_DEPTH
, path
,
256 cs
->name
? cs
->name
:
258 ret
= git_config_from_file(git_config_include
, path
, inc
);
262 strbuf_release(&buf
);
267 static void add_trailing_starstar_for_dir(struct strbuf
*pat
)
269 if (pat
->len
&& is_dir_sep(pat
->buf
[pat
->len
- 1]))
270 strbuf_addstr(pat
, "**");
273 static int prepare_include_condition_pattern(struct config_source
*cs
,
276 struct strbuf path
= STRBUF_INIT
;
280 expanded
= interpolate_path(pat
->buf
, 1);
283 strbuf_addstr(pat
, expanded
);
287 if (pat
->buf
[0] == '.' && is_dir_sep(pat
->buf
[1])) {
290 if (!cs
|| !cs
->path
)
291 return error(_("relative config include "
292 "conditionals must come from files"));
294 strbuf_realpath(&path
, cs
->path
, 1);
295 slash
= find_last_dir_sep(path
.buf
);
297 BUG("how is this possible?");
298 strbuf_splice(pat
, 0, 1, path
.buf
, slash
- path
.buf
);
299 prefix
= slash
- path
.buf
+ 1 /* slash */;
300 } else if (!is_absolute_path(pat
->buf
))
301 strbuf_insertstr(pat
, 0, "**/");
303 add_trailing_starstar_for_dir(pat
);
305 strbuf_release(&path
);
309 static int include_by_gitdir(struct config_source
*cs
,
310 const struct config_options
*opts
,
311 const char *cond
, size_t cond_len
, int icase
)
313 struct strbuf text
= STRBUF_INIT
;
314 struct strbuf pattern
= STRBUF_INIT
;
317 int already_tried_absolute
= 0;
320 git_dir
= opts
->git_dir
;
324 strbuf_realpath(&text
, git_dir
, 1);
325 strbuf_add(&pattern
, cond
, cond_len
);
326 prefix
= prepare_include_condition_pattern(cs
, &pattern
);
334 * perform literal matching on the prefix part so that
335 * any wildcard character in it can't create side effects.
337 if (text
.len
< prefix
)
339 if (!icase
&& strncmp(pattern
.buf
, text
.buf
, prefix
))
341 if (icase
&& strncasecmp(pattern
.buf
, text
.buf
, prefix
))
345 ret
= !wildmatch(pattern
.buf
+ prefix
, text
.buf
+ prefix
,
346 WM_PATHNAME
| (icase
? WM_CASEFOLD
: 0));
348 if (!ret
&& !already_tried_absolute
) {
350 * We've tried e.g. matching gitdir:~/work, but if
351 * ~/work is a symlink to /mnt/storage/work
352 * strbuf_realpath() will expand it, so the rule won't
353 * match. Let's match against a
354 * strbuf_add_absolute_path() version of the path,
355 * which'll do the right thing
358 strbuf_add_absolute_path(&text
, git_dir
);
359 already_tried_absolute
= 1;
363 strbuf_release(&pattern
);
364 strbuf_release(&text
);
368 static int include_by_branch(const char *cond
, size_t cond_len
)
372 struct strbuf pattern
= STRBUF_INIT
;
373 const char *refname
= !the_repository
->gitdir
?
374 NULL
: resolve_ref_unsafe("HEAD", 0, NULL
, &flags
);
375 const char *shortname
;
377 if (!refname
|| !(flags
& REF_ISSYMREF
) ||
378 !skip_prefix(refname
, "refs/heads/", &shortname
))
381 strbuf_add(&pattern
, cond
, cond_len
);
382 add_trailing_starstar_for_dir(&pattern
);
383 ret
= !wildmatch(pattern
.buf
, shortname
, WM_PATHNAME
);
384 strbuf_release(&pattern
);
388 static int add_remote_url(const char *var
, const char *value
, void *data
)
390 struct string_list
*remote_urls
= data
;
391 const char *remote_name
;
392 size_t remote_name_len
;
395 if (!parse_config_key(var
, "remote", &remote_name
, &remote_name_len
,
399 string_list_append(remote_urls
, value
);
403 static void populate_remote_urls(struct config_include_data
*inc
)
405 struct config_options opts
;
407 enum config_scope store_scope
= inc
->config_reader
->parsing_scope
;
410 opts
.unconditional_remote_url
= 1;
412 config_reader_set_scope(inc
->config_reader
, 0);
414 inc
->remote_urls
= xmalloc(sizeof(*inc
->remote_urls
));
415 string_list_init_dup(inc
->remote_urls
);
416 config_with_options(add_remote_url
, inc
->remote_urls
,
417 inc
->config_source
, inc
->repo
, &opts
);
419 config_reader_set_scope(inc
->config_reader
, store_scope
);
422 static int forbid_remote_url(const char *var
, const char *value UNUSED
,
425 const char *remote_name
;
426 size_t remote_name_len
;
429 if (!parse_config_key(var
, "remote", &remote_name
, &remote_name_len
,
433 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
437 static int at_least_one_url_matches_glob(const char *glob
, int glob_len
,
438 struct string_list
*remote_urls
)
440 struct strbuf pattern
= STRBUF_INIT
;
441 struct string_list_item
*url_item
;
444 strbuf_add(&pattern
, glob
, glob_len
);
445 for_each_string_list_item(url_item
, remote_urls
) {
446 if (!wildmatch(pattern
.buf
, url_item
->string
, WM_PATHNAME
)) {
451 strbuf_release(&pattern
);
455 static int include_by_remote_url(struct config_include_data
*inc
,
456 const char *cond
, size_t cond_len
)
458 if (inc
->opts
->unconditional_remote_url
)
460 if (!inc
->remote_urls
)
461 populate_remote_urls(inc
);
462 return at_least_one_url_matches_glob(cond
, cond_len
,
466 static int include_condition_is_true(struct config_source
*cs
,
467 struct config_include_data
*inc
,
468 const char *cond
, size_t cond_len
)
470 const struct config_options
*opts
= inc
->opts
;
472 if (skip_prefix_mem(cond
, cond_len
, "gitdir:", &cond
, &cond_len
))
473 return include_by_gitdir(cs
, opts
, cond
, cond_len
, 0);
474 else if (skip_prefix_mem(cond
, cond_len
, "gitdir/i:", &cond
, &cond_len
))
475 return include_by_gitdir(cs
, opts
, cond
, cond_len
, 1);
476 else if (skip_prefix_mem(cond
, cond_len
, "onbranch:", &cond
, &cond_len
))
477 return include_by_branch(cond
, cond_len
);
478 else if (skip_prefix_mem(cond
, cond_len
, "hasconfig:remote.*.url:", &cond
,
480 return include_by_remote_url(inc
, cond
, cond_len
);
482 /* unknown conditionals are always false */
486 static int git_config_include(const char *var
, const char *value
, void *data
)
488 struct config_include_data
*inc
= data
;
489 struct config_source
*cs
= inc
->config_reader
->source
;
490 const char *cond
, *key
;
495 * Pass along all values, including "include" directives; this makes it
496 * possible to query information on the includes themselves.
498 ret
= inc
->fn(var
, value
, inc
->data
);
502 if (!strcmp(var
, "include.path"))
503 ret
= handle_path_include(cs
, value
, inc
);
505 if (!parse_config_key(var
, "includeif", &cond
, &cond_len
, &key
) &&
506 cond
&& include_condition_is_true(cs
, inc
, cond
, cond_len
) &&
507 !strcmp(key
, "path")) {
508 config_fn_t old_fn
= inc
->fn
;
510 if (inc
->opts
->unconditional_remote_url
)
511 inc
->fn
= forbid_remote_url
;
512 ret
= handle_path_include(cs
, value
, inc
);
519 static void git_config_push_split_parameter(const char *key
, const char *value
)
521 struct strbuf env
= STRBUF_INIT
;
522 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
524 strbuf_addstr(&env
, old
);
525 strbuf_addch(&env
, ' ');
527 sq_quote_buf(&env
, key
);
528 strbuf_addch(&env
, '=');
530 sq_quote_buf(&env
, value
);
531 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
532 strbuf_release(&env
);
535 void git_config_push_parameter(const char *text
)
542 * section.subsection=with=equals.key=value
544 * we cannot tell if it means:
546 * [section "subsection=with=equals"]
552 * subsection = with=equals.key=value
554 * We parse left-to-right for the first "=", meaning we'll prefer to
555 * keep the value intact over the subsection. This is historical, but
556 * also sensible since values are more likely to contain odd or
557 * untrusted input than a section name.
559 * A missing equals is explicitly allowed (as a bool-only entry).
561 value
= strchr(text
, '=');
563 char *key
= xmemdupz(text
, value
- text
);
564 git_config_push_split_parameter(key
, value
+ 1);
567 git_config_push_split_parameter(text
, NULL
);
571 void git_config_push_env(const char *spec
)
574 const char *env_name
;
575 const char *env_value
;
577 env_name
= strrchr(spec
, '=');
579 die(_("invalid config format: %s"), spec
);
580 key
= xmemdupz(spec
, env_name
- spec
);
583 die(_("missing environment variable name for configuration '%.*s'"),
584 (int)(env_name
- spec
- 1), spec
);
586 env_value
= getenv(env_name
);
588 die(_("missing environment variable '%s' for configuration '%.*s'"),
589 env_name
, (int)(env_name
- spec
- 1), spec
);
591 git_config_push_split_parameter(key
, env_value
);
595 static inline int iskeychar(int c
)
597 return isalnum(c
) || c
== '-';
601 * Auxiliary function to sanity-check and split the key into the section
602 * identifier and variable name.
604 * Returns 0 on success, -1 when there is an invalid character in the key and
605 * -2 if there is no section name in the key.
607 * store_key - pointer to char* which will hold a copy of the key with
608 * lowercase section and variable name
609 * baselen - pointer to size_t which will hold the length of the
610 * section + subsection part, can be NULL
612 int git_config_parse_key(const char *key
, char **store_key
, size_t *baselen_
)
616 const char *last_dot
= strrchr(key
, '.');
619 * Since "key" actually contains the section name and the real
620 * key name separated by a dot, we have to know where the dot is.
623 if (last_dot
== NULL
|| last_dot
== key
) {
624 error(_("key does not contain a section: %s"), key
);
625 return -CONFIG_NO_SECTION_OR_NAME
;
629 error(_("key does not contain variable name: %s"), key
);
630 return -CONFIG_NO_SECTION_OR_NAME
;
633 baselen
= last_dot
- key
;
638 * Validate the key and while at it, lower case it for matching.
640 *store_key
= xmallocz(strlen(key
));
643 for (i
= 0; key
[i
]; i
++) {
644 unsigned char c
= key
[i
];
647 /* Leave the extended basename untouched.. */
648 if (!dot
|| i
> baselen
) {
650 (i
== baselen
+ 1 && !isalpha(c
))) {
651 error(_("invalid key: %s"), key
);
655 } else if (c
== '\n') {
656 error(_("invalid key (newline): %s"), key
);
665 FREE_AND_NULL(*store_key
);
666 return -CONFIG_INVALID_KEY
;
669 static int config_parse_pair(const char *key
, const char *value
,
670 config_fn_t fn
, void *data
)
672 char *canonical_name
;
676 return error(_("empty config key"));
677 if (git_config_parse_key(key
, &canonical_name
, NULL
))
680 ret
= (fn(canonical_name
, value
, data
) < 0) ? -1 : 0;
681 free(canonical_name
);
685 int git_config_parse_parameter(const char *text
,
686 config_fn_t fn
, void *data
)
689 struct strbuf
**pair
;
692 pair
= strbuf_split_str(text
, '=', 2);
694 return error(_("bogus config parameter: %s"), text
);
696 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
697 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
698 value
= pair
[1] ? pair
[1]->buf
: "";
703 strbuf_trim(pair
[0]);
705 strbuf_list_free(pair
);
706 return error(_("bogus config parameter: %s"), text
);
709 ret
= config_parse_pair(pair
[0]->buf
, value
, fn
, data
);
710 strbuf_list_free(pair
);
714 static int parse_config_env_list(char *env
, config_fn_t fn
, void *data
)
717 while (cur
&& *cur
) {
718 const char *key
= sq_dequote_step(cur
, &cur
);
720 return error(_("bogus format in %s"),
721 CONFIG_DATA_ENVIRONMENT
);
723 if (!cur
|| isspace(*cur
)) {
724 /* old-style 'key=value' */
725 if (git_config_parse_parameter(key
, fn
, data
) < 0)
728 else if (*cur
== '=') {
729 /* new-style 'key'='value' */
735 value
= sq_dequote_step(cur
, &cur
);
736 if (!value
|| (cur
&& !isspace(*cur
))) {
737 return error(_("bogus format in %s"),
738 CONFIG_DATA_ENVIRONMENT
);
740 } else if (!*cur
|| isspace(*cur
)) {
741 /* implicit bool: 'key'= */
744 return error(_("bogus format in %s"),
745 CONFIG_DATA_ENVIRONMENT
);
748 if (config_parse_pair(key
, value
, fn
, data
) < 0)
753 return error(_("bogus format in %s"),
754 CONFIG_DATA_ENVIRONMENT
);
758 while (isspace(*cur
))
765 int git_config_from_parameters(config_fn_t fn
, void *data
)
768 struct strbuf envvar
= STRBUF_INIT
;
769 struct strvec to_free
= STRVEC_INIT
;
772 struct config_source source
= CONFIG_SOURCE_INIT
;
774 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
775 config_reader_push_source(&the_reader
, &source
);
777 env
= getenv(CONFIG_COUNT_ENVIRONMENT
);
783 count
= strtoul(env
, &endp
, 10);
785 ret
= error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT
);
788 if (count
> INT_MAX
) {
789 ret
= error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT
);
793 for (i
= 0; i
< count
; i
++) {
794 const char *key
, *value
;
796 strbuf_addf(&envvar
, "GIT_CONFIG_KEY_%d", i
);
797 key
= getenv_safe(&to_free
, envvar
.buf
);
799 ret
= error(_("missing config key %s"), envvar
.buf
);
802 strbuf_reset(&envvar
);
804 strbuf_addf(&envvar
, "GIT_CONFIG_VALUE_%d", i
);
805 value
= getenv_safe(&to_free
, envvar
.buf
);
807 ret
= error(_("missing config value %s"), envvar
.buf
);
810 strbuf_reset(&envvar
);
812 if (config_parse_pair(key
, value
, fn
, data
) < 0) {
819 env
= getenv(CONFIG_DATA_ENVIRONMENT
);
821 /* sq_dequote will write over it */
823 if (parse_config_env_list(envw
, fn
, data
) < 0) {
830 strbuf_release(&envvar
);
831 strvec_clear(&to_free
);
833 config_reader_pop_source(&the_reader
);
837 static int get_next_char(struct config_source
*cs
)
839 int c
= cs
->do_fgetc(cs
);
842 /* DOS like systems */
843 c
= cs
->do_fgetc(cs
);
846 cs
->do_ungetc(c
, cs
);
851 if (c
!= EOF
&& ++cs
->total_len
> INT_MAX
) {
853 * This is an absurdly long config file; refuse to parse
854 * further in order to protect downstream code from integer
855 * overflows. Note that we can't return an error specifically,
856 * but we can mark EOF and put trash in the return value,
857 * which will trigger a parse error.
873 static char *parse_value(struct config_source
*cs
)
875 int quote
= 0, comment
= 0, space
= 0;
877 strbuf_reset(&cs
->value
);
879 int c
= get_next_char(cs
);
885 return cs
->value
.buf
;
889 if (isspace(c
) && !quote
) {
895 if (c
== ';' || c
== '#') {
900 for (; space
; space
--)
901 strbuf_addch(&cs
->value
, ' ');
903 c
= get_next_char(cs
);
916 /* Some characters escape as themselves */
919 /* Reject unknown escape sequences */
923 strbuf_addch(&cs
->value
, c
);
930 strbuf_addch(&cs
->value
, c
);
934 static int get_value(struct config_source
*cs
, config_fn_t fn
, void *data
,
941 /* Get the full name */
943 c
= get_next_char(cs
);
948 strbuf_addch(name
, tolower(c
));
951 while (c
== ' ' || c
== '\t')
952 c
= get_next_char(cs
);
958 value
= parse_value(cs
);
963 * We already consumed the \n, but we need linenr to point to
964 * the line we just parsed during the call to fn to get
965 * accurate line number in error messages.
968 ret
= fn(name
->buf
, value
, data
);
974 static int get_extended_base_var(struct config_source
*cs
, struct strbuf
*name
,
977 cs
->subsection_case_sensitive
= 0;
980 goto error_incomplete_line
;
981 c
= get_next_char(cs
);
982 } while (isspace(c
));
984 /* We require the format to be '[base "extension"]' */
987 strbuf_addch(name
, '.');
990 int c
= get_next_char(cs
);
992 goto error_incomplete_line
;
996 c
= get_next_char(cs
);
998 goto error_incomplete_line
;
1000 strbuf_addch(name
, c
);
1004 if (get_next_char(cs
) != ']')
1007 error_incomplete_line
:
1012 static int get_base_var(struct config_source
*cs
, struct strbuf
*name
)
1014 cs
->subsection_case_sensitive
= 1;
1016 int c
= get_next_char(cs
);
1022 return get_extended_base_var(cs
, name
, c
);
1023 if (!iskeychar(c
) && c
!= '.')
1025 strbuf_addch(name
, tolower(c
));
1029 struct parse_event_data
{
1030 enum config_event_t previous_type
;
1031 size_t previous_offset
;
1032 const struct config_options
*opts
;
1035 static int do_event(struct config_source
*cs
, enum config_event_t type
,
1036 struct parse_event_data
*data
)
1040 if (!data
->opts
|| !data
->opts
->event_fn
)
1043 if (type
== CONFIG_EVENT_WHITESPACE
&&
1044 data
->previous_type
== type
)
1047 offset
= cs
->do_ftell(cs
);
1049 * At EOF, the parser always "inserts" an extra '\n', therefore
1050 * the end offset of the event is the current file position, otherwise
1051 * we will already have advanced to the next event.
1053 if (type
!= CONFIG_EVENT_EOF
)
1056 if (data
->previous_type
!= CONFIG_EVENT_EOF
&&
1057 data
->opts
->event_fn(data
->previous_type
, data
->previous_offset
,
1058 offset
, data
->opts
->event_fn_data
) < 0)
1061 data
->previous_type
= type
;
1062 data
->previous_offset
= offset
;
1067 static int git_parse_source(struct config_source
*cs
, config_fn_t fn
,
1068 void *data
, const struct config_options
*opts
)
1072 struct strbuf
*var
= &cs
->var
;
1073 int error_return
= 0;
1074 char *error_msg
= NULL
;
1076 /* U+FEFF Byte Order Mark in UTF8 */
1077 const char *bomptr
= utf8_bom
;
1079 /* For the parser event callback */
1080 struct parse_event_data event_data
= {
1081 CONFIG_EVENT_EOF
, 0, opts
1087 c
= get_next_char(cs
);
1088 if (bomptr
&& *bomptr
) {
1089 /* We are at the file beginning; skip UTF8-encoded BOM
1090 * if present. Sane editors won't put this in on their
1091 * own, but e.g. Windows Notepad will do it happily. */
1092 if (c
== (*bomptr
& 0377)) {
1096 /* Do not tolerate partial BOM. */
1097 if (bomptr
!= utf8_bom
)
1099 /* No BOM at file beginning. Cool. */
1105 if (do_event(cs
, CONFIG_EVENT_EOF
, &event_data
) < 0)
1109 if (do_event(cs
, CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
1117 if (do_event(cs
, CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
1121 if (c
== '#' || c
== ';') {
1122 if (do_event(cs
, CONFIG_EVENT_COMMENT
, &event_data
) < 0)
1128 if (do_event(cs
, CONFIG_EVENT_SECTION
, &event_data
) < 0)
1131 /* Reset prior to determining a new stem */
1133 if (get_base_var(cs
, var
) < 0 || var
->len
< 1)
1135 strbuf_addch(var
, '.');
1142 if (do_event(cs
, CONFIG_EVENT_ENTRY
, &event_data
) < 0)
1146 * Truncate the var name back to the section header
1147 * stem prior to grabbing the suffix part of the name
1150 strbuf_setlen(var
, baselen
);
1151 strbuf_addch(var
, tolower(c
));
1152 if (get_value(cs
, fn
, data
, var
) < 0)
1156 if (do_event(cs
, CONFIG_EVENT_ERROR
, &event_data
) < 0)
1159 switch (cs
->origin_type
) {
1160 case CONFIG_ORIGIN_BLOB
:
1161 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
1162 cs
->linenr
, cs
->name
);
1164 case CONFIG_ORIGIN_FILE
:
1165 error_msg
= xstrfmt(_("bad config line %d in file %s"),
1166 cs
->linenr
, cs
->name
);
1168 case CONFIG_ORIGIN_STDIN
:
1169 error_msg
= xstrfmt(_("bad config line %d in standard input"),
1172 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1173 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
1174 cs
->linenr
, cs
->name
);
1176 case CONFIG_ORIGIN_CMDLINE
:
1177 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
1178 cs
->linenr
, cs
->name
);
1181 error_msg
= xstrfmt(_("bad config line %d in %s"),
1182 cs
->linenr
, cs
->name
);
1185 switch (opts
&& opts
->error_action
?
1186 opts
->error_action
:
1187 cs
->default_error_action
) {
1188 case CONFIG_ERROR_DIE
:
1189 die("%s", error_msg
);
1191 case CONFIG_ERROR_ERROR
:
1192 error_return
= error("%s", error_msg
);
1194 case CONFIG_ERROR_SILENT
:
1197 case CONFIG_ERROR_UNSET
:
1198 BUG("config error action unset");
1202 return error_return
;
1205 static uintmax_t get_unit_factor(const char *end
)
1209 else if (!strcasecmp(end
, "k"))
1211 else if (!strcasecmp(end
, "m"))
1213 else if (!strcasecmp(end
, "g"))
1214 return 1024 * 1024 * 1024;
1218 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
1220 if (value
&& *value
) {
1226 BUG("max must be a positive integer");
1229 val
= strtoimax(value
, &end
, 0);
1230 if (errno
== ERANGE
)
1236 factor
= get_unit_factor(end
);
1241 if ((val
< 0 && -max
/ factor
> val
) ||
1242 (val
> 0 && max
/ factor
< val
)) {
1254 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
1256 if (value
&& *value
) {
1261 /* negative values would be accepted by strtoumax */
1262 if (strchr(value
, '-')) {
1267 val
= strtoumax(value
, &end
, 0);
1268 if (errno
== ERANGE
)
1274 factor
= get_unit_factor(end
);
1279 if (unsigned_mult_overflows(factor
, val
) ||
1280 factor
* val
> max
) {
1292 int git_parse_int(const char *value
, int *ret
)
1295 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
1301 static int git_parse_int64(const char *value
, int64_t *ret
)
1304 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
1310 int git_parse_ulong(const char *value
, unsigned long *ret
)
1313 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
1319 int git_parse_ssize_t(const char *value
, ssize_t
*ret
)
1322 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(ssize_t
)))
1328 static int reader_config_name(struct config_reader
*reader
, const char **out
);
1329 static int reader_origin_type(struct config_reader
*reader
,
1330 enum config_origin_type
*type
);
1332 static void die_bad_number(struct config_reader
*reader
, const char *name
,
1335 const char *error_type
= (errno
== ERANGE
) ?
1336 N_("out of range") : N_("invalid unit");
1337 const char *bad_numeric
= N_("bad numeric config value '%s' for '%s': %s");
1338 const char *config_name
= NULL
;
1339 enum config_origin_type config_origin
= CONFIG_ORIGIN_UNKNOWN
;
1344 /* Ignoring the return value is okay since we handle missing values. */
1345 reader_config_name(reader
, &config_name
);
1346 reader_origin_type(reader
, &config_origin
);
1349 die(_(bad_numeric
), value
, name
, _(error_type
));
1351 switch (config_origin
) {
1352 case CONFIG_ORIGIN_BLOB
:
1353 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1354 value
, name
, config_name
, _(error_type
));
1355 case CONFIG_ORIGIN_FILE
:
1356 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1357 value
, name
, config_name
, _(error_type
));
1358 case CONFIG_ORIGIN_STDIN
:
1359 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1360 value
, name
, _(error_type
));
1361 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1362 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1363 value
, name
, config_name
, _(error_type
));
1364 case CONFIG_ORIGIN_CMDLINE
:
1365 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1366 value
, name
, config_name
, _(error_type
));
1368 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1369 value
, name
, config_name
, _(error_type
));
1373 int git_config_int(const char *name
, const char *value
)
1376 if (!git_parse_int(value
, &ret
))
1377 die_bad_number(&the_reader
, name
, value
);
1381 int64_t git_config_int64(const char *name
, const char *value
)
1384 if (!git_parse_int64(value
, &ret
))
1385 die_bad_number(&the_reader
, name
, value
);
1389 unsigned long git_config_ulong(const char *name
, const char *value
)
1392 if (!git_parse_ulong(value
, &ret
))
1393 die_bad_number(&the_reader
, name
, value
);
1397 ssize_t
git_config_ssize_t(const char *name
, const char *value
)
1400 if (!git_parse_ssize_t(value
, &ret
))
1401 die_bad_number(&the_reader
, name
, value
);
1405 static int git_parse_maybe_bool_text(const char *value
)
1411 if (!strcasecmp(value
, "true")
1412 || !strcasecmp(value
, "yes")
1413 || !strcasecmp(value
, "on"))
1415 if (!strcasecmp(value
, "false")
1416 || !strcasecmp(value
, "no")
1417 || !strcasecmp(value
, "off"))
1422 static const struct fsync_component_name
{
1424 enum fsync_component component_bits
;
1425 } fsync_component_names
[] = {
1426 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT
},
1427 { "pack", FSYNC_COMPONENT_PACK
},
1428 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA
},
1429 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH
},
1430 { "index", FSYNC_COMPONENT_INDEX
},
1431 { "objects", FSYNC_COMPONENTS_OBJECTS
},
1432 { "reference", FSYNC_COMPONENT_REFERENCE
},
1433 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA
},
1434 { "committed", FSYNC_COMPONENTS_COMMITTED
},
1435 { "added", FSYNC_COMPONENTS_ADDED
},
1436 { "all", FSYNC_COMPONENTS_ALL
},
1439 static enum fsync_component
parse_fsync_components(const char *var
, const char *string
)
1441 enum fsync_component current
= FSYNC_COMPONENTS_PLATFORM_DEFAULT
;
1442 enum fsync_component positive
= 0, negative
= 0;
1451 string
= string
+ strspn(string
, ", \t\n\r");
1452 ep
= strchrnul(string
, ',');
1454 if (!strcmp(string
, "none")) {
1455 current
= FSYNC_COMPONENT_NONE
;
1459 if (*string
== '-') {
1464 warning(_("invalid value for variable %s"), var
);
1470 for (i
= 0; i
< ARRAY_SIZE(fsync_component_names
); ++i
) {
1471 const struct fsync_component_name
*n
= &fsync_component_names
[i
];
1473 if (strncmp(n
->name
, string
, len
))
1478 negative
|= n
->component_bits
;
1480 positive
|= n
->component_bits
;
1484 char *component
= xstrndup(string
, len
);
1485 warning(_("ignoring unknown core.fsync component '%s'"), component
);
1493 return (current
& ~negative
) | positive
;
1496 int git_parse_maybe_bool(const char *value
)
1498 int v
= git_parse_maybe_bool_text(value
);
1501 if (git_parse_int(value
, &v
))
1506 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
1508 int v
= git_parse_maybe_bool_text(value
);
1514 return git_config_int(name
, value
);
1517 int git_config_bool(const char *name
, const char *value
)
1519 int v
= git_parse_maybe_bool(value
);
1521 die(_("bad boolean config value '%s' for '%s'"), value
, name
);
1525 int git_config_string(const char **dest
, const char *var
, const char *value
)
1528 return config_error_nonbool(var
);
1529 *dest
= xstrdup(value
);
1533 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
1536 return config_error_nonbool(var
);
1537 *dest
= interpolate_path(value
, 0);
1539 die(_("failed to expand user dir in: '%s'"), value
);
1543 int git_config_expiry_date(timestamp_t
*timestamp
, const char *var
, const char *value
)
1546 return config_error_nonbool(var
);
1547 if (parse_expiry_date(value
, timestamp
))
1548 return error(_("'%s' for '%s' is not a valid timestamp"),
1553 int git_config_color(char *dest
, const char *var
, const char *value
)
1556 return config_error_nonbool(var
);
1557 if (color_parse(value
, dest
) < 0)
1562 static int git_default_core_config(const char *var
, const char *value
, void *cb
)
1564 /* This needs a better name */
1565 if (!strcmp(var
, "core.filemode")) {
1566 trust_executable_bit
= git_config_bool(var
, value
);
1569 if (!strcmp(var
, "core.trustctime")) {
1570 trust_ctime
= git_config_bool(var
, value
);
1573 if (!strcmp(var
, "core.checkstat")) {
1574 if (!strcasecmp(value
, "default"))
1576 else if (!strcasecmp(value
, "minimal"))
1580 if (!strcmp(var
, "core.quotepath")) {
1581 quote_path_fully
= git_config_bool(var
, value
);
1585 if (!strcmp(var
, "core.symlinks")) {
1586 has_symlinks
= git_config_bool(var
, value
);
1590 if (!strcmp(var
, "core.ignorecase")) {
1591 ignore_case
= git_config_bool(var
, value
);
1595 if (!strcmp(var
, "core.attributesfile"))
1596 return git_config_pathname(&git_attributes_file
, var
, value
);
1598 if (!strcmp(var
, "core.hookspath"))
1599 return git_config_pathname(&git_hooks_path
, var
, value
);
1601 if (!strcmp(var
, "core.bare")) {
1602 is_bare_repository_cfg
= git_config_bool(var
, value
);
1606 if (!strcmp(var
, "core.ignorestat")) {
1607 assume_unchanged
= git_config_bool(var
, value
);
1611 if (!strcmp(var
, "core.prefersymlinkrefs")) {
1612 prefer_symlink_refs
= git_config_bool(var
, value
);
1616 if (!strcmp(var
, "core.logallrefupdates")) {
1617 if (value
&& !strcasecmp(value
, "always"))
1618 log_all_ref_updates
= LOG_REFS_ALWAYS
;
1619 else if (git_config_bool(var
, value
))
1620 log_all_ref_updates
= LOG_REFS_NORMAL
;
1622 log_all_ref_updates
= LOG_REFS_NONE
;
1626 if (!strcmp(var
, "core.warnambiguousrefs")) {
1627 warn_ambiguous_refs
= git_config_bool(var
, value
);
1631 if (!strcmp(var
, "core.abbrev")) {
1633 return config_error_nonbool(var
);
1634 if (!strcasecmp(value
, "auto"))
1635 default_abbrev
= -1;
1636 else if (!git_parse_maybe_bool_text(value
))
1637 default_abbrev
= the_hash_algo
->hexsz
;
1639 int abbrev
= git_config_int(var
, value
);
1640 if (abbrev
< minimum_abbrev
|| abbrev
> the_hash_algo
->hexsz
)
1641 return error(_("abbrev length out of range: %d"), abbrev
);
1642 default_abbrev
= abbrev
;
1647 if (!strcmp(var
, "core.disambiguate"))
1648 return set_disambiguate_hint_config(var
, value
);
1650 if (!strcmp(var
, "core.loosecompression")) {
1651 int level
= git_config_int(var
, value
);
1653 level
= Z_DEFAULT_COMPRESSION
;
1654 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1655 die(_("bad zlib compression level %d"), level
);
1656 zlib_compression_level
= level
;
1657 zlib_compression_seen
= 1;
1661 if (!strcmp(var
, "core.compression")) {
1662 int level
= git_config_int(var
, value
);
1664 level
= Z_DEFAULT_COMPRESSION
;
1665 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1666 die(_("bad zlib compression level %d"), level
);
1667 if (!zlib_compression_seen
)
1668 zlib_compression_level
= level
;
1669 if (!pack_compression_seen
)
1670 pack_compression_level
= level
;
1674 if (!strcmp(var
, "core.packedgitwindowsize")) {
1675 int pgsz_x2
= getpagesize() * 2;
1676 packed_git_window_size
= git_config_ulong(var
, value
);
1678 /* This value must be multiple of (pagesize * 2) */
1679 packed_git_window_size
/= pgsz_x2
;
1680 if (packed_git_window_size
< 1)
1681 packed_git_window_size
= 1;
1682 packed_git_window_size
*= pgsz_x2
;
1686 if (!strcmp(var
, "core.bigfilethreshold")) {
1687 big_file_threshold
= git_config_ulong(var
, value
);
1691 if (!strcmp(var
, "core.packedgitlimit")) {
1692 packed_git_limit
= git_config_ulong(var
, value
);
1696 if (!strcmp(var
, "core.deltabasecachelimit")) {
1697 delta_base_cache_limit
= git_config_ulong(var
, value
);
1701 if (!strcmp(var
, "core.autocrlf")) {
1702 if (value
&& !strcasecmp(value
, "input")) {
1703 auto_crlf
= AUTO_CRLF_INPUT
;
1706 auto_crlf
= git_config_bool(var
, value
);
1710 if (!strcmp(var
, "core.safecrlf")) {
1712 if (value
&& !strcasecmp(value
, "warn")) {
1713 global_conv_flags_eol
= CONV_EOL_RNDTRP_WARN
;
1716 eol_rndtrp_die
= git_config_bool(var
, value
);
1717 global_conv_flags_eol
= eol_rndtrp_die
?
1718 CONV_EOL_RNDTRP_DIE
: 0;
1722 if (!strcmp(var
, "core.eol")) {
1723 if (value
&& !strcasecmp(value
, "lf"))
1725 else if (value
&& !strcasecmp(value
, "crlf"))
1726 core_eol
= EOL_CRLF
;
1727 else if (value
&& !strcasecmp(value
, "native"))
1728 core_eol
= EOL_NATIVE
;
1730 core_eol
= EOL_UNSET
;
1734 if (!strcmp(var
, "core.checkroundtripencoding")) {
1735 check_roundtrip_encoding
= xstrdup(value
);
1739 if (!strcmp(var
, "core.notesref")) {
1740 notes_ref_name
= xstrdup(value
);
1744 if (!strcmp(var
, "core.editor"))
1745 return git_config_string(&editor_program
, var
, value
);
1747 if (!strcmp(var
, "core.commentchar")) {
1749 return config_error_nonbool(var
);
1750 else if (!strcasecmp(value
, "auto"))
1751 auto_comment_line_char
= 1;
1752 else if (value
[0] && !value
[1]) {
1753 comment_line_char
= value
[0];
1754 auto_comment_line_char
= 0;
1756 return error(_("core.commentChar should only be one ASCII character"));
1760 if (!strcmp(var
, "core.askpass"))
1761 return git_config_string(&askpass_program
, var
, value
);
1763 if (!strcmp(var
, "core.excludesfile"))
1764 return git_config_pathname(&excludes_file
, var
, value
);
1766 if (!strcmp(var
, "core.whitespace")) {
1768 return config_error_nonbool(var
);
1769 whitespace_rule_cfg
= parse_whitespace_rule(value
);
1773 if (!strcmp(var
, "core.fsync")) {
1775 return config_error_nonbool(var
);
1776 fsync_components
= parse_fsync_components(var
, value
);
1780 if (!strcmp(var
, "core.fsyncmethod")) {
1782 return config_error_nonbool(var
);
1783 if (!strcmp(value
, "fsync"))
1784 fsync_method
= FSYNC_METHOD_FSYNC
;
1785 else if (!strcmp(value
, "writeout-only"))
1786 fsync_method
= FSYNC_METHOD_WRITEOUT_ONLY
;
1787 else if (!strcmp(value
, "batch"))
1788 fsync_method
= FSYNC_METHOD_BATCH
;
1790 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value
);
1794 if (!strcmp(var
, "core.fsyncobjectfiles")) {
1795 if (fsync_object_files
< 0)
1796 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1797 fsync_object_files
= git_config_bool(var
, value
);
1801 if (!strcmp(var
, "core.preloadindex")) {
1802 core_preload_index
= git_config_bool(var
, value
);
1806 if (!strcmp(var
, "core.createobject")) {
1807 if (!strcmp(value
, "rename"))
1808 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
1809 else if (!strcmp(value
, "link"))
1810 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
1812 die(_("invalid mode for object creation: %s"), value
);
1816 if (!strcmp(var
, "core.sparsecheckout")) {
1817 core_apply_sparse_checkout
= git_config_bool(var
, value
);
1821 if (!strcmp(var
, "core.sparsecheckoutcone")) {
1822 core_sparse_checkout_cone
= git_config_bool(var
, value
);
1826 if (!strcmp(var
, "core.precomposeunicode")) {
1827 precomposed_unicode
= git_config_bool(var
, value
);
1831 if (!strcmp(var
, "core.protecthfs")) {
1832 protect_hfs
= git_config_bool(var
, value
);
1836 if (!strcmp(var
, "core.protectntfs")) {
1837 protect_ntfs
= git_config_bool(var
, value
);
1841 /* Add other config variables here and to Documentation/config.txt. */
1842 return platform_core_config(var
, value
, cb
);
1845 static int git_default_sparse_config(const char *var
, const char *value
)
1847 if (!strcmp(var
, "sparse.expectfilesoutsideofpatterns")) {
1848 sparse_expect_files_outside_of_patterns
= git_config_bool(var
, value
);
1852 /* Add other config variables here and to Documentation/config/sparse.txt. */
1856 static int git_default_i18n_config(const char *var
, const char *value
)
1858 if (!strcmp(var
, "i18n.commitencoding"))
1859 return git_config_string(&git_commit_encoding
, var
, value
);
1861 if (!strcmp(var
, "i18n.logoutputencoding"))
1862 return git_config_string(&git_log_output_encoding
, var
, value
);
1864 /* Add other config variables here and to Documentation/config.txt. */
1868 static int git_default_branch_config(const char *var
, const char *value
)
1870 if (!strcmp(var
, "branch.autosetupmerge")) {
1871 if (value
&& !strcmp(value
, "always")) {
1872 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1874 } else if (value
&& !strcmp(value
, "inherit")) {
1875 git_branch_track
= BRANCH_TRACK_INHERIT
;
1877 } else if (value
&& !strcmp(value
, "simple")) {
1878 git_branch_track
= BRANCH_TRACK_SIMPLE
;
1881 git_branch_track
= git_config_bool(var
, value
);
1884 if (!strcmp(var
, "branch.autosetuprebase")) {
1886 return config_error_nonbool(var
);
1887 else if (!strcmp(value
, "never"))
1888 autorebase
= AUTOREBASE_NEVER
;
1889 else if (!strcmp(value
, "local"))
1890 autorebase
= AUTOREBASE_LOCAL
;
1891 else if (!strcmp(value
, "remote"))
1892 autorebase
= AUTOREBASE_REMOTE
;
1893 else if (!strcmp(value
, "always"))
1894 autorebase
= AUTOREBASE_ALWAYS
;
1896 return error(_("malformed value for %s"), var
);
1900 /* Add other config variables here and to Documentation/config.txt. */
1904 static int git_default_push_config(const char *var
, const char *value
)
1906 if (!strcmp(var
, "push.default")) {
1908 return config_error_nonbool(var
);
1909 else if (!strcmp(value
, "nothing"))
1910 push_default
= PUSH_DEFAULT_NOTHING
;
1911 else if (!strcmp(value
, "matching"))
1912 push_default
= PUSH_DEFAULT_MATCHING
;
1913 else if (!strcmp(value
, "simple"))
1914 push_default
= PUSH_DEFAULT_SIMPLE
;
1915 else if (!strcmp(value
, "upstream"))
1916 push_default
= PUSH_DEFAULT_UPSTREAM
;
1917 else if (!strcmp(value
, "tracking")) /* deprecated */
1918 push_default
= PUSH_DEFAULT_UPSTREAM
;
1919 else if (!strcmp(value
, "current"))
1920 push_default
= PUSH_DEFAULT_CURRENT
;
1922 error(_("malformed value for %s: %s"), var
, value
);
1923 return error(_("must be one of nothing, matching, simple, "
1924 "upstream or current"));
1929 /* Add other config variables here and to Documentation/config.txt. */
1933 static int git_default_mailmap_config(const char *var
, const char *value
)
1935 if (!strcmp(var
, "mailmap.file"))
1936 return git_config_pathname(&git_mailmap_file
, var
, value
);
1937 if (!strcmp(var
, "mailmap.blob"))
1938 return git_config_string(&git_mailmap_blob
, var
, value
);
1940 /* Add other config variables here and to Documentation/config.txt. */
1944 int git_default_config(const char *var
, const char *value
, void *cb
)
1946 if (starts_with(var
, "core."))
1947 return git_default_core_config(var
, value
, cb
);
1949 if (starts_with(var
, "user.") ||
1950 starts_with(var
, "author.") ||
1951 starts_with(var
, "committer."))
1952 return git_ident_config(var
, value
, cb
);
1954 if (starts_with(var
, "i18n."))
1955 return git_default_i18n_config(var
, value
);
1957 if (starts_with(var
, "branch."))
1958 return git_default_branch_config(var
, value
);
1960 if (starts_with(var
, "push."))
1961 return git_default_push_config(var
, value
);
1963 if (starts_with(var
, "mailmap."))
1964 return git_default_mailmap_config(var
, value
);
1966 if (starts_with(var
, "advice.") || starts_with(var
, "color.advice"))
1967 return git_default_advice_config(var
, value
);
1969 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1970 pager_use_color
= git_config_bool(var
,value
);
1974 if (!strcmp(var
, "pack.packsizelimit")) {
1975 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1979 if (!strcmp(var
, "pack.compression")) {
1980 int level
= git_config_int(var
, value
);
1982 level
= Z_DEFAULT_COMPRESSION
;
1983 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1984 die(_("bad pack compression level %d"), level
);
1985 pack_compression_level
= level
;
1986 pack_compression_seen
= 1;
1990 if (starts_with(var
, "sparse."))
1991 return git_default_sparse_config(var
, value
);
1993 /* Add other config variables here and to Documentation/config.txt. */
1998 * All source specific fields in the union, die_on_error, name and the callbacks
1999 * fgetc, ungetc, ftell of top need to be initialized before calling
2002 static int do_config_from(struct config_reader
*reader
,
2003 struct config_source
*top
, config_fn_t fn
, void *data
,
2004 const struct config_options
*opts
)
2008 /* push config-file parsing state stack */
2012 strbuf_init(&top
->value
, 1024);
2013 strbuf_init(&top
->var
, 1024);
2014 config_reader_push_source(reader
, top
);
2016 ret
= git_parse_source(top
, fn
, data
, opts
);
2018 /* pop config-file parsing state stack */
2019 strbuf_release(&top
->value
);
2020 strbuf_release(&top
->var
);
2021 config_reader_pop_source(reader
);
2026 static int do_config_from_file(struct config_reader
*reader
,
2028 const enum config_origin_type origin_type
,
2029 const char *name
, const char *path
, FILE *f
,
2030 void *data
, const struct config_options
*opts
)
2032 struct config_source top
= CONFIG_SOURCE_INIT
;
2036 top
.origin_type
= origin_type
;
2039 top
.default_error_action
= CONFIG_ERROR_DIE
;
2040 top
.do_fgetc
= config_file_fgetc
;
2041 top
.do_ungetc
= config_file_ungetc
;
2042 top
.do_ftell
= config_file_ftell
;
2045 ret
= do_config_from(reader
, &top
, fn
, data
, opts
);
2050 static int git_config_from_stdin(config_fn_t fn
, void *data
)
2052 return do_config_from_file(&the_reader
, fn
, CONFIG_ORIGIN_STDIN
, "",
2053 NULL
, stdin
, data
, NULL
);
2056 int git_config_from_file_with_options(config_fn_t fn
, const char *filename
,
2058 const struct config_options
*opts
)
2064 BUG("filename cannot be NULL");
2065 f
= fopen_or_warn(filename
, "r");
2067 ret
= do_config_from_file(&the_reader
, fn
, CONFIG_ORIGIN_FILE
,
2068 filename
, filename
, f
, data
, opts
);
2074 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
2076 return git_config_from_file_with_options(fn
, filename
, data
, NULL
);
2079 int git_config_from_mem(config_fn_t fn
,
2080 const enum config_origin_type origin_type
,
2081 const char *name
, const char *buf
, size_t len
,
2082 void *data
, const struct config_options
*opts
)
2084 struct config_source top
= CONFIG_SOURCE_INIT
;
2086 top
.u
.buf
.buf
= buf
;
2087 top
.u
.buf
.len
= len
;
2089 top
.origin_type
= origin_type
;
2092 top
.default_error_action
= CONFIG_ERROR_ERROR
;
2093 top
.do_fgetc
= config_buf_fgetc
;
2094 top
.do_ungetc
= config_buf_ungetc
;
2095 top
.do_ftell
= config_buf_ftell
;
2097 return do_config_from(&the_reader
, &top
, fn
, data
, opts
);
2100 int git_config_from_blob_oid(config_fn_t fn
,
2102 struct repository
*repo
,
2103 const struct object_id
*oid
,
2106 enum object_type type
;
2111 buf
= repo_read_object_file(repo
, oid
, &type
, &size
);
2113 return error(_("unable to load config blob object '%s'"), name
);
2114 if (type
!= OBJ_BLOB
) {
2116 return error(_("reference '%s' does not point to a blob"), name
);
2119 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
,
2126 static int git_config_from_blob_ref(config_fn_t fn
,
2127 struct repository
*repo
,
2131 struct object_id oid
;
2133 if (repo_get_oid(repo
, name
, &oid
) < 0)
2134 return error(_("unable to resolve config blob '%s'"), name
);
2135 return git_config_from_blob_oid(fn
, name
, repo
, &oid
, data
);
2138 char *git_system_config(void)
2140 char *system_config
= xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2142 system_config
= system_path(ETC_GITCONFIG
);
2143 normalize_path_copy(system_config
, system_config
);
2144 return system_config
;
2147 void git_global_config(char **user_out
, char **xdg_out
)
2149 char *user_config
= xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2150 char *xdg_config
= NULL
;
2153 user_config
= interpolate_path("~/.gitconfig", 0);
2154 xdg_config
= xdg_config_home("config");
2157 *user_out
= user_config
;
2158 *xdg_out
= xdg_config
;
2162 * Parse environment variable 'k' as a boolean (in various
2163 * possible spellings); if missing, use the default value 'def'.
2165 int git_env_bool(const char *k
, int def
)
2167 const char *v
= getenv(k
);
2168 return v
? git_config_bool(k
, v
) : def
;
2172 * Parse environment variable 'k' as ulong with possibly a unit
2173 * suffix; if missing, use the default value 'val'.
2175 unsigned long git_env_ulong(const char *k
, unsigned long val
)
2177 const char *v
= getenv(k
);
2178 if (v
&& !git_parse_ulong(v
, &val
))
2179 die(_("failed to parse %s"), k
);
2183 int git_config_system(void)
2185 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2188 static int do_git_config_sequence(struct config_reader
*reader
,
2189 const struct config_options
*opts
,
2190 const struct repository
*repo
,
2191 config_fn_t fn
, void *data
)
2194 char *system_config
= git_system_config();
2195 char *xdg_config
= NULL
;
2196 char *user_config
= NULL
;
2198 char *worktree_config
;
2199 enum config_scope prev_parsing_scope
= reader
->parsing_scope
;
2202 * Ensure that either:
2203 * - the git_dir and commondir are both set, or
2204 * - the git_dir and commondir are both NULL
2206 if (!opts
->git_dir
!= !opts
->commondir
)
2207 BUG("only one of commondir and git_dir is non-NULL");
2209 if (opts
->commondir
) {
2210 repo_config
= mkpathdup("%s/config", opts
->commondir
);
2211 worktree_config
= mkpathdup("%s/config.worktree", opts
->git_dir
);
2214 worktree_config
= NULL
;
2217 config_reader_set_scope(reader
, CONFIG_SCOPE_SYSTEM
);
2218 if (git_config_system() && system_config
&&
2219 !access_or_die(system_config
, R_OK
,
2220 opts
->system_gently
? ACCESS_EACCES_OK
: 0))
2221 ret
+= git_config_from_file(fn
, system_config
, data
);
2223 config_reader_set_scope(reader
, CONFIG_SCOPE_GLOBAL
);
2224 git_global_config(&user_config
, &xdg_config
);
2226 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
2227 ret
+= git_config_from_file(fn
, xdg_config
, data
);
2229 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
2230 ret
+= git_config_from_file(fn
, user_config
, data
);
2232 config_reader_set_scope(reader
, CONFIG_SCOPE_LOCAL
);
2233 if (!opts
->ignore_repo
&& repo_config
&&
2234 !access_or_die(repo_config
, R_OK
, 0))
2235 ret
+= git_config_from_file(fn
, repo_config
, data
);
2237 config_reader_set_scope(reader
, CONFIG_SCOPE_WORKTREE
);
2238 if (!opts
->ignore_worktree
&& worktree_config
&&
2239 repo
&& repo
->repository_format_worktree_config
&&
2240 !access_or_die(worktree_config
, R_OK
, 0)) {
2241 ret
+= git_config_from_file(fn
, worktree_config
, data
);
2244 config_reader_set_scope(reader
, CONFIG_SCOPE_COMMAND
);
2245 if (!opts
->ignore_cmdline
&& git_config_from_parameters(fn
, data
) < 0)
2246 die(_("unable to parse command-line config"));
2248 config_reader_set_scope(reader
, prev_parsing_scope
);
2249 free(system_config
);
2253 free(worktree_config
);
2257 int config_with_options(config_fn_t fn
, void *data
,
2258 struct git_config_source
*config_source
,
2259 struct repository
*repo
,
2260 const struct config_options
*opts
)
2262 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
2263 enum config_scope prev_scope
= the_reader
.parsing_scope
;
2266 if (opts
->respect_includes
) {
2271 inc
.config_source
= config_source
;
2272 inc
.config_reader
= &the_reader
;
2273 fn
= git_config_include
;
2278 config_reader_set_scope(&the_reader
, config_source
->scope
);
2281 * If we have a specific filename, use it. Otherwise, follow the
2282 * regular lookup sequence.
2284 if (config_source
&& config_source
->use_stdin
) {
2285 ret
= git_config_from_stdin(fn
, data
);
2286 } else if (config_source
&& config_source
->file
) {
2287 ret
= git_config_from_file(fn
, config_source
->file
, data
);
2288 } else if (config_source
&& config_source
->blob
) {
2289 ret
= git_config_from_blob_ref(fn
, repo
, config_source
->blob
,
2292 ret
= do_git_config_sequence(&the_reader
, opts
, repo
, fn
, data
);
2295 if (inc
.remote_urls
) {
2296 string_list_clear(inc
.remote_urls
, 0);
2297 FREE_AND_NULL(inc
.remote_urls
);
2299 config_reader_set_scope(&the_reader
, prev_scope
);
2303 static void configset_iter(struct config_reader
*reader
, struct config_set
*set
,
2304 config_fn_t fn
, void *data
)
2307 struct string_list
*values
;
2308 struct config_set_element
*entry
;
2309 struct configset_list
*list
= &set
->list
;
2311 for (i
= 0; i
< list
->nr
; i
++) {
2312 entry
= list
->items
[i
].e
;
2313 value_index
= list
->items
[i
].value_index
;
2314 values
= &entry
->value_list
;
2316 config_reader_set_kvi(reader
, values
->items
[value_index
].util
);
2318 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
2319 git_die_config_linenr(entry
->key
,
2320 reader
->config_kvi
->filename
,
2321 reader
->config_kvi
->linenr
);
2323 config_reader_set_kvi(reader
, NULL
);
2327 void read_early_config(config_fn_t cb
, void *data
)
2329 struct config_options opts
= {0};
2330 struct strbuf commondir
= STRBUF_INIT
;
2331 struct strbuf gitdir
= STRBUF_INIT
;
2333 opts
.respect_includes
= 1;
2335 if (have_git_dir()) {
2336 opts
.commondir
= get_git_common_dir();
2337 opts
.git_dir
= get_git_dir();
2339 * When setup_git_directory() was not yet asked to discover the
2340 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2341 * is any repository config we should use (but unlike
2342 * setup_git_directory_gently(), no global state is changed, most
2343 * notably, the current working directory is still the same after the
2346 } else if (!discover_git_directory(&commondir
, &gitdir
)) {
2347 opts
.commondir
= commondir
.buf
;
2348 opts
.git_dir
= gitdir
.buf
;
2351 config_with_options(cb
, data
, NULL
, NULL
, &opts
);
2353 strbuf_release(&commondir
);
2354 strbuf_release(&gitdir
);
2358 * Read config but only enumerate system and global settings.
2359 * Omit any repo-local, worktree-local, or command-line settings.
2361 void read_very_early_config(config_fn_t cb
, void *data
)
2363 struct config_options opts
= { 0 };
2365 opts
.respect_includes
= 1;
2366 opts
.ignore_repo
= 1;
2367 opts
.ignore_worktree
= 1;
2368 opts
.ignore_cmdline
= 1;
2369 opts
.system_gently
= 1;
2371 config_with_options(cb
, data
, NULL
, NULL
, &opts
);
2375 static int configset_find_element(struct config_set
*set
, const char *key
,
2376 struct config_set_element
**dest
)
2378 struct config_set_element k
;
2379 struct config_set_element
*found_entry
;
2380 char *normalized_key
;
2384 * `key` may come from the user, so normalize it before using it
2385 * for querying entries from the hashmap.
2387 ret
= git_config_parse_key(key
, &normalized_key
, NULL
);
2391 hashmap_entry_init(&k
.ent
, strhash(normalized_key
));
2392 k
.key
= normalized_key
;
2393 found_entry
= hashmap_get_entry(&set
->config_hash
, &k
, ent
, NULL
);
2394 free(normalized_key
);
2395 *dest
= found_entry
;
2399 static int configset_add_value(struct config_reader
*reader
,
2400 struct config_set
*set
, const char *key
,
2403 struct config_set_element
*e
;
2404 struct string_list_item
*si
;
2405 struct configset_list_item
*l_item
;
2406 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
2409 ret
= configset_find_element(set
, key
, &e
);
2413 * Since the keys are being fed by git_config*() callback mechanism, they
2414 * are already normalized. So simply add them without any further munging.
2417 e
= xmalloc(sizeof(*e
));
2418 hashmap_entry_init(&e
->ent
, strhash(key
));
2419 e
->key
= xstrdup(key
);
2420 string_list_init_dup(&e
->value_list
);
2421 hashmap_add(&set
->config_hash
, &e
->ent
);
2423 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
2425 ALLOC_GROW(set
->list
.items
, set
->list
.nr
+ 1, set
->list
.alloc
);
2426 l_item
= &set
->list
.items
[set
->list
.nr
++];
2428 l_item
->value_index
= e
->value_list
.nr
- 1;
2430 if (!reader
->source
)
2431 BUG("configset_add_value has no source");
2432 if (reader
->source
->name
) {
2433 kv_info
->filename
= strintern(reader
->source
->name
);
2434 kv_info
->linenr
= reader
->source
->linenr
;
2435 kv_info
->origin_type
= reader
->source
->origin_type
;
2437 /* for values read from `git_config_from_parameters()` */
2438 kv_info
->filename
= NULL
;
2439 kv_info
->linenr
= -1;
2440 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
2442 kv_info
->scope
= reader
->parsing_scope
;
2448 static int config_set_element_cmp(const void *cmp_data UNUSED
,
2449 const struct hashmap_entry
*eptr
,
2450 const struct hashmap_entry
*entry_or_key
,
2451 const void *keydata UNUSED
)
2453 const struct config_set_element
*e1
, *e2
;
2455 e1
= container_of(eptr
, const struct config_set_element
, ent
);
2456 e2
= container_of(entry_or_key
, const struct config_set_element
, ent
);
2458 return strcmp(e1
->key
, e2
->key
);
2461 void git_configset_init(struct config_set
*set
)
2463 hashmap_init(&set
->config_hash
, config_set_element_cmp
, NULL
, 0);
2464 set
->hash_initialized
= 1;
2466 set
->list
.alloc
= 0;
2467 set
->list
.items
= NULL
;
2470 void git_configset_clear(struct config_set
*set
)
2472 struct config_set_element
*entry
;
2473 struct hashmap_iter iter
;
2474 if (!set
->hash_initialized
)
2477 hashmap_for_each_entry(&set
->config_hash
, &iter
, entry
,
2478 ent
/* member name */) {
2480 string_list_clear(&entry
->value_list
, 1);
2482 hashmap_clear_and_free(&set
->config_hash
, struct config_set_element
, ent
);
2483 set
->hash_initialized
= 0;
2484 free(set
->list
.items
);
2486 set
->list
.alloc
= 0;
2487 set
->list
.items
= NULL
;
2490 struct configset_add_data
{
2491 struct config_set
*config_set
;
2492 struct config_reader
*config_reader
;
2494 #define CONFIGSET_ADD_INIT { 0 }
2496 static int config_set_callback(const char *key
, const char *value
, void *cb
)
2498 struct configset_add_data
*data
= cb
;
2499 configset_add_value(data
->config_reader
, data
->config_set
, key
, value
);
2503 int git_configset_add_file(struct config_set
*set
, const char *filename
)
2505 struct configset_add_data data
= CONFIGSET_ADD_INIT
;
2506 data
.config_reader
= &the_reader
;
2507 data
.config_set
= set
;
2508 return git_config_from_file(config_set_callback
, filename
, &data
);
2511 int git_configset_get_value(struct config_set
*set
, const char *key
, const char **value
)
2513 const struct string_list
*values
= NULL
;
2517 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2518 * queried key in the files of the configset, the value returned will be the last
2519 * value in the value list for that key.
2521 if ((ret
= git_configset_get_value_multi(set
, key
, &values
)))
2524 assert(values
->nr
> 0);
2525 *value
= values
->items
[values
->nr
- 1].string
;
2529 int git_configset_get_value_multi(struct config_set
*set
, const char *key
,
2530 const struct string_list
**dest
)
2532 struct config_set_element
*e
;
2535 if ((ret
= configset_find_element(set
, key
, &e
)))
2539 *dest
= &e
->value_list
;
2544 static int check_multi_string(struct string_list_item
*item
, void *util
)
2546 return item
->string
? 0 : config_error_nonbool(util
);
2549 int git_configset_get_string_multi(struct config_set
*cs
, const char *key
,
2550 const struct string_list
**dest
)
2554 if ((ret
= git_configset_get_value_multi(cs
, key
, dest
)))
2556 if ((ret
= for_each_string_list((struct string_list
*)*dest
,
2557 check_multi_string
, (void *)key
)))
2563 int git_configset_get(struct config_set
*set
, const char *key
)
2565 struct config_set_element
*e
;
2568 if ((ret
= configset_find_element(set
, key
, &e
)))
2575 int git_configset_get_string(struct config_set
*set
, const char *key
, char **dest
)
2578 if (!git_configset_get_value(set
, key
, &value
))
2579 return git_config_string((const char **)dest
, key
, value
);
2584 static int git_configset_get_string_tmp(struct config_set
*set
, const char *key
,
2588 if (!git_configset_get_value(set
, key
, &value
)) {
2590 return config_error_nonbool(key
);
2598 int git_configset_get_int(struct config_set
*set
, const char *key
, int *dest
)
2601 if (!git_configset_get_value(set
, key
, &value
)) {
2602 *dest
= git_config_int(key
, value
);
2608 int git_configset_get_ulong(struct config_set
*set
, const char *key
, unsigned long *dest
)
2611 if (!git_configset_get_value(set
, key
, &value
)) {
2612 *dest
= git_config_ulong(key
, value
);
2618 int git_configset_get_bool(struct config_set
*set
, const char *key
, int *dest
)
2621 if (!git_configset_get_value(set
, key
, &value
)) {
2622 *dest
= git_config_bool(key
, value
);
2628 int git_configset_get_bool_or_int(struct config_set
*set
, const char *key
,
2629 int *is_bool
, int *dest
)
2632 if (!git_configset_get_value(set
, key
, &value
)) {
2633 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
2639 int git_configset_get_maybe_bool(struct config_set
*set
, const char *key
, int *dest
)
2642 if (!git_configset_get_value(set
, key
, &value
)) {
2643 *dest
= git_parse_maybe_bool(value
);
2651 int git_configset_get_pathname(struct config_set
*set
, const char *key
, const char **dest
)
2654 if (!git_configset_get_value(set
, key
, &value
))
2655 return git_config_pathname(dest
, key
, value
);
2660 /* Functions use to read configuration from a repository */
2661 static void repo_read_config(struct repository
*repo
)
2663 struct config_options opts
= { 0 };
2664 struct configset_add_data data
= CONFIGSET_ADD_INIT
;
2666 opts
.respect_includes
= 1;
2667 opts
.commondir
= repo
->commondir
;
2668 opts
.git_dir
= repo
->gitdir
;
2671 CALLOC_ARRAY(repo
->config
, 1);
2673 git_configset_clear(repo
->config
);
2675 git_configset_init(repo
->config
);
2676 data
.config_set
= repo
->config
;
2677 data
.config_reader
= &the_reader
;
2679 if (config_with_options(config_set_callback
, &data
, NULL
, repo
, &opts
) < 0)
2681 * config_with_options() normally returns only
2682 * zero, as most errors are fatal, and
2683 * non-fatal potential errors are guarded by "if"
2684 * statements that are entered only when no error is
2687 * If we ever encounter a non-fatal error, it means
2688 * something went really wrong and we should stop
2691 die(_("unknown error occurred while reading the configuration files"));
2694 static void git_config_check_init(struct repository
*repo
)
2696 if (repo
->config
&& repo
->config
->hash_initialized
)
2698 repo_read_config(repo
);
2701 static void repo_config_clear(struct repository
*repo
)
2703 if (!repo
->config
|| !repo
->config
->hash_initialized
)
2705 git_configset_clear(repo
->config
);
2708 void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
)
2710 git_config_check_init(repo
);
2711 configset_iter(&the_reader
, repo
->config
, fn
, data
);
2714 int repo_config_get(struct repository
*repo
, const char *key
)
2716 git_config_check_init(repo
);
2717 return git_configset_get(repo
->config
, key
);
2720 int repo_config_get_value(struct repository
*repo
,
2721 const char *key
, const char **value
)
2723 git_config_check_init(repo
);
2724 return git_configset_get_value(repo
->config
, key
, value
);
2727 int repo_config_get_value_multi(struct repository
*repo
, const char *key
,
2728 const struct string_list
**dest
)
2730 git_config_check_init(repo
);
2731 return git_configset_get_value_multi(repo
->config
, key
, dest
);
2734 int repo_config_get_string_multi(struct repository
*repo
, const char *key
,
2735 const struct string_list
**dest
)
2737 git_config_check_init(repo
);
2738 return git_configset_get_string_multi(repo
->config
, key
, dest
);
2741 int repo_config_get_string(struct repository
*repo
,
2742 const char *key
, char **dest
)
2745 git_config_check_init(repo
);
2746 ret
= git_configset_get_string(repo
->config
, key
, dest
);
2748 git_die_config(key
, NULL
);
2752 int repo_config_get_string_tmp(struct repository
*repo
,
2753 const char *key
, const char **dest
)
2756 git_config_check_init(repo
);
2757 ret
= git_configset_get_string_tmp(repo
->config
, key
, dest
);
2759 git_die_config(key
, NULL
);
2763 int repo_config_get_int(struct repository
*repo
,
2764 const char *key
, int *dest
)
2766 git_config_check_init(repo
);
2767 return git_configset_get_int(repo
->config
, key
, dest
);
2770 int repo_config_get_ulong(struct repository
*repo
,
2771 const char *key
, unsigned long *dest
)
2773 git_config_check_init(repo
);
2774 return git_configset_get_ulong(repo
->config
, key
, dest
);
2777 int repo_config_get_bool(struct repository
*repo
,
2778 const char *key
, int *dest
)
2780 git_config_check_init(repo
);
2781 return git_configset_get_bool(repo
->config
, key
, dest
);
2784 int repo_config_get_bool_or_int(struct repository
*repo
,
2785 const char *key
, int *is_bool
, int *dest
)
2787 git_config_check_init(repo
);
2788 return git_configset_get_bool_or_int(repo
->config
, key
, is_bool
, dest
);
2791 int repo_config_get_maybe_bool(struct repository
*repo
,
2792 const char *key
, int *dest
)
2794 git_config_check_init(repo
);
2795 return git_configset_get_maybe_bool(repo
->config
, key
, dest
);
2798 int repo_config_get_pathname(struct repository
*repo
,
2799 const char *key
, const char **dest
)
2802 git_config_check_init(repo
);
2803 ret
= git_configset_get_pathname(repo
->config
, key
, dest
);
2805 git_die_config(key
, NULL
);
2809 /* Read values into protected_config. */
2810 static void read_protected_config(void)
2812 struct config_options opts
= {
2813 .respect_includes
= 1,
2815 .ignore_worktree
= 1,
2818 struct configset_add_data data
= CONFIGSET_ADD_INIT
;
2820 git_configset_init(&protected_config
);
2821 data
.config_set
= &protected_config
;
2822 data
.config_reader
= &the_reader
;
2823 config_with_options(config_set_callback
, &data
, NULL
, NULL
, &opts
);
2826 void git_protected_config(config_fn_t fn
, void *data
)
2828 if (!protected_config
.hash_initialized
)
2829 read_protected_config();
2830 configset_iter(&the_reader
, &protected_config
, fn
, data
);
2833 /* Functions used historically to read configuration from 'the_repository' */
2834 void git_config(config_fn_t fn
, void *data
)
2836 repo_config(the_repository
, fn
, data
);
2839 void git_config_clear(void)
2841 repo_config_clear(the_repository
);
2844 int git_config_get(const char *key
)
2846 return repo_config_get(the_repository
, key
);
2849 int git_config_get_value(const char *key
, const char **value
)
2851 return repo_config_get_value(the_repository
, key
, value
);
2854 int git_config_get_value_multi(const char *key
, const struct string_list
**dest
)
2856 return repo_config_get_value_multi(the_repository
, key
, dest
);
2859 int git_config_get_string_multi(const char *key
,
2860 const struct string_list
**dest
)
2862 return repo_config_get_string_multi(the_repository
, key
, dest
);
2865 int git_config_get_string(const char *key
, char **dest
)
2867 return repo_config_get_string(the_repository
, key
, dest
);
2870 int git_config_get_string_tmp(const char *key
, const char **dest
)
2872 return repo_config_get_string_tmp(the_repository
, key
, dest
);
2875 int git_config_get_int(const char *key
, int *dest
)
2877 return repo_config_get_int(the_repository
, key
, dest
);
2880 int git_config_get_ulong(const char *key
, unsigned long *dest
)
2882 return repo_config_get_ulong(the_repository
, key
, dest
);
2885 int git_config_get_bool(const char *key
, int *dest
)
2887 return repo_config_get_bool(the_repository
, key
, dest
);
2890 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
2892 return repo_config_get_bool_or_int(the_repository
, key
, is_bool
, dest
);
2895 int git_config_get_maybe_bool(const char *key
, int *dest
)
2897 return repo_config_get_maybe_bool(the_repository
, key
, dest
);
2900 int git_config_get_pathname(const char *key
, const char **dest
)
2902 return repo_config_get_pathname(the_repository
, key
, dest
);
2905 int git_config_get_expiry(const char *key
, const char **output
)
2907 int ret
= git_config_get_string(key
, (char **)output
);
2910 if (strcmp(*output
, "now")) {
2911 timestamp_t now
= approxidate("now");
2912 if (approxidate(*output
) >= now
)
2913 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
2918 int git_config_get_expiry_in_days(const char *key
, timestamp_t
*expiry
, timestamp_t now
)
2920 const char *expiry_string
;
2924 if (git_config_get_string_tmp(key
, &expiry_string
))
2925 return 1; /* no such thing */
2927 if (git_parse_signed(expiry_string
, &days
, maximum_signed_value_of_type(int))) {
2928 const int scale
= 86400;
2929 *expiry
= now
- days
* scale
;
2933 if (!parse_expiry_date(expiry_string
, &when
)) {
2937 return -1; /* thing exists but cannot be parsed */
2940 int git_config_get_split_index(void)
2944 if (!git_config_get_maybe_bool("core.splitindex", &val
))
2947 return -1; /* default value */
2950 int git_config_get_max_percent_split_change(void)
2954 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
2955 if (0 <= val
&& val
<= 100)
2958 return error(_("splitIndex.maxPercentChange value '%d' "
2959 "should be between 0 and 100"), val
);
2962 return -1; /* default value */
2965 int git_config_get_index_threads(int *dest
)
2969 val
= git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2975 if (!git_config_get_bool_or_int("index.threads", &is_bool
, &val
)) {
2977 *dest
= val
? 0 : 1;
2987 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
2990 die(_("unable to parse '%s' from command-line config"), key
);
2992 die(_("bad config variable '%s' in file '%s' at line %d"),
2993 key
, filename
, linenr
);
2996 NORETURN
__attribute__((format(printf
, 2, 3)))
2997 void git_die_config(const char *key
, const char *err
, ...)
2999 const struct string_list
*values
;
3000 struct key_value_info
*kv_info
;
3001 report_fn error_fn
= get_error_routine();
3005 va_start(params
, err
);
3006 error_fn(err
, params
);
3009 if (git_config_get_value_multi(key
, &values
))
3010 BUG("for key '%s' we must have a value to report on", key
);
3011 kv_info
= values
->items
[values
->nr
- 1].util
;
3012 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
3016 * Find all the stuff for git_config_set() below.
3019 struct config_store_data
{
3020 struct config_reader
*config_reader
;
3024 const char *fixed_value
;
3025 regex_t
*value_pattern
;
3029 enum config_event_t type
;
3030 int is_keys_section
;
3032 unsigned int parsed_nr
, parsed_alloc
, *seen
, seen_nr
, seen_alloc
;
3033 unsigned int key_seen
:1, section_seen
:1, is_keys_section
:1;
3035 #define CONFIG_STORE_INIT { 0 }
3037 static void config_store_data_clear(struct config_store_data
*store
)
3040 if (store
->value_pattern
!= NULL
&&
3041 store
->value_pattern
!= CONFIG_REGEX_NONE
) {
3042 regfree(store
->value_pattern
);
3043 free(store
->value_pattern
);
3045 free(store
->parsed
);
3047 memset(store
, 0, sizeof(*store
));
3050 static int matches(const char *key
, const char *value
,
3051 const struct config_store_data
*store
)
3053 if (strcmp(key
, store
->key
))
3054 return 0; /* not ours */
3055 if (store
->fixed_value
)
3056 return !strcmp(store
->fixed_value
, value
);
3057 if (!store
->value_pattern
)
3058 return 1; /* always matches */
3059 if (store
->value_pattern
== CONFIG_REGEX_NONE
)
3060 return 0; /* never matches */
3062 return store
->do_not_match
^
3063 (value
&& !regexec(store
->value_pattern
, value
, 0, NULL
, 0));
3066 static int store_aux_event(enum config_event_t type
,
3067 size_t begin
, size_t end
, void *data
)
3069 struct config_store_data
*store
= data
;
3070 struct config_source
*cs
= store
->config_reader
->source
;
3072 ALLOC_GROW(store
->parsed
, store
->parsed_nr
+ 1, store
->parsed_alloc
);
3073 store
->parsed
[store
->parsed_nr
].begin
= begin
;
3074 store
->parsed
[store
->parsed_nr
].end
= end
;
3075 store
->parsed
[store
->parsed_nr
].type
= type
;
3077 if (type
== CONFIG_EVENT_SECTION
) {
3078 int (*cmpfn
)(const char *, const char *, size_t);
3080 if (cs
->var
.len
< 2 || cs
->var
.buf
[cs
->var
.len
- 1] != '.')
3081 return error(_("invalid section name '%s'"), cs
->var
.buf
);
3083 if (cs
->subsection_case_sensitive
)
3084 cmpfn
= strncasecmp
;
3088 /* Is this the section we were looking for? */
3089 store
->is_keys_section
=
3090 store
->parsed
[store
->parsed_nr
].is_keys_section
=
3091 cs
->var
.len
- 1 == store
->baselen
&&
3092 !cmpfn(cs
->var
.buf
, store
->key
, store
->baselen
);
3093 if (store
->is_keys_section
) {
3094 store
->section_seen
= 1;
3095 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
3097 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
3106 static int store_aux(const char *key
, const char *value
, void *cb
)
3108 struct config_store_data
*store
= cb
;
3110 if (store
->key_seen
) {
3111 if (matches(key
, value
, store
)) {
3112 if (store
->seen_nr
== 1 && store
->multi_replace
== 0) {
3113 warning(_("%s has multiple values"), key
);
3116 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
3119 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
3122 } else if (store
->is_keys_section
) {
3124 * Do not increment matches yet: this may not be a match, but we
3125 * are in the desired section.
3127 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1, store
->seen_alloc
);
3128 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
3129 store
->section_seen
= 1;
3131 if (matches(key
, value
, store
)) {
3133 store
->key_seen
= 1;
3140 static int write_error(const char *filename
)
3142 error(_("failed to write new configuration file %s"), filename
);
3144 /* Same error code as "failed to rename". */
3148 static struct strbuf
store_create_section(const char *key
,
3149 const struct config_store_data
*store
)
3153 struct strbuf sb
= STRBUF_INIT
;
3155 dot
= memchr(key
, '.', store
->baselen
);
3157 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
3158 for (i
= dot
- key
+ 1; i
< store
->baselen
; i
++) {
3159 if (key
[i
] == '"' || key
[i
] == '\\')
3160 strbuf_addch(&sb
, '\\');
3161 strbuf_addch(&sb
, key
[i
]);
3163 strbuf_addstr(&sb
, "\"]\n");
3165 strbuf_addch(&sb
, '[');
3166 strbuf_add(&sb
, key
, store
->baselen
);
3167 strbuf_addstr(&sb
, "]\n");
3173 static ssize_t
write_section(int fd
, const char *key
,
3174 const struct config_store_data
*store
)
3176 struct strbuf sb
= store_create_section(key
, store
);
3179 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
3180 strbuf_release(&sb
);
3185 static ssize_t
write_pair(int fd
, const char *key
, const char *value
,
3186 const struct config_store_data
*store
)
3190 const char *quote
= "";
3191 struct strbuf sb
= STRBUF_INIT
;
3194 * Check to see if the value needs to be surrounded with a dq pair.
3195 * Note that problematic characters are always backslash-quoted; this
3196 * check is about not losing leading or trailing SP and strings that
3197 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3198 * configuration parser.
3200 if (value
[0] == ' ')
3202 for (i
= 0; value
[i
]; i
++)
3203 if (value
[i
] == ';' || value
[i
] == '#')
3205 if (i
&& value
[i
- 1] == ' ')
3208 strbuf_addf(&sb
, "\t%s = %s", key
+ store
->baselen
+ 1, quote
);
3210 for (i
= 0; value
[i
]; i
++)
3213 strbuf_addstr(&sb
, "\\n");
3216 strbuf_addstr(&sb
, "\\t");
3220 strbuf_addch(&sb
, '\\');
3223 strbuf_addch(&sb
, value
[i
]);
3226 strbuf_addf(&sb
, "%s\n", quote
);
3228 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
3229 strbuf_release(&sb
);
3235 * If we are about to unset the last key(s) in a section, and if there are
3236 * no comments surrounding (or included in) the section, we will want to
3237 * extend begin/end to remove the entire section.
3239 * Note: the parameter `seen_ptr` points to the index into the store.seen
3240 * array. * This index may be incremented if a section has more than one
3241 * entry (which all are to be removed).
3243 static void maybe_remove_section(struct config_store_data
*store
,
3244 size_t *begin_offset
, size_t *end_offset
,
3248 int i
, seen
, section_seen
= 0;
3251 * First, ensure that this is the first key, and that there are no
3252 * comments before the entry nor before the section header.
3255 for (i
= store
->seen
[seen
]; i
> 0; i
--) {
3256 enum config_event_t type
= store
->parsed
[i
- 1].type
;
3258 if (type
== CONFIG_EVENT_COMMENT
)
3259 /* There is a comment before this entry or section */
3261 if (type
== CONFIG_EVENT_ENTRY
) {
3263 /* This is not the section's first entry. */
3265 /* We encountered no comment before the section. */
3268 if (type
== CONFIG_EVENT_SECTION
) {
3269 if (!store
->parsed
[i
- 1].is_keys_section
)
3274 begin
= store
->parsed
[i
].begin
;
3277 * Next, make sure that we are removing the last key(s) in the section,
3278 * and that there are no comments that are possibly about the current
3281 for (i
= store
->seen
[seen
] + 1; i
< store
->parsed_nr
; i
++) {
3282 enum config_event_t type
= store
->parsed
[i
].type
;
3284 if (type
== CONFIG_EVENT_COMMENT
)
3286 if (type
== CONFIG_EVENT_SECTION
) {
3287 if (store
->parsed
[i
].is_keys_section
)
3291 if (type
== CONFIG_EVENT_ENTRY
) {
3292 if (++seen
< store
->seen_nr
&&
3293 i
== store
->seen
[seen
])
3294 /* We want to remove this entry, too */
3296 /* There is another entry in this section. */
3302 * We are really removing the last entry/entries from this section, and
3303 * there are no enclosed or surrounding comments. Remove the entire,
3304 * now-empty section.
3307 *begin_offset
= begin
;
3308 if (i
< store
->parsed_nr
)
3309 *end_offset
= store
->parsed
[i
].begin
;
3311 *end_offset
= store
->parsed
[store
->parsed_nr
- 1].end
;
3314 int git_config_set_in_file_gently(const char *config_filename
,
3315 const char *key
, const char *value
)
3317 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
3320 void git_config_set_in_file(const char *config_filename
,
3321 const char *key
, const char *value
)
3323 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
3326 int git_config_set_gently(const char *key
, const char *value
)
3328 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
3331 int repo_config_set_worktree_gently(struct repository
*r
,
3332 const char *key
, const char *value
)
3334 /* Only use worktree-specific config if it is already enabled. */
3335 if (r
->repository_format_worktree_config
) {
3336 char *file
= repo_git_path(r
, "config.worktree");
3337 int ret
= git_config_set_multivar_in_file_gently(
3338 file
, key
, value
, NULL
, 0);
3342 return repo_config_set_multivar_gently(r
, key
, value
, NULL
, 0);
3345 void git_config_set(const char *key
, const char *value
)
3347 git_config_set_multivar(key
, value
, NULL
, 0);
3349 trace2_cmd_set_config(key
, value
);
3353 * If value==NULL, unset in (remove from) config,
3354 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3355 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3356 * (only add a new one)
3357 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3358 * key/values are removed before a single new pair is written. If the
3359 * flag is not present, then replace only the first match.
3361 * Returns 0 on success.
3363 * This function does this:
3365 * - it locks the config file by creating ".git/config.lock"
3367 * - it then parses the config using store_aux() as validator to find
3368 * the position on the key/value pair to replace. If it is to be unset,
3369 * it must be found exactly once.
3371 * - the config file is mmap()ed and the part before the match (if any) is
3372 * written to the lock file, then the changed part and the rest.
3374 * - the config file is removed and the lock file rename()d to it.
3377 int git_config_set_multivar_in_file_gently(const char *config_filename
,
3378 const char *key
, const char *value
,
3379 const char *value_pattern
,
3382 int fd
= -1, in_fd
= -1;
3384 struct lock_file lock
= LOCK_INIT
;
3385 char *filename_buf
= NULL
;
3386 char *contents
= NULL
;
3388 struct config_store_data store
= CONFIG_STORE_INIT
;
3390 store
.config_reader
= &the_reader
;
3392 /* parse-key returns negative; flip the sign to feed exit(3) */
3393 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
3397 store
.multi_replace
= (flags
& CONFIG_FLAGS_MULTI_REPLACE
) != 0;
3399 if (!config_filename
)
3400 config_filename
= filename_buf
= git_pathdup("config");
3403 * The lock serves a purpose in addition to locking: the new
3404 * contents of .git/config will be written into it.
3406 fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3408 error_errno(_("could not lock config file %s"), config_filename
);
3409 ret
= CONFIG_NO_LOCK
;
3414 * If .git/config does not exist yet, write a minimal version.
3416 in_fd
= open(config_filename
, O_RDONLY
);
3418 if ( ENOENT
!= errno
) {
3419 error_errno(_("opening %s"), config_filename
);
3420 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
3423 /* if nothing to unset, error out */
3425 ret
= CONFIG_NOTHING_SET
;
3430 store
.key
= xstrdup(key
);
3431 if (write_section(fd
, key
, &store
) < 0 ||
3432 write_pair(fd
, key
, value
, &store
) < 0)
3436 size_t copy_begin
, copy_end
;
3437 int i
, new_line
= 0;
3438 struct config_options opts
;
3441 store
.value_pattern
= NULL
;
3442 else if (value_pattern
== CONFIG_REGEX_NONE
)
3443 store
.value_pattern
= CONFIG_REGEX_NONE
;
3444 else if (flags
& CONFIG_FLAGS_FIXED_VALUE
)
3445 store
.fixed_value
= value_pattern
;
3447 if (value_pattern
[0] == '!') {
3448 store
.do_not_match
= 1;
3451 store
.do_not_match
= 0;
3453 store
.value_pattern
= (regex_t
*)xmalloc(sizeof(regex_t
));
3454 if (regcomp(store
.value_pattern
, value_pattern
,
3456 error(_("invalid pattern: %s"), value_pattern
);
3457 FREE_AND_NULL(store
.value_pattern
);
3458 ret
= CONFIG_INVALID_PATTERN
;
3463 ALLOC_GROW(store
.parsed
, 1, store
.parsed_alloc
);
3464 store
.parsed
[0].end
= 0;
3466 memset(&opts
, 0, sizeof(opts
));
3467 opts
.event_fn
= store_aux_event
;
3468 opts
.event_fn_data
= &store
;
3471 * After this, store.parsed will contain offsets of all the
3472 * parsed elements, and store.seen will contain a list of
3473 * matches, as indices into store.parsed.
3475 * As a side effect, we make sure to transform only a valid
3476 * existing config file.
3478 if (git_config_from_file_with_options(store_aux
,
3481 error(_("invalid config file %s"), config_filename
);
3482 ret
= CONFIG_INVALID_FILE
;
3486 /* if nothing to unset, or too many matches, error out */
3487 if ((store
.seen_nr
== 0 && value
== NULL
) ||
3488 (store
.seen_nr
> 1 && !store
.multi_replace
)) {
3489 ret
= CONFIG_NOTHING_SET
;
3493 if (fstat(in_fd
, &st
) == -1) {
3494 error_errno(_("fstat on %s failed"), config_filename
);
3495 ret
= CONFIG_INVALID_FILE
;
3499 contents_sz
= xsize_t(st
.st_size
);
3500 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
3501 MAP_PRIVATE
, in_fd
, 0);
3502 if (contents
== MAP_FAILED
) {
3503 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
3505 error_errno(_("unable to mmap '%s'%s"),
3506 config_filename
, mmap_os_err());
3507 ret
= CONFIG_INVALID_FILE
;
3514 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3515 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock
));
3516 ret
= CONFIG_NO_WRITE
;
3520 if (store
.seen_nr
== 0) {
3521 if (!store
.seen_alloc
) {
3522 /* Did not see key nor section */
3523 ALLOC_GROW(store
.seen
, 1, store
.seen_alloc
);
3524 store
.seen
[0] = store
.parsed_nr
3525 - !!store
.parsed_nr
;
3530 for (i
= 0, copy_begin
= 0; i
< store
.seen_nr
; i
++) {
3532 int j
= store
.seen
[i
];
3535 if (!store
.key_seen
) {
3536 copy_end
= store
.parsed
[j
].end
;
3537 /* include '\n' when copying section header */
3538 if (copy_end
> 0 && copy_end
< contents_sz
&&
3539 contents
[copy_end
- 1] != '\n' &&
3540 contents
[copy_end
] == '\n')
3542 replace_end
= copy_end
;
3544 replace_end
= store
.parsed
[j
].end
;
3545 copy_end
= store
.parsed
[j
].begin
;
3547 maybe_remove_section(&store
,
3551 * Swallow preceding white-space on the same
3554 while (copy_end
> 0 ) {
3555 char c
= contents
[copy_end
- 1];
3557 if (isspace(c
) && c
!= '\n')
3564 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
3567 /* write the first part of the config */
3568 if (copy_end
> copy_begin
) {
3569 if (write_in_full(fd
, contents
+ copy_begin
,
3570 copy_end
- copy_begin
) < 0)
3573 write_str_in_full(fd
, "\n") < 0)
3576 copy_begin
= replace_end
;
3579 /* write the pair (value == NULL means unset) */
3581 if (!store
.section_seen
) {
3582 if (write_section(fd
, key
, &store
) < 0)
3585 if (write_pair(fd
, key
, value
, &store
) < 0)
3589 /* write the rest of the config */
3590 if (copy_begin
< contents_sz
)
3591 if (write_in_full(fd
, contents
+ copy_begin
,
3592 contents_sz
- copy_begin
) < 0)
3595 munmap(contents
, contents_sz
);
3599 if (commit_lock_file(&lock
) < 0) {
3600 error_errno(_("could not write config file %s"), config_filename
);
3601 ret
= CONFIG_NO_WRITE
;
3607 /* Invalidate the config cache */
3611 rollback_lock_file(&lock
);
3614 munmap(contents
, contents_sz
);
3617 config_store_data_clear(&store
);
3621 ret
= write_error(get_lock_file_path(&lock
));
3626 void git_config_set_multivar_in_file(const char *config_filename
,
3627 const char *key
, const char *value
,
3628 const char *value_pattern
, unsigned flags
)
3630 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
3631 value_pattern
, flags
))
3634 die(_("could not set '%s' to '%s'"), key
, value
);
3636 die(_("could not unset '%s'"), key
);
3639 int git_config_set_multivar_gently(const char *key
, const char *value
,
3640 const char *value_pattern
, unsigned flags
)
3642 return repo_config_set_multivar_gently(the_repository
, key
, value
,
3643 value_pattern
, flags
);
3646 int repo_config_set_multivar_gently(struct repository
*r
, const char *key
,
3648 const char *value_pattern
, unsigned flags
)
3650 char *file
= repo_git_path(r
, "config");
3651 int res
= git_config_set_multivar_in_file_gently(file
,
3659 void git_config_set_multivar(const char *key
, const char *value
,
3660 const char *value_pattern
, unsigned flags
)
3662 git_config_set_multivar_in_file(git_path("config"),
3663 key
, value
, value_pattern
,
3667 static size_t section_name_match (const char *buf
, const char *name
)
3669 size_t i
= 0, j
= 0;
3673 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
3674 if (!dot
&& isspace(buf
[i
])) {
3676 if (name
[j
++] != '.')
3678 for (i
++; isspace(buf
[i
]); i
++)
3684 if (buf
[i
] == '\\' && dot
)
3686 else if (buf
[i
] == '"' && dot
) {
3687 for (i
++; isspace(buf
[i
]); i
++)
3691 if (buf
[i
] != name
[j
++])
3694 if (buf
[i
] == ']' && name
[j
] == 0) {
3696 * We match, now just find the right length offset by
3697 * gobbling up any whitespace after it, as well
3700 for (; buf
[i
] && isspace(buf
[i
]); i
++)
3707 static int section_name_is_ok(const char *name
)
3709 /* Empty section names are bogus. */
3714 * Before a dot, we must be alphanumeric or dash. After the first dot,
3715 * anything goes, so we can stop checking.
3717 for (; *name
&& *name
!= '.'; name
++)
3718 if (*name
!= '-' && !isalnum(*name
))
3723 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3725 /* if new_name == NULL, the section is removed instead */
3726 static int git_config_copy_or_rename_section_in_file(const char *config_filename
,
3727 const char *old_name
,
3728 const char *new_name
, int copy
)
3730 int ret
= 0, remove
= 0;
3731 char *filename_buf
= NULL
;
3732 struct lock_file lock
= LOCK_INIT
;
3734 struct strbuf buf
= STRBUF_INIT
;
3735 FILE *config_file
= NULL
;
3737 struct strbuf copystr
= STRBUF_INIT
;
3738 struct config_store_data store
;
3739 uint32_t line_nr
= 0;
3741 memset(&store
, 0, sizeof(store
));
3743 if (new_name
&& !section_name_is_ok(new_name
)) {
3744 ret
= error(_("invalid section name: %s"), new_name
);
3745 goto out_no_rollback
;
3748 if (!config_filename
)
3749 config_filename
= filename_buf
= git_pathdup("config");
3751 out_fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3753 ret
= error(_("could not lock config file %s"), config_filename
);
3757 if (!(config_file
= fopen(config_filename
, "rb"))) {
3758 ret
= warn_on_fopen_errors(config_filename
);
3761 /* no config file means nothing to rename, no error */
3762 goto commit_and_out
;
3765 if (fstat(fileno(config_file
), &st
) == -1) {
3766 ret
= error_errno(_("fstat on %s failed"), config_filename
);
3770 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3771 ret
= error_errno(_("chmod on %s failed"),
3772 get_lock_file_path(&lock
));
3776 while (!strbuf_getwholeline(&buf
, config_file
, '\n')) {
3779 char *output
= buf
.buf
;
3783 if (buf
.len
>= GIT_CONFIG_MAX_LINE_LEN
) {
3784 ret
= error(_("refusing to work with overly long line "
3785 "in '%s' on line %"PRIuMAX
),
3786 config_filename
, (uintmax_t)line_nr
);
3790 for (i
= 0; buf
.buf
[i
] && isspace(buf
.buf
[i
]); i
++)
3792 if (buf
.buf
[i
] == '[') {
3793 /* it's a section */
3798 * When encountering a new section under -c we
3799 * need to flush out any section we're already
3800 * coping and begin anew. There might be
3801 * multiple [branch "$name"] sections.
3803 if (copystr
.len
> 0) {
3804 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3805 ret
= write_error(get_lock_file_path(&lock
));
3808 strbuf_reset(©str
);
3811 offset
= section_name_match(&buf
.buf
[i
], old_name
);
3818 store
.baselen
= strlen(new_name
);
3820 if (write_section(out_fd
, new_name
, &store
) < 0) {
3821 ret
= write_error(get_lock_file_path(&lock
));
3825 * We wrote out the new section, with
3826 * a newline, now skip the old
3829 output
+= offset
+ i
;
3830 if (strlen(output
) > 0) {
3832 * More content means there's
3833 * a declaration to put on the
3834 * next line; indent with a
3841 strbuf_release(©str
);
3842 copystr
= store_create_section(new_name
, &store
);
3849 length
= strlen(output
);
3851 if (!is_section
&& copystr
.len
> 0) {
3852 strbuf_add(©str
, output
, length
);
3855 if (write_in_full(out_fd
, output
, length
) < 0) {
3856 ret
= write_error(get_lock_file_path(&lock
));
3862 * Copy a trailing section at the end of the config, won't be
3863 * flushed by the usual "flush because we have a new section
3864 * logic in the loop above.
3866 if (copystr
.len
> 0) {
3867 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3868 ret
= write_error(get_lock_file_path(&lock
));
3871 strbuf_reset(©str
);
3874 fclose(config_file
);
3877 if (commit_lock_file(&lock
) < 0)
3878 ret
= error_errno(_("could not write config file %s"),
3882 fclose(config_file
);
3883 rollback_lock_file(&lock
);
3886 config_store_data_clear(&store
);
3887 strbuf_release(&buf
);
3888 strbuf_release(©str
);
3892 int git_config_rename_section_in_file(const char *config_filename
,
3893 const char *old_name
, const char *new_name
)
3895 return git_config_copy_or_rename_section_in_file(config_filename
,
3896 old_name
, new_name
, 0);
3899 int git_config_rename_section(const char *old_name
, const char *new_name
)
3901 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
3904 int git_config_copy_section_in_file(const char *config_filename
,
3905 const char *old_name
, const char *new_name
)
3907 return git_config_copy_or_rename_section_in_file(config_filename
,
3908 old_name
, new_name
, 1);
3911 int git_config_copy_section(const char *old_name
, const char *new_name
)
3913 return git_config_copy_section_in_file(NULL
, old_name
, new_name
);
3917 * Call this to report error for your variable that should not
3918 * get a boolean value (i.e. "[my] var" means "true").
3920 #undef config_error_nonbool
3921 int config_error_nonbool(const char *var
)
3923 return error(_("missing value for '%s'"), var
);
3926 int parse_config_key(const char *var
,
3927 const char *section
,
3928 const char **subsection
, size_t *subsection_len
,
3933 /* Does it start with "section." ? */
3934 if (!skip_prefix(var
, section
, &var
) || *var
!= '.')
3938 * Find the key; we don't know yet if we have a subsection, but we must
3939 * parse backwards from the end, since the subsection may have dots in
3942 dot
= strrchr(var
, '.');
3945 /* Did we have a subsection at all? */
3949 *subsection_len
= 0;
3955 *subsection
= var
+ 1;
3956 *subsection_len
= dot
- *subsection
;
3962 static int reader_origin_type(struct config_reader
*reader
,
3963 enum config_origin_type
*type
)
3965 if (the_reader
.config_kvi
)
3966 *type
= reader
->config_kvi
->origin_type
;
3967 else if(the_reader
.source
)
3968 *type
= reader
->source
->origin_type
;
3974 const char *current_config_origin_type(void)
3976 enum config_origin_type type
= CONFIG_ORIGIN_UNKNOWN
;
3978 if (reader_origin_type(&the_reader
, &type
))
3979 BUG("current_config_origin_type called outside config callback");
3982 case CONFIG_ORIGIN_BLOB
:
3984 case CONFIG_ORIGIN_FILE
:
3986 case CONFIG_ORIGIN_STDIN
:
3987 return "standard input";
3988 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
3989 return "submodule-blob";
3990 case CONFIG_ORIGIN_CMDLINE
:
3991 return "command line";
3993 BUG("unknown config origin type");
3997 const char *config_scope_name(enum config_scope scope
)
4000 case CONFIG_SCOPE_SYSTEM
:
4002 case CONFIG_SCOPE_GLOBAL
:
4004 case CONFIG_SCOPE_LOCAL
:
4006 case CONFIG_SCOPE_WORKTREE
:
4008 case CONFIG_SCOPE_COMMAND
:
4010 case CONFIG_SCOPE_SUBMODULE
:
4017 static int reader_config_name(struct config_reader
*reader
, const char **out
)
4019 if (the_reader
.config_kvi
)
4020 *out
= reader
->config_kvi
->filename
;
4021 else if (the_reader
.source
)
4022 *out
= reader
->source
->name
;
4028 const char *current_config_name(void)
4031 if (reader_config_name(&the_reader
, &name
))
4032 BUG("current_config_name called outside config callback");
4033 return name
? name
: "";
4036 enum config_scope
current_config_scope(void)
4038 if (the_reader
.config_kvi
)
4039 return the_reader
.config_kvi
->scope
;
4041 return the_reader
.parsing_scope
;
4044 int current_config_line(void)
4046 if (the_reader
.config_kvi
)
4047 return the_reader
.config_kvi
->linenr
;
4049 return the_reader
.source
->linenr
;
4052 int lookup_config(const char **mapping
, int nr_mapping
, const char *var
)
4056 for (i
= 0; i
< nr_mapping
; i
++) {
4057 const char *name
= mapping
[i
];
4059 if (name
&& !strcasecmp(var
, name
))