Git 2.8.3
[git.git] / config.c
blob4c9b447d76e77cc61e55cfd78ec50878f162a989
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 "lockfile.h"
10 #include "exec_cmd.h"
11 #include "strbuf.h"
12 #include "quote.h"
13 #include "hashmap.h"
14 #include "string-list.h"
15 #include "utf8.h"
17 struct config_source {
18 struct config_source *prev;
19 union {
20 FILE *file;
21 struct config_buf {
22 const char *buf;
23 size_t len;
24 size_t pos;
25 } buf;
26 } u;
27 const char *origin_type;
28 const char *name;
29 const char *path;
30 int die_on_error;
31 int linenr;
32 int eof;
33 struct strbuf value;
34 struct strbuf var;
36 int (*do_fgetc)(struct config_source *c);
37 int (*do_ungetc)(int c, struct config_source *conf);
38 long (*do_ftell)(struct config_source *c);
41 static struct config_source *cf;
43 static int zlib_compression_seen;
46 * Default config_set that contains key-value pairs from the usual set of config
47 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
48 * config file and the global /etc/gitconfig)
50 static struct config_set the_config_set;
52 static int config_file_fgetc(struct config_source *conf)
54 return getc_unlocked(conf->u.file);
57 static int config_file_ungetc(int c, struct config_source *conf)
59 return ungetc(c, conf->u.file);
62 static long config_file_ftell(struct config_source *conf)
64 return ftell(conf->u.file);
68 static int config_buf_fgetc(struct config_source *conf)
70 if (conf->u.buf.pos < conf->u.buf.len)
71 return conf->u.buf.buf[conf->u.buf.pos++];
73 return EOF;
76 static int config_buf_ungetc(int c, struct config_source *conf)
78 if (conf->u.buf.pos > 0) {
79 conf->u.buf.pos--;
80 if (conf->u.buf.buf[conf->u.buf.pos] != c)
81 die("BUG: config_buf can only ungetc the same character");
82 return c;
85 return EOF;
88 static long config_buf_ftell(struct config_source *conf)
90 return conf->u.buf.pos;
93 #define MAX_INCLUDE_DEPTH 10
94 static const char include_depth_advice[] =
95 "exceeded maximum include depth (%d) while including\n"
96 " %s\n"
97 "from\n"
98 " %s\n"
99 "Do you have circular includes?";
100 static int handle_path_include(const char *path, struct config_include_data *inc)
102 int ret = 0;
103 struct strbuf buf = STRBUF_INIT;
104 char *expanded;
106 if (!path)
107 return config_error_nonbool("include.path");
109 expanded = expand_user_path(path);
110 if (!expanded)
111 return error("could not expand include path '%s'", path);
112 path = expanded;
115 * Use an absolute path as-is, but interpret relative paths
116 * based on the including config file.
118 if (!is_absolute_path(path)) {
119 char *slash;
121 if (!cf || !cf->path)
122 return error("relative config includes must come from files");
124 slash = find_last_dir_sep(cf->path);
125 if (slash)
126 strbuf_add(&buf, cf->path, slash - cf->path + 1);
127 strbuf_addstr(&buf, path);
128 path = buf.buf;
131 if (!access_or_die(path, R_OK, 0)) {
132 if (++inc->depth > MAX_INCLUDE_DEPTH)
133 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
134 cf && cf->name ? cf->name : "the command line");
135 ret = git_config_from_file(git_config_include, path, inc);
136 inc->depth--;
138 strbuf_release(&buf);
139 free(expanded);
140 return ret;
143 int git_config_include(const char *var, const char *value, void *data)
145 struct config_include_data *inc = data;
146 int ret;
149 * Pass along all values, including "include" directives; this makes it
150 * possible to query information on the includes themselves.
152 ret = inc->fn(var, value, inc->data);
153 if (ret < 0)
154 return ret;
156 if (!strcmp(var, "include.path"))
157 ret = handle_path_include(value, inc);
158 return ret;
161 void git_config_push_parameter(const char *text)
163 struct strbuf env = STRBUF_INIT;
164 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
165 if (old) {
166 strbuf_addstr(&env, old);
167 strbuf_addch(&env, ' ');
169 sq_quote_buf(&env, text);
170 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
171 strbuf_release(&env);
174 int git_config_parse_parameter(const char *text,
175 config_fn_t fn, void *data)
177 const char *value;
178 struct strbuf **pair;
180 pair = strbuf_split_str(text, '=', 2);
181 if (!pair[0])
182 return error("bogus config parameter: %s", text);
184 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
185 strbuf_setlen(pair[0], pair[0]->len - 1);
186 value = pair[1] ? pair[1]->buf : "";
187 } else {
188 value = NULL;
191 strbuf_trim(pair[0]);
192 if (!pair[0]->len) {
193 strbuf_list_free(pair);
194 return error("bogus config parameter: %s", text);
196 strbuf_tolower(pair[0]);
197 if (fn(pair[0]->buf, value, data) < 0) {
198 strbuf_list_free(pair);
199 return -1;
201 strbuf_list_free(pair);
202 return 0;
205 int git_config_from_parameters(config_fn_t fn, void *data)
207 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
208 char *envw;
209 const char **argv = NULL;
210 int nr = 0, alloc = 0;
211 int i;
213 if (!env)
214 return 0;
215 /* sq_dequote will write over it */
216 envw = xstrdup(env);
218 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
219 free(envw);
220 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
223 for (i = 0; i < nr; i++) {
224 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
225 free(argv);
226 free(envw);
227 return -1;
231 free(argv);
232 free(envw);
233 return nr > 0;
236 static int get_next_char(void)
238 int c = cf->do_fgetc(cf);
240 if (c == '\r') {
241 /* DOS like systems */
242 c = cf->do_fgetc(cf);
243 if (c != '\n') {
244 if (c != EOF)
245 cf->do_ungetc(c, cf);
246 c = '\r';
249 if (c == '\n')
250 cf->linenr++;
251 if (c == EOF) {
252 cf->eof = 1;
253 cf->linenr++;
254 c = '\n';
256 return c;
259 static char *parse_value(void)
261 int quote = 0, comment = 0, space = 0;
263 strbuf_reset(&cf->value);
264 for (;;) {
265 int c = get_next_char();
266 if (c == '\n') {
267 if (quote) {
268 cf->linenr--;
269 return NULL;
271 return cf->value.buf;
273 if (comment)
274 continue;
275 if (isspace(c) && !quote) {
276 if (cf->value.len)
277 space++;
278 continue;
280 if (!quote) {
281 if (c == ';' || c == '#') {
282 comment = 1;
283 continue;
286 for (; space; space--)
287 strbuf_addch(&cf->value, ' ');
288 if (c == '\\') {
289 c = get_next_char();
290 switch (c) {
291 case '\n':
292 continue;
293 case 't':
294 c = '\t';
295 break;
296 case 'b':
297 c = '\b';
298 break;
299 case 'n':
300 c = '\n';
301 break;
302 /* Some characters escape as themselves */
303 case '\\': case '"':
304 break;
305 /* Reject unknown escape sequences */
306 default:
307 return NULL;
309 strbuf_addch(&cf->value, c);
310 continue;
312 if (c == '"') {
313 quote = 1-quote;
314 continue;
316 strbuf_addch(&cf->value, c);
320 static inline int iskeychar(int c)
322 return isalnum(c) || c == '-';
325 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
327 int c;
328 char *value;
329 int ret;
331 /* Get the full name */
332 for (;;) {
333 c = get_next_char();
334 if (cf->eof)
335 break;
336 if (!iskeychar(c))
337 break;
338 strbuf_addch(name, tolower(c));
341 while (c == ' ' || c == '\t')
342 c = get_next_char();
344 value = NULL;
345 if (c != '\n') {
346 if (c != '=')
347 return -1;
348 value = parse_value();
349 if (!value)
350 return -1;
353 * We already consumed the \n, but we need linenr to point to
354 * the line we just parsed during the call to fn to get
355 * accurate line number in error messages.
357 cf->linenr--;
358 ret = fn(name->buf, value, data);
359 cf->linenr++;
360 return ret;
363 static int get_extended_base_var(struct strbuf *name, int c)
365 do {
366 if (c == '\n')
367 goto error_incomplete_line;
368 c = get_next_char();
369 } while (isspace(c));
371 /* We require the format to be '[base "extension"]' */
372 if (c != '"')
373 return -1;
374 strbuf_addch(name, '.');
376 for (;;) {
377 int c = get_next_char();
378 if (c == '\n')
379 goto error_incomplete_line;
380 if (c == '"')
381 break;
382 if (c == '\\') {
383 c = get_next_char();
384 if (c == '\n')
385 goto error_incomplete_line;
387 strbuf_addch(name, c);
390 /* Final ']' */
391 if (get_next_char() != ']')
392 return -1;
393 return 0;
394 error_incomplete_line:
395 cf->linenr--;
396 return -1;
399 static int get_base_var(struct strbuf *name)
401 for (;;) {
402 int c = get_next_char();
403 if (cf->eof)
404 return -1;
405 if (c == ']')
406 return 0;
407 if (isspace(c))
408 return get_extended_base_var(name, c);
409 if (!iskeychar(c) && c != '.')
410 return -1;
411 strbuf_addch(name, tolower(c));
415 static int git_parse_source(config_fn_t fn, void *data)
417 int comment = 0;
418 int baselen = 0;
419 struct strbuf *var = &cf->var;
421 /* U+FEFF Byte Order Mark in UTF8 */
422 const char *bomptr = utf8_bom;
424 for (;;) {
425 int c = get_next_char();
426 if (bomptr && *bomptr) {
427 /* We are at the file beginning; skip UTF8-encoded BOM
428 * if present. Sane editors won't put this in on their
429 * own, but e.g. Windows Notepad will do it happily. */
430 if (c == (*bomptr & 0377)) {
431 bomptr++;
432 continue;
433 } else {
434 /* Do not tolerate partial BOM. */
435 if (bomptr != utf8_bom)
436 break;
437 /* No BOM at file beginning. Cool. */
438 bomptr = NULL;
441 if (c == '\n') {
442 if (cf->eof)
443 return 0;
444 comment = 0;
445 continue;
447 if (comment || isspace(c))
448 continue;
449 if (c == '#' || c == ';') {
450 comment = 1;
451 continue;
453 if (c == '[') {
454 /* Reset prior to determining a new stem */
455 strbuf_reset(var);
456 if (get_base_var(var) < 0 || var->len < 1)
457 break;
458 strbuf_addch(var, '.');
459 baselen = var->len;
460 continue;
462 if (!isalpha(c))
463 break;
465 * Truncate the var name back to the section header
466 * stem prior to grabbing the suffix part of the name
467 * and the value.
469 strbuf_setlen(var, baselen);
470 strbuf_addch(var, tolower(c));
471 if (get_value(fn, data, var) < 0)
472 break;
474 if (cf->die_on_error)
475 die(_("bad config line %d in %s %s"), cf->linenr, cf->origin_type, cf->name);
476 else
477 return error(_("bad config line %d in %s %s"), cf->linenr, cf->origin_type, cf->name);
480 static int parse_unit_factor(const char *end, uintmax_t *val)
482 if (!*end)
483 return 1;
484 else if (!strcasecmp(end, "k")) {
485 *val *= 1024;
486 return 1;
488 else if (!strcasecmp(end, "m")) {
489 *val *= 1024 * 1024;
490 return 1;
492 else if (!strcasecmp(end, "g")) {
493 *val *= 1024 * 1024 * 1024;
494 return 1;
496 return 0;
499 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
501 if (value && *value) {
502 char *end;
503 intmax_t val;
504 uintmax_t uval;
505 uintmax_t factor = 1;
507 errno = 0;
508 val = strtoimax(value, &end, 0);
509 if (errno == ERANGE)
510 return 0;
511 if (!parse_unit_factor(end, &factor)) {
512 errno = EINVAL;
513 return 0;
515 uval = labs(val);
516 uval *= factor;
517 if (uval > max || labs(val) > uval) {
518 errno = ERANGE;
519 return 0;
521 val *= factor;
522 *ret = val;
523 return 1;
525 errno = EINVAL;
526 return 0;
529 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
531 if (value && *value) {
532 char *end;
533 uintmax_t val;
534 uintmax_t oldval;
536 errno = 0;
537 val = strtoumax(value, &end, 0);
538 if (errno == ERANGE)
539 return 0;
540 oldval = val;
541 if (!parse_unit_factor(end, &val)) {
542 errno = EINVAL;
543 return 0;
545 if (val > max || oldval > val) {
546 errno = ERANGE;
547 return 0;
549 *ret = val;
550 return 1;
552 errno = EINVAL;
553 return 0;
556 static int git_parse_int(const char *value, int *ret)
558 intmax_t tmp;
559 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
560 return 0;
561 *ret = tmp;
562 return 1;
565 static int git_parse_int64(const char *value, int64_t *ret)
567 intmax_t tmp;
568 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
569 return 0;
570 *ret = tmp;
571 return 1;
574 int git_parse_ulong(const char *value, unsigned long *ret)
576 uintmax_t tmp;
577 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
578 return 0;
579 *ret = tmp;
580 return 1;
583 NORETURN
584 static void die_bad_number(const char *name, const char *value)
586 const char *reason = errno == ERANGE ?
587 "out of range" :
588 "invalid unit";
589 if (!value)
590 value = "";
592 if (cf && cf->origin_type && cf->name)
593 die(_("bad numeric config value '%s' for '%s' in %s %s: %s"),
594 value, name, cf->origin_type, cf->name, reason);
595 die(_("bad numeric config value '%s' for '%s': %s"), value, name, reason);
598 int git_config_int(const char *name, const char *value)
600 int ret;
601 if (!git_parse_int(value, &ret))
602 die_bad_number(name, value);
603 return ret;
606 int64_t git_config_int64(const char *name, const char *value)
608 int64_t ret;
609 if (!git_parse_int64(value, &ret))
610 die_bad_number(name, value);
611 return ret;
614 unsigned long git_config_ulong(const char *name, const char *value)
616 unsigned long ret;
617 if (!git_parse_ulong(value, &ret))
618 die_bad_number(name, value);
619 return ret;
622 int git_parse_maybe_bool(const char *value)
624 if (!value)
625 return 1;
626 if (!*value)
627 return 0;
628 if (!strcasecmp(value, "true")
629 || !strcasecmp(value, "yes")
630 || !strcasecmp(value, "on"))
631 return 1;
632 if (!strcasecmp(value, "false")
633 || !strcasecmp(value, "no")
634 || !strcasecmp(value, "off"))
635 return 0;
636 return -1;
639 int git_config_maybe_bool(const char *name, const char *value)
641 int v = git_parse_maybe_bool(value);
642 if (0 <= v)
643 return v;
644 if (git_parse_int(value, &v))
645 return !!v;
646 return -1;
649 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
651 int v = git_parse_maybe_bool(value);
652 if (0 <= v) {
653 *is_bool = 1;
654 return v;
656 *is_bool = 0;
657 return git_config_int(name, value);
660 int git_config_bool(const char *name, const char *value)
662 int discard;
663 return !!git_config_bool_or_int(name, value, &discard);
666 int git_config_string(const char **dest, const char *var, const char *value)
668 if (!value)
669 return config_error_nonbool(var);
670 *dest = xstrdup(value);
671 return 0;
674 int git_config_pathname(const char **dest, const char *var, const char *value)
676 if (!value)
677 return config_error_nonbool(var);
678 *dest = expand_user_path(value);
679 if (!*dest)
680 die(_("failed to expand user dir in: '%s'"), value);
681 return 0;
684 static int git_default_core_config(const char *var, const char *value)
686 /* This needs a better name */
687 if (!strcmp(var, "core.filemode")) {
688 trust_executable_bit = git_config_bool(var, value);
689 return 0;
691 if (!strcmp(var, "core.trustctime")) {
692 trust_ctime = git_config_bool(var, value);
693 return 0;
695 if (!strcmp(var, "core.checkstat")) {
696 if (!strcasecmp(value, "default"))
697 check_stat = 1;
698 else if (!strcasecmp(value, "minimal"))
699 check_stat = 0;
702 if (!strcmp(var, "core.quotepath")) {
703 quote_path_fully = git_config_bool(var, value);
704 return 0;
707 if (!strcmp(var, "core.symlinks")) {
708 has_symlinks = git_config_bool(var, value);
709 return 0;
712 if (!strcmp(var, "core.ignorecase")) {
713 ignore_case = git_config_bool(var, value);
714 return 0;
717 if (!strcmp(var, "core.attributesfile"))
718 return git_config_pathname(&git_attributes_file, var, value);
720 if (!strcmp(var, "core.bare")) {
721 is_bare_repository_cfg = git_config_bool(var, value);
722 return 0;
725 if (!strcmp(var, "core.ignorestat")) {
726 assume_unchanged = git_config_bool(var, value);
727 return 0;
730 if (!strcmp(var, "core.prefersymlinkrefs")) {
731 prefer_symlink_refs = git_config_bool(var, value);
732 return 0;
735 if (!strcmp(var, "core.logallrefupdates")) {
736 log_all_ref_updates = git_config_bool(var, value);
737 return 0;
740 if (!strcmp(var, "core.warnambiguousrefs")) {
741 warn_ambiguous_refs = git_config_bool(var, value);
742 return 0;
745 if (!strcmp(var, "core.abbrev")) {
746 int abbrev = git_config_int(var, value);
747 if (abbrev < minimum_abbrev || abbrev > 40)
748 return -1;
749 default_abbrev = abbrev;
750 return 0;
753 if (!strcmp(var, "core.loosecompression")) {
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 zlib_compression_level = level;
760 zlib_compression_seen = 1;
761 return 0;
764 if (!strcmp(var, "core.compression")) {
765 int level = git_config_int(var, value);
766 if (level == -1)
767 level = Z_DEFAULT_COMPRESSION;
768 else if (level < 0 || level > Z_BEST_COMPRESSION)
769 die(_("bad zlib compression level %d"), level);
770 core_compression_level = level;
771 core_compression_seen = 1;
772 if (!zlib_compression_seen)
773 zlib_compression_level = level;
774 return 0;
777 if (!strcmp(var, "core.packedgitwindowsize")) {
778 int pgsz_x2 = getpagesize() * 2;
779 packed_git_window_size = git_config_ulong(var, value);
781 /* This value must be multiple of (pagesize * 2) */
782 packed_git_window_size /= pgsz_x2;
783 if (packed_git_window_size < 1)
784 packed_git_window_size = 1;
785 packed_git_window_size *= pgsz_x2;
786 return 0;
789 if (!strcmp(var, "core.bigfilethreshold")) {
790 big_file_threshold = git_config_ulong(var, value);
791 return 0;
794 if (!strcmp(var, "core.packedgitlimit")) {
795 packed_git_limit = git_config_ulong(var, value);
796 return 0;
799 if (!strcmp(var, "core.deltabasecachelimit")) {
800 delta_base_cache_limit = git_config_ulong(var, value);
801 return 0;
804 if (!strcmp(var, "core.autocrlf")) {
805 if (value && !strcasecmp(value, "input")) {
806 if (core_eol == EOL_CRLF)
807 return error("core.autocrlf=input conflicts with core.eol=crlf");
808 auto_crlf = AUTO_CRLF_INPUT;
809 return 0;
811 auto_crlf = git_config_bool(var, value);
812 return 0;
815 if (!strcmp(var, "core.safecrlf")) {
816 if (value && !strcasecmp(value, "warn")) {
817 safe_crlf = SAFE_CRLF_WARN;
818 return 0;
820 safe_crlf = git_config_bool(var, value);
821 return 0;
824 if (!strcmp(var, "core.eol")) {
825 if (value && !strcasecmp(value, "lf"))
826 core_eol = EOL_LF;
827 else if (value && !strcasecmp(value, "crlf"))
828 core_eol = EOL_CRLF;
829 else if (value && !strcasecmp(value, "native"))
830 core_eol = EOL_NATIVE;
831 else
832 core_eol = EOL_UNSET;
833 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
834 return error("core.autocrlf=input conflicts with core.eol=crlf");
835 return 0;
838 if (!strcmp(var, "core.notesref")) {
839 notes_ref_name = xstrdup(value);
840 return 0;
843 if (!strcmp(var, "core.pager"))
844 return git_config_string(&pager_program, var, value);
846 if (!strcmp(var, "core.editor"))
847 return git_config_string(&editor_program, var, value);
849 if (!strcmp(var, "core.commentchar")) {
850 if (!value)
851 return config_error_nonbool(var);
852 else if (!strcasecmp(value, "auto"))
853 auto_comment_line_char = 1;
854 else if (value[0] && !value[1]) {
855 comment_line_char = value[0];
856 auto_comment_line_char = 0;
857 } else
858 return error("core.commentChar should only be one character");
859 return 0;
862 if (!strcmp(var, "core.askpass"))
863 return git_config_string(&askpass_program, var, value);
865 if (!strcmp(var, "core.excludesfile"))
866 return git_config_pathname(&excludes_file, var, value);
868 if (!strcmp(var, "core.whitespace")) {
869 if (!value)
870 return config_error_nonbool(var);
871 whitespace_rule_cfg = parse_whitespace_rule(value);
872 return 0;
875 if (!strcmp(var, "core.fsyncobjectfiles")) {
876 fsync_object_files = git_config_bool(var, value);
877 return 0;
880 if (!strcmp(var, "core.preloadindex")) {
881 core_preload_index = git_config_bool(var, value);
882 return 0;
885 if (!strcmp(var, "core.createobject")) {
886 if (!strcmp(value, "rename"))
887 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
888 else if (!strcmp(value, "link"))
889 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
890 else
891 die(_("invalid mode for object creation: %s"), value);
892 return 0;
895 if (!strcmp(var, "core.sparsecheckout")) {
896 core_apply_sparse_checkout = git_config_bool(var, value);
897 return 0;
900 if (!strcmp(var, "core.precomposeunicode")) {
901 precomposed_unicode = git_config_bool(var, value);
902 return 0;
905 if (!strcmp(var, "core.protecthfs")) {
906 protect_hfs = git_config_bool(var, value);
907 return 0;
910 if (!strcmp(var, "core.protectntfs")) {
911 protect_ntfs = git_config_bool(var, value);
912 return 0;
915 /* Add other config variables here and to Documentation/config.txt. */
916 return 0;
919 static int git_default_i18n_config(const char *var, const char *value)
921 if (!strcmp(var, "i18n.commitencoding"))
922 return git_config_string(&git_commit_encoding, var, value);
924 if (!strcmp(var, "i18n.logoutputencoding"))
925 return git_config_string(&git_log_output_encoding, var, value);
927 /* Add other config variables here and to Documentation/config.txt. */
928 return 0;
931 static int git_default_branch_config(const char *var, const char *value)
933 if (!strcmp(var, "branch.autosetupmerge")) {
934 if (value && !strcasecmp(value, "always")) {
935 git_branch_track = BRANCH_TRACK_ALWAYS;
936 return 0;
938 git_branch_track = git_config_bool(var, value);
939 return 0;
941 if (!strcmp(var, "branch.autosetuprebase")) {
942 if (!value)
943 return config_error_nonbool(var);
944 else if (!strcmp(value, "never"))
945 autorebase = AUTOREBASE_NEVER;
946 else if (!strcmp(value, "local"))
947 autorebase = AUTOREBASE_LOCAL;
948 else if (!strcmp(value, "remote"))
949 autorebase = AUTOREBASE_REMOTE;
950 else if (!strcmp(value, "always"))
951 autorebase = AUTOREBASE_ALWAYS;
952 else
953 return error("malformed value for %s", var);
954 return 0;
957 /* Add other config variables here and to Documentation/config.txt. */
958 return 0;
961 static int git_default_push_config(const char *var, const char *value)
963 if (!strcmp(var, "push.default")) {
964 if (!value)
965 return config_error_nonbool(var);
966 else if (!strcmp(value, "nothing"))
967 push_default = PUSH_DEFAULT_NOTHING;
968 else if (!strcmp(value, "matching"))
969 push_default = PUSH_DEFAULT_MATCHING;
970 else if (!strcmp(value, "simple"))
971 push_default = PUSH_DEFAULT_SIMPLE;
972 else if (!strcmp(value, "upstream"))
973 push_default = PUSH_DEFAULT_UPSTREAM;
974 else if (!strcmp(value, "tracking")) /* deprecated */
975 push_default = PUSH_DEFAULT_UPSTREAM;
976 else if (!strcmp(value, "current"))
977 push_default = PUSH_DEFAULT_CURRENT;
978 else {
979 error("malformed value for %s: %s", var, value);
980 return error("Must be one of nothing, matching, simple, "
981 "upstream or current.");
983 return 0;
986 /* Add other config variables here and to Documentation/config.txt. */
987 return 0;
990 static int git_default_mailmap_config(const char *var, const char *value)
992 if (!strcmp(var, "mailmap.file"))
993 return git_config_pathname(&git_mailmap_file, var, value);
994 if (!strcmp(var, "mailmap.blob"))
995 return git_config_string(&git_mailmap_blob, var, value);
997 /* Add other config variables here and to Documentation/config.txt. */
998 return 0;
1001 int git_default_config(const char *var, const char *value, void *dummy)
1003 if (starts_with(var, "core."))
1004 return git_default_core_config(var, value);
1006 if (starts_with(var, "user."))
1007 return git_ident_config(var, value, dummy);
1009 if (starts_with(var, "i18n."))
1010 return git_default_i18n_config(var, value);
1012 if (starts_with(var, "branch."))
1013 return git_default_branch_config(var, value);
1015 if (starts_with(var, "push."))
1016 return git_default_push_config(var, value);
1018 if (starts_with(var, "mailmap."))
1019 return git_default_mailmap_config(var, value);
1021 if (starts_with(var, "advice."))
1022 return git_default_advice_config(var, value);
1024 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1025 pager_use_color = git_config_bool(var,value);
1026 return 0;
1029 if (!strcmp(var, "pack.packsizelimit")) {
1030 pack_size_limit_cfg = git_config_ulong(var, value);
1031 return 0;
1033 /* Add other config variables here and to Documentation/config.txt. */
1034 return 0;
1038 * All source specific fields in the union, die_on_error, name and the callbacks
1039 * fgetc, ungetc, ftell of top need to be initialized before calling
1040 * this function.
1042 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1044 int ret;
1046 /* push config-file parsing state stack */
1047 top->prev = cf;
1048 top->linenr = 1;
1049 top->eof = 0;
1050 strbuf_init(&top->value, 1024);
1051 strbuf_init(&top->var, 1024);
1052 cf = top;
1054 ret = git_parse_source(fn, data);
1056 /* pop config-file parsing state stack */
1057 strbuf_release(&top->value);
1058 strbuf_release(&top->var);
1059 cf = top->prev;
1061 return ret;
1064 static int do_config_from_file(config_fn_t fn,
1065 const char *origin_type, const char *name, const char *path, FILE *f,
1066 void *data)
1068 struct config_source top;
1070 top.u.file = f;
1071 top.origin_type = origin_type;
1072 top.name = name;
1073 top.path = path;
1074 top.die_on_error = 1;
1075 top.do_fgetc = config_file_fgetc;
1076 top.do_ungetc = config_file_ungetc;
1077 top.do_ftell = config_file_ftell;
1079 return do_config_from(&top, fn, data);
1082 static int git_config_from_stdin(config_fn_t fn, void *data)
1084 return do_config_from_file(fn, "standard input", "", NULL, stdin, data);
1087 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1089 int ret = -1;
1090 FILE *f;
1092 f = fopen(filename, "r");
1093 if (f) {
1094 flockfile(f);
1095 ret = do_config_from_file(fn, "file", filename, filename, f, data);
1096 funlockfile(f);
1097 fclose(f);
1099 return ret;
1102 int git_config_from_mem(config_fn_t fn, const char *origin_type,
1103 const char *name, const char *buf, size_t len, void *data)
1105 struct config_source top;
1107 top.u.buf.buf = buf;
1108 top.u.buf.len = len;
1109 top.u.buf.pos = 0;
1110 top.origin_type = origin_type;
1111 top.name = name;
1112 top.path = NULL;
1113 top.die_on_error = 0;
1114 top.do_fgetc = config_buf_fgetc;
1115 top.do_ungetc = config_buf_ungetc;
1116 top.do_ftell = config_buf_ftell;
1118 return do_config_from(&top, fn, data);
1121 static int git_config_from_blob_sha1(config_fn_t fn,
1122 const char *name,
1123 const unsigned char *sha1,
1124 void *data)
1126 enum object_type type;
1127 char *buf;
1128 unsigned long size;
1129 int ret;
1131 buf = read_sha1_file(sha1, &type, &size);
1132 if (!buf)
1133 return error("unable to load config blob object '%s'", name);
1134 if (type != OBJ_BLOB) {
1135 free(buf);
1136 return error("reference '%s' does not point to a blob", name);
1139 ret = git_config_from_mem(fn, "blob", name, buf, size, data);
1140 free(buf);
1142 return ret;
1145 static int git_config_from_blob_ref(config_fn_t fn,
1146 const char *name,
1147 void *data)
1149 unsigned char sha1[20];
1151 if (get_sha1(name, sha1) < 0)
1152 return error("unable to resolve config blob '%s'", name);
1153 return git_config_from_blob_sha1(fn, name, sha1, data);
1156 const char *git_etc_gitconfig(void)
1158 static const char *system_wide;
1159 if (!system_wide)
1160 system_wide = system_path(ETC_GITCONFIG);
1161 return system_wide;
1165 * Parse environment variable 'k' as a boolean (in various
1166 * possible spellings); if missing, use the default value 'def'.
1168 int git_env_bool(const char *k, int def)
1170 const char *v = getenv(k);
1171 return v ? git_config_bool(k, v) : def;
1175 * Parse environment variable 'k' as ulong with possibly a unit
1176 * suffix; if missing, use the default value 'val'.
1178 unsigned long git_env_ulong(const char *k, unsigned long val)
1180 const char *v = getenv(k);
1181 if (v && !git_parse_ulong(v, &val))
1182 die("failed to parse %s", k);
1183 return val;
1186 int git_config_system(void)
1188 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1191 static int do_git_config_sequence(config_fn_t fn, void *data)
1193 int ret = 0, found = 0;
1194 char *xdg_config = xdg_config_home("config");
1195 char *user_config = expand_user_path("~/.gitconfig");
1196 char *repo_config = git_pathdup("config");
1198 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1199 ret += git_config_from_file(fn, git_etc_gitconfig(),
1200 data);
1201 found += 1;
1204 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1205 ret += git_config_from_file(fn, xdg_config, data);
1206 found += 1;
1209 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1210 ret += git_config_from_file(fn, user_config, data);
1211 found += 1;
1214 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1215 ret += git_config_from_file(fn, repo_config, data);
1216 found += 1;
1219 switch (git_config_from_parameters(fn, data)) {
1220 case -1: /* error */
1221 die(_("unable to parse command-line config"));
1222 break;
1223 case 0: /* found nothing */
1224 break;
1225 default: /* found at least one item */
1226 found++;
1227 break;
1230 free(xdg_config);
1231 free(user_config);
1232 free(repo_config);
1233 return ret == 0 ? found : ret;
1236 int git_config_with_options(config_fn_t fn, void *data,
1237 struct git_config_source *config_source,
1238 int respect_includes)
1240 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1242 if (respect_includes) {
1243 inc.fn = fn;
1244 inc.data = data;
1245 fn = git_config_include;
1246 data = &inc;
1250 * If we have a specific filename, use it. Otherwise, follow the
1251 * regular lookup sequence.
1253 if (config_source && config_source->use_stdin)
1254 return git_config_from_stdin(fn, data);
1255 else if (config_source && config_source->file)
1256 return git_config_from_file(fn, config_source->file, data);
1257 else if (config_source && config_source->blob)
1258 return git_config_from_blob_ref(fn, config_source->blob, data);
1260 return do_git_config_sequence(fn, data);
1263 static void git_config_raw(config_fn_t fn, void *data)
1265 if (git_config_with_options(fn, data, NULL, 1) < 0)
1267 * git_config_with_options() normally returns only
1268 * positive values, as most errors are fatal, and
1269 * non-fatal potential errors are guarded by "if"
1270 * statements that are entered only when no error is
1271 * possible.
1273 * If we ever encounter a non-fatal error, it means
1274 * something went really wrong and we should stop
1275 * immediately.
1277 die(_("unknown error occured while reading the configuration files"));
1280 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1282 int i, value_index;
1283 struct string_list *values;
1284 struct config_set_element *entry;
1285 struct configset_list *list = &cs->list;
1286 struct key_value_info *kv_info;
1288 for (i = 0; i < list->nr; i++) {
1289 entry = list->items[i].e;
1290 value_index = list->items[i].value_index;
1291 values = &entry->value_list;
1292 if (fn(entry->key, values->items[value_index].string, data) < 0) {
1293 kv_info = values->items[value_index].util;
1294 git_die_config_linenr(entry->key, kv_info->filename, kv_info->linenr);
1299 static void git_config_check_init(void);
1301 void git_config(config_fn_t fn, void *data)
1303 git_config_check_init();
1304 configset_iter(&the_config_set, fn, data);
1307 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1309 struct config_set_element k;
1310 struct config_set_element *found_entry;
1311 char *normalized_key;
1313 * `key` may come from the user, so normalize it before using it
1314 * for querying entries from the hashmap.
1316 if (git_config_parse_key(key, &normalized_key, NULL))
1317 return NULL;
1319 hashmap_entry_init(&k, strhash(normalized_key));
1320 k.key = normalized_key;
1321 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1322 free(normalized_key);
1323 return found_entry;
1326 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1328 struct config_set_element *e;
1329 struct string_list_item *si;
1330 struct configset_list_item *l_item;
1331 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1333 e = configset_find_element(cs, key);
1335 * Since the keys are being fed by git_config*() callback mechanism, they
1336 * are already normalized. So simply add them without any further munging.
1338 if (!e) {
1339 e = xmalloc(sizeof(*e));
1340 hashmap_entry_init(e, strhash(key));
1341 e->key = xstrdup(key);
1342 string_list_init(&e->value_list, 1);
1343 hashmap_add(&cs->config_hash, e);
1345 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1347 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1348 l_item = &cs->list.items[cs->list.nr++];
1349 l_item->e = e;
1350 l_item->value_index = e->value_list.nr - 1;
1352 if (cf) {
1353 kv_info->filename = strintern(cf->name);
1354 kv_info->linenr = cf->linenr;
1355 } else {
1356 /* for values read from `git_config_from_parameters()` */
1357 kv_info->filename = NULL;
1358 kv_info->linenr = -1;
1360 si->util = kv_info;
1362 return 0;
1365 static int config_set_element_cmp(const struct config_set_element *e1,
1366 const struct config_set_element *e2, const void *unused)
1368 return strcmp(e1->key, e2->key);
1371 void git_configset_init(struct config_set *cs)
1373 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1374 cs->hash_initialized = 1;
1375 cs->list.nr = 0;
1376 cs->list.alloc = 0;
1377 cs->list.items = NULL;
1380 void git_configset_clear(struct config_set *cs)
1382 struct config_set_element *entry;
1383 struct hashmap_iter iter;
1384 if (!cs->hash_initialized)
1385 return;
1387 hashmap_iter_init(&cs->config_hash, &iter);
1388 while ((entry = hashmap_iter_next(&iter))) {
1389 free(entry->key);
1390 string_list_clear(&entry->value_list, 1);
1392 hashmap_free(&cs->config_hash, 1);
1393 cs->hash_initialized = 0;
1394 free(cs->list.items);
1395 cs->list.nr = 0;
1396 cs->list.alloc = 0;
1397 cs->list.items = NULL;
1400 static int config_set_callback(const char *key, const char *value, void *cb)
1402 struct config_set *cs = cb;
1403 configset_add_value(cs, key, value);
1404 return 0;
1407 int git_configset_add_file(struct config_set *cs, const char *filename)
1409 return git_config_from_file(config_set_callback, filename, cs);
1412 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1414 const struct string_list *values = NULL;
1416 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1417 * queried key in the files of the configset, the value returned will be the last
1418 * value in the value list for that key.
1420 values = git_configset_get_value_multi(cs, key);
1422 if (!values)
1423 return 1;
1424 assert(values->nr > 0);
1425 *value = values->items[values->nr - 1].string;
1426 return 0;
1429 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1431 struct config_set_element *e = configset_find_element(cs, key);
1432 return e ? &e->value_list : NULL;
1435 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1437 const char *value;
1438 if (!git_configset_get_value(cs, key, &value))
1439 return git_config_string(dest, key, value);
1440 else
1441 return 1;
1444 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1446 return git_configset_get_string_const(cs, key, (const char **)dest);
1449 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1451 const char *value;
1452 if (!git_configset_get_value(cs, key, &value)) {
1453 *dest = git_config_int(key, value);
1454 return 0;
1455 } else
1456 return 1;
1459 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1461 const char *value;
1462 if (!git_configset_get_value(cs, key, &value)) {
1463 *dest = git_config_ulong(key, value);
1464 return 0;
1465 } else
1466 return 1;
1469 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1471 const char *value;
1472 if (!git_configset_get_value(cs, key, &value)) {
1473 *dest = git_config_bool(key, value);
1474 return 0;
1475 } else
1476 return 1;
1479 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1480 int *is_bool, int *dest)
1482 const char *value;
1483 if (!git_configset_get_value(cs, key, &value)) {
1484 *dest = git_config_bool_or_int(key, value, is_bool);
1485 return 0;
1486 } else
1487 return 1;
1490 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1492 const char *value;
1493 if (!git_configset_get_value(cs, key, &value)) {
1494 *dest = git_config_maybe_bool(key, value);
1495 if (*dest == -1)
1496 return -1;
1497 return 0;
1498 } else
1499 return 1;
1502 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1504 const char *value;
1505 if (!git_configset_get_value(cs, key, &value))
1506 return git_config_pathname(dest, key, value);
1507 else
1508 return 1;
1511 static void git_config_check_init(void)
1513 if (the_config_set.hash_initialized)
1514 return;
1515 git_configset_init(&the_config_set);
1516 git_config_raw(config_set_callback, &the_config_set);
1519 void git_config_clear(void)
1521 if (!the_config_set.hash_initialized)
1522 return;
1523 git_configset_clear(&the_config_set);
1526 int git_config_get_value(const char *key, const char **value)
1528 git_config_check_init();
1529 return git_configset_get_value(&the_config_set, key, value);
1532 const struct string_list *git_config_get_value_multi(const char *key)
1534 git_config_check_init();
1535 return git_configset_get_value_multi(&the_config_set, key);
1538 int git_config_get_string_const(const char *key, const char **dest)
1540 int ret;
1541 git_config_check_init();
1542 ret = git_configset_get_string_const(&the_config_set, key, dest);
1543 if (ret < 0)
1544 git_die_config(key, NULL);
1545 return ret;
1548 int git_config_get_string(const char *key, char **dest)
1550 git_config_check_init();
1551 return git_config_get_string_const(key, (const char **)dest);
1554 int git_config_get_int(const char *key, int *dest)
1556 git_config_check_init();
1557 return git_configset_get_int(&the_config_set, key, dest);
1560 int git_config_get_ulong(const char *key, unsigned long *dest)
1562 git_config_check_init();
1563 return git_configset_get_ulong(&the_config_set, key, dest);
1566 int git_config_get_bool(const char *key, int *dest)
1568 git_config_check_init();
1569 return git_configset_get_bool(&the_config_set, key, dest);
1572 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1574 git_config_check_init();
1575 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1578 int git_config_get_maybe_bool(const char *key, int *dest)
1580 git_config_check_init();
1581 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1584 int git_config_get_pathname(const char *key, const char **dest)
1586 int ret;
1587 git_config_check_init();
1588 ret = git_configset_get_pathname(&the_config_set, key, dest);
1589 if (ret < 0)
1590 git_die_config(key, NULL);
1591 return ret;
1594 int git_config_get_untracked_cache(void)
1596 int val = -1;
1597 const char *v;
1599 /* Hack for test programs like test-dump-untracked-cache */
1600 if (ignore_untracked_cache_config)
1601 return -1;
1603 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
1604 return val;
1606 if (!git_config_get_value("core.untrackedcache", &v)) {
1607 if (!strcasecmp(v, "keep"))
1608 return -1;
1610 error("unknown core.untrackedCache value '%s'; "
1611 "using 'keep' default value", v);
1612 return -1;
1615 return -1; /* default value */
1618 NORETURN
1619 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1621 if (!filename)
1622 die(_("unable to parse '%s' from command-line config"), key);
1623 else
1624 die(_("bad config variable '%s' in file '%s' at line %d"),
1625 key, filename, linenr);
1628 NORETURN __attribute__((format(printf, 2, 3)))
1629 void git_die_config(const char *key, const char *err, ...)
1631 const struct string_list *values;
1632 struct key_value_info *kv_info;
1634 if (err) {
1635 va_list params;
1636 va_start(params, err);
1637 vreportf("error: ", err, params);
1638 va_end(params);
1640 values = git_config_get_value_multi(key);
1641 kv_info = values->items[values->nr - 1].util;
1642 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
1646 * Find all the stuff for git_config_set() below.
1649 static struct {
1650 int baselen;
1651 char *key;
1652 int do_not_match;
1653 regex_t *value_regex;
1654 int multi_replace;
1655 size_t *offset;
1656 unsigned int offset_alloc;
1657 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1658 int seen;
1659 } store;
1661 static int matches(const char *key, const char *value)
1663 if (strcmp(key, store.key))
1664 return 0; /* not ours */
1665 if (!store.value_regex)
1666 return 1; /* always matches */
1667 if (store.value_regex == CONFIG_REGEX_NONE)
1668 return 0; /* never matches */
1670 return store.do_not_match ^
1671 (value && !regexec(store.value_regex, value, 0, NULL, 0));
1674 static int store_aux(const char *key, const char *value, void *cb)
1676 const char *ep;
1677 size_t section_len;
1679 switch (store.state) {
1680 case KEY_SEEN:
1681 if (matches(key, value)) {
1682 if (store.seen == 1 && store.multi_replace == 0) {
1683 warning(_("%s has multiple values"), key);
1686 ALLOC_GROW(store.offset, store.seen + 1,
1687 store.offset_alloc);
1689 store.offset[store.seen] = cf->do_ftell(cf);
1690 store.seen++;
1692 break;
1693 case SECTION_SEEN:
1695 * What we are looking for is in store.key (both
1696 * section and var), and its section part is baselen
1697 * long. We found key (again, both section and var).
1698 * We would want to know if this key is in the same
1699 * section as what we are looking for. We already
1700 * know we are in the same section as what should
1701 * hold store.key.
1703 ep = strrchr(key, '.');
1704 section_len = ep - key;
1706 if ((section_len != store.baselen) ||
1707 memcmp(key, store.key, section_len+1)) {
1708 store.state = SECTION_END_SEEN;
1709 break;
1713 * Do not increment matches: this is no match, but we
1714 * just made sure we are in the desired section.
1716 ALLOC_GROW(store.offset, store.seen + 1,
1717 store.offset_alloc);
1718 store.offset[store.seen] = cf->do_ftell(cf);
1719 /* fallthru */
1720 case SECTION_END_SEEN:
1721 case START:
1722 if (matches(key, value)) {
1723 ALLOC_GROW(store.offset, store.seen + 1,
1724 store.offset_alloc);
1725 store.offset[store.seen] = cf->do_ftell(cf);
1726 store.state = KEY_SEEN;
1727 store.seen++;
1728 } else {
1729 if (strrchr(key, '.') - key == store.baselen &&
1730 !strncmp(key, store.key, store.baselen)) {
1731 store.state = SECTION_SEEN;
1732 ALLOC_GROW(store.offset,
1733 store.seen + 1,
1734 store.offset_alloc);
1735 store.offset[store.seen] = cf->do_ftell(cf);
1739 return 0;
1742 static int write_error(const char *filename)
1744 error("failed to write new configuration file %s", filename);
1746 /* Same error code as "failed to rename". */
1747 return 4;
1750 static int store_write_section(int fd, const char *key)
1752 const char *dot;
1753 int i, success;
1754 struct strbuf sb = STRBUF_INIT;
1756 dot = memchr(key, '.', store.baselen);
1757 if (dot) {
1758 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1759 for (i = dot - key + 1; i < store.baselen; i++) {
1760 if (key[i] == '"' || key[i] == '\\')
1761 strbuf_addch(&sb, '\\');
1762 strbuf_addch(&sb, key[i]);
1764 strbuf_addstr(&sb, "\"]\n");
1765 } else {
1766 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1769 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1770 strbuf_release(&sb);
1772 return success;
1775 static int store_write_pair(int fd, const char *key, const char *value)
1777 int i, success;
1778 int length = strlen(key + store.baselen + 1);
1779 const char *quote = "";
1780 struct strbuf sb = STRBUF_INIT;
1783 * Check to see if the value needs to be surrounded with a dq pair.
1784 * Note that problematic characters are always backslash-quoted; this
1785 * check is about not losing leading or trailing SP and strings that
1786 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1787 * configuration parser.
1789 if (value[0] == ' ')
1790 quote = "\"";
1791 for (i = 0; value[i]; i++)
1792 if (value[i] == ';' || value[i] == '#')
1793 quote = "\"";
1794 if (i && value[i - 1] == ' ')
1795 quote = "\"";
1797 strbuf_addf(&sb, "\t%.*s = %s",
1798 length, key + store.baselen + 1, quote);
1800 for (i = 0; value[i]; i++)
1801 switch (value[i]) {
1802 case '\n':
1803 strbuf_addstr(&sb, "\\n");
1804 break;
1805 case '\t':
1806 strbuf_addstr(&sb, "\\t");
1807 break;
1808 case '"':
1809 case '\\':
1810 strbuf_addch(&sb, '\\');
1811 default:
1812 strbuf_addch(&sb, value[i]);
1813 break;
1815 strbuf_addf(&sb, "%s\n", quote);
1817 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1818 strbuf_release(&sb);
1820 return success;
1823 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1824 size_t offset_, int *found_bracket)
1826 size_t equal_offset = size, bracket_offset = size;
1827 ssize_t offset;
1829 contline:
1830 for (offset = offset_-2; offset > 0
1831 && contents[offset] != '\n'; offset--)
1832 switch (contents[offset]) {
1833 case '=': equal_offset = offset; break;
1834 case ']': bracket_offset = offset; break;
1836 if (offset > 0 && contents[offset-1] == '\\') {
1837 offset_ = offset;
1838 goto contline;
1840 if (bracket_offset < equal_offset) {
1841 *found_bracket = 1;
1842 offset = bracket_offset+1;
1843 } else
1844 offset++;
1846 return offset;
1849 int git_config_set_in_file_gently(const char *config_filename,
1850 const char *key, const char *value)
1852 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
1855 void git_config_set_in_file(const char *config_filename,
1856 const char *key, const char *value)
1858 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1861 int git_config_set_gently(const char *key, const char *value)
1863 return git_config_set_multivar_gently(key, value, NULL, 0);
1866 void git_config_set(const char *key, const char *value)
1868 git_config_set_multivar(key, value, NULL, 0);
1872 * Auxiliary function to sanity-check and split the key into the section
1873 * identifier and variable name.
1875 * Returns 0 on success, -1 when there is an invalid character in the key and
1876 * -2 if there is no section name in the key.
1878 * store_key - pointer to char* which will hold a copy of the key with
1879 * lowercase section and variable name
1880 * baselen - pointer to int which will hold the length of the
1881 * section + subsection part, can be NULL
1883 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
1885 int i, dot, baselen;
1886 const char *last_dot = strrchr(key, '.');
1889 * Since "key" actually contains the section name and the real
1890 * key name separated by a dot, we have to know where the dot is.
1893 if (last_dot == NULL || last_dot == key) {
1894 if (!quiet)
1895 error("key does not contain a section: %s", key);
1896 return -CONFIG_NO_SECTION_OR_NAME;
1899 if (!last_dot[1]) {
1900 if (!quiet)
1901 error("key does not contain variable name: %s", key);
1902 return -CONFIG_NO_SECTION_OR_NAME;
1905 baselen = last_dot - key;
1906 if (baselen_)
1907 *baselen_ = baselen;
1910 * Validate the key and while at it, lower case it for matching.
1912 if (store_key)
1913 *store_key = xmallocz(strlen(key));
1915 dot = 0;
1916 for (i = 0; key[i]; i++) {
1917 unsigned char c = key[i];
1918 if (c == '.')
1919 dot = 1;
1920 /* Leave the extended basename untouched.. */
1921 if (!dot || i > baselen) {
1922 if (!iskeychar(c) ||
1923 (i == baselen + 1 && !isalpha(c))) {
1924 if (!quiet)
1925 error("invalid key: %s", key);
1926 goto out_free_ret_1;
1928 c = tolower(c);
1929 } else if (c == '\n') {
1930 if (!quiet)
1931 error("invalid key (newline): %s", key);
1932 goto out_free_ret_1;
1934 if (store_key)
1935 (*store_key)[i] = c;
1938 return 0;
1940 out_free_ret_1:
1941 if (store_key) {
1942 free(*store_key);
1943 *store_key = NULL;
1945 return -CONFIG_INVALID_KEY;
1948 int git_config_parse_key(const char *key, char **store_key, int *baselen)
1950 return git_config_parse_key_1(key, store_key, baselen, 0);
1953 int git_config_key_is_valid(const char *key)
1955 return !git_config_parse_key_1(key, NULL, NULL, 1);
1959 * If value==NULL, unset in (remove from) config,
1960 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1961 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
1962 * (only add a new one)
1963 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1964 * else all matching key/values (regardless how many) are removed,
1965 * before the new pair is written.
1967 * Returns 0 on success.
1969 * This function does this:
1971 * - it locks the config file by creating ".git/config.lock"
1973 * - it then parses the config using store_aux() as validator to find
1974 * the position on the key/value pair to replace. If it is to be unset,
1975 * it must be found exactly once.
1977 * - the config file is mmap()ed and the part before the match (if any) is
1978 * written to the lock file, then the changed part and the rest.
1980 * - the config file is removed and the lock file rename()d to it.
1983 int git_config_set_multivar_in_file_gently(const char *config_filename,
1984 const char *key, const char *value,
1985 const char *value_regex,
1986 int multi_replace)
1988 int fd = -1, in_fd = -1;
1989 int ret;
1990 struct lock_file *lock = NULL;
1991 char *filename_buf = NULL;
1992 char *contents = NULL;
1993 size_t contents_sz;
1995 /* parse-key returns negative; flip the sign to feed exit(3) */
1996 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1997 if (ret)
1998 goto out_free;
2000 store.multi_replace = multi_replace;
2002 if (!config_filename)
2003 config_filename = filename_buf = git_pathdup("config");
2006 * The lock serves a purpose in addition to locking: the new
2007 * contents of .git/config will be written into it.
2009 lock = xcalloc(1, sizeof(struct lock_file));
2010 fd = hold_lock_file_for_update(lock, config_filename, 0);
2011 if (fd < 0) {
2012 error("could not lock config file %s: %s", config_filename, strerror(errno));
2013 free(store.key);
2014 ret = CONFIG_NO_LOCK;
2015 goto out_free;
2019 * If .git/config does not exist yet, write a minimal version.
2021 in_fd = open(config_filename, O_RDONLY);
2022 if ( in_fd < 0 ) {
2023 free(store.key);
2025 if ( ENOENT != errno ) {
2026 error("opening %s: %s", config_filename,
2027 strerror(errno));
2028 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2029 goto out_free;
2031 /* if nothing to unset, error out */
2032 if (value == NULL) {
2033 ret = CONFIG_NOTHING_SET;
2034 goto out_free;
2037 store.key = (char *)key;
2038 if (!store_write_section(fd, key) ||
2039 !store_write_pair(fd, key, value))
2040 goto write_err_out;
2041 } else {
2042 struct stat st;
2043 size_t copy_begin, copy_end;
2044 int i, new_line = 0;
2046 if (value_regex == NULL)
2047 store.value_regex = NULL;
2048 else if (value_regex == CONFIG_REGEX_NONE)
2049 store.value_regex = CONFIG_REGEX_NONE;
2050 else {
2051 if (value_regex[0] == '!') {
2052 store.do_not_match = 1;
2053 value_regex++;
2054 } else
2055 store.do_not_match = 0;
2057 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2058 if (regcomp(store.value_regex, value_regex,
2059 REG_EXTENDED)) {
2060 error("invalid pattern: %s", value_regex);
2061 free(store.value_regex);
2062 ret = CONFIG_INVALID_PATTERN;
2063 goto out_free;
2067 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2068 store.offset[0] = 0;
2069 store.state = START;
2070 store.seen = 0;
2073 * After this, store.offset will contain the *end* offset
2074 * of the last match, or remain at 0 if no match was found.
2075 * As a side effect, we make sure to transform only a valid
2076 * existing config file.
2078 if (git_config_from_file(store_aux, config_filename, NULL)) {
2079 error("invalid config file %s", config_filename);
2080 free(store.key);
2081 if (store.value_regex != NULL &&
2082 store.value_regex != CONFIG_REGEX_NONE) {
2083 regfree(store.value_regex);
2084 free(store.value_regex);
2086 ret = CONFIG_INVALID_FILE;
2087 goto out_free;
2090 free(store.key);
2091 if (store.value_regex != NULL &&
2092 store.value_regex != CONFIG_REGEX_NONE) {
2093 regfree(store.value_regex);
2094 free(store.value_regex);
2097 /* if nothing to unset, or too many matches, error out */
2098 if ((store.seen == 0 && value == NULL) ||
2099 (store.seen > 1 && multi_replace == 0)) {
2100 ret = CONFIG_NOTHING_SET;
2101 goto out_free;
2104 fstat(in_fd, &st);
2105 contents_sz = xsize_t(st.st_size);
2106 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2107 MAP_PRIVATE, in_fd, 0);
2108 if (contents == MAP_FAILED) {
2109 if (errno == ENODEV && S_ISDIR(st.st_mode))
2110 errno = EISDIR;
2111 error("unable to mmap '%s': %s",
2112 config_filename, strerror(errno));
2113 ret = CONFIG_INVALID_FILE;
2114 contents = NULL;
2115 goto out_free;
2117 close(in_fd);
2118 in_fd = -1;
2120 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2121 error("chmod on %s failed: %s",
2122 get_lock_file_path(lock), strerror(errno));
2123 ret = CONFIG_NO_WRITE;
2124 goto out_free;
2127 if (store.seen == 0)
2128 store.seen = 1;
2130 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2131 if (store.offset[i] == 0) {
2132 store.offset[i] = copy_end = contents_sz;
2133 } else if (store.state != KEY_SEEN) {
2134 copy_end = store.offset[i];
2135 } else
2136 copy_end = find_beginning_of_line(
2137 contents, contents_sz,
2138 store.offset[i]-2, &new_line);
2140 if (copy_end > 0 && contents[copy_end-1] != '\n')
2141 new_line = 1;
2143 /* write the first part of the config */
2144 if (copy_end > copy_begin) {
2145 if (write_in_full(fd, contents + copy_begin,
2146 copy_end - copy_begin) <
2147 copy_end - copy_begin)
2148 goto write_err_out;
2149 if (new_line &&
2150 write_str_in_full(fd, "\n") != 1)
2151 goto write_err_out;
2153 copy_begin = store.offset[i];
2156 /* write the pair (value == NULL means unset) */
2157 if (value != NULL) {
2158 if (store.state == START) {
2159 if (!store_write_section(fd, key))
2160 goto write_err_out;
2162 if (!store_write_pair(fd, key, value))
2163 goto write_err_out;
2166 /* write the rest of the config */
2167 if (copy_begin < contents_sz)
2168 if (write_in_full(fd, contents + copy_begin,
2169 contents_sz - copy_begin) <
2170 contents_sz - copy_begin)
2171 goto write_err_out;
2173 munmap(contents, contents_sz);
2174 contents = NULL;
2177 if (commit_lock_file(lock) < 0) {
2178 error("could not write config file %s: %s", config_filename,
2179 strerror(errno));
2180 ret = CONFIG_NO_WRITE;
2181 lock = NULL;
2182 goto out_free;
2186 * lock is committed, so don't try to roll it back below.
2187 * NOTE: Since lockfile.c keeps a linked list of all created
2188 * lock_file structures, it isn't safe to free(lock). It's
2189 * better to just leave it hanging around.
2191 lock = NULL;
2192 ret = 0;
2194 /* Invalidate the config cache */
2195 git_config_clear();
2197 out_free:
2198 if (lock)
2199 rollback_lock_file(lock);
2200 free(filename_buf);
2201 if (contents)
2202 munmap(contents, contents_sz);
2203 if (in_fd >= 0)
2204 close(in_fd);
2205 return ret;
2207 write_err_out:
2208 ret = write_error(get_lock_file_path(lock));
2209 goto out_free;
2213 void git_config_set_multivar_in_file(const char *config_filename,
2214 const char *key, const char *value,
2215 const char *value_regex, int multi_replace)
2217 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2218 value_regex, multi_replace))
2219 return;
2220 if (value)
2221 die(_("could not set '%s' to '%s'"), key, value);
2222 else
2223 die(_("could not unset '%s'"), key);
2226 int git_config_set_multivar_gently(const char *key, const char *value,
2227 const char *value_regex, int multi_replace)
2229 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2230 multi_replace);
2233 void git_config_set_multivar(const char *key, const char *value,
2234 const char *value_regex, int multi_replace)
2236 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2237 multi_replace);
2240 static int section_name_match (const char *buf, const char *name)
2242 int i = 0, j = 0, dot = 0;
2243 if (buf[i] != '[')
2244 return 0;
2245 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2246 if (!dot && isspace(buf[i])) {
2247 dot = 1;
2248 if (name[j++] != '.')
2249 break;
2250 for (i++; isspace(buf[i]); i++)
2251 ; /* do nothing */
2252 if (buf[i] != '"')
2253 break;
2254 continue;
2256 if (buf[i] == '\\' && dot)
2257 i++;
2258 else if (buf[i] == '"' && dot) {
2259 for (i++; isspace(buf[i]); i++)
2260 ; /* do_nothing */
2261 break;
2263 if (buf[i] != name[j++])
2264 break;
2266 if (buf[i] == ']' && name[j] == 0) {
2268 * We match, now just find the right length offset by
2269 * gobbling up any whitespace after it, as well
2271 i++;
2272 for (; buf[i] && isspace(buf[i]); i++)
2273 ; /* do nothing */
2274 return i;
2276 return 0;
2279 static int section_name_is_ok(const char *name)
2281 /* Empty section names are bogus. */
2282 if (!*name)
2283 return 0;
2286 * Before a dot, we must be alphanumeric or dash. After the first dot,
2287 * anything goes, so we can stop checking.
2289 for (; *name && *name != '.'; name++)
2290 if (*name != '-' && !isalnum(*name))
2291 return 0;
2292 return 1;
2295 /* if new_name == NULL, the section is removed instead */
2296 int git_config_rename_section_in_file(const char *config_filename,
2297 const char *old_name, const char *new_name)
2299 int ret = 0, remove = 0;
2300 char *filename_buf = NULL;
2301 struct lock_file *lock;
2302 int out_fd;
2303 char buf[1024];
2304 FILE *config_file;
2305 struct stat st;
2307 if (new_name && !section_name_is_ok(new_name)) {
2308 ret = error("invalid section name: %s", new_name);
2309 goto out;
2312 if (!config_filename)
2313 config_filename = filename_buf = git_pathdup("config");
2315 lock = xcalloc(1, sizeof(struct lock_file));
2316 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2317 if (out_fd < 0) {
2318 ret = error("could not lock config file %s", config_filename);
2319 goto out;
2322 if (!(config_file = fopen(config_filename, "rb"))) {
2323 /* no config file means nothing to rename, no error */
2324 goto unlock_and_out;
2327 fstat(fileno(config_file), &st);
2329 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2330 ret = error("chmod on %s failed: %s",
2331 get_lock_file_path(lock), strerror(errno));
2332 goto out;
2335 while (fgets(buf, sizeof(buf), config_file)) {
2336 int i;
2337 int length;
2338 char *output = buf;
2339 for (i = 0; buf[i] && isspace(buf[i]); i++)
2340 ; /* do nothing */
2341 if (buf[i] == '[') {
2342 /* it's a section */
2343 int offset = section_name_match(&buf[i], old_name);
2344 if (offset > 0) {
2345 ret++;
2346 if (new_name == NULL) {
2347 remove = 1;
2348 continue;
2350 store.baselen = strlen(new_name);
2351 if (!store_write_section(out_fd, new_name)) {
2352 ret = write_error(get_lock_file_path(lock));
2353 goto out;
2356 * We wrote out the new section, with
2357 * a newline, now skip the old
2358 * section's length
2360 output += offset + i;
2361 if (strlen(output) > 0) {
2363 * More content means there's
2364 * a declaration to put on the
2365 * next line; indent with a
2366 * tab
2368 output -= 1;
2369 output[0] = '\t';
2372 remove = 0;
2374 if (remove)
2375 continue;
2376 length = strlen(output);
2377 if (write_in_full(out_fd, output, length) != length) {
2378 ret = write_error(get_lock_file_path(lock));
2379 goto out;
2382 fclose(config_file);
2383 unlock_and_out:
2384 if (commit_lock_file(lock) < 0)
2385 ret = error("could not write config file %s: %s",
2386 config_filename, strerror(errno));
2387 out:
2388 free(filename_buf);
2389 return ret;
2392 int git_config_rename_section(const char *old_name, const char *new_name)
2394 return git_config_rename_section_in_file(NULL, old_name, new_name);
2398 * Call this to report error for your variable that should not
2399 * get a boolean value (i.e. "[my] var" means "true").
2401 #undef config_error_nonbool
2402 int config_error_nonbool(const char *var)
2404 return error("missing value for '%s'", var);
2407 int parse_config_key(const char *var,
2408 const char *section,
2409 const char **subsection, int *subsection_len,
2410 const char **key)
2412 int section_len = strlen(section);
2413 const char *dot;
2415 /* Does it start with "section." ? */
2416 if (!starts_with(var, section) || var[section_len] != '.')
2417 return -1;
2420 * Find the key; we don't know yet if we have a subsection, but we must
2421 * parse backwards from the end, since the subsection may have dots in
2422 * it, too.
2424 dot = strrchr(var, '.');
2425 *key = dot + 1;
2427 /* Did we have a subsection at all? */
2428 if (dot == var + section_len) {
2429 *subsection = NULL;
2430 *subsection_len = 0;
2432 else {
2433 *subsection = var + section_len + 1;
2434 *subsection_len = dot - *subsection;
2437 return 0;
2440 const char *current_config_origin_type(void)
2442 return cf && cf->origin_type ? cf->origin_type : "command line";
2445 const char *current_config_name(void)
2447 return cf && cf->name ? cf->name : "";