2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
13 typedef struct config_file
{
14 struct config_file
*prev
;
23 static config_file
*cf
;
25 static int zlib_compression_seen
;
27 #define MAX_INCLUDE_DEPTH 10
28 static const char include_depth_advice
[] =
29 "exceeded maximum include depth (%d) while including\n"
33 "Do you have circular includes?";
34 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
37 struct strbuf buf
= STRBUF_INIT
;
38 char *expanded
= expand_user_path(path
);
41 return error("Could not expand include path '%s'", path
);
45 * Use an absolute path as-is, but interpret relative paths
46 * based on the including config file.
48 if (!is_absolute_path(path
)) {
52 return error("relative config includes must come from files");
54 slash
= find_last_dir_sep(cf
->name
);
56 strbuf_add(&buf
, cf
->name
, slash
- cf
->name
+ 1);
57 strbuf_addstr(&buf
, path
);
61 if (!access_or_die(path
, R_OK
)) {
62 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
63 die(include_depth_advice
, MAX_INCLUDE_DEPTH
, path
,
64 cf
&& cf
->name
? cf
->name
: "the command line");
65 ret
= git_config_from_file(git_config_include
, path
, inc
);
73 int git_config_include(const char *var
, const char *value
, void *data
)
75 struct config_include_data
*inc
= data
;
80 * Pass along all values, including "include" directives; this makes it
81 * possible to query information on the includes themselves.
83 ret
= inc
->fn(var
, value
, inc
->data
);
87 type
= skip_prefix(var
, "include.");
91 if (!strcmp(type
, "path"))
92 ret
= handle_path_include(value
, inc
);
96 static void lowercase(char *p
)
102 void git_config_push_parameter(const char *text
)
104 struct strbuf env
= STRBUF_INIT
;
105 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
107 strbuf_addstr(&env
, old
);
108 strbuf_addch(&env
, ' ');
110 sq_quote_buf(&env
, text
);
111 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
112 strbuf_release(&env
);
115 int git_config_parse_parameter(const char *text
,
116 config_fn_t fn
, void *data
)
118 struct strbuf
**pair
;
119 pair
= strbuf_split_str(text
, '=', 2);
121 return error("bogus config parameter: %s", text
);
122 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=')
123 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
124 strbuf_trim(pair
[0]);
126 strbuf_list_free(pair
);
127 return error("bogus config parameter: %s", text
);
129 lowercase(pair
[0]->buf
);
130 if (fn(pair
[0]->buf
, pair
[1] ? pair
[1]->buf
: NULL
, data
) < 0) {
131 strbuf_list_free(pair
);
134 strbuf_list_free(pair
);
138 int git_config_from_parameters(config_fn_t fn
, void *data
)
140 const char *env
= getenv(CONFIG_DATA_ENVIRONMENT
);
142 const char **argv
= NULL
;
143 int nr
= 0, alloc
= 0;
148 /* sq_dequote will write over it */
151 if (sq_dequote_to_argv(envw
, &argv
, &nr
, &alloc
) < 0) {
153 return error("bogus format in " CONFIG_DATA_ENVIRONMENT
);
156 for (i
= 0; i
< nr
; i
++) {
157 if (git_config_parse_parameter(argv
[i
], fn
, data
) < 0) {
169 static int get_next_char(void)
175 if (cf
&& ((f
= cf
->f
) != NULL
)) {
178 /* DOS like systems */
195 static char *parse_value(void)
197 int quote
= 0, comment
= 0, space
= 0;
199 strbuf_reset(&cf
->value
);
201 int c
= get_next_char();
207 return cf
->value
.buf
;
211 if (isspace(c
) && !quote
) {
217 if (c
== ';' || c
== '#') {
222 for (; space
; space
--)
223 strbuf_addch(&cf
->value
, ' ');
238 /* Some characters escape as themselves */
241 /* Reject unknown escape sequences */
245 strbuf_addch(&cf
->value
, c
);
252 strbuf_addch(&cf
->value
, c
);
256 static inline int iskeychar(int c
)
258 return isalnum(c
) || c
== '-';
261 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
266 /* Get the full name */
273 strbuf_addch(name
, tolower(c
));
276 while (c
== ' ' || c
== '\t')
283 value
= parse_value();
287 return fn(name
->buf
, value
, data
);
290 static int get_extended_base_var(struct strbuf
*name
, int c
)
294 goto error_incomplete_line
;
296 } while (isspace(c
));
298 /* We require the format to be '[base "extension"]' */
301 strbuf_addch(name
, '.');
304 int c
= get_next_char();
306 goto error_incomplete_line
;
312 goto error_incomplete_line
;
314 strbuf_addch(name
, c
);
318 if (get_next_char() != ']')
321 error_incomplete_line
:
326 static int get_base_var(struct strbuf
*name
)
329 int c
= get_next_char();
335 return get_extended_base_var(name
, c
);
336 if (!iskeychar(c
) && c
!= '.')
338 strbuf_addch(name
, tolower(c
));
342 static int git_parse_file(config_fn_t fn
, void *data
)
346 struct strbuf
*var
= &cf
->var
;
348 /* U+FEFF Byte Order Mark in UTF8 */
349 static const unsigned char *utf8_bom
= (unsigned char *) "\xef\xbb\xbf";
350 const unsigned char *bomptr
= utf8_bom
;
353 int c
= get_next_char();
354 if (bomptr
&& *bomptr
) {
355 /* We are at the file beginning; skip UTF8-encoded BOM
356 * if present. Sane editors won't put this in on their
357 * own, but e.g. Windows Notepad will do it happily. */
358 if ((unsigned char) c
== *bomptr
) {
362 /* Do not tolerate partial BOM. */
363 if (bomptr
!= utf8_bom
)
365 /* No BOM at file beginning. Cool. */
375 if (comment
|| isspace(c
))
377 if (c
== '#' || c
== ';') {
382 /* Reset prior to determining a new stem */
384 if (get_base_var(var
) < 0 || var
->len
< 1)
386 strbuf_addch(var
, '.');
393 * Truncate the var name back to the section header
394 * stem prior to grabbing the suffix part of the name
397 strbuf_setlen(var
, baselen
);
398 strbuf_addch(var
, tolower(c
));
399 if (get_value(fn
, data
, var
) < 0)
402 die("bad config file line %d in %s", cf
->linenr
, cf
->name
);
405 static int parse_unit_factor(const char *end
, uintmax_t *val
)
409 else if (!strcasecmp(end
, "k")) {
413 else if (!strcasecmp(end
, "m")) {
417 else if (!strcasecmp(end
, "g")) {
418 *val
*= 1024 * 1024 * 1024;
424 static int git_parse_long(const char *value
, long *ret
)
426 if (value
&& *value
) {
430 uintmax_t factor
= 1;
433 val
= strtoimax(value
, &end
, 0);
436 if (!parse_unit_factor(end
, &factor
))
440 if ((uval
> maximum_signed_value_of_type(long)) ||
450 int git_parse_ulong(const char *value
, unsigned long *ret
)
452 if (value
&& *value
) {
458 val
= strtoumax(value
, &end
, 0);
462 if (!parse_unit_factor(end
, &val
))
464 if ((val
> maximum_unsigned_value_of_type(long)) ||
473 static void die_bad_config(const char *name
)
476 die("bad config value for '%s' in %s", name
, cf
->name
);
477 die("bad config value for '%s'", name
);
480 int git_config_int(const char *name
, const char *value
)
483 if (!git_parse_long(value
, &ret
))
484 die_bad_config(name
);
488 unsigned long git_config_ulong(const char *name
, const char *value
)
491 if (!git_parse_ulong(value
, &ret
))
492 die_bad_config(name
);
496 static int git_config_maybe_bool_text(const char *name
, const char *value
)
502 if (!strcasecmp(value
, "true")
503 || !strcasecmp(value
, "yes")
504 || !strcasecmp(value
, "on"))
506 if (!strcasecmp(value
, "false")
507 || !strcasecmp(value
, "no")
508 || !strcasecmp(value
, "off"))
513 int git_config_maybe_bool(const char *name
, const char *value
)
515 long v
= git_config_maybe_bool_text(name
, value
);
518 if (git_parse_long(value
, &v
))
523 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
525 int v
= git_config_maybe_bool_text(name
, value
);
531 return git_config_int(name
, value
);
534 int git_config_bool(const char *name
, const char *value
)
537 return !!git_config_bool_or_int(name
, value
, &discard
);
540 int git_config_string(const char **dest
, const char *var
, const char *value
)
543 return config_error_nonbool(var
);
544 *dest
= xstrdup(value
);
548 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
551 return config_error_nonbool(var
);
552 *dest
= expand_user_path(value
);
554 die("Failed to expand user dir in: '%s'", value
);
558 static int git_default_core_config(const char *var
, const char *value
)
560 /* This needs a better name */
561 if (!strcmp(var
, "core.filemode")) {
562 trust_executable_bit
= git_config_bool(var
, value
);
565 if (!strcmp(var
, "core.trustctime")) {
566 trust_ctime
= git_config_bool(var
, value
);
569 if (!strcmp(var
, "core.statinfo")) {
570 if (!strcasecmp(value
, "default"))
572 else if (!strcasecmp(value
, "minimal"))
576 if (!strcmp(var
, "core.quotepath")) {
577 quote_path_fully
= git_config_bool(var
, value
);
581 if (!strcmp(var
, "core.symlinks")) {
582 has_symlinks
= git_config_bool(var
, value
);
586 if (!strcmp(var
, "core.ignorecase")) {
587 ignore_case
= git_config_bool(var
, value
);
591 if (!strcmp(var
, "core.attributesfile"))
592 return git_config_pathname(&git_attributes_file
, var
, value
);
594 if (!strcmp(var
, "core.bare")) {
595 is_bare_repository_cfg
= git_config_bool(var
, value
);
599 if (!strcmp(var
, "core.ignorestat")) {
600 assume_unchanged
= git_config_bool(var
, value
);
604 if (!strcmp(var
, "core.prefersymlinkrefs")) {
605 prefer_symlink_refs
= git_config_bool(var
, value
);
609 if (!strcmp(var
, "core.logallrefupdates")) {
610 log_all_ref_updates
= git_config_bool(var
, value
);
614 if (!strcmp(var
, "core.warnambiguousrefs")) {
615 warn_ambiguous_refs
= git_config_bool(var
, value
);
619 if (!strcmp(var
, "core.abbrev")) {
620 int abbrev
= git_config_int(var
, value
);
621 if (abbrev
< minimum_abbrev
|| abbrev
> 40)
623 default_abbrev
= abbrev
;
627 if (!strcmp(var
, "core.loosecompression")) {
628 int level
= git_config_int(var
, value
);
630 level
= Z_DEFAULT_COMPRESSION
;
631 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
632 die("bad zlib compression level %d", level
);
633 zlib_compression_level
= level
;
634 zlib_compression_seen
= 1;
638 if (!strcmp(var
, "core.compression")) {
639 int level
= git_config_int(var
, value
);
641 level
= Z_DEFAULT_COMPRESSION
;
642 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
643 die("bad zlib compression level %d", level
);
644 core_compression_level
= level
;
645 core_compression_seen
= 1;
646 if (!zlib_compression_seen
)
647 zlib_compression_level
= level
;
651 if (!strcmp(var
, "core.packedgitwindowsize")) {
652 int pgsz_x2
= getpagesize() * 2;
653 packed_git_window_size
= git_config_ulong(var
, value
);
655 /* This value must be multiple of (pagesize * 2) */
656 packed_git_window_size
/= pgsz_x2
;
657 if (packed_git_window_size
< 1)
658 packed_git_window_size
= 1;
659 packed_git_window_size
*= pgsz_x2
;
663 if (!strcmp(var
, "core.bigfilethreshold")) {
664 big_file_threshold
= git_config_ulong(var
, value
);
668 if (!strcmp(var
, "core.packedgitlimit")) {
669 packed_git_limit
= git_config_ulong(var
, value
);
673 if (!strcmp(var
, "core.deltabasecachelimit")) {
674 delta_base_cache_limit
= git_config_ulong(var
, value
);
678 if (!strcmp(var
, "core.logpackaccess"))
679 return git_config_string(&log_pack_access
, var
, value
);
681 if (!strcmp(var
, "core.autocrlf")) {
682 if (value
&& !strcasecmp(value
, "input")) {
683 if (core_eol
== EOL_CRLF
)
684 return error("core.autocrlf=input conflicts with core.eol=crlf");
685 auto_crlf
= AUTO_CRLF_INPUT
;
688 auto_crlf
= git_config_bool(var
, value
);
692 if (!strcmp(var
, "core.safecrlf")) {
693 if (value
&& !strcasecmp(value
, "warn")) {
694 safe_crlf
= SAFE_CRLF_WARN
;
697 safe_crlf
= git_config_bool(var
, value
);
701 if (!strcmp(var
, "core.eol")) {
702 if (value
&& !strcasecmp(value
, "lf"))
704 else if (value
&& !strcasecmp(value
, "crlf"))
706 else if (value
&& !strcasecmp(value
, "native"))
707 core_eol
= EOL_NATIVE
;
709 core_eol
= EOL_UNSET
;
710 if (core_eol
== EOL_CRLF
&& auto_crlf
== AUTO_CRLF_INPUT
)
711 return error("core.autocrlf=input conflicts with core.eol=crlf");
715 if (!strcmp(var
, "core.notesref")) {
716 notes_ref_name
= xstrdup(value
);
720 if (!strcmp(var
, "core.pager"))
721 return git_config_string(&pager_program
, var
, value
);
723 if (!strcmp(var
, "core.editor"))
724 return git_config_string(&editor_program
, var
, value
);
726 if (!strcmp(var
, "core.commentchar")) {
728 int ret
= git_config_string(&comment
, var
, value
);
730 comment_line_char
= comment
[0];
734 if (!strcmp(var
, "core.askpass"))
735 return git_config_string(&askpass_program
, var
, value
);
737 if (!strcmp(var
, "core.excludesfile"))
738 return git_config_pathname(&excludes_file
, var
, value
);
740 if (!strcmp(var
, "core.whitespace")) {
742 return config_error_nonbool(var
);
743 whitespace_rule_cfg
= parse_whitespace_rule(value
);
747 if (!strcmp(var
, "core.fsyncobjectfiles")) {
748 fsync_object_files
= git_config_bool(var
, value
);
752 if (!strcmp(var
, "core.preloadindex")) {
753 core_preload_index
= git_config_bool(var
, value
);
757 if (!strcmp(var
, "core.createobject")) {
758 if (!strcmp(value
, "rename"))
759 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
760 else if (!strcmp(value
, "link"))
761 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
763 die("Invalid mode for object creation: %s", value
);
767 if (!strcmp(var
, "core.sparsecheckout")) {
768 core_apply_sparse_checkout
= git_config_bool(var
, value
);
772 if (!strcmp(var
, "core.precomposeunicode")) {
773 precomposed_unicode
= git_config_bool(var
, value
);
777 if (!strcmp(var
, "core.hidedotfiles")) {
778 if (value
&& !strcasecmp(value
, "dotgitonly")) {
779 hide_dotfiles
= HIDE_DOTFILES_DOTGITONLY
;
782 hide_dotfiles
= git_config_bool(var
, value
);
786 /* Add other config variables here and to Documentation/config.txt. */
790 static int git_default_i18n_config(const char *var
, const char *value
)
792 if (!strcmp(var
, "i18n.commitencoding"))
793 return git_config_string(&git_commit_encoding
, var
, value
);
795 if (!strcmp(var
, "i18n.logoutputencoding"))
796 return git_config_string(&git_log_output_encoding
, var
, value
);
798 /* Add other config variables here and to Documentation/config.txt. */
802 static int git_default_branch_config(const char *var
, const char *value
)
804 if (!strcmp(var
, "branch.autosetupmerge")) {
805 if (value
&& !strcasecmp(value
, "always")) {
806 git_branch_track
= BRANCH_TRACK_ALWAYS
;
809 git_branch_track
= git_config_bool(var
, value
);
812 if (!strcmp(var
, "branch.autosetuprebase")) {
814 return config_error_nonbool(var
);
815 else if (!strcmp(value
, "never"))
816 autorebase
= AUTOREBASE_NEVER
;
817 else if (!strcmp(value
, "local"))
818 autorebase
= AUTOREBASE_LOCAL
;
819 else if (!strcmp(value
, "remote"))
820 autorebase
= AUTOREBASE_REMOTE
;
821 else if (!strcmp(value
, "always"))
822 autorebase
= AUTOREBASE_ALWAYS
;
824 return error("Malformed value for %s", var
);
828 /* Add other config variables here and to Documentation/config.txt. */
832 static int git_default_push_config(const char *var
, const char *value
)
834 if (!strcmp(var
, "push.default")) {
836 return config_error_nonbool(var
);
837 else if (!strcmp(value
, "nothing"))
838 push_default
= PUSH_DEFAULT_NOTHING
;
839 else if (!strcmp(value
, "matching"))
840 push_default
= PUSH_DEFAULT_MATCHING
;
841 else if (!strcmp(value
, "simple"))
842 push_default
= PUSH_DEFAULT_SIMPLE
;
843 else if (!strcmp(value
, "upstream"))
844 push_default
= PUSH_DEFAULT_UPSTREAM
;
845 else if (!strcmp(value
, "tracking")) /* deprecated */
846 push_default
= PUSH_DEFAULT_UPSTREAM
;
847 else if (!strcmp(value
, "current"))
848 push_default
= PUSH_DEFAULT_CURRENT
;
850 error("Malformed value for %s: %s", var
, value
);
851 return error("Must be one of nothing, matching, simple, "
852 "upstream or current.");
857 /* Add other config variables here and to Documentation/config.txt. */
861 static int git_default_mailmap_config(const char *var
, const char *value
)
863 if (!strcmp(var
, "mailmap.file"))
864 return git_config_string(&git_mailmap_file
, var
, value
);
865 if (!strcmp(var
, "mailmap.blob"))
866 return git_config_string(&git_mailmap_blob
, var
, value
);
868 /* Add other config variables here and to Documentation/config.txt. */
872 int git_default_config(const char *var
, const char *value
, void *dummy
)
874 if (!prefixcmp(var
, "core."))
875 return git_default_core_config(var
, value
);
877 if (!prefixcmp(var
, "user."))
878 return git_ident_config(var
, value
, dummy
);
880 if (!prefixcmp(var
, "i18n."))
881 return git_default_i18n_config(var
, value
);
883 if (!prefixcmp(var
, "branch."))
884 return git_default_branch_config(var
, value
);
886 if (!prefixcmp(var
, "push."))
887 return git_default_push_config(var
, value
);
889 if (!prefixcmp(var
, "mailmap."))
890 return git_default_mailmap_config(var
, value
);
892 if (!prefixcmp(var
, "advice."))
893 return git_default_advice_config(var
, value
);
895 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
896 pager_use_color
= git_config_bool(var
,value
);
900 if (!strcmp(var
, "pack.packsizelimit")) {
901 pack_size_limit_cfg
= git_config_ulong(var
, value
);
904 /* Add other config variables here and to Documentation/config.txt. */
908 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
911 FILE *f
= fopen(filename
, "r");
917 /* push config-file parsing state stack */
923 strbuf_init(&top
.value
, 1024);
924 strbuf_init(&top
.var
, 1024);
927 ret
= git_parse_file(fn
, data
);
929 /* pop config-file parsing state stack */
930 strbuf_release(&top
.value
);
931 strbuf_release(&top
.var
);
939 const char *git_etc_gitconfig(void)
941 static const char *system_wide
;
943 system_wide
= system_path(ETC_GITCONFIG
);
947 int git_env_bool(const char *k
, int def
)
949 const char *v
= getenv(k
);
950 return v
? git_config_bool(k
, v
) : def
;
953 int git_config_system(void)
955 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
958 int git_config_early(config_fn_t fn
, void *data
, const char *repo_config
)
960 int ret
= 0, found
= 0;
961 char *xdg_config
= NULL
;
962 char *user_config
= NULL
;
964 home_config_paths(&user_config
, &xdg_config
, "config");
966 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK
)) {
967 ret
+= git_config_from_file(fn
, git_etc_gitconfig(),
972 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
)) {
973 ret
+= git_config_from_file(fn
, xdg_config
, data
);
977 if (user_config
&& !access_or_die(user_config
, R_OK
)) {
978 ret
+= git_config_from_file(fn
, user_config
, data
);
982 if (repo_config
&& !access_or_die(repo_config
, R_OK
)) {
983 ret
+= git_config_from_file(fn
, repo_config
, data
);
987 switch (git_config_from_parameters(fn
, data
)) {
989 die("unable to parse command-line config");
991 case 0: /* found nothing */
993 default: /* found at least one item */
1000 return ret
== 0 ? found
: ret
;
1003 int git_config_with_options(config_fn_t fn
, void *data
,
1004 const char *filename
, int respect_includes
)
1006 char *repo_config
= NULL
;
1008 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1010 if (respect_includes
) {
1013 fn
= git_config_include
;
1018 * If we have a specific filename, use it. Otherwise, follow the
1019 * regular lookup sequence.
1022 return git_config_from_file(fn
, filename
, data
);
1024 repo_config
= git_pathdup("config");
1025 ret
= git_config_early(fn
, data
, repo_config
);
1031 int git_config(config_fn_t fn
, void *data
)
1033 return git_config_with_options(fn
, data
, NULL
, 1);
1037 * Find all the stuff for git_config_set() below.
1040 #define MAX_MATCHES 512
1046 regex_t
*value_regex
;
1048 size_t offset
[MAX_MATCHES
];
1049 enum { START
, SECTION_SEEN
, SECTION_END_SEEN
, KEY_SEEN
} state
;
1053 static int matches(const char *key
, const char *value
)
1055 return !strcmp(key
, store
.key
) &&
1056 (store
.value_regex
== NULL
||
1057 (store
.do_not_match
^
1058 !regexec(store
.value_regex
, value
, 0, NULL
, 0)));
1061 static int store_aux(const char *key
, const char *value
, void *cb
)
1067 switch (store
.state
) {
1069 if (matches(key
, value
)) {
1070 if (store
.seen
== 1 && store
.multi_replace
== 0) {
1071 warning("%s has multiple values", key
);
1072 } else if (store
.seen
>= MAX_MATCHES
) {
1073 error("too many matches for %s", key
);
1077 store
.offset
[store
.seen
] = ftell(f
);
1083 * What we are looking for is in store.key (both
1084 * section and var), and its section part is baselen
1085 * long. We found key (again, both section and var).
1086 * We would want to know if this key is in the same
1087 * section as what we are looking for. We already
1088 * know we are in the same section as what should
1091 ep
= strrchr(key
, '.');
1092 section_len
= ep
- key
;
1094 if ((section_len
!= store
.baselen
) ||
1095 memcmp(key
, store
.key
, section_len
+1)) {
1096 store
.state
= SECTION_END_SEEN
;
1101 * Do not increment matches: this is no match, but we
1102 * just made sure we are in the desired section.
1104 store
.offset
[store
.seen
] = ftell(f
);
1106 case SECTION_END_SEEN
:
1108 if (matches(key
, value
)) {
1109 store
.offset
[store
.seen
] = ftell(f
);
1110 store
.state
= KEY_SEEN
;
1113 if (strrchr(key
, '.') - key
== store
.baselen
&&
1114 !strncmp(key
, store
.key
, store
.baselen
)) {
1115 store
.state
= SECTION_SEEN
;
1116 store
.offset
[store
.seen
] = ftell(f
);
1123 static int write_error(const char *filename
)
1125 error("failed to write new configuration file %s", filename
);
1127 /* Same error code as "failed to rename". */
1131 static int store_write_section(int fd
, const char *key
)
1135 struct strbuf sb
= STRBUF_INIT
;
1137 dot
= memchr(key
, '.', store
.baselen
);
1139 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
1140 for (i
= dot
- key
+ 1; i
< store
.baselen
; i
++) {
1141 if (key
[i
] == '"' || key
[i
] == '\\')
1142 strbuf_addch(&sb
, '\\');
1143 strbuf_addch(&sb
, key
[i
]);
1145 strbuf_addstr(&sb
, "\"]\n");
1147 strbuf_addf(&sb
, "[%.*s]\n", store
.baselen
, key
);
1150 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1151 strbuf_release(&sb
);
1156 static int store_write_pair(int fd
, const char *key
, const char *value
)
1159 int length
= strlen(key
+ store
.baselen
+ 1);
1160 const char *quote
= "";
1161 struct strbuf sb
= STRBUF_INIT
;
1164 * Check to see if the value needs to be surrounded with a dq pair.
1165 * Note that problematic characters are always backslash-quoted; this
1166 * check is about not losing leading or trailing SP and strings that
1167 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1168 * configuration parser.
1170 if (value
[0] == ' ')
1172 for (i
= 0; value
[i
]; i
++)
1173 if (value
[i
] == ';' || value
[i
] == '#')
1175 if (i
&& value
[i
- 1] == ' ')
1178 strbuf_addf(&sb
, "\t%.*s = %s",
1179 length
, key
+ store
.baselen
+ 1, quote
);
1181 for (i
= 0; value
[i
]; i
++)
1184 strbuf_addstr(&sb
, "\\n");
1187 strbuf_addstr(&sb
, "\\t");
1191 strbuf_addch(&sb
, '\\');
1193 strbuf_addch(&sb
, value
[i
]);
1196 strbuf_addf(&sb
, "%s\n", quote
);
1198 success
= write_in_full(fd
, sb
.buf
, sb
.len
) == sb
.len
;
1199 strbuf_release(&sb
);
1204 static ssize_t
find_beginning_of_line(const char *contents
, size_t size
,
1205 size_t offset_
, int *found_bracket
)
1207 size_t equal_offset
= size
, bracket_offset
= size
;
1211 for (offset
= offset_
-2; offset
> 0
1212 && contents
[offset
] != '\n'; offset
--)
1213 switch (contents
[offset
]) {
1214 case '=': equal_offset
= offset
; break;
1215 case ']': bracket_offset
= offset
; break;
1217 if (offset
> 0 && contents
[offset
-1] == '\\') {
1221 if (bracket_offset
< equal_offset
) {
1223 offset
= bracket_offset
+1;
1230 int git_config_set_in_file(const char *config_filename
,
1231 const char *key
, const char *value
)
1233 return git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
1236 int git_config_set(const char *key
, const char *value
)
1238 return git_config_set_multivar(key
, value
, NULL
, 0);
1242 * Auxiliary function to sanity-check and split the key into the section
1243 * identifier and variable name.
1245 * Returns 0 on success, -1 when there is an invalid character in the key and
1246 * -2 if there is no section name in the key.
1248 * store_key - pointer to char* which will hold a copy of the key with
1249 * lowercase section and variable name
1250 * baselen - pointer to int which will hold the length of the
1251 * section + subsection part, can be NULL
1253 int git_config_parse_key(const char *key
, char **store_key
, int *baselen_
)
1255 int i
, dot
, baselen
;
1256 const char *last_dot
= strrchr(key
, '.');
1259 * Since "key" actually contains the section name and the real
1260 * key name separated by a dot, we have to know where the dot is.
1263 if (last_dot
== NULL
|| last_dot
== key
) {
1264 error("key does not contain a section: %s", key
);
1265 return -CONFIG_NO_SECTION_OR_NAME
;
1269 error("key does not contain variable name: %s", key
);
1270 return -CONFIG_NO_SECTION_OR_NAME
;
1273 baselen
= last_dot
- key
;
1275 *baselen_
= baselen
;
1278 * Validate the key and while at it, lower case it for matching.
1280 *store_key
= xmalloc(strlen(key
) + 1);
1283 for (i
= 0; key
[i
]; i
++) {
1284 unsigned char c
= key
[i
];
1287 /* Leave the extended basename untouched.. */
1288 if (!dot
|| i
> baselen
) {
1289 if (!iskeychar(c
) ||
1290 (i
== baselen
+ 1 && !isalpha(c
))) {
1291 error("invalid key: %s", key
);
1292 goto out_free_ret_1
;
1295 } else if (c
== '\n') {
1296 error("invalid key (newline): %s", key
);
1297 goto out_free_ret_1
;
1299 (*store_key
)[i
] = c
;
1301 (*store_key
)[i
] = 0;
1308 return -CONFIG_INVALID_KEY
;
1312 * If value==NULL, unset in (remove from) config,
1313 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1314 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1315 * else all matching key/values (regardless how many) are removed,
1316 * before the new pair is written.
1318 * Returns 0 on success.
1320 * This function does this:
1322 * - it locks the config file by creating ".git/config.lock"
1324 * - it then parses the config using store_aux() as validator to find
1325 * the position on the key/value pair to replace. If it is to be unset,
1326 * it must be found exactly once.
1328 * - the config file is mmap()ed and the part before the match (if any) is
1329 * written to the lock file, then the changed part and the rest.
1331 * - the config file is removed and the lock file rename()d to it.
1334 int git_config_set_multivar_in_file(const char *config_filename
,
1335 const char *key
, const char *value
,
1336 const char *value_regex
, int multi_replace
)
1340 struct lock_file
*lock
= NULL
;
1341 char *filename_buf
= NULL
;
1343 /* parse-key returns negative; flip the sign to feed exit(3) */
1344 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
1348 store
.multi_replace
= multi_replace
;
1350 if (!config_filename
)
1351 config_filename
= filename_buf
= git_pathdup("config");
1354 * The lock serves a purpose in addition to locking: the new
1355 * contents of .git/config will be written into it.
1357 lock
= xcalloc(sizeof(struct lock_file
), 1);
1358 fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1360 error("could not lock config file %s: %s", config_filename
, strerror(errno
));
1362 ret
= CONFIG_NO_LOCK
;
1367 * If .git/config does not exist yet, write a minimal version.
1369 in_fd
= open(config_filename
, O_RDONLY
);
1373 if ( ENOENT
!= errno
) {
1374 error("opening %s: %s", config_filename
,
1376 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
1379 /* if nothing to unset, error out */
1380 if (value
== NULL
) {
1381 ret
= CONFIG_NOTHING_SET
;
1385 store
.key
= (char *)key
;
1386 if (!store_write_section(fd
, key
) ||
1387 !store_write_pair(fd
, key
, value
))
1392 size_t contents_sz
, copy_begin
, copy_end
;
1393 int i
, new_line
= 0;
1395 if (value_regex
== NULL
)
1396 store
.value_regex
= NULL
;
1398 if (value_regex
[0] == '!') {
1399 store
.do_not_match
= 1;
1402 store
.do_not_match
= 0;
1404 store
.value_regex
= (regex_t
*)xmalloc(sizeof(regex_t
));
1405 if (regcomp(store
.value_regex
, value_regex
,
1407 error("invalid pattern: %s", value_regex
);
1408 free(store
.value_regex
);
1409 ret
= CONFIG_INVALID_PATTERN
;
1414 store
.offset
[0] = 0;
1415 store
.state
= START
;
1419 * After this, store.offset will contain the *end* offset
1420 * of the last match, or remain at 0 if no match was found.
1421 * As a side effect, we make sure to transform only a valid
1422 * existing config file.
1424 if (git_config_from_file(store_aux
, config_filename
, NULL
)) {
1425 error("invalid config file %s", config_filename
);
1427 if (store
.value_regex
!= NULL
) {
1428 regfree(store
.value_regex
);
1429 free(store
.value_regex
);
1431 ret
= CONFIG_INVALID_FILE
;
1436 if (store
.value_regex
!= NULL
) {
1437 regfree(store
.value_regex
);
1438 free(store
.value_regex
);
1441 /* if nothing to unset, or too many matches, error out */
1442 if ((store
.seen
== 0 && value
== NULL
) ||
1443 (store
.seen
> 1 && multi_replace
== 0)) {
1444 ret
= CONFIG_NOTHING_SET
;
1449 contents_sz
= xsize_t(st
.st_size
);
1450 contents
= xmmap(NULL
, contents_sz
, PROT_READ
,
1451 MAP_PRIVATE
, in_fd
, 0);
1454 if (store
.seen
== 0)
1457 for (i
= 0, copy_begin
= 0; i
< store
.seen
; i
++) {
1458 if (store
.offset
[i
] == 0) {
1459 store
.offset
[i
] = copy_end
= contents_sz
;
1460 } else if (store
.state
!= KEY_SEEN
) {
1461 copy_end
= store
.offset
[i
];
1463 copy_end
= find_beginning_of_line(
1464 contents
, contents_sz
,
1465 store
.offset
[i
]-2, &new_line
);
1467 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
1470 /* write the first part of the config */
1471 if (copy_end
> copy_begin
) {
1472 if (write_in_full(fd
, contents
+ copy_begin
,
1473 copy_end
- copy_begin
) <
1474 copy_end
- copy_begin
)
1477 write_str_in_full(fd
, "\n") != 1)
1480 copy_begin
= store
.offset
[i
];
1483 /* write the pair (value == NULL means unset) */
1484 if (value
!= NULL
) {
1485 if (store
.state
== START
) {
1486 if (!store_write_section(fd
, key
))
1489 if (!store_write_pair(fd
, key
, value
))
1493 /* write the rest of the config */
1494 if (copy_begin
< contents_sz
)
1495 if (write_in_full(fd
, contents
+ copy_begin
,
1496 contents_sz
- copy_begin
) <
1497 contents_sz
- copy_begin
)
1500 munmap(contents
, contents_sz
);
1503 if (commit_lock_file(lock
) < 0) {
1504 error("could not commit config file %s", config_filename
);
1505 ret
= CONFIG_NO_WRITE
;
1510 * lock is committed, so don't try to roll it back below.
1511 * NOTE: Since lockfile.c keeps a linked list of all created
1512 * lock_file structures, it isn't safe to free(lock). It's
1513 * better to just leave it hanging around.
1520 rollback_lock_file(lock
);
1525 ret
= write_error(lock
->filename
);
1530 int git_config_set_multivar(const char *key
, const char *value
,
1531 const char *value_regex
, int multi_replace
)
1533 return git_config_set_multivar_in_file(NULL
, key
, value
, value_regex
,
1537 static int section_name_match (const char *buf
, const char *name
)
1539 int i
= 0, j
= 0, dot
= 0;
1542 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
1543 if (!dot
&& isspace(buf
[i
])) {
1545 if (name
[j
++] != '.')
1547 for (i
++; isspace(buf
[i
]); i
++)
1553 if (buf
[i
] == '\\' && dot
)
1555 else if (buf
[i
] == '"' && dot
) {
1556 for (i
++; isspace(buf
[i
]); i
++)
1560 if (buf
[i
] != name
[j
++])
1563 if (buf
[i
] == ']' && name
[j
] == 0) {
1565 * We match, now just find the right length offset by
1566 * gobbling up any whitespace after it, as well
1569 for (; buf
[i
] && isspace(buf
[i
]); i
++)
1576 static int section_name_is_ok(const char *name
)
1578 /* Empty section names are bogus. */
1583 * Before a dot, we must be alphanumeric or dash. After the first dot,
1584 * anything goes, so we can stop checking.
1586 for (; *name
&& *name
!= '.'; name
++)
1587 if (*name
!= '-' && !isalnum(*name
))
1592 /* if new_name == NULL, the section is removed instead */
1593 int git_config_rename_section_in_file(const char *config_filename
,
1594 const char *old_name
, const char *new_name
)
1596 int ret
= 0, remove
= 0;
1597 char *filename_buf
= NULL
;
1598 struct lock_file
*lock
;
1603 if (new_name
&& !section_name_is_ok(new_name
)) {
1604 ret
= error("invalid section name: %s", new_name
);
1608 if (!config_filename
)
1609 config_filename
= filename_buf
= git_pathdup("config");
1611 lock
= xcalloc(sizeof(struct lock_file
), 1);
1612 out_fd
= hold_lock_file_for_update(lock
, config_filename
, 0);
1614 ret
= error("could not lock config file %s", config_filename
);
1618 if (!(config_file
= fopen(config_filename
, "rb"))) {
1619 /* no config file means nothing to rename, no error */
1620 goto unlock_and_out
;
1623 while (fgets(buf
, sizeof(buf
), config_file
)) {
1627 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
1629 if (buf
[i
] == '[') {
1630 /* it's a section */
1631 int offset
= section_name_match(&buf
[i
], old_name
);
1634 if (new_name
== NULL
) {
1638 store
.baselen
= strlen(new_name
);
1639 if (!store_write_section(out_fd
, new_name
)) {
1640 ret
= write_error(lock
->filename
);
1644 * We wrote out the new section, with
1645 * a newline, now skip the old
1648 output
+= offset
+ i
;
1649 if (strlen(output
) > 0) {
1651 * More content means there's
1652 * a declaration to put on the
1653 * next line; indent with a
1664 length
= strlen(output
);
1665 if (write_in_full(out_fd
, output
, length
) != length
) {
1666 ret
= write_error(lock
->filename
);
1670 fclose(config_file
);
1672 if (commit_lock_file(lock
) < 0)
1673 ret
= error("could not commit config file %s", config_filename
);
1679 int git_config_rename_section(const char *old_name
, const char *new_name
)
1681 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
1685 * Call this to report error for your variable that should not
1686 * get a boolean value (i.e. "[my] var" means "true").
1688 #undef config_error_nonbool
1689 int config_error_nonbool(const char *var
)
1691 return error("Missing value for '%s'", var
);
1694 int parse_config_key(const char *var
,
1695 const char *section
,
1696 const char **subsection
, int *subsection_len
,
1699 int section_len
= strlen(section
);
1702 /* Does it start with "section." ? */
1703 if (prefixcmp(var
, section
) || var
[section_len
] != '.')
1707 * Find the key; we don't know yet if we have a subsection, but we must
1708 * parse backwards from the end, since the subsection may have dots in
1711 dot
= strrchr(var
, '.');
1714 /* Did we have a subsection at all? */
1715 if (dot
== var
+ section_len
) {
1717 *subsection_len
= 0;
1720 *subsection
= var
+ section_len
+ 1;
1721 *subsection_len
= dot
- *subsection
;