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
)
166 struct strbuf
**pair
;
168 pair
= strbuf_split_str(text
, '=', 2);
170 return error("bogus config parameter: %s", text
);
172 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
173 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
174 value
= pair
[1] ? pair
[1]->buf
: "";
179 strbuf_trim(pair
[0]);
181 strbuf_list_free(pair
);
182 return error("bogus config parameter: %s", text
);
184 strbuf_tolower(pair
[0]);
185 if (fn(pair
[0]->buf
, value
, data
) < 0) {
186 strbuf_list_free(pair
);
189 strbuf_list_free(pair
);
193 int git_config_from_parameters(config_fn_t fn
, void *data
)
195 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
197 const char **argv
= NULL
;
198 int nr
= 0, alloc
= 0;
203 /* sq_dequote will write over it */
206 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
208 return error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
211 for (i
= 0; i
< nr
; i
++) {
212 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
224 static int get_next_char(void)
226 int c
= cf
->do_fgetc(cf
);
229 /* DOS like systems */
230 c
= cf
->do_fgetc(cf
);
232 cf
->do_ungetc(c
, cf
);
245 static char *parse_value(void)
247 int quote
= 0, comment
= 0, space
= 0;
249 strbuf_reset(&cf
->value
);
251 int c
= get_next_char();
257 return cf
->value
.buf
;
261 if (isspace(c
) && !quote
) {
267 if (c
== ';' || c
== '#') {
272 for (; space
; space
--)
273 strbuf_addch(&cf
->value
, ' ');
288 /* Some characters escape as themselves */
291 /* Reject unknown escape sequences */
295 strbuf_addch(&cf
->value
, c
);
302 strbuf_addch(&cf
->value
, c
);
306 static inline int iskeychar(int c
)
308 return isalnum(c
) || c
== '-';
311 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
316 /* Get the full name */
323 strbuf_addch(name
, tolower(c
));
326 while (c
== ' ' || c
== '\t')
333 value
= parse_value();
337 return fn(name
->buf
, value
, data
);
340 static int get_extended_base_var(struct strbuf
*name
, int c
)
344 goto error_incomplete_line
;
346 } while (isspace(c
));
348 /* We require the format to be '[base "extension"]' */
351 strbuf_addch(name
, '.');
354 int c
= get_next_char();
356 goto error_incomplete_line
;
362 goto error_incomplete_line
;
364 strbuf_addch(name
, c
);
368 if (get_next_char() != ']')
371 error_incomplete_line
:
376 static int get_base_var(struct strbuf
*name
)
379 int c
= get_next_char();
385 return get_extended_base_var(name
, c
);
386 if (!iskeychar(c
) && c
!= '.')
388 strbuf_addch(name
, tolower(c
));
392 static int git_parse_source(config_fn_t fn
, void *data
)
396 struct strbuf
*var
= &cf
->var
;
398 /* U+FEFF Byte Order Mark in UTF8 */
399 static const unsigned char *utf8_bom
= (unsigned char *) "\xef\xbb\xbf";
400 const unsigned char *bomptr
= utf8_bom
;
403 int c
= get_next_char();
404 if (bomptr
&& *bomptr
) {
405 /* We are at the file beginning; skip UTF8-encoded BOM
406 * if present. Sane editors won't put this in on their
407 * own, but e.g. Windows Notepad will do it happily. */
408 if ((unsigned char) c
== *bomptr
) {
412 /* Do not tolerate partial BOM. */
413 if (bomptr
!= utf8_bom
)
415 /* No BOM at file beginning. Cool. */
425 if (comment
|| isspace(c
))
427 if (c
== '#' || c
== ';') {
432 /* Reset prior to determining a new stem */
434 if (get_base_var(var
) < 0 || var
->len
< 1)
436 strbuf_addch(var
, '.');
443 * Truncate the var name back to the section header
444 * stem prior to grabbing the suffix part of the name
447 strbuf_setlen(var
, baselen
);
448 strbuf_addch(var
, tolower(c
));
449 if (get_value(fn
, data
, var
) < 0)
452 if (cf
->die_on_error
)
453 die("bad config file line %d in %s", cf
->linenr
, cf
->name
);
455 return error("bad config file line %d in %s", cf
->linenr
, cf
->name
);
458 static int parse_unit_factor(const char *end
, uintmax_t *val
)
462 else if (!strcasecmp(end
, "k")) {
466 else if (!strcasecmp(end
, "m")) {
470 else if (!strcasecmp(end
, "g")) {
471 *val
*= 1024 * 1024 * 1024;
477 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
479 if (value
&& *value
) {
483 uintmax_t factor
= 1;
486 val
= strtoimax(value
, &end
, 0);
489 if (!parse_unit_factor(end
, &factor
)) {
495 if (uval
> max
|| abs(val
) > uval
) {
507 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
509 if (value
&& *value
) {
515 val
= strtoumax(value
, &end
, 0);
519 if (!parse_unit_factor(end
, &val
)) {
523 if (val
> max
|| oldval
> val
) {
534 static int git_parse_int(const char *value
, int *ret
)
537 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
543 static int git_parse_int64(const char *value
, int64_t *ret
)
546 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
552 int git_parse_ulong(const char *value
, unsigned long *ret
)
555 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
562 static void die_bad_number(const char *name
, const char *value
)
564 const char *reason
= errno
== ERANGE
?
571 die("bad numeric config value '%s' for '%s' in %s: %s",
572 value
, name
, cf
->name
, reason
);
573 die("bad numeric config value '%s' for '%s': %s", value
, name
, reason
);
576 int git_config_int(const char *name
, const char *value
)
579 if (!git_parse_int(value
, &ret
))
580 die_bad_number(name
, value
);
584 int64_t git_config_int64(const char *name
, const char *value
)
587 if (!git_parse_int64(value
, &ret
))
588 die_bad_number(name
, value
);
592 unsigned long git_config_ulong(const char *name
, const char *value
)
595 if (!git_parse_ulong(value
, &ret
))
596 die_bad_number(name
, value
);
600 static int git_config_maybe_bool_text(const char *name
, const char *value
)
606 if (!strcasecmp(value
, "true")
607 || !strcasecmp(value
, "yes")
608 || !strcasecmp(value
, "on"))
610 if (!strcasecmp(value
, "false")
611 || !strcasecmp(value
, "no")
612 || !strcasecmp(value
, "off"))
617 int git_config_maybe_bool(const char *name
, const char *value
)
619 int v
= git_config_maybe_bool_text(name
, value
);
622 if (git_parse_int(value
, &v
))
627 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
629 int v
= git_config_maybe_bool_text(name
, value
);
635 return git_config_int(name
, value
);
638 int git_config_bool(const char *name
, const char *value
)
641 return !!git_config_bool_or_int(name
, value
, &discard
);
644 int git_config_string(const char **dest
, const char *var
, const char *value
)
647 return config_error_nonbool(var
);
648 *dest
= xstrdup(value
);
652 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
655 return config_error_nonbool(var
);
656 *dest
= expand_user_path(value
);
658 die("Failed to expand user dir in: '%s'", value
);
662 static int git_default_core_config(const char *var
, const char *value
)
664 /* This needs a better name */
665 if (!strcmp(var
, "core.filemode")) {
666 trust_executable_bit
= git_config_bool(var
, value
);
669 if (!strcmp(var
, "core.trustctime")) {
670 trust_ctime
= git_config_bool(var
, value
);
673 if (!strcmp(var
, "core.checkstat")) {
674 if (!strcasecmp(value
, "default"))
676 else if (!strcasecmp(value
, "minimal"))
680 if (!strcmp(var
, "core.quotepath")) {
681 quote_path_fully
= git_config_bool(var
, value
);
685 if (!strcmp(var
, "core.symlinks")) {
686 has_symlinks
= git_config_bool(var
, value
);
690 if (!strcmp(var
, "core.ignorecase")) {
691 ignore_case
= git_config_bool(var
, value
);
695 if (!strcmp(var
, "core.attributesfile"))
696 return git_config_pathname(&git_attributes_file
, var
, value
);
698 if (!strcmp(var
, "core.bare")) {
699 is_bare_repository_cfg
= git_config_bool(var
, value
);
703 if (!strcmp(var
, "core.ignorestat")) {
704 assume_unchanged
= git_config_bool(var
, value
);
708 if (!strcmp(var
, "core.prefersymlinkrefs")) {
709 prefer_symlink_refs
= git_config_bool(var
, value
);
713 if (!strcmp(var
, "core.logallrefupdates")) {
714 log_all_ref_updates
= git_config_bool(var
, value
);
718 if (!strcmp(var
, "core.warnambiguousrefs")) {
719 warn_ambiguous_refs
= git_config_bool(var
, value
);
723 if (!strcmp(var
, "core.abbrev")) {
724 int abbrev
= git_config_int(var
, value
);
725 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
727 default_abbrev
= abbrev
;
731 if (!strcmp(var
, "core.loosecompression")) {
732 int level
= git_config_int(var
, value
);
734 level
= Z_DEFAULT_COMPRESSION
;
735 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
736 die("bad zlib compression level %d", level
);
737 zlib_compression_level
= level
;
738 zlib_compression_seen
= 1;
742 if (!strcmp(var
, "core.compression")) {
743 int level
= git_config_int(var
, value
);
745 level
= Z_DEFAULT_COMPRESSION
;
746 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
747 die("bad zlib compression level %d", level
);
748 core_compression_level
= level
;
749 core_compression_seen
= 1;
750 if (!zlib_compression_seen
)
751 zlib_compression_level
= level
;
755 if (!strcmp(var
, "core.packedgitwindowsize")) {
756 int pgsz_x2
= getpagesize() * 2;
757 packed_git_window_size
= git_config_ulong(var
, value
);
759 /* This value must be multiple of (pagesize * 2) */
760 packed_git_window_size
/= pgsz_x2
;
761 if (packed_git_window_size
< 1)
762 packed_git_window_size
= 1;
763 packed_git_window_size
*= pgsz_x2
;
767 if (!strcmp(var
, "core.bigfilethreshold")) {
768 big_file_threshold
= git_config_ulong(var
, value
);
772 if (!strcmp(var
, "core.packedgitlimit")) {
773 packed_git_limit
= git_config_ulong(var
, value
);
777 if (!strcmp(var
, "core.deltabasecachelimit")) {
778 delta_base_cache_limit
= git_config_ulong(var
, value
);
782 if (!strcmp(var
, "core.autocrlf")) {
783 if (value
&& !strcasecmp(value
, "input")) {
784 if (core_eol
== EOL_CRLF
)
785 return error("core.autocrlf=input conflicts with core.eol=crlf");
786 auto_crlf
= AUTO_CRLF_INPUT
;
789 auto_crlf
= git_config_bool(var
, value
);
793 if (!strcmp(var
, "core.safecrlf")) {
794 if (value
&& !strcasecmp(value
, "warn")) {
795 safe_crlf
= SAFE_CRLF_WARN
;
798 safe_crlf
= git_config_bool(var
, value
);
802 if (!strcmp(var
, "core.eol")) {
803 if (value
&& !strcasecmp(value
, "lf"))
805 else if (value
&& !strcasecmp(value
, "crlf"))
807 else if (value
&& !strcasecmp(value
, "native"))
808 core_eol
= EOL_NATIVE
;
810 core_eol
= EOL_UNSET
;
811 if (core_eol
== EOL_CRLF
&& auto_crlf
== AUTO_CRLF_INPUT
)
812 return error("core.autocrlf=input conflicts with core.eol=crlf");
816 if (!strcmp(var
, "core.notesref")) {
817 notes_ref_name
= xstrdup(value
);
821 if (!strcmp(var
, "core.pager"))
822 return git_config_string(&pager_program
, var
, value
);
824 if (!strcmp(var
, "core.editor"))
825 return git_config_string(&editor_program
, var
, value
);
827 if (!strcmp(var
, "core.commentchar")) {
829 return config_error_nonbool(var
);
830 else if (!strcasecmp(value
, "auto"))
831 auto_comment_line_char
= 1;
832 else if (value
[0] && !value
[1]) {
833 comment_line_char
= value
[0];
834 auto_comment_line_char
= 0;
836 return error("core.commentChar should only be one character");
840 if (!strcmp(var
, "core.askpass"))
841 return git_config_string(&askpass_program
, var
, value
);
843 if (!strcmp(var
, "core.excludesfile"))
844 return git_config_pathname(&excludes_file
, var
, value
);
846 if (!strcmp(var
, "core.whitespace")) {
848 return config_error_nonbool(var
);
849 whitespace_rule_cfg
= parse_whitespace_rule(value
);
853 if (!strcmp(var
, "core.fsyncobjectfiles")) {
854 fsync_object_files
= git_config_bool(var
, value
);
858 if (!strcmp(var
, "core.preloadindex")) {
859 core_preload_index
= git_config_bool(var
, value
);
863 if (!strcmp(var
, "core.createobject")) {
864 if (!strcmp(value
, "rename"))
865 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
866 else if (!strcmp(value
, "link"))
867 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
869 die("Invalid mode for object creation: %s", value
);
873 if (!strcmp(var
, "core.sparsecheckout")) {
874 core_apply_sparse_checkout
= git_config_bool(var
, value
);
878 if (!strcmp(var
, "core.precomposeunicode")) {
879 precomposed_unicode
= git_config_bool(var
, value
);
883 /* Add other config variables here and to Documentation/config.txt. */
887 static int git_default_i18n_config(const char *var
, const char *value
)
889 if (!strcmp(var
, "i18n.commitencoding"))
890 return git_config_string(&git_commit_encoding
, var
, value
);
892 if (!strcmp(var
, "i18n.logoutputencoding"))
893 return git_config_string(&git_log_output_encoding
, var
, value
);
895 /* Add other config variables here and to Documentation/config.txt. */
899 static int git_default_branch_config(const char *var
, const char *value
)
901 if (!strcmp(var
, "branch.autosetupmerge")) {
902 if (value
&& !strcasecmp(value
, "always")) {
903 git_branch_track
= BRANCH_TRACK_ALWAYS
;
906 git_branch_track
= git_config_bool(var
, value
);
909 if (!strcmp(var
, "branch.autosetuprebase")) {
911 return config_error_nonbool(var
);
912 else if (!strcmp(value
, "never"))
913 autorebase
= AUTOREBASE_NEVER
;
914 else if (!strcmp(value
, "local"))
915 autorebase
= AUTOREBASE_LOCAL
;
916 else if (!strcmp(value
, "remote"))
917 autorebase
= AUTOREBASE_REMOTE
;
918 else if (!strcmp(value
, "always"))
919 autorebase
= AUTOREBASE_ALWAYS
;
921 return error("Malformed value for %s", var
);
925 /* Add other config variables here and to Documentation/config.txt. */
929 static int git_default_push_config(const char *var
, const char *value
)
931 if (!strcmp(var
, "push.default")) {
933 return config_error_nonbool(var
);
934 else if (!strcmp(value
, "nothing"))
935 push_default
= PUSH_DEFAULT_NOTHING
;
936 else if (!strcmp(value
, "matching"))
937 push_default
= PUSH_DEFAULT_MATCHING
;
938 else if (!strcmp(value
, "simple"))
939 push_default
= PUSH_DEFAULT_SIMPLE
;
940 else if (!strcmp(value
, "upstream"))
941 push_default
= PUSH_DEFAULT_UPSTREAM
;
942 else if (!strcmp(value
, "tracking")) /* deprecated */
943 push_default
= PUSH_DEFAULT_UPSTREAM
;
944 else if (!strcmp(value
, "current"))
945 push_default
= PUSH_DEFAULT_CURRENT
;
947 error("Malformed value for %s: %s", var
, value
);
948 return error("Must be one of nothing, matching, simple, "
949 "upstream or current.");
954 /* Add other config variables here and to Documentation/config.txt. */
958 static int git_default_mailmap_config(const char *var
, const char *value
)
960 if (!strcmp(var
, "mailmap.file"))
961 return git_config_pathname(&git_mailmap_file
, var
, value
);
962 if (!strcmp(var
, "mailmap.blob"))
963 return git_config_string(&git_mailmap_blob
, var
, value
);
965 /* Add other config variables here and to Documentation/config.txt. */
969 int git_default_config(const char *var
, const char *value
, void *dummy
)
971 if (starts_with(var
, "core."))
972 return git_default_core_config(var
, value
);
974 if (starts_with(var
, "user."))
975 return git_ident_config(var
, value
, dummy
);
977 if (starts_with(var
, "i18n."))
978 return git_default_i18n_config(var
, value
);
980 if (starts_with(var
, "branch."))
981 return git_default_branch_config(var
, value
);
983 if (starts_with(var
, "push."))
984 return git_default_push_config(var
, value
);
986 if (starts_with(var
, "mailmap."))
987 return git_default_mailmap_config(var
, value
);
989 if (starts_with(var
, "advice."))
990 return git_default_advice_config(var
, value
);
992 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
993 pager_use_color
= git_config_bool(var
,value
);
997 if (!strcmp(var
, "pack.packsizelimit")) {
998 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1001 /* Add other config variables here and to Documentation/config.txt. */
1006 * All source specific fields in the union, die_on_error, name and the callbacks
1007 * fgetc, ungetc, ftell of top need to be initialized before calling
1010 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1014 /* push config-file parsing state stack */
1018 strbuf_init(&top
->value
, 1024);
1019 strbuf_init(&top
->var
, 1024);
1022 ret
= git_parse_source(fn
, data
);
1024 /* pop config-file parsing state stack */
1025 strbuf_release(&top
->value
);
1026 strbuf_release(&top
->var
);
1032 static int do_config_from_file(config_fn_t fn
,
1033 const char *name
, const char *path
, FILE *f
, void *data
)
1035 struct config_source top
;
1040 top
.die_on_error
= 1;
1041 top
.do_fgetc
= config_file_fgetc
;
1042 top
.do_ungetc
= config_file_ungetc
;
1043 top
.do_ftell
= config_file_ftell
;
1045 return do_config_from(&top
, fn
, data
);
1048 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1050 return do_config_from_file(fn
, "<stdin>", NULL
, stdin
, data
);
1053 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1058 f
= fopen(filename
, "r");
1060 ret
= do_config_from_file(fn
, filename
, filename
, f
, data
);
1066 int git_config_from_buf(config_fn_t fn
, const char *name
, const char *buf
,
1067 size_t len
, void *data
)
1069 struct config_source top
;
1071 top
.u
.buf
.buf
= buf
;
1072 top
.u
.buf
.len
= len
;
1076 top
.die_on_error
= 0;
1077 top
.do_fgetc
= config_buf_fgetc
;
1078 top
.do_ungetc
= config_buf_ungetc
;
1079 top
.do_ftell
= config_buf_ftell
;
1081 return do_config_from(&top
, fn
, data
);
1084 static int git_config_from_blob_sha1(config_fn_t fn
,
1086 const unsigned char *sha1
,
1089 enum object_type type
;
1094 buf
= read_sha1_file(sha1
, &type
, &size
);
1096 return error("unable to load config blob object '%s'", name
);
1097 if (type
!= OBJ_BLOB
) {
1099 return error("reference '%s' does not point to a blob", name
);
1102 ret
= git_config_from_buf(fn
, name
, buf
, size
, data
);
1108 static int git_config_from_blob_ref(config_fn_t fn
,
1112 unsigned char sha1
[20];
1114 if (get_sha1(name
, sha1
) < 0)
1115 return error("unable to resolve config blob '%s'", name
);
1116 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1119 const char *git_etc_gitconfig(void)
1121 static const char *system_wide
;
1123 system_wide
= system_path(ETC_GITCONFIG
);
1127 int git_env_bool(const char *k
, int def
)
1129 const char *v
= getenv(k
);
1130 return v
? git_config_bool(k
, v
) : def
;
1133 int git_config_system(void)
1135 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1138 int git_config_early(config_fn_t fn
, void *data
, const char *repo_config
)
1140 int ret
= 0, found
= 0;
1141 char *xdg_config
= NULL
;
1142 char *user_config
= NULL
;
1144 home_config_paths(&user_config
, &xdg_config
, "config");
1146 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0)) {
1147 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1152 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
)) {
1153 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1157 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
)) {
1158 ret
+= git_config_from_file(fn
, user_config
, data
);
1162 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0)) {
1163 ret
+= git_config_from_file(fn
, repo_config
, data
);
1167 switch (git_config_from_parameters(fn
, data
)) {
1168 case -1: /* error */
1169 die("unable to parse command-line config");
1171 case 0: /* found nothing */
1173 default: /* found at least one item */
1180 return ret
== 0 ? found
: ret
;
1183 int git_config_with_options(config_fn_t fn
, void *data
,
1184 struct git_config_source
*config_source
,
1185 int respect_includes
)
1187 char *repo_config
= NULL
;
1189 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1191 if (respect_includes
) {
1194 fn
= git_config_include
;
1199 * If we have a specific filename, use it. Otherwise, follow the
1200 * regular lookup sequence.
1202 if (config_source
&& config_source
->use_stdin
)
1203 return git_config_from_stdin(fn
, data
);
1204 else if (config_source
&& config_source
->file
)
1205 return git_config_from_file(fn
, config_source
->file
, data
);
1206 else if (config_source
&& config_source
->blob
)
1207 return git_config_from_blob_ref(fn
, config_source
->blob
, data
);
1209 repo_config
= git_pathdup("config");
1210 ret
= git_config_early(fn
, data
, repo_config
);
1216 int git_config(config_fn_t fn
, void *data
)
1218 return git_config_with_options(fn
, data
, NULL
, 1);
1222 * Find all the stuff for git_config_set() below.
1229 regex_t
*value_regex
;
1232 unsigned int offset_alloc
;
1233 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1237 static int matches(const char *key
, const char *value
)
1239 return !strcmp(key
, store
.key
) &&
1240 (store
.value_regex
== NULL
||
1241 (store
.do_not_match
^
1242 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
1245 static int store_aux(const char *key
, const char *value
, void *cb
)
1250 switch (store
.state
) {
1252 if (matches(key
, value
)) {
1253 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1254 warning("%s has multiple values", key
);
1257 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1258 store
.offset_alloc
);
1260 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1266 * What we are looking for is in store.key (both
1267 * section and var), and its section part is baselen
1268 * long. We found key (again, both section and var).
1269 * We would want to know if this key is in the same
1270 * section as what we are looking for. We already
1271 * know we are in the same section as what should
1274 ep
= strrchr(key
, '.');
1275 section_len
= ep
- key
;
1277 if ((section_len
!= store
.baselen
) ||
1278 memcmp(key
, store
.key
, section_len
+1)) {
1279 store
.state
= SECTION_END_SEEN
;
1284 * Do not increment matches: this is no match, but we
1285 * just made sure we are in the desired section.
1287 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1288 store
.offset_alloc
);
1289 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1291 case SECTION_END_SEEN
:
1293 if (matches(key
, value
)) {
1294 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1295 store
.offset_alloc
);
1296 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1297 store
.state
= KEY_SEEN
;
1300 if (strrchr(key
, '.') - key
== store
.baselen
&&
1301 !strncmp(key
, store
.key
, store
.baselen
)) {
1302 store
.state
= SECTION_SEEN
;
1303 ALLOC_GROW(store
.offset
,
1305 store
.offset_alloc
);
1306 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1313 static int write_error(const char *filename
)
1315 error("failed to write new configuration file %s", filename
);
1317 /* Same error code as "failed to rename". */
1321 static int store_write_section(int fd
, const char *key
)
1325 struct strbuf sb
= STRBUF_INIT
;
1327 dot
= memchr(key
, '.', store
.baselen
);
1329 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1330 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1331 if (key
[i
] == '"' || key
[i
] == '\\')
1332 strbuf_addch(&sb
, '\\');
1333 strbuf_addch(&sb
, key
[i
]);
1335 strbuf_addstr(&sb
, "\"]\n");
1337 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1340 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1341 strbuf_release(&sb
);
1346 static int store_write_pair(int fd
, const char *key
, const char *value
)
1349 int length
= strlen(key
+ store
.baselen
+ 1);
1350 const char *quote
= "";
1351 struct strbuf sb
= STRBUF_INIT
;
1354 * Check to see if the value needs to be surrounded with a dq pair.
1355 * Note that problematic characters are always backslash-quoted; this
1356 * check is about not losing leading or trailing SP and strings that
1357 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1358 * configuration parser.
1360 if (value
[0] == ' ')
1362 for (i
= 0; value
[i
]; i
++)
1363 if (value
[i
] == ';' || value
[i
] == '#')
1365 if (i
&& value
[i
- 1] == ' ')
1368 strbuf_addf(&sb
, "\t%.*s = %s",
1369 length
, key
+ store
.baselen
+ 1, quote
);
1371 for (i
= 0; value
[i
]; i
++)
1374 strbuf_addstr(&sb
, "\\n");
1377 strbuf_addstr(&sb
, "\\t");
1381 strbuf_addch(&sb
, '\\');
1383 strbuf_addch(&sb
, value
[i
]);
1386 strbuf_addf(&sb
, "%s\n", quote
);
1388 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1389 strbuf_release(&sb
);
1394 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1395 size_t offset_
, int *found_bracket
)
1397 size_t equal_offset
= size
, bracket_offset
= size
;
1401 for (offset
= offset_
-2; offset
> 0
1402 && contents
[offset
] != '\n'; offset
--)
1403 switch (contents
[offset
]) {
1404 case '=': equal_offset
= offset
; break;
1405 case ']': bracket_offset
= offset
; break;
1407 if (offset
> 0 && contents
[offset
-1] == '\\') {
1411 if (bracket_offset
< equal_offset
) {
1413 offset
= bracket_offset
+1;
1420 int git_config_set_in_file(const char *config_filename
,
1421 const char *key
, const char *value
)
1423 return git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1426 int git_config_set(const char *key
, const char *value
)
1428 return git_config_set_multivar(key
, value
, NULL
, 0);
1432 * Auxiliary function to sanity-check and split the key into the section
1433 * identifier and variable name.
1435 * Returns 0 on success, -1 when there is an invalid character in the key and
1436 * -2 if there is no section name in the key.
1438 * store_key - pointer to char* which will hold a copy of the key with
1439 * lowercase section and variable name
1440 * baselen - pointer to int which will hold the length of the
1441 * section + subsection part, can be NULL
1443 int git_config_parse_key(const char *key
, char **store_key
, int *baselen_
)
1445 int i
, dot
, baselen
;
1446 const char *last_dot
= strrchr(key
, '.');
1449 * Since "key" actually contains the section name and the real
1450 * key name separated by a dot, we have to know where the dot is.
1453 if (last_dot
== NULL
|| last_dot
== key
) {
1454 error("key does not contain a section: %s", key
);
1455 return -CONFIG_NO_SECTION_OR_NAME
;
1459 error("key does not contain variable name: %s", key
);
1460 return -CONFIG_NO_SECTION_OR_NAME
;
1463 baselen
= last_dot
- key
;
1465 *baselen_
= baselen
;
1468 * Validate the key and while at it, lower case it for matching.
1470 *store_key
= xmalloc(strlen(key
) + 1);
1473 for (i
= 0; key
[i
]; i
++) {
1474 unsigned char c
= key
[i
];
1477 /* Leave the extended basename untouched.. */
1478 if (!dot
|| i
> baselen
) {
1479 if (!iskeychar(c
) ||
1480 (i
== baselen
+ 1 && !isalpha(c
))) {
1481 error("invalid key: %s", key
);
1482 goto out_free_ret_1
;
1485 } else if (c
== '\n') {
1486 error("invalid key (newline): %s", key
);
1487 goto out_free_ret_1
;
1489 (*store_key
)[i
] = c
;
1491 (*store_key
)[i
] = 0;
1498 return -CONFIG_INVALID_KEY
;
1502 * If value==NULL, unset in (remove from) config,
1503 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1504 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1505 * else all matching key/values (regardless how many) are removed,
1506 * before the new pair is written.
1508 * Returns 0 on success.
1510 * This function does this:
1512 * - it locks the config file by creating ".git/config.lock"
1514 * - it then parses the config using store_aux() as validator to find
1515 * the position on the key/value pair to replace. If it is to be unset,
1516 * it must be found exactly once.
1518 * - the config file is mmap()ed and the part before the match (if any) is
1519 * written to the lock file, then the changed part and the rest.
1521 * - the config file is removed and the lock file rename()d to it.
1524 int git_config_set_multivar_in_file(const char *config_filename
,
1525 const char *key
, const char *value
,
1526 const char *value_regex
, int multi_replace
)
1530 struct lock_file
*lock
= NULL
;
1531 char *filename_buf
= NULL
;
1533 /* parse-key returns negative; flip the sign to feed exit(3) */
1534 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
1538 store
.multi_replace
= multi_replace
;
1540 if (!config_filename
)
1541 config_filename
= filename_buf
= git_pathdup("config");
1544 * The lock serves a purpose in addition to locking: the new
1545 * contents of .git/config will be written into it.
1547 lock
= xcalloc(1, sizeof(struct lock_file
));
1548 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1550 error("could not lock config file %s: %s", config_filename
, strerror(errno
));
1552 ret
= CONFIG_NO_LOCK
;
1557 * If .git/config does not exist yet, write a minimal version.
1559 in_fd
= open(config_filename
, O_RDONLY
);
1563 if ( ENOENT
!= errno
) {
1564 error("opening %s: %s", config_filename
,
1566 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
1569 /* if nothing to unset, error out */
1570 if (value
== NULL
) {
1571 ret
= CONFIG_NOTHING_SET
;
1575 store
.key
= (char *)key
;
1576 if (!store_write_section(fd
, key
) ||
1577 !store_write_pair(fd
, key
, value
))
1582 size_t contents_sz
, copy_begin
, copy_end
;
1583 int i
, new_line
= 0;
1585 if (value_regex
== NULL
)
1586 store
.value_regex
= NULL
;
1588 if (value_regex
[0] == '!') {
1589 store
.do_not_match
= 1;
1592 store
.do_not_match
= 0;
1594 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
1595 if (regcomp(store
.value_regex
, value_regex
,
1597 error("invalid pattern: %s", value_regex
);
1598 free(store
.value_regex
);
1599 ret
= CONFIG_INVALID_PATTERN
;
1604 ALLOC_GROW(store
.offset
, 1, store
.offset_alloc
);
1605 store
.offset
[0] = 0;
1606 store
.state
= START
;
1610 * After this, store.offset will contain the *end* offset
1611 * of the last match, or remain at 0 if no match was found.
1612 * As a side effect, we make sure to transform only a valid
1613 * existing config file.
1615 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
1616 error("invalid config file %s", config_filename
);
1618 if (store
.value_regex
!= NULL
) {
1619 regfree(store
.value_regex
);
1620 free(store
.value_regex
);
1622 ret
= CONFIG_INVALID_FILE
;
1627 if (store
.value_regex
!= NULL
) {
1628 regfree(store
.value_regex
);
1629 free(store
.value_regex
);
1632 /* if nothing to unset, or too many matches, error out */
1633 if ((store
.seen
== 0 && value
== NULL
) ||
1634 (store
.seen
> 1 && multi_replace
== 0)) {
1635 ret
= CONFIG_NOTHING_SET
;
1640 contents_sz
= xsize_t(st
.st_size
);
1641 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
1642 MAP_PRIVATE
, in_fd
, 0);
1645 if (chmod(lock
->filename
, st
.st_mode
& 07777) < 0) {
1646 error("chmod on %s failed: %s",
1647 lock
->filename
, strerror(errno
));
1648 ret
= CONFIG_NO_WRITE
;
1652 if (store
.seen
== 0)
1655 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
1656 if (store
.offset
[i
] == 0) {
1657 store
.offset
[i
] = copy_end
= contents_sz
;
1658 } else if (store
.state
!= KEY_SEEN
) {
1659 copy_end
= store
.offset
[i
];
1661 copy_end
= find_beginning_of_line(
1662 contents
, contents_sz
,
1663 store
.offset
[i
]-2, &new_line
);
1665 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
1668 /* write the first part of the config */
1669 if (copy_end
> copy_begin
) {
1670 if (write_in_full(fd
, contents
+ copy_begin
,
1671 copy_end
- copy_begin
) <
1672 copy_end
- copy_begin
)
1675 write_str_in_full(fd
, "\n") != 1)
1678 copy_begin
= store
.offset
[i
];
1681 /* write the pair (value == NULL means unset) */
1682 if (value
!= NULL
) {
1683 if (store
.state
== START
) {
1684 if (!store_write_section(fd
, key
))
1687 if (!store_write_pair(fd
, key
, value
))
1691 /* write the rest of the config */
1692 if (copy_begin
< contents_sz
)
1693 if (write_in_full(fd
, contents
+ copy_begin
,
1694 contents_sz
- copy_begin
) <
1695 contents_sz
- copy_begin
)
1698 munmap(contents
, contents_sz
);
1701 if (commit_lock_file(lock
) < 0) {
1702 error("could not commit config file %s", config_filename
);
1703 ret
= CONFIG_NO_WRITE
;
1708 * lock is committed, so don't try to roll it back below.
1709 * NOTE: Since lockfile.c keeps a linked list of all created
1710 * lock_file structures, it isn't safe to free(lock). It's
1711 * better to just leave it hanging around.
1718 rollback_lock_file(lock
);
1723 ret
= write_error(lock
->filename
);
1728 int git_config_set_multivar(const char *key
, const char *value
,
1729 const char *value_regex
, int multi_replace
)
1731 return git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
1735 static int section_name_match (const char *buf
, const char *name
)
1737 int i
= 0, j
= 0, dot
= 0;
1740 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
1741 if (!dot
&& isspace(buf
[i
])) {
1743 if (name
[j
++] != '.')
1745 for (i
++; isspace(buf
[i
]); i
++)
1751 if (buf
[i
] == '\\' && dot
)
1753 else if (buf
[i
] == '"' && dot
) {
1754 for (i
++; isspace(buf
[i
]); i
++)
1758 if (buf
[i
] != name
[j
++])
1761 if (buf
[i
] == ']' && name
[j
] == 0) {
1763 * We match, now just find the right length offset by
1764 * gobbling up any whitespace after it, as well
1767 for (; buf
[i
] && isspace(buf
[i
]); i
++)
1774 static int section_name_is_ok(const char *name
)
1776 /* Empty section names are bogus. */
1781 * Before a dot, we must be alphanumeric or dash. After the first dot,
1782 * anything goes, so we can stop checking.
1784 for (; *name
&& *name
!= '.'; name
++)
1785 if (*name
!= '-' && !isalnum(*name
))
1790 /* if new_name == NULL, the section is removed instead */
1791 int git_config_rename_section_in_file(const char *config_filename
,
1792 const char *old_name
, const char *new_name
)
1794 int ret
= 0, remove
= 0;
1795 char *filename_buf
= NULL
;
1796 struct lock_file
*lock
;
1802 if (new_name
&& !section_name_is_ok(new_name
)) {
1803 ret
= error("invalid section name: %s", new_name
);
1807 if (!config_filename
)
1808 config_filename
= filename_buf
= git_pathdup("config");
1810 lock
= xcalloc(1, sizeof(struct lock_file
));
1811 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1813 ret
= error("could not lock config file %s", config_filename
);
1817 if (!(config_file
= fopen(config_filename
, "rb"))) {
1818 /* no config file means nothing to rename, no error */
1819 goto unlock_and_out
;
1822 fstat(fileno(config_file
), &st
);
1824 if (chmod(lock
->filename
, st
.st_mode
& 07777) < 0) {
1825 ret
= error("chmod on %s failed: %s",
1826 lock
->filename
, strerror(errno
));
1830 while (fgets(buf
, sizeof(buf
), config_file
)) {
1834 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1836 if (buf
[i
] == '[') {
1837 /* it's a section */
1838 int offset
= section_name_match(&buf
[i
], old_name
);
1841 if (new_name
== NULL
) {
1845 store
.baselen
= strlen(new_name
);
1846 if (!store_write_section(out_fd
, new_name
)) {
1847 ret
= write_error(lock
->filename
);
1851 * We wrote out the new section, with
1852 * a newline, now skip the old
1855 output
+= offset
+ i
;
1856 if (strlen(output
) > 0) {
1858 * More content means there's
1859 * a declaration to put on the
1860 * next line; indent with a
1871 length
= strlen(output
);
1872 if (write_in_full(out_fd
, output
, length
) != length
) {
1873 ret
= write_error(lock
->filename
);
1877 fclose(config_file
);
1879 if (commit_lock_file(lock
) < 0)
1880 ret
= error("could not commit config file %s", config_filename
);
1886 int git_config_rename_section(const char *old_name
, const char *new_name
)
1888 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
1892 * Call this to report error for your variable that should not
1893 * get a boolean value (i.e. "[my] var" means "true").
1895 #undef config_error_nonbool
1896 int config_error_nonbool(const char *var
)
1898 return error("Missing value for '%s'", var
);
1901 int parse_config_key(const char *var
,
1902 const char *section
,
1903 const char **subsection
, int *subsection_len
,
1906 int section_len
= strlen(section
);
1909 /* Does it start with "section." ? */
1910 if (!starts_with(var
, section
) || var
[section_len
] != '.')
1914 * Find the key; we don't know yet if we have a subsection, but we must
1915 * parse backwards from the end, since the subsection may have dots in
1918 dot
= strrchr(var
, '.');
1921 /* Did we have a subsection at all? */
1922 if (dot
== var
+ section_len
) {
1924 *subsection_len
= 0;
1927 *subsection
= var
+ section_len
+ 1;
1928 *subsection_len
= dot
- *subsection
;