2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
15 typedef struct config_file
{
16 struct config_file
*prev
;
25 static config_file
*cf
;
27 static int zlib_compression_seen
;
29 #define MAX_INCLUDE_DEPTH 10
30 static const char include_depth_advice
[] =
31 "exceeded maximum include depth (%d) while including\n"
35 "Do you have circular includes?";
36 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
39 struct strbuf buf
= STRBUF_INIT
;
40 char *expanded
= expand_user_path(path
);
43 return error("Could not expand include path '%s'", path
);
47 * Use an absolute path as-is, but interpret relative paths
48 * based on the including config file.
50 if (!is_absolute_path(path
)) {
54 return error("relative config includes must come from files");
56 slash
= find_last_dir_sep(cf
->name
);
58 strbuf_add(&buf
, cf
->name
, slash
- cf
->name
+ 1);
59 strbuf_addstr(&buf
, path
);
63 if (!access(path
, R_OK
)) {
64 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
65 die(include_depth_advice
, MAX_INCLUDE_DEPTH
, path
,
66 cf
&& cf
->name
? cf
->name
: "the command line");
67 ret
= git_config_from_file(git_config_include
, path
, inc
);
75 int git_config_include(const char *var
, const char *value
, void *data
)
77 struct config_include_data
*inc
= data
;
82 * Pass along all values, including "include" directives; this makes it
83 * possible to query information on the includes themselves.
85 ret
= inc
->fn(var
, value
, inc
->data
);
89 type
= skip_prefix(var
, "include.");
93 if (!strcmp(type
, "path"))
94 ret
= handle_path_include(value
, inc
);
98 static void lowercase(char *p
)
104 void git_config_push_parameter(const char *text
)
106 struct strbuf env
= STRBUF_INIT
;
107 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
109 strbuf_addstr(&env
, old
);
110 strbuf_addch(&env
, ' ');
112 sq_quote_buf(&env
, text
);
113 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
114 strbuf_release(&env
);
117 int git_config_parse_parameter(const char *text
,
118 config_fn_t fn
, void *data
)
120 struct strbuf
**pair
;
121 pair
= strbuf_split_str(text
, '=', 2);
123 return error("bogus config parameter: %s", text
);
124 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=')
125 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
126 strbuf_trim(pair
[0]);
128 strbuf_list_free(pair
);
129 return error("bogus config parameter: %s", text
);
131 lowercase(pair
[0]->buf
);
132 if (fn(pair
[0]->buf
, pair
[1] ? pair
[1]->buf
: NULL
, data
) < 0) {
133 strbuf_list_free(pair
);
136 strbuf_list_free(pair
);
140 int git_config_from_parameters(config_fn_t fn
, void *data
)
142 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
144 const char **argv
= NULL
;
145 int nr
= 0, alloc
= 0;
150 /* sq_dequote will write over it */
153 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
155 return error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
158 for (i
= 0; i
< nr
; i
++) {
159 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
171 static int get_next_char(void)
177 if (cf
&& ((f
= cf
->f
) != NULL
)) {
180 /* DOS like systems */
197 static char *parse_value(void)
199 int quote
= 0, comment
= 0, space
= 0;
201 strbuf_reset(&cf
->value
);
203 int c
= get_next_char();
209 return cf
->value
.buf
;
213 if (isspace(c
) && !quote
) {
219 if (c
== ';' || c
== '#') {
224 for (; space
; space
--)
225 strbuf_addch(&cf
->value
, ' ');
240 /* Some characters escape as themselves */
243 /* Reject unknown escape sequences */
247 strbuf_addch(&cf
->value
, c
);
254 strbuf_addch(&cf
->value
, c
);
258 static inline int iskeychar(int c
)
260 return isalnum(c
) || c
== '-';
263 static int get_value(config_fn_t fn
, void *data
, char *name
, unsigned int len
)
268 /* Get the full name */
275 name
[len
++] = tolower(c
);
280 while (c
== ' ' || c
== '\t')
287 value
= parse_value();
291 return fn(name
, value
, data
);
294 static int get_extended_base_var(char *name
, int baselen
, int c
)
298 goto error_incomplete_line
;
300 } while (isspace(c
));
302 /* We require the format to be '[base "extension"]' */
305 name
[baselen
++] = '.';
308 int c
= get_next_char();
310 goto error_incomplete_line
;
316 goto error_incomplete_line
;
319 if (baselen
> MAXNAME
/ 2)
324 if (get_next_char() != ']')
327 error_incomplete_line
:
332 static int get_base_var(char *name
)
337 int c
= get_next_char();
343 return get_extended_base_var(name
, baselen
, c
);
344 if (!iskeychar(c
) && c
!= '.')
346 if (baselen
> MAXNAME
/ 2)
348 name
[baselen
++] = tolower(c
);
352 static int git_parse_file(config_fn_t fn
, void *data
)
358 /* U+FEFF Byte Order Mark in UTF8 */
359 static const unsigned char *utf8_bom
= (unsigned char *) "\xef\xbb\xbf";
360 const unsigned char *bomptr
= utf8_bom
;
363 int c
= get_next_char();
364 if (bomptr
&& *bomptr
) {
365 /* We are at the file beginning; skip UTF8-encoded BOM
366 * if present. Sane editors won't put this in on their
367 * own, but e.g. Windows Notepad will do it happily. */
368 if ((unsigned char) c
== *bomptr
) {
372 /* Do not tolerate partial BOM. */
373 if (bomptr
!= utf8_bom
)
375 /* No BOM at file beginning. Cool. */
385 if (comment
|| isspace(c
))
387 if (c
== '#' || c
== ';') {
392 baselen
= get_base_var(var
);
395 var
[baselen
++] = '.';
401 var
[baselen
] = tolower(c
);
402 if (get_value(fn
, data
, var
, baselen
+1) < 0)
405 die("bad config file line %d in %s", cf
->linenr
, cf
->name
);
408 static int parse_unit_factor(const char *end
, uintmax_t *val
)
412 else if (!strcasecmp(end
, "k")) {
416 else if (!strcasecmp(end
, "m")) {
420 else if (!strcasecmp(end
, "g")) {
421 *val
*= 1024 * 1024 * 1024;
427 static int git_parse_long(const char *value
, long *ret
)
429 if (value
&& *value
) {
433 uintmax_t factor
= 1;
436 val
= strtoimax(value
, &end
, 0);
439 if (!parse_unit_factor(end
, &factor
))
443 if ((uval
> maximum_signed_value_of_type(long)) ||
453 int git_parse_ulong(const char *value
, unsigned long *ret
)
455 if (value
&& *value
) {
461 val
= strtoumax(value
, &end
, 0);
465 if (!parse_unit_factor(end
, &val
))
467 if ((val
> maximum_unsigned_value_of_type(long)) ||
476 static void die_bad_config(const char *name
)
479 die("bad config value for '%s' in %s", name
, cf
->name
);
480 die("bad config value for '%s'", name
);
483 int git_config_int(const char *name
, const char *value
)
486 if (!git_parse_long(value
, &ret
))
487 die_bad_config(name
);
491 unsigned long git_config_ulong(const char *name
, const char *value
)
494 if (!git_parse_ulong(value
, &ret
))
495 die_bad_config(name
);
499 static int git_config_maybe_bool_text(const char *name
, const char *value
)
505 if (!strcasecmp(value
, "true")
506 || !strcasecmp(value
, "yes")
507 || !strcasecmp(value
, "on"))
509 if (!strcasecmp(value
, "false")
510 || !strcasecmp(value
, "no")
511 || !strcasecmp(value
, "off"))
516 int git_config_maybe_bool(const char *name
, const char *value
)
518 long v
= git_config_maybe_bool_text(name
, value
);
521 if (git_parse_long(value
, &v
))
526 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
528 int v
= git_config_maybe_bool_text(name
, value
);
534 return git_config_int(name
, value
);
537 int git_config_bool(const char *name
, const char *value
)
540 return !!git_config_bool_or_int(name
, value
, &discard
);
543 int git_config_string(const char **dest
, const char *var
, const char *value
)
546 return config_error_nonbool(var
);
547 *dest
= xstrdup(value
);
551 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
554 return config_error_nonbool(var
);
555 *dest
= expand_user_path(value
);
557 die("Failed to expand user dir in: '%s'", value
);
561 static int git_default_core_config(const char *var
, const char *value
)
563 /* This needs a better name */
564 if (!strcmp(var
, "core.filemode")) {
565 trust_executable_bit
= git_config_bool(var
, value
);
568 if (!strcmp(var
, "core.trustctime")) {
569 trust_ctime
= git_config_bool(var
, value
);
573 if (!strcmp(var
, "core.quotepath")) {
574 quote_path_fully
= git_config_bool(var
, value
);
578 if (!strcmp(var
, "core.symlinks")) {
579 has_symlinks
= git_config_bool(var
, value
);
583 if (!strcmp(var
, "core.ignorecase")) {
584 ignore_case
= git_config_bool(var
, value
);
588 if (!strcmp(var
, "core.attributesfile"))
589 return git_config_pathname(&git_attributes_file
, var
, value
);
591 if (!strcmp(var
, "core.bare")) {
592 is_bare_repository_cfg
= git_config_bool(var
, value
);
596 if (!strcmp(var
, "core.ignorestat")) {
597 assume_unchanged
= git_config_bool(var
, value
);
601 if (!strcmp(var
, "core.prefersymlinkrefs")) {
602 prefer_symlink_refs
= git_config_bool(var
, value
);
606 if (!strcmp(var
, "core.logallrefupdates")) {
607 log_all_ref_updates
= git_config_bool(var
, value
);
611 if (!strcmp(var
, "core.warnambiguousrefs")) {
612 warn_ambiguous_refs
= git_config_bool(var
, value
);
616 if (!strcmp(var
, "core.abbrev")) {
617 int abbrev
= git_config_int(var
, value
);
618 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
620 default_abbrev
= abbrev
;
624 if (!strcmp(var
, "core.loosecompression")) {
625 int level
= git_config_int(var
, value
);
627 level
= Z_DEFAULT_COMPRESSION
;
628 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
629 die("bad zlib compression level %d", level
);
630 zlib_compression_level
= level
;
631 zlib_compression_seen
= 1;
635 if (!strcmp(var
, "core.compression")) {
636 int level
= git_config_int(var
, value
);
638 level
= Z_DEFAULT_COMPRESSION
;
639 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
640 die("bad zlib compression level %d", level
);
641 core_compression_level
= level
;
642 core_compression_seen
= 1;
643 if (!zlib_compression_seen
)
644 zlib_compression_level
= level
;
648 if (!strcmp(var
, "core.packedgitwindowsize")) {
649 int pgsz_x2
= getpagesize() * 2;
650 packed_git_window_size
= git_config_ulong(var
, value
);
652 /* This value must be multiple of (pagesize * 2) */
653 packed_git_window_size
/= pgsz_x2
;
654 if (packed_git_window_size
< 1)
655 packed_git_window_size
= 1;
656 packed_git_window_size
*= pgsz_x2
;
660 if (!strcmp(var
, "core.bigfilethreshold")) {
661 big_file_threshold
= git_config_ulong(var
, value
);
665 if (!strcmp(var
, "core.packedgitlimit")) {
666 packed_git_limit
= git_config_ulong(var
, value
);
670 if (!strcmp(var
, "core.deltabasecachelimit")) {
671 delta_base_cache_limit
= git_config_ulong(var
, value
);
675 if (!strcmp(var
, "core.logpackaccess"))
676 return git_config_string(&log_pack_access
, var
, value
);
678 if (!strcmp(var
, "core.autocrlf")) {
679 if (value
&& !strcasecmp(value
, "input")) {
680 if (core_eol
== EOL_CRLF
)
681 return error("core.autocrlf=input conflicts with core.eol=crlf");
682 auto_crlf
= AUTO_CRLF_INPUT
;
685 auto_crlf
= git_config_bool(var
, value
);
689 if (!strcmp(var
, "core.safecrlf")) {
690 if (value
&& !strcasecmp(value
, "warn")) {
691 safe_crlf
= SAFE_CRLF_WARN
;
694 safe_crlf
= git_config_bool(var
, value
);
698 if (!strcmp(var
, "core.eol")) {
699 if (value
&& !strcasecmp(value
, "lf"))
701 else if (value
&& !strcasecmp(value
, "crlf"))
703 else if (value
&& !strcasecmp(value
, "native"))
704 core_eol
= EOL_NATIVE
;
706 core_eol
= EOL_UNSET
;
707 if (core_eol
== EOL_CRLF
&& auto_crlf
== AUTO_CRLF_INPUT
)
708 return error("core.autocrlf=input conflicts with core.eol=crlf");
712 if (!strcmp(var
, "core.notesref")) {
713 notes_ref_name
= xstrdup(value
);
717 if (!strcmp(var
, "core.pager"))
718 return git_config_string(&pager_program
, var
, value
);
720 if (!strcmp(var
, "core.editor"))
721 return git_config_string(&editor_program
, var
, value
);
723 if (!strcmp(var
, "core.askpass"))
724 return git_config_string(&askpass_program
, var
, value
);
726 if (!strcmp(var
, "core.excludesfile"))
727 return git_config_pathname(&excludes_file
, var
, value
);
729 if (!strcmp(var
, "core.whitespace")) {
731 return config_error_nonbool(var
);
732 whitespace_rule_cfg
= parse_whitespace_rule(value
);
736 if (!strcmp(var
, "core.fsyncobjectfiles")) {
737 fsync_object_files
= git_config_bool(var
, value
);
741 if (!strcmp(var
, "core.preloadindex")) {
742 core_preload_index
= git_config_bool(var
, value
);
746 if (!strcmp(var
, "core.createobject")) {
747 if (!strcmp(value
, "rename"))
748 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
749 else if (!strcmp(value
, "link"))
750 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
752 die("Invalid mode for object creation: %s", value
);
756 if (!strcmp(var
, "core.sparsecheckout")) {
757 core_apply_sparse_checkout
= git_config_bool(var
, value
);
761 /* Add other config variables here and to Documentation/config.txt. */
765 static int git_default_i18n_config(const char *var
, const char *value
)
767 if (!strcmp(var
, "i18n.commitencoding"))
768 return git_config_string(&git_commit_encoding
, var
, value
);
770 if (!strcmp(var
, "i18n.logoutputencoding"))
771 return git_config_string(&git_log_output_encoding
, var
, value
);
773 /* Add other config variables here and to Documentation/config.txt. */
777 static int git_default_branch_config(const char *var
, const char *value
)
779 if (!strcmp(var
, "branch.autosetupmerge")) {
780 if (value
&& !strcasecmp(value
, "always")) {
781 git_branch_track
= BRANCH_TRACK_ALWAYS
;
784 git_branch_track
= git_config_bool(var
, value
);
787 if (!strcmp(var
, "branch.autosetuprebase")) {
789 return config_error_nonbool(var
);
790 else if (!strcmp(value
, "never"))
791 autorebase
= AUTOREBASE_NEVER
;
792 else if (!strcmp(value
, "local"))
793 autorebase
= AUTOREBASE_LOCAL
;
794 else if (!strcmp(value
, "remote"))
795 autorebase
= AUTOREBASE_REMOTE
;
796 else if (!strcmp(value
, "always"))
797 autorebase
= AUTOREBASE_ALWAYS
;
799 return error("Malformed value for %s", var
);
803 /* Add other config variables here and to Documentation/config.txt. */
807 static int git_default_push_config(const char *var
, const char *value
)
809 if (!strcmp(var
, "push.default")) {
811 return config_error_nonbool(var
);
812 else if (!strcmp(value
, "nothing"))
813 push_default
= PUSH_DEFAULT_NOTHING
;
814 else if (!strcmp(value
, "matching"))
815 push_default
= PUSH_DEFAULT_MATCHING
;
816 else if (!strcmp(value
, "simple"))
817 push_default
= PUSH_DEFAULT_SIMPLE
;
818 else if (!strcmp(value
, "upstream"))
819 push_default
= PUSH_DEFAULT_UPSTREAM
;
820 else if (!strcmp(value
, "tracking")) /* deprecated */
821 push_default
= PUSH_DEFAULT_UPSTREAM
;
822 else if (!strcmp(value
, "current"))
823 push_default
= PUSH_DEFAULT_CURRENT
;
825 error("Malformed value for %s: %s", var
, value
);
826 return error("Must be one of nothing, matching, simple, "
827 "upstream or current.");
832 /* Add other config variables here and to Documentation/config.txt. */
836 static int git_default_mailmap_config(const char *var
, const char *value
)
838 if (!strcmp(var
, "mailmap.file"))
839 return git_config_string(&git_mailmap_file
, var
, value
);
841 /* Add other config variables here and to Documentation/config.txt. */
845 int git_default_config(const char *var
, const char *value
, void *dummy
)
847 if (!prefixcmp(var
, "core."))
848 return git_default_core_config(var
, value
);
850 if (!prefixcmp(var
, "user."))
851 return git_ident_config(var
, value
, dummy
);
853 if (!prefixcmp(var
, "i18n."))
854 return git_default_i18n_config(var
, value
);
856 if (!prefixcmp(var
, "branch."))
857 return git_default_branch_config(var
, value
);
859 if (!prefixcmp(var
, "push."))
860 return git_default_push_config(var
, value
);
862 if (!prefixcmp(var
, "mailmap."))
863 return git_default_mailmap_config(var
, value
);
865 if (!prefixcmp(var
, "advice."))
866 return git_default_advice_config(var
, value
);
868 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
869 pager_use_color
= git_config_bool(var
,value
);
873 if (!strcmp(var
, "pack.packsizelimit")) {
874 pack_size_limit_cfg
= git_config_ulong(var
, value
);
877 /* Add other config variables here and to Documentation/config.txt. */
881 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
884 FILE *f
= fopen(filename
, "r");
890 /* push config-file parsing state stack */
896 strbuf_init(&top
.value
, 1024);
899 ret
= git_parse_file(fn
, data
);
901 /* pop config-file parsing state stack */
902 strbuf_release(&top
.value
);
910 const char *git_etc_gitconfig(void)
912 static const char *system_wide
;
914 system_wide
= system_path(ETC_GITCONFIG
);
918 int git_env_bool(const char *k
, int def
)
920 const char *v
= getenv(k
);
921 return v
? git_config_bool(k
, v
) : def
;
924 int git_config_system(void)
926 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
929 int git_config_early(config_fn_t fn
, void *data
, const char *repo_config
)
931 int ret
= 0, found
= 0;
932 char *xdg_config
= NULL
;
933 char *user_config
= NULL
;
935 home_config_paths(&user_config
, &xdg_config
, "config");
937 if (git_config_system() && !access(git_etc_gitconfig(), R_OK
)) {
938 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
943 if (!access(xdg_config
, R_OK
)) {
944 ret
+= git_config_from_file(fn
, xdg_config
, data
);
948 if (!access(user_config
, R_OK
)) {
949 ret
+= git_config_from_file(fn
, user_config
, data
);
953 if (repo_config
&& !access(repo_config
, R_OK
)) {
954 ret
+= git_config_from_file(fn
, repo_config
, data
);
958 switch (git_config_from_parameters(fn
, data
)) {
960 die("unable to parse command-line config");
962 case 0: /* found nothing */
964 default: /* found at least one item */
971 return ret
== 0 ? found
: ret
;
974 int git_config_with_options(config_fn_t fn
, void *data
,
975 const char *filename
, int respect_includes
)
977 char *repo_config
= NULL
;
979 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
981 if (respect_includes
) {
984 fn
= git_config_include
;
989 * If we have a specific filename, use it. Otherwise, follow the
990 * regular lookup sequence.
993 return git_config_from_file(fn
, filename
, data
);
995 repo_config
= git_pathdup("config");
996 ret
= git_config_early(fn
, data
, repo_config
);
1002 int git_config(config_fn_t fn
, void *data
)
1004 return git_config_with_options(fn
, data
, NULL
, 1);
1008 * Find all the stuff for git_config_set() below.
1011 #define MAX_MATCHES 512
1017 regex_t
*value_regex
;
1019 size_t offset
[MAX_MATCHES
];
1020 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1024 static int matches(const char *key
, const char *value
)
1026 return !strcmp(key
, store
.key
) &&
1027 (store
.value_regex
== NULL
||
1028 (store
.do_not_match
^
1029 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
1032 static int store_aux(const char *key
, const char *value
, void *cb
)
1038 switch (store
.state
) {
1040 if (matches(key
, value
)) {
1041 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1042 warning("%s has multiple values", key
);
1043 } else if (store
.seen
>= MAX_MATCHES
) {
1044 error("too many matches for %s", key
);
1048 store
.offset
[store
.seen
] = ftell(f
);
1054 * What we are looking for is in store.key (both
1055 * section and var), and its section part is baselen
1056 * long. We found key (again, both section and var).
1057 * We would want to know if this key is in the same
1058 * section as what we are looking for. We already
1059 * know we are in the same section as what should
1062 ep
= strrchr(key
, '.');
1063 section_len
= ep
- key
;
1065 if ((section_len
!= store
.baselen
) ||
1066 memcmp(key
, store
.key
, section_len
+1)) {
1067 store
.state
= SECTION_END_SEEN
;
1072 * Do not increment matches: this is no match, but we
1073 * just made sure we are in the desired section.
1075 store
.offset
[store
.seen
] = ftell(f
);
1077 case SECTION_END_SEEN
:
1079 if (matches(key
, value
)) {
1080 store
.offset
[store
.seen
] = ftell(f
);
1081 store
.state
= KEY_SEEN
;
1084 if (strrchr(key
, '.') - key
== store
.baselen
&&
1085 !strncmp(key
, store
.key
, store
.baselen
)) {
1086 store
.state
= SECTION_SEEN
;
1087 store
.offset
[store
.seen
] = ftell(f
);
1094 static int write_error(const char *filename
)
1096 error("failed to write new configuration file %s", filename
);
1098 /* Same error code as "failed to rename". */
1102 static int store_write_section(int fd
, const char *key
)
1106 struct strbuf sb
= STRBUF_INIT
;
1108 dot
= memchr(key
, '.', store
.baselen
);
1110 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1111 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1112 if (key
[i
] == '"' || key
[i
] == '\\')
1113 strbuf_addch(&sb
, '\\');
1114 strbuf_addch(&sb
, key
[i
]);
1116 strbuf_addstr(&sb
, "\"]\n");
1118 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1121 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1122 strbuf_release(&sb
);
1127 static int store_write_pair(int fd
, const char *key
, const char *value
)
1130 int length
= strlen(key
+ store
.baselen
+ 1);
1131 const char *quote
= "";
1132 struct strbuf sb
= STRBUF_INIT
;
1135 * Check to see if the value needs to be surrounded with a dq pair.
1136 * Note that problematic characters are always backslash-quoted; this
1137 * check is about not losing leading or trailing SP and strings that
1138 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1139 * configuration parser.
1141 if (value
[0] == ' ')
1143 for (i
= 0; value
[i
]; i
++)
1144 if (value
[i
] == ';' || value
[i
] == '#')
1146 if (i
&& value
[i
- 1] == ' ')
1149 strbuf_addf(&sb
, "\t%.*s = %s",
1150 length
, key
+ store
.baselen
+ 1, quote
);
1152 for (i
= 0; value
[i
]; i
++)
1155 strbuf_addstr(&sb
, "\\n");
1158 strbuf_addstr(&sb
, "\\t");
1162 strbuf_addch(&sb
, '\\');
1164 strbuf_addch(&sb
, value
[i
]);
1167 strbuf_addf(&sb
, "%s\n", quote
);
1169 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1170 strbuf_release(&sb
);
1175 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1176 size_t offset_
, int *found_bracket
)
1178 size_t equal_offset
= size
, bracket_offset
= size
;
1182 for (offset
= offset_
-2; offset
> 0
1183 && contents
[offset
] != '\n'; offset
--)
1184 switch (contents
[offset
]) {
1185 case '=': equal_offset
= offset
; break;
1186 case ']': bracket_offset
= offset
; break;
1188 if (offset
> 0 && contents
[offset
-1] == '\\') {
1192 if (bracket_offset
< equal_offset
) {
1194 offset
= bracket_offset
+1;
1201 int git_config_set_in_file(const char *config_filename
,
1202 const char *key
, const char *value
)
1204 return git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1207 int git_config_set(const char *key
, const char *value
)
1209 return git_config_set_multivar(key
, value
, NULL
, 0);
1213 * Auxiliary function to sanity-check and split the key into the section
1214 * identifier and variable name.
1216 * Returns 0 on success, -1 when there is an invalid character in the key and
1217 * -2 if there is no section name in the key.
1219 * store_key - pointer to char* which will hold a copy of the key with
1220 * lowercase section and variable name
1221 * baselen - pointer to int which will hold the length of the
1222 * section + subsection part, can be NULL
1224 int git_config_parse_key(const char *key
, char **store_key
, int *baselen_
)
1226 int i
, dot
, baselen
;
1227 const char *last_dot
= strrchr(key
, '.');
1230 * Since "key" actually contains the section name and the real
1231 * key name separated by a dot, we have to know where the dot is.
1234 if (last_dot
== NULL
|| last_dot
== key
) {
1235 error("key does not contain a section: %s", key
);
1236 return -CONFIG_NO_SECTION_OR_NAME
;
1240 error("key does not contain variable name: %s", key
);
1241 return -CONFIG_NO_SECTION_OR_NAME
;
1244 baselen
= last_dot
- key
;
1246 *baselen_
= baselen
;
1249 * Validate the key and while at it, lower case it for matching.
1251 *store_key
= xmalloc(strlen(key
) + 1);
1254 for (i
= 0; key
[i
]; i
++) {
1255 unsigned char c
= key
[i
];
1258 /* Leave the extended basename untouched.. */
1259 if (!dot
|| i
> baselen
) {
1260 if (!iskeychar(c
) ||
1261 (i
== baselen
+ 1 && !isalpha(c
))) {
1262 error("invalid key: %s", key
);
1263 goto out_free_ret_1
;
1266 } else if (c
== '\n') {
1267 error("invalid key (newline): %s", key
);
1268 goto out_free_ret_1
;
1270 (*store_key
)[i
] = c
;
1272 (*store_key
)[i
] = 0;
1278 return -CONFIG_INVALID_KEY
;
1282 * If value==NULL, unset in (remove from) config,
1283 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1284 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1285 * else all matching key/values (regardless how many) are removed,
1286 * before the new pair is written.
1288 * Returns 0 on success.
1290 * This function does this:
1292 * - it locks the config file by creating ".git/config.lock"
1294 * - it then parses the config using store_aux() as validator to find
1295 * the position on the key/value pair to replace. If it is to be unset,
1296 * it must be found exactly once.
1298 * - the config file is mmap()ed and the part before the match (if any) is
1299 * written to the lock file, then the changed part and the rest.
1301 * - the config file is removed and the lock file rename()d to it.
1304 int git_config_set_multivar_in_file(const char *config_filename
,
1305 const char *key
, const char *value
,
1306 const char *value_regex
, int multi_replace
)
1310 struct lock_file
*lock
= NULL
;
1311 char *filename_buf
= NULL
;
1313 /* parse-key returns negative; flip the sign to feed exit(3) */
1314 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
1318 store
.multi_replace
= multi_replace
;
1320 if (!config_filename
)
1321 config_filename
= filename_buf
= git_pathdup("config");
1324 * The lock serves a purpose in addition to locking: the new
1325 * contents of .git/config will be written into it.
1327 lock
= xcalloc(sizeof(struct lock_file
), 1);
1328 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1330 error("could not lock config file %s: %s", config_filename
, strerror(errno
));
1332 ret
= CONFIG_NO_LOCK
;
1337 * If .git/config does not exist yet, write a minimal version.
1339 in_fd
= open(config_filename
, O_RDONLY
);
1343 if ( ENOENT
!= errno
) {
1344 error("opening %s: %s", config_filename
,
1346 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
1349 /* if nothing to unset, error out */
1350 if (value
== NULL
) {
1351 ret
= CONFIG_NOTHING_SET
;
1355 store
.key
= (char *)key
;
1356 if (!store_write_section(fd
, key
) ||
1357 !store_write_pair(fd
, key
, value
))
1362 size_t contents_sz
, copy_begin
, copy_end
;
1363 int i
, new_line
= 0;
1365 if (value_regex
== NULL
)
1366 store
.value_regex
= NULL
;
1368 if (value_regex
[0] == '!') {
1369 store
.do_not_match
= 1;
1372 store
.do_not_match
= 0;
1374 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
1375 if (regcomp(store
.value_regex
, value_regex
,
1377 error("invalid pattern: %s", value_regex
);
1378 free(store
.value_regex
);
1379 ret
= CONFIG_INVALID_PATTERN
;
1384 store
.offset
[0] = 0;
1385 store
.state
= START
;
1389 * After this, store.offset will contain the *end* offset
1390 * of the last match, or remain at 0 if no match was found.
1391 * As a side effect, we make sure to transform only a valid
1392 * existing config file.
1394 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
1395 error("invalid config file %s", config_filename
);
1397 if (store
.value_regex
!= NULL
) {
1398 regfree(store
.value_regex
);
1399 free(store
.value_regex
);
1401 ret
= CONFIG_INVALID_FILE
;
1406 if (store
.value_regex
!= NULL
) {
1407 regfree(store
.value_regex
);
1408 free(store
.value_regex
);
1411 /* if nothing to unset, or too many matches, error out */
1412 if ((store
.seen
== 0 && value
== NULL
) ||
1413 (store
.seen
> 1 && multi_replace
== 0)) {
1414 ret
= CONFIG_NOTHING_SET
;
1419 contents_sz
= xsize_t(st
.st_size
);
1420 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
1421 MAP_PRIVATE
, in_fd
, 0);
1424 if (store
.seen
== 0)
1427 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
1428 if (store
.offset
[i
] == 0) {
1429 store
.offset
[i
] = copy_end
= contents_sz
;
1430 } else if (store
.state
!= KEY_SEEN
) {
1431 copy_end
= store
.offset
[i
];
1433 copy_end
= find_beginning_of_line(
1434 contents
, contents_sz
,
1435 store
.offset
[i
]-2, &new_line
);
1437 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
1440 /* write the first part of the config */
1441 if (copy_end
> copy_begin
) {
1442 if (write_in_full(fd
, contents
+ copy_begin
,
1443 copy_end
- copy_begin
) <
1444 copy_end
- copy_begin
)
1447 write_str_in_full(fd
, "\n") != 1)
1450 copy_begin
= store
.offset
[i
];
1453 /* write the pair (value == NULL means unset) */
1454 if (value
!= NULL
) {
1455 if (store
.state
== START
) {
1456 if (!store_write_section(fd
, key
))
1459 if (!store_write_pair(fd
, key
, value
))
1463 /* write the rest of the config */
1464 if (copy_begin
< contents_sz
)
1465 if (write_in_full(fd
, contents
+ copy_begin
,
1466 contents_sz
- copy_begin
) <
1467 contents_sz
- copy_begin
)
1470 munmap(contents
, contents_sz
);
1473 if (commit_lock_file(lock
) < 0) {
1474 error("could not commit config file %s", config_filename
);
1475 ret
= CONFIG_NO_WRITE
;
1480 * lock is committed, so don't try to roll it back below.
1481 * NOTE: Since lockfile.c keeps a linked list of all created
1482 * lock_file structures, it isn't safe to free(lock). It's
1483 * better to just leave it hanging around.
1490 rollback_lock_file(lock
);
1495 ret
= write_error(lock
->filename
);
1500 int git_config_set_multivar(const char *key
, const char *value
,
1501 const char *value_regex
, int multi_replace
)
1503 return git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
1507 static int section_name_match (const char *buf
, const char *name
)
1509 int i
= 0, j
= 0, dot
= 0;
1512 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
1513 if (!dot
&& isspace(buf
[i
])) {
1515 if (name
[j
++] != '.')
1517 for (i
++; isspace(buf
[i
]); i
++)
1523 if (buf
[i
] == '\\' && dot
)
1525 else if (buf
[i
] == '"' && dot
) {
1526 for (i
++; isspace(buf
[i
]); i
++)
1530 if (buf
[i
] != name
[j
++])
1533 if (buf
[i
] == ']' && name
[j
] == 0) {
1535 * We match, now just find the right length offset by
1536 * gobbling up any whitespace after it, as well
1539 for (; buf
[i
] && isspace(buf
[i
]); i
++)
1546 static int section_name_is_ok(const char *name
)
1548 /* Empty section names are bogus. */
1553 * Before a dot, we must be alphanumeric or dash. After the first dot,
1554 * anything goes, so we can stop checking.
1556 for (; *name
&& *name
!= '.'; name
++)
1557 if (*name
!= '-' && !isalnum(*name
))
1562 /* if new_name == NULL, the section is removed instead */
1563 int git_config_rename_section_in_file(const char *config_filename
,
1564 const char *old_name
, const char *new_name
)
1566 int ret
= 0, remove
= 0;
1567 char *filename_buf
= NULL
;
1568 struct lock_file
*lock
;
1573 if (new_name
&& !section_name_is_ok(new_name
)) {
1574 ret
= error("invalid section name: %s", new_name
);
1578 if (!config_filename
)
1579 config_filename
= filename_buf
= git_pathdup("config");
1581 lock
= xcalloc(sizeof(struct lock_file
), 1);
1582 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1584 ret
= error("could not lock config file %s", config_filename
);
1588 if (!(config_file
= fopen(config_filename
, "rb"))) {
1589 /* no config file means nothing to rename, no error */
1590 goto unlock_and_out
;
1593 while (fgets(buf
, sizeof(buf
), config_file
)) {
1597 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1599 if (buf
[i
] == '[') {
1600 /* it's a section */
1601 int offset
= section_name_match(&buf
[i
], old_name
);
1604 if (new_name
== NULL
) {
1608 store
.baselen
= strlen(new_name
);
1609 if (!store_write_section(out_fd
, new_name
)) {
1610 ret
= write_error(lock
->filename
);
1614 * We wrote out the new section, with
1615 * a newline, now skip the old
1618 output
+= offset
+ i
;
1619 if (strlen(output
) > 0) {
1621 * More content means there's
1622 * a declaration to put on the
1623 * next line; indent with a
1634 length
= strlen(output
);
1635 if (write_in_full(out_fd
, output
, length
) != length
) {
1636 ret
= write_error(lock
->filename
);
1640 fclose(config_file
);
1642 if (commit_lock_file(lock
) < 0)
1643 ret
= error("could not commit config file %s", config_filename
);
1649 int git_config_rename_section(const char *old_name
, const char *new_name
)
1651 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
1655 * Call this to report error for your variable that should not
1656 * get a boolean value (i.e. "[my] var" means "true").
1658 int config_error_nonbool(const char *var
)
1660 return error("Missing value for '%s'", var
);