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
;
90 return config_error_nonbool("include.path");
92 expanded
= expand_user_path(path
);
94 return error("Could not expand include path '%s'", path
);
98 * Use an absolute path as-is, but interpret relative paths
99 * based on the including config file.
101 if (!is_absolute_path(path
)) {
104 if (!cf
|| !cf
->name
)
105 return error("relative config includes must come from files");
107 slash
= find_last_dir_sep(cf
->name
);
109 strbuf_add(&buf
, cf
->name
, slash
- cf
->name
+ 1);
110 strbuf_addstr(&buf
, path
);
114 if (!access_or_die(path
, R_OK
, 0)) {
115 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
116 die(include_depth_advice
, MAX_INCLUDE_DEPTH
, path
,
117 cf
&& cf
->name
? cf
->name
: "the command line");
118 ret
= git_config_from_file(git_config_include
, path
, inc
);
121 strbuf_release(&buf
);
126 int git_config_include(const char *var
, const char *value
, void *data
)
128 struct config_include_data
*inc
= data
;
133 * Pass along all values, including "include" directives; this makes it
134 * possible to query information on the includes themselves.
136 ret
= inc
->fn(var
, value
, inc
->data
);
140 type
= skip_prefix(var
, "include.");
144 if (!strcmp(type
, "path"))
145 ret
= handle_path_include(value
, inc
);
149 static void lowercase(char *p
)
155 void git_config_push_parameter(const char *text
)
157 struct strbuf env
= STRBUF_INIT
;
158 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
160 strbuf_addstr(&env
, old
);
161 strbuf_addch(&env
, ' ');
163 sq_quote_buf(&env
, text
);
164 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
165 strbuf_release(&env
);
168 int git_config_parse_parameter(const char *text
,
169 config_fn_t fn
, void *data
)
171 struct strbuf
**pair
;
172 pair
= strbuf_split_str(text
, '=', 2);
174 return error("bogus config parameter: %s", text
);
175 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=')
176 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
177 strbuf_trim(pair
[0]);
179 strbuf_list_free(pair
);
180 return error("bogus config parameter: %s", text
);
182 lowercase(pair
[0]->buf
);
183 if (fn(pair
[0]->buf
, pair
[1] ? pair
[1]->buf
: NULL
, data
) < 0) {
184 strbuf_list_free(pair
);
187 strbuf_list_free(pair
);
191 int git_config_from_parameters(config_fn_t fn
, void *data
)
193 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
195 const char **argv
= NULL
;
196 int nr
= 0, alloc
= 0;
201 /* sq_dequote will write over it */
204 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
206 return error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
209 for (i
= 0; i
< nr
; i
++) {
210 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
222 static int get_next_char(void)
224 int c
= cf
->do_fgetc(cf
);
227 /* DOS like systems */
228 c
= cf
->do_fgetc(cf
);
230 cf
->do_ungetc(c
, cf
);
243 static char *parse_value(void)
245 int quote
= 0, comment
= 0, space
= 0;
247 strbuf_reset(&cf
->value
);
249 int c
= get_next_char();
255 return cf
->value
.buf
;
259 if (isspace(c
) && !quote
) {
265 if (c
== ';' || c
== '#') {
270 for (; space
; space
--)
271 strbuf_addch(&cf
->value
, ' ');
286 /* Some characters escape as themselves */
289 /* Reject unknown escape sequences */
293 strbuf_addch(&cf
->value
, c
);
300 strbuf_addch(&cf
->value
, c
);
304 static inline int iskeychar(int c
)
306 return isalnum(c
) || c
== '-';
309 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
314 /* Get the full name */
321 strbuf_addch(name
, tolower(c
));
324 while (c
== ' ' || c
== '\t')
331 value
= parse_value();
335 return fn(name
->buf
, value
, data
);
338 static int get_extended_base_var(struct strbuf
*name
, int c
)
342 goto error_incomplete_line
;
344 } while (isspace(c
));
346 /* We require the format to be '[base "extension"]' */
349 strbuf_addch(name
, '.');
352 int c
= get_next_char();
354 goto error_incomplete_line
;
360 goto error_incomplete_line
;
362 strbuf_addch(name
, c
);
366 if (get_next_char() != ']')
369 error_incomplete_line
:
374 static int get_base_var(struct strbuf
*name
)
377 int c
= get_next_char();
383 return get_extended_base_var(name
, c
);
384 if (!iskeychar(c
) && c
!= '.')
386 strbuf_addch(name
, tolower(c
));
390 static int git_parse_source(config_fn_t fn
, void *data
)
394 struct strbuf
*var
= &cf
->var
;
396 /* U+FEFF Byte Order Mark in UTF8 */
397 static const unsigned char *utf8_bom
= (unsigned char *) "\xef\xbb\xbf";
398 const unsigned char *bomptr
= utf8_bom
;
401 int c
= get_next_char();
402 if (bomptr
&& *bomptr
) {
403 /* We are at the file beginning; skip UTF8-encoded BOM
404 * if present. Sane editors won't put this in on their
405 * own, but e.g. Windows Notepad will do it happily. */
406 if ((unsigned char) c
== *bomptr
) {
410 /* Do not tolerate partial BOM. */
411 if (bomptr
!= utf8_bom
)
413 /* No BOM at file beginning. Cool. */
423 if (comment
|| isspace(c
))
425 if (c
== '#' || c
== ';') {
430 /* Reset prior to determining a new stem */
432 if (get_base_var(var
) < 0 || var
->len
< 1)
434 strbuf_addch(var
, '.');
441 * Truncate the var name back to the section header
442 * stem prior to grabbing the suffix part of the name
445 strbuf_setlen(var
, baselen
);
446 strbuf_addch(var
, tolower(c
));
447 if (get_value(fn
, data
, var
) < 0)
450 if (cf
->die_on_error
)
451 die("bad config file line %d in %s", cf
->linenr
, cf
->name
);
453 return error("bad config file line %d in %s", cf
->linenr
, cf
->name
);
456 static int parse_unit_factor(const char *end
, uintmax_t *val
)
460 else if (!strcasecmp(end
, "k")) {
464 else if (!strcasecmp(end
, "m")) {
468 else if (!strcasecmp(end
, "g")) {
469 *val
*= 1024 * 1024 * 1024;
475 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
477 if (value
&& *value
) {
481 uintmax_t factor
= 1;
484 val
= strtoimax(value
, &end
, 0);
487 if (!parse_unit_factor(end
, &factor
)) {
493 if (uval
> max
|| abs(val
) > uval
) {
505 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
507 if (value
&& *value
) {
513 val
= strtoumax(value
, &end
, 0);
517 if (!parse_unit_factor(end
, &val
)) {
521 if (val
> max
|| oldval
> val
) {
532 static int git_parse_int(const char *value
, int *ret
)
535 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
541 static int git_parse_int64(const char *value
, int64_t *ret
)
544 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
550 int git_parse_ulong(const char *value
, unsigned long *ret
)
553 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
560 static void die_bad_number(const char *name
, const char *value
)
562 const char *reason
= errno
== ERANGE
?
569 die("bad numeric config value '%s' for '%s' in %s: %s",
570 value
, name
, cf
->name
, reason
);
571 die("bad numeric config value '%s' for '%s': %s", value
, name
, reason
);
574 int git_config_int(const char *name
, const char *value
)
577 if (!git_parse_int(value
, &ret
))
578 die_bad_number(name
, value
);
582 int64_t git_config_int64(const char *name
, const char *value
)
585 if (!git_parse_int64(value
, &ret
))
586 die_bad_number(name
, value
);
590 unsigned long git_config_ulong(const char *name
, const char *value
)
593 if (!git_parse_ulong(value
, &ret
))
594 die_bad_number(name
, value
);
598 static int git_config_maybe_bool_text(const char *name
, const char *value
)
604 if (!strcasecmp(value
, "true")
605 || !strcasecmp(value
, "yes")
606 || !strcasecmp(value
, "on"))
608 if (!strcasecmp(value
, "false")
609 || !strcasecmp(value
, "no")
610 || !strcasecmp(value
, "off"))
615 int git_config_maybe_bool(const char *name
, const char *value
)
617 int v
= git_config_maybe_bool_text(name
, value
);
620 if (git_parse_int(value
, &v
))
625 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
627 int v
= git_config_maybe_bool_text(name
, value
);
633 return git_config_int(name
, value
);
636 int git_config_bool(const char *name
, const char *value
)
639 return !!git_config_bool_or_int(name
, value
, &discard
);
642 int git_config_string(const char **dest
, const char *var
, const char *value
)
645 return config_error_nonbool(var
);
646 *dest
= xstrdup(value
);
650 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
653 return config_error_nonbool(var
);
654 *dest
= expand_user_path(value
);
656 die("Failed to expand user dir in: '%s'", value
);
660 static int git_default_core_config(const char *var
, const char *value
)
662 /* This needs a better name */
663 if (!strcmp(var
, "core.filemode")) {
664 trust_executable_bit
= git_config_bool(var
, value
);
667 if (!strcmp(var
, "core.trustctime")) {
668 trust_ctime
= git_config_bool(var
, value
);
671 if (!strcmp(var
, "core.statinfo") ||
672 !strcmp(var
, "core.checkstat")) {
674 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
675 * never been advertised. we will remove it at Git
678 if (!strcmp(var
, "core.statinfo")) {
681 warning("'core.statinfo' will be removed in Git 2.0; "
682 "use 'core.checkstat' instead.");
685 if (!strcasecmp(value
, "default"))
687 else if (!strcasecmp(value
, "minimal"))
691 if (!strcmp(var
, "core.quotepath")) {
692 quote_path_fully
= git_config_bool(var
, value
);
696 if (!strcmp(var
, "core.symlinks")) {
697 has_symlinks
= git_config_bool(var
, value
);
701 if (!strcmp(var
, "core.ignorecase")) {
702 ignore_case
= git_config_bool(var
, value
);
706 if (!strcmp(var
, "core.attributesfile"))
707 return git_config_pathname(&git_attributes_file
, var
, value
);
709 if (!strcmp(var
, "core.bare")) {
710 is_bare_repository_cfg
= git_config_bool(var
, value
);
714 if (!strcmp(var
, "core.ignorestat")) {
715 assume_unchanged
= git_config_bool(var
, value
);
719 if (!strcmp(var
, "core.prefersymlinkrefs")) {
720 prefer_symlink_refs
= git_config_bool(var
, value
);
724 if (!strcmp(var
, "core.logallrefupdates")) {
725 log_all_ref_updates
= git_config_bool(var
, value
);
729 if (!strcmp(var
, "core.warnambiguousrefs")) {
730 warn_ambiguous_refs
= git_config_bool(var
, value
);
734 if (!strcmp(var
, "core.abbrev")) {
735 int abbrev
= git_config_int(var
, value
);
736 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
738 default_abbrev
= abbrev
;
742 if (!strcmp(var
, "core.loosecompression")) {
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 zlib_compression_level
= level
;
749 zlib_compression_seen
= 1;
753 if (!strcmp(var
, "core.compression")) {
754 int level
= git_config_int(var
, value
);
756 level
= Z_DEFAULT_COMPRESSION
;
757 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
758 die("bad zlib compression level %d", level
);
759 core_compression_level
= level
;
760 core_compression_seen
= 1;
761 if (!zlib_compression_seen
)
762 zlib_compression_level
= level
;
766 if (!strcmp(var
, "core.packedgitwindowsize")) {
767 int pgsz_x2
= getpagesize() * 2;
768 packed_git_window_size
= git_config_ulong(var
, value
);
770 /* This value must be multiple of (pagesize * 2) */
771 packed_git_window_size
/= pgsz_x2
;
772 if (packed_git_window_size
< 1)
773 packed_git_window_size
= 1;
774 packed_git_window_size
*= pgsz_x2
;
778 if (!strcmp(var
, "core.bigfilethreshold")) {
779 big_file_threshold
= git_config_ulong(var
, value
);
783 if (!strcmp(var
, "core.packedgitlimit")) {
784 packed_git_limit
= git_config_ulong(var
, value
);
788 if (!strcmp(var
, "core.deltabasecachelimit")) {
789 delta_base_cache_limit
= git_config_ulong(var
, value
);
793 if (!strcmp(var
, "core.autocrlf")) {
794 if (value
&& !strcasecmp(value
, "input")) {
795 if (core_eol
== EOL_CRLF
)
796 return error("core.autocrlf=input conflicts with core.eol=crlf");
797 auto_crlf
= AUTO_CRLF_INPUT
;
800 auto_crlf
= git_config_bool(var
, value
);
804 if (!strcmp(var
, "core.safecrlf")) {
805 if (value
&& !strcasecmp(value
, "warn")) {
806 safe_crlf
= SAFE_CRLF_WARN
;
809 safe_crlf
= git_config_bool(var
, value
);
813 if (!strcmp(var
, "core.eol")) {
814 if (value
&& !strcasecmp(value
, "lf"))
816 else if (value
&& !strcasecmp(value
, "crlf"))
818 else if (value
&& !strcasecmp(value
, "native"))
819 core_eol
= EOL_NATIVE
;
821 core_eol
= EOL_UNSET
;
822 if (core_eol
== EOL_CRLF
&& auto_crlf
== AUTO_CRLF_INPUT
)
823 return error("core.autocrlf=input conflicts with core.eol=crlf");
827 if (!strcmp(var
, "core.notesref")) {
828 notes_ref_name
= xstrdup(value
);
832 if (!strcmp(var
, "core.pager"))
833 return git_config_string(&pager_program
, var
, value
);
835 if (!strcmp(var
, "core.editor"))
836 return git_config_string(&editor_program
, var
, value
);
838 if (!strcmp(var
, "core.commentchar")) {
840 int ret
= git_config_string(&comment
, var
, value
);
842 comment_line_char
= comment
[0];
846 if (!strcmp(var
, "core.askpass"))
847 return git_config_string(&askpass_program
, var
, value
);
849 if (!strcmp(var
, "core.excludesfile"))
850 return git_config_pathname(&excludes_file
, var
, value
);
852 if (!strcmp(var
, "core.whitespace")) {
854 return config_error_nonbool(var
);
855 whitespace_rule_cfg
= parse_whitespace_rule(value
);
859 if (!strcmp(var
, "core.fsyncobjectfiles")) {
860 fsync_object_files
= git_config_bool(var
, value
);
864 if (!strcmp(var
, "core.preloadindex")) {
865 core_preload_index
= git_config_bool(var
, value
);
869 if (!strcmp(var
, "core.createobject")) {
870 if (!strcmp(value
, "rename"))
871 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
872 else if (!strcmp(value
, "link"))
873 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
875 die("Invalid mode for object creation: %s", value
);
879 if (!strcmp(var
, "core.sparsecheckout")) {
880 core_apply_sparse_checkout
= git_config_bool(var
, value
);
884 if (!strcmp(var
, "core.precomposeunicode")) {
885 precomposed_unicode
= git_config_bool(var
, value
);
889 if (!strcmp(var
, "core.hidedotfiles")) {
890 if (value
&& !strcasecmp(value
, "dotgitonly")) {
891 hide_dotfiles
= HIDE_DOTFILES_DOTGITONLY
;
894 hide_dotfiles
= git_config_bool(var
, value
);
898 /* Add other config variables here and to Documentation/config.txt. */
902 static int git_default_i18n_config(const char *var
, const char *value
)
904 if (!strcmp(var
, "i18n.commitencoding"))
905 return git_config_string(&git_commit_encoding
, var
, value
);
907 if (!strcmp(var
, "i18n.logoutputencoding"))
908 return git_config_string(&git_log_output_encoding
, var
, value
);
910 /* Add other config variables here and to Documentation/config.txt. */
914 static int git_default_branch_config(const char *var
, const char *value
)
916 if (!strcmp(var
, "branch.autosetupmerge")) {
917 if (value
&& !strcasecmp(value
, "always")) {
918 git_branch_track
= BRANCH_TRACK_ALWAYS
;
921 git_branch_track
= git_config_bool(var
, value
);
924 if (!strcmp(var
, "branch.autosetuprebase")) {
926 return config_error_nonbool(var
);
927 else if (!strcmp(value
, "never"))
928 autorebase
= AUTOREBASE_NEVER
;
929 else if (!strcmp(value
, "local"))
930 autorebase
= AUTOREBASE_LOCAL
;
931 else if (!strcmp(value
, "remote"))
932 autorebase
= AUTOREBASE_REMOTE
;
933 else if (!strcmp(value
, "always"))
934 autorebase
= AUTOREBASE_ALWAYS
;
936 return error("Malformed value for %s", var
);
940 /* Add other config variables here and to Documentation/config.txt. */
944 static int git_default_push_config(const char *var
, const char *value
)
946 if (!strcmp(var
, "push.default")) {
948 return config_error_nonbool(var
);
949 else if (!strcmp(value
, "nothing"))
950 push_default
= PUSH_DEFAULT_NOTHING
;
951 else if (!strcmp(value
, "matching"))
952 push_default
= PUSH_DEFAULT_MATCHING
;
953 else if (!strcmp(value
, "simple"))
954 push_default
= PUSH_DEFAULT_SIMPLE
;
955 else if (!strcmp(value
, "upstream"))
956 push_default
= PUSH_DEFAULT_UPSTREAM
;
957 else if (!strcmp(value
, "tracking")) /* deprecated */
958 push_default
= PUSH_DEFAULT_UPSTREAM
;
959 else if (!strcmp(value
, "current"))
960 push_default
= PUSH_DEFAULT_CURRENT
;
962 error("Malformed value for %s: %s", var
, value
);
963 return error("Must be one of nothing, matching, simple, "
964 "upstream or current.");
969 /* Add other config variables here and to Documentation/config.txt. */
973 static int git_default_mailmap_config(const char *var
, const char *value
)
975 if (!strcmp(var
, "mailmap.file"))
976 return git_config_string(&git_mailmap_file
, var
, value
);
977 if (!strcmp(var
, "mailmap.blob"))
978 return git_config_string(&git_mailmap_blob
, var
, value
);
980 /* Add other config variables here and to Documentation/config.txt. */
984 int git_default_config(const char *var
, const char *value
, void *dummy
)
986 if (starts_with(var
, "core."))
987 return git_default_core_config(var
, value
);
989 if (starts_with(var
, "user."))
990 return git_ident_config(var
, value
, dummy
);
992 if (starts_with(var
, "i18n."))
993 return git_default_i18n_config(var
, value
);
995 if (starts_with(var
, "branch."))
996 return git_default_branch_config(var
, value
);
998 if (starts_with(var
, "push."))
999 return git_default_push_config(var
, value
);
1001 if (starts_with(var
, "mailmap."))
1002 return git_default_mailmap_config(var
, value
);
1004 if (starts_with(var
, "advice."))
1005 return git_default_advice_config(var
, value
);
1007 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1008 pager_use_color
= git_config_bool(var
,value
);
1012 if (!strcmp(var
, "pack.packsizelimit")) {
1013 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1016 /* Add other config variables here and to Documentation/config.txt. */
1021 * All source specific fields in the union, die_on_error, name and the callbacks
1022 * fgetc, ungetc, ftell of top need to be initialized before calling
1025 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
)
1029 /* push config-file parsing state stack */
1033 strbuf_init(&top
->value
, 1024);
1034 strbuf_init(&top
->var
, 1024);
1037 ret
= git_parse_source(fn
, data
);
1039 /* pop config-file parsing state stack */
1040 strbuf_release(&top
->value
);
1041 strbuf_release(&top
->var
);
1047 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1050 FILE *f
= fopen(filename
, "r");
1054 struct config_source top
;
1057 top
.name
= filename
;
1058 top
.die_on_error
= 1;
1059 top
.do_fgetc
= config_file_fgetc
;
1060 top
.do_ungetc
= config_file_ungetc
;
1061 top
.do_ftell
= config_file_ftell
;
1063 ret
= do_config_from(&top
, fn
, data
);
1070 int git_config_from_buf(config_fn_t fn
, const char *name
, const char *buf
,
1071 size_t len
, void *data
)
1073 struct config_source top
;
1075 top
.u
.buf
.buf
= buf
;
1076 top
.u
.buf
.len
= len
;
1079 top
.die_on_error
= 0;
1080 top
.do_fgetc
= config_buf_fgetc
;
1081 top
.do_ungetc
= config_buf_ungetc
;
1082 top
.do_ftell
= config_buf_ftell
;
1084 return do_config_from(&top
, fn
, data
);
1087 static int git_config_from_blob_sha1(config_fn_t fn
,
1089 const unsigned char *sha1
,
1092 enum object_type type
;
1097 buf
= read_sha1_file(sha1
, &type
, &size
);
1099 return error("unable to load config blob object '%s'", name
);
1100 if (type
!= OBJ_BLOB
) {
1102 return error("reference '%s' does not point to a blob", name
);
1105 ret
= git_config_from_buf(fn
, name
, buf
, size
, data
);
1111 static int git_config_from_blob_ref(config_fn_t fn
,
1115 unsigned char sha1
[20];
1117 if (get_sha1(name
, sha1
) < 0)
1118 return error("unable to resolve config blob '%s'", name
);
1119 return git_config_from_blob_sha1(fn
, name
, sha1
, data
);
1122 const char *git_etc_gitconfig(void)
1124 static const char *system_wide
;
1126 system_wide
= system_path(ETC_GITCONFIG
);
1130 int git_env_bool(const char *k
, int def
)
1132 const char *v
= getenv(k
);
1133 return v
? git_config_bool(k
, v
) : def
;
1136 int git_config_system(void)
1138 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1141 int git_config_early(config_fn_t fn
, void *data
, const char *repo_config
)
1143 int ret
= 0, found
= 0;
1144 char *xdg_config
= NULL
;
1145 char *user_config
= NULL
;
1147 home_config_paths(&user_config
, &xdg_config
, "config");
1149 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
, 0)) {
1150 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
1155 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
)) {
1156 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1160 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
)) {
1161 ret
+= git_config_from_file(fn
, user_config
, data
);
1165 if (repo_config
&& !access_or_die(repo_config
, R_OK
, 0)) {
1166 ret
+= git_config_from_file(fn
, repo_config
, data
);
1170 switch (git_config_from_parameters(fn
, data
)) {
1171 case -1: /* error */
1172 die("unable to parse command-line config");
1174 case 0: /* found nothing */
1176 default: /* found at least one item */
1183 return ret
== 0 ? found
: ret
;
1186 int git_config_with_options(config_fn_t fn
, void *data
,
1187 const char *filename
,
1188 const char *blob_ref
,
1189 int respect_includes
)
1191 char *repo_config
= NULL
;
1193 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1195 if (respect_includes
) {
1198 fn
= git_config_include
;
1203 * If we have a specific filename, use it. Otherwise, follow the
1204 * regular lookup sequence.
1207 return git_config_from_file(fn
, filename
, data
);
1209 return git_config_from_blob_ref(fn
, blob_ref
, data
);
1211 repo_config
= git_pathdup("config");
1212 ret
= git_config_early(fn
, data
, repo_config
);
1218 int git_config(config_fn_t fn
, void *data
)
1220 return git_config_with_options(fn
, data
, NULL
, NULL
, 1);
1224 * Find all the stuff for git_config_set() below.
1231 regex_t
*value_regex
;
1234 unsigned int offset_alloc
;
1235 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1239 static int matches(const char *key
, const char *value
)
1241 return !strcmp(key
, store
.key
) &&
1242 (store
.value_regex
== NULL
||
1243 (store
.do_not_match
^
1244 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
1247 static int store_aux(const char *key
, const char *value
, void *cb
)
1252 switch (store
.state
) {
1254 if (matches(key
, value
)) {
1255 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1256 warning("%s has multiple values", key
);
1259 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1260 store
.offset_alloc
);
1262 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1268 * What we are looking for is in store.key (both
1269 * section and var), and its section part is baselen
1270 * long. We found key (again, both section and var).
1271 * We would want to know if this key is in the same
1272 * section as what we are looking for. We already
1273 * know we are in the same section as what should
1276 ep
= strrchr(key
, '.');
1277 section_len
= ep
- key
;
1279 if ((section_len
!= store
.baselen
) ||
1280 memcmp(key
, store
.key
, section_len
+1)) {
1281 store
.state
= SECTION_END_SEEN
;
1286 * Do not increment matches: this is no match, but we
1287 * just made sure we are in the desired section.
1289 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1290 store
.offset_alloc
);
1291 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1293 case SECTION_END_SEEN
:
1295 if (matches(key
, value
)) {
1296 ALLOC_GROW(store
.offset
, store
.seen
+ 1,
1297 store
.offset_alloc
);
1298 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1299 store
.state
= KEY_SEEN
;
1302 if (strrchr(key
, '.') - key
== store
.baselen
&&
1303 !strncmp(key
, store
.key
, store
.baselen
)) {
1304 store
.state
= SECTION_SEEN
;
1305 ALLOC_GROW(store
.offset
,
1307 store
.offset_alloc
);
1308 store
.offset
[store
.seen
] = cf
->do_ftell(cf
);
1315 static int write_error(const char *filename
)
1317 error("failed to write new configuration file %s", filename
);
1319 /* Same error code as "failed to rename". */
1323 static int store_write_section(int fd
, const char *key
)
1327 struct strbuf sb
= STRBUF_INIT
;
1329 dot
= memchr(key
, '.', store
.baselen
);
1331 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1332 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1333 if (key
[i
] == '"' || key
[i
] == '\\')
1334 strbuf_addch(&sb
, '\\');
1335 strbuf_addch(&sb
, key
[i
]);
1337 strbuf_addstr(&sb
, "\"]\n");
1339 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1342 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1343 strbuf_release(&sb
);
1348 static int store_write_pair(int fd
, const char *key
, const char *value
)
1351 int length
= strlen(key
+ store
.baselen
+ 1);
1352 const char *quote
= "";
1353 struct strbuf sb
= STRBUF_INIT
;
1356 * Check to see if the value needs to be surrounded with a dq pair.
1357 * Note that problematic characters are always backslash-quoted; this
1358 * check is about not losing leading or trailing SP and strings that
1359 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1360 * configuration parser.
1362 if (value
[0] == ' ')
1364 for (i
= 0; value
[i
]; i
++)
1365 if (value
[i
] == ';' || value
[i
] == '#')
1367 if (i
&& value
[i
- 1] == ' ')
1370 strbuf_addf(&sb
, "\t%.*s = %s",
1371 length
, key
+ store
.baselen
+ 1, quote
);
1373 for (i
= 0; value
[i
]; i
++)
1376 strbuf_addstr(&sb
, "\\n");
1379 strbuf_addstr(&sb
, "\\t");
1383 strbuf_addch(&sb
, '\\');
1385 strbuf_addch(&sb
, value
[i
]);
1388 strbuf_addf(&sb
, "%s\n", quote
);
1390 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1391 strbuf_release(&sb
);
1396 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1397 size_t offset_
, int *found_bracket
)
1399 size_t equal_offset
= size
, bracket_offset
= size
;
1403 for (offset
= offset_
-2; offset
> 0
1404 && contents
[offset
] != '\n'; offset
--)
1405 switch (contents
[offset
]) {
1406 case '=': equal_offset
= offset
; break;
1407 case ']': bracket_offset
= offset
; break;
1409 if (offset
> 0 && contents
[offset
-1] == '\\') {
1413 if (bracket_offset
< equal_offset
) {
1415 offset
= bracket_offset
+1;
1422 int git_config_set_in_file(const char *config_filename
,
1423 const char *key
, const char *value
)
1425 return git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1428 int git_config_set(const char *key
, const char *value
)
1430 return git_config_set_multivar(key
, value
, NULL
, 0);
1434 * Auxiliary function to sanity-check and split the key into the section
1435 * identifier and variable name.
1437 * Returns 0 on success, -1 when there is an invalid character in the key and
1438 * -2 if there is no section name in the key.
1440 * store_key - pointer to char* which will hold a copy of the key with
1441 * lowercase section and variable name
1442 * baselen - pointer to int which will hold the length of the
1443 * section + subsection part, can be NULL
1445 int git_config_parse_key(const char *key
, char **store_key
, int *baselen_
)
1447 int i
, dot
, baselen
;
1448 const char *last_dot
= strrchr(key
, '.');
1451 * Since "key" actually contains the section name and the real
1452 * key name separated by a dot, we have to know where the dot is.
1455 if (last_dot
== NULL
|| last_dot
== key
) {
1456 error("key does not contain a section: %s", key
);
1457 return -CONFIG_NO_SECTION_OR_NAME
;
1461 error("key does not contain variable name: %s", key
);
1462 return -CONFIG_NO_SECTION_OR_NAME
;
1465 baselen
= last_dot
- key
;
1467 *baselen_
= baselen
;
1470 * Validate the key and while at it, lower case it for matching.
1472 *store_key
= xmalloc(strlen(key
) + 1);
1475 for (i
= 0; key
[i
]; i
++) {
1476 unsigned char c
= key
[i
];
1479 /* Leave the extended basename untouched.. */
1480 if (!dot
|| i
> baselen
) {
1481 if (!iskeychar(c
) ||
1482 (i
== baselen
+ 1 && !isalpha(c
))) {
1483 error("invalid key: %s", key
);
1484 goto out_free_ret_1
;
1487 } else if (c
== '\n') {
1488 error("invalid key (newline): %s", key
);
1489 goto out_free_ret_1
;
1491 (*store_key
)[i
] = c
;
1493 (*store_key
)[i
] = 0;
1500 return -CONFIG_INVALID_KEY
;
1504 * If value==NULL, unset in (remove from) config,
1505 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1506 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1507 * else all matching key/values (regardless how many) are removed,
1508 * before the new pair is written.
1510 * Returns 0 on success.
1512 * This function does this:
1514 * - it locks the config file by creating ".git/config.lock"
1516 * - it then parses the config using store_aux() as validator to find
1517 * the position on the key/value pair to replace. If it is to be unset,
1518 * it must be found exactly once.
1520 * - the config file is mmap()ed and the part before the match (if any) is
1521 * written to the lock file, then the changed part and the rest.
1523 * - the config file is removed and the lock file rename()d to it.
1526 int git_config_set_multivar_in_file(const char *config_filename
,
1527 const char *key
, const char *value
,
1528 const char *value_regex
, int multi_replace
)
1532 struct lock_file
*lock
= NULL
;
1533 char *filename_buf
= NULL
;
1535 /* parse-key returns negative; flip the sign to feed exit(3) */
1536 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
1540 store
.multi_replace
= multi_replace
;
1542 if (!config_filename
)
1543 config_filename
= filename_buf
= git_pathdup("config");
1546 * The lock serves a purpose in addition to locking: the new
1547 * contents of .git/config will be written into it.
1549 lock
= xcalloc(sizeof(struct lock_file
), 1);
1550 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1552 error("could not lock config file %s: %s", config_filename
, strerror(errno
));
1554 ret
= CONFIG_NO_LOCK
;
1559 * If .git/config does not exist yet, write a minimal version.
1561 in_fd
= open(config_filename
, O_RDONLY
);
1565 if ( ENOENT
!= errno
) {
1566 error("opening %s: %s", config_filename
,
1568 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
1571 /* if nothing to unset, error out */
1572 if (value
== NULL
) {
1573 ret
= CONFIG_NOTHING_SET
;
1577 store
.key
= (char *)key
;
1578 if (!store_write_section(fd
, key
) ||
1579 !store_write_pair(fd
, key
, value
))
1584 size_t contents_sz
, copy_begin
, copy_end
;
1585 int i
, new_line
= 0;
1587 if (value_regex
== NULL
)
1588 store
.value_regex
= NULL
;
1590 if (value_regex
[0] == '!') {
1591 store
.do_not_match
= 1;
1594 store
.do_not_match
= 0;
1596 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
1597 if (regcomp(store
.value_regex
, value_regex
,
1599 error("invalid pattern: %s", value_regex
);
1600 free(store
.value_regex
);
1601 ret
= CONFIG_INVALID_PATTERN
;
1606 ALLOC_GROW(store
.offset
, 1, store
.offset_alloc
);
1607 store
.offset
[0] = 0;
1608 store
.state
= START
;
1612 * After this, store.offset will contain the *end* offset
1613 * of the last match, or remain at 0 if no match was found.
1614 * As a side effect, we make sure to transform only a valid
1615 * existing config file.
1617 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
1618 error("invalid config file %s", config_filename
);
1620 if (store
.value_regex
!= NULL
) {
1621 regfree(store
.value_regex
);
1622 free(store
.value_regex
);
1624 ret
= CONFIG_INVALID_FILE
;
1629 if (store
.value_regex
!= NULL
) {
1630 regfree(store
.value_regex
);
1631 free(store
.value_regex
);
1634 /* if nothing to unset, or too many matches, error out */
1635 if ((store
.seen
== 0 && value
== NULL
) ||
1636 (store
.seen
> 1 && multi_replace
== 0)) {
1637 ret
= CONFIG_NOTHING_SET
;
1642 contents_sz
= xsize_t(st
.st_size
);
1643 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
1644 MAP_PRIVATE
, in_fd
, 0);
1647 if (store
.seen
== 0)
1650 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
1651 if (store
.offset
[i
] == 0) {
1652 store
.offset
[i
] = copy_end
= contents_sz
;
1653 } else if (store
.state
!= KEY_SEEN
) {
1654 copy_end
= store
.offset
[i
];
1656 copy_end
= find_beginning_of_line(
1657 contents
, contents_sz
,
1658 store
.offset
[i
]-2, &new_line
);
1660 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
1663 /* write the first part of the config */
1664 if (copy_end
> copy_begin
) {
1665 if (write_in_full(fd
, contents
+ copy_begin
,
1666 copy_end
- copy_begin
) <
1667 copy_end
- copy_begin
)
1670 write_str_in_full(fd
, "\n") != 1)
1673 copy_begin
= store
.offset
[i
];
1676 /* write the pair (value == NULL means unset) */
1677 if (value
!= NULL
) {
1678 if (store
.state
== START
) {
1679 if (!store_write_section(fd
, key
))
1682 if (!store_write_pair(fd
, key
, value
))
1686 /* write the rest of the config */
1687 if (copy_begin
< contents_sz
)
1688 if (write_in_full(fd
, contents
+ copy_begin
,
1689 contents_sz
- copy_begin
) <
1690 contents_sz
- copy_begin
)
1693 munmap(contents
, contents_sz
);
1696 if (commit_lock_file(lock
) < 0) {
1697 error("could not commit config file %s", config_filename
);
1698 ret
= CONFIG_NO_WRITE
;
1703 * lock is committed, so don't try to roll it back below.
1704 * NOTE: Since lockfile.c keeps a linked list of all created
1705 * lock_file structures, it isn't safe to free(lock). It's
1706 * better to just leave it hanging around.
1713 rollback_lock_file(lock
);
1718 ret
= write_error(lock
->filename
);
1723 int git_config_set_multivar(const char *key
, const char *value
,
1724 const char *value_regex
, int multi_replace
)
1726 return git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
1730 static int section_name_match (const char *buf
, const char *name
)
1732 int i
= 0, j
= 0, dot
= 0;
1735 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
1736 if (!dot
&& isspace(buf
[i
])) {
1738 if (name
[j
++] != '.')
1740 for (i
++; isspace(buf
[i
]); i
++)
1746 if (buf
[i
] == '\\' && dot
)
1748 else if (buf
[i
] == '"' && dot
) {
1749 for (i
++; isspace(buf
[i
]); i
++)
1753 if (buf
[i
] != name
[j
++])
1756 if (buf
[i
] == ']' && name
[j
] == 0) {
1758 * We match, now just find the right length offset by
1759 * gobbling up any whitespace after it, as well
1762 for (; buf
[i
] && isspace(buf
[i
]); i
++)
1769 static int section_name_is_ok(const char *name
)
1771 /* Empty section names are bogus. */
1776 * Before a dot, we must be alphanumeric or dash. After the first dot,
1777 * anything goes, so we can stop checking.
1779 for (; *name
&& *name
!= '.'; name
++)
1780 if (*name
!= '-' && !isalnum(*name
))
1785 /* if new_name == NULL, the section is removed instead */
1786 int git_config_rename_section_in_file(const char *config_filename
,
1787 const char *old_name
, const char *new_name
)
1789 int ret
= 0, remove
= 0;
1790 char *filename_buf
= NULL
;
1791 struct lock_file
*lock
;
1796 if (new_name
&& !section_name_is_ok(new_name
)) {
1797 ret
= error("invalid section name: %s", new_name
);
1801 if (!config_filename
)
1802 config_filename
= filename_buf
= git_pathdup("config");
1804 lock
= xcalloc(sizeof(struct lock_file
), 1);
1805 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1807 ret
= error("could not lock config file %s", config_filename
);
1811 if (!(config_file
= fopen(config_filename
, "rb"))) {
1812 /* no config file means nothing to rename, no error */
1813 goto unlock_and_out
;
1816 while (fgets(buf
, sizeof(buf
), config_file
)) {
1820 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1822 if (buf
[i
] == '[') {
1823 /* it's a section */
1824 int offset
= section_name_match(&buf
[i
], old_name
);
1827 if (new_name
== NULL
) {
1831 store
.baselen
= strlen(new_name
);
1832 if (!store_write_section(out_fd
, new_name
)) {
1833 ret
= write_error(lock
->filename
);
1837 * We wrote out the new section, with
1838 * a newline, now skip the old
1841 output
+= offset
+ i
;
1842 if (strlen(output
) > 0) {
1844 * More content means there's
1845 * a declaration to put on the
1846 * next line; indent with a
1857 length
= strlen(output
);
1858 if (write_in_full(out_fd
, output
, length
) != length
) {
1859 ret
= write_error(lock
->filename
);
1863 fclose(config_file
);
1865 if (commit_lock_file(lock
) < 0)
1866 ret
= error("could not commit config file %s", config_filename
);
1872 int git_config_rename_section(const char *old_name
, const char *new_name
)
1874 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
1878 * Call this to report error for your variable that should not
1879 * get a boolean value (i.e. "[my] var" means "true").
1881 #undef config_error_nonbool
1882 int config_error_nonbool(const char *var
)
1884 return error("Missing value for '%s'", var
);
1887 int parse_config_key(const char *var
,
1888 const char *section
,
1889 const char **subsection
, int *subsection_len
,
1892 int section_len
= strlen(section
);
1895 /* Does it start with "section." ? */
1896 if (!starts_with(var
, section
) || var
[section_len
] != '.')
1900 * Find the key; we don't know yet if we have a subsection, but we must
1901 * parse backwards from the end, since the subsection may have dots in
1904 dot
= strrchr(var
, '.');
1907 /* Did we have a subsection at all? */
1908 if (dot
== var
+ section_len
) {
1910 *subsection_len
= 0;
1913 *subsection
= var
+ section_len
+ 1;
1914 *subsection_len
= dot
- *subsection
;