http-backend.c: replace `git_config()` with `git_config_get_bool()` family
[git/debian.git] / config.c
blob387e86bb6ce6307d3a1398b82344b7e2a8de817f
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "exec_cmd.h"
10 #include "strbuf.h"
11 #include "quote.h"
12 #include "hashmap.h"
13 #include "string-list.h"
15 struct config_source {
16 struct config_source *prev;
17 union {
18 FILE *file;
19 struct config_buf {
20 const char *buf;
21 size_t len;
22 size_t pos;
23 } buf;
24 } u;
25 const char *name;
26 const char *path;
27 int die_on_error;
28 int linenr;
29 int eof;
30 struct strbuf value;
31 struct strbuf var;
33 int (*do_fgetc)(struct config_source *c);
34 int (*do_ungetc)(int c, struct config_source *conf);
35 long (*do_ftell)(struct config_source *c);
38 static struct config_source *cf;
40 static int zlib_compression_seen;
43 * Default config_set that contains key-value pairs from the usual set of config
44 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
45 * config file and the global /etc/gitconfig)
47 static struct config_set the_config_set;
49 static int config_file_fgetc(struct config_source *conf)
51 return fgetc(conf->u.file);
54 static int config_file_ungetc(int c, struct config_source *conf)
56 return ungetc(c, conf->u.file);
59 static long config_file_ftell(struct config_source *conf)
61 return ftell(conf->u.file);
65 static int config_buf_fgetc(struct config_source *conf)
67 if (conf->u.buf.pos < conf->u.buf.len)
68 return conf->u.buf.buf[conf->u.buf.pos++];
70 return EOF;
73 static int config_buf_ungetc(int c, struct config_source *conf)
75 if (conf->u.buf.pos > 0)
76 return conf->u.buf.buf[--conf->u.buf.pos];
78 return EOF;
81 static long config_buf_ftell(struct config_source *conf)
83 return conf->u.buf.pos;
86 #define MAX_INCLUDE_DEPTH 10
87 static const char include_depth_advice[] =
88 "exceeded maximum include depth (%d) while including\n"
89 " %s\n"
90 "from\n"
91 " %s\n"
92 "Do you have circular includes?";
93 static int handle_path_include(const char *path, struct config_include_data *inc)
95 int ret = 0;
96 struct strbuf buf = STRBUF_INIT;
97 char *expanded;
99 if (!path)
100 return config_error_nonbool("include.path");
102 expanded = expand_user_path(path);
103 if (!expanded)
104 return error("Could not expand include path '%s'", path);
105 path = expanded;
108 * Use an absolute path as-is, but interpret relative paths
109 * based on the including config file.
111 if (!is_absolute_path(path)) {
112 char *slash;
114 if (!cf || !cf->path)
115 return error("relative config includes must come from files");
117 slash = find_last_dir_sep(cf->path);
118 if (slash)
119 strbuf_add(&buf, cf->path, slash - cf->path + 1);
120 strbuf_addstr(&buf, path);
121 path = buf.buf;
124 if (!access_or_die(path, R_OK, 0)) {
125 if (++inc->depth > MAX_INCLUDE_DEPTH)
126 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
127 cf && cf->name ? cf->name : "the command line");
128 ret = git_config_from_file(git_config_include, path, inc);
129 inc->depth--;
131 strbuf_release(&buf);
132 free(expanded);
133 return ret;
136 int git_config_include(const char *var, const char *value, void *data)
138 struct config_include_data *inc = data;
139 const char *type;
140 int ret;
143 * Pass along all values, including "include" directives; this makes it
144 * possible to query information on the includes themselves.
146 ret = inc->fn(var, value, inc->data);
147 if (ret < 0)
148 return ret;
150 if (!skip_prefix(var, "include.", &type))
151 return ret;
153 if (!strcmp(type, "path"))
154 ret = handle_path_include(value, inc);
155 return ret;
158 void git_config_push_parameter(const char *text)
160 struct strbuf env = STRBUF_INIT;
161 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
162 if (old) {
163 strbuf_addstr(&env, old);
164 strbuf_addch(&env, ' ');
166 sq_quote_buf(&env, text);
167 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
168 strbuf_release(&env);
171 int git_config_parse_parameter(const char *text,
172 config_fn_t fn, void *data)
174 struct strbuf **pair;
175 pair = strbuf_split_str(text, '=', 2);
176 if (!pair[0])
177 return error("bogus config parameter: %s", text);
178 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
179 strbuf_setlen(pair[0], pair[0]->len - 1);
180 strbuf_trim(pair[0]);
181 if (!pair[0]->len) {
182 strbuf_list_free(pair);
183 return error("bogus config parameter: %s", text);
185 strbuf_tolower(pair[0]);
186 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
187 strbuf_list_free(pair);
188 return -1;
190 strbuf_list_free(pair);
191 return 0;
194 int git_config_from_parameters(config_fn_t fn, void *data)
196 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
197 char *envw;
198 const char **argv = NULL;
199 int nr = 0, alloc = 0;
200 int i;
202 if (!env)
203 return 0;
204 /* sq_dequote will write over it */
205 envw = xstrdup(env);
207 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
208 free(envw);
209 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
212 for (i = 0; i < nr; i++) {
213 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
214 free(argv);
215 free(envw);
216 return -1;
220 free(argv);
221 free(envw);
222 return nr > 0;
225 static int get_next_char(void)
227 int c = cf->do_fgetc(cf);
229 if (c == '\r') {
230 /* DOS like systems */
231 c = cf->do_fgetc(cf);
232 if (c != '\n') {
233 cf->do_ungetc(c, cf);
234 c = '\r';
237 if (c == '\n')
238 cf->linenr++;
239 if (c == EOF) {
240 cf->eof = 1;
241 cf->linenr++;
242 c = '\n';
244 return c;
247 static char *parse_value(void)
249 int quote = 0, comment = 0, space = 0;
251 strbuf_reset(&cf->value);
252 for (;;) {
253 int c = get_next_char();
254 if (c == '\n') {
255 if (quote) {
256 cf->linenr--;
257 return NULL;
259 return cf->value.buf;
261 if (comment)
262 continue;
263 if (isspace(c) && !quote) {
264 if (cf->value.len)
265 space++;
266 continue;
268 if (!quote) {
269 if (c == ';' || c == '#') {
270 comment = 1;
271 continue;
274 for (; space; space--)
275 strbuf_addch(&cf->value, ' ');
276 if (c == '\\') {
277 c = get_next_char();
278 switch (c) {
279 case '\n':
280 continue;
281 case 't':
282 c = '\t';
283 break;
284 case 'b':
285 c = '\b';
286 break;
287 case 'n':
288 c = '\n';
289 break;
290 /* Some characters escape as themselves */
291 case '\\': case '"':
292 break;
293 /* Reject unknown escape sequences */
294 default:
295 return NULL;
297 strbuf_addch(&cf->value, c);
298 continue;
300 if (c == '"') {
301 quote = 1-quote;
302 continue;
304 strbuf_addch(&cf->value, c);
308 static inline int iskeychar(int c)
310 return isalnum(c) || c == '-';
313 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
315 int c;
316 char *value;
317 int ret;
319 /* Get the full name */
320 for (;;) {
321 c = get_next_char();
322 if (cf->eof)
323 break;
324 if (!iskeychar(c))
325 break;
326 strbuf_addch(name, tolower(c));
329 while (c == ' ' || c == '\t')
330 c = get_next_char();
332 value = NULL;
333 if (c != '\n') {
334 if (c != '=')
335 return -1;
336 value = parse_value();
337 if (!value)
338 return -1;
341 * We already consumed the \n, but we need linenr to point to
342 * the line we just parsed during the call to fn to get
343 * accurate line number in error messages.
345 cf->linenr--;
346 ret = fn(name->buf, value, data);
347 cf->linenr++;
348 return ret;
351 static int get_extended_base_var(struct strbuf *name, int c)
353 do {
354 if (c == '\n')
355 goto error_incomplete_line;
356 c = get_next_char();
357 } while (isspace(c));
359 /* We require the format to be '[base "extension"]' */
360 if (c != '"')
361 return -1;
362 strbuf_addch(name, '.');
364 for (;;) {
365 int c = get_next_char();
366 if (c == '\n')
367 goto error_incomplete_line;
368 if (c == '"')
369 break;
370 if (c == '\\') {
371 c = get_next_char();
372 if (c == '\n')
373 goto error_incomplete_line;
375 strbuf_addch(name, c);
378 /* Final ']' */
379 if (get_next_char() != ']')
380 return -1;
381 return 0;
382 error_incomplete_line:
383 cf->linenr--;
384 return -1;
387 static int get_base_var(struct strbuf *name)
389 for (;;) {
390 int c = get_next_char();
391 if (cf->eof)
392 return -1;
393 if (c == ']')
394 return 0;
395 if (isspace(c))
396 return get_extended_base_var(name, c);
397 if (!iskeychar(c) && c != '.')
398 return -1;
399 strbuf_addch(name, tolower(c));
403 static int git_parse_source(config_fn_t fn, void *data)
405 int comment = 0;
406 int baselen = 0;
407 struct strbuf *var = &cf->var;
409 /* U+FEFF Byte Order Mark in UTF8 */
410 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
411 const unsigned char *bomptr = utf8_bom;
413 for (;;) {
414 int c = get_next_char();
415 if (bomptr && *bomptr) {
416 /* We are at the file beginning; skip UTF8-encoded BOM
417 * if present. Sane editors won't put this in on their
418 * own, but e.g. Windows Notepad will do it happily. */
419 if ((unsigned char) c == *bomptr) {
420 bomptr++;
421 continue;
422 } else {
423 /* Do not tolerate partial BOM. */
424 if (bomptr != utf8_bom)
425 break;
426 /* No BOM at file beginning. Cool. */
427 bomptr = NULL;
430 if (c == '\n') {
431 if (cf->eof)
432 return 0;
433 comment = 0;
434 continue;
436 if (comment || isspace(c))
437 continue;
438 if (c == '#' || c == ';') {
439 comment = 1;
440 continue;
442 if (c == '[') {
443 /* Reset prior to determining a new stem */
444 strbuf_reset(var);
445 if (get_base_var(var) < 0 || var->len < 1)
446 break;
447 strbuf_addch(var, '.');
448 baselen = var->len;
449 continue;
451 if (!isalpha(c))
452 break;
454 * Truncate the var name back to the section header
455 * stem prior to grabbing the suffix part of the name
456 * and the value.
458 strbuf_setlen(var, baselen);
459 strbuf_addch(var, tolower(c));
460 if (get_value(fn, data, var) < 0)
461 break;
463 if (cf->die_on_error)
464 die(_("bad config file line %d in %s"), cf->linenr, cf->name);
465 else
466 return error(_("bad config file line %d in %s"), cf->linenr, cf->name);
469 static int parse_unit_factor(const char *end, uintmax_t *val)
471 if (!*end)
472 return 1;
473 else if (!strcasecmp(end, "k")) {
474 *val *= 1024;
475 return 1;
477 else if (!strcasecmp(end, "m")) {
478 *val *= 1024 * 1024;
479 return 1;
481 else if (!strcasecmp(end, "g")) {
482 *val *= 1024 * 1024 * 1024;
483 return 1;
485 return 0;
488 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
490 if (value && *value) {
491 char *end;
492 intmax_t val;
493 uintmax_t uval;
494 uintmax_t factor = 1;
496 errno = 0;
497 val = strtoimax(value, &end, 0);
498 if (errno == ERANGE)
499 return 0;
500 if (!parse_unit_factor(end, &factor)) {
501 errno = EINVAL;
502 return 0;
504 uval = abs(val);
505 uval *= factor;
506 if (uval > max || abs(val) > uval) {
507 errno = ERANGE;
508 return 0;
510 val *= factor;
511 *ret = val;
512 return 1;
514 errno = EINVAL;
515 return 0;
518 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
520 if (value && *value) {
521 char *end;
522 uintmax_t val;
523 uintmax_t oldval;
525 errno = 0;
526 val = strtoumax(value, &end, 0);
527 if (errno == ERANGE)
528 return 0;
529 oldval = val;
530 if (!parse_unit_factor(end, &val)) {
531 errno = EINVAL;
532 return 0;
534 if (val > max || oldval > val) {
535 errno = ERANGE;
536 return 0;
538 *ret = val;
539 return 1;
541 errno = EINVAL;
542 return 0;
545 static int git_parse_int(const char *value, int *ret)
547 intmax_t tmp;
548 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
549 return 0;
550 *ret = tmp;
551 return 1;
554 static int git_parse_int64(const char *value, int64_t *ret)
556 intmax_t tmp;
557 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
558 return 0;
559 *ret = tmp;
560 return 1;
563 int git_parse_ulong(const char *value, unsigned long *ret)
565 uintmax_t tmp;
566 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
567 return 0;
568 *ret = tmp;
569 return 1;
572 NORETURN
573 static void die_bad_number(const char *name, const char *value)
575 const char *reason = errno == ERANGE ?
576 "out of range" :
577 "invalid unit";
578 if (!value)
579 value = "";
581 if (cf && cf->name)
582 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
583 value, name, cf->name, reason);
584 die(_("bad numeric config value '%s' for '%s': %s"), value, name, reason);
587 int git_config_int(const char *name, const char *value)
589 int ret;
590 if (!git_parse_int(value, &ret))
591 die_bad_number(name, value);
592 return ret;
595 int64_t git_config_int64(const char *name, const char *value)
597 int64_t ret;
598 if (!git_parse_int64(value, &ret))
599 die_bad_number(name, value);
600 return ret;
603 unsigned long git_config_ulong(const char *name, const char *value)
605 unsigned long ret;
606 if (!git_parse_ulong(value, &ret))
607 die_bad_number(name, value);
608 return ret;
611 static int git_config_maybe_bool_text(const char *name, const char *value)
613 if (!value)
614 return 1;
615 if (!*value)
616 return 0;
617 if (!strcasecmp(value, "true")
618 || !strcasecmp(value, "yes")
619 || !strcasecmp(value, "on"))
620 return 1;
621 if (!strcasecmp(value, "false")
622 || !strcasecmp(value, "no")
623 || !strcasecmp(value, "off"))
624 return 0;
625 return -1;
628 int git_config_maybe_bool(const char *name, const char *value)
630 int v = git_config_maybe_bool_text(name, value);
631 if (0 <= v)
632 return v;
633 if (git_parse_int(value, &v))
634 return !!v;
635 return -1;
638 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
640 int v = git_config_maybe_bool_text(name, value);
641 if (0 <= v) {
642 *is_bool = 1;
643 return v;
645 *is_bool = 0;
646 return git_config_int(name, value);
649 int git_config_bool(const char *name, const char *value)
651 int discard;
652 return !!git_config_bool_or_int(name, value, &discard);
655 int git_config_string(const char **dest, const char *var, const char *value)
657 if (!value)
658 return config_error_nonbool(var);
659 *dest = xstrdup(value);
660 return 0;
663 int git_config_pathname(const char **dest, const char *var, const char *value)
665 if (!value)
666 return config_error_nonbool(var);
667 *dest = expand_user_path(value);
668 if (!*dest)
669 die(_("failed to expand user dir in: '%s'"), value);
670 return 0;
673 static int git_default_core_config(const char *var, const char *value)
675 /* This needs a better name */
676 if (!strcmp(var, "core.filemode")) {
677 trust_executable_bit = git_config_bool(var, value);
678 return 0;
680 if (!strcmp(var, "core.trustctime")) {
681 trust_ctime = git_config_bool(var, value);
682 return 0;
684 if (!strcmp(var, "core.checkstat")) {
685 if (!strcasecmp(value, "default"))
686 check_stat = 1;
687 else if (!strcasecmp(value, "minimal"))
688 check_stat = 0;
691 if (!strcmp(var, "core.quotepath")) {
692 quote_path_fully = git_config_bool(var, value);
693 return 0;
696 if (!strcmp(var, "core.symlinks")) {
697 has_symlinks = git_config_bool(var, value);
698 return 0;
701 if (!strcmp(var, "core.ignorecase")) {
702 ignore_case = git_config_bool(var, value);
703 return 0;
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);
711 return 0;
714 if (!strcmp(var, "core.ignorestat")) {
715 assume_unchanged = git_config_bool(var, value);
716 return 0;
719 if (!strcmp(var, "core.prefersymlinkrefs")) {
720 prefer_symlink_refs = git_config_bool(var, value);
721 return 0;
724 if (!strcmp(var, "core.logallrefupdates")) {
725 log_all_ref_updates = git_config_bool(var, value);
726 return 0;
729 if (!strcmp(var, "core.warnambiguousrefs")) {
730 warn_ambiguous_refs = git_config_bool(var, value);
731 return 0;
734 if (!strcmp(var, "core.abbrev")) {
735 int abbrev = git_config_int(var, value);
736 if (abbrev < minimum_abbrev || abbrev > 40)
737 return -1;
738 default_abbrev = abbrev;
739 return 0;
742 if (!strcmp(var, "core.loosecompression")) {
743 int level = git_config_int(var, value);
744 if (level == -1)
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;
750 return 0;
753 if (!strcmp(var, "core.compression")) {
754 int level = git_config_int(var, value);
755 if (level == -1)
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;
763 return 0;
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;
775 return 0;
778 if (!strcmp(var, "core.bigfilethreshold")) {
779 big_file_threshold = git_config_ulong(var, value);
780 return 0;
783 if (!strcmp(var, "core.packedgitlimit")) {
784 packed_git_limit = git_config_ulong(var, value);
785 return 0;
788 if (!strcmp(var, "core.deltabasecachelimit")) {
789 delta_base_cache_limit = git_config_ulong(var, value);
790 return 0;
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;
798 return 0;
800 auto_crlf = git_config_bool(var, value);
801 return 0;
804 if (!strcmp(var, "core.safecrlf")) {
805 if (value && !strcasecmp(value, "warn")) {
806 safe_crlf = SAFE_CRLF_WARN;
807 return 0;
809 safe_crlf = git_config_bool(var, value);
810 return 0;
813 if (!strcmp(var, "core.eol")) {
814 if (value && !strcasecmp(value, "lf"))
815 core_eol = EOL_LF;
816 else if (value && !strcasecmp(value, "crlf"))
817 core_eol = EOL_CRLF;
818 else if (value && !strcasecmp(value, "native"))
819 core_eol = EOL_NATIVE;
820 else
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");
824 return 0;
827 if (!strcmp(var, "core.notesref")) {
828 notes_ref_name = xstrdup(value);
829 return 0;
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")) {
839 const char *comment;
840 int ret = git_config_string(&comment, var, value);
841 if (ret)
842 return ret;
843 else if (!strcasecmp(comment, "auto"))
844 auto_comment_line_char = 1;
845 else if (comment[0] && !comment[1]) {
846 comment_line_char = comment[0];
847 auto_comment_line_char = 0;
848 } else
849 return error("core.commentChar should only be one character");
850 return 0;
853 if (!strcmp(var, "core.askpass"))
854 return git_config_string(&askpass_program, var, value);
856 if (!strcmp(var, "core.excludesfile"))
857 return git_config_pathname(&excludes_file, var, value);
859 if (!strcmp(var, "core.whitespace")) {
860 if (!value)
861 return config_error_nonbool(var);
862 whitespace_rule_cfg = parse_whitespace_rule(value);
863 return 0;
866 if (!strcmp(var, "core.fsyncobjectfiles")) {
867 fsync_object_files = git_config_bool(var, value);
868 return 0;
871 if (!strcmp(var, "core.preloadindex")) {
872 core_preload_index = git_config_bool(var, value);
873 return 0;
876 if (!strcmp(var, "core.createobject")) {
877 if (!strcmp(value, "rename"))
878 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
879 else if (!strcmp(value, "link"))
880 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
881 else
882 die(_("invalid mode for object creation: %s"), value);
883 return 0;
886 if (!strcmp(var, "core.sparsecheckout")) {
887 core_apply_sparse_checkout = git_config_bool(var, value);
888 return 0;
891 if (!strcmp(var, "core.precomposeunicode")) {
892 precomposed_unicode = git_config_bool(var, value);
893 return 0;
896 /* Add other config variables here and to Documentation/config.txt. */
897 return 0;
900 static int git_default_i18n_config(const char *var, const char *value)
902 if (!strcmp(var, "i18n.commitencoding"))
903 return git_config_string(&git_commit_encoding, var, value);
905 if (!strcmp(var, "i18n.logoutputencoding"))
906 return git_config_string(&git_log_output_encoding, var, value);
908 /* Add other config variables here and to Documentation/config.txt. */
909 return 0;
912 static int git_default_branch_config(const char *var, const char *value)
914 if (!strcmp(var, "branch.autosetupmerge")) {
915 if (value && !strcasecmp(value, "always")) {
916 git_branch_track = BRANCH_TRACK_ALWAYS;
917 return 0;
919 git_branch_track = git_config_bool(var, value);
920 return 0;
922 if (!strcmp(var, "branch.autosetuprebase")) {
923 if (!value)
924 return config_error_nonbool(var);
925 else if (!strcmp(value, "never"))
926 autorebase = AUTOREBASE_NEVER;
927 else if (!strcmp(value, "local"))
928 autorebase = AUTOREBASE_LOCAL;
929 else if (!strcmp(value, "remote"))
930 autorebase = AUTOREBASE_REMOTE;
931 else if (!strcmp(value, "always"))
932 autorebase = AUTOREBASE_ALWAYS;
933 else
934 return error("Malformed value for %s", var);
935 return 0;
938 /* Add other config variables here and to Documentation/config.txt. */
939 return 0;
942 static int git_default_push_config(const char *var, const char *value)
944 if (!strcmp(var, "push.default")) {
945 if (!value)
946 return config_error_nonbool(var);
947 else if (!strcmp(value, "nothing"))
948 push_default = PUSH_DEFAULT_NOTHING;
949 else if (!strcmp(value, "matching"))
950 push_default = PUSH_DEFAULT_MATCHING;
951 else if (!strcmp(value, "simple"))
952 push_default = PUSH_DEFAULT_SIMPLE;
953 else if (!strcmp(value, "upstream"))
954 push_default = PUSH_DEFAULT_UPSTREAM;
955 else if (!strcmp(value, "tracking")) /* deprecated */
956 push_default = PUSH_DEFAULT_UPSTREAM;
957 else if (!strcmp(value, "current"))
958 push_default = PUSH_DEFAULT_CURRENT;
959 else {
960 error("Malformed value for %s: %s", var, value);
961 return error("Must be one of nothing, matching, simple, "
962 "upstream or current.");
964 return 0;
967 /* Add other config variables here and to Documentation/config.txt. */
968 return 0;
971 static int git_default_mailmap_config(const char *var, const char *value)
973 if (!strcmp(var, "mailmap.file"))
974 return git_config_pathname(&git_mailmap_file, var, value);
975 if (!strcmp(var, "mailmap.blob"))
976 return git_config_string(&git_mailmap_blob, var, value);
978 /* Add other config variables here and to Documentation/config.txt. */
979 return 0;
982 int git_default_config(const char *var, const char *value, void *dummy)
984 if (starts_with(var, "core."))
985 return git_default_core_config(var, value);
987 if (starts_with(var, "user."))
988 return git_ident_config(var, value, dummy);
990 if (starts_with(var, "i18n."))
991 return git_default_i18n_config(var, value);
993 if (starts_with(var, "branch."))
994 return git_default_branch_config(var, value);
996 if (starts_with(var, "push."))
997 return git_default_push_config(var, value);
999 if (starts_with(var, "mailmap."))
1000 return git_default_mailmap_config(var, value);
1002 if (starts_with(var, "advice."))
1003 return git_default_advice_config(var, value);
1005 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1006 pager_use_color = git_config_bool(var,value);
1007 return 0;
1010 if (!strcmp(var, "pack.packsizelimit")) {
1011 pack_size_limit_cfg = git_config_ulong(var, value);
1012 return 0;
1014 /* Add other config variables here and to Documentation/config.txt. */
1015 return 0;
1019 * All source specific fields in the union, die_on_error, name and the callbacks
1020 * fgetc, ungetc, ftell of top need to be initialized before calling
1021 * this function.
1023 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1025 int ret;
1027 /* push config-file parsing state stack */
1028 top->prev = cf;
1029 top->linenr = 1;
1030 top->eof = 0;
1031 strbuf_init(&top->value, 1024);
1032 strbuf_init(&top->var, 1024);
1033 cf = top;
1035 ret = git_parse_source(fn, data);
1037 /* pop config-file parsing state stack */
1038 strbuf_release(&top->value);
1039 strbuf_release(&top->var);
1040 cf = top->prev;
1042 return ret;
1045 static int do_config_from_file(config_fn_t fn,
1046 const char *name, const char *path, FILE *f, void *data)
1048 struct config_source top;
1050 top.u.file = f;
1051 top.name = name;
1052 top.path = path;
1053 top.die_on_error = 1;
1054 top.do_fgetc = config_file_fgetc;
1055 top.do_ungetc = config_file_ungetc;
1056 top.do_ftell = config_file_ftell;
1058 return do_config_from(&top, fn, data);
1061 static int git_config_from_stdin(config_fn_t fn, void *data)
1063 return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
1066 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1068 int ret = -1;
1069 FILE *f;
1071 f = fopen(filename, "r");
1072 if (f) {
1073 ret = do_config_from_file(fn, filename, filename, f, data);
1074 fclose(f);
1076 return ret;
1079 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1080 size_t len, void *data)
1082 struct config_source top;
1084 top.u.buf.buf = buf;
1085 top.u.buf.len = len;
1086 top.u.buf.pos = 0;
1087 top.name = name;
1088 top.path = NULL;
1089 top.die_on_error = 0;
1090 top.do_fgetc = config_buf_fgetc;
1091 top.do_ungetc = config_buf_ungetc;
1092 top.do_ftell = config_buf_ftell;
1094 return do_config_from(&top, fn, data);
1097 static int git_config_from_blob_sha1(config_fn_t fn,
1098 const char *name,
1099 const unsigned char *sha1,
1100 void *data)
1102 enum object_type type;
1103 char *buf;
1104 unsigned long size;
1105 int ret;
1107 buf = read_sha1_file(sha1, &type, &size);
1108 if (!buf)
1109 return error("unable to load config blob object '%s'", name);
1110 if (type != OBJ_BLOB) {
1111 free(buf);
1112 return error("reference '%s' does not point to a blob", name);
1115 ret = git_config_from_buf(fn, name, buf, size, data);
1116 free(buf);
1118 return ret;
1121 static int git_config_from_blob_ref(config_fn_t fn,
1122 const char *name,
1123 void *data)
1125 unsigned char sha1[20];
1127 if (get_sha1(name, sha1) < 0)
1128 return error("unable to resolve config blob '%s'", name);
1129 return git_config_from_blob_sha1(fn, name, sha1, data);
1132 const char *git_etc_gitconfig(void)
1134 static const char *system_wide;
1135 if (!system_wide)
1136 system_wide = system_path(ETC_GITCONFIG);
1137 return system_wide;
1140 int git_env_bool(const char *k, int def)
1142 const char *v = getenv(k);
1143 return v ? git_config_bool(k, v) : def;
1146 int git_config_system(void)
1148 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1151 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1153 int ret = 0, found = 0;
1154 char *xdg_config = NULL;
1155 char *user_config = NULL;
1157 home_config_paths(&user_config, &xdg_config, "config");
1159 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1160 ret += git_config_from_file(fn, git_etc_gitconfig(),
1161 data);
1162 found += 1;
1165 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1166 ret += git_config_from_file(fn, xdg_config, data);
1167 found += 1;
1170 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1171 ret += git_config_from_file(fn, user_config, data);
1172 found += 1;
1175 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1176 ret += git_config_from_file(fn, repo_config, data);
1177 found += 1;
1180 switch (git_config_from_parameters(fn, data)) {
1181 case -1: /* error */
1182 die(_("unable to parse command-line config"));
1183 break;
1184 case 0: /* found nothing */
1185 break;
1186 default: /* found at least one item */
1187 found++;
1188 break;
1191 free(xdg_config);
1192 free(user_config);
1193 return ret == 0 ? found : ret;
1196 int git_config_with_options(config_fn_t fn, void *data,
1197 struct git_config_source *config_source,
1198 int respect_includes)
1200 char *repo_config = NULL;
1201 int ret;
1202 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1204 if (respect_includes) {
1205 inc.fn = fn;
1206 inc.data = data;
1207 fn = git_config_include;
1208 data = &inc;
1212 * If we have a specific filename, use it. Otherwise, follow the
1213 * regular lookup sequence.
1215 if (config_source && config_source->use_stdin)
1216 return git_config_from_stdin(fn, data);
1217 else if (config_source && config_source->file)
1218 return git_config_from_file(fn, config_source->file, data);
1219 else if (config_source && config_source->blob)
1220 return git_config_from_blob_ref(fn, config_source->blob, data);
1222 repo_config = git_pathdup("config");
1223 ret = git_config_early(fn, data, repo_config);
1224 if (repo_config)
1225 free(repo_config);
1226 return ret;
1229 static void git_config_raw(config_fn_t fn, void *data)
1231 if (git_config_with_options(fn, data, NULL, 1) < 0)
1233 * git_config_with_options() normally returns only
1234 * positive values, as most errors are fatal, and
1235 * non-fatal potential errors are guarded by "if"
1236 * statements that are entered only when no error is
1237 * possible.
1239 * If we ever encounter a non-fatal error, it means
1240 * something went really wrong and we should stop
1241 * immediately.
1243 die(_("unknown error occured while reading the configuration files"));
1246 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1248 int i, value_index;
1249 struct string_list *values;
1250 struct config_set_element *entry;
1251 struct configset_list *list = &cs->list;
1252 struct key_value_info *kv_info;
1254 for (i = 0; i < list->nr; i++) {
1255 entry = list->items[i].e;
1256 value_index = list->items[i].value_index;
1257 values = &entry->value_list;
1258 if (fn(entry->key, values->items[value_index].string, data) < 0) {
1259 kv_info = values->items[value_index].util;
1260 git_die_config_linenr(entry->key, kv_info->filename, kv_info->linenr);
1265 static void git_config_check_init(void);
1267 void git_config(config_fn_t fn, void *data)
1269 git_config_check_init();
1270 configset_iter(&the_config_set, fn, data);
1273 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1275 struct config_set_element k;
1276 struct config_set_element *found_entry;
1277 char *normalized_key;
1278 int ret;
1280 * `key` may come from the user, so normalize it before using it
1281 * for querying entries from the hashmap.
1283 ret = git_config_parse_key(key, &normalized_key, NULL);
1285 if (ret)
1286 return NULL;
1288 hashmap_entry_init(&k, strhash(normalized_key));
1289 k.key = normalized_key;
1290 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1291 free(normalized_key);
1292 return found_entry;
1295 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1297 struct config_set_element *e;
1298 struct string_list_item *si;
1299 struct configset_list_item *l_item;
1300 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1302 e = configset_find_element(cs, key);
1304 * Since the keys are being fed by git_config*() callback mechanism, they
1305 * are already normalized. So simply add them without any further munging.
1307 if (!e) {
1308 e = xmalloc(sizeof(*e));
1309 hashmap_entry_init(e, strhash(key));
1310 e->key = xstrdup(key);
1311 string_list_init(&e->value_list, 1);
1312 hashmap_add(&cs->config_hash, e);
1314 si = string_list_append_nodup(&e->value_list, value ? xstrdup(value) : NULL);
1316 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1317 l_item = &cs->list.items[cs->list.nr++];
1318 l_item->e = e;
1319 l_item->value_index = e->value_list.nr - 1;
1321 if (cf) {
1322 kv_info->filename = strintern(cf->name);
1323 kv_info->linenr = cf->linenr;
1324 } else {
1325 /* for values read from `git_config_from_parameters()` */
1326 kv_info->filename = NULL;
1327 kv_info->linenr = -1;
1329 si->util = kv_info;
1331 return 0;
1334 static int config_set_element_cmp(const struct config_set_element *e1,
1335 const struct config_set_element *e2, const void *unused)
1337 return strcmp(e1->key, e2->key);
1340 void git_configset_init(struct config_set *cs)
1342 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1343 cs->hash_initialized = 1;
1344 cs->list.nr = 0;
1345 cs->list.alloc = 0;
1346 cs->list.items = NULL;
1349 void git_configset_clear(struct config_set *cs)
1351 struct config_set_element *entry;
1352 struct hashmap_iter iter;
1353 if (!cs->hash_initialized)
1354 return;
1356 hashmap_iter_init(&cs->config_hash, &iter);
1357 while ((entry = hashmap_iter_next(&iter))) {
1358 free(entry->key);
1359 string_list_clear(&entry->value_list, 1);
1361 hashmap_free(&cs->config_hash, 1);
1362 cs->hash_initialized = 0;
1363 free(cs->list.items);
1364 cs->list.nr = 0;
1365 cs->list.alloc = 0;
1366 cs->list.items = NULL;
1369 static int config_set_callback(const char *key, const char *value, void *cb)
1371 struct config_set *cs = cb;
1372 configset_add_value(cs, key, value);
1373 return 0;
1376 int git_configset_add_file(struct config_set *cs, const char *filename)
1378 return git_config_from_file(config_set_callback, filename, cs);
1381 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1383 const struct string_list *values = NULL;
1385 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1386 * queried key in the files of the configset, the value returned will be the last
1387 * value in the value list for that key.
1389 values = git_configset_get_value_multi(cs, key);
1391 if (!values)
1392 return 1;
1393 assert(values->nr > 0);
1394 *value = values->items[values->nr - 1].string;
1395 return 0;
1398 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1400 struct config_set_element *e = configset_find_element(cs, key);
1401 return e ? &e->value_list : NULL;
1404 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1406 const char *value;
1407 if (!git_configset_get_value(cs, key, &value))
1408 return git_config_string(dest, key, value);
1409 else
1410 return 1;
1413 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1415 return git_configset_get_string_const(cs, key, (const char **)dest);
1418 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1420 const char *value;
1421 if (!git_configset_get_value(cs, key, &value)) {
1422 *dest = git_config_int(key, value);
1423 return 0;
1424 } else
1425 return 1;
1428 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1430 const char *value;
1431 if (!git_configset_get_value(cs, key, &value)) {
1432 *dest = git_config_ulong(key, value);
1433 return 0;
1434 } else
1435 return 1;
1438 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1440 const char *value;
1441 if (!git_configset_get_value(cs, key, &value)) {
1442 *dest = git_config_bool(key, value);
1443 return 0;
1444 } else
1445 return 1;
1448 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1449 int *is_bool, int *dest)
1451 const char *value;
1452 if (!git_configset_get_value(cs, key, &value)) {
1453 *dest = git_config_bool_or_int(key, value, is_bool);
1454 return 0;
1455 } else
1456 return 1;
1459 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1461 const char *value;
1462 if (!git_configset_get_value(cs, key, &value)) {
1463 *dest = git_config_maybe_bool(key, value);
1464 if (*dest == -1)
1465 return -1;
1466 return 0;
1467 } else
1468 return 1;
1471 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1473 const char *value;
1474 if (!git_configset_get_value(cs, key, &value))
1475 return git_config_pathname(dest, key, value);
1476 else
1477 return 1;
1480 static void git_config_check_init(void)
1482 if (the_config_set.hash_initialized)
1483 return;
1484 git_configset_init(&the_config_set);
1485 git_config_raw(config_set_callback, &the_config_set);
1488 void git_config_clear(void)
1490 if (!the_config_set.hash_initialized)
1491 return;
1492 git_configset_clear(&the_config_set);
1495 int git_config_get_value(const char *key, const char **value)
1497 git_config_check_init();
1498 return git_configset_get_value(&the_config_set, key, value);
1501 const struct string_list *git_config_get_value_multi(const char *key)
1503 git_config_check_init();
1504 return git_configset_get_value_multi(&the_config_set, key);
1507 int git_config_get_string_const(const char *key, const char **dest)
1509 int ret;
1510 git_config_check_init();
1511 ret = git_configset_get_string_const(&the_config_set, key, dest);
1512 if (ret < 0)
1513 git_die_config(key, NULL);
1514 return ret;
1517 int git_config_get_string(const char *key, char **dest)
1519 git_config_check_init();
1520 return git_config_get_string_const(key, (const char **)dest);
1523 int git_config_get_int(const char *key, int *dest)
1525 git_config_check_init();
1526 return git_configset_get_int(&the_config_set, key, dest);
1529 int git_config_get_ulong(const char *key, unsigned long *dest)
1531 git_config_check_init();
1532 return git_configset_get_ulong(&the_config_set, key, dest);
1535 int git_config_get_bool(const char *key, int *dest)
1537 git_config_check_init();
1538 return git_configset_get_bool(&the_config_set, key, dest);
1541 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1543 git_config_check_init();
1544 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1547 int git_config_get_maybe_bool(const char *key, int *dest)
1549 git_config_check_init();
1550 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1553 int git_config_get_pathname(const char *key, const char **dest)
1555 int ret;
1556 git_config_check_init();
1557 ret = git_configset_get_pathname(&the_config_set, key, dest);
1558 if (ret < 0)
1559 git_die_config(key, NULL);
1560 return ret;
1563 NORETURN
1564 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1566 if (!filename)
1567 die(_("unable to parse '%s' from command-line config"), key);
1568 else
1569 die(_("bad config variable '%s' in file '%s' at line %d"),
1570 key, filename, linenr);
1573 NORETURN __attribute__((format(printf, 2, 3)))
1574 void git_die_config(const char *key, const char *err, ...)
1576 const struct string_list *values;
1577 struct key_value_info *kv_info;
1579 if (err) {
1580 va_list params;
1581 va_start(params, err);
1582 vreportf("error: ", err, params);
1583 va_end(params);
1585 values = git_config_get_value_multi(key);
1586 kv_info = values->items[values->nr - 1].util;
1587 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
1591 * Find all the stuff for git_config_set() below.
1594 static struct {
1595 int baselen;
1596 char *key;
1597 int do_not_match;
1598 regex_t *value_regex;
1599 int multi_replace;
1600 size_t *offset;
1601 unsigned int offset_alloc;
1602 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1603 int seen;
1604 } store;
1606 static int matches(const char *key, const char *value)
1608 return !strcmp(key, store.key) &&
1609 (store.value_regex == NULL ||
1610 (store.do_not_match ^
1611 !regexec(store.value_regex, value, 0, NULL, 0)));
1614 static int store_aux(const char *key, const char *value, void *cb)
1616 const char *ep;
1617 size_t section_len;
1619 switch (store.state) {
1620 case KEY_SEEN:
1621 if (matches(key, value)) {
1622 if (store.seen == 1 && store.multi_replace == 0) {
1623 warning(_("%s has multiple values"), key);
1626 ALLOC_GROW(store.offset, store.seen + 1,
1627 store.offset_alloc);
1629 store.offset[store.seen] = cf->do_ftell(cf);
1630 store.seen++;
1632 break;
1633 case SECTION_SEEN:
1635 * What we are looking for is in store.key (both
1636 * section and var), and its section part is baselen
1637 * long. We found key (again, both section and var).
1638 * We would want to know if this key is in the same
1639 * section as what we are looking for. We already
1640 * know we are in the same section as what should
1641 * hold store.key.
1643 ep = strrchr(key, '.');
1644 section_len = ep - key;
1646 if ((section_len != store.baselen) ||
1647 memcmp(key, store.key, section_len+1)) {
1648 store.state = SECTION_END_SEEN;
1649 break;
1653 * Do not increment matches: this is no match, but we
1654 * just made sure we are in the desired section.
1656 ALLOC_GROW(store.offset, store.seen + 1,
1657 store.offset_alloc);
1658 store.offset[store.seen] = cf->do_ftell(cf);
1659 /* fallthru */
1660 case SECTION_END_SEEN:
1661 case START:
1662 if (matches(key, value)) {
1663 ALLOC_GROW(store.offset, store.seen + 1,
1664 store.offset_alloc);
1665 store.offset[store.seen] = cf->do_ftell(cf);
1666 store.state = KEY_SEEN;
1667 store.seen++;
1668 } else {
1669 if (strrchr(key, '.') - key == store.baselen &&
1670 !strncmp(key, store.key, store.baselen)) {
1671 store.state = SECTION_SEEN;
1672 ALLOC_GROW(store.offset,
1673 store.seen + 1,
1674 store.offset_alloc);
1675 store.offset[store.seen] = cf->do_ftell(cf);
1679 return 0;
1682 static int write_error(const char *filename)
1684 error("failed to write new configuration file %s", filename);
1686 /* Same error code as "failed to rename". */
1687 return 4;
1690 static int store_write_section(int fd, const char *key)
1692 const char *dot;
1693 int i, success;
1694 struct strbuf sb = STRBUF_INIT;
1696 dot = memchr(key, '.', store.baselen);
1697 if (dot) {
1698 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1699 for (i = dot - key + 1; i < store.baselen; i++) {
1700 if (key[i] == '"' || key[i] == '\\')
1701 strbuf_addch(&sb, '\\');
1702 strbuf_addch(&sb, key[i]);
1704 strbuf_addstr(&sb, "\"]\n");
1705 } else {
1706 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1709 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1710 strbuf_release(&sb);
1712 return success;
1715 static int store_write_pair(int fd, const char *key, const char *value)
1717 int i, success;
1718 int length = strlen(key + store.baselen + 1);
1719 const char *quote = "";
1720 struct strbuf sb = STRBUF_INIT;
1723 * Check to see if the value needs to be surrounded with a dq pair.
1724 * Note that problematic characters are always backslash-quoted; this
1725 * check is about not losing leading or trailing SP and strings that
1726 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1727 * configuration parser.
1729 if (value[0] == ' ')
1730 quote = "\"";
1731 for (i = 0; value[i]; i++)
1732 if (value[i] == ';' || value[i] == '#')
1733 quote = "\"";
1734 if (i && value[i - 1] == ' ')
1735 quote = "\"";
1737 strbuf_addf(&sb, "\t%.*s = %s",
1738 length, key + store.baselen + 1, quote);
1740 for (i = 0; value[i]; i++)
1741 switch (value[i]) {
1742 case '\n':
1743 strbuf_addstr(&sb, "\\n");
1744 break;
1745 case '\t':
1746 strbuf_addstr(&sb, "\\t");
1747 break;
1748 case '"':
1749 case '\\':
1750 strbuf_addch(&sb, '\\');
1751 default:
1752 strbuf_addch(&sb, value[i]);
1753 break;
1755 strbuf_addf(&sb, "%s\n", quote);
1757 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1758 strbuf_release(&sb);
1760 return success;
1763 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1764 size_t offset_, int *found_bracket)
1766 size_t equal_offset = size, bracket_offset = size;
1767 ssize_t offset;
1769 contline:
1770 for (offset = offset_-2; offset > 0
1771 && contents[offset] != '\n'; offset--)
1772 switch (contents[offset]) {
1773 case '=': equal_offset = offset; break;
1774 case ']': bracket_offset = offset; break;
1776 if (offset > 0 && contents[offset-1] == '\\') {
1777 offset_ = offset;
1778 goto contline;
1780 if (bracket_offset < equal_offset) {
1781 *found_bracket = 1;
1782 offset = bracket_offset+1;
1783 } else
1784 offset++;
1786 return offset;
1789 int git_config_set_in_file(const char *config_filename,
1790 const char *key, const char *value)
1792 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1795 int git_config_set(const char *key, const char *value)
1797 return git_config_set_multivar(key, value, NULL, 0);
1801 * Auxiliary function to sanity-check and split the key into the section
1802 * identifier and variable name.
1804 * Returns 0 on success, -1 when there is an invalid character in the key and
1805 * -2 if there is no section name in the key.
1807 * store_key - pointer to char* which will hold a copy of the key with
1808 * lowercase section and variable name
1809 * baselen - pointer to int which will hold the length of the
1810 * section + subsection part, can be NULL
1812 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1814 int i, dot, baselen;
1815 const char *last_dot = strrchr(key, '.');
1818 * Since "key" actually contains the section name and the real
1819 * key name separated by a dot, we have to know where the dot is.
1822 if (last_dot == NULL || last_dot == key) {
1823 error("key does not contain a section: %s", key);
1824 return -CONFIG_NO_SECTION_OR_NAME;
1827 if (!last_dot[1]) {
1828 error("key does not contain variable name: %s", key);
1829 return -CONFIG_NO_SECTION_OR_NAME;
1832 baselen = last_dot - key;
1833 if (baselen_)
1834 *baselen_ = baselen;
1837 * Validate the key and while at it, lower case it for matching.
1839 *store_key = xmalloc(strlen(key) + 1);
1841 dot = 0;
1842 for (i = 0; key[i]; i++) {
1843 unsigned char c = key[i];
1844 if (c == '.')
1845 dot = 1;
1846 /* Leave the extended basename untouched.. */
1847 if (!dot || i > baselen) {
1848 if (!iskeychar(c) ||
1849 (i == baselen + 1 && !isalpha(c))) {
1850 error("invalid key: %s", key);
1851 goto out_free_ret_1;
1853 c = tolower(c);
1854 } else if (c == '\n') {
1855 error("invalid key (newline): %s", key);
1856 goto out_free_ret_1;
1858 (*store_key)[i] = c;
1860 (*store_key)[i] = 0;
1862 return 0;
1864 out_free_ret_1:
1865 free(*store_key);
1866 *store_key = NULL;
1867 return -CONFIG_INVALID_KEY;
1871 * If value==NULL, unset in (remove from) config,
1872 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1873 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1874 * else all matching key/values (regardless how many) are removed,
1875 * before the new pair is written.
1877 * Returns 0 on success.
1879 * This function does this:
1881 * - it locks the config file by creating ".git/config.lock"
1883 * - it then parses the config using store_aux() as validator to find
1884 * the position on the key/value pair to replace. If it is to be unset,
1885 * it must be found exactly once.
1887 * - the config file is mmap()ed and the part before the match (if any) is
1888 * written to the lock file, then the changed part and the rest.
1890 * - the config file is removed and the lock file rename()d to it.
1893 int git_config_set_multivar_in_file(const char *config_filename,
1894 const char *key, const char *value,
1895 const char *value_regex, int multi_replace)
1897 int fd = -1, in_fd;
1898 int ret;
1899 struct lock_file *lock = NULL;
1900 char *filename_buf = NULL;
1902 /* parse-key returns negative; flip the sign to feed exit(3) */
1903 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1904 if (ret)
1905 goto out_free;
1907 store.multi_replace = multi_replace;
1909 if (!config_filename)
1910 config_filename = filename_buf = git_pathdup("config");
1913 * The lock serves a purpose in addition to locking: the new
1914 * contents of .git/config will be written into it.
1916 lock = xcalloc(1, sizeof(struct lock_file));
1917 fd = hold_lock_file_for_update(lock, config_filename, 0);
1918 if (fd < 0) {
1919 error("could not lock config file %s: %s", config_filename, strerror(errno));
1920 free(store.key);
1921 ret = CONFIG_NO_LOCK;
1922 goto out_free;
1926 * If .git/config does not exist yet, write a minimal version.
1928 in_fd = open(config_filename, O_RDONLY);
1929 if ( in_fd < 0 ) {
1930 free(store.key);
1932 if ( ENOENT != errno ) {
1933 error("opening %s: %s", config_filename,
1934 strerror(errno));
1935 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1936 goto out_free;
1938 /* if nothing to unset, error out */
1939 if (value == NULL) {
1940 ret = CONFIG_NOTHING_SET;
1941 goto out_free;
1944 store.key = (char *)key;
1945 if (!store_write_section(fd, key) ||
1946 !store_write_pair(fd, key, value))
1947 goto write_err_out;
1948 } else {
1949 struct stat st;
1950 char *contents;
1951 size_t contents_sz, copy_begin, copy_end;
1952 int i, new_line = 0;
1954 if (value_regex == NULL)
1955 store.value_regex = NULL;
1956 else {
1957 if (value_regex[0] == '!') {
1958 store.do_not_match = 1;
1959 value_regex++;
1960 } else
1961 store.do_not_match = 0;
1963 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1964 if (regcomp(store.value_regex, value_regex,
1965 REG_EXTENDED)) {
1966 error("invalid pattern: %s", value_regex);
1967 free(store.value_regex);
1968 ret = CONFIG_INVALID_PATTERN;
1969 goto out_free;
1973 ALLOC_GROW(store.offset, 1, store.offset_alloc);
1974 store.offset[0] = 0;
1975 store.state = START;
1976 store.seen = 0;
1979 * After this, store.offset will contain the *end* offset
1980 * of the last match, or remain at 0 if no match was found.
1981 * As a side effect, we make sure to transform only a valid
1982 * existing config file.
1984 if (git_config_from_file(store_aux, config_filename, NULL)) {
1985 error("invalid config file %s", config_filename);
1986 free(store.key);
1987 if (store.value_regex != NULL) {
1988 regfree(store.value_regex);
1989 free(store.value_regex);
1991 ret = CONFIG_INVALID_FILE;
1992 goto out_free;
1995 free(store.key);
1996 if (store.value_regex != NULL) {
1997 regfree(store.value_regex);
1998 free(store.value_regex);
2001 /* if nothing to unset, or too many matches, error out */
2002 if ((store.seen == 0 && value == NULL) ||
2003 (store.seen > 1 && multi_replace == 0)) {
2004 ret = CONFIG_NOTHING_SET;
2005 goto out_free;
2008 fstat(in_fd, &st);
2009 contents_sz = xsize_t(st.st_size);
2010 contents = xmmap(NULL, contents_sz, PROT_READ,
2011 MAP_PRIVATE, in_fd, 0);
2012 close(in_fd);
2014 if (chmod(lock->filename, st.st_mode & 07777) < 0) {
2015 error("chmod on %s failed: %s",
2016 lock->filename, strerror(errno));
2017 ret = CONFIG_NO_WRITE;
2018 goto out_free;
2021 if (store.seen == 0)
2022 store.seen = 1;
2024 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2025 if (store.offset[i] == 0) {
2026 store.offset[i] = copy_end = contents_sz;
2027 } else if (store.state != KEY_SEEN) {
2028 copy_end = store.offset[i];
2029 } else
2030 copy_end = find_beginning_of_line(
2031 contents, contents_sz,
2032 store.offset[i]-2, &new_line);
2034 if (copy_end > 0 && contents[copy_end-1] != '\n')
2035 new_line = 1;
2037 /* write the first part of the config */
2038 if (copy_end > copy_begin) {
2039 if (write_in_full(fd, contents + copy_begin,
2040 copy_end - copy_begin) <
2041 copy_end - copy_begin)
2042 goto write_err_out;
2043 if (new_line &&
2044 write_str_in_full(fd, "\n") != 1)
2045 goto write_err_out;
2047 copy_begin = store.offset[i];
2050 /* write the pair (value == NULL means unset) */
2051 if (value != NULL) {
2052 if (store.state == START) {
2053 if (!store_write_section(fd, key))
2054 goto write_err_out;
2056 if (!store_write_pair(fd, key, value))
2057 goto write_err_out;
2060 /* write the rest of the config */
2061 if (copy_begin < contents_sz)
2062 if (write_in_full(fd, contents + copy_begin,
2063 contents_sz - copy_begin) <
2064 contents_sz - copy_begin)
2065 goto write_err_out;
2067 munmap(contents, contents_sz);
2070 if (commit_lock_file(lock) < 0) {
2071 error("could not commit config file %s", config_filename);
2072 ret = CONFIG_NO_WRITE;
2073 goto out_free;
2077 * lock is committed, so don't try to roll it back below.
2078 * NOTE: Since lockfile.c keeps a linked list of all created
2079 * lock_file structures, it isn't safe to free(lock). It's
2080 * better to just leave it hanging around.
2082 lock = NULL;
2083 ret = 0;
2085 /* Invalidate the config cache */
2086 git_config_clear();
2088 out_free:
2089 if (lock)
2090 rollback_lock_file(lock);
2091 free(filename_buf);
2092 return ret;
2094 write_err_out:
2095 ret = write_error(lock->filename);
2096 goto out_free;
2100 int git_config_set_multivar(const char *key, const char *value,
2101 const char *value_regex, int multi_replace)
2103 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
2104 multi_replace);
2107 static int section_name_match (const char *buf, const char *name)
2109 int i = 0, j = 0, dot = 0;
2110 if (buf[i] != '[')
2111 return 0;
2112 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2113 if (!dot && isspace(buf[i])) {
2114 dot = 1;
2115 if (name[j++] != '.')
2116 break;
2117 for (i++; isspace(buf[i]); i++)
2118 ; /* do nothing */
2119 if (buf[i] != '"')
2120 break;
2121 continue;
2123 if (buf[i] == '\\' && dot)
2124 i++;
2125 else if (buf[i] == '"' && dot) {
2126 for (i++; isspace(buf[i]); i++)
2127 ; /* do_nothing */
2128 break;
2130 if (buf[i] != name[j++])
2131 break;
2133 if (buf[i] == ']' && name[j] == 0) {
2135 * We match, now just find the right length offset by
2136 * gobbling up any whitespace after it, as well
2138 i++;
2139 for (; buf[i] && isspace(buf[i]); i++)
2140 ; /* do nothing */
2141 return i;
2143 return 0;
2146 static int section_name_is_ok(const char *name)
2148 /* Empty section names are bogus. */
2149 if (!*name)
2150 return 0;
2153 * Before a dot, we must be alphanumeric or dash. After the first dot,
2154 * anything goes, so we can stop checking.
2156 for (; *name && *name != '.'; name++)
2157 if (*name != '-' && !isalnum(*name))
2158 return 0;
2159 return 1;
2162 /* if new_name == NULL, the section is removed instead */
2163 int git_config_rename_section_in_file(const char *config_filename,
2164 const char *old_name, const char *new_name)
2166 int ret = 0, remove = 0;
2167 char *filename_buf = NULL;
2168 struct lock_file *lock;
2169 int out_fd;
2170 char buf[1024];
2171 FILE *config_file;
2172 struct stat st;
2174 if (new_name && !section_name_is_ok(new_name)) {
2175 ret = error("invalid section name: %s", new_name);
2176 goto out;
2179 if (!config_filename)
2180 config_filename = filename_buf = git_pathdup("config");
2182 lock = xcalloc(1, sizeof(struct lock_file));
2183 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2184 if (out_fd < 0) {
2185 ret = error("could not lock config file %s", config_filename);
2186 goto out;
2189 if (!(config_file = fopen(config_filename, "rb"))) {
2190 /* no config file means nothing to rename, no error */
2191 goto unlock_and_out;
2194 fstat(fileno(config_file), &st);
2196 if (chmod(lock->filename, st.st_mode & 07777) < 0) {
2197 ret = error("chmod on %s failed: %s",
2198 lock->filename, strerror(errno));
2199 goto out;
2202 while (fgets(buf, sizeof(buf), config_file)) {
2203 int i;
2204 int length;
2205 char *output = buf;
2206 for (i = 0; buf[i] && isspace(buf[i]); i++)
2207 ; /* do nothing */
2208 if (buf[i] == '[') {
2209 /* it's a section */
2210 int offset = section_name_match(&buf[i], old_name);
2211 if (offset > 0) {
2212 ret++;
2213 if (new_name == NULL) {
2214 remove = 1;
2215 continue;
2217 store.baselen = strlen(new_name);
2218 if (!store_write_section(out_fd, new_name)) {
2219 ret = write_error(lock->filename);
2220 goto out;
2223 * We wrote out the new section, with
2224 * a newline, now skip the old
2225 * section's length
2227 output += offset + i;
2228 if (strlen(output) > 0) {
2230 * More content means there's
2231 * a declaration to put on the
2232 * next line; indent with a
2233 * tab
2235 output -= 1;
2236 output[0] = '\t';
2239 remove = 0;
2241 if (remove)
2242 continue;
2243 length = strlen(output);
2244 if (write_in_full(out_fd, output, length) != length) {
2245 ret = write_error(lock->filename);
2246 goto out;
2249 fclose(config_file);
2250 unlock_and_out:
2251 if (commit_lock_file(lock) < 0)
2252 ret = error("could not commit config file %s", config_filename);
2253 out:
2254 free(filename_buf);
2255 return ret;
2258 int git_config_rename_section(const char *old_name, const char *new_name)
2260 return git_config_rename_section_in_file(NULL, old_name, new_name);
2264 * Call this to report error for your variable that should not
2265 * get a boolean value (i.e. "[my] var" means "true").
2267 #undef config_error_nonbool
2268 int config_error_nonbool(const char *var)
2270 return error("Missing value for '%s'", var);
2273 int parse_config_key(const char *var,
2274 const char *section,
2275 const char **subsection, int *subsection_len,
2276 const char **key)
2278 int section_len = strlen(section);
2279 const char *dot;
2281 /* Does it start with "section." ? */
2282 if (!starts_with(var, section) || var[section_len] != '.')
2283 return -1;
2286 * Find the key; we don't know yet if we have a subsection, but we must
2287 * parse backwards from the end, since the subsection may have dots in
2288 * it, too.
2290 dot = strrchr(var, '.');
2291 *key = dot + 1;
2293 /* Did we have a subsection at all? */
2294 if (dot == var + section_len) {
2295 *subsection = NULL;
2296 *subsection_len = 0;
2298 else {
2299 *subsection = var + section_len + 1;
2300 *subsection_len = dot - *subsection;
2303 return 0;