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
;
30 int (*fgetc
)(struct config_source
*c
);
31 int (*ungetc
)(int c
, struct config_source
*conf
);
32 long (*ftell
)(struct config_source
*c
);
35 static struct config_source
*cf
;
37 static int zlib_compression_seen
;
39 static int config_file_fgetc(struct config_source
*conf
)
41 return fgetc(conf
->u
.file
);
44 static int config_file_ungetc(int c
, struct config_source
*conf
)
46 return ungetc(c
, conf
->u
.file
);
49 static long config_file_ftell(struct config_source
*conf
)
51 return ftell(conf
->u
.file
);
55 static int config_buf_fgetc(struct config_source
*conf
)
57 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
58 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
63 static int config_buf_ungetc(int c
, struct config_source
*conf
)
65 if (conf
->u
.buf
.pos
> 0)
66 return conf
->u
.buf
.buf
[--conf
->u
.buf
.pos
];
71 static long config_buf_ftell(struct config_source
*conf
)
73 return conf
->u
.buf
.pos
;
76 #define MAX_INCLUDE_DEPTH 10
77 static const char include_depth_advice
[] =
78 "exceeded maximum include depth (%d) while including\n"
82 "Do you have circular includes?";
83 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
86 struct strbuf buf
= STRBUF_INIT
;
87 char *expanded
= expand_user_path(path
);
90 return error("Could not expand include path '%s'", path
);
94 * Use an absolute path as-is, but interpret relative paths
95 * based on the including config file.
97 if (!is_absolute_path(path
)) {
100 if (!cf
|| !cf
->name
)
101 return error("relative config includes must come from files");
103 slash
= find_last_dir_sep(cf
->name
);
105 strbuf_add(&buf
, cf
->name
, slash
- cf
->name
+ 1);
106 strbuf_addstr(&buf
, path
);
110 if (!access_or_die(path
, R_OK
, 0)) {
111 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
112 die(include_depth_advice
, MAX_INCLUDE_DEPTH
, path
,
113 cf
&& cf
->name
? cf
->name
: "the command line");
114 ret
= git_config_from_file(git_config_include
, path
, inc
);
117 strbuf_release(&buf
);
122 int git_config_include(const char *var
, const char *value
, void *data
)
124 struct config_include_data
*inc
= data
;
129 * Pass along all values, including "include" directives; this makes it
130 * possible to query information on the includes themselves.
132 ret
= inc
->fn(var
, value
, inc
->data
);
136 type
= skip_prefix(var
, "include.");
140 if (!strcmp(type
, "path"))
141 ret
= handle_path_include(value
, inc
);
145 static void lowercase(char *p
)
151 void git_config_push_parameter(const char *text
)
153 struct strbuf env
= STRBUF_INIT
;
154 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
156 strbuf_addstr(&env
, old
);
157 strbuf_addch(&env
, ' ');
159 sq_quote_buf(&env
, text
);
160 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
161 strbuf_release(&env
);
164 int git_config_parse_parameter(const char *text
,
165 config_fn_t fn
, void *data
)
167 struct strbuf
**pair
;
168 pair
= strbuf_split_str(text
, '=', 2);
170 return error("bogus config parameter: %s", text
);
171 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=')
172 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
173 strbuf_trim(pair
[0]);
175 strbuf_list_free(pair
);
176 return error("bogus config parameter: %s", text
);
178 lowercase(pair
[0]->buf
);
179 if (fn(pair
[0]->buf
, pair
[1] ? pair
[1]->buf
: NULL
, data
) < 0) {
180 strbuf_list_free(pair
);
183 strbuf_list_free(pair
);
187 int git_config_from_parameters(config_fn_t fn
, void *data
)
189 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
191 const char **argv
= NULL
;
192 int nr
= 0, alloc
= 0;
197 /* sq_dequote will write over it */
200 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
202 return error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
205 for (i
= 0; i
< nr
; i
++) {
206 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
218 static int get_next_char(void)
220 int c
= cf
->fgetc(cf
);
223 /* DOS like systems */
239 static char *parse_value(void)
241 int quote
= 0, comment
= 0, space
= 0;
243 strbuf_reset(&cf
->value
);
245 int c
= get_next_char();
251 return cf
->value
.buf
;
255 if (isspace(c
) && !quote
) {
261 if (c
== ';' || c
== '#') {
266 for (; space
; space
--)
267 strbuf_addch(&cf
->value
, ' ');
282 /* Some characters escape as themselves */
285 /* Reject unknown escape sequences */
289 strbuf_addch(&cf
->value
, c
);
296 strbuf_addch(&cf
->value
, c
);
300 static inline int iskeychar(int c
)
302 return isalnum(c
) || c
== '-';
305 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
310 /* Get the full name */
317 strbuf_addch(name
, tolower(c
));
320 while (c
== ' ' || c
== '\t')
327 value
= parse_value();
331 return fn(name
->buf
, value
, data
);
334 static int get_extended_base_var(struct strbuf
*name
, int c
)
338 goto error_incomplete_line
;
340 } while (isspace(c
));
342 /* We require the format to be '[base "extension"]' */
345 strbuf_addch(name
, '.');
348 int c
= get_next_char();
350 goto error_incomplete_line
;
356 goto error_incomplete_line
;
358 strbuf_addch(name
, c
);
362 if (get_next_char() != ']')
365 error_incomplete_line
:
370 static int get_base_var(struct strbuf
*name
)
373 int c
= get_next_char();
379 return get_extended_base_var(name
, c
);
380 if (!iskeychar(c
) && c
!= '.')
382 strbuf_addch(name
, tolower(c
));
386 static int git_parse_source(config_fn_t fn
, void *data
)
390 struct strbuf
*var
= &cf
->var
;
392 /* U+FEFF Byte Order Mark in UTF8 */
393 static const unsigned char *utf8_bom
= (unsigned char *) "\xef\xbb\xbf";
394 const unsigned char *bomptr
= utf8_bom
;
397 int c
= get_next_char();
398 if (bomptr
&& *bomptr
) {
399 /* We are at the file beginning; skip UTF8-encoded BOM
400 * if present. Sane editors won't put this in on their
401 * own, but e.g. Windows Notepad will do it happily. */
402 if ((unsigned char) c
== *bomptr
) {
406 /* Do not tolerate partial BOM. */
407 if (bomptr
!= utf8_bom
)
409 /* No BOM at file beginning. Cool. */
419 if (comment
|| isspace(c
))
421 if (c
== '#' || c
== ';') {
426 /* Reset prior to determining a new stem */
428 if (get_base_var(var
) < 0 || var
->len
< 1)
430 strbuf_addch(var
, '.');
437 * Truncate the var name back to the section header
438 * stem prior to grabbing the suffix part of the name
441 strbuf_setlen(var
, baselen
);
442 strbuf_addch(var
, tolower(c
));
443 if (get_value(fn
, data
, var
) < 0)
446 if (cf
->die_on_error
)
447 die("bad config file line %d in %s", cf
->linenr
, cf
->name
);
449 return error("bad config file line %d in %s", cf
->linenr
, cf
->name
);
452 static int parse_unit_factor(const char *end
, uintmax_t *val
)
456 else if (!strcasecmp(end
, "k")) {
460 else if (!strcasecmp(end
, "m")) {
464 else if (!strcasecmp(end
, "g")) {
465 *val
*= 1024 * 1024 * 1024;
471 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
473 if (value
&& *value
) {
477 uintmax_t factor
= 1;
480 val
= strtoimax(value
, &end
, 0);
483 if (!parse_unit_factor(end
, &factor
)) {
489 if (uval
> max
|| abs(val
) > uval
) {
501 int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
503 if (value
&& *value
) {
509 val
= strtoumax(value
, &end
, 0);
513 if (!parse_unit_factor(end
, &val
)) {
517 if (val
> max
|| oldval
> val
) {
528 static int git_parse_int(const char *value
, int *ret
)
531 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
537 int git_parse_ulong(const char *value
, unsigned long *ret
)
540 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
546 static void die_bad_config(const char *name
)
549 die("bad config value for '%s' in %s", name
, cf
->name
);
550 die("bad config value for '%s'", name
);
553 int git_config_int(const char *name
, const char *value
)
556 if (!git_parse_int(value
, &ret
))
557 die_bad_config(name
);
561 unsigned long git_config_ulong(const char *name
, const char *value
)
564 if (!git_parse_ulong(value
, &ret
))
565 die_bad_config(name
);
569 static int git_config_maybe_bool_text(const char *name
, const char *value
)
575 if (!strcasecmp(value
, "true")
576 || !strcasecmp(value
, "yes")
577 || !strcasecmp(value
, "on"))
579 if (!strcasecmp(value
, "false")
580 || !strcasecmp(value
, "no")
581 || !strcasecmp(value
, "off"))
586 int git_config_maybe_bool(const char *name
, const char *value
)
588 int v
= git_config_maybe_bool_text(name
, value
);
591 if (git_parse_int(value
, &v
))
596 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
598 int v
= git_config_maybe_bool_text(name
, value
);
604 return git_config_int(name
, value
);
607 int git_config_bool(const char *name
, const char *value
)
610 return !!git_config_bool_or_int(name
, value
, &discard
);
613 int git_config_string(const char **dest
, const char *var
, const char *value
)
616 return config_error_nonbool(var
);
617 *dest
= xstrdup(value
);
621 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
624 return config_error_nonbool(var
);
625 *dest
= expand_user_path(value
);
627 die("Failed to expand user dir in: '%s'", value
);
631 static int git_default_core_config(const char *var
, const char *value
)
633 /* This needs a better name */
634 if (!strcmp(var
, "core.filemode")) {
635 trust_executable_bit
= git_config_bool(var
, value
);
638 if (!strcmp(var
, "core.trustctime")) {
639 trust_ctime
= git_config_bool(var
, value
);
642 if (!strcmp(var
, "core.statinfo") ||
643 !strcmp(var
, "core.checkstat")) {
645 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
646 * never been advertised. we will remove it at Git
649 if (!strcmp(var
, "core.statinfo")) {
652 warning("'core.statinfo' will be removed in Git 2.0; "
653 "use 'core.checkstat' instead.");
656 if (!strcasecmp(value
, "default"))
658 else if (!strcasecmp(value
, "minimal"))
662 if (!strcmp(var
, "core.quotepath")) {
663 quote_path_fully
= git_config_bool(var
, value
);
667 if (!strcmp(var
, "core.symlinks")) {
668 has_symlinks
= git_config_bool(var
, value
);
672 if (!strcmp(var
, "core.ignorecase")) {
673 ignore_case
= git_config_bool(var
, value
);
677 if (!strcmp(var
, "core.attributesfile"))
678 return git_config_pathname(&git_attributes_file
, var
, value
);
680 if (!strcmp(var
, "core.bare")) {
681 is_bare_repository_cfg
= git_config_bool(var
, value
);
685 if (!strcmp(var
, "core.ignorestat")) {
686 assume_unchanged
= git_config_bool(var
, value
);
690 if (!strcmp(var
, "core.prefersymlinkrefs")) {
691 prefer_symlink_refs
= git_config_bool(var
, value
);
695 if (!strcmp(var
, "core.logallrefupdates")) {
696 log_all_ref_updates
= git_config_bool(var
, value
);
700 if (!strcmp(var
, "core.warnambiguousrefs")) {
701 warn_ambiguous_refs
= git_config_bool(var
, value
);
705 if (!strcmp(var
, "core.abbrev")) {
706 int abbrev
= git_config_int(var
, value
);
707 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
709 default_abbrev
= abbrev
;
713 if (!strcmp(var
, "core.loosecompression")) {
714 int level
= git_config_int(var
, value
);
716 level
= Z_DEFAULT_COMPRESSION
;
717 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
718 die("bad zlib compression level %d", level
);
719 zlib_compression_level
= level
;
720 zlib_compression_seen
= 1;
724 if (!strcmp(var
, "core.compression")) {
725 int level
= git_config_int(var
, value
);
727 level
= Z_DEFAULT_COMPRESSION
;
728 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
729 die("bad zlib compression level %d", level
);
730 core_compression_level
= level
;
731 core_compression_seen
= 1;
732 if (!zlib_compression_seen
)
733 zlib_compression_level
= level
;
737 if (!strcmp(var
, "core.packedgitwindowsize")) {
738 int pgsz_x2
= getpagesize() * 2;
739 packed_git_window_size
= git_config_ulong(var
, value
);
741 /* This value must be multiple of (pagesize * 2) */
742 packed_git_window_size
/= pgsz_x2
;
743 if (packed_git_window_size
< 1)
744 packed_git_window_size
= 1;
745 packed_git_window_size
*= pgsz_x2
;
749 if (!strcmp(var
, "core.bigfilethreshold")) {
750 big_file_threshold
= git_config_ulong(var
, value
);
754 if (!strcmp(var
, "core.packedgitlimit")) {
755 packed_git_limit
= git_config_ulong(var
, value
);
759 if (!strcmp(var
, "core.deltabasecachelimit")) {
760 delta_base_cache_limit
= git_config_ulong(var
, value
);
764 if (!strcmp(var
, "core.autocrlf")) {
765 if (value
&& !strcasecmp(value
, "input")) {
766 if (core_eol
== EOL_CRLF
)
767 return error("core.autocrlf=input conflicts with core.eol=crlf");
768 auto_crlf
= AUTO_CRLF_INPUT
;
771 auto_crlf
= git_config_bool(var
, value
);
775 if (!strcmp(var
, "core.safecrlf")) {
776 if (value
&& !strcasecmp(value
, "warn")) {
777 safe_crlf
= SAFE_CRLF_WARN
;
780 safe_crlf
= git_config_bool(var
, value
);
784 if (!strcmp(var
, "core.eol")) {
785 if (value
&& !strcasecmp(value
, "lf"))
787 else if (value
&& !strcasecmp(value
, "crlf"))
789 else if (value
&& !strcasecmp(value
, "native"))
790 core_eol
= EOL_NATIVE
;
792 core_eol
= EOL_UNSET
;
793 if (core_eol
== EOL_CRLF
&& auto_crlf
== AUTO_CRLF_INPUT
)
794 return error("core.autocrlf=input conflicts with core.eol=crlf");
798 if (!strcmp(var
, "core.notesref")) {
799 notes_ref_name
= xstrdup(value
);
803 if (!strcmp(var
, "core.pager"))
804 return git_config_string(&pager_program
, var
, value
);
806 if (!strcmp(var
, "core.editor"))
807 return git_config_string(&editor_program
, var
, value
);
809 if (!strcmp(var
, "core.commentchar")) {
811 int ret
= git_config_string(&comment
, var
, value
);
813 comment_line_char
= comment
[0];
817 if (!strcmp(var
, "core.askpass"))
818 return git_config_string(&askpass_program
, var
, value
);
820 if (!strcmp(var
, "core.excludesfile"))
821 return git_config_pathname(&excludes_file
, var
, value
);
823 if (!strcmp(var
, "core.whitespace")) {
825 return config_error_nonbool(var
);
826 whitespace_rule_cfg
= parse_whitespace_rule(value
);
830 if (!strcmp(var
, "core.fsyncobjectfiles")) {
831 fsync_object_files
= git_config_bool(var
, value
);
835 if (!strcmp(var
, "core.preloadindex")) {
836 core_preload_index
= git_config_bool(var
, value
);
840 if (!strcmp(var
, "core.createobject")) {
841 if (!strcmp(value
, "rename"))
842 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
843 else if (!strcmp(value
, "link"))
844 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
846 die("Invalid mode for object creation: %s", value
);
850 if (!strcmp(var
, "core.sparsecheckout")) {
851 core_apply_sparse_checkout
= git_config_bool(var
, value
);
855 if (!strcmp(var
, "core.precomposeunicode")) {
856 precomposed_unicode
= git_config_bool(var
, value
);
860 /* Add other config variables here and to Documentation/config.txt. */
864 static int git_default_i18n_config(const char *var
, const char *value
)
866 if (!strcmp(var
, "i18n.commitencoding"))
867 return git_config_string(&git_commit_encoding
, var
, value
);
869 if (!strcmp(var
, "i18n.logoutputencoding"))
870 return git_config_string(&git_log_output_encoding
, var
, value
);
872 /* Add other config variables here and to Documentation/config.txt. */
876 static int git_default_branch_config(const char *var
, const char *value
)
878 if (!strcmp(var
, "branch.autosetupmerge")) {
879 if (value
&& !strcasecmp(value
, "always")) {
880 git_branch_track
= BRANCH_TRACK_ALWAYS
;
883 git_branch_track
= git_config_bool(var
, value
);
886 if (!strcmp(var
, "branch.autosetuprebase")) {
888 return config_error_nonbool(var
);
889 else if (!strcmp(value
, "never"))
890 autorebase
= AUTOREBASE_NEVER
;
891 else if (!strcmp(value
, "local"))
892 autorebase
= AUTOREBASE_LOCAL
;
893 else if (!strcmp(value
, "remote"))
894 autorebase
= AUTOREBASE_REMOTE
;
895 else if (!strcmp(value
, "always"))
896 autorebase
= AUTOREBASE_ALWAYS
;
898 return error("Malformed value for %s", var
);
902 /* Add other config variables here and to Documentation/config.txt. */
906 static int git_default_push_config(const char *var
, const char *value
)
908 if (!strcmp(var
, "push.default")) {
910 return config_error_nonbool(var
);
911 else if (!strcmp(value
, "nothing"))
912 push_default
= PUSH_DEFAULT_NOTHING
;
913 else if (!strcmp(value
, "matching"))
914 push_default
= PUSH_DEFAULT_MATCHING
;
915 else if (!strcmp(value
, "simple"))
916 push_default
= PUSH_DEFAULT_SIMPLE
;
917 else if (!strcmp(value
, "upstream"))
918 push_default
= PUSH_DEFAULT_UPSTREAM
;
919 else if (!strcmp(value
, "tracking")) /* deprecated */
920 push_default
= PUSH_DEFAULT_UPSTREAM
;
921 else if (!strcmp(value
, "current"))
922 push_default
= PUSH_DEFAULT_CURRENT
;
924 error("Malformed value for %s: %s", var
, value
);
925 return error("Must be one of nothing, matching, simple, "
926 "upstream or current.");
931 /* Add other config variables here and to Documentation/config.txt. */
935 static int git_default_mailmap_config(const char *var
, const char *value
)
937 if (!strcmp(var
, "mailmap.file"))
938 return git_config_string(&git_mailmap_file
, var
, value
);
939 if (!strcmp(var
, "mailmap.blob"))
940 return git_config_string(&git_mailmap_blob
, var
, value
);
942 /* Add other config variables here and to Documentation/config.txt. */
946 int git_default_config(const char *var
, const char *value
, void *dummy
)
948 if (!prefixcmp(var
, "core."))
949 return git_default_core_config(var
, value
);
951 if (!prefixcmp(var
, "user."))
952 return git_ident_config(var
, value
, dummy
);
954 if (!prefixcmp(var
, "i18n."))
955 return git_default_i18n_config(var
, value
);
957 if (!prefixcmp(var
, "branch."))
958 return git_default_branch_config(var
, value
);
960 if (!prefixcmp(var
, "push."))
961 return git_default_push_config(var
, value
);
963 if (!prefixcmp(var
, "mailmap."))
964 return git_default_mailmap_config(var
, value
);
966 if (!prefixcmp(var
, "advice."))
967 return git_default_advice_config(var
, value
);
969 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
970 pager_use_color
= git_config_bool(var
,value
);
974 if (!strcmp(var
, "pack.packsizelimit")) {
975 pack_size_limit_cfg
= git_config_ulong(var
, value
);
978 /* Add other config variables here and to Documentation/config.txt. */
983 * All source specific fields in the union, die_on_error, name and the callbacks
984 * fgetc, ungetc, ftell of top need to be initialized before calling
987 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
991 /* push config-file parsing state stack */
995 strbuf_init(&top
->value
, 1024);
996 strbuf_init(&top
->var
, 1024);
999 ret
= git_parse_source(fn
, data
);
1001 /* pop config-file parsing state stack */
1002 strbuf_release(&top
->value
);
1003 strbuf_release(&top
->var
);
1009 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1012 FILE *f
= fopen(filename
, "r");
1016 struct config_source top
;
1019 top
.name
= filename
;
1020 top
.die_on_error
= 1;
1021 top
.fgetc
= config_file_fgetc
;
1022 top
.ungetc
= config_file_ungetc
;
1023 top
.ftell
= config_file_ftell
;
1025 ret
= do_config_from(&top
, fn
, data
);
1032 int git_config_from_buf(config_fn_t fn
, const char *name
, const char *buf
,
1033 size_t len
, void *data
)
1035 struct config_source top
;
1037 top
.u
.buf
.buf
= buf
;
1038 top
.u
.buf
.len
= len
;
1041 top
.die_on_error
= 0;
1042 top
.fgetc
= config_buf_fgetc
;
1043 top
.ungetc
= config_buf_ungetc
;
1044 top
.ftell
= config_buf_ftell
;
1046 return do_config_from(&top
, fn
, data
);
1049 static int git_config_from_blob_sha1(config_fn_t fn
,
1051 const unsigned char *sha1
,
1054 enum object_type type
;
1059 buf
= read_sha1_file(sha1
, &type
, &size
);
1061 return error("unable to load config blob object '%s'", name
);
1062 if (type
!= OBJ_BLOB
) {
1064 return error("reference '%s' does not point to a blob", name
);
1067 ret
= git_config_from_buf(fn
, name
, buf
, size
, data
);
1073 static int git_config_from_blob_ref(config_fn_t fn
,
1077 unsigned char sha1
[20];
1079 if (get_sha1(name
, sha1
) < 0)
1080 return error("unable to resolve config blob '%s'", name
);
1081 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1084 const char *git_etc_gitconfig(void)
1086 static const char *system_wide
;
1088 system_wide
= system_path(ETC_GITCONFIG
);
1092 int git_env_bool(const char *k
, int def
)
1094 const char *v
= getenv(k
);
1095 return v
? git_config_bool(k
, v
) : def
;
1098 int git_config_system(void)
1100 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1103 int git_config_early(config_fn_t fn
, void *data
, const char *repo_config
)
1105 int ret
= 0, found
= 0;
1106 char *xdg_config
= NULL
;
1107 char *user_config
= NULL
;
1109 home_config_paths(&user_config
, &xdg_config
, "config");
1111 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0)) {
1112 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1117 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
)) {
1118 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1122 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
)) {
1123 ret
+= git_config_from_file(fn
, user_config
, data
);
1127 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0)) {
1128 ret
+= git_config_from_file(fn
, repo_config
, data
);
1132 switch (git_config_from_parameters(fn
, data
)) {
1133 case -1: /* error */
1134 die("unable to parse command-line config");
1136 case 0: /* found nothing */
1138 default: /* found at least one item */
1145 return ret
== 0 ? found
: ret
;
1148 int git_config_with_options(config_fn_t fn
, void *data
,
1149 const char *filename
,
1150 const char *blob_ref
,
1151 int respect_includes
)
1153 char *repo_config
= NULL
;
1155 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1157 if (respect_includes
) {
1160 fn
= git_config_include
;
1165 * If we have a specific filename, use it. Otherwise, follow the
1166 * regular lookup sequence.
1169 return git_config_from_file(fn
, filename
, data
);
1171 return git_config_from_blob_ref(fn
, blob_ref
, data
);
1173 repo_config
= git_pathdup("config");
1174 ret
= git_config_early(fn
, data
, repo_config
);
1180 int git_config(config_fn_t fn
, void *data
)
1182 return git_config_with_options(fn
, data
, NULL
, NULL
, 1);
1186 * Find all the stuff for git_config_set() below.
1189 #define MAX_MATCHES 512
1195 regex_t
*value_regex
;
1197 size_t offset
[MAX_MATCHES
];
1198 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1202 static int matches(const char *key
, const char *value
)
1204 return !strcmp(key
, store
.key
) &&
1205 (store
.value_regex
== NULL
||
1206 (store
.do_not_match
^
1207 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
1210 static int store_aux(const char *key
, const char *value
, void *cb
)
1215 switch (store
.state
) {
1217 if (matches(key
, value
)) {
1218 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1219 warning("%s has multiple values", key
);
1220 } else if (store
.seen
>= MAX_MATCHES
) {
1221 error("too many matches for %s", key
);
1225 store
.offset
[store
.seen
] = cf
->ftell(cf
);
1231 * What we are looking for is in store.key (both
1232 * section and var), and its section part is baselen
1233 * long. We found key (again, both section and var).
1234 * We would want to know if this key is in the same
1235 * section as what we are looking for. We already
1236 * know we are in the same section as what should
1239 ep
= strrchr(key
, '.');
1240 section_len
= ep
- key
;
1242 if ((section_len
!= store
.baselen
) ||
1243 memcmp(key
, store
.key
, section_len
+1)) {
1244 store
.state
= SECTION_END_SEEN
;
1249 * Do not increment matches: this is no match, but we
1250 * just made sure we are in the desired section.
1252 store
.offset
[store
.seen
] = cf
->ftell(cf
);
1254 case SECTION_END_SEEN
:
1256 if (matches(key
, value
)) {
1257 store
.offset
[store
.seen
] = cf
->ftell(cf
);
1258 store
.state
= KEY_SEEN
;
1261 if (strrchr(key
, '.') - key
== store
.baselen
&&
1262 !strncmp(key
, store
.key
, store
.baselen
)) {
1263 store
.state
= SECTION_SEEN
;
1264 store
.offset
[store
.seen
] = cf
->ftell(cf
);
1271 static int write_error(const char *filename
)
1273 error("failed to write new configuration file %s", filename
);
1275 /* Same error code as "failed to rename". */
1279 static int store_write_section(int fd
, const char *key
)
1283 struct strbuf sb
= STRBUF_INIT
;
1285 dot
= memchr(key
, '.', store
.baselen
);
1287 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1288 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1289 if (key
[i
] == '"' || key
[i
] == '\\')
1290 strbuf_addch(&sb
, '\\');
1291 strbuf_addch(&sb
, key
[i
]);
1293 strbuf_addstr(&sb
, "\"]\n");
1295 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1298 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1299 strbuf_release(&sb
);
1304 static int store_write_pair(int fd
, const char *key
, const char *value
)
1307 int length
= strlen(key
+ store
.baselen
+ 1);
1308 const char *quote
= "";
1309 struct strbuf sb
= STRBUF_INIT
;
1312 * Check to see if the value needs to be surrounded with a dq pair.
1313 * Note that problematic characters are always backslash-quoted; this
1314 * check is about not losing leading or trailing SP and strings that
1315 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1316 * configuration parser.
1318 if (value
[0] == ' ')
1320 for (i
= 0; value
[i
]; i
++)
1321 if (value
[i
] == ';' || value
[i
] == '#')
1323 if (i
&& value
[i
- 1] == ' ')
1326 strbuf_addf(&sb
, "\t%.*s = %s",
1327 length
, key
+ store
.baselen
+ 1, quote
);
1329 for (i
= 0; value
[i
]; i
++)
1332 strbuf_addstr(&sb
, "\\n");
1335 strbuf_addstr(&sb
, "\\t");
1339 strbuf_addch(&sb
, '\\');
1341 strbuf_addch(&sb
, value
[i
]);
1344 strbuf_addf(&sb
, "%s\n", quote
);
1346 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1347 strbuf_release(&sb
);
1352 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1353 size_t offset_
, int *found_bracket
)
1355 size_t equal_offset
= size
, bracket_offset
= size
;
1359 for (offset
= offset_
-2; offset
> 0
1360 && contents
[offset
] != '\n'; offset
--)
1361 switch (contents
[offset
]) {
1362 case '=': equal_offset
= offset
; break;
1363 case ']': bracket_offset
= offset
; break;
1365 if (offset
> 0 && contents
[offset
-1] == '\\') {
1369 if (bracket_offset
< equal_offset
) {
1371 offset
= bracket_offset
+1;
1378 int git_config_set_in_file(const char *config_filename
,
1379 const char *key
, const char *value
)
1381 return git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1384 int git_config_set(const char *key
, const char *value
)
1386 return git_config_set_multivar(key
, value
, NULL
, 0);
1390 * Auxiliary function to sanity-check and split the key into the section
1391 * identifier and variable name.
1393 * Returns 0 on success, -1 when there is an invalid character in the key and
1394 * -2 if there is no section name in the key.
1396 * store_key - pointer to char* which will hold a copy of the key with
1397 * lowercase section and variable name
1398 * baselen - pointer to int which will hold the length of the
1399 * section + subsection part, can be NULL
1401 int git_config_parse_key(const char *key
, char **store_key
, int *baselen_
)
1403 int i
, dot
, baselen
;
1404 const char *last_dot
= strrchr(key
, '.');
1407 * Since "key" actually contains the section name and the real
1408 * key name separated by a dot, we have to know where the dot is.
1411 if (last_dot
== NULL
|| last_dot
== key
) {
1412 error("key does not contain a section: %s", key
);
1413 return -CONFIG_NO_SECTION_OR_NAME
;
1417 error("key does not contain variable name: %s", key
);
1418 return -CONFIG_NO_SECTION_OR_NAME
;
1421 baselen
= last_dot
- key
;
1423 *baselen_
= baselen
;
1426 * Validate the key and while at it, lower case it for matching.
1428 *store_key
= xmalloc(strlen(key
) + 1);
1431 for (i
= 0; key
[i
]; i
++) {
1432 unsigned char c
= key
[i
];
1435 /* Leave the extended basename untouched.. */
1436 if (!dot
|| i
> baselen
) {
1437 if (!iskeychar(c
) ||
1438 (i
== baselen
+ 1 && !isalpha(c
))) {
1439 error("invalid key: %s", key
);
1440 goto out_free_ret_1
;
1443 } else if (c
== '\n') {
1444 error("invalid key (newline): %s", key
);
1445 goto out_free_ret_1
;
1447 (*store_key
)[i
] = c
;
1449 (*store_key
)[i
] = 0;
1456 return -CONFIG_INVALID_KEY
;
1460 * If value==NULL, unset in (remove from) config,
1461 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1462 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1463 * else all matching key/values (regardless how many) are removed,
1464 * before the new pair is written.
1466 * Returns 0 on success.
1468 * This function does this:
1470 * - it locks the config file by creating ".git/config.lock"
1472 * - it then parses the config using store_aux() as validator to find
1473 * the position on the key/value pair to replace. If it is to be unset,
1474 * it must be found exactly once.
1476 * - the config file is mmap()ed and the part before the match (if any) is
1477 * written to the lock file, then the changed part and the rest.
1479 * - the config file is removed and the lock file rename()d to it.
1482 int git_config_set_multivar_in_file(const char *config_filename
,
1483 const char *key
, const char *value
,
1484 const char *value_regex
, int multi_replace
)
1488 struct lock_file
*lock
= NULL
;
1489 char *filename_buf
= NULL
;
1491 /* parse-key returns negative; flip the sign to feed exit(3) */
1492 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
1496 store
.multi_replace
= multi_replace
;
1498 if (!config_filename
)
1499 config_filename
= filename_buf
= git_pathdup("config");
1502 * The lock serves a purpose in addition to locking: the new
1503 * contents of .git/config will be written into it.
1505 lock
= xcalloc(sizeof(struct lock_file
), 1);
1506 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1508 error("could not lock config file %s: %s", config_filename
, strerror(errno
));
1510 ret
= CONFIG_NO_LOCK
;
1515 * If .git/config does not exist yet, write a minimal version.
1517 in_fd
= open(config_filename
, O_RDONLY
);
1521 if ( ENOENT
!= errno
) {
1522 error("opening %s: %s", config_filename
,
1524 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
1527 /* if nothing to unset, error out */
1528 if (value
== NULL
) {
1529 ret
= CONFIG_NOTHING_SET
;
1533 store
.key
= (char *)key
;
1534 if (!store_write_section(fd
, key
) ||
1535 !store_write_pair(fd
, key
, value
))
1540 size_t contents_sz
, copy_begin
, copy_end
;
1541 int i
, new_line
= 0;
1543 if (value_regex
== NULL
)
1544 store
.value_regex
= NULL
;
1546 if (value_regex
[0] == '!') {
1547 store
.do_not_match
= 1;
1550 store
.do_not_match
= 0;
1552 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
1553 if (regcomp(store
.value_regex
, value_regex
,
1555 error("invalid pattern: %s", value_regex
);
1556 free(store
.value_regex
);
1557 ret
= CONFIG_INVALID_PATTERN
;
1562 store
.offset
[0] = 0;
1563 store
.state
= START
;
1567 * After this, store.offset will contain the *end* offset
1568 * of the last match, or remain at 0 if no match was found.
1569 * As a side effect, we make sure to transform only a valid
1570 * existing config file.
1572 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
1573 error("invalid config file %s", config_filename
);
1575 if (store
.value_regex
!= NULL
) {
1576 regfree(store
.value_regex
);
1577 free(store
.value_regex
);
1579 ret
= CONFIG_INVALID_FILE
;
1584 if (store
.value_regex
!= NULL
) {
1585 regfree(store
.value_regex
);
1586 free(store
.value_regex
);
1589 /* if nothing to unset, or too many matches, error out */
1590 if ((store
.seen
== 0 && value
== NULL
) ||
1591 (store
.seen
> 1 && multi_replace
== 0)) {
1592 ret
= CONFIG_NOTHING_SET
;
1597 contents_sz
= xsize_t(st
.st_size
);
1598 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
1599 MAP_PRIVATE
, in_fd
, 0);
1602 if (store
.seen
== 0)
1605 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
1606 if (store
.offset
[i
] == 0) {
1607 store
.offset
[i
] = copy_end
= contents_sz
;
1608 } else if (store
.state
!= KEY_SEEN
) {
1609 copy_end
= store
.offset
[i
];
1611 copy_end
= find_beginning_of_line(
1612 contents
, contents_sz
,
1613 store
.offset
[i
]-2, &new_line
);
1615 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
1618 /* write the first part of the config */
1619 if (copy_end
> copy_begin
) {
1620 if (write_in_full(fd
, contents
+ copy_begin
,
1621 copy_end
- copy_begin
) <
1622 copy_end
- copy_begin
)
1625 write_str_in_full(fd
, "\n") != 1)
1628 copy_begin
= store
.offset
[i
];
1631 /* write the pair (value == NULL means unset) */
1632 if (value
!= NULL
) {
1633 if (store
.state
== START
) {
1634 if (!store_write_section(fd
, key
))
1637 if (!store_write_pair(fd
, key
, value
))
1641 /* write the rest of the config */
1642 if (copy_begin
< contents_sz
)
1643 if (write_in_full(fd
, contents
+ copy_begin
,
1644 contents_sz
- copy_begin
) <
1645 contents_sz
- copy_begin
)
1648 munmap(contents
, contents_sz
);
1651 if (commit_lock_file(lock
) < 0) {
1652 error("could not commit config file %s", config_filename
);
1653 ret
= CONFIG_NO_WRITE
;
1658 * lock is committed, so don't try to roll it back below.
1659 * NOTE: Since lockfile.c keeps a linked list of all created
1660 * lock_file structures, it isn't safe to free(lock). It's
1661 * better to just leave it hanging around.
1668 rollback_lock_file(lock
);
1673 ret
= write_error(lock
->filename
);
1678 int git_config_set_multivar(const char *key
, const char *value
,
1679 const char *value_regex
, int multi_replace
)
1681 return git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
1685 static int section_name_match (const char *buf
, const char *name
)
1687 int i
= 0, j
= 0, dot
= 0;
1690 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
1691 if (!dot
&& isspace(buf
[i
])) {
1693 if (name
[j
++] != '.')
1695 for (i
++; isspace(buf
[i
]); i
++)
1701 if (buf
[i
] == '\\' && dot
)
1703 else if (buf
[i
] == '"' && dot
) {
1704 for (i
++; isspace(buf
[i
]); i
++)
1708 if (buf
[i
] != name
[j
++])
1711 if (buf
[i
] == ']' && name
[j
] == 0) {
1713 * We match, now just find the right length offset by
1714 * gobbling up any whitespace after it, as well
1717 for (; buf
[i
] && isspace(buf
[i
]); i
++)
1724 static int section_name_is_ok(const char *name
)
1726 /* Empty section names are bogus. */
1731 * Before a dot, we must be alphanumeric or dash. After the first dot,
1732 * anything goes, so we can stop checking.
1734 for (; *name
&& *name
!= '.'; name
++)
1735 if (*name
!= '-' && !isalnum(*name
))
1740 /* if new_name == NULL, the section is removed instead */
1741 int git_config_rename_section_in_file(const char *config_filename
,
1742 const char *old_name
, const char *new_name
)
1744 int ret
= 0, remove
= 0;
1745 char *filename_buf
= NULL
;
1746 struct lock_file
*lock
;
1751 if (new_name
&& !section_name_is_ok(new_name
)) {
1752 ret
= error("invalid section name: %s", new_name
);
1756 if (!config_filename
)
1757 config_filename
= filename_buf
= git_pathdup("config");
1759 lock
= xcalloc(sizeof(struct lock_file
), 1);
1760 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1762 ret
= error("could not lock config file %s", config_filename
);
1766 if (!(config_file
= fopen(config_filename
, "rb"))) {
1767 /* no config file means nothing to rename, no error */
1768 goto unlock_and_out
;
1771 while (fgets(buf
, sizeof(buf
), config_file
)) {
1775 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1777 if (buf
[i
] == '[') {
1778 /* it's a section */
1779 int offset
= section_name_match(&buf
[i
], old_name
);
1782 if (new_name
== NULL
) {
1786 store
.baselen
= strlen(new_name
);
1787 if (!store_write_section(out_fd
, new_name
)) {
1788 ret
= write_error(lock
->filename
);
1792 * We wrote out the new section, with
1793 * a newline, now skip the old
1796 output
+= offset
+ i
;
1797 if (strlen(output
) > 0) {
1799 * More content means there's
1800 * a declaration to put on the
1801 * next line; indent with a
1812 length
= strlen(output
);
1813 if (write_in_full(out_fd
, output
, length
) != length
) {
1814 ret
= write_error(lock
->filename
);
1818 fclose(config_file
);
1820 if (commit_lock_file(lock
) < 0)
1821 ret
= error("could not commit config file %s", config_filename
);
1827 int git_config_rename_section(const char *old_name
, const char *new_name
)
1829 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
1833 * Call this to report error for your variable that should not
1834 * get a boolean value (i.e. "[my] var" means "true").
1836 #undef config_error_nonbool
1837 int config_error_nonbool(const char *var
)
1839 return error("Missing value for '%s'", var
);
1842 int parse_config_key(const char *var
,
1843 const char *section
,
1844 const char **subsection
, int *subsection_len
,
1847 int section_len
= strlen(section
);
1850 /* Does it start with "section." ? */
1851 if (prefixcmp(var
, section
) || var
[section_len
] != '.')
1855 * Find the key; we don't know yet if we have a subsection, but we must
1856 * parse backwards from the end, since the subsection may have dots in
1859 dot
= strrchr(var
, '.');
1862 /* Did we have a subsection at all? */
1863 if (dot
== var
+ section_len
) {
1865 *subsection_len
= 0;
1868 *subsection
= var
+ section_len
+ 1;
1869 *subsection_len
= dot
- *subsection
;