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 (*do_fgetc
)(struct config_source
*c
);
31 int (*do_ungetc
)(int c
, struct config_source
*conf
);
32 long (*do_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
->do_fgetc(cf
);
223 /* DOS like systems */
224 c
= cf
->do_fgetc(cf
);
226 cf
->do_ungetc(c
, cf
);
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 static 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 static int git_parse_int64(const char *value
, int64_t *ret
)
540 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
546 int git_parse_ulong(const char *value
, unsigned long *ret
)
549 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
556 static void die_bad_number(const char *name
, const char *value
)
558 const char *reason
= errno
== ERANGE
?
565 die("bad numeric config value '%s' for '%s' in %s: %s",
566 value
, name
, cf
->name
, reason
);
567 die("bad numeric config value '%s' for '%s': %s", value
, name
, reason
);
570 int git_config_int(const char *name
, const char *value
)
573 if (!git_parse_int(value
, &ret
))
574 die_bad_number(name
, value
);
578 int64_t git_config_int64(const char *name
, const char *value
)
581 if (!git_parse_int64(value
, &ret
))
582 die_bad_number(name
, value
);
586 unsigned long git_config_ulong(const char *name
, const char *value
)
589 if (!git_parse_ulong(value
, &ret
))
590 die_bad_number(name
, value
);
594 static int git_config_maybe_bool_text(const char *name
, const char *value
)
600 if (!strcasecmp(value
, "true")
601 || !strcasecmp(value
, "yes")
602 || !strcasecmp(value
, "on"))
604 if (!strcasecmp(value
, "false")
605 || !strcasecmp(value
, "no")
606 || !strcasecmp(value
, "off"))
611 int git_config_maybe_bool(const char *name
, const char *value
)
613 int v
= git_config_maybe_bool_text(name
, value
);
616 if (git_parse_int(value
, &v
))
621 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
623 int v
= git_config_maybe_bool_text(name
, value
);
629 return git_config_int(name
, value
);
632 int git_config_bool(const char *name
, const char *value
)
635 return !!git_config_bool_or_int(name
, value
, &discard
);
638 int git_config_string(const char **dest
, const char *var
, const char *value
)
641 return config_error_nonbool(var
);
642 *dest
= xstrdup(value
);
646 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
649 return config_error_nonbool(var
);
650 *dest
= expand_user_path(value
);
652 die("Failed to expand user dir in: '%s'", value
);
656 static int git_default_core_config(const char *var
, const char *value
)
658 /* This needs a better name */
659 if (!strcmp(var
, "core.filemode")) {
660 trust_executable_bit
= git_config_bool(var
, value
);
663 if (!strcmp(var
, "core.trustctime")) {
664 trust_ctime
= git_config_bool(var
, value
);
667 if (!strcmp(var
, "core.statinfo") ||
668 !strcmp(var
, "core.checkstat")) {
670 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
671 * never been advertised. we will remove it at Git
674 if (!strcmp(var
, "core.statinfo")) {
677 warning("'core.statinfo' will be removed in Git 2.0; "
678 "use 'core.checkstat' instead.");
681 if (!strcasecmp(value
, "default"))
683 else if (!strcasecmp(value
, "minimal"))
687 if (!strcmp(var
, "core.quotepath")) {
688 quote_path_fully
= git_config_bool(var
, value
);
692 if (!strcmp(var
, "core.symlinks")) {
693 has_symlinks
= git_config_bool(var
, value
);
697 if (!strcmp(var
, "core.ignorecase")) {
698 ignore_case
= git_config_bool(var
, value
);
702 if (!strcmp(var
, "core.attributesfile"))
703 return git_config_pathname(&git_attributes_file
, var
, value
);
705 if (!strcmp(var
, "core.bare")) {
706 is_bare_repository_cfg
= git_config_bool(var
, value
);
710 if (!strcmp(var
, "core.ignorestat")) {
711 assume_unchanged
= git_config_bool(var
, value
);
715 if (!strcmp(var
, "core.prefersymlinkrefs")) {
716 prefer_symlink_refs
= git_config_bool(var
, value
);
720 if (!strcmp(var
, "core.logallrefupdates")) {
721 log_all_ref_updates
= git_config_bool(var
, value
);
725 if (!strcmp(var
, "core.warnambiguousrefs")) {
726 warn_ambiguous_refs
= git_config_bool(var
, value
);
730 if (!strcmp(var
, "core.abbrev")) {
731 int abbrev
= git_config_int(var
, value
);
732 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
734 default_abbrev
= abbrev
;
738 if (!strcmp(var
, "core.loosecompression")) {
739 int level
= git_config_int(var
, value
);
741 level
= Z_DEFAULT_COMPRESSION
;
742 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
743 die("bad zlib compression level %d", level
);
744 zlib_compression_level
= level
;
745 zlib_compression_seen
= 1;
749 if (!strcmp(var
, "core.compression")) {
750 int level
= git_config_int(var
, value
);
752 level
= Z_DEFAULT_COMPRESSION
;
753 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
754 die("bad zlib compression level %d", level
);
755 core_compression_level
= level
;
756 core_compression_seen
= 1;
757 if (!zlib_compression_seen
)
758 zlib_compression_level
= level
;
762 if (!strcmp(var
, "core.packedgitwindowsize")) {
763 int pgsz_x2
= getpagesize() * 2;
764 packed_git_window_size
= git_config_ulong(var
, value
);
766 /* This value must be multiple of (pagesize * 2) */
767 packed_git_window_size
/= pgsz_x2
;
768 if (packed_git_window_size
< 1)
769 packed_git_window_size
= 1;
770 packed_git_window_size
*= pgsz_x2
;
774 if (!strcmp(var
, "core.bigfilethreshold")) {
775 big_file_threshold
= git_config_ulong(var
, value
);
779 if (!strcmp(var
, "core.packedgitlimit")) {
780 packed_git_limit
= git_config_ulong(var
, value
);
784 if (!strcmp(var
, "core.deltabasecachelimit")) {
785 delta_base_cache_limit
= git_config_ulong(var
, value
);
789 if (!strcmp(var
, "core.autocrlf")) {
790 if (value
&& !strcasecmp(value
, "input")) {
791 if (core_eol
== EOL_CRLF
)
792 return error("core.autocrlf=input conflicts with core.eol=crlf");
793 auto_crlf
= AUTO_CRLF_INPUT
;
796 auto_crlf
= git_config_bool(var
, value
);
800 if (!strcmp(var
, "core.safecrlf")) {
801 if (value
&& !strcasecmp(value
, "warn")) {
802 safe_crlf
= SAFE_CRLF_WARN
;
805 safe_crlf
= git_config_bool(var
, value
);
809 if (!strcmp(var
, "core.eol")) {
810 if (value
&& !strcasecmp(value
, "lf"))
812 else if (value
&& !strcasecmp(value
, "crlf"))
814 else if (value
&& !strcasecmp(value
, "native"))
815 core_eol
= EOL_NATIVE
;
817 core_eol
= EOL_UNSET
;
818 if (core_eol
== EOL_CRLF
&& auto_crlf
== AUTO_CRLF_INPUT
)
819 return error("core.autocrlf=input conflicts with core.eol=crlf");
823 if (!strcmp(var
, "core.notesref")) {
824 notes_ref_name
= xstrdup(value
);
828 if (!strcmp(var
, "core.pager"))
829 return git_config_string(&pager_program
, var
, value
);
831 if (!strcmp(var
, "core.editor"))
832 return git_config_string(&editor_program
, var
, value
);
834 if (!strcmp(var
, "core.commentchar")) {
836 int ret
= git_config_string(&comment
, var
, value
);
838 comment_line_char
= comment
[0];
842 if (!strcmp(var
, "core.askpass"))
843 return git_config_string(&askpass_program
, var
, value
);
845 if (!strcmp(var
, "core.excludesfile"))
846 return git_config_pathname(&excludes_file
, var
, value
);
848 if (!strcmp(var
, "core.whitespace")) {
850 return config_error_nonbool(var
);
851 whitespace_rule_cfg
= parse_whitespace_rule(value
);
855 if (!strcmp(var
, "core.fsyncobjectfiles")) {
856 fsync_object_files
= git_config_bool(var
, value
);
860 if (!strcmp(var
, "core.preloadindex")) {
861 core_preload_index
= git_config_bool(var
, value
);
865 if (!strcmp(var
, "core.createobject")) {
866 if (!strcmp(value
, "rename"))
867 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
868 else if (!strcmp(value
, "link"))
869 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
871 die("Invalid mode for object creation: %s", value
);
875 if (!strcmp(var
, "core.sparsecheckout")) {
876 core_apply_sparse_checkout
= git_config_bool(var
, value
);
880 if (!strcmp(var
, "core.precomposeunicode")) {
881 precomposed_unicode
= git_config_bool(var
, value
);
885 /* Add other config variables here and to Documentation/config.txt. */
889 static int git_default_i18n_config(const char *var
, const char *value
)
891 if (!strcmp(var
, "i18n.commitencoding"))
892 return git_config_string(&git_commit_encoding
, var
, value
);
894 if (!strcmp(var
, "i18n.logoutputencoding"))
895 return git_config_string(&git_log_output_encoding
, var
, value
);
897 /* Add other config variables here and to Documentation/config.txt. */
901 static int git_default_branch_config(const char *var
, const char *value
)
903 if (!strcmp(var
, "branch.autosetupmerge")) {
904 if (value
&& !strcasecmp(value
, "always")) {
905 git_branch_track
= BRANCH_TRACK_ALWAYS
;
908 git_branch_track
= git_config_bool(var
, value
);
911 if (!strcmp(var
, "branch.autosetuprebase")) {
913 return config_error_nonbool(var
);
914 else if (!strcmp(value
, "never"))
915 autorebase
= AUTOREBASE_NEVER
;
916 else if (!strcmp(value
, "local"))
917 autorebase
= AUTOREBASE_LOCAL
;
918 else if (!strcmp(value
, "remote"))
919 autorebase
= AUTOREBASE_REMOTE
;
920 else if (!strcmp(value
, "always"))
921 autorebase
= AUTOREBASE_ALWAYS
;
923 return error("Malformed value for %s", var
);
927 /* Add other config variables here and to Documentation/config.txt. */
931 static int git_default_push_config(const char *var
, const char *value
)
933 if (!strcmp(var
, "push.default")) {
935 return config_error_nonbool(var
);
936 else if (!strcmp(value
, "nothing"))
937 push_default
= PUSH_DEFAULT_NOTHING
;
938 else if (!strcmp(value
, "matching"))
939 push_default
= PUSH_DEFAULT_MATCHING
;
940 else if (!strcmp(value
, "simple"))
941 push_default
= PUSH_DEFAULT_SIMPLE
;
942 else if (!strcmp(value
, "upstream"))
943 push_default
= PUSH_DEFAULT_UPSTREAM
;
944 else if (!strcmp(value
, "tracking")) /* deprecated */
945 push_default
= PUSH_DEFAULT_UPSTREAM
;
946 else if (!strcmp(value
, "current"))
947 push_default
= PUSH_DEFAULT_CURRENT
;
949 error("Malformed value for %s: %s", var
, value
);
950 return error("Must be one of nothing, matching, simple, "
951 "upstream or current.");
956 /* Add other config variables here and to Documentation/config.txt. */
960 static int git_default_mailmap_config(const char *var
, const char *value
)
962 if (!strcmp(var
, "mailmap.file"))
963 return git_config_string(&git_mailmap_file
, var
, value
);
964 if (!strcmp(var
, "mailmap.blob"))
965 return git_config_string(&git_mailmap_blob
, var
, value
);
967 /* Add other config variables here and to Documentation/config.txt. */
971 int git_default_config(const char *var
, const char *value
, void *dummy
)
973 if (!prefixcmp(var
, "core."))
974 return git_default_core_config(var
, value
);
976 if (!prefixcmp(var
, "user."))
977 return git_ident_config(var
, value
, dummy
);
979 if (!prefixcmp(var
, "i18n."))
980 return git_default_i18n_config(var
, value
);
982 if (!prefixcmp(var
, "branch."))
983 return git_default_branch_config(var
, value
);
985 if (!prefixcmp(var
, "push."))
986 return git_default_push_config(var
, value
);
988 if (!prefixcmp(var
, "mailmap."))
989 return git_default_mailmap_config(var
, value
);
991 if (!prefixcmp(var
, "advice."))
992 return git_default_advice_config(var
, value
);
994 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
995 pager_use_color
= git_config_bool(var
,value
);
999 if (!strcmp(var
, "pack.packsizelimit")) {
1000 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1003 /* Add other config variables here and to Documentation/config.txt. */
1008 * All source specific fields in the union, die_on_error, name and the callbacks
1009 * fgetc, ungetc, ftell of top need to be initialized before calling
1012 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1016 /* push config-file parsing state stack */
1020 strbuf_init(&top
->value
, 1024);
1021 strbuf_init(&top
->var
, 1024);
1024 ret
= git_parse_source(fn
, data
);
1026 /* pop config-file parsing state stack */
1027 strbuf_release(&top
->value
);
1028 strbuf_release(&top
->var
);
1034 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1037 FILE *f
= fopen(filename
, "r");
1041 struct config_source top
;
1044 top
.name
= filename
;
1045 top
.die_on_error
= 1;
1046 top
.do_fgetc
= config_file_fgetc
;
1047 top
.do_ungetc
= config_file_ungetc
;
1048 top
.do_ftell
= config_file_ftell
;
1050 ret
= do_config_from(&top
, fn
, data
);
1057 int git_config_from_buf(config_fn_t fn
, const char *name
, const char *buf
,
1058 size_t len
, void *data
)
1060 struct config_source top
;
1062 top
.u
.buf
.buf
= buf
;
1063 top
.u
.buf
.len
= len
;
1066 top
.die_on_error
= 0;
1067 top
.do_fgetc
= config_buf_fgetc
;
1068 top
.do_ungetc
= config_buf_ungetc
;
1069 top
.do_ftell
= config_buf_ftell
;
1071 return do_config_from(&top
, fn
, data
);
1074 static int git_config_from_blob_sha1(config_fn_t fn
,
1076 const unsigned char *sha1
,
1079 enum object_type type
;
1084 buf
= read_sha1_file(sha1
, &type
, &size
);
1086 return error("unable to load config blob object '%s'", name
);
1087 if (type
!= OBJ_BLOB
) {
1089 return error("reference '%s' does not point to a blob", name
);
1092 ret
= git_config_from_buf(fn
, name
, buf
, size
, data
);
1098 static int git_config_from_blob_ref(config_fn_t fn
,
1102 unsigned char sha1
[20];
1104 if (get_sha1(name
, sha1
) < 0)
1105 return error("unable to resolve config blob '%s'", name
);
1106 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1109 const char *git_etc_gitconfig(void)
1111 static const char *system_wide
;
1113 system_wide
= system_path(ETC_GITCONFIG
);
1117 int git_env_bool(const char *k
, int def
)
1119 const char *v
= getenv(k
);
1120 return v
? git_config_bool(k
, v
) : def
;
1123 int git_config_system(void)
1125 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1128 int git_config_early(config_fn_t fn
, void *data
, const char *repo_config
)
1130 int ret
= 0, found
= 0;
1131 char *xdg_config
= NULL
;
1132 char *user_config
= NULL
;
1134 home_config_paths(&user_config
, &xdg_config
, "config");
1136 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0)) {
1137 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1142 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
)) {
1143 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1147 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
)) {
1148 ret
+= git_config_from_file(fn
, user_config
, data
);
1152 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0)) {
1153 ret
+= git_config_from_file(fn
, repo_config
, data
);
1157 switch (git_config_from_parameters(fn
, data
)) {
1158 case -1: /* error */
1159 die("unable to parse command-line config");
1161 case 0: /* found nothing */
1163 default: /* found at least one item */
1170 return ret
== 0 ? found
: ret
;
1173 int git_config_with_options(config_fn_t fn
, void *data
,
1174 const char *filename
,
1175 const char *blob_ref
,
1176 int respect_includes
)
1178 char *repo_config
= NULL
;
1180 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1182 if (respect_includes
) {
1185 fn
= git_config_include
;
1190 * If we have a specific filename, use it. Otherwise, follow the
1191 * regular lookup sequence.
1194 return git_config_from_file(fn
, filename
, data
);
1196 return git_config_from_blob_ref(fn
, blob_ref
, data
);
1198 repo_config
= git_pathdup("config");
1199 ret
= git_config_early(fn
, data
, repo_config
);
1205 int git_config(config_fn_t fn
, void *data
)
1207 return git_config_with_options(fn
, data
, NULL
, NULL
, 1);
1211 * Find all the stuff for git_config_set() below.
1214 #define MAX_MATCHES 512
1220 regex_t
*value_regex
;
1222 size_t offset
[MAX_MATCHES
];
1223 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1227 static int matches(const char *key
, const char *value
)
1229 return !strcmp(key
, store
.key
) &&
1230 (store
.value_regex
== NULL
||
1231 (store
.do_not_match
^
1232 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
1235 static int store_aux(const char *key
, const char *value
, void *cb
)
1240 switch (store
.state
) {
1242 if (matches(key
, value
)) {
1243 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1244 warning("%s has multiple values", key
);
1245 } else if (store
.seen
>= MAX_MATCHES
) {
1246 error("too many matches for %s", key
);
1250 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1256 * What we are looking for is in store.key (both
1257 * section and var), and its section part is baselen
1258 * long. We found key (again, both section and var).
1259 * We would want to know if this key is in the same
1260 * section as what we are looking for. We already
1261 * know we are in the same section as what should
1264 ep
= strrchr(key
, '.');
1265 section_len
= ep
- key
;
1267 if ((section_len
!= store
.baselen
) ||
1268 memcmp(key
, store
.key
, section_len
+1)) {
1269 store
.state
= SECTION_END_SEEN
;
1274 * Do not increment matches: this is no match, but we
1275 * just made sure we are in the desired section.
1277 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1279 case SECTION_END_SEEN
:
1281 if (matches(key
, value
)) {
1282 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1283 store
.state
= KEY_SEEN
;
1286 if (strrchr(key
, '.') - key
== store
.baselen
&&
1287 !strncmp(key
, store
.key
, store
.baselen
)) {
1288 store
.state
= SECTION_SEEN
;
1289 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1296 static int write_error(const char *filename
)
1298 error("failed to write new configuration file %s", filename
);
1300 /* Same error code as "failed to rename". */
1304 static int store_write_section(int fd
, const char *key
)
1308 struct strbuf sb
= STRBUF_INIT
;
1310 dot
= memchr(key
, '.', store
.baselen
);
1312 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1313 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1314 if (key
[i
] == '"' || key
[i
] == '\\')
1315 strbuf_addch(&sb
, '\\');
1316 strbuf_addch(&sb
, key
[i
]);
1318 strbuf_addstr(&sb
, "\"]\n");
1320 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1323 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1324 strbuf_release(&sb
);
1329 static int store_write_pair(int fd
, const char *key
, const char *value
)
1332 int length
= strlen(key
+ store
.baselen
+ 1);
1333 const char *quote
= "";
1334 struct strbuf sb
= STRBUF_INIT
;
1337 * Check to see if the value needs to be surrounded with a dq pair.
1338 * Note that problematic characters are always backslash-quoted; this
1339 * check is about not losing leading or trailing SP and strings that
1340 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1341 * configuration parser.
1343 if (value
[0] == ' ')
1345 for (i
= 0; value
[i
]; i
++)
1346 if (value
[i
] == ';' || value
[i
] == '#')
1348 if (i
&& value
[i
- 1] == ' ')
1351 strbuf_addf(&sb
, "\t%.*s = %s",
1352 length
, key
+ store
.baselen
+ 1, quote
);
1354 for (i
= 0; value
[i
]; i
++)
1357 strbuf_addstr(&sb
, "\\n");
1360 strbuf_addstr(&sb
, "\\t");
1364 strbuf_addch(&sb
, '\\');
1366 strbuf_addch(&sb
, value
[i
]);
1369 strbuf_addf(&sb
, "%s\n", quote
);
1371 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1372 strbuf_release(&sb
);
1377 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1378 size_t offset_
, int *found_bracket
)
1380 size_t equal_offset
= size
, bracket_offset
= size
;
1384 for (offset
= offset_
-2; offset
> 0
1385 && contents
[offset
] != '\n'; offset
--)
1386 switch (contents
[offset
]) {
1387 case '=': equal_offset
= offset
; break;
1388 case ']': bracket_offset
= offset
; break;
1390 if (offset
> 0 && contents
[offset
-1] == '\\') {
1394 if (bracket_offset
< equal_offset
) {
1396 offset
= bracket_offset
+1;
1403 int git_config_set_in_file(const char *config_filename
,
1404 const char *key
, const char *value
)
1406 return git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1409 int git_config_set(const char *key
, const char *value
)
1411 return git_config_set_multivar(key
, value
, NULL
, 0);
1415 * Auxiliary function to sanity-check and split the key into the section
1416 * identifier and variable name.
1418 * Returns 0 on success, -1 when there is an invalid character in the key and
1419 * -2 if there is no section name in the key.
1421 * store_key - pointer to char* which will hold a copy of the key with
1422 * lowercase section and variable name
1423 * baselen - pointer to int which will hold the length of the
1424 * section + subsection part, can be NULL
1426 int git_config_parse_key(const char *key
, char **store_key
, int *baselen_
)
1428 int i
, dot
, baselen
;
1429 const char *last_dot
= strrchr(key
, '.');
1432 * Since "key" actually contains the section name and the real
1433 * key name separated by a dot, we have to know where the dot is.
1436 if (last_dot
== NULL
|| last_dot
== key
) {
1437 error("key does not contain a section: %s", key
);
1438 return -CONFIG_NO_SECTION_OR_NAME
;
1442 error("key does not contain variable name: %s", key
);
1443 return -CONFIG_NO_SECTION_OR_NAME
;
1446 baselen
= last_dot
- key
;
1448 *baselen_
= baselen
;
1451 * Validate the key and while at it, lower case it for matching.
1453 *store_key
= xmalloc(strlen(key
) + 1);
1456 for (i
= 0; key
[i
]; i
++) {
1457 unsigned char c
= key
[i
];
1460 /* Leave the extended basename untouched.. */
1461 if (!dot
|| i
> baselen
) {
1462 if (!iskeychar(c
) ||
1463 (i
== baselen
+ 1 && !isalpha(c
))) {
1464 error("invalid key: %s", key
);
1465 goto out_free_ret_1
;
1468 } else if (c
== '\n') {
1469 error("invalid key (newline): %s", key
);
1470 goto out_free_ret_1
;
1472 (*store_key
)[i
] = c
;
1474 (*store_key
)[i
] = 0;
1481 return -CONFIG_INVALID_KEY
;
1485 * If value==NULL, unset in (remove from) config,
1486 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1487 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1488 * else all matching key/values (regardless how many) are removed,
1489 * before the new pair is written.
1491 * Returns 0 on success.
1493 * This function does this:
1495 * - it locks the config file by creating ".git/config.lock"
1497 * - it then parses the config using store_aux() as validator to find
1498 * the position on the key/value pair to replace. If it is to be unset,
1499 * it must be found exactly once.
1501 * - the config file is mmap()ed and the part before the match (if any) is
1502 * written to the lock file, then the changed part and the rest.
1504 * - the config file is removed and the lock file rename()d to it.
1507 int git_config_set_multivar_in_file(const char *config_filename
,
1508 const char *key
, const char *value
,
1509 const char *value_regex
, int multi_replace
)
1513 struct lock_file
*lock
= NULL
;
1514 char *filename_buf
= NULL
;
1516 /* parse-key returns negative; flip the sign to feed exit(3) */
1517 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
1521 store
.multi_replace
= multi_replace
;
1523 if (!config_filename
)
1524 config_filename
= filename_buf
= git_pathdup("config");
1527 * The lock serves a purpose in addition to locking: the new
1528 * contents of .git/config will be written into it.
1530 lock
= xcalloc(sizeof(struct lock_file
), 1);
1531 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1533 error("could not lock config file %s: %s", config_filename
, strerror(errno
));
1535 ret
= CONFIG_NO_LOCK
;
1540 * If .git/config does not exist yet, write a minimal version.
1542 in_fd
= open(config_filename
, O_RDONLY
);
1546 if ( ENOENT
!= errno
) {
1547 error("opening %s: %s", config_filename
,
1549 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
1552 /* if nothing to unset, error out */
1553 if (value
== NULL
) {
1554 ret
= CONFIG_NOTHING_SET
;
1558 store
.key
= (char *)key
;
1559 if (!store_write_section(fd
, key
) ||
1560 !store_write_pair(fd
, key
, value
))
1565 size_t contents_sz
, copy_begin
, copy_end
;
1566 int i
, new_line
= 0;
1568 if (value_regex
== NULL
)
1569 store
.value_regex
= NULL
;
1571 if (value_regex
[0] == '!') {
1572 store
.do_not_match
= 1;
1575 store
.do_not_match
= 0;
1577 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
1578 if (regcomp(store
.value_regex
, value_regex
,
1580 error("invalid pattern: %s", value_regex
);
1581 free(store
.value_regex
);
1582 ret
= CONFIG_INVALID_PATTERN
;
1587 store
.offset
[0] = 0;
1588 store
.state
= START
;
1592 * After this, store.offset will contain the *end* offset
1593 * of the last match, or remain at 0 if no match was found.
1594 * As a side effect, we make sure to transform only a valid
1595 * existing config file.
1597 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
1598 error("invalid config file %s", config_filename
);
1600 if (store
.value_regex
!= NULL
) {
1601 regfree(store
.value_regex
);
1602 free(store
.value_regex
);
1604 ret
= CONFIG_INVALID_FILE
;
1609 if (store
.value_regex
!= NULL
) {
1610 regfree(store
.value_regex
);
1611 free(store
.value_regex
);
1614 /* if nothing to unset, or too many matches, error out */
1615 if ((store
.seen
== 0 && value
== NULL
) ||
1616 (store
.seen
> 1 && multi_replace
== 0)) {
1617 ret
= CONFIG_NOTHING_SET
;
1622 contents_sz
= xsize_t(st
.st_size
);
1623 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
1624 MAP_PRIVATE
, in_fd
, 0);
1627 if (store
.seen
== 0)
1630 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
1631 if (store
.offset
[i
] == 0) {
1632 store
.offset
[i
] = copy_end
= contents_sz
;
1633 } else if (store
.state
!= KEY_SEEN
) {
1634 copy_end
= store
.offset
[i
];
1636 copy_end
= find_beginning_of_line(
1637 contents
, contents_sz
,
1638 store
.offset
[i
]-2, &new_line
);
1640 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
1643 /* write the first part of the config */
1644 if (copy_end
> copy_begin
) {
1645 if (write_in_full(fd
, contents
+ copy_begin
,
1646 copy_end
- copy_begin
) <
1647 copy_end
- copy_begin
)
1650 write_str_in_full(fd
, "\n") != 1)
1653 copy_begin
= store
.offset
[i
];
1656 /* write the pair (value == NULL means unset) */
1657 if (value
!= NULL
) {
1658 if (store
.state
== START
) {
1659 if (!store_write_section(fd
, key
))
1662 if (!store_write_pair(fd
, key
, value
))
1666 /* write the rest of the config */
1667 if (copy_begin
< contents_sz
)
1668 if (write_in_full(fd
, contents
+ copy_begin
,
1669 contents_sz
- copy_begin
) <
1670 contents_sz
- copy_begin
)
1673 munmap(contents
, contents_sz
);
1676 if (commit_lock_file(lock
) < 0) {
1677 error("could not commit config file %s", config_filename
);
1678 ret
= CONFIG_NO_WRITE
;
1683 * lock is committed, so don't try to roll it back below.
1684 * NOTE: Since lockfile.c keeps a linked list of all created
1685 * lock_file structures, it isn't safe to free(lock). It's
1686 * better to just leave it hanging around.
1693 rollback_lock_file(lock
);
1698 ret
= write_error(lock
->filename
);
1703 int git_config_set_multivar(const char *key
, const char *value
,
1704 const char *value_regex
, int multi_replace
)
1706 return git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
1710 static int section_name_match (const char *buf
, const char *name
)
1712 int i
= 0, j
= 0, dot
= 0;
1715 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
1716 if (!dot
&& isspace(buf
[i
])) {
1718 if (name
[j
++] != '.')
1720 for (i
++; isspace(buf
[i
]); i
++)
1726 if (buf
[i
] == '\\' && dot
)
1728 else if (buf
[i
] == '"' && dot
) {
1729 for (i
++; isspace(buf
[i
]); i
++)
1733 if (buf
[i
] != name
[j
++])
1736 if (buf
[i
] == ']' && name
[j
] == 0) {
1738 * We match, now just find the right length offset by
1739 * gobbling up any whitespace after it, as well
1742 for (; buf
[i
] && isspace(buf
[i
]); i
++)
1749 static int section_name_is_ok(const char *name
)
1751 /* Empty section names are bogus. */
1756 * Before a dot, we must be alphanumeric or dash. After the first dot,
1757 * anything goes, so we can stop checking.
1759 for (; *name
&& *name
!= '.'; name
++)
1760 if (*name
!= '-' && !isalnum(*name
))
1765 /* if new_name == NULL, the section is removed instead */
1766 int git_config_rename_section_in_file(const char *config_filename
,
1767 const char *old_name
, const char *new_name
)
1769 int ret
= 0, remove
= 0;
1770 char *filename_buf
= NULL
;
1771 struct lock_file
*lock
;
1776 if (new_name
&& !section_name_is_ok(new_name
)) {
1777 ret
= error("invalid section name: %s", new_name
);
1781 if (!config_filename
)
1782 config_filename
= filename_buf
= git_pathdup("config");
1784 lock
= xcalloc(sizeof(struct lock_file
), 1);
1785 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1787 ret
= error("could not lock config file %s", config_filename
);
1791 if (!(config_file
= fopen(config_filename
, "rb"))) {
1792 /* no config file means nothing to rename, no error */
1793 goto unlock_and_out
;
1796 while (fgets(buf
, sizeof(buf
), config_file
)) {
1800 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1802 if (buf
[i
] == '[') {
1803 /* it's a section */
1804 int offset
= section_name_match(&buf
[i
], old_name
);
1807 if (new_name
== NULL
) {
1811 store
.baselen
= strlen(new_name
);
1812 if (!store_write_section(out_fd
, new_name
)) {
1813 ret
= write_error(lock
->filename
);
1817 * We wrote out the new section, with
1818 * a newline, now skip the old
1821 output
+= offset
+ i
;
1822 if (strlen(output
) > 0) {
1824 * More content means there's
1825 * a declaration to put on the
1826 * next line; indent with a
1837 length
= strlen(output
);
1838 if (write_in_full(out_fd
, output
, length
) != length
) {
1839 ret
= write_error(lock
->filename
);
1843 fclose(config_file
);
1845 if (commit_lock_file(lock
) < 0)
1846 ret
= error("could not commit config file %s", config_filename
);
1852 int git_config_rename_section(const char *old_name
, const char *new_name
)
1854 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
1858 * Call this to report error for your variable that should not
1859 * get a boolean value (i.e. "[my] var" means "true").
1861 #undef config_error_nonbool
1862 int config_error_nonbool(const char *var
)
1864 return error("Missing value for '%s'", var
);
1867 int parse_config_key(const char *var
,
1868 const char *section
,
1869 const char **subsection
, int *subsection_len
,
1872 int section_len
= strlen(section
);
1875 /* Does it start with "section." ? */
1876 if (prefixcmp(var
, section
) || var
[section_len
] != '.')
1880 * Find the key; we don't know yet if we have a subsection, but we must
1881 * parse backwards from the end, since the subsection may have dots in
1884 dot
= strrchr(var
, '.');
1887 /* Did we have a subsection at all? */
1888 if (dot
== var
+ section_len
) {
1890 *subsection_len
= 0;
1893 *subsection
= var
+ section_len
+ 1;
1894 *subsection_len
= dot
- *subsection
;