doc: add verb in front of command to run
[git/git-svn.git] / config.c
blobd7ce34b33d67c38245e77b7082d80f350e4f7eb7
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 && *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.hookspath"))
721 return git_config_pathname(&git_hooks_path, var, value);
723 if (!strcmp(var, "core.bare")) {
724 is_bare_repository_cfg = git_config_bool(var, value);
725 return 0;
728 if (!strcmp(var, "core.ignorestat")) {
729 assume_unchanged = git_config_bool(var, value);
730 return 0;
733 if (!strcmp(var, "core.prefersymlinkrefs")) {
734 prefer_symlink_refs = git_config_bool(var, value);
735 return 0;
738 if (!strcmp(var, "core.logallrefupdates")) {
739 log_all_ref_updates = git_config_bool(var, value);
740 return 0;
743 if (!strcmp(var, "core.warnambiguousrefs")) {
744 warn_ambiguous_refs = git_config_bool(var, value);
745 return 0;
748 if (!strcmp(var, "core.abbrev")) {
749 int abbrev = git_config_int(var, value);
750 if (abbrev < minimum_abbrev || abbrev > 40)
751 return -1;
752 default_abbrev = abbrev;
753 return 0;
756 if (!strcmp(var, "core.loosecompression")) {
757 int level = git_config_int(var, value);
758 if (level == -1)
759 level = Z_DEFAULT_COMPRESSION;
760 else if (level < 0 || level > Z_BEST_COMPRESSION)
761 die(_("bad zlib compression level %d"), level);
762 zlib_compression_level = level;
763 zlib_compression_seen = 1;
764 return 0;
767 if (!strcmp(var, "core.compression")) {
768 int level = git_config_int(var, value);
769 if (level == -1)
770 level = Z_DEFAULT_COMPRESSION;
771 else if (level < 0 || level > Z_BEST_COMPRESSION)
772 die(_("bad zlib compression level %d"), level);
773 core_compression_level = level;
774 core_compression_seen = 1;
775 if (!zlib_compression_seen)
776 zlib_compression_level = level;
777 return 0;
780 if (!strcmp(var, "core.packedgitwindowsize")) {
781 int pgsz_x2 = getpagesize() * 2;
782 packed_git_window_size = git_config_ulong(var, value);
784 /* This value must be multiple of (pagesize * 2) */
785 packed_git_window_size /= pgsz_x2;
786 if (packed_git_window_size < 1)
787 packed_git_window_size = 1;
788 packed_git_window_size *= pgsz_x2;
789 return 0;
792 if (!strcmp(var, "core.bigfilethreshold")) {
793 big_file_threshold = git_config_ulong(var, value);
794 return 0;
797 if (!strcmp(var, "core.packedgitlimit")) {
798 packed_git_limit = git_config_ulong(var, value);
799 return 0;
802 if (!strcmp(var, "core.deltabasecachelimit")) {
803 delta_base_cache_limit = git_config_ulong(var, value);
804 return 0;
807 if (!strcmp(var, "core.autocrlf")) {
808 if (value && !strcasecmp(value, "input")) {
809 auto_crlf = AUTO_CRLF_INPUT;
810 return 0;
812 auto_crlf = git_config_bool(var, value);
813 return 0;
816 if (!strcmp(var, "core.safecrlf")) {
817 if (value && !strcasecmp(value, "warn")) {
818 safe_crlf = SAFE_CRLF_WARN;
819 return 0;
821 safe_crlf = git_config_bool(var, value);
822 return 0;
825 if (!strcmp(var, "core.eol")) {
826 if (value && !strcasecmp(value, "lf"))
827 core_eol = EOL_LF;
828 else if (value && !strcasecmp(value, "crlf"))
829 core_eol = EOL_CRLF;
830 else if (value && !strcasecmp(value, "native"))
831 core_eol = EOL_NATIVE;
832 else
833 core_eol = EOL_UNSET;
834 return 0;
837 if (!strcmp(var, "core.notesref")) {
838 notes_ref_name = xstrdup(value);
839 return 0;
842 if (!strcmp(var, "core.pager"))
843 return git_config_string(&pager_program, var, value);
845 if (!strcmp(var, "core.editor"))
846 return git_config_string(&editor_program, var, value);
848 if (!strcmp(var, "core.commentchar")) {
849 if (!value)
850 return config_error_nonbool(var);
851 else if (!strcasecmp(value, "auto"))
852 auto_comment_line_char = 1;
853 else if (value[0] && !value[1]) {
854 comment_line_char = value[0];
855 auto_comment_line_char = 0;
856 } else
857 return error("core.commentChar should only be one character");
858 return 0;
861 if (!strcmp(var, "core.askpass"))
862 return git_config_string(&askpass_program, var, value);
864 if (!strcmp(var, "core.excludesfile"))
865 return git_config_pathname(&excludes_file, var, value);
867 if (!strcmp(var, "core.whitespace")) {
868 if (!value)
869 return config_error_nonbool(var);
870 whitespace_rule_cfg = parse_whitespace_rule(value);
871 return 0;
874 if (!strcmp(var, "core.fsyncobjectfiles")) {
875 fsync_object_files = git_config_bool(var, value);
876 return 0;
879 if (!strcmp(var, "core.preloadindex")) {
880 core_preload_index = git_config_bool(var, value);
881 return 0;
884 if (!strcmp(var, "core.createobject")) {
885 if (!strcmp(value, "rename"))
886 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
887 else if (!strcmp(value, "link"))
888 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
889 else
890 die(_("invalid mode for object creation: %s"), value);
891 return 0;
894 if (!strcmp(var, "core.sparsecheckout")) {
895 core_apply_sparse_checkout = git_config_bool(var, value);
896 return 0;
899 if (!strcmp(var, "core.precomposeunicode")) {
900 precomposed_unicode = git_config_bool(var, value);
901 return 0;
904 if (!strcmp(var, "core.protecthfs")) {
905 protect_hfs = git_config_bool(var, value);
906 return 0;
909 if (!strcmp(var, "core.protectntfs")) {
910 protect_ntfs = git_config_bool(var, value);
911 return 0;
914 if (!strcmp(var, "core.hidedotfiles")) {
915 if (value && !strcasecmp(value, "dotgitonly"))
916 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
917 else
918 hide_dotfiles = git_config_bool(var, value);
919 return 0;
922 /* Add other config variables here and to Documentation/config.txt. */
923 return 0;
926 static int git_default_i18n_config(const char *var, const char *value)
928 if (!strcmp(var, "i18n.commitencoding"))
929 return git_config_string(&git_commit_encoding, var, value);
931 if (!strcmp(var, "i18n.logoutputencoding"))
932 return git_config_string(&git_log_output_encoding, var, value);
934 /* Add other config variables here and to Documentation/config.txt. */
935 return 0;
938 static int git_default_branch_config(const char *var, const char *value)
940 if (!strcmp(var, "branch.autosetupmerge")) {
941 if (value && !strcasecmp(value, "always")) {
942 git_branch_track = BRANCH_TRACK_ALWAYS;
943 return 0;
945 git_branch_track = git_config_bool(var, value);
946 return 0;
948 if (!strcmp(var, "branch.autosetuprebase")) {
949 if (!value)
950 return config_error_nonbool(var);
951 else if (!strcmp(value, "never"))
952 autorebase = AUTOREBASE_NEVER;
953 else if (!strcmp(value, "local"))
954 autorebase = AUTOREBASE_LOCAL;
955 else if (!strcmp(value, "remote"))
956 autorebase = AUTOREBASE_REMOTE;
957 else if (!strcmp(value, "always"))
958 autorebase = AUTOREBASE_ALWAYS;
959 else
960 return error("malformed value for %s", var);
961 return 0;
964 /* Add other config variables here and to Documentation/config.txt. */
965 return 0;
968 static int git_default_push_config(const char *var, const char *value)
970 if (!strcmp(var, "push.default")) {
971 if (!value)
972 return config_error_nonbool(var);
973 else if (!strcmp(value, "nothing"))
974 push_default = PUSH_DEFAULT_NOTHING;
975 else if (!strcmp(value, "matching"))
976 push_default = PUSH_DEFAULT_MATCHING;
977 else if (!strcmp(value, "simple"))
978 push_default = PUSH_DEFAULT_SIMPLE;
979 else if (!strcmp(value, "upstream"))
980 push_default = PUSH_DEFAULT_UPSTREAM;
981 else if (!strcmp(value, "tracking")) /* deprecated */
982 push_default = PUSH_DEFAULT_UPSTREAM;
983 else if (!strcmp(value, "current"))
984 push_default = PUSH_DEFAULT_CURRENT;
985 else {
986 error("malformed value for %s: %s", var, value);
987 return error("Must be one of nothing, matching, simple, "
988 "upstream or current.");
990 return 0;
993 /* Add other config variables here and to Documentation/config.txt. */
994 return 0;
997 static int git_default_mailmap_config(const char *var, const char *value)
999 if (!strcmp(var, "mailmap.file"))
1000 return git_config_pathname(&git_mailmap_file, var, value);
1001 if (!strcmp(var, "mailmap.blob"))
1002 return git_config_string(&git_mailmap_blob, var, value);
1004 /* Add other config variables here and to Documentation/config.txt. */
1005 return 0;
1008 int git_default_config(const char *var, const char *value, void *dummy)
1010 if (starts_with(var, "core."))
1011 return git_default_core_config(var, value);
1013 if (starts_with(var, "user."))
1014 return git_ident_config(var, value, dummy);
1016 if (starts_with(var, "i18n."))
1017 return git_default_i18n_config(var, value);
1019 if (starts_with(var, "branch."))
1020 return git_default_branch_config(var, value);
1022 if (starts_with(var, "push."))
1023 return git_default_push_config(var, value);
1025 if (starts_with(var, "mailmap."))
1026 return git_default_mailmap_config(var, value);
1028 if (starts_with(var, "advice."))
1029 return git_default_advice_config(var, value);
1031 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1032 pager_use_color = git_config_bool(var,value);
1033 return 0;
1036 if (!strcmp(var, "pack.packsizelimit")) {
1037 pack_size_limit_cfg = git_config_ulong(var, value);
1038 return 0;
1040 /* Add other config variables here and to Documentation/config.txt. */
1041 return 0;
1045 * All source specific fields in the union, die_on_error, name and the callbacks
1046 * fgetc, ungetc, ftell of top need to be initialized before calling
1047 * this function.
1049 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1051 int ret;
1053 /* push config-file parsing state stack */
1054 top->prev = cf;
1055 top->linenr = 1;
1056 top->eof = 0;
1057 strbuf_init(&top->value, 1024);
1058 strbuf_init(&top->var, 1024);
1059 cf = top;
1061 ret = git_parse_source(fn, data);
1063 /* pop config-file parsing state stack */
1064 strbuf_release(&top->value);
1065 strbuf_release(&top->var);
1066 cf = top->prev;
1068 return ret;
1071 static int do_config_from_file(config_fn_t fn,
1072 const char *origin_type, const char *name, const char *path, FILE *f,
1073 void *data)
1075 struct config_source top;
1077 top.u.file = f;
1078 top.origin_type = origin_type;
1079 top.name = name;
1080 top.path = path;
1081 top.die_on_error = 1;
1082 top.do_fgetc = config_file_fgetc;
1083 top.do_ungetc = config_file_ungetc;
1084 top.do_ftell = config_file_ftell;
1086 return do_config_from(&top, fn, data);
1089 static int git_config_from_stdin(config_fn_t fn, void *data)
1091 return do_config_from_file(fn, "standard input", "", NULL, stdin, data);
1094 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1096 int ret = -1;
1097 FILE *f;
1099 f = fopen(filename, "r");
1100 if (f) {
1101 flockfile(f);
1102 ret = do_config_from_file(fn, "file", filename, filename, f, data);
1103 funlockfile(f);
1104 fclose(f);
1106 return ret;
1109 int git_config_from_mem(config_fn_t fn, const char *origin_type,
1110 const char *name, const char *buf, size_t len, void *data)
1112 struct config_source top;
1114 top.u.buf.buf = buf;
1115 top.u.buf.len = len;
1116 top.u.buf.pos = 0;
1117 top.origin_type = origin_type;
1118 top.name = name;
1119 top.path = NULL;
1120 top.die_on_error = 0;
1121 top.do_fgetc = config_buf_fgetc;
1122 top.do_ungetc = config_buf_ungetc;
1123 top.do_ftell = config_buf_ftell;
1125 return do_config_from(&top, fn, data);
1128 static int git_config_from_blob_sha1(config_fn_t fn,
1129 const char *name,
1130 const unsigned char *sha1,
1131 void *data)
1133 enum object_type type;
1134 char *buf;
1135 unsigned long size;
1136 int ret;
1138 buf = read_sha1_file(sha1, &type, &size);
1139 if (!buf)
1140 return error("unable to load config blob object '%s'", name);
1141 if (type != OBJ_BLOB) {
1142 free(buf);
1143 return error("reference '%s' does not point to a blob", name);
1146 ret = git_config_from_mem(fn, "blob", name, buf, size, data);
1147 free(buf);
1149 return ret;
1152 static int git_config_from_blob_ref(config_fn_t fn,
1153 const char *name,
1154 void *data)
1156 unsigned char sha1[20];
1158 if (get_sha1(name, sha1) < 0)
1159 return error("unable to resolve config blob '%s'", name);
1160 return git_config_from_blob_sha1(fn, name, sha1, data);
1163 const char *git_etc_gitconfig(void)
1165 static const char *system_wide;
1166 if (!system_wide)
1167 system_wide = system_path(ETC_GITCONFIG);
1168 return system_wide;
1172 * Parse environment variable 'k' as a boolean (in various
1173 * possible spellings); if missing, use the default value 'def'.
1175 int git_env_bool(const char *k, int def)
1177 const char *v = getenv(k);
1178 return v ? git_config_bool(k, v) : def;
1182 * Parse environment variable 'k' as ulong with possibly a unit
1183 * suffix; if missing, use the default value 'val'.
1185 unsigned long git_env_ulong(const char *k, unsigned long val)
1187 const char *v = getenv(k);
1188 if (v && !git_parse_ulong(v, &val))
1189 die("failed to parse %s", k);
1190 return val;
1193 int git_config_system(void)
1195 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1198 static int do_git_config_sequence(config_fn_t fn, void *data)
1200 int ret = 0, found = 0;
1201 char *xdg_config = xdg_config_home("config");
1202 char *user_config = expand_user_path("~/.gitconfig");
1203 char *repo_config = git_pathdup("config");
1205 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1206 ret += git_config_from_file(fn, git_etc_gitconfig(),
1207 data);
1208 found += 1;
1211 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1212 ret += git_config_from_file(fn, xdg_config, data);
1213 found += 1;
1216 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1217 ret += git_config_from_file(fn, user_config, data);
1218 found += 1;
1221 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1222 ret += git_config_from_file(fn, repo_config, data);
1223 found += 1;
1226 switch (git_config_from_parameters(fn, data)) {
1227 case -1: /* error */
1228 die(_("unable to parse command-line config"));
1229 break;
1230 case 0: /* found nothing */
1231 break;
1232 default: /* found at least one item */
1233 found++;
1234 break;
1237 free(xdg_config);
1238 free(user_config);
1239 free(repo_config);
1240 return ret == 0 ? found : ret;
1243 int git_config_with_options(config_fn_t fn, void *data,
1244 struct git_config_source *config_source,
1245 int respect_includes)
1247 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1249 if (respect_includes) {
1250 inc.fn = fn;
1251 inc.data = data;
1252 fn = git_config_include;
1253 data = &inc;
1257 * If we have a specific filename, use it. Otherwise, follow the
1258 * regular lookup sequence.
1260 if (config_source && config_source->use_stdin)
1261 return git_config_from_stdin(fn, data);
1262 else if (config_source && config_source->file)
1263 return git_config_from_file(fn, config_source->file, data);
1264 else if (config_source && config_source->blob)
1265 return git_config_from_blob_ref(fn, config_source->blob, data);
1267 return do_git_config_sequence(fn, data);
1270 static void git_config_raw(config_fn_t fn, void *data)
1272 if (git_config_with_options(fn, data, NULL, 1) < 0)
1274 * git_config_with_options() normally returns only
1275 * positive values, as most errors are fatal, and
1276 * non-fatal potential errors are guarded by "if"
1277 * statements that are entered only when no error is
1278 * possible.
1280 * If we ever encounter a non-fatal error, it means
1281 * something went really wrong and we should stop
1282 * immediately.
1284 die(_("unknown error occurred while reading the configuration files"));
1287 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1289 int i, value_index;
1290 struct string_list *values;
1291 struct config_set_element *entry;
1292 struct configset_list *list = &cs->list;
1293 struct key_value_info *kv_info;
1295 for (i = 0; i < list->nr; i++) {
1296 entry = list->items[i].e;
1297 value_index = list->items[i].value_index;
1298 values = &entry->value_list;
1299 if (fn(entry->key, values->items[value_index].string, data) < 0) {
1300 kv_info = values->items[value_index].util;
1301 git_die_config_linenr(entry->key, kv_info->filename, kv_info->linenr);
1306 static void git_config_check_init(void);
1308 void git_config(config_fn_t fn, void *data)
1310 git_config_check_init();
1311 configset_iter(&the_config_set, fn, data);
1314 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1316 struct config_set_element k;
1317 struct config_set_element *found_entry;
1318 char *normalized_key;
1320 * `key` may come from the user, so normalize it before using it
1321 * for querying entries from the hashmap.
1323 if (git_config_parse_key(key, &normalized_key, NULL))
1324 return NULL;
1326 hashmap_entry_init(&k, strhash(normalized_key));
1327 k.key = normalized_key;
1328 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1329 free(normalized_key);
1330 return found_entry;
1333 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1335 struct config_set_element *e;
1336 struct string_list_item *si;
1337 struct configset_list_item *l_item;
1338 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1340 e = configset_find_element(cs, key);
1342 * Since the keys are being fed by git_config*() callback mechanism, they
1343 * are already normalized. So simply add them without any further munging.
1345 if (!e) {
1346 e = xmalloc(sizeof(*e));
1347 hashmap_entry_init(e, strhash(key));
1348 e->key = xstrdup(key);
1349 string_list_init(&e->value_list, 1);
1350 hashmap_add(&cs->config_hash, e);
1352 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1354 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1355 l_item = &cs->list.items[cs->list.nr++];
1356 l_item->e = e;
1357 l_item->value_index = e->value_list.nr - 1;
1359 if (cf) {
1360 kv_info->filename = strintern(cf->name);
1361 kv_info->linenr = cf->linenr;
1362 } else {
1363 /* for values read from `git_config_from_parameters()` */
1364 kv_info->filename = NULL;
1365 kv_info->linenr = -1;
1367 si->util = kv_info;
1369 return 0;
1372 static int config_set_element_cmp(const struct config_set_element *e1,
1373 const struct config_set_element *e2, const void *unused)
1375 return strcmp(e1->key, e2->key);
1378 void git_configset_init(struct config_set *cs)
1380 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1381 cs->hash_initialized = 1;
1382 cs->list.nr = 0;
1383 cs->list.alloc = 0;
1384 cs->list.items = NULL;
1387 void git_configset_clear(struct config_set *cs)
1389 struct config_set_element *entry;
1390 struct hashmap_iter iter;
1391 if (!cs->hash_initialized)
1392 return;
1394 hashmap_iter_init(&cs->config_hash, &iter);
1395 while ((entry = hashmap_iter_next(&iter))) {
1396 free(entry->key);
1397 string_list_clear(&entry->value_list, 1);
1399 hashmap_free(&cs->config_hash, 1);
1400 cs->hash_initialized = 0;
1401 free(cs->list.items);
1402 cs->list.nr = 0;
1403 cs->list.alloc = 0;
1404 cs->list.items = NULL;
1407 static int config_set_callback(const char *key, const char *value, void *cb)
1409 struct config_set *cs = cb;
1410 configset_add_value(cs, key, value);
1411 return 0;
1414 int git_configset_add_file(struct config_set *cs, const char *filename)
1416 return git_config_from_file(config_set_callback, filename, cs);
1419 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1421 const struct string_list *values = NULL;
1423 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1424 * queried key in the files of the configset, the value returned will be the last
1425 * value in the value list for that key.
1427 values = git_configset_get_value_multi(cs, key);
1429 if (!values)
1430 return 1;
1431 assert(values->nr > 0);
1432 *value = values->items[values->nr - 1].string;
1433 return 0;
1436 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1438 struct config_set_element *e = configset_find_element(cs, key);
1439 return e ? &e->value_list : NULL;
1442 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1444 const char *value;
1445 if (!git_configset_get_value(cs, key, &value))
1446 return git_config_string(dest, key, value);
1447 else
1448 return 1;
1451 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1453 return git_configset_get_string_const(cs, key, (const char **)dest);
1456 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1458 const char *value;
1459 if (!git_configset_get_value(cs, key, &value)) {
1460 *dest = git_config_int(key, value);
1461 return 0;
1462 } else
1463 return 1;
1466 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1468 const char *value;
1469 if (!git_configset_get_value(cs, key, &value)) {
1470 *dest = git_config_ulong(key, value);
1471 return 0;
1472 } else
1473 return 1;
1476 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1478 const char *value;
1479 if (!git_configset_get_value(cs, key, &value)) {
1480 *dest = git_config_bool(key, value);
1481 return 0;
1482 } else
1483 return 1;
1486 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1487 int *is_bool, int *dest)
1489 const char *value;
1490 if (!git_configset_get_value(cs, key, &value)) {
1491 *dest = git_config_bool_or_int(key, value, is_bool);
1492 return 0;
1493 } else
1494 return 1;
1497 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1499 const char *value;
1500 if (!git_configset_get_value(cs, key, &value)) {
1501 *dest = git_config_maybe_bool(key, value);
1502 if (*dest == -1)
1503 return -1;
1504 return 0;
1505 } else
1506 return 1;
1509 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1511 const char *value;
1512 if (!git_configset_get_value(cs, key, &value))
1513 return git_config_pathname(dest, key, value);
1514 else
1515 return 1;
1518 static void git_config_check_init(void)
1520 if (the_config_set.hash_initialized)
1521 return;
1522 git_configset_init(&the_config_set);
1523 git_config_raw(config_set_callback, &the_config_set);
1526 void git_config_clear(void)
1528 if (!the_config_set.hash_initialized)
1529 return;
1530 git_configset_clear(&the_config_set);
1533 int git_config_get_value(const char *key, const char **value)
1535 git_config_check_init();
1536 return git_configset_get_value(&the_config_set, key, value);
1539 const struct string_list *git_config_get_value_multi(const char *key)
1541 git_config_check_init();
1542 return git_configset_get_value_multi(&the_config_set, key);
1545 int git_config_get_string_const(const char *key, const char **dest)
1547 int ret;
1548 git_config_check_init();
1549 ret = git_configset_get_string_const(&the_config_set, key, dest);
1550 if (ret < 0)
1551 git_die_config(key, NULL);
1552 return ret;
1555 int git_config_get_string(const char *key, char **dest)
1557 git_config_check_init();
1558 return git_config_get_string_const(key, (const char **)dest);
1561 int git_config_get_int(const char *key, int *dest)
1563 git_config_check_init();
1564 return git_configset_get_int(&the_config_set, key, dest);
1567 int git_config_get_ulong(const char *key, unsigned long *dest)
1569 git_config_check_init();
1570 return git_configset_get_ulong(&the_config_set, key, dest);
1573 int git_config_get_bool(const char *key, int *dest)
1575 git_config_check_init();
1576 return git_configset_get_bool(&the_config_set, key, dest);
1579 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1581 git_config_check_init();
1582 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1585 int git_config_get_maybe_bool(const char *key, int *dest)
1587 git_config_check_init();
1588 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1591 int git_config_get_pathname(const char *key, const char **dest)
1593 int ret;
1594 git_config_check_init();
1595 ret = git_configset_get_pathname(&the_config_set, key, dest);
1596 if (ret < 0)
1597 git_die_config(key, NULL);
1598 return ret;
1601 int git_config_get_untracked_cache(void)
1603 int val = -1;
1604 const char *v;
1606 /* Hack for test programs like test-dump-untracked-cache */
1607 if (ignore_untracked_cache_config)
1608 return -1;
1610 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
1611 return val;
1613 if (!git_config_get_value("core.untrackedcache", &v)) {
1614 if (!strcasecmp(v, "keep"))
1615 return -1;
1617 error("unknown core.untrackedCache value '%s'; "
1618 "using 'keep' default value", v);
1619 return -1;
1622 return -1; /* default value */
1625 NORETURN
1626 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1628 if (!filename)
1629 die(_("unable to parse '%s' from command-line config"), key);
1630 else
1631 die(_("bad config variable '%s' in file '%s' at line %d"),
1632 key, filename, linenr);
1635 NORETURN __attribute__((format(printf, 2, 3)))
1636 void git_die_config(const char *key, const char *err, ...)
1638 const struct string_list *values;
1639 struct key_value_info *kv_info;
1641 if (err) {
1642 va_list params;
1643 va_start(params, err);
1644 vreportf("error: ", err, params);
1645 va_end(params);
1647 values = git_config_get_value_multi(key);
1648 kv_info = values->items[values->nr - 1].util;
1649 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
1653 * Find all the stuff for git_config_set() below.
1656 static struct {
1657 int baselen;
1658 char *key;
1659 int do_not_match;
1660 regex_t *value_regex;
1661 int multi_replace;
1662 size_t *offset;
1663 unsigned int offset_alloc;
1664 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1665 int seen;
1666 } store;
1668 static int matches(const char *key, const char *value)
1670 if (strcmp(key, store.key))
1671 return 0; /* not ours */
1672 if (!store.value_regex)
1673 return 1; /* always matches */
1674 if (store.value_regex == CONFIG_REGEX_NONE)
1675 return 0; /* never matches */
1677 return store.do_not_match ^
1678 (value && !regexec(store.value_regex, value, 0, NULL, 0));
1681 static int store_aux(const char *key, const char *value, void *cb)
1683 const char *ep;
1684 size_t section_len;
1686 switch (store.state) {
1687 case KEY_SEEN:
1688 if (matches(key, value)) {
1689 if (store.seen == 1 && store.multi_replace == 0) {
1690 warning(_("%s has multiple values"), key);
1693 ALLOC_GROW(store.offset, store.seen + 1,
1694 store.offset_alloc);
1696 store.offset[store.seen] = cf->do_ftell(cf);
1697 store.seen++;
1699 break;
1700 case SECTION_SEEN:
1702 * What we are looking for is in store.key (both
1703 * section and var), and its section part is baselen
1704 * long. We found key (again, both section and var).
1705 * We would want to know if this key is in the same
1706 * section as what we are looking for. We already
1707 * know we are in the same section as what should
1708 * hold store.key.
1710 ep = strrchr(key, '.');
1711 section_len = ep - key;
1713 if ((section_len != store.baselen) ||
1714 memcmp(key, store.key, section_len+1)) {
1715 store.state = SECTION_END_SEEN;
1716 break;
1720 * Do not increment matches: this is no match, but we
1721 * just made sure we are in the desired section.
1723 ALLOC_GROW(store.offset, store.seen + 1,
1724 store.offset_alloc);
1725 store.offset[store.seen] = cf->do_ftell(cf);
1726 /* fallthru */
1727 case SECTION_END_SEEN:
1728 case START:
1729 if (matches(key, value)) {
1730 ALLOC_GROW(store.offset, store.seen + 1,
1731 store.offset_alloc);
1732 store.offset[store.seen] = cf->do_ftell(cf);
1733 store.state = KEY_SEEN;
1734 store.seen++;
1735 } else {
1736 if (strrchr(key, '.') - key == store.baselen &&
1737 !strncmp(key, store.key, store.baselen)) {
1738 store.state = SECTION_SEEN;
1739 ALLOC_GROW(store.offset,
1740 store.seen + 1,
1741 store.offset_alloc);
1742 store.offset[store.seen] = cf->do_ftell(cf);
1746 return 0;
1749 static int write_error(const char *filename)
1751 error("failed to write new configuration file %s", filename);
1753 /* Same error code as "failed to rename". */
1754 return 4;
1757 static int store_write_section(int fd, const char *key)
1759 const char *dot;
1760 int i, success;
1761 struct strbuf sb = STRBUF_INIT;
1763 dot = memchr(key, '.', store.baselen);
1764 if (dot) {
1765 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1766 for (i = dot - key + 1; i < store.baselen; i++) {
1767 if (key[i] == '"' || key[i] == '\\')
1768 strbuf_addch(&sb, '\\');
1769 strbuf_addch(&sb, key[i]);
1771 strbuf_addstr(&sb, "\"]\n");
1772 } else {
1773 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1776 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1777 strbuf_release(&sb);
1779 return success;
1782 static int store_write_pair(int fd, const char *key, const char *value)
1784 int i, success;
1785 int length = strlen(key + store.baselen + 1);
1786 const char *quote = "";
1787 struct strbuf sb = STRBUF_INIT;
1790 * Check to see if the value needs to be surrounded with a dq pair.
1791 * Note that problematic characters are always backslash-quoted; this
1792 * check is about not losing leading or trailing SP and strings that
1793 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1794 * configuration parser.
1796 if (value[0] == ' ')
1797 quote = "\"";
1798 for (i = 0; value[i]; i++)
1799 if (value[i] == ';' || value[i] == '#')
1800 quote = "\"";
1801 if (i && value[i - 1] == ' ')
1802 quote = "\"";
1804 strbuf_addf(&sb, "\t%.*s = %s",
1805 length, key + store.baselen + 1, quote);
1807 for (i = 0; value[i]; i++)
1808 switch (value[i]) {
1809 case '\n':
1810 strbuf_addstr(&sb, "\\n");
1811 break;
1812 case '\t':
1813 strbuf_addstr(&sb, "\\t");
1814 break;
1815 case '"':
1816 case '\\':
1817 strbuf_addch(&sb, '\\');
1818 default:
1819 strbuf_addch(&sb, value[i]);
1820 break;
1822 strbuf_addf(&sb, "%s\n", quote);
1824 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1825 strbuf_release(&sb);
1827 return success;
1830 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1831 size_t offset_, int *found_bracket)
1833 size_t equal_offset = size, bracket_offset = size;
1834 ssize_t offset;
1836 contline:
1837 for (offset = offset_-2; offset > 0
1838 && contents[offset] != '\n'; offset--)
1839 switch (contents[offset]) {
1840 case '=': equal_offset = offset; break;
1841 case ']': bracket_offset = offset; break;
1843 if (offset > 0 && contents[offset-1] == '\\') {
1844 offset_ = offset;
1845 goto contline;
1847 if (bracket_offset < equal_offset) {
1848 *found_bracket = 1;
1849 offset = bracket_offset+1;
1850 } else
1851 offset++;
1853 return offset;
1856 int git_config_set_in_file_gently(const char *config_filename,
1857 const char *key, const char *value)
1859 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
1862 void git_config_set_in_file(const char *config_filename,
1863 const char *key, const char *value)
1865 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1868 int git_config_set_gently(const char *key, const char *value)
1870 return git_config_set_multivar_gently(key, value, NULL, 0);
1873 void git_config_set(const char *key, const char *value)
1875 git_config_set_multivar(key, value, NULL, 0);
1879 * Auxiliary function to sanity-check and split the key into the section
1880 * identifier and variable name.
1882 * Returns 0 on success, -1 when there is an invalid character in the key and
1883 * -2 if there is no section name in the key.
1885 * store_key - pointer to char* which will hold a copy of the key with
1886 * lowercase section and variable name
1887 * baselen - pointer to int which will hold the length of the
1888 * section + subsection part, can be NULL
1890 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
1892 int i, dot, baselen;
1893 const char *last_dot = strrchr(key, '.');
1896 * Since "key" actually contains the section name and the real
1897 * key name separated by a dot, we have to know where the dot is.
1900 if (last_dot == NULL || last_dot == key) {
1901 if (!quiet)
1902 error("key does not contain a section: %s", key);
1903 return -CONFIG_NO_SECTION_OR_NAME;
1906 if (!last_dot[1]) {
1907 if (!quiet)
1908 error("key does not contain variable name: %s", key);
1909 return -CONFIG_NO_SECTION_OR_NAME;
1912 baselen = last_dot - key;
1913 if (baselen_)
1914 *baselen_ = baselen;
1917 * Validate the key and while at it, lower case it for matching.
1919 if (store_key)
1920 *store_key = xmallocz(strlen(key));
1922 dot = 0;
1923 for (i = 0; key[i]; i++) {
1924 unsigned char c = key[i];
1925 if (c == '.')
1926 dot = 1;
1927 /* Leave the extended basename untouched.. */
1928 if (!dot || i > baselen) {
1929 if (!iskeychar(c) ||
1930 (i == baselen + 1 && !isalpha(c))) {
1931 if (!quiet)
1932 error("invalid key: %s", key);
1933 goto out_free_ret_1;
1935 c = tolower(c);
1936 } else if (c == '\n') {
1937 if (!quiet)
1938 error("invalid key (newline): %s", key);
1939 goto out_free_ret_1;
1941 if (store_key)
1942 (*store_key)[i] = c;
1945 return 0;
1947 out_free_ret_1:
1948 if (store_key) {
1949 free(*store_key);
1950 *store_key = NULL;
1952 return -CONFIG_INVALID_KEY;
1955 int git_config_parse_key(const char *key, char **store_key, int *baselen)
1957 return git_config_parse_key_1(key, store_key, baselen, 0);
1960 int git_config_key_is_valid(const char *key)
1962 return !git_config_parse_key_1(key, NULL, NULL, 1);
1966 * If value==NULL, unset in (remove from) config,
1967 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1968 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
1969 * (only add a new one)
1970 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1971 * else all matching key/values (regardless how many) are removed,
1972 * before the new pair is written.
1974 * Returns 0 on success.
1976 * This function does this:
1978 * - it locks the config file by creating ".git/config.lock"
1980 * - it then parses the config using store_aux() as validator to find
1981 * the position on the key/value pair to replace. If it is to be unset,
1982 * it must be found exactly once.
1984 * - the config file is mmap()ed and the part before the match (if any) is
1985 * written to the lock file, then the changed part and the rest.
1987 * - the config file is removed and the lock file rename()d to it.
1990 int git_config_set_multivar_in_file_gently(const char *config_filename,
1991 const char *key, const char *value,
1992 const char *value_regex,
1993 int multi_replace)
1995 int fd = -1, in_fd = -1;
1996 int ret;
1997 struct lock_file *lock = NULL;
1998 char *filename_buf = NULL;
1999 char *contents = NULL;
2000 size_t contents_sz;
2002 /* parse-key returns negative; flip the sign to feed exit(3) */
2003 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2004 if (ret)
2005 goto out_free;
2007 store.multi_replace = multi_replace;
2009 if (!config_filename)
2010 config_filename = filename_buf = git_pathdup("config");
2013 * The lock serves a purpose in addition to locking: the new
2014 * contents of .git/config will be written into it.
2016 lock = xcalloc(1, sizeof(struct lock_file));
2017 fd = hold_lock_file_for_update(lock, config_filename, 0);
2018 if (fd < 0) {
2019 error_errno("could not lock config file %s", config_filename);
2020 free(store.key);
2021 ret = CONFIG_NO_LOCK;
2022 goto out_free;
2026 * If .git/config does not exist yet, write a minimal version.
2028 in_fd = open(config_filename, O_RDONLY);
2029 if ( in_fd < 0 ) {
2030 free(store.key);
2032 if ( ENOENT != errno ) {
2033 error_errno("opening %s", config_filename);
2034 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2035 goto out_free;
2037 /* if nothing to unset, error out */
2038 if (value == NULL) {
2039 ret = CONFIG_NOTHING_SET;
2040 goto out_free;
2043 store.key = (char *)key;
2044 if (!store_write_section(fd, key) ||
2045 !store_write_pair(fd, key, value))
2046 goto write_err_out;
2047 } else {
2048 struct stat st;
2049 size_t copy_begin, copy_end;
2050 int i, new_line = 0;
2052 if (value_regex == NULL)
2053 store.value_regex = NULL;
2054 else if (value_regex == CONFIG_REGEX_NONE)
2055 store.value_regex = CONFIG_REGEX_NONE;
2056 else {
2057 if (value_regex[0] == '!') {
2058 store.do_not_match = 1;
2059 value_regex++;
2060 } else
2061 store.do_not_match = 0;
2063 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2064 if (regcomp(store.value_regex, value_regex,
2065 REG_EXTENDED)) {
2066 error("invalid pattern: %s", value_regex);
2067 free(store.value_regex);
2068 ret = CONFIG_INVALID_PATTERN;
2069 goto out_free;
2073 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2074 store.offset[0] = 0;
2075 store.state = START;
2076 store.seen = 0;
2079 * After this, store.offset will contain the *end* offset
2080 * of the last match, or remain at 0 if no match was found.
2081 * As a side effect, we make sure to transform only a valid
2082 * existing config file.
2084 if (git_config_from_file(store_aux, config_filename, NULL)) {
2085 error("invalid config file %s", config_filename);
2086 free(store.key);
2087 if (store.value_regex != NULL &&
2088 store.value_regex != CONFIG_REGEX_NONE) {
2089 regfree(store.value_regex);
2090 free(store.value_regex);
2092 ret = CONFIG_INVALID_FILE;
2093 goto out_free;
2096 free(store.key);
2097 if (store.value_regex != NULL &&
2098 store.value_regex != CONFIG_REGEX_NONE) {
2099 regfree(store.value_regex);
2100 free(store.value_regex);
2103 /* if nothing to unset, or too many matches, error out */
2104 if ((store.seen == 0 && value == NULL) ||
2105 (store.seen > 1 && multi_replace == 0)) {
2106 ret = CONFIG_NOTHING_SET;
2107 goto out_free;
2110 fstat(in_fd, &st);
2111 contents_sz = xsize_t(st.st_size);
2112 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2113 MAP_PRIVATE, in_fd, 0);
2114 if (contents == MAP_FAILED) {
2115 if (errno == ENODEV && S_ISDIR(st.st_mode))
2116 errno = EISDIR;
2117 error_errno("unable to mmap '%s'", config_filename);
2118 ret = CONFIG_INVALID_FILE;
2119 contents = NULL;
2120 goto out_free;
2122 close(in_fd);
2123 in_fd = -1;
2125 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2126 error_errno("chmod on %s failed", get_lock_file_path(lock));
2127 ret = CONFIG_NO_WRITE;
2128 goto out_free;
2131 if (store.seen == 0)
2132 store.seen = 1;
2134 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2135 if (store.offset[i] == 0) {
2136 store.offset[i] = copy_end = contents_sz;
2137 } else if (store.state != KEY_SEEN) {
2138 copy_end = store.offset[i];
2139 } else
2140 copy_end = find_beginning_of_line(
2141 contents, contents_sz,
2142 store.offset[i]-2, &new_line);
2144 if (copy_end > 0 && contents[copy_end-1] != '\n')
2145 new_line = 1;
2147 /* write the first part of the config */
2148 if (copy_end > copy_begin) {
2149 if (write_in_full(fd, contents + copy_begin,
2150 copy_end - copy_begin) <
2151 copy_end - copy_begin)
2152 goto write_err_out;
2153 if (new_line &&
2154 write_str_in_full(fd, "\n") != 1)
2155 goto write_err_out;
2157 copy_begin = store.offset[i];
2160 /* write the pair (value == NULL means unset) */
2161 if (value != NULL) {
2162 if (store.state == START) {
2163 if (!store_write_section(fd, key))
2164 goto write_err_out;
2166 if (!store_write_pair(fd, key, value))
2167 goto write_err_out;
2170 /* write the rest of the config */
2171 if (copy_begin < contents_sz)
2172 if (write_in_full(fd, contents + copy_begin,
2173 contents_sz - copy_begin) <
2174 contents_sz - copy_begin)
2175 goto write_err_out;
2177 munmap(contents, contents_sz);
2178 contents = NULL;
2181 if (commit_lock_file(lock) < 0) {
2182 error_errno("could not write config file %s", config_filename);
2183 ret = CONFIG_NO_WRITE;
2184 lock = NULL;
2185 goto out_free;
2189 * lock is committed, so don't try to roll it back below.
2190 * NOTE: Since lockfile.c keeps a linked list of all created
2191 * lock_file structures, it isn't safe to free(lock). It's
2192 * better to just leave it hanging around.
2194 lock = NULL;
2195 ret = 0;
2197 /* Invalidate the config cache */
2198 git_config_clear();
2200 out_free:
2201 if (lock)
2202 rollback_lock_file(lock);
2203 free(filename_buf);
2204 if (contents)
2205 munmap(contents, contents_sz);
2206 if (in_fd >= 0)
2207 close(in_fd);
2208 return ret;
2210 write_err_out:
2211 ret = write_error(get_lock_file_path(lock));
2212 goto out_free;
2216 void git_config_set_multivar_in_file(const char *config_filename,
2217 const char *key, const char *value,
2218 const char *value_regex, int multi_replace)
2220 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2221 value_regex, multi_replace))
2222 return;
2223 if (value)
2224 die(_("could not set '%s' to '%s'"), key, value);
2225 else
2226 die(_("could not unset '%s'"), key);
2229 int git_config_set_multivar_gently(const char *key, const char *value,
2230 const char *value_regex, int multi_replace)
2232 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2233 multi_replace);
2236 void git_config_set_multivar(const char *key, const char *value,
2237 const char *value_regex, int multi_replace)
2239 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2240 multi_replace);
2243 static int section_name_match (const char *buf, const char *name)
2245 int i = 0, j = 0, dot = 0;
2246 if (buf[i] != '[')
2247 return 0;
2248 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2249 if (!dot && isspace(buf[i])) {
2250 dot = 1;
2251 if (name[j++] != '.')
2252 break;
2253 for (i++; isspace(buf[i]); i++)
2254 ; /* do nothing */
2255 if (buf[i] != '"')
2256 break;
2257 continue;
2259 if (buf[i] == '\\' && dot)
2260 i++;
2261 else if (buf[i] == '"' && dot) {
2262 for (i++; isspace(buf[i]); i++)
2263 ; /* do_nothing */
2264 break;
2266 if (buf[i] != name[j++])
2267 break;
2269 if (buf[i] == ']' && name[j] == 0) {
2271 * We match, now just find the right length offset by
2272 * gobbling up any whitespace after it, as well
2274 i++;
2275 for (; buf[i] && isspace(buf[i]); i++)
2276 ; /* do nothing */
2277 return i;
2279 return 0;
2282 static int section_name_is_ok(const char *name)
2284 /* Empty section names are bogus. */
2285 if (!*name)
2286 return 0;
2289 * Before a dot, we must be alphanumeric or dash. After the first dot,
2290 * anything goes, so we can stop checking.
2292 for (; *name && *name != '.'; name++)
2293 if (*name != '-' && !isalnum(*name))
2294 return 0;
2295 return 1;
2298 /* if new_name == NULL, the section is removed instead */
2299 int git_config_rename_section_in_file(const char *config_filename,
2300 const char *old_name, const char *new_name)
2302 int ret = 0, remove = 0;
2303 char *filename_buf = NULL;
2304 struct lock_file *lock;
2305 int out_fd;
2306 char buf[1024];
2307 FILE *config_file;
2308 struct stat st;
2310 if (new_name && !section_name_is_ok(new_name)) {
2311 ret = error("invalid section name: %s", new_name);
2312 goto out;
2315 if (!config_filename)
2316 config_filename = filename_buf = git_pathdup("config");
2318 lock = xcalloc(1, sizeof(struct lock_file));
2319 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2320 if (out_fd < 0) {
2321 ret = error("could not lock config file %s", config_filename);
2322 goto out;
2325 if (!(config_file = fopen(config_filename, "rb"))) {
2326 /* no config file means nothing to rename, no error */
2327 goto unlock_and_out;
2330 fstat(fileno(config_file), &st);
2332 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2333 ret = error_errno("chmod on %s failed",
2334 get_lock_file_path(lock));
2335 goto out;
2338 while (fgets(buf, sizeof(buf), config_file)) {
2339 int i;
2340 int length;
2341 char *output = buf;
2342 for (i = 0; buf[i] && isspace(buf[i]); i++)
2343 ; /* do nothing */
2344 if (buf[i] == '[') {
2345 /* it's a section */
2346 int offset = section_name_match(&buf[i], old_name);
2347 if (offset > 0) {
2348 ret++;
2349 if (new_name == NULL) {
2350 remove = 1;
2351 continue;
2353 store.baselen = strlen(new_name);
2354 if (!store_write_section(out_fd, new_name)) {
2355 ret = write_error(get_lock_file_path(lock));
2356 goto out;
2359 * We wrote out the new section, with
2360 * a newline, now skip the old
2361 * section's length
2363 output += offset + i;
2364 if (strlen(output) > 0) {
2366 * More content means there's
2367 * a declaration to put on the
2368 * next line; indent with a
2369 * tab
2371 output -= 1;
2372 output[0] = '\t';
2375 remove = 0;
2377 if (remove)
2378 continue;
2379 length = strlen(output);
2380 if (write_in_full(out_fd, output, length) != length) {
2381 ret = write_error(get_lock_file_path(lock));
2382 goto out;
2385 fclose(config_file);
2386 unlock_and_out:
2387 if (commit_lock_file(lock) < 0)
2388 ret = error_errno("could not write config file %s",
2389 config_filename);
2390 out:
2391 free(filename_buf);
2392 return ret;
2395 int git_config_rename_section(const char *old_name, const char *new_name)
2397 return git_config_rename_section_in_file(NULL, old_name, new_name);
2401 * Call this to report error for your variable that should not
2402 * get a boolean value (i.e. "[my] var" means "true").
2404 #undef config_error_nonbool
2405 int config_error_nonbool(const char *var)
2407 return error("missing value for '%s'", var);
2410 int parse_config_key(const char *var,
2411 const char *section,
2412 const char **subsection, int *subsection_len,
2413 const char **key)
2415 int section_len = strlen(section);
2416 const char *dot;
2418 /* Does it start with "section." ? */
2419 if (!starts_with(var, section) || var[section_len] != '.')
2420 return -1;
2423 * Find the key; we don't know yet if we have a subsection, but we must
2424 * parse backwards from the end, since the subsection may have dots in
2425 * it, too.
2427 dot = strrchr(var, '.');
2428 *key = dot + 1;
2430 /* Did we have a subsection at all? */
2431 if (dot == var + section_len) {
2432 *subsection = NULL;
2433 *subsection_len = 0;
2435 else {
2436 *subsection = var + section_len + 1;
2437 *subsection_len = dot - *subsection;
2440 return 0;
2443 const char *current_config_origin_type(void)
2445 return cf && cf->origin_type ? cf->origin_type : "command line";
2448 const char *current_config_name(void)
2450 return cf && cf->name ? cf->name : "";