Documentation/stash: remove mention of git reset --hard
[git.git] / config.c
blob83fdecb1bc9f6f31bc625c79c1d3c12ba5b27f77
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 enum config_origin_type 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);
42 * These variables record the "current" config source, which
43 * can be accessed by parsing callbacks.
45 * The "cf" variable will be non-NULL only when we are actually parsing a real
46 * config source (file, blob, cmdline, etc).
48 * The "current_config_kvi" variable will be non-NULL only when we are feeding
49 * cached config from a configset into a callback.
51 * They should generally never be non-NULL at the same time. If they are both
52 * NULL, then we aren't parsing anything (and depending on the function looking
53 * at the variables, it's either a bug for it to be called in the first place,
54 * or it's a function which can be reused for non-config purposes, and should
55 * fall back to some sane behavior).
57 static struct config_source *cf;
58 static struct key_value_info *current_config_kvi;
61 * Similar to the variables above, this gives access to the "scope" of the
62 * current value (repo, global, etc). For cached values, it can be found via
63 * the current_config_kvi as above. During parsing, the current value can be
64 * found in this variable. It's not part of "cf" because it transcends a single
65 * file (i.e., a file included from .git/config is still in "repo" scope).
67 static enum config_scope current_parsing_scope;
69 static int zlib_compression_seen;
72 * Default config_set that contains key-value pairs from the usual set of config
73 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
74 * config file and the global /etc/gitconfig)
76 static struct config_set the_config_set;
78 static int config_file_fgetc(struct config_source *conf)
80 return getc_unlocked(conf->u.file);
83 static int config_file_ungetc(int c, struct config_source *conf)
85 return ungetc(c, conf->u.file);
88 static long config_file_ftell(struct config_source *conf)
90 return ftell(conf->u.file);
94 static int config_buf_fgetc(struct config_source *conf)
96 if (conf->u.buf.pos < conf->u.buf.len)
97 return conf->u.buf.buf[conf->u.buf.pos++];
99 return EOF;
102 static int config_buf_ungetc(int c, struct config_source *conf)
104 if (conf->u.buf.pos > 0) {
105 conf->u.buf.pos--;
106 if (conf->u.buf.buf[conf->u.buf.pos] != c)
107 die("BUG: config_buf can only ungetc the same character");
108 return c;
111 return EOF;
114 static long config_buf_ftell(struct config_source *conf)
116 return conf->u.buf.pos;
119 #define MAX_INCLUDE_DEPTH 10
120 static const char include_depth_advice[] =
121 "exceeded maximum include depth (%d) while including\n"
122 " %s\n"
123 "from\n"
124 " %s\n"
125 "Do you have circular includes?";
126 static int handle_path_include(const char *path, struct config_include_data *inc)
128 int ret = 0;
129 struct strbuf buf = STRBUF_INIT;
130 char *expanded;
132 if (!path)
133 return config_error_nonbool("include.path");
135 expanded = expand_user_path(path);
136 if (!expanded)
137 return error("could not expand include path '%s'", path);
138 path = expanded;
141 * Use an absolute path as-is, but interpret relative paths
142 * based on the including config file.
144 if (!is_absolute_path(path)) {
145 char *slash;
147 if (!cf || !cf->path)
148 return error("relative config includes must come from files");
150 slash = find_last_dir_sep(cf->path);
151 if (slash)
152 strbuf_add(&buf, cf->path, slash - cf->path + 1);
153 strbuf_addstr(&buf, path);
154 path = buf.buf;
157 if (!access_or_die(path, R_OK, 0)) {
158 if (++inc->depth > MAX_INCLUDE_DEPTH)
159 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
160 !cf ? "<unknown>" :
161 cf->name ? cf->name :
162 "the command line");
163 ret = git_config_from_file(git_config_include, path, inc);
164 inc->depth--;
166 strbuf_release(&buf);
167 free(expanded);
168 return ret;
171 int git_config_include(const char *var, const char *value, void *data)
173 struct config_include_data *inc = data;
174 int ret;
177 * Pass along all values, including "include" directives; this makes it
178 * possible to query information on the includes themselves.
180 ret = inc->fn(var, value, inc->data);
181 if (ret < 0)
182 return ret;
184 if (!strcmp(var, "include.path"))
185 ret = handle_path_include(value, inc);
186 return ret;
189 void git_config_push_parameter(const char *text)
191 struct strbuf env = STRBUF_INIT;
192 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
193 if (old && *old) {
194 strbuf_addstr(&env, old);
195 strbuf_addch(&env, ' ');
197 sq_quote_buf(&env, text);
198 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
199 strbuf_release(&env);
202 int git_config_parse_parameter(const char *text,
203 config_fn_t fn, void *data)
205 const char *value;
206 struct strbuf **pair;
208 pair = strbuf_split_str(text, '=', 2);
209 if (!pair[0])
210 return error("bogus config parameter: %s", text);
212 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
213 strbuf_setlen(pair[0], pair[0]->len - 1);
214 value = pair[1] ? pair[1]->buf : "";
215 } else {
216 value = NULL;
219 strbuf_trim(pair[0]);
220 if (!pair[0]->len) {
221 strbuf_list_free(pair);
222 return error("bogus config parameter: %s", text);
224 strbuf_tolower(pair[0]);
225 if (fn(pair[0]->buf, value, data) < 0) {
226 strbuf_list_free(pair);
227 return -1;
229 strbuf_list_free(pair);
230 return 0;
233 int git_config_from_parameters(config_fn_t fn, void *data)
235 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
236 int ret = 0;
237 char *envw;
238 const char **argv = NULL;
239 int nr = 0, alloc = 0;
240 int i;
241 struct config_source source;
243 if (!env)
244 return 0;
246 memset(&source, 0, sizeof(source));
247 source.prev = cf;
248 source.origin_type = CONFIG_ORIGIN_CMDLINE;
249 cf = &source;
251 /* sq_dequote will write over it */
252 envw = xstrdup(env);
254 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
255 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
256 goto out;
259 for (i = 0; i < nr; i++) {
260 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
261 ret = -1;
262 goto out;
266 out:
267 free(argv);
268 free(envw);
269 cf = source.prev;
270 return ret;
273 static int get_next_char(void)
275 int c = cf->do_fgetc(cf);
277 if (c == '\r') {
278 /* DOS like systems */
279 c = cf->do_fgetc(cf);
280 if (c != '\n') {
281 if (c != EOF)
282 cf->do_ungetc(c, cf);
283 c = '\r';
286 if (c == '\n')
287 cf->linenr++;
288 if (c == EOF) {
289 cf->eof = 1;
290 cf->linenr++;
291 c = '\n';
293 return c;
296 static char *parse_value(void)
298 int quote = 0, comment = 0, space = 0;
300 strbuf_reset(&cf->value);
301 for (;;) {
302 int c = get_next_char();
303 if (c == '\n') {
304 if (quote) {
305 cf->linenr--;
306 return NULL;
308 return cf->value.buf;
310 if (comment)
311 continue;
312 if (isspace(c) && !quote) {
313 if (cf->value.len)
314 space++;
315 continue;
317 if (!quote) {
318 if (c == ';' || c == '#') {
319 comment = 1;
320 continue;
323 for (; space; space--)
324 strbuf_addch(&cf->value, ' ');
325 if (c == '\\') {
326 c = get_next_char();
327 switch (c) {
328 case '\n':
329 continue;
330 case 't':
331 c = '\t';
332 break;
333 case 'b':
334 c = '\b';
335 break;
336 case 'n':
337 c = '\n';
338 break;
339 /* Some characters escape as themselves */
340 case '\\': case '"':
341 break;
342 /* Reject unknown escape sequences */
343 default:
344 return NULL;
346 strbuf_addch(&cf->value, c);
347 continue;
349 if (c == '"') {
350 quote = 1-quote;
351 continue;
353 strbuf_addch(&cf->value, c);
357 static inline int iskeychar(int c)
359 return isalnum(c) || c == '-';
362 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
364 int c;
365 char *value;
366 int ret;
368 /* Get the full name */
369 for (;;) {
370 c = get_next_char();
371 if (cf->eof)
372 break;
373 if (!iskeychar(c))
374 break;
375 strbuf_addch(name, tolower(c));
378 while (c == ' ' || c == '\t')
379 c = get_next_char();
381 value = NULL;
382 if (c != '\n') {
383 if (c != '=')
384 return -1;
385 value = parse_value();
386 if (!value)
387 return -1;
390 * We already consumed the \n, but we need linenr to point to
391 * the line we just parsed during the call to fn to get
392 * accurate line number in error messages.
394 cf->linenr--;
395 ret = fn(name->buf, value, data);
396 cf->linenr++;
397 return ret;
400 static int get_extended_base_var(struct strbuf *name, int c)
402 do {
403 if (c == '\n')
404 goto error_incomplete_line;
405 c = get_next_char();
406 } while (isspace(c));
408 /* We require the format to be '[base "extension"]' */
409 if (c != '"')
410 return -1;
411 strbuf_addch(name, '.');
413 for (;;) {
414 int c = get_next_char();
415 if (c == '\n')
416 goto error_incomplete_line;
417 if (c == '"')
418 break;
419 if (c == '\\') {
420 c = get_next_char();
421 if (c == '\n')
422 goto error_incomplete_line;
424 strbuf_addch(name, c);
427 /* Final ']' */
428 if (get_next_char() != ']')
429 return -1;
430 return 0;
431 error_incomplete_line:
432 cf->linenr--;
433 return -1;
436 static int get_base_var(struct strbuf *name)
438 for (;;) {
439 int c = get_next_char();
440 if (cf->eof)
441 return -1;
442 if (c == ']')
443 return 0;
444 if (isspace(c))
445 return get_extended_base_var(name, c);
446 if (!iskeychar(c) && c != '.')
447 return -1;
448 strbuf_addch(name, tolower(c));
452 static int git_parse_source(config_fn_t fn, void *data)
454 int comment = 0;
455 int baselen = 0;
456 struct strbuf *var = &cf->var;
457 int error_return = 0;
458 char *error_msg = NULL;
460 /* U+FEFF Byte Order Mark in UTF8 */
461 const char *bomptr = utf8_bom;
463 for (;;) {
464 int c = get_next_char();
465 if (bomptr && *bomptr) {
466 /* We are at the file beginning; skip UTF8-encoded BOM
467 * if present. Sane editors won't put this in on their
468 * own, but e.g. Windows Notepad will do it happily. */
469 if (c == (*bomptr & 0377)) {
470 bomptr++;
471 continue;
472 } else {
473 /* Do not tolerate partial BOM. */
474 if (bomptr != utf8_bom)
475 break;
476 /* No BOM at file beginning. Cool. */
477 bomptr = NULL;
480 if (c == '\n') {
481 if (cf->eof)
482 return 0;
483 comment = 0;
484 continue;
486 if (comment || isspace(c))
487 continue;
488 if (c == '#' || c == ';') {
489 comment = 1;
490 continue;
492 if (c == '[') {
493 /* Reset prior to determining a new stem */
494 strbuf_reset(var);
495 if (get_base_var(var) < 0 || var->len < 1)
496 break;
497 strbuf_addch(var, '.');
498 baselen = var->len;
499 continue;
501 if (!isalpha(c))
502 break;
504 * Truncate the var name back to the section header
505 * stem prior to grabbing the suffix part of the name
506 * and the value.
508 strbuf_setlen(var, baselen);
509 strbuf_addch(var, tolower(c));
510 if (get_value(fn, data, var) < 0)
511 break;
514 switch (cf->origin_type) {
515 case CONFIG_ORIGIN_BLOB:
516 error_msg = xstrfmt(_("bad config line %d in blob %s"),
517 cf->linenr, cf->name);
518 break;
519 case CONFIG_ORIGIN_FILE:
520 error_msg = xstrfmt(_("bad config line %d in file %s"),
521 cf->linenr, cf->name);
522 break;
523 case CONFIG_ORIGIN_STDIN:
524 error_msg = xstrfmt(_("bad config line %d in standard input"),
525 cf->linenr);
526 break;
527 case CONFIG_ORIGIN_SUBMODULE_BLOB:
528 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
529 cf->linenr, cf->name);
530 break;
531 case CONFIG_ORIGIN_CMDLINE:
532 error_msg = xstrfmt(_("bad config line %d in command line %s"),
533 cf->linenr, cf->name);
534 break;
535 default:
536 error_msg = xstrfmt(_("bad config line %d in %s"),
537 cf->linenr, cf->name);
540 if (cf->die_on_error)
541 die("%s", error_msg);
542 else
543 error_return = error("%s", error_msg);
545 free(error_msg);
546 return error_return;
549 static int parse_unit_factor(const char *end, uintmax_t *val)
551 if (!*end)
552 return 1;
553 else if (!strcasecmp(end, "k")) {
554 *val *= 1024;
555 return 1;
557 else if (!strcasecmp(end, "m")) {
558 *val *= 1024 * 1024;
559 return 1;
561 else if (!strcasecmp(end, "g")) {
562 *val *= 1024 * 1024 * 1024;
563 return 1;
565 return 0;
568 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
570 if (value && *value) {
571 char *end;
572 intmax_t val;
573 uintmax_t uval;
574 uintmax_t factor = 1;
576 errno = 0;
577 val = strtoimax(value, &end, 0);
578 if (errno == ERANGE)
579 return 0;
580 if (!parse_unit_factor(end, &factor)) {
581 errno = EINVAL;
582 return 0;
584 uval = labs(val);
585 uval *= factor;
586 if (uval > max || labs(val) > uval) {
587 errno = ERANGE;
588 return 0;
590 val *= factor;
591 *ret = val;
592 return 1;
594 errno = EINVAL;
595 return 0;
598 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
600 if (value && *value) {
601 char *end;
602 uintmax_t val;
603 uintmax_t oldval;
605 errno = 0;
606 val = strtoumax(value, &end, 0);
607 if (errno == ERANGE)
608 return 0;
609 oldval = val;
610 if (!parse_unit_factor(end, &val)) {
611 errno = EINVAL;
612 return 0;
614 if (val > max || oldval > val) {
615 errno = ERANGE;
616 return 0;
618 *ret = val;
619 return 1;
621 errno = EINVAL;
622 return 0;
625 static int git_parse_int(const char *value, int *ret)
627 intmax_t tmp;
628 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
629 return 0;
630 *ret = tmp;
631 return 1;
634 static int git_parse_int64(const char *value, int64_t *ret)
636 intmax_t tmp;
637 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
638 return 0;
639 *ret = tmp;
640 return 1;
643 int git_parse_ulong(const char *value, unsigned long *ret)
645 uintmax_t tmp;
646 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
647 return 0;
648 *ret = tmp;
649 return 1;
652 NORETURN
653 static void die_bad_number(const char *name, const char *value)
655 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
657 if (!value)
658 value = "";
660 if (!(cf && cf->name))
661 die(_("bad numeric config value '%s' for '%s': %s"),
662 value, name, error_type);
664 switch (cf->origin_type) {
665 case CONFIG_ORIGIN_BLOB:
666 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
667 value, name, cf->name, error_type);
668 case CONFIG_ORIGIN_FILE:
669 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
670 value, name, cf->name, error_type);
671 case CONFIG_ORIGIN_STDIN:
672 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
673 value, name, error_type);
674 case CONFIG_ORIGIN_SUBMODULE_BLOB:
675 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
676 value, name, cf->name, error_type);
677 case CONFIG_ORIGIN_CMDLINE:
678 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
679 value, name, cf->name, error_type);
680 default:
681 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
682 value, name, cf->name, error_type);
686 int git_config_int(const char *name, const char *value)
688 int ret;
689 if (!git_parse_int(value, &ret))
690 die_bad_number(name, value);
691 return ret;
694 int64_t git_config_int64(const char *name, const char *value)
696 int64_t ret;
697 if (!git_parse_int64(value, &ret))
698 die_bad_number(name, value);
699 return ret;
702 unsigned long git_config_ulong(const char *name, const char *value)
704 unsigned long ret;
705 if (!git_parse_ulong(value, &ret))
706 die_bad_number(name, value);
707 return ret;
710 int git_parse_maybe_bool(const char *value)
712 if (!value)
713 return 1;
714 if (!*value)
715 return 0;
716 if (!strcasecmp(value, "true")
717 || !strcasecmp(value, "yes")
718 || !strcasecmp(value, "on"))
719 return 1;
720 if (!strcasecmp(value, "false")
721 || !strcasecmp(value, "no")
722 || !strcasecmp(value, "off"))
723 return 0;
724 return -1;
727 int git_config_maybe_bool(const char *name, const char *value)
729 int v = git_parse_maybe_bool(value);
730 if (0 <= v)
731 return v;
732 if (git_parse_int(value, &v))
733 return !!v;
734 return -1;
737 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
739 int v = git_parse_maybe_bool(value);
740 if (0 <= v) {
741 *is_bool = 1;
742 return v;
744 *is_bool = 0;
745 return git_config_int(name, value);
748 int git_config_bool(const char *name, const char *value)
750 int discard;
751 return !!git_config_bool_or_int(name, value, &discard);
754 int git_config_string(const char **dest, const char *var, const char *value)
756 if (!value)
757 return config_error_nonbool(var);
758 *dest = xstrdup(value);
759 return 0;
762 int git_config_pathname(const char **dest, const char *var, const char *value)
764 if (!value)
765 return config_error_nonbool(var);
766 *dest = expand_user_path(value);
767 if (!*dest)
768 die(_("failed to expand user dir in: '%s'"), value);
769 return 0;
772 static int git_default_core_config(const char *var, const char *value)
774 /* This needs a better name */
775 if (!strcmp(var, "core.filemode")) {
776 trust_executable_bit = git_config_bool(var, value);
777 return 0;
779 if (!strcmp(var, "core.trustctime")) {
780 trust_ctime = git_config_bool(var, value);
781 return 0;
783 if (!strcmp(var, "core.checkstat")) {
784 if (!strcasecmp(value, "default"))
785 check_stat = 1;
786 else if (!strcasecmp(value, "minimal"))
787 check_stat = 0;
790 if (!strcmp(var, "core.quotepath")) {
791 quote_path_fully = git_config_bool(var, value);
792 return 0;
795 if (!strcmp(var, "core.symlinks")) {
796 has_symlinks = git_config_bool(var, value);
797 return 0;
800 if (!strcmp(var, "core.ignorecase")) {
801 ignore_case = git_config_bool(var, value);
802 return 0;
805 if (!strcmp(var, "core.attributesfile"))
806 return git_config_pathname(&git_attributes_file, var, value);
808 if (!strcmp(var, "core.hookspath"))
809 return git_config_pathname(&git_hooks_path, var, value);
811 if (!strcmp(var, "core.bare")) {
812 is_bare_repository_cfg = git_config_bool(var, value);
813 return 0;
816 if (!strcmp(var, "core.ignorestat")) {
817 assume_unchanged = git_config_bool(var, value);
818 return 0;
821 if (!strcmp(var, "core.prefersymlinkrefs")) {
822 prefer_symlink_refs = git_config_bool(var, value);
823 return 0;
826 if (!strcmp(var, "core.logallrefupdates")) {
827 log_all_ref_updates = git_config_bool(var, value);
828 return 0;
831 if (!strcmp(var, "core.warnambiguousrefs")) {
832 warn_ambiguous_refs = git_config_bool(var, value);
833 return 0;
836 if (!strcmp(var, "core.abbrev")) {
837 int abbrev = git_config_int(var, value);
838 if (abbrev < minimum_abbrev || abbrev > 40)
839 return -1;
840 default_abbrev = abbrev;
841 return 0;
844 if (!strcmp(var, "core.disambiguate"))
845 return set_disambiguate_hint_config(var, value);
847 if (!strcmp(var, "core.loosecompression")) {
848 int level = git_config_int(var, value);
849 if (level == -1)
850 level = Z_DEFAULT_COMPRESSION;
851 else if (level < 0 || level > Z_BEST_COMPRESSION)
852 die(_("bad zlib compression level %d"), level);
853 zlib_compression_level = level;
854 zlib_compression_seen = 1;
855 return 0;
858 if (!strcmp(var, "core.compression")) {
859 int level = git_config_int(var, value);
860 if (level == -1)
861 level = Z_DEFAULT_COMPRESSION;
862 else if (level < 0 || level > Z_BEST_COMPRESSION)
863 die(_("bad zlib compression level %d"), level);
864 core_compression_level = level;
865 core_compression_seen = 1;
866 if (!zlib_compression_seen)
867 zlib_compression_level = level;
868 return 0;
871 if (!strcmp(var, "core.packedgitwindowsize")) {
872 int pgsz_x2 = getpagesize() * 2;
873 packed_git_window_size = git_config_ulong(var, value);
875 /* This value must be multiple of (pagesize * 2) */
876 packed_git_window_size /= pgsz_x2;
877 if (packed_git_window_size < 1)
878 packed_git_window_size = 1;
879 packed_git_window_size *= pgsz_x2;
880 return 0;
883 if (!strcmp(var, "core.bigfilethreshold")) {
884 big_file_threshold = git_config_ulong(var, value);
885 return 0;
888 if (!strcmp(var, "core.packedgitlimit")) {
889 packed_git_limit = git_config_ulong(var, value);
890 return 0;
893 if (!strcmp(var, "core.deltabasecachelimit")) {
894 delta_base_cache_limit = git_config_ulong(var, value);
895 return 0;
898 if (!strcmp(var, "core.autocrlf")) {
899 if (value && !strcasecmp(value, "input")) {
900 auto_crlf = AUTO_CRLF_INPUT;
901 return 0;
903 auto_crlf = git_config_bool(var, value);
904 return 0;
907 if (!strcmp(var, "core.safecrlf")) {
908 if (value && !strcasecmp(value, "warn")) {
909 safe_crlf = SAFE_CRLF_WARN;
910 return 0;
912 safe_crlf = git_config_bool(var, value);
913 return 0;
916 if (!strcmp(var, "core.eol")) {
917 if (value && !strcasecmp(value, "lf"))
918 core_eol = EOL_LF;
919 else if (value && !strcasecmp(value, "crlf"))
920 core_eol = EOL_CRLF;
921 else if (value && !strcasecmp(value, "native"))
922 core_eol = EOL_NATIVE;
923 else
924 core_eol = EOL_UNSET;
925 return 0;
928 if (!strcmp(var, "core.notesref")) {
929 notes_ref_name = xstrdup(value);
930 return 0;
933 if (!strcmp(var, "core.editor"))
934 return git_config_string(&editor_program, var, value);
936 if (!strcmp(var, "core.commentchar")) {
937 if (!value)
938 return config_error_nonbool(var);
939 else if (!strcasecmp(value, "auto"))
940 auto_comment_line_char = 1;
941 else if (value[0] && !value[1]) {
942 comment_line_char = value[0];
943 auto_comment_line_char = 0;
944 } else
945 return error("core.commentChar should only be one character");
946 return 0;
949 if (!strcmp(var, "core.askpass"))
950 return git_config_string(&askpass_program, var, value);
952 if (!strcmp(var, "core.excludesfile"))
953 return git_config_pathname(&excludes_file, var, value);
955 if (!strcmp(var, "core.whitespace")) {
956 if (!value)
957 return config_error_nonbool(var);
958 whitespace_rule_cfg = parse_whitespace_rule(value);
959 return 0;
962 if (!strcmp(var, "core.fsyncobjectfiles")) {
963 fsync_object_files = git_config_bool(var, value);
964 return 0;
967 if (!strcmp(var, "core.preloadindex")) {
968 core_preload_index = git_config_bool(var, value);
969 return 0;
972 if (!strcmp(var, "core.createobject")) {
973 if (!strcmp(value, "rename"))
974 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
975 else if (!strcmp(value, "link"))
976 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
977 else
978 die(_("invalid mode for object creation: %s"), value);
979 return 0;
982 if (!strcmp(var, "core.sparsecheckout")) {
983 core_apply_sparse_checkout = git_config_bool(var, value);
984 return 0;
987 if (!strcmp(var, "core.precomposeunicode")) {
988 precomposed_unicode = git_config_bool(var, value);
989 return 0;
992 if (!strcmp(var, "core.protecthfs")) {
993 protect_hfs = git_config_bool(var, value);
994 return 0;
997 if (!strcmp(var, "core.protectntfs")) {
998 protect_ntfs = git_config_bool(var, value);
999 return 0;
1002 if (!strcmp(var, "core.hidedotfiles")) {
1003 if (value && !strcasecmp(value, "dotgitonly"))
1004 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1005 else
1006 hide_dotfiles = git_config_bool(var, value);
1007 return 0;
1010 /* Add other config variables here and to Documentation/config.txt. */
1011 return 0;
1014 static int git_default_i18n_config(const char *var, const char *value)
1016 if (!strcmp(var, "i18n.commitencoding"))
1017 return git_config_string(&git_commit_encoding, var, value);
1019 if (!strcmp(var, "i18n.logoutputencoding"))
1020 return git_config_string(&git_log_output_encoding, var, value);
1022 /* Add other config variables here and to Documentation/config.txt. */
1023 return 0;
1026 static int git_default_branch_config(const char *var, const char *value)
1028 if (!strcmp(var, "branch.autosetupmerge")) {
1029 if (value && !strcasecmp(value, "always")) {
1030 git_branch_track = BRANCH_TRACK_ALWAYS;
1031 return 0;
1033 git_branch_track = git_config_bool(var, value);
1034 return 0;
1036 if (!strcmp(var, "branch.autosetuprebase")) {
1037 if (!value)
1038 return config_error_nonbool(var);
1039 else if (!strcmp(value, "never"))
1040 autorebase = AUTOREBASE_NEVER;
1041 else if (!strcmp(value, "local"))
1042 autorebase = AUTOREBASE_LOCAL;
1043 else if (!strcmp(value, "remote"))
1044 autorebase = AUTOREBASE_REMOTE;
1045 else if (!strcmp(value, "always"))
1046 autorebase = AUTOREBASE_ALWAYS;
1047 else
1048 return error("malformed value for %s", var);
1049 return 0;
1052 /* Add other config variables here and to Documentation/config.txt. */
1053 return 0;
1056 static int git_default_push_config(const char *var, const char *value)
1058 if (!strcmp(var, "push.default")) {
1059 if (!value)
1060 return config_error_nonbool(var);
1061 else if (!strcmp(value, "nothing"))
1062 push_default = PUSH_DEFAULT_NOTHING;
1063 else if (!strcmp(value, "matching"))
1064 push_default = PUSH_DEFAULT_MATCHING;
1065 else if (!strcmp(value, "simple"))
1066 push_default = PUSH_DEFAULT_SIMPLE;
1067 else if (!strcmp(value, "upstream"))
1068 push_default = PUSH_DEFAULT_UPSTREAM;
1069 else if (!strcmp(value, "tracking")) /* deprecated */
1070 push_default = PUSH_DEFAULT_UPSTREAM;
1071 else if (!strcmp(value, "current"))
1072 push_default = PUSH_DEFAULT_CURRENT;
1073 else {
1074 error("malformed value for %s: %s", var, value);
1075 return error("Must be one of nothing, matching, simple, "
1076 "upstream or current.");
1078 return 0;
1081 /* Add other config variables here and to Documentation/config.txt. */
1082 return 0;
1085 static int git_default_mailmap_config(const char *var, const char *value)
1087 if (!strcmp(var, "mailmap.file"))
1088 return git_config_pathname(&git_mailmap_file, var, value);
1089 if (!strcmp(var, "mailmap.blob"))
1090 return git_config_string(&git_mailmap_blob, var, value);
1092 /* Add other config variables here and to Documentation/config.txt. */
1093 return 0;
1096 int git_default_config(const char *var, const char *value, void *dummy)
1098 if (starts_with(var, "core."))
1099 return git_default_core_config(var, value);
1101 if (starts_with(var, "user."))
1102 return git_ident_config(var, value, dummy);
1104 if (starts_with(var, "i18n."))
1105 return git_default_i18n_config(var, value);
1107 if (starts_with(var, "branch."))
1108 return git_default_branch_config(var, value);
1110 if (starts_with(var, "push."))
1111 return git_default_push_config(var, value);
1113 if (starts_with(var, "mailmap."))
1114 return git_default_mailmap_config(var, value);
1116 if (starts_with(var, "advice."))
1117 return git_default_advice_config(var, value);
1119 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1120 pager_use_color = git_config_bool(var,value);
1121 return 0;
1124 if (!strcmp(var, "pack.packsizelimit")) {
1125 pack_size_limit_cfg = git_config_ulong(var, value);
1126 return 0;
1128 /* Add other config variables here and to Documentation/config.txt. */
1129 return 0;
1133 * All source specific fields in the union, die_on_error, name and the callbacks
1134 * fgetc, ungetc, ftell of top need to be initialized before calling
1135 * this function.
1137 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1139 int ret;
1141 /* push config-file parsing state stack */
1142 top->prev = cf;
1143 top->linenr = 1;
1144 top->eof = 0;
1145 strbuf_init(&top->value, 1024);
1146 strbuf_init(&top->var, 1024);
1147 cf = top;
1149 ret = git_parse_source(fn, data);
1151 /* pop config-file parsing state stack */
1152 strbuf_release(&top->value);
1153 strbuf_release(&top->var);
1154 cf = top->prev;
1156 return ret;
1159 static int do_config_from_file(config_fn_t fn,
1160 const enum config_origin_type origin_type,
1161 const char *name, const char *path, FILE *f,
1162 void *data)
1164 struct config_source top;
1166 top.u.file = f;
1167 top.origin_type = origin_type;
1168 top.name = name;
1169 top.path = path;
1170 top.die_on_error = 1;
1171 top.do_fgetc = config_file_fgetc;
1172 top.do_ungetc = config_file_ungetc;
1173 top.do_ftell = config_file_ftell;
1175 return do_config_from(&top, fn, data);
1178 static int git_config_from_stdin(config_fn_t fn, void *data)
1180 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1183 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1185 int ret = -1;
1186 FILE *f;
1188 f = fopen(filename, "r");
1189 if (f) {
1190 flockfile(f);
1191 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1192 funlockfile(f);
1193 fclose(f);
1195 return ret;
1198 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1199 const char *name, const char *buf, size_t len, void *data)
1201 struct config_source top;
1203 top.u.buf.buf = buf;
1204 top.u.buf.len = len;
1205 top.u.buf.pos = 0;
1206 top.origin_type = origin_type;
1207 top.name = name;
1208 top.path = NULL;
1209 top.die_on_error = 0;
1210 top.do_fgetc = config_buf_fgetc;
1211 top.do_ungetc = config_buf_ungetc;
1212 top.do_ftell = config_buf_ftell;
1214 return do_config_from(&top, fn, data);
1217 static int git_config_from_blob_sha1(config_fn_t fn,
1218 const char *name,
1219 const unsigned char *sha1,
1220 void *data)
1222 enum object_type type;
1223 char *buf;
1224 unsigned long size;
1225 int ret;
1227 buf = read_sha1_file(sha1, &type, &size);
1228 if (!buf)
1229 return error("unable to load config blob object '%s'", name);
1230 if (type != OBJ_BLOB) {
1231 free(buf);
1232 return error("reference '%s' does not point to a blob", name);
1235 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1236 free(buf);
1238 return ret;
1241 static int git_config_from_blob_ref(config_fn_t fn,
1242 const char *name,
1243 void *data)
1245 unsigned char sha1[20];
1247 if (get_sha1(name, sha1) < 0)
1248 return error("unable to resolve config blob '%s'", name);
1249 return git_config_from_blob_sha1(fn, name, sha1, data);
1252 const char *git_etc_gitconfig(void)
1254 static const char *system_wide;
1255 if (!system_wide)
1256 system_wide = system_path(ETC_GITCONFIG);
1257 return system_wide;
1261 * Parse environment variable 'k' as a boolean (in various
1262 * possible spellings); if missing, use the default value 'def'.
1264 int git_env_bool(const char *k, int def)
1266 const char *v = getenv(k);
1267 return v ? git_config_bool(k, v) : def;
1271 * Parse environment variable 'k' as ulong with possibly a unit
1272 * suffix; if missing, use the default value 'val'.
1274 unsigned long git_env_ulong(const char *k, unsigned long val)
1276 const char *v = getenv(k);
1277 if (v && !git_parse_ulong(v, &val))
1278 die("failed to parse %s", k);
1279 return val;
1282 int git_config_system(void)
1284 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1287 static int do_git_config_sequence(config_fn_t fn, void *data)
1289 int ret = 0;
1290 char *xdg_config = xdg_config_home("config");
1291 char *user_config = expand_user_path("~/.gitconfig");
1292 char *repo_config = have_git_dir() ? git_pathdup("config") : NULL;
1294 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1295 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1296 ret += git_config_from_file(fn, git_etc_gitconfig(),
1297 data);
1299 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1300 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1301 ret += git_config_from_file(fn, xdg_config, data);
1303 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1304 ret += git_config_from_file(fn, user_config, data);
1306 current_parsing_scope = CONFIG_SCOPE_REPO;
1307 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1308 ret += git_config_from_file(fn, repo_config, data);
1310 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1311 if (git_config_from_parameters(fn, data) < 0)
1312 die(_("unable to parse command-line config"));
1314 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1315 free(xdg_config);
1316 free(user_config);
1317 free(repo_config);
1318 return ret;
1321 int git_config_with_options(config_fn_t fn, void *data,
1322 struct git_config_source *config_source,
1323 int respect_includes)
1325 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1327 if (respect_includes) {
1328 inc.fn = fn;
1329 inc.data = data;
1330 fn = git_config_include;
1331 data = &inc;
1335 * If we have a specific filename, use it. Otherwise, follow the
1336 * regular lookup sequence.
1338 if (config_source && config_source->use_stdin)
1339 return git_config_from_stdin(fn, data);
1340 else if (config_source && config_source->file)
1341 return git_config_from_file(fn, config_source->file, data);
1342 else if (config_source && config_source->blob)
1343 return git_config_from_blob_ref(fn, config_source->blob, data);
1345 return do_git_config_sequence(fn, data);
1348 static void git_config_raw(config_fn_t fn, void *data)
1350 if (git_config_with_options(fn, data, NULL, 1) < 0)
1352 * git_config_with_options() normally returns only
1353 * zero, as most errors are fatal, and
1354 * non-fatal potential errors are guarded by "if"
1355 * statements that are entered only when no error is
1356 * possible.
1358 * If we ever encounter a non-fatal error, it means
1359 * something went really wrong and we should stop
1360 * immediately.
1362 die(_("unknown error occurred while reading the configuration files"));
1365 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1367 int i, value_index;
1368 struct string_list *values;
1369 struct config_set_element *entry;
1370 struct configset_list *list = &cs->list;
1372 for (i = 0; i < list->nr; i++) {
1373 entry = list->items[i].e;
1374 value_index = list->items[i].value_index;
1375 values = &entry->value_list;
1377 current_config_kvi = values->items[value_index].util;
1379 if (fn(entry->key, values->items[value_index].string, data) < 0)
1380 git_die_config_linenr(entry->key,
1381 current_config_kvi->filename,
1382 current_config_kvi->linenr);
1384 current_config_kvi = NULL;
1388 static void git_config_check_init(void);
1390 void git_config(config_fn_t fn, void *data)
1392 git_config_check_init();
1393 configset_iter(&the_config_set, fn, data);
1396 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1398 struct config_set_element k;
1399 struct config_set_element *found_entry;
1400 char *normalized_key;
1402 * `key` may come from the user, so normalize it before using it
1403 * for querying entries from the hashmap.
1405 if (git_config_parse_key(key, &normalized_key, NULL))
1406 return NULL;
1408 hashmap_entry_init(&k, strhash(normalized_key));
1409 k.key = normalized_key;
1410 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1411 free(normalized_key);
1412 return found_entry;
1415 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1417 struct config_set_element *e;
1418 struct string_list_item *si;
1419 struct configset_list_item *l_item;
1420 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1422 e = configset_find_element(cs, key);
1424 * Since the keys are being fed by git_config*() callback mechanism, they
1425 * are already normalized. So simply add them without any further munging.
1427 if (!e) {
1428 e = xmalloc(sizeof(*e));
1429 hashmap_entry_init(e, strhash(key));
1430 e->key = xstrdup(key);
1431 string_list_init(&e->value_list, 1);
1432 hashmap_add(&cs->config_hash, e);
1434 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1436 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1437 l_item = &cs->list.items[cs->list.nr++];
1438 l_item->e = e;
1439 l_item->value_index = e->value_list.nr - 1;
1441 if (!cf)
1442 die("BUG: configset_add_value has no source");
1443 if (cf->name) {
1444 kv_info->filename = strintern(cf->name);
1445 kv_info->linenr = cf->linenr;
1446 kv_info->origin_type = cf->origin_type;
1447 } else {
1448 /* for values read from `git_config_from_parameters()` */
1449 kv_info->filename = NULL;
1450 kv_info->linenr = -1;
1451 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1453 kv_info->scope = current_parsing_scope;
1454 si->util = kv_info;
1456 return 0;
1459 static int config_set_element_cmp(const struct config_set_element *e1,
1460 const struct config_set_element *e2, const void *unused)
1462 return strcmp(e1->key, e2->key);
1465 void git_configset_init(struct config_set *cs)
1467 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1468 cs->hash_initialized = 1;
1469 cs->list.nr = 0;
1470 cs->list.alloc = 0;
1471 cs->list.items = NULL;
1474 void git_configset_clear(struct config_set *cs)
1476 struct config_set_element *entry;
1477 struct hashmap_iter iter;
1478 if (!cs->hash_initialized)
1479 return;
1481 hashmap_iter_init(&cs->config_hash, &iter);
1482 while ((entry = hashmap_iter_next(&iter))) {
1483 free(entry->key);
1484 string_list_clear(&entry->value_list, 1);
1486 hashmap_free(&cs->config_hash, 1);
1487 cs->hash_initialized = 0;
1488 free(cs->list.items);
1489 cs->list.nr = 0;
1490 cs->list.alloc = 0;
1491 cs->list.items = NULL;
1494 static int config_set_callback(const char *key, const char *value, void *cb)
1496 struct config_set *cs = cb;
1497 configset_add_value(cs, key, value);
1498 return 0;
1501 int git_configset_add_file(struct config_set *cs, const char *filename)
1503 return git_config_from_file(config_set_callback, filename, cs);
1506 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1508 const struct string_list *values = NULL;
1510 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1511 * queried key in the files of the configset, the value returned will be the last
1512 * value in the value list for that key.
1514 values = git_configset_get_value_multi(cs, key);
1516 if (!values)
1517 return 1;
1518 assert(values->nr > 0);
1519 *value = values->items[values->nr - 1].string;
1520 return 0;
1523 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1525 struct config_set_element *e = configset_find_element(cs, key);
1526 return e ? &e->value_list : NULL;
1529 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1531 const char *value;
1532 if (!git_configset_get_value(cs, key, &value))
1533 return git_config_string(dest, key, value);
1534 else
1535 return 1;
1538 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1540 return git_configset_get_string_const(cs, key, (const char **)dest);
1543 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1545 const char *value;
1546 if (!git_configset_get_value(cs, key, &value)) {
1547 *dest = git_config_int(key, value);
1548 return 0;
1549 } else
1550 return 1;
1553 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1555 const char *value;
1556 if (!git_configset_get_value(cs, key, &value)) {
1557 *dest = git_config_ulong(key, value);
1558 return 0;
1559 } else
1560 return 1;
1563 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1565 const char *value;
1566 if (!git_configset_get_value(cs, key, &value)) {
1567 *dest = git_config_bool(key, value);
1568 return 0;
1569 } else
1570 return 1;
1573 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1574 int *is_bool, int *dest)
1576 const char *value;
1577 if (!git_configset_get_value(cs, key, &value)) {
1578 *dest = git_config_bool_or_int(key, value, is_bool);
1579 return 0;
1580 } else
1581 return 1;
1584 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1586 const char *value;
1587 if (!git_configset_get_value(cs, key, &value)) {
1588 *dest = git_config_maybe_bool(key, value);
1589 if (*dest == -1)
1590 return -1;
1591 return 0;
1592 } else
1593 return 1;
1596 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1598 const char *value;
1599 if (!git_configset_get_value(cs, key, &value))
1600 return git_config_pathname(dest, key, value);
1601 else
1602 return 1;
1605 static void git_config_check_init(void)
1607 if (the_config_set.hash_initialized)
1608 return;
1609 git_configset_init(&the_config_set);
1610 git_config_raw(config_set_callback, &the_config_set);
1613 void git_config_clear(void)
1615 if (!the_config_set.hash_initialized)
1616 return;
1617 git_configset_clear(&the_config_set);
1620 int git_config_get_value(const char *key, const char **value)
1622 git_config_check_init();
1623 return git_configset_get_value(&the_config_set, key, value);
1626 const struct string_list *git_config_get_value_multi(const char *key)
1628 git_config_check_init();
1629 return git_configset_get_value_multi(&the_config_set, key);
1632 int git_config_get_string_const(const char *key, const char **dest)
1634 int ret;
1635 git_config_check_init();
1636 ret = git_configset_get_string_const(&the_config_set, key, dest);
1637 if (ret < 0)
1638 git_die_config(key, NULL);
1639 return ret;
1642 int git_config_get_string(const char *key, char **dest)
1644 git_config_check_init();
1645 return git_config_get_string_const(key, (const char **)dest);
1648 int git_config_get_int(const char *key, int *dest)
1650 git_config_check_init();
1651 return git_configset_get_int(&the_config_set, key, dest);
1654 int git_config_get_ulong(const char *key, unsigned long *dest)
1656 git_config_check_init();
1657 return git_configset_get_ulong(&the_config_set, key, dest);
1660 int git_config_get_bool(const char *key, int *dest)
1662 git_config_check_init();
1663 return git_configset_get_bool(&the_config_set, key, dest);
1666 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1668 git_config_check_init();
1669 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1672 int git_config_get_maybe_bool(const char *key, int *dest)
1674 git_config_check_init();
1675 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1678 int git_config_get_pathname(const char *key, const char **dest)
1680 int ret;
1681 git_config_check_init();
1682 ret = git_configset_get_pathname(&the_config_set, key, dest);
1683 if (ret < 0)
1684 git_die_config(key, NULL);
1685 return ret;
1688 int git_config_get_untracked_cache(void)
1690 int val = -1;
1691 const char *v;
1693 /* Hack for test programs like test-dump-untracked-cache */
1694 if (ignore_untracked_cache_config)
1695 return -1;
1697 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
1698 return val;
1700 if (!git_config_get_value("core.untrackedcache", &v)) {
1701 if (!strcasecmp(v, "keep"))
1702 return -1;
1704 error("unknown core.untrackedCache value '%s'; "
1705 "using 'keep' default value", v);
1706 return -1;
1709 return -1; /* default value */
1712 NORETURN
1713 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1715 if (!filename)
1716 die(_("unable to parse '%s' from command-line config"), key);
1717 else
1718 die(_("bad config variable '%s' in file '%s' at line %d"),
1719 key, filename, linenr);
1722 NORETURN __attribute__((format(printf, 2, 3)))
1723 void git_die_config(const char *key, const char *err, ...)
1725 const struct string_list *values;
1726 struct key_value_info *kv_info;
1728 if (err) {
1729 va_list params;
1730 va_start(params, err);
1731 vreportf("error: ", err, params);
1732 va_end(params);
1734 values = git_config_get_value_multi(key);
1735 kv_info = values->items[values->nr - 1].util;
1736 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
1740 * Find all the stuff for git_config_set() below.
1743 static struct {
1744 int baselen;
1745 char *key;
1746 int do_not_match;
1747 regex_t *value_regex;
1748 int multi_replace;
1749 size_t *offset;
1750 unsigned int offset_alloc;
1751 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1752 int seen;
1753 } store;
1755 static int matches(const char *key, const char *value)
1757 if (strcmp(key, store.key))
1758 return 0; /* not ours */
1759 if (!store.value_regex)
1760 return 1; /* always matches */
1761 if (store.value_regex == CONFIG_REGEX_NONE)
1762 return 0; /* never matches */
1764 return store.do_not_match ^
1765 (value && !regexec(store.value_regex, value, 0, NULL, 0));
1768 static int store_aux(const char *key, const char *value, void *cb)
1770 const char *ep;
1771 size_t section_len;
1773 switch (store.state) {
1774 case KEY_SEEN:
1775 if (matches(key, value)) {
1776 if (store.seen == 1 && store.multi_replace == 0) {
1777 warning(_("%s has multiple values"), key);
1780 ALLOC_GROW(store.offset, store.seen + 1,
1781 store.offset_alloc);
1783 store.offset[store.seen] = cf->do_ftell(cf);
1784 store.seen++;
1786 break;
1787 case SECTION_SEEN:
1789 * What we are looking for is in store.key (both
1790 * section and var), and its section part is baselen
1791 * long. We found key (again, both section and var).
1792 * We would want to know if this key is in the same
1793 * section as what we are looking for. We already
1794 * know we are in the same section as what should
1795 * hold store.key.
1797 ep = strrchr(key, '.');
1798 section_len = ep - key;
1800 if ((section_len != store.baselen) ||
1801 memcmp(key, store.key, section_len+1)) {
1802 store.state = SECTION_END_SEEN;
1803 break;
1807 * Do not increment matches: this is no match, but we
1808 * just made sure we are in the desired section.
1810 ALLOC_GROW(store.offset, store.seen + 1,
1811 store.offset_alloc);
1812 store.offset[store.seen] = cf->do_ftell(cf);
1813 /* fallthru */
1814 case SECTION_END_SEEN:
1815 case START:
1816 if (matches(key, value)) {
1817 ALLOC_GROW(store.offset, store.seen + 1,
1818 store.offset_alloc);
1819 store.offset[store.seen] = cf->do_ftell(cf);
1820 store.state = KEY_SEEN;
1821 store.seen++;
1822 } else {
1823 if (strrchr(key, '.') - key == store.baselen &&
1824 !strncmp(key, store.key, store.baselen)) {
1825 store.state = SECTION_SEEN;
1826 ALLOC_GROW(store.offset,
1827 store.seen + 1,
1828 store.offset_alloc);
1829 store.offset[store.seen] = cf->do_ftell(cf);
1833 return 0;
1836 static int write_error(const char *filename)
1838 error("failed to write new configuration file %s", filename);
1840 /* Same error code as "failed to rename". */
1841 return 4;
1844 static int store_write_section(int fd, const char *key)
1846 const char *dot;
1847 int i, success;
1848 struct strbuf sb = STRBUF_INIT;
1850 dot = memchr(key, '.', store.baselen);
1851 if (dot) {
1852 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1853 for (i = dot - key + 1; i < store.baselen; i++) {
1854 if (key[i] == '"' || key[i] == '\\')
1855 strbuf_addch(&sb, '\\');
1856 strbuf_addch(&sb, key[i]);
1858 strbuf_addstr(&sb, "\"]\n");
1859 } else {
1860 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1863 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1864 strbuf_release(&sb);
1866 return success;
1869 static int store_write_pair(int fd, const char *key, const char *value)
1871 int i, success;
1872 int length = strlen(key + store.baselen + 1);
1873 const char *quote = "";
1874 struct strbuf sb = STRBUF_INIT;
1877 * Check to see if the value needs to be surrounded with a dq pair.
1878 * Note that problematic characters are always backslash-quoted; this
1879 * check is about not losing leading or trailing SP and strings that
1880 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1881 * configuration parser.
1883 if (value[0] == ' ')
1884 quote = "\"";
1885 for (i = 0; value[i]; i++)
1886 if (value[i] == ';' || value[i] == '#')
1887 quote = "\"";
1888 if (i && value[i - 1] == ' ')
1889 quote = "\"";
1891 strbuf_addf(&sb, "\t%.*s = %s",
1892 length, key + store.baselen + 1, quote);
1894 for (i = 0; value[i]; i++)
1895 switch (value[i]) {
1896 case '\n':
1897 strbuf_addstr(&sb, "\\n");
1898 break;
1899 case '\t':
1900 strbuf_addstr(&sb, "\\t");
1901 break;
1902 case '"':
1903 case '\\':
1904 strbuf_addch(&sb, '\\');
1905 default:
1906 strbuf_addch(&sb, value[i]);
1907 break;
1909 strbuf_addf(&sb, "%s\n", quote);
1911 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1912 strbuf_release(&sb);
1914 return success;
1917 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1918 size_t offset_, int *found_bracket)
1920 size_t equal_offset = size, bracket_offset = size;
1921 ssize_t offset;
1923 contline:
1924 for (offset = offset_-2; offset > 0
1925 && contents[offset] != '\n'; offset--)
1926 switch (contents[offset]) {
1927 case '=': equal_offset = offset; break;
1928 case ']': bracket_offset = offset; break;
1930 if (offset > 0 && contents[offset-1] == '\\') {
1931 offset_ = offset;
1932 goto contline;
1934 if (bracket_offset < equal_offset) {
1935 *found_bracket = 1;
1936 offset = bracket_offset+1;
1937 } else
1938 offset++;
1940 return offset;
1943 int git_config_set_in_file_gently(const char *config_filename,
1944 const char *key, const char *value)
1946 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
1949 void git_config_set_in_file(const char *config_filename,
1950 const char *key, const char *value)
1952 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1955 int git_config_set_gently(const char *key, const char *value)
1957 return git_config_set_multivar_gently(key, value, NULL, 0);
1960 void git_config_set(const char *key, const char *value)
1962 git_config_set_multivar(key, value, NULL, 0);
1966 * Auxiliary function to sanity-check and split the key into the section
1967 * identifier and variable name.
1969 * Returns 0 on success, -1 when there is an invalid character in the key and
1970 * -2 if there is no section name in the key.
1972 * store_key - pointer to char* which will hold a copy of the key with
1973 * lowercase section and variable name
1974 * baselen - pointer to int which will hold the length of the
1975 * section + subsection part, can be NULL
1977 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
1979 int i, dot, baselen;
1980 const char *last_dot = strrchr(key, '.');
1983 * Since "key" actually contains the section name and the real
1984 * key name separated by a dot, we have to know where the dot is.
1987 if (last_dot == NULL || last_dot == key) {
1988 if (!quiet)
1989 error("key does not contain a section: %s", key);
1990 return -CONFIG_NO_SECTION_OR_NAME;
1993 if (!last_dot[1]) {
1994 if (!quiet)
1995 error("key does not contain variable name: %s", key);
1996 return -CONFIG_NO_SECTION_OR_NAME;
1999 baselen = last_dot - key;
2000 if (baselen_)
2001 *baselen_ = baselen;
2004 * Validate the key and while at it, lower case it for matching.
2006 if (store_key)
2007 *store_key = xmallocz(strlen(key));
2009 dot = 0;
2010 for (i = 0; key[i]; i++) {
2011 unsigned char c = key[i];
2012 if (c == '.')
2013 dot = 1;
2014 /* Leave the extended basename untouched.. */
2015 if (!dot || i > baselen) {
2016 if (!iskeychar(c) ||
2017 (i == baselen + 1 && !isalpha(c))) {
2018 if (!quiet)
2019 error("invalid key: %s", key);
2020 goto out_free_ret_1;
2022 c = tolower(c);
2023 } else if (c == '\n') {
2024 if (!quiet)
2025 error("invalid key (newline): %s", key);
2026 goto out_free_ret_1;
2028 if (store_key)
2029 (*store_key)[i] = c;
2032 return 0;
2034 out_free_ret_1:
2035 if (store_key) {
2036 free(*store_key);
2037 *store_key = NULL;
2039 return -CONFIG_INVALID_KEY;
2042 int git_config_parse_key(const char *key, char **store_key, int *baselen)
2044 return git_config_parse_key_1(key, store_key, baselen, 0);
2047 int git_config_key_is_valid(const char *key)
2049 return !git_config_parse_key_1(key, NULL, NULL, 1);
2053 * If value==NULL, unset in (remove from) config,
2054 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2055 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2056 * (only add a new one)
2057 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2058 * else all matching key/values (regardless how many) are removed,
2059 * before the new pair is written.
2061 * Returns 0 on success.
2063 * This function does this:
2065 * - it locks the config file by creating ".git/config.lock"
2067 * - it then parses the config using store_aux() as validator to find
2068 * the position on the key/value pair to replace. If it is to be unset,
2069 * it must be found exactly once.
2071 * - the config file is mmap()ed and the part before the match (if any) is
2072 * written to the lock file, then the changed part and the rest.
2074 * - the config file is removed and the lock file rename()d to it.
2077 int git_config_set_multivar_in_file_gently(const char *config_filename,
2078 const char *key, const char *value,
2079 const char *value_regex,
2080 int multi_replace)
2082 int fd = -1, in_fd = -1;
2083 int ret;
2084 struct lock_file *lock = NULL;
2085 char *filename_buf = NULL;
2086 char *contents = NULL;
2087 size_t contents_sz;
2089 /* parse-key returns negative; flip the sign to feed exit(3) */
2090 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2091 if (ret)
2092 goto out_free;
2094 store.multi_replace = multi_replace;
2096 if (!config_filename)
2097 config_filename = filename_buf = git_pathdup("config");
2100 * The lock serves a purpose in addition to locking: the new
2101 * contents of .git/config will be written into it.
2103 lock = xcalloc(1, sizeof(struct lock_file));
2104 fd = hold_lock_file_for_update(lock, config_filename, 0);
2105 if (fd < 0) {
2106 error_errno("could not lock config file %s", config_filename);
2107 free(store.key);
2108 ret = CONFIG_NO_LOCK;
2109 goto out_free;
2113 * If .git/config does not exist yet, write a minimal version.
2115 in_fd = open(config_filename, O_RDONLY);
2116 if ( in_fd < 0 ) {
2117 free(store.key);
2119 if ( ENOENT != errno ) {
2120 error_errno("opening %s", config_filename);
2121 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2122 goto out_free;
2124 /* if nothing to unset, error out */
2125 if (value == NULL) {
2126 ret = CONFIG_NOTHING_SET;
2127 goto out_free;
2130 store.key = (char *)key;
2131 if (!store_write_section(fd, key) ||
2132 !store_write_pair(fd, key, value))
2133 goto write_err_out;
2134 } else {
2135 struct stat st;
2136 size_t copy_begin, copy_end;
2137 int i, new_line = 0;
2139 if (value_regex == NULL)
2140 store.value_regex = NULL;
2141 else if (value_regex == CONFIG_REGEX_NONE)
2142 store.value_regex = CONFIG_REGEX_NONE;
2143 else {
2144 if (value_regex[0] == '!') {
2145 store.do_not_match = 1;
2146 value_regex++;
2147 } else
2148 store.do_not_match = 0;
2150 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2151 if (regcomp(store.value_regex, value_regex,
2152 REG_EXTENDED)) {
2153 error("invalid pattern: %s", value_regex);
2154 free(store.value_regex);
2155 ret = CONFIG_INVALID_PATTERN;
2156 goto out_free;
2160 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2161 store.offset[0] = 0;
2162 store.state = START;
2163 store.seen = 0;
2166 * After this, store.offset will contain the *end* offset
2167 * of the last match, or remain at 0 if no match was found.
2168 * As a side effect, we make sure to transform only a valid
2169 * existing config file.
2171 if (git_config_from_file(store_aux, config_filename, NULL)) {
2172 error("invalid config file %s", config_filename);
2173 free(store.key);
2174 if (store.value_regex != NULL &&
2175 store.value_regex != CONFIG_REGEX_NONE) {
2176 regfree(store.value_regex);
2177 free(store.value_regex);
2179 ret = CONFIG_INVALID_FILE;
2180 goto out_free;
2183 free(store.key);
2184 if (store.value_regex != NULL &&
2185 store.value_regex != CONFIG_REGEX_NONE) {
2186 regfree(store.value_regex);
2187 free(store.value_regex);
2190 /* if nothing to unset, or too many matches, error out */
2191 if ((store.seen == 0 && value == NULL) ||
2192 (store.seen > 1 && multi_replace == 0)) {
2193 ret = CONFIG_NOTHING_SET;
2194 goto out_free;
2197 fstat(in_fd, &st);
2198 contents_sz = xsize_t(st.st_size);
2199 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2200 MAP_PRIVATE, in_fd, 0);
2201 if (contents == MAP_FAILED) {
2202 if (errno == ENODEV && S_ISDIR(st.st_mode))
2203 errno = EISDIR;
2204 error_errno("unable to mmap '%s'", config_filename);
2205 ret = CONFIG_INVALID_FILE;
2206 contents = NULL;
2207 goto out_free;
2209 close(in_fd);
2210 in_fd = -1;
2212 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2213 error_errno("chmod on %s failed", get_lock_file_path(lock));
2214 ret = CONFIG_NO_WRITE;
2215 goto out_free;
2218 if (store.seen == 0)
2219 store.seen = 1;
2221 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2222 if (store.offset[i] == 0) {
2223 store.offset[i] = copy_end = contents_sz;
2224 } else if (store.state != KEY_SEEN) {
2225 copy_end = store.offset[i];
2226 } else
2227 copy_end = find_beginning_of_line(
2228 contents, contents_sz,
2229 store.offset[i]-2, &new_line);
2231 if (copy_end > 0 && contents[copy_end-1] != '\n')
2232 new_line = 1;
2234 /* write the first part of the config */
2235 if (copy_end > copy_begin) {
2236 if (write_in_full(fd, contents + copy_begin,
2237 copy_end - copy_begin) <
2238 copy_end - copy_begin)
2239 goto write_err_out;
2240 if (new_line &&
2241 write_str_in_full(fd, "\n") != 1)
2242 goto write_err_out;
2244 copy_begin = store.offset[i];
2247 /* write the pair (value == NULL means unset) */
2248 if (value != NULL) {
2249 if (store.state == START) {
2250 if (!store_write_section(fd, key))
2251 goto write_err_out;
2253 if (!store_write_pair(fd, key, value))
2254 goto write_err_out;
2257 /* write the rest of the config */
2258 if (copy_begin < contents_sz)
2259 if (write_in_full(fd, contents + copy_begin,
2260 contents_sz - copy_begin) <
2261 contents_sz - copy_begin)
2262 goto write_err_out;
2264 munmap(contents, contents_sz);
2265 contents = NULL;
2268 if (commit_lock_file(lock) < 0) {
2269 error_errno("could not write config file %s", config_filename);
2270 ret = CONFIG_NO_WRITE;
2271 lock = NULL;
2272 goto out_free;
2276 * lock is committed, so don't try to roll it back below.
2277 * NOTE: Since lockfile.c keeps a linked list of all created
2278 * lock_file structures, it isn't safe to free(lock). It's
2279 * better to just leave it hanging around.
2281 lock = NULL;
2282 ret = 0;
2284 /* Invalidate the config cache */
2285 git_config_clear();
2287 out_free:
2288 if (lock)
2289 rollback_lock_file(lock);
2290 free(filename_buf);
2291 if (contents)
2292 munmap(contents, contents_sz);
2293 if (in_fd >= 0)
2294 close(in_fd);
2295 return ret;
2297 write_err_out:
2298 ret = write_error(get_lock_file_path(lock));
2299 goto out_free;
2303 void git_config_set_multivar_in_file(const char *config_filename,
2304 const char *key, const char *value,
2305 const char *value_regex, int multi_replace)
2307 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2308 value_regex, multi_replace))
2309 return;
2310 if (value)
2311 die(_("could not set '%s' to '%s'"), key, value);
2312 else
2313 die(_("could not unset '%s'"), key);
2316 int git_config_set_multivar_gently(const char *key, const char *value,
2317 const char *value_regex, int multi_replace)
2319 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2320 multi_replace);
2323 void git_config_set_multivar(const char *key, const char *value,
2324 const char *value_regex, int multi_replace)
2326 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2327 multi_replace);
2330 static int section_name_match (const char *buf, const char *name)
2332 int i = 0, j = 0, dot = 0;
2333 if (buf[i] != '[')
2334 return 0;
2335 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2336 if (!dot && isspace(buf[i])) {
2337 dot = 1;
2338 if (name[j++] != '.')
2339 break;
2340 for (i++; isspace(buf[i]); i++)
2341 ; /* do nothing */
2342 if (buf[i] != '"')
2343 break;
2344 continue;
2346 if (buf[i] == '\\' && dot)
2347 i++;
2348 else if (buf[i] == '"' && dot) {
2349 for (i++; isspace(buf[i]); i++)
2350 ; /* do_nothing */
2351 break;
2353 if (buf[i] != name[j++])
2354 break;
2356 if (buf[i] == ']' && name[j] == 0) {
2358 * We match, now just find the right length offset by
2359 * gobbling up any whitespace after it, as well
2361 i++;
2362 for (; buf[i] && isspace(buf[i]); i++)
2363 ; /* do nothing */
2364 return i;
2366 return 0;
2369 static int section_name_is_ok(const char *name)
2371 /* Empty section names are bogus. */
2372 if (!*name)
2373 return 0;
2376 * Before a dot, we must be alphanumeric or dash. After the first dot,
2377 * anything goes, so we can stop checking.
2379 for (; *name && *name != '.'; name++)
2380 if (*name != '-' && !isalnum(*name))
2381 return 0;
2382 return 1;
2385 /* if new_name == NULL, the section is removed instead */
2386 int git_config_rename_section_in_file(const char *config_filename,
2387 const char *old_name, const char *new_name)
2389 int ret = 0, remove = 0;
2390 char *filename_buf = NULL;
2391 struct lock_file *lock;
2392 int out_fd;
2393 char buf[1024];
2394 FILE *config_file;
2395 struct stat st;
2397 if (new_name && !section_name_is_ok(new_name)) {
2398 ret = error("invalid section name: %s", new_name);
2399 goto out;
2402 if (!config_filename)
2403 config_filename = filename_buf = git_pathdup("config");
2405 lock = xcalloc(1, sizeof(struct lock_file));
2406 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2407 if (out_fd < 0) {
2408 ret = error("could not lock config file %s", config_filename);
2409 goto out;
2412 if (!(config_file = fopen(config_filename, "rb"))) {
2413 /* no config file means nothing to rename, no error */
2414 goto unlock_and_out;
2417 fstat(fileno(config_file), &st);
2419 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2420 ret = error_errno("chmod on %s failed",
2421 get_lock_file_path(lock));
2422 goto out;
2425 while (fgets(buf, sizeof(buf), config_file)) {
2426 int i;
2427 int length;
2428 char *output = buf;
2429 for (i = 0; buf[i] && isspace(buf[i]); i++)
2430 ; /* do nothing */
2431 if (buf[i] == '[') {
2432 /* it's a section */
2433 int offset = section_name_match(&buf[i], old_name);
2434 if (offset > 0) {
2435 ret++;
2436 if (new_name == NULL) {
2437 remove = 1;
2438 continue;
2440 store.baselen = strlen(new_name);
2441 if (!store_write_section(out_fd, new_name)) {
2442 ret = write_error(get_lock_file_path(lock));
2443 goto out;
2446 * We wrote out the new section, with
2447 * a newline, now skip the old
2448 * section's length
2450 output += offset + i;
2451 if (strlen(output) > 0) {
2453 * More content means there's
2454 * a declaration to put on the
2455 * next line; indent with a
2456 * tab
2458 output -= 1;
2459 output[0] = '\t';
2462 remove = 0;
2464 if (remove)
2465 continue;
2466 length = strlen(output);
2467 if (write_in_full(out_fd, output, length) != length) {
2468 ret = write_error(get_lock_file_path(lock));
2469 goto out;
2472 fclose(config_file);
2473 unlock_and_out:
2474 if (commit_lock_file(lock) < 0)
2475 ret = error_errno("could not write config file %s",
2476 config_filename);
2477 out:
2478 free(filename_buf);
2479 return ret;
2482 int git_config_rename_section(const char *old_name, const char *new_name)
2484 return git_config_rename_section_in_file(NULL, old_name, new_name);
2488 * Call this to report error for your variable that should not
2489 * get a boolean value (i.e. "[my] var" means "true").
2491 #undef config_error_nonbool
2492 int config_error_nonbool(const char *var)
2494 return error("missing value for '%s'", var);
2497 int parse_config_key(const char *var,
2498 const char *section,
2499 const char **subsection, int *subsection_len,
2500 const char **key)
2502 int section_len = strlen(section);
2503 const char *dot;
2505 /* Does it start with "section." ? */
2506 if (!starts_with(var, section) || var[section_len] != '.')
2507 return -1;
2510 * Find the key; we don't know yet if we have a subsection, but we must
2511 * parse backwards from the end, since the subsection may have dots in
2512 * it, too.
2514 dot = strrchr(var, '.');
2515 *key = dot + 1;
2517 /* Did we have a subsection at all? */
2518 if (dot == var + section_len) {
2519 *subsection = NULL;
2520 *subsection_len = 0;
2522 else {
2523 *subsection = var + section_len + 1;
2524 *subsection_len = dot - *subsection;
2527 return 0;
2530 const char *current_config_origin_type(void)
2532 int type;
2533 if (current_config_kvi)
2534 type = current_config_kvi->origin_type;
2535 else if(cf)
2536 type = cf->origin_type;
2537 else
2538 die("BUG: current_config_origin_type called outside config callback");
2540 switch (type) {
2541 case CONFIG_ORIGIN_BLOB:
2542 return "blob";
2543 case CONFIG_ORIGIN_FILE:
2544 return "file";
2545 case CONFIG_ORIGIN_STDIN:
2546 return "standard input";
2547 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2548 return "submodule-blob";
2549 case CONFIG_ORIGIN_CMDLINE:
2550 return "command line";
2551 default:
2552 die("BUG: unknown config origin type");
2556 const char *current_config_name(void)
2558 const char *name;
2559 if (current_config_kvi)
2560 name = current_config_kvi->filename;
2561 else if (cf)
2562 name = cf->name;
2563 else
2564 die("BUG: current_config_name called outside config callback");
2565 return name ? name : "";
2568 enum config_scope current_config_scope(void)
2570 if (current_config_kvi)
2571 return current_config_kvi->scope;
2572 else
2573 return current_parsing_scope;