2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
11 #include "environment.h"
12 #include "repository.h"
18 #include "string-list.h"
19 #include "object-store.h"
25 struct config_source
{
26 struct config_source
*prev
;
35 enum config_origin_type origin_type
;
38 enum config_error_action default_error_action
;
44 unsigned subsection_case_sensitive
: 1;
46 int (*do_fgetc
)(struct config_source
*c
);
47 int (*do_ungetc
)(int c
, struct config_source
*conf
);
48 long (*do_ftell
)(struct config_source
*c
);
52 * These variables record the "current" config source, which
53 * can be accessed by parsing callbacks.
55 * The "cf" variable will be non-NULL only when we are actually parsing a real
56 * config source (file, blob, cmdline, etc).
58 * The "current_config_kvi" variable will be non-NULL only when we are feeding
59 * cached config from a configset into a callback.
61 * They should generally never be non-NULL at the same time. If they are both
62 * NULL, then we aren't parsing anything (and depending on the function looking
63 * at the variables, it's either a bug for it to be called in the first place,
64 * or it's a function which can be reused for non-config purposes, and should
65 * fall back to some sane behavior).
67 static struct config_source
*cf
;
68 static struct key_value_info
*current_config_kvi
;
71 * Similar to the variables above, this gives access to the "scope" of the
72 * current value (repo, global, etc). For cached values, it can be found via
73 * the current_config_kvi as above. During parsing, the current value can be
74 * found in this variable. It's not part of "cf" because it transcends a single
75 * file (i.e., a file included from .git/config is still in "repo" scope).
77 static enum config_scope current_parsing_scope
;
79 static int pack_compression_seen
;
80 static int zlib_compression_seen
;
82 static int config_file_fgetc(struct config_source
*conf
)
84 return getc_unlocked(conf
->u
.file
);
87 static int config_file_ungetc(int c
, struct config_source
*conf
)
89 return ungetc(c
, conf
->u
.file
);
92 static long config_file_ftell(struct config_source
*conf
)
94 return ftell(conf
->u
.file
);
98 static int config_buf_fgetc(struct config_source
*conf
)
100 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
101 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
106 static int config_buf_ungetc(int c
, struct config_source
*conf
)
108 if (conf
->u
.buf
.pos
> 0) {
110 if (conf
->u
.buf
.buf
[conf
->u
.buf
.pos
] != c
)
111 BUG("config_buf can only ungetc the same character");
118 static long config_buf_ftell(struct config_source
*conf
)
120 return conf
->u
.buf
.pos
;
123 #define MAX_INCLUDE_DEPTH 10
124 static const char include_depth_advice
[] = N_(
125 "exceeded maximum include depth (%d) while including\n"
129 "This might be due to circular includes.");
130 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
133 struct strbuf buf
= STRBUF_INIT
;
137 return config_error_nonbool("include.path");
139 expanded
= interpolate_path(path
, 0);
141 return error(_("could not expand include path '%s'"), path
);
145 * Use an absolute path as-is, but interpret relative paths
146 * based on the including config file.
148 if (!is_absolute_path(path
)) {
151 if (!cf
|| !cf
->path
)
152 return error(_("relative config includes must come from files"));
154 slash
= find_last_dir_sep(cf
->path
);
156 strbuf_add(&buf
, cf
->path
, slash
- cf
->path
+ 1);
157 strbuf_addstr(&buf
, path
);
161 if (!access_or_die(path
, R_OK
, 0)) {
162 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
163 die(_(include_depth_advice
), MAX_INCLUDE_DEPTH
, path
,
165 cf
->name
? cf
->name
:
167 ret
= git_config_from_file(git_config_include
, path
, inc
);
170 strbuf_release(&buf
);
175 static void add_trailing_starstar_for_dir(struct strbuf
*pat
)
177 if (pat
->len
&& is_dir_sep(pat
->buf
[pat
->len
- 1]))
178 strbuf_addstr(pat
, "**");
181 static int prepare_include_condition_pattern(struct strbuf
*pat
)
183 struct strbuf path
= STRBUF_INIT
;
187 expanded
= interpolate_path(pat
->buf
, 1);
190 strbuf_addstr(pat
, expanded
);
194 if (pat
->buf
[0] == '.' && is_dir_sep(pat
->buf
[1])) {
197 if (!cf
|| !cf
->path
)
198 return error(_("relative config include "
199 "conditionals must come from files"));
201 strbuf_realpath(&path
, cf
->path
, 1);
202 slash
= find_last_dir_sep(path
.buf
);
204 BUG("how is this possible?");
205 strbuf_splice(pat
, 0, 1, path
.buf
, slash
- path
.buf
);
206 prefix
= slash
- path
.buf
+ 1 /* slash */;
207 } else if (!is_absolute_path(pat
->buf
))
208 strbuf_insertstr(pat
, 0, "**/");
210 add_trailing_starstar_for_dir(pat
);
212 strbuf_release(&path
);
216 static int include_by_gitdir(const struct config_options
*opts
,
217 const char *cond
, size_t cond_len
, int icase
)
219 struct strbuf text
= STRBUF_INIT
;
220 struct strbuf pattern
= STRBUF_INIT
;
223 int already_tried_absolute
= 0;
226 git_dir
= opts
->git_dir
;
230 strbuf_realpath(&text
, git_dir
, 1);
231 strbuf_add(&pattern
, cond
, cond_len
);
232 prefix
= prepare_include_condition_pattern(&pattern
);
240 * perform literal matching on the prefix part so that
241 * any wildcard character in it can't create side effects.
243 if (text
.len
< prefix
)
245 if (!icase
&& strncmp(pattern
.buf
, text
.buf
, prefix
))
247 if (icase
&& strncasecmp(pattern
.buf
, text
.buf
, prefix
))
251 ret
= !wildmatch(pattern
.buf
+ prefix
, text
.buf
+ prefix
,
252 WM_PATHNAME
| (icase
? WM_CASEFOLD
: 0));
254 if (!ret
&& !already_tried_absolute
) {
256 * We've tried e.g. matching gitdir:~/work, but if
257 * ~/work is a symlink to /mnt/storage/work
258 * strbuf_realpath() will expand it, so the rule won't
259 * match. Let's match against a
260 * strbuf_add_absolute_path() version of the path,
261 * which'll do the right thing
264 strbuf_add_absolute_path(&text
, git_dir
);
265 already_tried_absolute
= 1;
269 strbuf_release(&pattern
);
270 strbuf_release(&text
);
274 static int include_by_branch(const char *cond
, size_t cond_len
)
278 struct strbuf pattern
= STRBUF_INIT
;
279 const char *refname
= !the_repository
->gitdir
?
280 NULL
: resolve_ref_unsafe("HEAD", 0, NULL
, &flags
);
281 const char *shortname
;
283 if (!refname
|| !(flags
& REF_ISSYMREF
) ||
284 !skip_prefix(refname
, "refs/heads/", &shortname
))
287 strbuf_add(&pattern
, cond
, cond_len
);
288 add_trailing_starstar_for_dir(&pattern
);
289 ret
= !wildmatch(pattern
.buf
, shortname
, WM_PATHNAME
);
290 strbuf_release(&pattern
);
294 static int include_condition_is_true(const struct config_options
*opts
,
295 const char *cond
, size_t cond_len
)
298 if (skip_prefix_mem(cond
, cond_len
, "gitdir:", &cond
, &cond_len
))
299 return include_by_gitdir(opts
, cond
, cond_len
, 0);
300 else if (skip_prefix_mem(cond
, cond_len
, "gitdir/i:", &cond
, &cond_len
))
301 return include_by_gitdir(opts
, cond
, cond_len
, 1);
302 else if (skip_prefix_mem(cond
, cond_len
, "onbranch:", &cond
, &cond_len
))
303 return include_by_branch(cond
, cond_len
);
305 /* unknown conditionals are always false */
309 int git_config_include(const char *var
, const char *value
, void *data
)
311 struct config_include_data
*inc
= data
;
312 const char *cond
, *key
;
317 * Pass along all values, including "include" directives; this makes it
318 * possible to query information on the includes themselves.
320 ret
= inc
->fn(var
, value
, inc
->data
);
324 if (!strcmp(var
, "include.path"))
325 ret
= handle_path_include(value
, inc
);
327 if (!parse_config_key(var
, "includeif", &cond
, &cond_len
, &key
) &&
328 (cond
&& include_condition_is_true(inc
->opts
, cond
, cond_len
)) &&
329 !strcmp(key
, "path"))
330 ret
= handle_path_include(value
, inc
);
335 static void git_config_push_split_parameter(const char *key
, const char *value
)
337 struct strbuf env
= STRBUF_INIT
;
338 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
340 strbuf_addstr(&env
, old
);
341 strbuf_addch(&env
, ' ');
343 sq_quote_buf(&env
, key
);
344 strbuf_addch(&env
, '=');
346 sq_quote_buf(&env
, value
);
347 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
348 strbuf_release(&env
);
351 void git_config_push_parameter(const char *text
)
358 * section.subsection=with=equals.key=value
360 * we cannot tell if it means:
362 * [section "subsection=with=equals"]
368 * subsection = with=equals.key=value
370 * We parse left-to-right for the first "=", meaning we'll prefer to
371 * keep the value intact over the subsection. This is historical, but
372 * also sensible since values are more likely to contain odd or
373 * untrusted input than a section name.
375 * A missing equals is explicitly allowed (as a bool-only entry).
377 value
= strchr(text
, '=');
379 char *key
= xmemdupz(text
, value
- text
);
380 git_config_push_split_parameter(key
, value
+ 1);
383 git_config_push_split_parameter(text
, NULL
);
387 void git_config_push_env(const char *spec
)
390 const char *env_name
;
391 const char *env_value
;
393 env_name
= strrchr(spec
, '=');
395 die(_("invalid config format: %s"), spec
);
396 key
= xmemdupz(spec
, env_name
- spec
);
399 die(_("missing environment variable name for configuration '%.*s'"),
400 (int)(env_name
- spec
- 1), spec
);
402 env_value
= getenv(env_name
);
404 die(_("missing environment variable '%s' for configuration '%.*s'"),
405 env_name
, (int)(env_name
- spec
- 1), spec
);
407 git_config_push_split_parameter(key
, env_value
);
411 static inline int iskeychar(int c
)
413 return isalnum(c
) || c
== '-';
417 * Auxiliary function to sanity-check and split the key into the section
418 * identifier and variable name.
420 * Returns 0 on success, -1 when there is an invalid character in the key and
421 * -2 if there is no section name in the key.
423 * store_key - pointer to char* which will hold a copy of the key with
424 * lowercase section and variable name
425 * baselen - pointer to size_t which will hold the length of the
426 * section + subsection part, can be NULL
428 static int git_config_parse_key_1(const char *key
, char **store_key
, size_t *baselen_
, int quiet
)
432 const char *last_dot
= strrchr(key
, '.');
435 * Since "key" actually contains the section name and the real
436 * key name separated by a dot, we have to know where the dot is.
439 if (last_dot
== NULL
|| last_dot
== key
) {
441 error(_("key does not contain a section: %s"), key
);
442 return -CONFIG_NO_SECTION_OR_NAME
;
447 error(_("key does not contain variable name: %s"), key
);
448 return -CONFIG_NO_SECTION_OR_NAME
;
451 baselen
= last_dot
- key
;
456 * Validate the key and while at it, lower case it for matching.
459 *store_key
= xmallocz(strlen(key
));
462 for (i
= 0; key
[i
]; i
++) {
463 unsigned char c
= key
[i
];
466 /* Leave the extended basename untouched.. */
467 if (!dot
|| i
> baselen
) {
469 (i
== baselen
+ 1 && !isalpha(c
))) {
471 error(_("invalid key: %s"), key
);
475 } else if (c
== '\n') {
477 error(_("invalid key (newline): %s"), key
);
488 FREE_AND_NULL(*store_key
);
490 return -CONFIG_INVALID_KEY
;
493 int git_config_parse_key(const char *key
, char **store_key
, size_t *baselen
)
495 return git_config_parse_key_1(key
, store_key
, baselen
, 0);
498 int git_config_key_is_valid(const char *key
)
500 return !git_config_parse_key_1(key
, NULL
, NULL
, 1);
503 static int config_parse_pair(const char *key
, const char *value
,
504 config_fn_t fn
, void *data
)
506 char *canonical_name
;
510 return error(_("empty config key"));
511 if (git_config_parse_key(key
, &canonical_name
, NULL
))
514 ret
= (fn(canonical_name
, value
, data
) < 0) ? -1 : 0;
515 free(canonical_name
);
519 int git_config_parse_parameter(const char *text
,
520 config_fn_t fn
, void *data
)
523 struct strbuf
**pair
;
526 pair
= strbuf_split_str(text
, '=', 2);
528 return error(_("bogus config parameter: %s"), text
);
530 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
531 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
532 value
= pair
[1] ? pair
[1]->buf
: "";
537 strbuf_trim(pair
[0]);
539 strbuf_list_free(pair
);
540 return error(_("bogus config parameter: %s"), text
);
543 ret
= config_parse_pair(pair
[0]->buf
, value
, fn
, data
);
544 strbuf_list_free(pair
);
548 static int parse_config_env_list(char *env
, config_fn_t fn
, void *data
)
551 while (cur
&& *cur
) {
552 const char *key
= sq_dequote_step(cur
, &cur
);
554 return error(_("bogus format in %s"),
555 CONFIG_DATA_ENVIRONMENT
);
557 if (!cur
|| isspace(*cur
)) {
558 /* old-style 'key=value' */
559 if (git_config_parse_parameter(key
, fn
, data
) < 0)
562 else if (*cur
== '=') {
563 /* new-style 'key'='value' */
569 value
= sq_dequote_step(cur
, &cur
);
570 if (!value
|| (cur
&& !isspace(*cur
))) {
571 return error(_("bogus format in %s"),
572 CONFIG_DATA_ENVIRONMENT
);
574 } else if (!*cur
|| isspace(*cur
)) {
575 /* implicit bool: 'key'= */
578 return error(_("bogus format in %s"),
579 CONFIG_DATA_ENVIRONMENT
);
582 if (config_parse_pair(key
, value
, fn
, data
) < 0)
587 return error(_("bogus format in %s"),
588 CONFIG_DATA_ENVIRONMENT
);
592 while (isspace(*cur
))
599 int git_config_from_parameters(config_fn_t fn
, void *data
)
602 struct strbuf envvar
= STRBUF_INIT
;
603 struct strvec to_free
= STRVEC_INIT
;
606 struct config_source source
;
608 memset(&source
, 0, sizeof(source
));
610 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
613 env
= getenv(CONFIG_COUNT_ENVIRONMENT
);
619 count
= strtoul(env
, &endp
, 10);
621 ret
= error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT
);
624 if (count
> INT_MAX
) {
625 ret
= error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT
);
629 for (i
= 0; i
< count
; i
++) {
630 const char *key
, *value
;
632 strbuf_addf(&envvar
, "GIT_CONFIG_KEY_%d", i
);
633 key
= getenv_safe(&to_free
, envvar
.buf
);
635 ret
= error(_("missing config key %s"), envvar
.buf
);
638 strbuf_reset(&envvar
);
640 strbuf_addf(&envvar
, "GIT_CONFIG_VALUE_%d", i
);
641 value
= getenv_safe(&to_free
, envvar
.buf
);
643 ret
= error(_("missing config value %s"), envvar
.buf
);
646 strbuf_reset(&envvar
);
648 if (config_parse_pair(key
, value
, fn
, data
) < 0) {
655 env
= getenv(CONFIG_DATA_ENVIRONMENT
);
657 /* sq_dequote will write over it */
659 if (parse_config_env_list(envw
, fn
, data
) < 0) {
666 strbuf_release(&envvar
);
667 strvec_clear(&to_free
);
673 static int get_next_char(void)
675 int c
= cf
->do_fgetc(cf
);
678 /* DOS like systems */
679 c
= cf
->do_fgetc(cf
);
682 cf
->do_ungetc(c
, cf
);
687 if (c
!= EOF
&& ++cf
->total_len
> INT_MAX
) {
689 * This is an absurdly long config file; refuse to parse
690 * further in order to protect downstream code from integer
691 * overflows. Note that we can't return an error specifically,
692 * but we can mark EOF and put trash in the return value,
693 * which will trigger a parse error.
709 static char *parse_value(void)
711 int quote
= 0, comment
= 0, space
= 0;
713 strbuf_reset(&cf
->value
);
715 int c
= get_next_char();
721 return cf
->value
.buf
;
725 if (isspace(c
) && !quote
) {
731 if (c
== ';' || c
== '#') {
736 for (; space
; space
--)
737 strbuf_addch(&cf
->value
, ' ');
752 /* Some characters escape as themselves */
755 /* Reject unknown escape sequences */
759 strbuf_addch(&cf
->value
, c
);
766 strbuf_addch(&cf
->value
, c
);
770 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
776 /* Get the full name */
783 strbuf_addch(name
, tolower(c
));
786 while (c
== ' ' || c
== '\t')
793 value
= parse_value();
798 * We already consumed the \n, but we need linenr to point to
799 * the line we just parsed during the call to fn to get
800 * accurate line number in error messages.
803 ret
= fn(name
->buf
, value
, data
);
809 static int get_extended_base_var(struct strbuf
*name
, int c
)
811 cf
->subsection_case_sensitive
= 0;
814 goto error_incomplete_line
;
816 } while (isspace(c
));
818 /* We require the format to be '[base "extension"]' */
821 strbuf_addch(name
, '.');
824 int c
= get_next_char();
826 goto error_incomplete_line
;
832 goto error_incomplete_line
;
834 strbuf_addch(name
, c
);
838 if (get_next_char() != ']')
841 error_incomplete_line
:
846 static int get_base_var(struct strbuf
*name
)
848 cf
->subsection_case_sensitive
= 1;
850 int c
= get_next_char();
856 return get_extended_base_var(name
, c
);
857 if (!iskeychar(c
) && c
!= '.')
859 strbuf_addch(name
, tolower(c
));
863 struct parse_event_data
{
864 enum config_event_t previous_type
;
865 size_t previous_offset
;
866 const struct config_options
*opts
;
869 static int do_event(enum config_event_t type
, struct parse_event_data
*data
)
873 if (!data
->opts
|| !data
->opts
->event_fn
)
876 if (type
== CONFIG_EVENT_WHITESPACE
&&
877 data
->previous_type
== type
)
880 offset
= cf
->do_ftell(cf
);
882 * At EOF, the parser always "inserts" an extra '\n', therefore
883 * the end offset of the event is the current file position, otherwise
884 * we will already have advanced to the next event.
886 if (type
!= CONFIG_EVENT_EOF
)
889 if (data
->previous_type
!= CONFIG_EVENT_EOF
&&
890 data
->opts
->event_fn(data
->previous_type
, data
->previous_offset
,
891 offset
, data
->opts
->event_fn_data
) < 0)
894 data
->previous_type
= type
;
895 data
->previous_offset
= offset
;
900 static int git_parse_source(config_fn_t fn
, void *data
,
901 const struct config_options
*opts
)
905 struct strbuf
*var
= &cf
->var
;
906 int error_return
= 0;
907 char *error_msg
= NULL
;
909 /* U+FEFF Byte Order Mark in UTF8 */
910 const char *bomptr
= utf8_bom
;
912 /* For the parser event callback */
913 struct parse_event_data event_data
= {
914 CONFIG_EVENT_EOF
, 0, opts
921 if (bomptr
&& *bomptr
) {
922 /* We are at the file beginning; skip UTF8-encoded BOM
923 * if present. Sane editors won't put this in on their
924 * own, but e.g. Windows Notepad will do it happily. */
925 if (c
== (*bomptr
& 0377)) {
929 /* Do not tolerate partial BOM. */
930 if (bomptr
!= utf8_bom
)
932 /* No BOM at file beginning. Cool. */
938 if (do_event(CONFIG_EVENT_EOF
, &event_data
) < 0)
942 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
950 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
954 if (c
== '#' || c
== ';') {
955 if (do_event(CONFIG_EVENT_COMMENT
, &event_data
) < 0)
961 if (do_event(CONFIG_EVENT_SECTION
, &event_data
) < 0)
964 /* Reset prior to determining a new stem */
966 if (get_base_var(var
) < 0 || var
->len
< 1)
968 strbuf_addch(var
, '.');
975 if (do_event(CONFIG_EVENT_ENTRY
, &event_data
) < 0)
979 * Truncate the var name back to the section header
980 * stem prior to grabbing the suffix part of the name
983 strbuf_setlen(var
, baselen
);
984 strbuf_addch(var
, tolower(c
));
985 if (get_value(fn
, data
, var
) < 0)
989 if (do_event(CONFIG_EVENT_ERROR
, &event_data
) < 0)
992 switch (cf
->origin_type
) {
993 case CONFIG_ORIGIN_BLOB
:
994 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
995 cf
->linenr
, cf
->name
);
997 case CONFIG_ORIGIN_FILE
:
998 error_msg
= xstrfmt(_("bad config line %d in file %s"),
999 cf
->linenr
, cf
->name
);
1001 case CONFIG_ORIGIN_STDIN
:
1002 error_msg
= xstrfmt(_("bad config line %d in standard input"),
1005 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1006 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
1007 cf
->linenr
, cf
->name
);
1009 case CONFIG_ORIGIN_CMDLINE
:
1010 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
1011 cf
->linenr
, cf
->name
);
1014 error_msg
= xstrfmt(_("bad config line %d in %s"),
1015 cf
->linenr
, cf
->name
);
1018 switch (opts
&& opts
->error_action
?
1019 opts
->error_action
:
1020 cf
->default_error_action
) {
1021 case CONFIG_ERROR_DIE
:
1022 die("%s", error_msg
);
1024 case CONFIG_ERROR_ERROR
:
1025 error_return
= error("%s", error_msg
);
1027 case CONFIG_ERROR_SILENT
:
1030 case CONFIG_ERROR_UNSET
:
1031 BUG("config error action unset");
1035 return error_return
;
1038 static uintmax_t get_unit_factor(const char *end
)
1042 else if (!strcasecmp(end
, "k"))
1044 else if (!strcasecmp(end
, "m"))
1046 else if (!strcasecmp(end
, "g"))
1047 return 1024 * 1024 * 1024;
1051 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
1053 if (value
&& *value
) {
1060 val
= strtoimax(value
, &end
, 0);
1061 if (errno
== ERANGE
)
1063 factor
= get_unit_factor(end
);
1068 uval
= val
< 0 ? -val
: val
;
1069 if (unsigned_mult_overflows(factor
, uval
) ||
1070 factor
* uval
> max
) {
1082 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
1084 if (value
&& *value
) {
1090 val
= strtoumax(value
, &end
, 0);
1091 if (errno
== ERANGE
)
1093 factor
= get_unit_factor(end
);
1098 if (unsigned_mult_overflows(factor
, val
) ||
1099 factor
* val
> max
) {
1111 static int git_parse_int(const char *value
, int *ret
)
1114 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
1120 static int git_parse_int64(const char *value
, int64_t *ret
)
1123 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
1129 int git_parse_ulong(const char *value
, unsigned long *ret
)
1132 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
1138 int git_parse_ssize_t(const char *value
, ssize_t
*ret
)
1141 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(ssize_t
)))
1148 static void die_bad_number(const char *name
, const char *value
)
1150 const char *error_type
= (errno
== ERANGE
) ?
1151 N_("out of range") : N_("invalid unit");
1152 const char *bad_numeric
= N_("bad numeric config value '%s' for '%s': %s");
1157 if (!(cf
&& cf
->name
))
1158 die(_(bad_numeric
), value
, name
, _(error_type
));
1160 switch (cf
->origin_type
) {
1161 case CONFIG_ORIGIN_BLOB
:
1162 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1163 value
, name
, cf
->name
, _(error_type
));
1164 case CONFIG_ORIGIN_FILE
:
1165 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1166 value
, name
, cf
->name
, _(error_type
));
1167 case CONFIG_ORIGIN_STDIN
:
1168 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1169 value
, name
, _(error_type
));
1170 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1171 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1172 value
, name
, cf
->name
, _(error_type
));
1173 case CONFIG_ORIGIN_CMDLINE
:
1174 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1175 value
, name
, cf
->name
, _(error_type
));
1177 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1178 value
, name
, cf
->name
, _(error_type
));
1182 int git_config_int(const char *name
, const char *value
)
1185 if (!git_parse_int(value
, &ret
))
1186 die_bad_number(name
, value
);
1190 int64_t git_config_int64(const char *name
, const char *value
)
1193 if (!git_parse_int64(value
, &ret
))
1194 die_bad_number(name
, value
);
1198 unsigned long git_config_ulong(const char *name
, const char *value
)
1201 if (!git_parse_ulong(value
, &ret
))
1202 die_bad_number(name
, value
);
1206 ssize_t
git_config_ssize_t(const char *name
, const char *value
)
1209 if (!git_parse_ssize_t(value
, &ret
))
1210 die_bad_number(name
, value
);
1214 static int git_parse_maybe_bool_text(const char *value
)
1220 if (!strcasecmp(value
, "true")
1221 || !strcasecmp(value
, "yes")
1222 || !strcasecmp(value
, "on"))
1224 if (!strcasecmp(value
, "false")
1225 || !strcasecmp(value
, "no")
1226 || !strcasecmp(value
, "off"))
1231 int git_parse_maybe_bool(const char *value
)
1233 int v
= git_parse_maybe_bool_text(value
);
1236 if (git_parse_int(value
, &v
))
1241 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
1243 int v
= git_parse_maybe_bool_text(value
);
1249 return git_config_int(name
, value
);
1252 int git_config_bool(const char *name
, const char *value
)
1254 int v
= git_parse_maybe_bool(value
);
1256 die(_("bad boolean config value '%s' for '%s'"), value
, name
);
1260 int git_config_string(const char **dest
, const char *var
, const char *value
)
1263 return config_error_nonbool(var
);
1264 *dest
= xstrdup(value
);
1268 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
1271 return config_error_nonbool(var
);
1272 *dest
= interpolate_path(value
, 0);
1274 die(_("failed to expand user dir in: '%s'"), value
);
1278 int git_config_expiry_date(timestamp_t
*timestamp
, const char *var
, const char *value
)
1281 return config_error_nonbool(var
);
1282 if (parse_expiry_date(value
, timestamp
))
1283 return error(_("'%s' for '%s' is not a valid timestamp"),
1288 int git_config_color(char *dest
, const char *var
, const char *value
)
1291 return config_error_nonbool(var
);
1292 if (color_parse(value
, dest
) < 0)
1297 static int git_default_core_config(const char *var
, const char *value
, void *cb
)
1299 /* This needs a better name */
1300 if (!strcmp(var
, "core.filemode")) {
1301 trust_executable_bit
= git_config_bool(var
, value
);
1304 if (!strcmp(var
, "core.trustctime")) {
1305 trust_ctime
= git_config_bool(var
, value
);
1308 if (!strcmp(var
, "core.checkstat")) {
1309 if (!strcasecmp(value
, "default"))
1311 else if (!strcasecmp(value
, "minimal"))
1315 if (!strcmp(var
, "core.quotepath")) {
1316 quote_path_fully
= git_config_bool(var
, value
);
1320 if (!strcmp(var
, "core.symlinks")) {
1321 has_symlinks
= git_config_bool(var
, value
);
1325 if (!strcmp(var
, "core.ignorecase")) {
1326 ignore_case
= git_config_bool(var
, value
);
1330 if (!strcmp(var
, "core.attributesfile"))
1331 return git_config_pathname(&git_attributes_file
, var
, value
);
1333 if (!strcmp(var
, "core.hookspath"))
1334 return git_config_pathname(&git_hooks_path
, var
, value
);
1336 if (!strcmp(var
, "core.bare")) {
1337 is_bare_repository_cfg
= git_config_bool(var
, value
);
1341 if (!strcmp(var
, "core.ignorestat")) {
1342 assume_unchanged
= git_config_bool(var
, value
);
1346 if (!strcmp(var
, "core.prefersymlinkrefs")) {
1347 prefer_symlink_refs
= git_config_bool(var
, value
);
1351 if (!strcmp(var
, "core.logallrefupdates")) {
1352 if (value
&& !strcasecmp(value
, "always"))
1353 log_all_ref_updates
= LOG_REFS_ALWAYS
;
1354 else if (git_config_bool(var
, value
))
1355 log_all_ref_updates
= LOG_REFS_NORMAL
;
1357 log_all_ref_updates
= LOG_REFS_NONE
;
1361 if (!strcmp(var
, "core.warnambiguousrefs")) {
1362 warn_ambiguous_refs
= git_config_bool(var
, value
);
1366 if (!strcmp(var
, "core.abbrev")) {
1368 return config_error_nonbool(var
);
1369 if (!strcasecmp(value
, "auto"))
1370 default_abbrev
= -1;
1371 else if (!git_parse_maybe_bool_text(value
))
1372 default_abbrev
= the_hash_algo
->hexsz
;
1374 int abbrev
= git_config_int(var
, value
);
1375 if (abbrev
< minimum_abbrev
|| abbrev
> the_hash_algo
->hexsz
)
1376 return error(_("abbrev length out of range: %d"), abbrev
);
1377 default_abbrev
= abbrev
;
1382 if (!strcmp(var
, "core.disambiguate"))
1383 return set_disambiguate_hint_config(var
, value
);
1385 if (!strcmp(var
, "core.loosecompression")) {
1386 int level
= git_config_int(var
, value
);
1388 level
= Z_DEFAULT_COMPRESSION
;
1389 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1390 die(_("bad zlib compression level %d"), level
);
1391 zlib_compression_level
= level
;
1392 zlib_compression_seen
= 1;
1396 if (!strcmp(var
, "core.compression")) {
1397 int level
= git_config_int(var
, value
);
1399 level
= Z_DEFAULT_COMPRESSION
;
1400 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1401 die(_("bad zlib compression level %d"), level
);
1402 if (!zlib_compression_seen
)
1403 zlib_compression_level
= level
;
1404 if (!pack_compression_seen
)
1405 pack_compression_level
= level
;
1409 if (!strcmp(var
, "core.packedgitwindowsize")) {
1410 int pgsz_x2
= getpagesize() * 2;
1411 packed_git_window_size
= git_config_ulong(var
, value
);
1413 /* This value must be multiple of (pagesize * 2) */
1414 packed_git_window_size
/= pgsz_x2
;
1415 if (packed_git_window_size
< 1)
1416 packed_git_window_size
= 1;
1417 packed_git_window_size
*= pgsz_x2
;
1421 if (!strcmp(var
, "core.bigfilethreshold")) {
1422 big_file_threshold
= git_config_ulong(var
, value
);
1426 if (!strcmp(var
, "core.packedgitlimit")) {
1427 packed_git_limit
= git_config_ulong(var
, value
);
1431 if (!strcmp(var
, "core.deltabasecachelimit")) {
1432 delta_base_cache_limit
= git_config_ulong(var
, value
);
1436 if (!strcmp(var
, "core.autocrlf")) {
1437 if (value
&& !strcasecmp(value
, "input")) {
1438 auto_crlf
= AUTO_CRLF_INPUT
;
1441 auto_crlf
= git_config_bool(var
, value
);
1445 if (!strcmp(var
, "core.safecrlf")) {
1447 if (value
&& !strcasecmp(value
, "warn")) {
1448 global_conv_flags_eol
= CONV_EOL_RNDTRP_WARN
;
1451 eol_rndtrp_die
= git_config_bool(var
, value
);
1452 global_conv_flags_eol
= eol_rndtrp_die
?
1453 CONV_EOL_RNDTRP_DIE
: 0;
1457 if (!strcmp(var
, "core.eol")) {
1458 if (value
&& !strcasecmp(value
, "lf"))
1460 else if (value
&& !strcasecmp(value
, "crlf"))
1461 core_eol
= EOL_CRLF
;
1462 else if (value
&& !strcasecmp(value
, "native"))
1463 core_eol
= EOL_NATIVE
;
1465 core_eol
= EOL_UNSET
;
1469 if (!strcmp(var
, "core.checkroundtripencoding")) {
1470 check_roundtrip_encoding
= xstrdup(value
);
1474 if (!strcmp(var
, "core.notesref")) {
1475 notes_ref_name
= xstrdup(value
);
1479 if (!strcmp(var
, "core.editor"))
1480 return git_config_string(&editor_program
, var
, value
);
1482 if (!strcmp(var
, "core.commentchar")) {
1484 return config_error_nonbool(var
);
1485 else if (!strcasecmp(value
, "auto"))
1486 auto_comment_line_char
= 1;
1487 else if (value
[0] && !value
[1]) {
1488 comment_line_char
= value
[0];
1489 auto_comment_line_char
= 0;
1491 return error(_("core.commentChar should only be one character"));
1495 if (!strcmp(var
, "core.askpass"))
1496 return git_config_string(&askpass_program
, var
, value
);
1498 if (!strcmp(var
, "core.excludesfile"))
1499 return git_config_pathname(&excludes_file
, var
, value
);
1501 if (!strcmp(var
, "core.whitespace")) {
1503 return config_error_nonbool(var
);
1504 whitespace_rule_cfg
= parse_whitespace_rule(value
);
1508 if (!strcmp(var
, "core.fsyncobjectfiles")) {
1509 fsync_object_files
= git_config_bool(var
, value
);
1513 if (!strcmp(var
, "core.preloadindex")) {
1514 core_preload_index
= git_config_bool(var
, value
);
1518 if (!strcmp(var
, "core.createobject")) {
1519 if (!strcmp(value
, "rename"))
1520 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
1521 else if (!strcmp(value
, "link"))
1522 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
1524 die(_("invalid mode for object creation: %s"), value
);
1528 if (!strcmp(var
, "core.sparsecheckout")) {
1529 core_apply_sparse_checkout
= git_config_bool(var
, value
);
1533 if (!strcmp(var
, "core.sparsecheckoutcone")) {
1534 core_sparse_checkout_cone
= git_config_bool(var
, value
);
1538 if (!strcmp(var
, "core.precomposeunicode")) {
1539 precomposed_unicode
= git_config_bool(var
, value
);
1543 if (!strcmp(var
, "core.protecthfs")) {
1544 protect_hfs
= git_config_bool(var
, value
);
1548 if (!strcmp(var
, "core.protectntfs")) {
1549 protect_ntfs
= git_config_bool(var
, value
);
1553 if (!strcmp(var
, "core.usereplacerefs")) {
1554 read_replace_refs
= git_config_bool(var
, value
);
1558 /* Add other config variables here and to Documentation/config.txt. */
1559 return platform_core_config(var
, value
, cb
);
1562 static int git_default_i18n_config(const char *var
, const char *value
)
1564 if (!strcmp(var
, "i18n.commitencoding"))
1565 return git_config_string(&git_commit_encoding
, var
, value
);
1567 if (!strcmp(var
, "i18n.logoutputencoding"))
1568 return git_config_string(&git_log_output_encoding
, var
, value
);
1570 /* Add other config variables here and to Documentation/config.txt. */
1574 static int git_default_branch_config(const char *var
, const char *value
)
1576 if (!strcmp(var
, "branch.autosetupmerge")) {
1577 if (value
&& !strcasecmp(value
, "always")) {
1578 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1581 git_branch_track
= git_config_bool(var
, value
);
1584 if (!strcmp(var
, "branch.autosetuprebase")) {
1586 return config_error_nonbool(var
);
1587 else if (!strcmp(value
, "never"))
1588 autorebase
= AUTOREBASE_NEVER
;
1589 else if (!strcmp(value
, "local"))
1590 autorebase
= AUTOREBASE_LOCAL
;
1591 else if (!strcmp(value
, "remote"))
1592 autorebase
= AUTOREBASE_REMOTE
;
1593 else if (!strcmp(value
, "always"))
1594 autorebase
= AUTOREBASE_ALWAYS
;
1596 return error(_("malformed value for %s"), var
);
1600 /* Add other config variables here and to Documentation/config.txt. */
1604 static int git_default_push_config(const char *var
, const char *value
)
1606 if (!strcmp(var
, "push.default")) {
1608 return config_error_nonbool(var
);
1609 else if (!strcmp(value
, "nothing"))
1610 push_default
= PUSH_DEFAULT_NOTHING
;
1611 else if (!strcmp(value
, "matching"))
1612 push_default
= PUSH_DEFAULT_MATCHING
;
1613 else if (!strcmp(value
, "simple"))
1614 push_default
= PUSH_DEFAULT_SIMPLE
;
1615 else if (!strcmp(value
, "upstream"))
1616 push_default
= PUSH_DEFAULT_UPSTREAM
;
1617 else if (!strcmp(value
, "tracking")) /* deprecated */
1618 push_default
= PUSH_DEFAULT_UPSTREAM
;
1619 else if (!strcmp(value
, "current"))
1620 push_default
= PUSH_DEFAULT_CURRENT
;
1622 error(_("malformed value for %s: %s"), var
, value
);
1623 return error(_("must be one of nothing, matching, simple, "
1624 "upstream or current"));
1629 /* Add other config variables here and to Documentation/config.txt. */
1633 static int git_default_mailmap_config(const char *var
, const char *value
)
1635 if (!strcmp(var
, "mailmap.file"))
1636 return git_config_pathname(&git_mailmap_file
, var
, value
);
1637 if (!strcmp(var
, "mailmap.blob"))
1638 return git_config_string(&git_mailmap_blob
, var
, value
);
1640 /* Add other config variables here and to Documentation/config.txt. */
1644 int git_default_config(const char *var
, const char *value
, void *cb
)
1646 if (starts_with(var
, "core."))
1647 return git_default_core_config(var
, value
, cb
);
1649 if (starts_with(var
, "user.") ||
1650 starts_with(var
, "author.") ||
1651 starts_with(var
, "committer."))
1652 return git_ident_config(var
, value
, cb
);
1654 if (starts_with(var
, "i18n."))
1655 return git_default_i18n_config(var
, value
);
1657 if (starts_with(var
, "branch."))
1658 return git_default_branch_config(var
, value
);
1660 if (starts_with(var
, "push."))
1661 return git_default_push_config(var
, value
);
1663 if (starts_with(var
, "mailmap."))
1664 return git_default_mailmap_config(var
, value
);
1666 if (starts_with(var
, "advice.") || starts_with(var
, "color.advice"))
1667 return git_default_advice_config(var
, value
);
1669 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1670 pager_use_color
= git_config_bool(var
,value
);
1674 if (!strcmp(var
, "pack.packsizelimit")) {
1675 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1679 if (!strcmp(var
, "pack.compression")) {
1680 int level
= git_config_int(var
, value
);
1682 level
= Z_DEFAULT_COMPRESSION
;
1683 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1684 die(_("bad pack compression level %d"), level
);
1685 pack_compression_level
= level
;
1686 pack_compression_seen
= 1;
1690 /* Add other config variables here and to Documentation/config.txt. */
1695 * All source specific fields in the union, die_on_error, name and the callbacks
1696 * fgetc, ungetc, ftell of top need to be initialized before calling
1699 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
,
1700 const struct config_options
*opts
)
1704 /* push config-file parsing state stack */
1709 strbuf_init(&top
->value
, 1024);
1710 strbuf_init(&top
->var
, 1024);
1713 ret
= git_parse_source(fn
, data
, opts
);
1715 /* pop config-file parsing state stack */
1716 strbuf_release(&top
->value
);
1717 strbuf_release(&top
->var
);
1723 static int do_config_from_file(config_fn_t fn
,
1724 const enum config_origin_type origin_type
,
1725 const char *name
, const char *path
, FILE *f
,
1726 void *data
, const struct config_options
*opts
)
1728 struct config_source top
;
1732 top
.origin_type
= origin_type
;
1735 top
.default_error_action
= CONFIG_ERROR_DIE
;
1736 top
.do_fgetc
= config_file_fgetc
;
1737 top
.do_ungetc
= config_file_ungetc
;
1738 top
.do_ftell
= config_file_ftell
;
1741 ret
= do_config_from(&top
, fn
, data
, opts
);
1746 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1748 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
,
1752 int git_config_from_file_with_options(config_fn_t fn
, const char *filename
,
1754 const struct config_options
*opts
)
1759 f
= fopen_or_warn(filename
, "r");
1761 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
,
1762 filename
, f
, data
, opts
);
1768 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1770 return git_config_from_file_with_options(fn
, filename
, data
, NULL
);
1773 int git_config_from_mem(config_fn_t fn
,
1774 const enum config_origin_type origin_type
,
1775 const char *name
, const char *buf
, size_t len
,
1776 void *data
, const struct config_options
*opts
)
1778 struct config_source top
;
1780 top
.u
.buf
.buf
= buf
;
1781 top
.u
.buf
.len
= len
;
1783 top
.origin_type
= origin_type
;
1786 top
.default_error_action
= CONFIG_ERROR_ERROR
;
1787 top
.do_fgetc
= config_buf_fgetc
;
1788 top
.do_ungetc
= config_buf_ungetc
;
1789 top
.do_ftell
= config_buf_ftell
;
1791 return do_config_from(&top
, fn
, data
, opts
);
1794 int git_config_from_blob_oid(config_fn_t fn
,
1796 struct repository
*repo
,
1797 const struct object_id
*oid
,
1800 enum object_type type
;
1805 buf
= repo_read_object_file(repo
, oid
, &type
, &size
);
1807 return error(_("unable to load config blob object '%s'"), name
);
1808 if (type
!= OBJ_BLOB
) {
1810 return error(_("reference '%s' does not point to a blob"), name
);
1813 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
,
1820 static int git_config_from_blob_ref(config_fn_t fn
,
1821 struct repository
*repo
,
1825 struct object_id oid
;
1827 if (repo_get_oid(repo
, name
, &oid
) < 0)
1828 return error(_("unable to resolve config blob '%s'"), name
);
1829 return git_config_from_blob_oid(fn
, name
, repo
, &oid
, data
);
1832 char *git_system_config(void)
1834 char *system_config
= xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1836 system_config
= system_path(ETC_GITCONFIG
);
1837 normalize_path_copy(system_config
, system_config
);
1838 return system_config
;
1841 void git_global_config(char **user_out
, char **xdg_out
)
1843 char *user_config
= xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1844 char *xdg_config
= NULL
;
1847 user_config
= interpolate_path("~/.gitconfig", 0);
1848 xdg_config
= xdg_config_home("config");
1851 *user_out
= user_config
;
1852 *xdg_out
= xdg_config
;
1856 * Parse environment variable 'k' as a boolean (in various
1857 * possible spellings); if missing, use the default value 'def'.
1859 int git_env_bool(const char *k
, int def
)
1861 const char *v
= getenv(k
);
1862 return v
? git_config_bool(k
, v
) : def
;
1866 * Parse environment variable 'k' as ulong with possibly a unit
1867 * suffix; if missing, use the default value 'val'.
1869 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1871 const char *v
= getenv(k
);
1872 if (v
&& !git_parse_ulong(v
, &val
))
1873 die(_("failed to parse %s"), k
);
1877 int git_config_system(void)
1879 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1882 static int do_git_config_sequence(const struct config_options
*opts
,
1883 config_fn_t fn
, void *data
)
1886 char *system_config
= git_system_config();
1887 char *xdg_config
= NULL
;
1888 char *user_config
= NULL
;
1890 enum config_scope prev_parsing_scope
= current_parsing_scope
;
1892 if (opts
->commondir
)
1893 repo_config
= mkpathdup("%s/config", opts
->commondir
);
1894 else if (opts
->git_dir
)
1895 BUG("git_dir without commondir");
1899 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1900 if (git_config_system() && system_config
&&
1901 !access_or_die(system_config
, R_OK
,
1902 opts
->system_gently
? ACCESS_EACCES_OK
: 0))
1903 ret
+= git_config_from_file(fn
, system_config
, data
);
1905 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1906 git_global_config(&user_config
, &xdg_config
);
1908 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1909 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1911 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1912 ret
+= git_config_from_file(fn
, user_config
, data
);
1914 current_parsing_scope
= CONFIG_SCOPE_LOCAL
;
1915 if (!opts
->ignore_repo
&& repo_config
&&
1916 !access_or_die(repo_config
, R_OK
, 0))
1917 ret
+= git_config_from_file(fn
, repo_config
, data
);
1919 current_parsing_scope
= CONFIG_SCOPE_WORKTREE
;
1920 if (!opts
->ignore_worktree
&& repository_format_worktree_config
) {
1921 char *path
= git_pathdup("config.worktree");
1922 if (!access_or_die(path
, R_OK
, 0))
1923 ret
+= git_config_from_file(fn
, path
, data
);
1927 current_parsing_scope
= CONFIG_SCOPE_COMMAND
;
1928 if (!opts
->ignore_cmdline
&& git_config_from_parameters(fn
, data
) < 0)
1929 die(_("unable to parse command-line config"));
1931 current_parsing_scope
= prev_parsing_scope
;
1932 free(system_config
);
1939 int config_with_options(config_fn_t fn
, void *data
,
1940 struct git_config_source
*config_source
,
1941 const struct config_options
*opts
)
1943 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1945 if (opts
->respect_includes
) {
1949 fn
= git_config_include
;
1954 current_parsing_scope
= config_source
->scope
;
1957 * If we have a specific filename, use it. Otherwise, follow the
1958 * regular lookup sequence.
1960 if (config_source
&& config_source
->use_stdin
) {
1961 return git_config_from_stdin(fn
, data
);
1962 } else if (config_source
&& config_source
->file
) {
1963 return git_config_from_file(fn
, config_source
->file
, data
);
1964 } else if (config_source
&& config_source
->blob
) {
1965 struct repository
*repo
= config_source
->repo
?
1966 config_source
->repo
: the_repository
;
1967 return git_config_from_blob_ref(fn
, repo
, config_source
->blob
,
1971 return do_git_config_sequence(opts
, fn
, data
);
1974 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1977 struct string_list
*values
;
1978 struct config_set_element
*entry
;
1979 struct configset_list
*list
= &cs
->list
;
1981 for (i
= 0; i
< list
->nr
; i
++) {
1982 entry
= list
->items
[i
].e
;
1983 value_index
= list
->items
[i
].value_index
;
1984 values
= &entry
->value_list
;
1986 current_config_kvi
= values
->items
[value_index
].util
;
1988 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1989 git_die_config_linenr(entry
->key
,
1990 current_config_kvi
->filename
,
1991 current_config_kvi
->linenr
);
1993 current_config_kvi
= NULL
;
1997 void read_early_config(config_fn_t cb
, void *data
)
1999 struct config_options opts
= {0};
2000 struct strbuf commondir
= STRBUF_INIT
;
2001 struct strbuf gitdir
= STRBUF_INIT
;
2003 opts
.respect_includes
= 1;
2005 if (have_git_dir()) {
2006 opts
.commondir
= get_git_common_dir();
2007 opts
.git_dir
= get_git_dir();
2009 * When setup_git_directory() was not yet asked to discover the
2010 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2011 * is any repository config we should use (but unlike
2012 * setup_git_directory_gently(), no global state is changed, most
2013 * notably, the current working directory is still the same after the
2016 } else if (!discover_git_directory(&commondir
, &gitdir
)) {
2017 opts
.commondir
= commondir
.buf
;
2018 opts
.git_dir
= gitdir
.buf
;
2021 config_with_options(cb
, data
, NULL
, &opts
);
2023 strbuf_release(&commondir
);
2024 strbuf_release(&gitdir
);
2028 * Read config but only enumerate system and global settings.
2029 * Omit any repo-local, worktree-local, or command-line settings.
2031 void read_very_early_config(config_fn_t cb
, void *data
)
2033 struct config_options opts
= { 0 };
2035 opts
.respect_includes
= 1;
2036 opts
.ignore_repo
= 1;
2037 opts
.ignore_worktree
= 1;
2038 opts
.ignore_cmdline
= 1;
2039 opts
.system_gently
= 1;
2041 config_with_options(cb
, data
, NULL
, &opts
);
2044 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
2046 struct config_set_element k
;
2047 struct config_set_element
*found_entry
;
2048 char *normalized_key
;
2050 * `key` may come from the user, so normalize it before using it
2051 * for querying entries from the hashmap.
2053 if (git_config_parse_key(key
, &normalized_key
, NULL
))
2056 hashmap_entry_init(&k
.ent
, strhash(normalized_key
));
2057 k
.key
= normalized_key
;
2058 found_entry
= hashmap_get_entry(&cs
->config_hash
, &k
, ent
, NULL
);
2059 free(normalized_key
);
2063 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
2065 struct config_set_element
*e
;
2066 struct string_list_item
*si
;
2067 struct configset_list_item
*l_item
;
2068 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
2070 e
= configset_find_element(cs
, key
);
2072 * Since the keys are being fed by git_config*() callback mechanism, they
2073 * are already normalized. So simply add them without any further munging.
2076 e
= xmalloc(sizeof(*e
));
2077 hashmap_entry_init(&e
->ent
, strhash(key
));
2078 e
->key
= xstrdup(key
);
2079 string_list_init_dup(&e
->value_list
);
2080 hashmap_add(&cs
->config_hash
, &e
->ent
);
2082 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
2084 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
2085 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
2087 l_item
->value_index
= e
->value_list
.nr
- 1;
2090 BUG("configset_add_value has no source");
2092 kv_info
->filename
= strintern(cf
->name
);
2093 kv_info
->linenr
= cf
->linenr
;
2094 kv_info
->origin_type
= cf
->origin_type
;
2096 /* for values read from `git_config_from_parameters()` */
2097 kv_info
->filename
= NULL
;
2098 kv_info
->linenr
= -1;
2099 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
2101 kv_info
->scope
= current_parsing_scope
;
2107 static int config_set_element_cmp(const void *unused_cmp_data
,
2108 const struct hashmap_entry
*eptr
,
2109 const struct hashmap_entry
*entry_or_key
,
2110 const void *unused_keydata
)
2112 const struct config_set_element
*e1
, *e2
;
2114 e1
= container_of(eptr
, const struct config_set_element
, ent
);
2115 e2
= container_of(entry_or_key
, const struct config_set_element
, ent
);
2117 return strcmp(e1
->key
, e2
->key
);
2120 void git_configset_init(struct config_set
*cs
)
2122 hashmap_init(&cs
->config_hash
, config_set_element_cmp
, NULL
, 0);
2123 cs
->hash_initialized
= 1;
2126 cs
->list
.items
= NULL
;
2129 void git_configset_clear(struct config_set
*cs
)
2131 struct config_set_element
*entry
;
2132 struct hashmap_iter iter
;
2133 if (!cs
->hash_initialized
)
2136 hashmap_for_each_entry(&cs
->config_hash
, &iter
, entry
,
2137 ent
/* member name */) {
2139 string_list_clear(&entry
->value_list
, 1);
2141 hashmap_clear_and_free(&cs
->config_hash
, struct config_set_element
, ent
);
2142 cs
->hash_initialized
= 0;
2143 free(cs
->list
.items
);
2146 cs
->list
.items
= NULL
;
2149 static int config_set_callback(const char *key
, const char *value
, void *cb
)
2151 struct config_set
*cs
= cb
;
2152 configset_add_value(cs
, key
, value
);
2156 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
2158 return git_config_from_file(config_set_callback
, filename
, cs
);
2161 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
2163 const struct string_list
*values
= NULL
;
2165 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2166 * queried key in the files of the configset, the value returned will be the last
2167 * value in the value list for that key.
2169 values
= git_configset_get_value_multi(cs
, key
);
2173 assert(values
->nr
> 0);
2174 *value
= values
->items
[values
->nr
- 1].string
;
2178 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
2180 struct config_set_element
*e
= configset_find_element(cs
, key
);
2181 return e
? &e
->value_list
: NULL
;
2184 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
2187 if (!git_configset_get_value(cs
, key
, &value
))
2188 return git_config_string((const char **)dest
, key
, value
);
2193 int git_configset_get_string_tmp(struct config_set
*cs
, const char *key
,
2197 if (!git_configset_get_value(cs
, key
, &value
)) {
2199 return config_error_nonbool(key
);
2207 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
2210 if (!git_configset_get_value(cs
, key
, &value
)) {
2211 *dest
= git_config_int(key
, value
);
2217 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
2220 if (!git_configset_get_value(cs
, key
, &value
)) {
2221 *dest
= git_config_ulong(key
, value
);
2227 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
2230 if (!git_configset_get_value(cs
, key
, &value
)) {
2231 *dest
= git_config_bool(key
, value
);
2237 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
2238 int *is_bool
, int *dest
)
2241 if (!git_configset_get_value(cs
, key
, &value
)) {
2242 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
2248 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
2251 if (!git_configset_get_value(cs
, key
, &value
)) {
2252 *dest
= git_parse_maybe_bool(value
);
2260 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
2263 if (!git_configset_get_value(cs
, key
, &value
))
2264 return git_config_pathname(dest
, key
, value
);
2269 /* Functions use to read configuration from a repository */
2270 static void repo_read_config(struct repository
*repo
)
2272 struct config_options opts
= { 0 };
2274 opts
.respect_includes
= 1;
2275 opts
.commondir
= repo
->commondir
;
2276 opts
.git_dir
= repo
->gitdir
;
2279 CALLOC_ARRAY(repo
->config
, 1);
2281 git_configset_clear(repo
->config
);
2283 git_configset_init(repo
->config
);
2285 if (config_with_options(config_set_callback
, repo
->config
, NULL
, &opts
) < 0)
2287 * config_with_options() normally returns only
2288 * zero, as most errors are fatal, and
2289 * non-fatal potential errors are guarded by "if"
2290 * statements that are entered only when no error is
2293 * If we ever encounter a non-fatal error, it means
2294 * something went really wrong and we should stop
2297 die(_("unknown error occurred while reading the configuration files"));
2300 static void git_config_check_init(struct repository
*repo
)
2302 if (repo
->config
&& repo
->config
->hash_initialized
)
2304 repo_read_config(repo
);
2307 static void repo_config_clear(struct repository
*repo
)
2309 if (!repo
->config
|| !repo
->config
->hash_initialized
)
2311 git_configset_clear(repo
->config
);
2314 void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
)
2316 git_config_check_init(repo
);
2317 configset_iter(repo
->config
, fn
, data
);
2320 int repo_config_get_value(struct repository
*repo
,
2321 const char *key
, const char **value
)
2323 git_config_check_init(repo
);
2324 return git_configset_get_value(repo
->config
, key
, value
);
2327 const struct string_list
*repo_config_get_value_multi(struct repository
*repo
,
2330 git_config_check_init(repo
);
2331 return git_configset_get_value_multi(repo
->config
, key
);
2334 int repo_config_get_string(struct repository
*repo
,
2335 const char *key
, char **dest
)
2338 git_config_check_init(repo
);
2339 ret
= git_configset_get_string(repo
->config
, key
, dest
);
2341 git_die_config(key
, NULL
);
2345 int repo_config_get_string_tmp(struct repository
*repo
,
2346 const char *key
, const char **dest
)
2349 git_config_check_init(repo
);
2350 ret
= git_configset_get_string_tmp(repo
->config
, key
, dest
);
2352 git_die_config(key
, NULL
);
2356 int repo_config_get_int(struct repository
*repo
,
2357 const char *key
, int *dest
)
2359 git_config_check_init(repo
);
2360 return git_configset_get_int(repo
->config
, key
, dest
);
2363 int repo_config_get_ulong(struct repository
*repo
,
2364 const char *key
, unsigned long *dest
)
2366 git_config_check_init(repo
);
2367 return git_configset_get_ulong(repo
->config
, key
, dest
);
2370 int repo_config_get_bool(struct repository
*repo
,
2371 const char *key
, int *dest
)
2373 git_config_check_init(repo
);
2374 return git_configset_get_bool(repo
->config
, key
, dest
);
2377 int repo_config_get_bool_or_int(struct repository
*repo
,
2378 const char *key
, int *is_bool
, int *dest
)
2380 git_config_check_init(repo
);
2381 return git_configset_get_bool_or_int(repo
->config
, key
, is_bool
, dest
);
2384 int repo_config_get_maybe_bool(struct repository
*repo
,
2385 const char *key
, int *dest
)
2387 git_config_check_init(repo
);
2388 return git_configset_get_maybe_bool(repo
->config
, key
, dest
);
2391 int repo_config_get_pathname(struct repository
*repo
,
2392 const char *key
, const char **dest
)
2395 git_config_check_init(repo
);
2396 ret
= git_configset_get_pathname(repo
->config
, key
, dest
);
2398 git_die_config(key
, NULL
);
2402 /* Functions used historically to read configuration from 'the_repository' */
2403 void git_config(config_fn_t fn
, void *data
)
2405 repo_config(the_repository
, fn
, data
);
2408 void git_config_clear(void)
2410 repo_config_clear(the_repository
);
2413 int git_config_get_value(const char *key
, const char **value
)
2415 return repo_config_get_value(the_repository
, key
, value
);
2418 const struct string_list
*git_config_get_value_multi(const char *key
)
2420 return repo_config_get_value_multi(the_repository
, key
);
2423 int git_config_get_string(const char *key
, char **dest
)
2425 return repo_config_get_string(the_repository
, key
, dest
);
2428 int git_config_get_string_tmp(const char *key
, const char **dest
)
2430 return repo_config_get_string_tmp(the_repository
, key
, dest
);
2433 int git_config_get_int(const char *key
, int *dest
)
2435 return repo_config_get_int(the_repository
, key
, dest
);
2438 int git_config_get_ulong(const char *key
, unsigned long *dest
)
2440 return repo_config_get_ulong(the_repository
, key
, dest
);
2443 int git_config_get_bool(const char *key
, int *dest
)
2445 return repo_config_get_bool(the_repository
, key
, dest
);
2448 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
2450 return repo_config_get_bool_or_int(the_repository
, key
, is_bool
, dest
);
2453 int git_config_get_maybe_bool(const char *key
, int *dest
)
2455 return repo_config_get_maybe_bool(the_repository
, key
, dest
);
2458 int git_config_get_pathname(const char *key
, const char **dest
)
2460 return repo_config_get_pathname(the_repository
, key
, dest
);
2463 int git_config_get_expiry(const char *key
, const char **output
)
2465 int ret
= git_config_get_string(key
, (char **)output
);
2468 if (strcmp(*output
, "now")) {
2469 timestamp_t now
= approxidate("now");
2470 if (approxidate(*output
) >= now
)
2471 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
2476 int git_config_get_expiry_in_days(const char *key
, timestamp_t
*expiry
, timestamp_t now
)
2478 const char *expiry_string
;
2482 if (git_config_get_string_tmp(key
, &expiry_string
))
2483 return 1; /* no such thing */
2485 if (git_parse_signed(expiry_string
, &days
, maximum_signed_value_of_type(int))) {
2486 const int scale
= 86400;
2487 *expiry
= now
- days
* scale
;
2491 if (!parse_expiry_date(expiry_string
, &when
)) {
2495 return -1; /* thing exists but cannot be parsed */
2498 int git_config_get_split_index(void)
2502 if (!git_config_get_maybe_bool("core.splitindex", &val
))
2505 return -1; /* default value */
2508 int git_config_get_max_percent_split_change(void)
2512 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
2513 if (0 <= val
&& val
<= 100)
2516 return error(_("splitIndex.maxPercentChange value '%d' "
2517 "should be between 0 and 100"), val
);
2520 return -1; /* default value */
2523 int git_config_get_fsmonitor(void)
2525 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor
))
2526 core_fsmonitor
= getenv("GIT_TEST_FSMONITOR");
2528 if (core_fsmonitor
&& !*core_fsmonitor
)
2529 core_fsmonitor
= NULL
;
2537 int git_config_get_index_threads(int *dest
)
2541 val
= git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2547 if (!git_config_get_bool_or_int("index.threads", &is_bool
, &val
)) {
2549 *dest
= val
? 0 : 1;
2559 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
2562 die(_("unable to parse '%s' from command-line config"), key
);
2564 die(_("bad config variable '%s' in file '%s' at line %d"),
2565 key
, filename
, linenr
);
2568 NORETURN
__attribute__((format(printf
, 2, 3)))
2569 void git_die_config(const char *key
, const char *err
, ...)
2571 const struct string_list
*values
;
2572 struct key_value_info
*kv_info
;
2576 va_start(params
, err
);
2577 vreportf("error: ", err
, params
);
2580 values
= git_config_get_value_multi(key
);
2581 kv_info
= values
->items
[values
->nr
- 1].util
;
2582 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
2586 * Find all the stuff for git_config_set() below.
2589 struct config_store_data
{
2593 const char *fixed_value
;
2594 regex_t
*value_pattern
;
2598 enum config_event_t type
;
2599 int is_keys_section
;
2601 unsigned int parsed_nr
, parsed_alloc
, *seen
, seen_nr
, seen_alloc
;
2602 unsigned int key_seen
:1, section_seen
:1, is_keys_section
:1;
2605 static void config_store_data_clear(struct config_store_data
*store
)
2608 if (store
->value_pattern
!= NULL
&&
2609 store
->value_pattern
!= CONFIG_REGEX_NONE
) {
2610 regfree(store
->value_pattern
);
2611 free(store
->value_pattern
);
2613 free(store
->parsed
);
2615 memset(store
, 0, sizeof(*store
));
2618 static int matches(const char *key
, const char *value
,
2619 const struct config_store_data
*store
)
2621 if (strcmp(key
, store
->key
))
2622 return 0; /* not ours */
2623 if (store
->fixed_value
)
2624 return !strcmp(store
->fixed_value
, value
);
2625 if (!store
->value_pattern
)
2626 return 1; /* always matches */
2627 if (store
->value_pattern
== CONFIG_REGEX_NONE
)
2628 return 0; /* never matches */
2630 return store
->do_not_match
^
2631 (value
&& !regexec(store
->value_pattern
, value
, 0, NULL
, 0));
2634 static int store_aux_event(enum config_event_t type
,
2635 size_t begin
, size_t end
, void *data
)
2637 struct config_store_data
*store
= data
;
2639 ALLOC_GROW(store
->parsed
, store
->parsed_nr
+ 1, store
->parsed_alloc
);
2640 store
->parsed
[store
->parsed_nr
].begin
= begin
;
2641 store
->parsed
[store
->parsed_nr
].end
= end
;
2642 store
->parsed
[store
->parsed_nr
].type
= type
;
2644 if (type
== CONFIG_EVENT_SECTION
) {
2645 int (*cmpfn
)(const char *, const char *, size_t);
2647 if (cf
->var
.len
< 2 || cf
->var
.buf
[cf
->var
.len
- 1] != '.')
2648 return error(_("invalid section name '%s'"), cf
->var
.buf
);
2650 if (cf
->subsection_case_sensitive
)
2651 cmpfn
= strncasecmp
;
2655 /* Is this the section we were looking for? */
2656 store
->is_keys_section
=
2657 store
->parsed
[store
->parsed_nr
].is_keys_section
=
2658 cf
->var
.len
- 1 == store
->baselen
&&
2659 !cmpfn(cf
->var
.buf
, store
->key
, store
->baselen
);
2660 if (store
->is_keys_section
) {
2661 store
->section_seen
= 1;
2662 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2664 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2673 static int store_aux(const char *key
, const char *value
, void *cb
)
2675 struct config_store_data
*store
= cb
;
2677 if (store
->key_seen
) {
2678 if (matches(key
, value
, store
)) {
2679 if (store
->seen_nr
== 1 && store
->multi_replace
== 0) {
2680 warning(_("%s has multiple values"), key
);
2683 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2686 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2689 } else if (store
->is_keys_section
) {
2691 * Do not increment matches yet: this may not be a match, but we
2692 * are in the desired section.
2694 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1, store
->seen_alloc
);
2695 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2696 store
->section_seen
= 1;
2698 if (matches(key
, value
, store
)) {
2700 store
->key_seen
= 1;
2707 static int write_error(const char *filename
)
2709 error(_("failed to write new configuration file %s"), filename
);
2711 /* Same error code as "failed to rename". */
2715 static struct strbuf
store_create_section(const char *key
,
2716 const struct config_store_data
*store
)
2720 struct strbuf sb
= STRBUF_INIT
;
2722 dot
= memchr(key
, '.', store
->baselen
);
2724 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
2725 for (i
= dot
- key
+ 1; i
< store
->baselen
; i
++) {
2726 if (key
[i
] == '"' || key
[i
] == '\\')
2727 strbuf_addch(&sb
, '\\');
2728 strbuf_addch(&sb
, key
[i
]);
2730 strbuf_addstr(&sb
, "\"]\n");
2732 strbuf_addch(&sb
, '[');
2733 strbuf_add(&sb
, key
, store
->baselen
);
2734 strbuf_addstr(&sb
, "]\n");
2740 static ssize_t
write_section(int fd
, const char *key
,
2741 const struct config_store_data
*store
)
2743 struct strbuf sb
= store_create_section(key
, store
);
2746 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2747 strbuf_release(&sb
);
2752 static ssize_t
write_pair(int fd
, const char *key
, const char *value
,
2753 const struct config_store_data
*store
)
2757 const char *quote
= "";
2758 struct strbuf sb
= STRBUF_INIT
;
2761 * Check to see if the value needs to be surrounded with a dq pair.
2762 * Note that problematic characters are always backslash-quoted; this
2763 * check is about not losing leading or trailing SP and strings that
2764 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2765 * configuration parser.
2767 if (value
[0] == ' ')
2769 for (i
= 0; value
[i
]; i
++)
2770 if (value
[i
] == ';' || value
[i
] == '#')
2772 if (i
&& value
[i
- 1] == ' ')
2775 strbuf_addf(&sb
, "\t%s = %s", key
+ store
->baselen
+ 1, quote
);
2777 for (i
= 0; value
[i
]; i
++)
2780 strbuf_addstr(&sb
, "\\n");
2783 strbuf_addstr(&sb
, "\\t");
2787 strbuf_addch(&sb
, '\\');
2790 strbuf_addch(&sb
, value
[i
]);
2793 strbuf_addf(&sb
, "%s\n", quote
);
2795 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2796 strbuf_release(&sb
);
2802 * If we are about to unset the last key(s) in a section, and if there are
2803 * no comments surrounding (or included in) the section, we will want to
2804 * extend begin/end to remove the entire section.
2806 * Note: the parameter `seen_ptr` points to the index into the store.seen
2807 * array. * This index may be incremented if a section has more than one
2808 * entry (which all are to be removed).
2810 static void maybe_remove_section(struct config_store_data
*store
,
2811 size_t *begin_offset
, size_t *end_offset
,
2815 int i
, seen
, section_seen
= 0;
2818 * First, ensure that this is the first key, and that there are no
2819 * comments before the entry nor before the section header.
2822 for (i
= store
->seen
[seen
]; i
> 0; i
--) {
2823 enum config_event_t type
= store
->parsed
[i
- 1].type
;
2825 if (type
== CONFIG_EVENT_COMMENT
)
2826 /* There is a comment before this entry or section */
2828 if (type
== CONFIG_EVENT_ENTRY
) {
2830 /* This is not the section's first entry. */
2832 /* We encountered no comment before the section. */
2835 if (type
== CONFIG_EVENT_SECTION
) {
2836 if (!store
->parsed
[i
- 1].is_keys_section
)
2841 begin
= store
->parsed
[i
].begin
;
2844 * Next, make sure that we are removing the last key(s) in the section,
2845 * and that there are no comments that are possibly about the current
2848 for (i
= store
->seen
[seen
] + 1; i
< store
->parsed_nr
; i
++) {
2849 enum config_event_t type
= store
->parsed
[i
].type
;
2851 if (type
== CONFIG_EVENT_COMMENT
)
2853 if (type
== CONFIG_EVENT_SECTION
) {
2854 if (store
->parsed
[i
].is_keys_section
)
2858 if (type
== CONFIG_EVENT_ENTRY
) {
2859 if (++seen
< store
->seen_nr
&&
2860 i
== store
->seen
[seen
])
2861 /* We want to remove this entry, too */
2863 /* There is another entry in this section. */
2869 * We are really removing the last entry/entries from this section, and
2870 * there are no enclosed or surrounding comments. Remove the entire,
2871 * now-empty section.
2874 *begin_offset
= begin
;
2875 if (i
< store
->parsed_nr
)
2876 *end_offset
= store
->parsed
[i
].begin
;
2878 *end_offset
= store
->parsed
[store
->parsed_nr
- 1].end
;
2881 int git_config_set_in_file_gently(const char *config_filename
,
2882 const char *key
, const char *value
)
2884 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
2887 void git_config_set_in_file(const char *config_filename
,
2888 const char *key
, const char *value
)
2890 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
2893 int git_config_set_gently(const char *key
, const char *value
)
2895 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
2898 void git_config_set(const char *key
, const char *value
)
2900 git_config_set_multivar(key
, value
, NULL
, 0);
2902 trace2_cmd_set_config(key
, value
);
2906 * If value==NULL, unset in (remove from) config,
2907 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
2908 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
2909 * (only add a new one)
2910 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
2911 * key/values are removed before a single new pair is written. If the
2912 * flag is not present, then replace only the first match.
2914 * Returns 0 on success.
2916 * This function does this:
2918 * - it locks the config file by creating ".git/config.lock"
2920 * - it then parses the config using store_aux() as validator to find
2921 * the position on the key/value pair to replace. If it is to be unset,
2922 * it must be found exactly once.
2924 * - the config file is mmap()ed and the part before the match (if any) is
2925 * written to the lock file, then the changed part and the rest.
2927 * - the config file is removed and the lock file rename()d to it.
2930 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2931 const char *key
, const char *value
,
2932 const char *value_pattern
,
2935 int fd
= -1, in_fd
= -1;
2937 struct lock_file lock
= LOCK_INIT
;
2938 char *filename_buf
= NULL
;
2939 char *contents
= NULL
;
2941 struct config_store_data store
;
2943 memset(&store
, 0, sizeof(store
));
2945 /* parse-key returns negative; flip the sign to feed exit(3) */
2946 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2950 store
.multi_replace
= (flags
& CONFIG_FLAGS_MULTI_REPLACE
) != 0;
2952 if (!config_filename
)
2953 config_filename
= filename_buf
= git_pathdup("config");
2956 * The lock serves a purpose in addition to locking: the new
2957 * contents of .git/config will be written into it.
2959 fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
2961 error_errno(_("could not lock config file %s"), config_filename
);
2962 ret
= CONFIG_NO_LOCK
;
2967 * If .git/config does not exist yet, write a minimal version.
2969 in_fd
= open(config_filename
, O_RDONLY
);
2971 if ( ENOENT
!= errno
) {
2972 error_errno(_("opening %s"), config_filename
);
2973 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2976 /* if nothing to unset, error out */
2977 if (value
== NULL
) {
2978 ret
= CONFIG_NOTHING_SET
;
2983 store
.key
= xstrdup(key
);
2984 if (write_section(fd
, key
, &store
) < 0 ||
2985 write_pair(fd
, key
, value
, &store
) < 0)
2989 size_t copy_begin
, copy_end
;
2990 int i
, new_line
= 0;
2991 struct config_options opts
;
2993 if (value_pattern
== NULL
)
2994 store
.value_pattern
= NULL
;
2995 else if (value_pattern
== CONFIG_REGEX_NONE
)
2996 store
.value_pattern
= CONFIG_REGEX_NONE
;
2997 else if (flags
& CONFIG_FLAGS_FIXED_VALUE
)
2998 store
.fixed_value
= value_pattern
;
3000 if (value_pattern
[0] == '!') {
3001 store
.do_not_match
= 1;
3004 store
.do_not_match
= 0;
3006 store
.value_pattern
= (regex_t
*)xmalloc(sizeof(regex_t
));
3007 if (regcomp(store
.value_pattern
, value_pattern
,
3009 error(_("invalid pattern: %s"), value_pattern
);
3010 FREE_AND_NULL(store
.value_pattern
);
3011 ret
= CONFIG_INVALID_PATTERN
;
3016 ALLOC_GROW(store
.parsed
, 1, store
.parsed_alloc
);
3017 store
.parsed
[0].end
= 0;
3019 memset(&opts
, 0, sizeof(opts
));
3020 opts
.event_fn
= store_aux_event
;
3021 opts
.event_fn_data
= &store
;
3024 * After this, store.parsed will contain offsets of all the
3025 * parsed elements, and store.seen will contain a list of
3026 * matches, as indices into store.parsed.
3028 * As a side effect, we make sure to transform only a valid
3029 * existing config file.
3031 if (git_config_from_file_with_options(store_aux
,
3034 error(_("invalid config file %s"), config_filename
);
3035 ret
= CONFIG_INVALID_FILE
;
3039 /* if nothing to unset, or too many matches, error out */
3040 if ((store
.seen_nr
== 0 && value
== NULL
) ||
3041 (store
.seen_nr
> 1 && !store
.multi_replace
)) {
3042 ret
= CONFIG_NOTHING_SET
;
3046 if (fstat(in_fd
, &st
) == -1) {
3047 error_errno(_("fstat on %s failed"), config_filename
);
3048 ret
= CONFIG_INVALID_FILE
;
3052 contents_sz
= xsize_t(st
.st_size
);
3053 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
3054 MAP_PRIVATE
, in_fd
, 0);
3055 if (contents
== MAP_FAILED
) {
3056 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
3058 error_errno(_("unable to mmap '%s'%s"),
3059 config_filename
, mmap_os_err());
3060 ret
= CONFIG_INVALID_FILE
;
3067 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3068 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock
));
3069 ret
= CONFIG_NO_WRITE
;
3073 if (store
.seen_nr
== 0) {
3074 if (!store
.seen_alloc
) {
3075 /* Did not see key nor section */
3076 ALLOC_GROW(store
.seen
, 1, store
.seen_alloc
);
3077 store
.seen
[0] = store
.parsed_nr
3078 - !!store
.parsed_nr
;
3083 for (i
= 0, copy_begin
= 0; i
< store
.seen_nr
; i
++) {
3085 int j
= store
.seen
[i
];
3088 if (!store
.key_seen
) {
3089 copy_end
= store
.parsed
[j
].end
;
3090 /* include '\n' when copying section header */
3091 if (copy_end
> 0 && copy_end
< contents_sz
&&
3092 contents
[copy_end
- 1] != '\n' &&
3093 contents
[copy_end
] == '\n')
3095 replace_end
= copy_end
;
3097 replace_end
= store
.parsed
[j
].end
;
3098 copy_end
= store
.parsed
[j
].begin
;
3100 maybe_remove_section(&store
,
3104 * Swallow preceding white-space on the same
3107 while (copy_end
> 0 ) {
3108 char c
= contents
[copy_end
- 1];
3110 if (isspace(c
) && c
!= '\n')
3117 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
3120 /* write the first part of the config */
3121 if (copy_end
> copy_begin
) {
3122 if (write_in_full(fd
, contents
+ copy_begin
,
3123 copy_end
- copy_begin
) < 0)
3126 write_str_in_full(fd
, "\n") < 0)
3129 copy_begin
= replace_end
;
3132 /* write the pair (value == NULL means unset) */
3133 if (value
!= NULL
) {
3134 if (!store
.section_seen
) {
3135 if (write_section(fd
, key
, &store
) < 0)
3138 if (write_pair(fd
, key
, value
, &store
) < 0)
3142 /* write the rest of the config */
3143 if (copy_begin
< contents_sz
)
3144 if (write_in_full(fd
, contents
+ copy_begin
,
3145 contents_sz
- copy_begin
) < 0)
3148 munmap(contents
, contents_sz
);
3152 if (commit_lock_file(&lock
) < 0) {
3153 error_errno(_("could not write config file %s"), config_filename
);
3154 ret
= CONFIG_NO_WRITE
;
3160 /* Invalidate the config cache */
3164 rollback_lock_file(&lock
);
3167 munmap(contents
, contents_sz
);
3170 config_store_data_clear(&store
);
3174 ret
= write_error(get_lock_file_path(&lock
));
3179 void git_config_set_multivar_in_file(const char *config_filename
,
3180 const char *key
, const char *value
,
3181 const char *value_pattern
, unsigned flags
)
3183 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
3184 value_pattern
, flags
))
3187 die(_("could not set '%s' to '%s'"), key
, value
);
3189 die(_("could not unset '%s'"), key
);
3192 int git_config_set_multivar_gently(const char *key
, const char *value
,
3193 const char *value_pattern
, unsigned flags
)
3195 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_pattern
,
3199 void git_config_set_multivar(const char *key
, const char *value
,
3200 const char *value_pattern
, unsigned flags
)
3202 git_config_set_multivar_in_file(NULL
, key
, value
, value_pattern
,
3206 static int section_name_match (const char *buf
, const char *name
)
3208 int i
= 0, j
= 0, dot
= 0;
3211 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
3212 if (!dot
&& isspace(buf
[i
])) {
3214 if (name
[j
++] != '.')
3216 for (i
++; isspace(buf
[i
]); i
++)
3222 if (buf
[i
] == '\\' && dot
)
3224 else if (buf
[i
] == '"' && dot
) {
3225 for (i
++; isspace(buf
[i
]); i
++)
3229 if (buf
[i
] != name
[j
++])
3232 if (buf
[i
] == ']' && name
[j
] == 0) {
3234 * We match, now just find the right length offset by
3235 * gobbling up any whitespace after it, as well
3238 for (; buf
[i
] && isspace(buf
[i
]); i
++)
3245 static int section_name_is_ok(const char *name
)
3247 /* Empty section names are bogus. */
3252 * Before a dot, we must be alphanumeric or dash. After the first dot,
3253 * anything goes, so we can stop checking.
3255 for (; *name
&& *name
!= '.'; name
++)
3256 if (*name
!= '-' && !isalnum(*name
))
3261 /* if new_name == NULL, the section is removed instead */
3262 static int git_config_copy_or_rename_section_in_file(const char *config_filename
,
3263 const char *old_name
,
3264 const char *new_name
, int copy
)
3266 int ret
= 0, remove
= 0;
3267 char *filename_buf
= NULL
;
3268 struct lock_file lock
= LOCK_INIT
;
3271 FILE *config_file
= NULL
;
3273 struct strbuf copystr
= STRBUF_INIT
;
3274 struct config_store_data store
;
3276 memset(&store
, 0, sizeof(store
));
3278 if (new_name
&& !section_name_is_ok(new_name
)) {
3279 ret
= error(_("invalid section name: %s"), new_name
);
3280 goto out_no_rollback
;
3283 if (!config_filename
)
3284 config_filename
= filename_buf
= git_pathdup("config");
3286 out_fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3288 ret
= error(_("could not lock config file %s"), config_filename
);
3292 if (!(config_file
= fopen(config_filename
, "rb"))) {
3293 ret
= warn_on_fopen_errors(config_filename
);
3296 /* no config file means nothing to rename, no error */
3297 goto commit_and_out
;
3300 if (fstat(fileno(config_file
), &st
) == -1) {
3301 ret
= error_errno(_("fstat on %s failed"), config_filename
);
3305 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3306 ret
= error_errno(_("chmod on %s failed"),
3307 get_lock_file_path(&lock
));
3311 while (fgets(buf
, sizeof(buf
), config_file
)) {
3316 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
3318 if (buf
[i
] == '[') {
3319 /* it's a section */
3324 * When encountering a new section under -c we
3325 * need to flush out any section we're already
3326 * coping and begin anew. There might be
3327 * multiple [branch "$name"] sections.
3329 if (copystr
.len
> 0) {
3330 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3331 ret
= write_error(get_lock_file_path(&lock
));
3334 strbuf_reset(©str
);
3337 offset
= section_name_match(&buf
[i
], old_name
);
3340 if (new_name
== NULL
) {
3344 store
.baselen
= strlen(new_name
);
3346 if (write_section(out_fd
, new_name
, &store
) < 0) {
3347 ret
= write_error(get_lock_file_path(&lock
));
3351 * We wrote out the new section, with
3352 * a newline, now skip the old
3355 output
+= offset
+ i
;
3356 if (strlen(output
) > 0) {
3358 * More content means there's
3359 * a declaration to put on the
3360 * next line; indent with a
3367 copystr
= store_create_section(new_name
, &store
);
3374 length
= strlen(output
);
3376 if (!is_section
&& copystr
.len
> 0) {
3377 strbuf_add(©str
, output
, length
);
3380 if (write_in_full(out_fd
, output
, length
) < 0) {
3381 ret
= write_error(get_lock_file_path(&lock
));
3387 * Copy a trailing section at the end of the config, won't be
3388 * flushed by the usual "flush because we have a new section
3389 * logic in the loop above.
3391 if (copystr
.len
> 0) {
3392 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3393 ret
= write_error(get_lock_file_path(&lock
));
3396 strbuf_reset(©str
);
3399 fclose(config_file
);
3402 if (commit_lock_file(&lock
) < 0)
3403 ret
= error_errno(_("could not write config file %s"),
3407 fclose(config_file
);
3408 rollback_lock_file(&lock
);
3411 config_store_data_clear(&store
);
3415 int git_config_rename_section_in_file(const char *config_filename
,
3416 const char *old_name
, const char *new_name
)
3418 return git_config_copy_or_rename_section_in_file(config_filename
,
3419 old_name
, new_name
, 0);
3422 int git_config_rename_section(const char *old_name
, const char *new_name
)
3424 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
3427 int git_config_copy_section_in_file(const char *config_filename
,
3428 const char *old_name
, const char *new_name
)
3430 return git_config_copy_or_rename_section_in_file(config_filename
,
3431 old_name
, new_name
, 1);
3434 int git_config_copy_section(const char *old_name
, const char *new_name
)
3436 return git_config_copy_section_in_file(NULL
, old_name
, new_name
);
3440 * Call this to report error for your variable that should not
3441 * get a boolean value (i.e. "[my] var" means "true").
3443 #undef config_error_nonbool
3444 int config_error_nonbool(const char *var
)
3446 return error(_("missing value for '%s'"), var
);
3449 int parse_config_key(const char *var
,
3450 const char *section
,
3451 const char **subsection
, size_t *subsection_len
,
3456 /* Does it start with "section." ? */
3457 if (!skip_prefix(var
, section
, &var
) || *var
!= '.')
3461 * Find the key; we don't know yet if we have a subsection, but we must
3462 * parse backwards from the end, since the subsection may have dots in
3465 dot
= strrchr(var
, '.');
3468 /* Did we have a subsection at all? */
3472 *subsection_len
= 0;
3478 *subsection
= var
+ 1;
3479 *subsection_len
= dot
- *subsection
;
3485 const char *current_config_origin_type(void)
3488 if (current_config_kvi
)
3489 type
= current_config_kvi
->origin_type
;
3491 type
= cf
->origin_type
;
3493 BUG("current_config_origin_type called outside config callback");
3496 case CONFIG_ORIGIN_BLOB
:
3498 case CONFIG_ORIGIN_FILE
:
3500 case CONFIG_ORIGIN_STDIN
:
3501 return "standard input";
3502 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
3503 return "submodule-blob";
3504 case CONFIG_ORIGIN_CMDLINE
:
3505 return "command line";
3507 BUG("unknown config origin type");
3511 const char *config_scope_name(enum config_scope scope
)
3514 case CONFIG_SCOPE_SYSTEM
:
3516 case CONFIG_SCOPE_GLOBAL
:
3518 case CONFIG_SCOPE_LOCAL
:
3520 case CONFIG_SCOPE_WORKTREE
:
3522 case CONFIG_SCOPE_COMMAND
:
3524 case CONFIG_SCOPE_SUBMODULE
:
3531 const char *current_config_name(void)
3534 if (current_config_kvi
)
3535 name
= current_config_kvi
->filename
;
3539 BUG("current_config_name called outside config callback");
3540 return name
? name
: "";
3543 enum config_scope
current_config_scope(void)
3545 if (current_config_kvi
)
3546 return current_config_kvi
->scope
;
3548 return current_parsing_scope
;
3551 int current_config_line(void)
3553 if (current_config_kvi
)
3554 return current_config_kvi
->linenr
;
3559 int lookup_config(const char **mapping
, int nr_mapping
, const char *var
)
3563 for (i
= 0; i
< nr_mapping
; i
++) {
3564 const char *name
= mapping
[i
];
3566 if (name
&& !strcasecmp(var
, name
))