2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
13 struct config_source
{
14 struct config_source
*prev
;
31 int (*do_fgetc
)(struct config_source
*c
);
32 int (*do_ungetc
)(int c
, struct config_source
*conf
);
33 long (*do_ftell
)(struct config_source
*c
);
36 static struct config_source
*cf
;
38 static int zlib_compression_seen
;
40 static int config_file_fgetc(struct config_source
*conf
)
42 return fgetc(conf
->u
.file
);
45 static int config_file_ungetc(int c
, struct config_source
*conf
)
47 return ungetc(c
, conf
->u
.file
);
50 static long config_file_ftell(struct config_source
*conf
)
52 return ftell(conf
->u
.file
);
56 static int config_buf_fgetc(struct config_source
*conf
)
58 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
59 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
64 static int config_buf_ungetc(int c
, struct config_source
*conf
)
66 if (conf
->u
.buf
.pos
> 0)
67 return conf
->u
.buf
.buf
[--conf
->u
.buf
.pos
];
72 static long config_buf_ftell(struct config_source
*conf
)
74 return conf
->u
.buf
.pos
;
77 #define MAX_INCLUDE_DEPTH 10
78 static const char include_depth_advice
[] =
79 "exceeded maximum include depth (%d) while including\n"
83 "Do you have circular includes?";
84 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
87 struct strbuf buf
= STRBUF_INIT
;
91 return config_error_nonbool("include.path");
93 expanded
= expand_user_path(path
);
95 return error("Could not expand include path '%s'", path
);
99 * Use an absolute path as-is, but interpret relative paths
100 * based on the including config file.
102 if (!is_absolute_path(path
)) {
105 if (!cf
|| !cf
->path
)
106 return error("relative config includes must come from files");
108 slash
= find_last_dir_sep(cf
->path
);
110 strbuf_add(&buf
, cf
->path
, slash
- cf
->path
+ 1);
111 strbuf_addstr(&buf
, path
);
115 if (!access_or_die(path
, R_OK
, 0)) {
116 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
117 die(include_depth_advice
, MAX_INCLUDE_DEPTH
, path
,
118 cf
&& cf
->name
? cf
->name
: "the command line");
119 ret
= git_config_from_file(git_config_include
, path
, inc
);
122 strbuf_release(&buf
);
127 int git_config_include(const char *var
, const char *value
, void *data
)
129 struct config_include_data
*inc
= data
;
134 * Pass along all values, including "include" directives; this makes it
135 * possible to query information on the includes themselves.
137 ret
= inc
->fn(var
, value
, inc
->data
);
141 if (!skip_prefix(var
, "include.", &type
))
144 if (!strcmp(type
, "path"))
145 ret
= handle_path_include(value
, inc
);
149 void git_config_push_parameter(const char *text
)
151 struct strbuf env
= STRBUF_INIT
;
152 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
154 strbuf_addstr(&env
, old
);
155 strbuf_addch(&env
, ' ');
157 sq_quote_buf(&env
, text
);
158 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
159 strbuf_release(&env
);
162 int git_config_parse_parameter(const char *text
,
163 config_fn_t fn
, void *data
)
165 struct strbuf
**pair
;
166 pair
= strbuf_split_str(text
, '=', 2);
168 return error("bogus config parameter: %s", text
);
169 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=')
170 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
171 strbuf_trim(pair
[0]);
173 strbuf_list_free(pair
);
174 return error("bogus config parameter: %s", text
);
176 strbuf_tolower(pair
[0]);
177 if (fn(pair
[0]->buf
, pair
[1] ? pair
[1]->buf
: NULL
, data
) < 0) {
178 strbuf_list_free(pair
);
181 strbuf_list_free(pair
);
185 int git_config_from_parameters(config_fn_t fn
, void *data
)
187 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
189 const char **argv
= NULL
;
190 int nr
= 0, alloc
= 0;
195 /* sq_dequote will write over it */
198 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
200 return error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
203 for (i
= 0; i
< nr
; i
++) {
204 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
216 static int get_next_char(void)
218 int c
= cf
->do_fgetc(cf
);
221 /* DOS like systems */
222 c
= cf
->do_fgetc(cf
);
224 cf
->do_ungetc(c
, cf
);
237 static char *parse_value(void)
239 int quote
= 0, comment
= 0, space
= 0;
241 strbuf_reset(&cf
->value
);
243 int c
= get_next_char();
249 return cf
->value
.buf
;
253 if (isspace(c
) && !quote
) {
259 if (c
== ';' || c
== '#') {
264 for (; space
; space
--)
265 strbuf_addch(&cf
->value
, ' ');
280 /* Some characters escape as themselves */
283 /* Reject unknown escape sequences */
287 strbuf_addch(&cf
->value
, c
);
294 strbuf_addch(&cf
->value
, c
);
298 static inline int iskeychar(int c
)
300 return isalnum(c
) || c
== '-';
303 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
308 /* Get the full name */
315 strbuf_addch(name
, tolower(c
));
318 while (c
== ' ' || c
== '\t')
325 value
= parse_value();
329 return fn(name
->buf
, value
, data
);
332 static int get_extended_base_var(struct strbuf
*name
, int c
)
336 goto error_incomplete_line
;
338 } while (isspace(c
));
340 /* We require the format to be '[base "extension"]' */
343 strbuf_addch(name
, '.');
346 int c
= get_next_char();
348 goto error_incomplete_line
;
354 goto error_incomplete_line
;
356 strbuf_addch(name
, c
);
360 if (get_next_char() != ']')
363 error_incomplete_line
:
368 static int get_base_var(struct strbuf
*name
)
371 int c
= get_next_char();
377 return get_extended_base_var(name
, c
);
378 if (!iskeychar(c
) && c
!= '.')
380 strbuf_addch(name
, tolower(c
));
384 static int git_parse_source(config_fn_t fn
, void *data
)
388 struct strbuf
*var
= &cf
->var
;
390 /* U+FEFF Byte Order Mark in UTF8 */
391 static const unsigned char *utf8_bom
= (unsigned char *) "\xef\xbb\xbf";
392 const unsigned char *bomptr
= utf8_bom
;
395 int c
= get_next_char();
396 if (bomptr
&& *bomptr
) {
397 /* We are at the file beginning; skip UTF8-encoded BOM
398 * if present. Sane editors won't put this in on their
399 * own, but e.g. Windows Notepad will do it happily. */
400 if ((unsigned char) c
== *bomptr
) {
404 /* Do not tolerate partial BOM. */
405 if (bomptr
!= utf8_bom
)
407 /* No BOM at file beginning. Cool. */
417 if (comment
|| isspace(c
))
419 if (c
== '#' || c
== ';') {
424 /* Reset prior to determining a new stem */
426 if (get_base_var(var
) < 0 || var
->len
< 1)
428 strbuf_addch(var
, '.');
435 * Truncate the var name back to the section header
436 * stem prior to grabbing the suffix part of the name
439 strbuf_setlen(var
, baselen
);
440 strbuf_addch(var
, tolower(c
));
441 if (get_value(fn
, data
, var
) < 0)
444 if (cf
->die_on_error
)
445 die("bad config file line %d in %s", cf
->linenr
, cf
->name
);
447 return error("bad config file line %d in %s", cf
->linenr
, cf
->name
);
450 static int parse_unit_factor(const char *end
, uintmax_t *val
)
454 else if (!strcasecmp(end
, "k")) {
458 else if (!strcasecmp(end
, "m")) {
462 else if (!strcasecmp(end
, "g")) {
463 *val
*= 1024 * 1024 * 1024;
469 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
471 if (value
&& *value
) {
475 uintmax_t factor
= 1;
478 val
= strtoimax(value
, &end
, 0);
481 if (!parse_unit_factor(end
, &factor
)) {
487 if (uval
> max
|| abs(val
) > uval
) {
499 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
501 if (value
&& *value
) {
507 val
= strtoumax(value
, &end
, 0);
511 if (!parse_unit_factor(end
, &val
)) {
515 if (val
> max
|| oldval
> val
) {
526 static int git_parse_int(const char *value
, int *ret
)
529 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
535 static int git_parse_int64(const char *value
, int64_t *ret
)
538 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
544 int git_parse_ulong(const char *value
, unsigned long *ret
)
547 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
554 static void die_bad_number(const char *name
, const char *value
)
556 const char *reason
= errno
== ERANGE
?
563 die("bad numeric config value '%s' for '%s' in %s: %s",
564 value
, name
, cf
->name
, reason
);
565 die("bad numeric config value '%s' for '%s': %s", value
, name
, reason
);
568 int git_config_int(const char *name
, const char *value
)
571 if (!git_parse_int(value
, &ret
))
572 die_bad_number(name
, value
);
576 int64_t git_config_int64(const char *name
, const char *value
)
579 if (!git_parse_int64(value
, &ret
))
580 die_bad_number(name
, value
);
584 unsigned long git_config_ulong(const char *name
, const char *value
)
587 if (!git_parse_ulong(value
, &ret
))
588 die_bad_number(name
, value
);
592 static int git_config_maybe_bool_text(const char *name
, const char *value
)
598 if (!strcasecmp(value
, "true")
599 || !strcasecmp(value
, "yes")
600 || !strcasecmp(value
, "on"))
602 if (!strcasecmp(value
, "false")
603 || !strcasecmp(value
, "no")
604 || !strcasecmp(value
, "off"))
609 int git_config_maybe_bool(const char *name
, const char *value
)
611 int v
= git_config_maybe_bool_text(name
, value
);
614 if (git_parse_int(value
, &v
))
619 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
621 int v
= git_config_maybe_bool_text(name
, value
);
627 return git_config_int(name
, value
);
630 int git_config_bool(const char *name
, const char *value
)
633 return !!git_config_bool_or_int(name
, value
, &discard
);
636 int git_config_string(const char **dest
, const char *var
, const char *value
)
639 return config_error_nonbool(var
);
640 *dest
= xstrdup(value
);
644 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
647 return config_error_nonbool(var
);
648 *dest
= expand_user_path(value
);
650 die("Failed to expand user dir in: '%s'", value
);
654 static int git_default_core_config(const char *var
, const char *value
)
656 /* This needs a better name */
657 if (!strcmp(var
, "core.filemode")) {
658 trust_executable_bit
= git_config_bool(var
, value
);
661 if (!strcmp(var
, "core.trustctime")) {
662 trust_ctime
= git_config_bool(var
, value
);
665 if (!strcmp(var
, "core.checkstat")) {
666 if (!strcasecmp(value
, "default"))
668 else if (!strcasecmp(value
, "minimal"))
672 if (!strcmp(var
, "core.quotepath")) {
673 quote_path_fully
= git_config_bool(var
, value
);
677 if (!strcmp(var
, "core.symlinks")) {
678 has_symlinks
= git_config_bool(var
, value
);
682 if (!strcmp(var
, "core.ignorecase")) {
683 ignore_case
= git_config_bool(var
, value
);
687 if (!strcmp(var
, "core.attributesfile"))
688 return git_config_pathname(&git_attributes_file
, var
, value
);
690 if (!strcmp(var
, "core.bare")) {
691 is_bare_repository_cfg
= git_config_bool(var
, value
);
695 if (!strcmp(var
, "core.ignorestat")) {
696 assume_unchanged
= git_config_bool(var
, value
);
700 if (!strcmp(var
, "core.prefersymlinkrefs")) {
701 prefer_symlink_refs
= git_config_bool(var
, value
);
705 if (!strcmp(var
, "core.logallrefupdates")) {
706 log_all_ref_updates
= git_config_bool(var
, value
);
710 if (!strcmp(var
, "core.warnambiguousrefs")) {
711 warn_ambiguous_refs
= git_config_bool(var
, value
);
715 if (!strcmp(var
, "core.abbrev")) {
716 int abbrev
= git_config_int(var
, value
);
717 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
719 default_abbrev
= abbrev
;
723 if (!strcmp(var
, "core.loosecompression")) {
724 int level
= git_config_int(var
, value
);
726 level
= Z_DEFAULT_COMPRESSION
;
727 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
728 die("bad zlib compression level %d", level
);
729 zlib_compression_level
= level
;
730 zlib_compression_seen
= 1;
734 if (!strcmp(var
, "core.compression")) {
735 int level
= git_config_int(var
, value
);
737 level
= Z_DEFAULT_COMPRESSION
;
738 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
739 die("bad zlib compression level %d", level
);
740 core_compression_level
= level
;
741 core_compression_seen
= 1;
742 if (!zlib_compression_seen
)
743 zlib_compression_level
= level
;
747 if (!strcmp(var
, "core.packedgitwindowsize")) {
748 int pgsz_x2
= getpagesize() * 2;
749 packed_git_window_size
= git_config_ulong(var
, value
);
751 /* This value must be multiple of (pagesize * 2) */
752 packed_git_window_size
/= pgsz_x2
;
753 if (packed_git_window_size
< 1)
754 packed_git_window_size
= 1;
755 packed_git_window_size
*= pgsz_x2
;
759 if (!strcmp(var
, "core.bigfilethreshold")) {
760 big_file_threshold
= git_config_ulong(var
, value
);
764 if (!strcmp(var
, "core.packedgitlimit")) {
765 packed_git_limit
= git_config_ulong(var
, value
);
769 if (!strcmp(var
, "core.deltabasecachelimit")) {
770 delta_base_cache_limit
= git_config_ulong(var
, value
);
774 if (!strcmp(var
, "core.autocrlf")) {
775 if (value
&& !strcasecmp(value
, "input")) {
776 if (core_eol
== EOL_CRLF
)
777 return error("core.autocrlf=input conflicts with core.eol=crlf");
778 auto_crlf
= AUTO_CRLF_INPUT
;
781 auto_crlf
= git_config_bool(var
, value
);
785 if (!strcmp(var
, "core.safecrlf")) {
786 if (value
&& !strcasecmp(value
, "warn")) {
787 safe_crlf
= SAFE_CRLF_WARN
;
790 safe_crlf
= git_config_bool(var
, value
);
794 if (!strcmp(var
, "core.eol")) {
795 if (value
&& !strcasecmp(value
, "lf"))
797 else if (value
&& !strcasecmp(value
, "crlf"))
799 else if (value
&& !strcasecmp(value
, "native"))
800 core_eol
= EOL_NATIVE
;
802 core_eol
= EOL_UNSET
;
803 if (core_eol
== EOL_CRLF
&& auto_crlf
== AUTO_CRLF_INPUT
)
804 return error("core.autocrlf=input conflicts with core.eol=crlf");
808 if (!strcmp(var
, "core.notesref")) {
809 notes_ref_name
= xstrdup(value
);
813 if (!strcmp(var
, "core.pager"))
814 return git_config_string(&pager_program
, var
, value
);
816 if (!strcmp(var
, "core.editor"))
817 return git_config_string(&editor_program
, var
, value
);
819 if (!strcmp(var
, "core.commentchar")) {
821 return config_error_nonbool(var
);
822 else if (!strcasecmp(value
, "auto"))
823 auto_comment_line_char
= 1;
824 else if (value
[0] && !value
[1]) {
825 comment_line_char
= value
[0];
826 auto_comment_line_char
= 0;
828 return error("core.commentChar should only be one character");
832 if (!strcmp(var
, "core.askpass"))
833 return git_config_string(&askpass_program
, var
, value
);
835 if (!strcmp(var
, "core.excludesfile"))
836 return git_config_pathname(&excludes_file
, var
, value
);
838 if (!strcmp(var
, "core.whitespace")) {
840 return config_error_nonbool(var
);
841 whitespace_rule_cfg
= parse_whitespace_rule(value
);
845 if (!strcmp(var
, "core.fsyncobjectfiles")) {
846 fsync_object_files
= git_config_bool(var
, value
);
850 if (!strcmp(var
, "core.preloadindex")) {
851 core_preload_index
= git_config_bool(var
, value
);
855 if (!strcmp(var
, "core.createobject")) {
856 if (!strcmp(value
, "rename"))
857 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
858 else if (!strcmp(value
, "link"))
859 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
861 die("Invalid mode for object creation: %s", value
);
865 if (!strcmp(var
, "core.sparsecheckout")) {
866 core_apply_sparse_checkout
= git_config_bool(var
, value
);
870 if (!strcmp(var
, "core.precomposeunicode")) {
871 precomposed_unicode
= git_config_bool(var
, value
);
875 /* Add other config variables here and to Documentation/config.txt. */
879 static int git_default_i18n_config(const char *var
, const char *value
)
881 if (!strcmp(var
, "i18n.commitencoding"))
882 return git_config_string(&git_commit_encoding
, var
, value
);
884 if (!strcmp(var
, "i18n.logoutputencoding"))
885 return git_config_string(&git_log_output_encoding
, var
, value
);
887 /* Add other config variables here and to Documentation/config.txt. */
891 static int git_default_branch_config(const char *var
, const char *value
)
893 if (!strcmp(var
, "branch.autosetupmerge")) {
894 if (value
&& !strcasecmp(value
, "always")) {
895 git_branch_track
= BRANCH_TRACK_ALWAYS
;
898 git_branch_track
= git_config_bool(var
, value
);
901 if (!strcmp(var
, "branch.autosetuprebase")) {
903 return config_error_nonbool(var
);
904 else if (!strcmp(value
, "never"))
905 autorebase
= AUTOREBASE_NEVER
;
906 else if (!strcmp(value
, "local"))
907 autorebase
= AUTOREBASE_LOCAL
;
908 else if (!strcmp(value
, "remote"))
909 autorebase
= AUTOREBASE_REMOTE
;
910 else if (!strcmp(value
, "always"))
911 autorebase
= AUTOREBASE_ALWAYS
;
913 return error("Malformed value for %s", var
);
917 /* Add other config variables here and to Documentation/config.txt. */
921 static int git_default_push_config(const char *var
, const char *value
)
923 if (!strcmp(var
, "push.default")) {
925 return config_error_nonbool(var
);
926 else if (!strcmp(value
, "nothing"))
927 push_default
= PUSH_DEFAULT_NOTHING
;
928 else if (!strcmp(value
, "matching"))
929 push_default
= PUSH_DEFAULT_MATCHING
;
930 else if (!strcmp(value
, "simple"))
931 push_default
= PUSH_DEFAULT_SIMPLE
;
932 else if (!strcmp(value
, "upstream"))
933 push_default
= PUSH_DEFAULT_UPSTREAM
;
934 else if (!strcmp(value
, "tracking")) /* deprecated */
935 push_default
= PUSH_DEFAULT_UPSTREAM
;
936 else if (!strcmp(value
, "current"))
937 push_default
= PUSH_DEFAULT_CURRENT
;
939 error("Malformed value for %s: %s", var
, value
);
940 return error("Must be one of nothing, matching, simple, "
941 "upstream or current.");
946 /* Add other config variables here and to Documentation/config.txt. */
950 static int git_default_mailmap_config(const char *var
, const char *value
)
952 if (!strcmp(var
, "mailmap.file"))
953 return git_config_pathname(&git_mailmap_file
, var
, value
);
954 if (!strcmp(var
, "mailmap.blob"))
955 return git_config_string(&git_mailmap_blob
, var
, value
);
957 /* Add other config variables here and to Documentation/config.txt. */
961 int git_default_config(const char *var
, const char *value
, void *dummy
)
963 if (starts_with(var
, "core."))
964 return git_default_core_config(var
, value
);
966 if (starts_with(var
, "user."))
967 return git_ident_config(var
, value
, dummy
);
969 if (starts_with(var
, "i18n."))
970 return git_default_i18n_config(var
, value
);
972 if (starts_with(var
, "branch."))
973 return git_default_branch_config(var
, value
);
975 if (starts_with(var
, "push."))
976 return git_default_push_config(var
, value
);
978 if (starts_with(var
, "mailmap."))
979 return git_default_mailmap_config(var
, value
);
981 if (starts_with(var
, "advice."))
982 return git_default_advice_config(var
, value
);
984 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
985 pager_use_color
= git_config_bool(var
,value
);
989 if (!strcmp(var
, "pack.packsizelimit")) {
990 pack_size_limit_cfg
= git_config_ulong(var
, value
);
993 /* Add other config variables here and to Documentation/config.txt. */
998 * All source specific fields in the union, die_on_error, name and the callbacks
999 * fgetc, ungetc, ftell of top need to be initialized before calling
1002 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1006 /* push config-file parsing state stack */
1010 strbuf_init(&top
->value
, 1024);
1011 strbuf_init(&top
->var
, 1024);
1014 ret
= git_parse_source(fn
, data
);
1016 /* pop config-file parsing state stack */
1017 strbuf_release(&top
->value
);
1018 strbuf_release(&top
->var
);
1024 static int do_config_from_file(config_fn_t fn
,
1025 const char *name
, const char *path
, FILE *f
, void *data
)
1027 struct config_source top
;
1032 top
.die_on_error
= 1;
1033 top
.do_fgetc
= config_file_fgetc
;
1034 top
.do_ungetc
= config_file_ungetc
;
1035 top
.do_ftell
= config_file_ftell
;
1037 return do_config_from(&top
, fn
, data
);
1040 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1042 return do_config_from_file(fn
, "<stdin>", NULL
, stdin
, data
);
1045 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1050 f
= fopen(filename
, "r");
1052 ret
= do_config_from_file(fn
, filename
, filename
, f
, data
);
1058 int git_config_from_buf(config_fn_t fn
, const char *name
, const char *buf
,
1059 size_t len
, void *data
)
1061 struct config_source top
;
1063 top
.u
.buf
.buf
= buf
;
1064 top
.u
.buf
.len
= len
;
1068 top
.die_on_error
= 0;
1069 top
.do_fgetc
= config_buf_fgetc
;
1070 top
.do_ungetc
= config_buf_ungetc
;
1071 top
.do_ftell
= config_buf_ftell
;
1073 return do_config_from(&top
, fn
, data
);
1076 static int git_config_from_blob_sha1(config_fn_t fn
,
1078 const unsigned char *sha1
,
1081 enum object_type type
;
1086 buf
= read_sha1_file(sha1
, &type
, &size
);
1088 return error("unable to load config blob object '%s'", name
);
1089 if (type
!= OBJ_BLOB
) {
1091 return error("reference '%s' does not point to a blob", name
);
1094 ret
= git_config_from_buf(fn
, name
, buf
, size
, data
);
1100 static int git_config_from_blob_ref(config_fn_t fn
,
1104 unsigned char sha1
[20];
1106 if (get_sha1(name
, sha1
) < 0)
1107 return error("unable to resolve config blob '%s'", name
);
1108 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1111 const char *git_etc_gitconfig(void)
1113 static const char *system_wide
;
1115 system_wide
= system_path(ETC_GITCONFIG
);
1120 * Parse environment variable 'k' as a boolean (in various
1121 * possible spellings); if missing, use the default value 'def'.
1123 int git_env_bool(const char *k
, int def
)
1125 const char *v
= getenv(k
);
1126 return v
? git_config_bool(k
, v
) : def
;
1130 * Parse environment variable 'k' as ulong with possibly a unit
1131 * suffix; if missing, use the default value 'val'.
1133 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1135 const char *v
= getenv(k
);
1136 if (v
&& !git_parse_ulong(v
, &val
))
1137 die("failed to parse %s", k
);
1141 int git_config_system(void)
1143 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1146 int git_config_early(config_fn_t fn
, void *data
, const char *repo_config
)
1148 int ret
= 0, found
= 0;
1149 char *xdg_config
= NULL
;
1150 char *user_config
= NULL
;
1152 home_config_paths(&user_config
, &xdg_config
, "config");
1154 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0)) {
1155 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1160 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
)) {
1161 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1165 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
)) {
1166 ret
+= git_config_from_file(fn
, user_config
, data
);
1170 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0)) {
1171 ret
+= git_config_from_file(fn
, repo_config
, data
);
1175 switch (git_config_from_parameters(fn
, data
)) {
1176 case -1: /* error */
1177 die("unable to parse command-line config");
1179 case 0: /* found nothing */
1181 default: /* found at least one item */
1188 return ret
== 0 ? found
: ret
;
1191 int git_config_with_options(config_fn_t fn
, void *data
,
1192 struct git_config_source
*config_source
,
1193 int respect_includes
)
1195 char *repo_config
= NULL
;
1197 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1199 if (respect_includes
) {
1202 fn
= git_config_include
;
1207 * If we have a specific filename, use it. Otherwise, follow the
1208 * regular lookup sequence.
1210 if (config_source
&& config_source
->use_stdin
)
1211 return git_config_from_stdin(fn
, data
);
1212 else if (config_source
&& config_source
->file
)
1213 return git_config_from_file(fn
, config_source
->file
, data
);
1214 else if (config_source
&& config_source
->blob
)
1215 return git_config_from_blob_ref(fn
, config_source
->blob
, data
);
1217 repo_config
= git_pathdup("config");
1218 ret
= git_config_early(fn
, data
, repo_config
);
1224 int git_config(config_fn_t fn
, void *data
)
1226 return git_config_with_options(fn
, data
, NULL
, 1);
1230 * Find all the stuff for git_config_set() below.
1237 regex_t
*value_regex
;
1240 unsigned int offset_alloc
;
1241 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1245 static int matches(const char *key
, const char *value
)
1247 return !strcmp(key
, store
.key
) &&
1248 (store
.value_regex
== NULL
||
1249 (store
.do_not_match
^
1250 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
1253 static int store_aux(const char *key
, const char *value
, void *cb
)
1258 switch (store
.state
) {
1260 if (matches(key
, value
)) {
1261 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1262 warning("%s has multiple values", key
);
1265 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1266 store
.offset_alloc
);
1268 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1274 * What we are looking for is in store.key (both
1275 * section and var), and its section part is baselen
1276 * long. We found key (again, both section and var).
1277 * We would want to know if this key is in the same
1278 * section as what we are looking for. We already
1279 * know we are in the same section as what should
1282 ep
= strrchr(key
, '.');
1283 section_len
= ep
- key
;
1285 if ((section_len
!= store
.baselen
) ||
1286 memcmp(key
, store
.key
, section_len
+1)) {
1287 store
.state
= SECTION_END_SEEN
;
1292 * Do not increment matches: this is no match, but we
1293 * just made sure we are in the desired section.
1295 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1296 store
.offset_alloc
);
1297 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1299 case SECTION_END_SEEN
:
1301 if (matches(key
, value
)) {
1302 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1303 store
.offset_alloc
);
1304 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1305 store
.state
= KEY_SEEN
;
1308 if (strrchr(key
, '.') - key
== store
.baselen
&&
1309 !strncmp(key
, store
.key
, store
.baselen
)) {
1310 store
.state
= SECTION_SEEN
;
1311 ALLOC_GROW(store
.offset
,
1313 store
.offset_alloc
);
1314 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1321 static int write_error(const char *filename
)
1323 error("failed to write new configuration file %s", filename
);
1325 /* Same error code as "failed to rename". */
1329 static int store_write_section(int fd
, const char *key
)
1333 struct strbuf sb
= STRBUF_INIT
;
1335 dot
= memchr(key
, '.', store
.baselen
);
1337 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1338 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1339 if (key
[i
] == '"' || key
[i
] == '\\')
1340 strbuf_addch(&sb
, '\\');
1341 strbuf_addch(&sb
, key
[i
]);
1343 strbuf_addstr(&sb
, "\"]\n");
1345 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1348 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1349 strbuf_release(&sb
);
1354 static int store_write_pair(int fd
, const char *key
, const char *value
)
1357 int length
= strlen(key
+ store
.baselen
+ 1);
1358 const char *quote
= "";
1359 struct strbuf sb
= STRBUF_INIT
;
1362 * Check to see if the value needs to be surrounded with a dq pair.
1363 * Note that problematic characters are always backslash-quoted; this
1364 * check is about not losing leading or trailing SP and strings that
1365 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1366 * configuration parser.
1368 if (value
[0] == ' ')
1370 for (i
= 0; value
[i
]; i
++)
1371 if (value
[i
] == ';' || value
[i
] == '#')
1373 if (i
&& value
[i
- 1] == ' ')
1376 strbuf_addf(&sb
, "\t%.*s = %s",
1377 length
, key
+ store
.baselen
+ 1, quote
);
1379 for (i
= 0; value
[i
]; i
++)
1382 strbuf_addstr(&sb
, "\\n");
1385 strbuf_addstr(&sb
, "\\t");
1389 strbuf_addch(&sb
, '\\');
1391 strbuf_addch(&sb
, value
[i
]);
1394 strbuf_addf(&sb
, "%s\n", quote
);
1396 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1397 strbuf_release(&sb
);
1402 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1403 size_t offset_
, int *found_bracket
)
1405 size_t equal_offset
= size
, bracket_offset
= size
;
1409 for (offset
= offset_
-2; offset
> 0
1410 && contents
[offset
] != '\n'; offset
--)
1411 switch (contents
[offset
]) {
1412 case '=': equal_offset
= offset
; break;
1413 case ']': bracket_offset
= offset
; break;
1415 if (offset
> 0 && contents
[offset
-1] == '\\') {
1419 if (bracket_offset
< equal_offset
) {
1421 offset
= bracket_offset
+1;
1428 int git_config_set_in_file(const char *config_filename
,
1429 const char *key
, const char *value
)
1431 return git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1434 int git_config_set(const char *key
, const char *value
)
1436 return git_config_set_multivar(key
, value
, NULL
, 0);
1440 * Auxiliary function to sanity-check and split the key into the section
1441 * identifier and variable name.
1443 * Returns 0 on success, -1 when there is an invalid character in the key and
1444 * -2 if there is no section name in the key.
1446 * store_key - pointer to char* which will hold a copy of the key with
1447 * lowercase section and variable name
1448 * baselen - pointer to int which will hold the length of the
1449 * section + subsection part, can be NULL
1451 int git_config_parse_key(const char *key
, char **store_key
, int *baselen_
)
1453 int i
, dot
, baselen
;
1454 const char *last_dot
= strrchr(key
, '.');
1457 * Since "key" actually contains the section name and the real
1458 * key name separated by a dot, we have to know where the dot is.
1461 if (last_dot
== NULL
|| last_dot
== key
) {
1462 error("key does not contain a section: %s", key
);
1463 return -CONFIG_NO_SECTION_OR_NAME
;
1467 error("key does not contain variable name: %s", key
);
1468 return -CONFIG_NO_SECTION_OR_NAME
;
1471 baselen
= last_dot
- key
;
1473 *baselen_
= baselen
;
1476 * Validate the key and while at it, lower case it for matching.
1478 *store_key
= xmalloc(strlen(key
) + 1);
1481 for (i
= 0; key
[i
]; i
++) {
1482 unsigned char c
= key
[i
];
1485 /* Leave the extended basename untouched.. */
1486 if (!dot
|| i
> baselen
) {
1487 if (!iskeychar(c
) ||
1488 (i
== baselen
+ 1 && !isalpha(c
))) {
1489 error("invalid key: %s", key
);
1490 goto out_free_ret_1
;
1493 } else if (c
== '\n') {
1494 error("invalid key (newline): %s", key
);
1495 goto out_free_ret_1
;
1497 (*store_key
)[i
] = c
;
1499 (*store_key
)[i
] = 0;
1506 return -CONFIG_INVALID_KEY
;
1510 * If value==NULL, unset in (remove from) config,
1511 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1512 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1513 * else all matching key/values (regardless how many) are removed,
1514 * before the new pair is written.
1516 * Returns 0 on success.
1518 * This function does this:
1520 * - it locks the config file by creating ".git/config.lock"
1522 * - it then parses the config using store_aux() as validator to find
1523 * the position on the key/value pair to replace. If it is to be unset,
1524 * it must be found exactly once.
1526 * - the config file is mmap()ed and the part before the match (if any) is
1527 * written to the lock file, then the changed part and the rest.
1529 * - the config file is removed and the lock file rename()d to it.
1532 int git_config_set_multivar_in_file(const char *config_filename
,
1533 const char *key
, const char *value
,
1534 const char *value_regex
, int multi_replace
)
1538 struct lock_file
*lock
= NULL
;
1539 char *filename_buf
= NULL
;
1541 /* parse-key returns negative; flip the sign to feed exit(3) */
1542 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
1546 store
.multi_replace
= multi_replace
;
1548 if (!config_filename
)
1549 config_filename
= filename_buf
= git_pathdup("config");
1552 * The lock serves a purpose in addition to locking: the new
1553 * contents of .git/config will be written into it.
1555 lock
= xcalloc(1, sizeof(struct lock_file
));
1556 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1558 error("could not lock config file %s: %s", config_filename
, strerror(errno
));
1560 ret
= CONFIG_NO_LOCK
;
1565 * If .git/config does not exist yet, write a minimal version.
1567 in_fd
= open(config_filename
, O_RDONLY
);
1571 if ( ENOENT
!= errno
) {
1572 error("opening %s: %s", config_filename
,
1574 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
1577 /* if nothing to unset, error out */
1578 if (value
== NULL
) {
1579 ret
= CONFIG_NOTHING_SET
;
1583 store
.key
= (char *)key
;
1584 if (!store_write_section(fd
, key
) ||
1585 !store_write_pair(fd
, key
, value
))
1590 size_t contents_sz
, copy_begin
, copy_end
;
1591 int i
, new_line
= 0;
1593 if (value_regex
== NULL
)
1594 store
.value_regex
= NULL
;
1596 if (value_regex
[0] == '!') {
1597 store
.do_not_match
= 1;
1600 store
.do_not_match
= 0;
1602 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
1603 if (regcomp(store
.value_regex
, value_regex
,
1605 error("invalid pattern: %s", value_regex
);
1606 free(store
.value_regex
);
1607 ret
= CONFIG_INVALID_PATTERN
;
1612 ALLOC_GROW(store
.offset
, 1, store
.offset_alloc
);
1613 store
.offset
[0] = 0;
1614 store
.state
= START
;
1618 * After this, store.offset will contain the *end* offset
1619 * of the last match, or remain at 0 if no match was found.
1620 * As a side effect, we make sure to transform only a valid
1621 * existing config file.
1623 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
1624 error("invalid config file %s", config_filename
);
1626 if (store
.value_regex
!= NULL
) {
1627 regfree(store
.value_regex
);
1628 free(store
.value_regex
);
1630 ret
= CONFIG_INVALID_FILE
;
1635 if (store
.value_regex
!= NULL
) {
1636 regfree(store
.value_regex
);
1637 free(store
.value_regex
);
1640 /* if nothing to unset, or too many matches, error out */
1641 if ((store
.seen
== 0 && value
== NULL
) ||
1642 (store
.seen
> 1 && multi_replace
== 0)) {
1643 ret
= CONFIG_NOTHING_SET
;
1648 contents_sz
= xsize_t(st
.st_size
);
1649 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
1650 MAP_PRIVATE
, in_fd
, 0);
1653 if (chmod(lock
->filename
, st
.st_mode
& 07777) < 0) {
1654 error("chmod on %s failed: %s",
1655 lock
->filename
, strerror(errno
));
1656 ret
= CONFIG_NO_WRITE
;
1660 if (store
.seen
== 0)
1663 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
1664 if (store
.offset
[i
] == 0) {
1665 store
.offset
[i
] = copy_end
= contents_sz
;
1666 } else if (store
.state
!= KEY_SEEN
) {
1667 copy_end
= store
.offset
[i
];
1669 copy_end
= find_beginning_of_line(
1670 contents
, contents_sz
,
1671 store
.offset
[i
]-2, &new_line
);
1673 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
1676 /* write the first part of the config */
1677 if (copy_end
> copy_begin
) {
1678 if (write_in_full(fd
, contents
+ copy_begin
,
1679 copy_end
- copy_begin
) <
1680 copy_end
- copy_begin
)
1683 write_str_in_full(fd
, "\n") != 1)
1686 copy_begin
= store
.offset
[i
];
1689 /* write the pair (value == NULL means unset) */
1690 if (value
!= NULL
) {
1691 if (store
.state
== START
) {
1692 if (!store_write_section(fd
, key
))
1695 if (!store_write_pair(fd
, key
, value
))
1699 /* write the rest of the config */
1700 if (copy_begin
< contents_sz
)
1701 if (write_in_full(fd
, contents
+ copy_begin
,
1702 contents_sz
- copy_begin
) <
1703 contents_sz
- copy_begin
)
1706 munmap(contents
, contents_sz
);
1709 if (commit_lock_file(lock
) < 0) {
1710 error("could not commit config file %s", config_filename
);
1711 ret
= CONFIG_NO_WRITE
;
1716 * lock is committed, so don't try to roll it back below.
1717 * NOTE: Since lockfile.c keeps a linked list of all created
1718 * lock_file structures, it isn't safe to free(lock). It's
1719 * better to just leave it hanging around.
1726 rollback_lock_file(lock
);
1731 ret
= write_error(lock
->filename
);
1736 int git_config_set_multivar(const char *key
, const char *value
,
1737 const char *value_regex
, int multi_replace
)
1739 return git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
1743 static int section_name_match (const char *buf
, const char *name
)
1745 int i
= 0, j
= 0, dot
= 0;
1748 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
1749 if (!dot
&& isspace(buf
[i
])) {
1751 if (name
[j
++] != '.')
1753 for (i
++; isspace(buf
[i
]); i
++)
1759 if (buf
[i
] == '\\' && dot
)
1761 else if (buf
[i
] == '"' && dot
) {
1762 for (i
++; isspace(buf
[i
]); i
++)
1766 if (buf
[i
] != name
[j
++])
1769 if (buf
[i
] == ']' && name
[j
] == 0) {
1771 * We match, now just find the right length offset by
1772 * gobbling up any whitespace after it, as well
1775 for (; buf
[i
] && isspace(buf
[i
]); i
++)
1782 static int section_name_is_ok(const char *name
)
1784 /* Empty section names are bogus. */
1789 * Before a dot, we must be alphanumeric or dash. After the first dot,
1790 * anything goes, so we can stop checking.
1792 for (; *name
&& *name
!= '.'; name
++)
1793 if (*name
!= '-' && !isalnum(*name
))
1798 /* if new_name == NULL, the section is removed instead */
1799 int git_config_rename_section_in_file(const char *config_filename
,
1800 const char *old_name
, const char *new_name
)
1802 int ret
= 0, remove
= 0;
1803 char *filename_buf
= NULL
;
1804 struct lock_file
*lock
;
1810 if (new_name
&& !section_name_is_ok(new_name
)) {
1811 ret
= error("invalid section name: %s", new_name
);
1815 if (!config_filename
)
1816 config_filename
= filename_buf
= git_pathdup("config");
1818 lock
= xcalloc(1, sizeof(struct lock_file
));
1819 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1821 ret
= error("could not lock config file %s", config_filename
);
1825 if (!(config_file
= fopen(config_filename
, "rb"))) {
1826 /* no config file means nothing to rename, no error */
1827 goto unlock_and_out
;
1830 fstat(fileno(config_file
), &st
);
1832 if (chmod(lock
->filename
, st
.st_mode
& 07777) < 0) {
1833 ret
= error("chmod on %s failed: %s",
1834 lock
->filename
, strerror(errno
));
1838 while (fgets(buf
, sizeof(buf
), config_file
)) {
1842 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1844 if (buf
[i
] == '[') {
1845 /* it's a section */
1846 int offset
= section_name_match(&buf
[i
], old_name
);
1849 if (new_name
== NULL
) {
1853 store
.baselen
= strlen(new_name
);
1854 if (!store_write_section(out_fd
, new_name
)) {
1855 ret
= write_error(lock
->filename
);
1859 * We wrote out the new section, with
1860 * a newline, now skip the old
1863 output
+= offset
+ i
;
1864 if (strlen(output
) > 0) {
1866 * More content means there's
1867 * a declaration to put on the
1868 * next line; indent with a
1879 length
= strlen(output
);
1880 if (write_in_full(out_fd
, output
, length
) != length
) {
1881 ret
= write_error(lock
->filename
);
1885 fclose(config_file
);
1887 if (commit_lock_file(lock
) < 0)
1888 ret
= error("could not commit config file %s", config_filename
);
1894 int git_config_rename_section(const char *old_name
, const char *new_name
)
1896 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
1900 * Call this to report error for your variable that should not
1901 * get a boolean value (i.e. "[my] var" means "true").
1903 #undef config_error_nonbool
1904 int config_error_nonbool(const char *var
)
1906 return error("Missing value for '%s'", var
);
1909 int parse_config_key(const char *var
,
1910 const char *section
,
1911 const char **subsection
, int *subsection_len
,
1914 int section_len
= strlen(section
);
1917 /* Does it start with "section." ? */
1918 if (!starts_with(var
, section
) || var
[section_len
] != '.')
1922 * Find the key; we don't know yet if we have a subsection, but we must
1923 * parse backwards from the end, since the subsection may have dots in
1926 dot
= strrchr(var
, '.');
1929 /* Did we have a subsection at all? */
1930 if (dot
== var
+ section_len
) {
1932 *subsection_len
= 0;
1935 *subsection
= var
+ section_len
+ 1;
1936 *subsection_len
= dot
- *subsection
;