Merge branch 'cn/bom-in-gitignore' into maint
[git/git.git] / config.c
1 /*
2 * GIT - The information manager from hell
3 *
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
6 *
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"
16
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 *name;
28 const char *path;
29 int die_on_error;
30 int linenr;
31 int eof;
32 struct strbuf value;
33 struct strbuf var;
34
35 int (*do_fgetc)(struct config_source *c);
36 int (*do_ungetc)(int c, struct config_source *conf);
37 long (*do_ftell)(struct config_source *c);
38 };
39
40 static struct config_source *cf;
41
42 static int zlib_compression_seen;
43
44 /*
45 * Default config_set that contains key-value pairs from the usual set of config
46 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
47 * config file and the global /etc/gitconfig)
48 */
49 static struct config_set the_config_set;
50
51 static int config_file_fgetc(struct config_source *conf)
52 {
53 return fgetc(conf->u.file);
54 }
55
56 static int config_file_ungetc(int c, struct config_source *conf)
57 {
58 return ungetc(c, conf->u.file);
59 }
60
61 static long config_file_ftell(struct config_source *conf)
62 {
63 return ftell(conf->u.file);
64 }
65
66
67 static int config_buf_fgetc(struct config_source *conf)
68 {
69 if (conf->u.buf.pos < conf->u.buf.len)
70 return conf->u.buf.buf[conf->u.buf.pos++];
71
72 return EOF;
73 }
74
75 static int config_buf_ungetc(int c, struct config_source *conf)
76 {
77 if (conf->u.buf.pos > 0) {
78 conf->u.buf.pos--;
79 if (conf->u.buf.buf[conf->u.buf.pos] != c)
80 die("BUG: config_buf can only ungetc the same character");
81 return c;
82 }
83
84 return EOF;
85 }
86
87 static long config_buf_ftell(struct config_source *conf)
88 {
89 return conf->u.buf.pos;
90 }
91
92 #define MAX_INCLUDE_DEPTH 10
93 static const char include_depth_advice[] =
94 "exceeded maximum include depth (%d) while including\n"
95 " %s\n"
96 "from\n"
97 " %s\n"
98 "Do you have circular includes?";
99 static int handle_path_include(const char *path, struct config_include_data *inc)
100 {
101 int ret = 0;
102 struct strbuf buf = STRBUF_INIT;
103 char *expanded;
104
105 if (!path)
106 return config_error_nonbool("include.path");
107
108 expanded = expand_user_path(path);
109 if (!expanded)
110 return error("Could not expand include path '%s'", path);
111 path = expanded;
112
113 /*
114 * Use an absolute path as-is, but interpret relative paths
115 * based on the including config file.
116 */
117 if (!is_absolute_path(path)) {
118 char *slash;
119
120 if (!cf || !cf->path)
121 return error("relative config includes must come from files");
122
123 slash = find_last_dir_sep(cf->path);
124 if (slash)
125 strbuf_add(&buf, cf->path, slash - cf->path + 1);
126 strbuf_addstr(&buf, path);
127 path = buf.buf;
128 }
129
130 if (!access_or_die(path, R_OK, 0)) {
131 if (++inc->depth > MAX_INCLUDE_DEPTH)
132 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
133 cf && cf->name ? cf->name : "the command line");
134 ret = git_config_from_file(git_config_include, path, inc);
135 inc->depth--;
136 }
137 strbuf_release(&buf);
138 free(expanded);
139 return ret;
140 }
141
142 int git_config_include(const char *var, const char *value, void *data)
143 {
144 struct config_include_data *inc = data;
145 int ret;
146
147 /*
148 * Pass along all values, including "include" directives; this makes it
149 * possible to query information on the includes themselves.
150 */
151 ret = inc->fn(var, value, inc->data);
152 if (ret < 0)
153 return ret;
154
155 if (!strcmp(var, "include.path"))
156 ret = handle_path_include(value, inc);
157 return ret;
158 }
159
160 void git_config_push_parameter(const char *text)
161 {
162 struct strbuf env = STRBUF_INIT;
163 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
164 if (old) {
165 strbuf_addstr(&env, old);
166 strbuf_addch(&env, ' ');
167 }
168 sq_quote_buf(&env, text);
169 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
170 strbuf_release(&env);
171 }
172
173 int git_config_parse_parameter(const char *text,
174 config_fn_t fn, void *data)
175 {
176 const char *value;
177 struct strbuf **pair;
178
179 pair = strbuf_split_str(text, '=', 2);
180 if (!pair[0])
181 return error("bogus config parameter: %s", text);
182
183 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
184 strbuf_setlen(pair[0], pair[0]->len - 1);
185 value = pair[1] ? pair[1]->buf : "";
186 } else {
187 value = NULL;
188 }
189
190 strbuf_trim(pair[0]);
191 if (!pair[0]->len) {
192 strbuf_list_free(pair);
193 return error("bogus config parameter: %s", text);
194 }
195 strbuf_tolower(pair[0]);
196 if (fn(pair[0]->buf, value, data) < 0) {
197 strbuf_list_free(pair);
198 return -1;
199 }
200 strbuf_list_free(pair);
201 return 0;
202 }
203
204 int git_config_from_parameters(config_fn_t fn, void *data)
205 {
206 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
207 char *envw;
208 const char **argv = NULL;
209 int nr = 0, alloc = 0;
210 int i;
211
212 if (!env)
213 return 0;
214 /* sq_dequote will write over it */
215 envw = xstrdup(env);
216
217 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
218 free(envw);
219 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
220 }
221
222 for (i = 0; i < nr; i++) {
223 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
224 free(argv);
225 free(envw);
226 return -1;
227 }
228 }
229
230 free(argv);
231 free(envw);
232 return nr > 0;
233 }
234
235 static int get_next_char(void)
236 {
237 int c = cf->do_fgetc(cf);
238
239 if (c == '\r') {
240 /* DOS like systems */
241 c = cf->do_fgetc(cf);
242 if (c != '\n') {
243 if (c != EOF)
244 cf->do_ungetc(c, cf);
245 c = '\r';
246 }
247 }
248 if (c == '\n')
249 cf->linenr++;
250 if (c == EOF) {
251 cf->eof = 1;
252 cf->linenr++;
253 c = '\n';
254 }
255 return c;
256 }
257
258 static char *parse_value(void)
259 {
260 int quote = 0, comment = 0, space = 0;
261
262 strbuf_reset(&cf->value);
263 for (;;) {
264 int c = get_next_char();
265 if (c == '\n') {
266 if (quote) {
267 cf->linenr--;
268 return NULL;
269 }
270 return cf->value.buf;
271 }
272 if (comment)
273 continue;
274 if (isspace(c) && !quote) {
275 if (cf->value.len)
276 space++;
277 continue;
278 }
279 if (!quote) {
280 if (c == ';' || c == '#') {
281 comment = 1;
282 continue;
283 }
284 }
285 for (; space; space--)
286 strbuf_addch(&cf->value, ' ');
287 if (c == '\\') {
288 c = get_next_char();
289 switch (c) {
290 case '\n':
291 continue;
292 case 't':
293 c = '\t';
294 break;
295 case 'b':
296 c = '\b';
297 break;
298 case 'n':
299 c = '\n';
300 break;
301 /* Some characters escape as themselves */
302 case '\\': case '"':
303 break;
304 /* Reject unknown escape sequences */
305 default:
306 return NULL;
307 }
308 strbuf_addch(&cf->value, c);
309 continue;
310 }
311 if (c == '"') {
312 quote = 1-quote;
313 continue;
314 }
315 strbuf_addch(&cf->value, c);
316 }
317 }
318
319 static inline int iskeychar(int c)
320 {
321 return isalnum(c) || c == '-';
322 }
323
324 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
325 {
326 int c;
327 char *value;
328 int ret;
329
330 /* Get the full name */
331 for (;;) {
332 c = get_next_char();
333 if (cf->eof)
334 break;
335 if (!iskeychar(c))
336 break;
337 strbuf_addch(name, tolower(c));
338 }
339
340 while (c == ' ' || c == '\t')
341 c = get_next_char();
342
343 value = NULL;
344 if (c != '\n') {
345 if (c != '=')
346 return -1;
347 value = parse_value();
348 if (!value)
349 return -1;
350 }
351 /*
352 * We already consumed the \n, but we need linenr to point to
353 * the line we just parsed during the call to fn to get
354 * accurate line number in error messages.
355 */
356 cf->linenr--;
357 ret = fn(name->buf, value, data);
358 cf->linenr++;
359 return ret;
360 }
361
362 static int get_extended_base_var(struct strbuf *name, int c)
363 {
364 do {
365 if (c == '\n')
366 goto error_incomplete_line;
367 c = get_next_char();
368 } while (isspace(c));
369
370 /* We require the format to be '[base "extension"]' */
371 if (c != '"')
372 return -1;
373 strbuf_addch(name, '.');
374
375 for (;;) {
376 int c = get_next_char();
377 if (c == '\n')
378 goto error_incomplete_line;
379 if (c == '"')
380 break;
381 if (c == '\\') {
382 c = get_next_char();
383 if (c == '\n')
384 goto error_incomplete_line;
385 }
386 strbuf_addch(name, c);
387 }
388
389 /* Final ']' */
390 if (get_next_char() != ']')
391 return -1;
392 return 0;
393 error_incomplete_line:
394 cf->linenr--;
395 return -1;
396 }
397
398 static int get_base_var(struct strbuf *name)
399 {
400 for (;;) {
401 int c = get_next_char();
402 if (cf->eof)
403 return -1;
404 if (c == ']')
405 return 0;
406 if (isspace(c))
407 return get_extended_base_var(name, c);
408 if (!iskeychar(c) && c != '.')
409 return -1;
410 strbuf_addch(name, tolower(c));
411 }
412 }
413
414 static int git_parse_source(config_fn_t fn, void *data)
415 {
416 int comment = 0;
417 int baselen = 0;
418 struct strbuf *var = &cf->var;
419
420 /* U+FEFF Byte Order Mark in UTF8 */
421 const char *bomptr = utf8_bom;
422
423 for (;;) {
424 int c = get_next_char();
425 if (bomptr && *bomptr) {
426 /* We are at the file beginning; skip UTF8-encoded BOM
427 * if present. Sane editors won't put this in on their
428 * own, but e.g. Windows Notepad will do it happily. */
429 if (c == (*bomptr & 0377)) {
430 bomptr++;
431 continue;
432 } else {
433 /* Do not tolerate partial BOM. */
434 if (bomptr != utf8_bom)
435 break;
436 /* No BOM at file beginning. Cool. */
437 bomptr = NULL;
438 }
439 }
440 if (c == '\n') {
441 if (cf->eof)
442 return 0;
443 comment = 0;
444 continue;
445 }
446 if (comment || isspace(c))
447 continue;
448 if (c == '#' || c == ';') {
449 comment = 1;
450 continue;
451 }
452 if (c == '[') {
453 /* Reset prior to determining a new stem */
454 strbuf_reset(var);
455 if (get_base_var(var) < 0 || var->len < 1)
456 break;
457 strbuf_addch(var, '.');
458 baselen = var->len;
459 continue;
460 }
461 if (!isalpha(c))
462 break;
463 /*
464 * Truncate the var name back to the section header
465 * stem prior to grabbing the suffix part of the name
466 * and the value.
467 */
468 strbuf_setlen(var, baselen);
469 strbuf_addch(var, tolower(c));
470 if (get_value(fn, data, var) < 0)
471 break;
472 }
473 if (cf->die_on_error)
474 die(_("bad config file line %d in %s"), cf->linenr, cf->name);
475 else
476 return error(_("bad config file line %d in %s"), cf->linenr, cf->name);
477 }
478
479 static int parse_unit_factor(const char *end, uintmax_t *val)
480 {
481 if (!*end)
482 return 1;
483 else if (!strcasecmp(end, "k")) {
484 *val *= 1024;
485 return 1;
486 }
487 else if (!strcasecmp(end, "m")) {
488 *val *= 1024 * 1024;
489 return 1;
490 }
491 else if (!strcasecmp(end, "g")) {
492 *val *= 1024 * 1024 * 1024;
493 return 1;
494 }
495 return 0;
496 }
497
498 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
499 {
500 if (value && *value) {
501 char *end;
502 intmax_t val;
503 uintmax_t uval;
504 uintmax_t factor = 1;
505
506 errno = 0;
507 val = strtoimax(value, &end, 0);
508 if (errno == ERANGE)
509 return 0;
510 if (!parse_unit_factor(end, &factor)) {
511 errno = EINVAL;
512 return 0;
513 }
514 uval = labs(val);
515 uval *= factor;
516 if (uval > max || labs(val) > uval) {
517 errno = ERANGE;
518 return 0;
519 }
520 val *= factor;
521 *ret = val;
522 return 1;
523 }
524 errno = EINVAL;
525 return 0;
526 }
527
528 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
529 {
530 if (value && *value) {
531 char *end;
532 uintmax_t val;
533 uintmax_t oldval;
534
535 errno = 0;
536 val = strtoumax(value, &end, 0);
537 if (errno == ERANGE)
538 return 0;
539 oldval = val;
540 if (!parse_unit_factor(end, &val)) {
541 errno = EINVAL;
542 return 0;
543 }
544 if (val > max || oldval > val) {
545 errno = ERANGE;
546 return 0;
547 }
548 *ret = val;
549 return 1;
550 }
551 errno = EINVAL;
552 return 0;
553 }
554
555 static int git_parse_int(const char *value, int *ret)
556 {
557 intmax_t tmp;
558 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
559 return 0;
560 *ret = tmp;
561 return 1;
562 }
563
564 static int git_parse_int64(const char *value, int64_t *ret)
565 {
566 intmax_t tmp;
567 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
568 return 0;
569 *ret = tmp;
570 return 1;
571 }
572
573 int git_parse_ulong(const char *value, unsigned long *ret)
574 {
575 uintmax_t tmp;
576 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
577 return 0;
578 *ret = tmp;
579 return 1;
580 }
581
582 NORETURN
583 static void die_bad_number(const char *name, const char *value)
584 {
585 const char *reason = errno == ERANGE ?
586 "out of range" :
587 "invalid unit";
588 if (!value)
589 value = "";
590
591 if (cf && cf->name)
592 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
593 value, name, cf->name, reason);
594 die(_("bad numeric config value '%s' for '%s': %s"), value, name, reason);
595 }
596
597 int git_config_int(const char *name, const char *value)
598 {
599 int ret;
600 if (!git_parse_int(value, &ret))
601 die_bad_number(name, value);
602 return ret;
603 }
604
605 int64_t git_config_int64(const char *name, const char *value)
606 {
607 int64_t ret;
608 if (!git_parse_int64(value, &ret))
609 die_bad_number(name, value);
610 return ret;
611 }
612
613 unsigned long git_config_ulong(const char *name, const char *value)
614 {
615 unsigned long ret;
616 if (!git_parse_ulong(value, &ret))
617 die_bad_number(name, value);
618 return ret;
619 }
620
621 static int git_config_maybe_bool_text(const char *name, const char *value)
622 {
623 if (!value)
624 return 1;
625 if (!*value)
626 return 0;
627 if (!strcasecmp(value, "true")
628 || !strcasecmp(value, "yes")
629 || !strcasecmp(value, "on"))
630 return 1;
631 if (!strcasecmp(value, "false")
632 || !strcasecmp(value, "no")
633 || !strcasecmp(value, "off"))
634 return 0;
635 return -1;
636 }
637
638 int git_config_maybe_bool(const char *name, const char *value)
639 {
640 int v = git_config_maybe_bool_text(name, value);
641 if (0 <= v)
642 return v;
643 if (git_parse_int(value, &v))
644 return !!v;
645 return -1;
646 }
647
648 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
649 {
650 int v = git_config_maybe_bool_text(name, value);
651 if (0 <= v) {
652 *is_bool = 1;
653 return v;
654 }
655 *is_bool = 0;
656 return git_config_int(name, value);
657 }
658
659 int git_config_bool(const char *name, const char *value)
660 {
661 int discard;
662 return !!git_config_bool_or_int(name, value, &discard);
663 }
664
665 int git_config_string(const char **dest, const char *var, const char *value)
666 {
667 if (!value)
668 return config_error_nonbool(var);
669 *dest = xstrdup(value);
670 return 0;
671 }
672
673 int git_config_pathname(const char **dest, const char *var, const char *value)
674 {
675 if (!value)
676 return config_error_nonbool(var);
677 *dest = expand_user_path(value);
678 if (!*dest)
679 die(_("failed to expand user dir in: '%s'"), value);
680 return 0;
681 }
682
683 static int git_default_core_config(const char *var, const char *value)
684 {
685 /* This needs a better name */
686 if (!strcmp(var, "core.filemode")) {
687 trust_executable_bit = git_config_bool(var, value);
688 return 0;
689 }
690 if (!strcmp(var, "core.trustctime")) {
691 trust_ctime = git_config_bool(var, value);
692 return 0;
693 }
694 if (!strcmp(var, "core.checkstat")) {
695 if (!strcasecmp(value, "default"))
696 check_stat = 1;
697 else if (!strcasecmp(value, "minimal"))
698 check_stat = 0;
699 }
700
701 if (!strcmp(var, "core.quotepath")) {
702 quote_path_fully = git_config_bool(var, value);
703 return 0;
704 }
705
706 if (!strcmp(var, "core.symlinks")) {
707 has_symlinks = git_config_bool(var, value);
708 return 0;
709 }
710
711 if (!strcmp(var, "core.ignorecase")) {
712 ignore_case = git_config_bool(var, value);
713 return 0;
714 }
715
716 if (!strcmp(var, "core.attributesfile"))
717 return git_config_pathname(&git_attributes_file, var, value);
718
719 if (!strcmp(var, "core.bare")) {
720 is_bare_repository_cfg = git_config_bool(var, value);
721 return 0;
722 }
723
724 if (!strcmp(var, "core.ignorestat")) {
725 assume_unchanged = git_config_bool(var, value);
726 return 0;
727 }
728
729 if (!strcmp(var, "core.prefersymlinkrefs")) {
730 prefer_symlink_refs = git_config_bool(var, value);
731 return 0;
732 }
733
734 if (!strcmp(var, "core.logallrefupdates")) {
735 log_all_ref_updates = git_config_bool(var, value);
736 return 0;
737 }
738
739 if (!strcmp(var, "core.warnambiguousrefs")) {
740 warn_ambiguous_refs = git_config_bool(var, value);
741 return 0;
742 }
743
744 if (!strcmp(var, "core.abbrev")) {
745 int abbrev = git_config_int(var, value);
746 if (abbrev < minimum_abbrev || abbrev > 40)
747 return -1;
748 default_abbrev = abbrev;
749 return 0;
750 }
751
752 if (!strcmp(var, "core.loosecompression")) {
753 int level = git_config_int(var, value);
754 if (level == -1)
755 level = Z_DEFAULT_COMPRESSION;
756 else if (level < 0 || level > Z_BEST_COMPRESSION)
757 die(_("bad zlib compression level %d"), level);
758 zlib_compression_level = level;
759 zlib_compression_seen = 1;
760 return 0;
761 }
762
763 if (!strcmp(var, "core.compression")) {
764 int level = git_config_int(var, value);
765 if (level == -1)
766 level = Z_DEFAULT_COMPRESSION;
767 else if (level < 0 || level > Z_BEST_COMPRESSION)
768 die(_("bad zlib compression level %d"), level);
769 core_compression_level = level;
770 core_compression_seen = 1;
771 if (!zlib_compression_seen)
772 zlib_compression_level = level;
773 return 0;
774 }
775
776 if (!strcmp(var, "core.packedgitwindowsize")) {
777 int pgsz_x2 = getpagesize() * 2;
778 packed_git_window_size = git_config_ulong(var, value);
779
780 /* This value must be multiple of (pagesize * 2) */
781 packed_git_window_size /= pgsz_x2;
782 if (packed_git_window_size < 1)
783 packed_git_window_size = 1;
784 packed_git_window_size *= pgsz_x2;
785 return 0;
786 }
787
788 if (!strcmp(var, "core.bigfilethreshold")) {
789 big_file_threshold = git_config_ulong(var, value);
790 return 0;
791 }
792
793 if (!strcmp(var, "core.packedgitlimit")) {
794 packed_git_limit = git_config_ulong(var, value);
795 return 0;
796 }
797
798 if (!strcmp(var, "core.deltabasecachelimit")) {
799 delta_base_cache_limit = git_config_ulong(var, value);
800 return 0;
801 }
802
803 if (!strcmp(var, "core.autocrlf")) {
804 if (value && !strcasecmp(value, "input")) {
805 if (core_eol == EOL_CRLF)
806 return error("core.autocrlf=input conflicts with core.eol=crlf");
807 auto_crlf = AUTO_CRLF_INPUT;
808 return 0;
809 }
810 auto_crlf = git_config_bool(var, value);
811 return 0;
812 }
813
814 if (!strcmp(var, "core.safecrlf")) {
815 if (value && !strcasecmp(value, "warn")) {
816 safe_crlf = SAFE_CRLF_WARN;
817 return 0;
818 }
819 safe_crlf = git_config_bool(var, value);
820 return 0;
821 }
822
823 if (!strcmp(var, "core.eol")) {
824 if (value && !strcasecmp(value, "lf"))
825 core_eol = EOL_LF;
826 else if (value && !strcasecmp(value, "crlf"))
827 core_eol = EOL_CRLF;
828 else if (value && !strcasecmp(value, "native"))
829 core_eol = EOL_NATIVE;
830 else
831 core_eol = EOL_UNSET;
832 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
833 return error("core.autocrlf=input conflicts with core.eol=crlf");
834 return 0;
835 }
836
837 if (!strcmp(var, "core.notesref")) {
838 notes_ref_name = xstrdup(value);
839 return 0;
840 }
841
842 if (!strcmp(var, "core.pager"))
843 return git_config_string(&pager_program, var, value);
844
845 if (!strcmp(var, "core.editor"))
846 return git_config_string(&editor_program, var, value);
847
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;
859 }
860
861 if (!strcmp(var, "core.askpass"))
862 return git_config_string(&askpass_program, var, value);
863
864 if (!strcmp(var, "core.excludesfile"))
865 return git_config_pathname(&excludes_file, var, value);
866
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;
872 }
873
874 if (!strcmp(var, "core.fsyncobjectfiles")) {
875 fsync_object_files = git_config_bool(var, value);
876 return 0;
877 }
878
879 if (!strcmp(var, "core.preloadindex")) {
880 core_preload_index = git_config_bool(var, value);
881 return 0;
882 }
883
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;
892 }
893
894 if (!strcmp(var, "core.sparsecheckout")) {
895 core_apply_sparse_checkout = git_config_bool(var, value);
896 return 0;
897 }
898
899 if (!strcmp(var, "core.precomposeunicode")) {
900 precomposed_unicode = git_config_bool(var, value);
901 return 0;
902 }
903
904 if (!strcmp(var, "core.protecthfs")) {
905 protect_hfs = git_config_bool(var, value);
906 return 0;
907 }
908
909 if (!strcmp(var, "core.protectntfs")) {
910 protect_ntfs = git_config_bool(var, value);
911 return 0;
912 }
913
914 /* Add other config variables here and to Documentation/config.txt. */
915 return 0;
916 }
917
918 static int git_default_i18n_config(const char *var, const char *value)
919 {
920 if (!strcmp(var, "i18n.commitencoding"))
921 return git_config_string(&git_commit_encoding, var, value);
922
923 if (!strcmp(var, "i18n.logoutputencoding"))
924 return git_config_string(&git_log_output_encoding, var, value);
925
926 /* Add other config variables here and to Documentation/config.txt. */
927 return 0;
928 }
929
930 static int git_default_branch_config(const char *var, const char *value)
931 {
932 if (!strcmp(var, "branch.autosetupmerge")) {
933 if (value && !strcasecmp(value, "always")) {
934 git_branch_track = BRANCH_TRACK_ALWAYS;
935 return 0;
936 }
937 git_branch_track = git_config_bool(var, value);
938 return 0;
939 }
940 if (!strcmp(var, "branch.autosetuprebase")) {
941 if (!value)
942 return config_error_nonbool(var);
943 else if (!strcmp(value, "never"))
944 autorebase = AUTOREBASE_NEVER;
945 else if (!strcmp(value, "local"))
946 autorebase = AUTOREBASE_LOCAL;
947 else if (!strcmp(value, "remote"))
948 autorebase = AUTOREBASE_REMOTE;
949 else if (!strcmp(value, "always"))
950 autorebase = AUTOREBASE_ALWAYS;
951 else
952 return error("Malformed value for %s", var);
953 return 0;
954 }
955
956 /* Add other config variables here and to Documentation/config.txt. */
957 return 0;
958 }
959
960 static int git_default_push_config(const char *var, const char *value)
961 {
962 if (!strcmp(var, "push.default")) {
963 if (!value)
964 return config_error_nonbool(var);
965 else if (!strcmp(value, "nothing"))
966 push_default = PUSH_DEFAULT_NOTHING;
967 else if (!strcmp(value, "matching"))
968 push_default = PUSH_DEFAULT_MATCHING;
969 else if (!strcmp(value, "simple"))
970 push_default = PUSH_DEFAULT_SIMPLE;
971 else if (!strcmp(value, "upstream"))
972 push_default = PUSH_DEFAULT_UPSTREAM;
973 else if (!strcmp(value, "tracking")) /* deprecated */
974 push_default = PUSH_DEFAULT_UPSTREAM;
975 else if (!strcmp(value, "current"))
976 push_default = PUSH_DEFAULT_CURRENT;
977 else {
978 error("Malformed value for %s: %s", var, value);
979 return error("Must be one of nothing, matching, simple, "
980 "upstream or current.");
981 }
982 return 0;
983 }
984
985 /* Add other config variables here and to Documentation/config.txt. */
986 return 0;
987 }
988
989 static int git_default_mailmap_config(const char *var, const char *value)
990 {
991 if (!strcmp(var, "mailmap.file"))
992 return git_config_pathname(&git_mailmap_file, var, value);
993 if (!strcmp(var, "mailmap.blob"))
994 return git_config_string(&git_mailmap_blob, var, value);
995
996 /* Add other config variables here and to Documentation/config.txt. */
997 return 0;
998 }
999
1000 int git_default_config(const char *var, const char *value, void *dummy)
1001 {
1002 if (starts_with(var, "core."))
1003 return git_default_core_config(var, value);
1004
1005 if (starts_with(var, "user."))
1006 return git_ident_config(var, value, dummy);
1007
1008 if (starts_with(var, "i18n."))
1009 return git_default_i18n_config(var, value);
1010
1011 if (starts_with(var, "branch."))
1012 return git_default_branch_config(var, value);
1013
1014 if (starts_with(var, "push."))
1015 return git_default_push_config(var, value);
1016
1017 if (starts_with(var, "mailmap."))
1018 return git_default_mailmap_config(var, value);
1019
1020 if (starts_with(var, "advice."))
1021 return git_default_advice_config(var, value);
1022
1023 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1024 pager_use_color = git_config_bool(var,value);
1025 return 0;
1026 }
1027
1028 if (!strcmp(var, "pack.packsizelimit")) {
1029 pack_size_limit_cfg = git_config_ulong(var, value);
1030 return 0;
1031 }
1032 /* Add other config variables here and to Documentation/config.txt. */
1033 return 0;
1034 }
1035
1036 /*
1037 * All source specific fields in the union, die_on_error, name and the callbacks
1038 * fgetc, ungetc, ftell of top need to be initialized before calling
1039 * this function.
1040 */
1041 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1042 {
1043 int ret;
1044
1045 /* push config-file parsing state stack */
1046 top->prev = cf;
1047 top->linenr = 1;
1048 top->eof = 0;
1049 strbuf_init(&top->value, 1024);
1050 strbuf_init(&top->var, 1024);
1051 cf = top;
1052
1053 ret = git_parse_source(fn, data);
1054
1055 /* pop config-file parsing state stack */
1056 strbuf_release(&top->value);
1057 strbuf_release(&top->var);
1058 cf = top->prev;
1059
1060 return ret;
1061 }
1062
1063 static int do_config_from_file(config_fn_t fn,
1064 const char *name, const char *path, FILE *f, void *data)
1065 {
1066 struct config_source top;
1067
1068 top.u.file = f;
1069 top.name = name;
1070 top.path = path;
1071 top.die_on_error = 1;
1072 top.do_fgetc = config_file_fgetc;
1073 top.do_ungetc = config_file_ungetc;
1074 top.do_ftell = config_file_ftell;
1075
1076 return do_config_from(&top, fn, data);
1077 }
1078
1079 static int git_config_from_stdin(config_fn_t fn, void *data)
1080 {
1081 return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
1082 }
1083
1084 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1085 {
1086 int ret = -1;
1087 FILE *f;
1088
1089 f = fopen(filename, "r");
1090 if (f) {
1091 ret = do_config_from_file(fn, filename, filename, f, data);
1092 fclose(f);
1093 }
1094 return ret;
1095 }
1096
1097 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1098 size_t len, void *data)
1099 {
1100 struct config_source top;
1101
1102 top.u.buf.buf = buf;
1103 top.u.buf.len = len;
1104 top.u.buf.pos = 0;
1105 top.name = name;
1106 top.path = NULL;
1107 top.die_on_error = 0;
1108 top.do_fgetc = config_buf_fgetc;
1109 top.do_ungetc = config_buf_ungetc;
1110 top.do_ftell = config_buf_ftell;
1111
1112 return do_config_from(&top, fn, data);
1113 }
1114
1115 static int git_config_from_blob_sha1(config_fn_t fn,
1116 const char *name,
1117 const unsigned char *sha1,
1118 void *data)
1119 {
1120 enum object_type type;
1121 char *buf;
1122 unsigned long size;
1123 int ret;
1124
1125 buf = read_sha1_file(sha1, &type, &size);
1126 if (!buf)
1127 return error("unable to load config blob object '%s'", name);
1128 if (type != OBJ_BLOB) {
1129 free(buf);
1130 return error("reference '%s' does not point to a blob", name);
1131 }
1132
1133 ret = git_config_from_buf(fn, name, buf, size, data);
1134 free(buf);
1135
1136 return ret;
1137 }
1138
1139 static int git_config_from_blob_ref(config_fn_t fn,
1140 const char *name,
1141 void *data)
1142 {
1143 unsigned char sha1[20];
1144
1145 if (get_sha1(name, sha1) < 0)
1146 return error("unable to resolve config blob '%s'", name);
1147 return git_config_from_blob_sha1(fn, name, sha1, data);
1148 }
1149
1150 const char *git_etc_gitconfig(void)
1151 {
1152 static const char *system_wide;
1153 if (!system_wide)
1154 system_wide = system_path(ETC_GITCONFIG);
1155 return system_wide;
1156 }
1157
1158 /*
1159 * Parse environment variable 'k' as a boolean (in various
1160 * possible spellings); if missing, use the default value 'def'.
1161 */
1162 int git_env_bool(const char *k, int def)
1163 {
1164 const char *v = getenv(k);
1165 return v ? git_config_bool(k, v) : def;
1166 }
1167
1168 /*
1169 * Parse environment variable 'k' as ulong with possibly a unit
1170 * suffix; if missing, use the default value 'val'.
1171 */
1172 unsigned long git_env_ulong(const char *k, unsigned long val)
1173 {
1174 const char *v = getenv(k);
1175 if (v && !git_parse_ulong(v, &val))
1176 die("failed to parse %s", k);
1177 return val;
1178 }
1179
1180 int git_config_system(void)
1181 {
1182 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1183 }
1184
1185 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1186 {
1187 int ret = 0, found = 0;
1188 char *xdg_config = NULL;
1189 char *user_config = NULL;
1190
1191 home_config_paths(&user_config, &xdg_config, "config");
1192
1193 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1194 ret += git_config_from_file(fn, git_etc_gitconfig(),
1195 data);
1196 found += 1;
1197 }
1198
1199 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1200 ret += git_config_from_file(fn, xdg_config, data);
1201 found += 1;
1202 }
1203
1204 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1205 ret += git_config_from_file(fn, user_config, data);
1206 found += 1;
1207 }
1208
1209 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1210 ret += git_config_from_file(fn, repo_config, data);
1211 found += 1;
1212 }
1213
1214 switch (git_config_from_parameters(fn, data)) {
1215 case -1: /* error */
1216 die(_("unable to parse command-line config"));
1217 break;
1218 case 0: /* found nothing */
1219 break;
1220 default: /* found at least one item */
1221 found++;
1222 break;
1223 }
1224
1225 free(xdg_config);
1226 free(user_config);
1227 return ret == 0 ? found : ret;
1228 }
1229
1230 int git_config_with_options(config_fn_t fn, void *data,
1231 struct git_config_source *config_source,
1232 int respect_includes)
1233 {
1234 char *repo_config = NULL;
1235 int ret;
1236 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1237
1238 if (respect_includes) {
1239 inc.fn = fn;
1240 inc.data = data;
1241 fn = git_config_include;
1242 data = &inc;
1243 }
1244
1245 /*
1246 * If we have a specific filename, use it. Otherwise, follow the
1247 * regular lookup sequence.
1248 */
1249 if (config_source && config_source->use_stdin)
1250 return git_config_from_stdin(fn, data);
1251 else if (config_source && config_source->file)
1252 return git_config_from_file(fn, config_source->file, data);
1253 else if (config_source && config_source->blob)
1254 return git_config_from_blob_ref(fn, config_source->blob, data);
1255
1256 repo_config = git_pathdup("config");
1257 ret = git_config_early(fn, data, repo_config);
1258 if (repo_config)
1259 free(repo_config);
1260 return ret;
1261 }
1262
1263 static void git_config_raw(config_fn_t fn, void *data)
1264 {
1265 if (git_config_with_options(fn, data, NULL, 1) < 0)
1266 /*
1267 * git_config_with_options() normally returns only
1268 * positive values, as most errors are fatal, and
1269 * non-fatal potential errors are guarded by "if"
1270 * statements that are entered only when no error is
1271 * possible.
1272 *
1273 * If we ever encounter a non-fatal error, it means
1274 * something went really wrong and we should stop
1275 * immediately.
1276 */
1277 die(_("unknown error occured while reading the configuration files"));
1278 }
1279
1280 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1281 {
1282 int i, value_index;
1283 struct string_list *values;
1284 struct config_set_element *entry;
1285 struct configset_list *list = &cs->list;
1286 struct key_value_info *kv_info;
1287
1288 for (i = 0; i < list->nr; i++) {
1289 entry = list->items[i].e;
1290 value_index = list->items[i].value_index;
1291 values = &entry->value_list;
1292 if (fn(entry->key, values->items[value_index].string, data) < 0) {
1293 kv_info = values->items[value_index].util;
1294 git_die_config_linenr(entry->key, kv_info->filename, kv_info->linenr);
1295 }
1296 }
1297 }
1298
1299 static void git_config_check_init(void);
1300
1301 void git_config(config_fn_t fn, void *data)
1302 {
1303 git_config_check_init();
1304 configset_iter(&the_config_set, fn, data);
1305 }
1306
1307 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1308 {
1309 struct config_set_element k;
1310 struct config_set_element *found_entry;
1311 char *normalized_key;
1312 int ret;
1313 /*
1314 * `key` may come from the user, so normalize it before using it
1315 * for querying entries from the hashmap.
1316 */
1317 ret = git_config_parse_key(key, &normalized_key, NULL);
1318
1319 if (ret)
1320 return NULL;
1321
1322 hashmap_entry_init(&k, strhash(normalized_key));
1323 k.key = normalized_key;
1324 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1325 free(normalized_key);
1326 return found_entry;
1327 }
1328
1329 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1330 {
1331 struct config_set_element *e;
1332 struct string_list_item *si;
1333 struct configset_list_item *l_item;
1334 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1335
1336 e = configset_find_element(cs, key);
1337 /*
1338 * Since the keys are being fed by git_config*() callback mechanism, they
1339 * are already normalized. So simply add them without any further munging.
1340 */
1341 if (!e) {
1342 e = xmalloc(sizeof(*e));
1343 hashmap_entry_init(e, strhash(key));
1344 e->key = xstrdup(key);
1345 string_list_init(&e->value_list, 1);
1346 hashmap_add(&cs->config_hash, e);
1347 }
1348 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1349
1350 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1351 l_item = &cs->list.items[cs->list.nr++];
1352 l_item->e = e;
1353 l_item->value_index = e->value_list.nr - 1;
1354
1355 if (cf) {
1356 kv_info->filename = strintern(cf->name);
1357 kv_info->linenr = cf->linenr;
1358 } else {
1359 /* for values read from `git_config_from_parameters()` */
1360 kv_info->filename = NULL;
1361 kv_info->linenr = -1;
1362 }
1363 si->util = kv_info;
1364
1365 return 0;
1366 }
1367
1368 static int config_set_element_cmp(const struct config_set_element *e1,
1369 const struct config_set_element *e2, const void *unused)
1370 {
1371 return strcmp(e1->key, e2->key);
1372 }
1373
1374 void git_configset_init(struct config_set *cs)
1375 {
1376 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1377 cs->hash_initialized = 1;
1378 cs->list.nr = 0;
1379 cs->list.alloc = 0;
1380 cs->list.items = NULL;
1381 }
1382
1383 void git_configset_clear(struct config_set *cs)
1384 {
1385 struct config_set_element *entry;
1386 struct hashmap_iter iter;
1387 if (!cs->hash_initialized)
1388 return;
1389
1390 hashmap_iter_init(&cs->config_hash, &iter);
1391 while ((entry = hashmap_iter_next(&iter))) {
1392 free(entry->key);
1393 string_list_clear(&entry->value_list, 1);
1394 }
1395 hashmap_free(&cs->config_hash, 1);
1396 cs->hash_initialized = 0;
1397 free(cs->list.items);
1398 cs->list.nr = 0;
1399 cs->list.alloc = 0;
1400 cs->list.items = NULL;
1401 }
1402
1403 static int config_set_callback(const char *key, const char *value, void *cb)
1404 {
1405 struct config_set *cs = cb;
1406 configset_add_value(cs, key, value);
1407 return 0;
1408 }
1409
1410 int git_configset_add_file(struct config_set *cs, const char *filename)
1411 {
1412 return git_config_from_file(config_set_callback, filename, cs);
1413 }
1414
1415 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1416 {
1417 const struct string_list *values = NULL;
1418 /*
1419 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1420 * queried key in the files of the configset, the value returned will be the last
1421 * value in the value list for that key.
1422 */
1423 values = git_configset_get_value_multi(cs, key);
1424
1425 if (!values)
1426 return 1;
1427 assert(values->nr > 0);
1428 *value = values->items[values->nr - 1].string;
1429 return 0;
1430 }
1431
1432 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1433 {
1434 struct config_set_element *e = configset_find_element(cs, key);
1435 return e ? &e->value_list : NULL;
1436 }
1437
1438 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1439 {
1440 const char *value;
1441 if (!git_configset_get_value(cs, key, &value))
1442 return git_config_string(dest, key, value);
1443 else
1444 return 1;
1445 }
1446
1447 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1448 {
1449 return git_configset_get_string_const(cs, key, (const char **)dest);
1450 }
1451
1452 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1453 {
1454 const char *value;
1455 if (!git_configset_get_value(cs, key, &value)) {
1456 *dest = git_config_int(key, value);
1457 return 0;
1458 } else
1459 return 1;
1460 }
1461
1462 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1463 {
1464 const char *value;
1465 if (!git_configset_get_value(cs, key, &value)) {
1466 *dest = git_config_ulong(key, value);
1467 return 0;
1468 } else
1469 return 1;
1470 }
1471
1472 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1473 {
1474 const char *value;
1475 if (!git_configset_get_value(cs, key, &value)) {
1476 *dest = git_config_bool(key, value);
1477 return 0;
1478 } else
1479 return 1;
1480 }
1481
1482 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1483 int *is_bool, int *dest)
1484 {
1485 const char *value;
1486 if (!git_configset_get_value(cs, key, &value)) {
1487 *dest = git_config_bool_or_int(key, value, is_bool);
1488 return 0;
1489 } else
1490 return 1;
1491 }
1492
1493 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1494 {
1495 const char *value;
1496 if (!git_configset_get_value(cs, key, &value)) {
1497 *dest = git_config_maybe_bool(key, value);
1498 if (*dest == -1)
1499 return -1;
1500 return 0;
1501 } else
1502 return 1;
1503 }
1504
1505 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1506 {
1507 const char *value;
1508 if (!git_configset_get_value(cs, key, &value))
1509 return git_config_pathname(dest, key, value);
1510 else
1511 return 1;
1512 }
1513
1514 static void git_config_check_init(void)
1515 {
1516 if (the_config_set.hash_initialized)
1517 return;
1518 git_configset_init(&the_config_set);
1519 git_config_raw(config_set_callback, &the_config_set);
1520 }
1521
1522 void git_config_clear(void)
1523 {
1524 if (!the_config_set.hash_initialized)
1525 return;
1526 git_configset_clear(&the_config_set);
1527 }
1528
1529 int git_config_get_value(const char *key, const char **value)
1530 {
1531 git_config_check_init();
1532 return git_configset_get_value(&the_config_set, key, value);
1533 }
1534
1535 const struct string_list *git_config_get_value_multi(const char *key)
1536 {
1537 git_config_check_init();
1538 return git_configset_get_value_multi(&the_config_set, key);
1539 }
1540
1541 int git_config_get_string_const(const char *key, const char **dest)
1542 {
1543 int ret;
1544 git_config_check_init();
1545 ret = git_configset_get_string_const(&the_config_set, key, dest);
1546 if (ret < 0)
1547 git_die_config(key, NULL);
1548 return ret;
1549 }
1550
1551 int git_config_get_string(const char *key, char **dest)
1552 {
1553 git_config_check_init();
1554 return git_config_get_string_const(key, (const char **)dest);
1555 }
1556
1557 int git_config_get_int(const char *key, int *dest)
1558 {
1559 git_config_check_init();
1560 return git_configset_get_int(&the_config_set, key, dest);
1561 }
1562
1563 int git_config_get_ulong(const char *key, unsigned long *dest)
1564 {
1565 git_config_check_init();
1566 return git_configset_get_ulong(&the_config_set, key, dest);
1567 }
1568
1569 int git_config_get_bool(const char *key, int *dest)
1570 {
1571 git_config_check_init();
1572 return git_configset_get_bool(&the_config_set, key, dest);
1573 }
1574
1575 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1576 {
1577 git_config_check_init();
1578 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1579 }
1580
1581 int git_config_get_maybe_bool(const char *key, int *dest)
1582 {
1583 git_config_check_init();
1584 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1585 }
1586
1587 int git_config_get_pathname(const char *key, const char **dest)
1588 {
1589 int ret;
1590 git_config_check_init();
1591 ret = git_configset_get_pathname(&the_config_set, key, dest);
1592 if (ret < 0)
1593 git_die_config(key, NULL);
1594 return ret;
1595 }
1596
1597 NORETURN
1598 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1599 {
1600 if (!filename)
1601 die(_("unable to parse '%s' from command-line config"), key);
1602 else
1603 die(_("bad config variable '%s' in file '%s' at line %d"),
1604 key, filename, linenr);
1605 }
1606
1607 NORETURN __attribute__((format(printf, 2, 3)))
1608 void git_die_config(const char *key, const char *err, ...)
1609 {
1610 const struct string_list *values;
1611 struct key_value_info *kv_info;
1612
1613 if (err) {
1614 va_list params;
1615 va_start(params, err);
1616 vreportf("error: ", err, params);
1617 va_end(params);
1618 }
1619 values = git_config_get_value_multi(key);
1620 kv_info = values->items[values->nr - 1].util;
1621 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
1622 }
1623
1624 /*
1625 * Find all the stuff for git_config_set() below.
1626 */
1627
1628 static struct {
1629 int baselen;
1630 char *key;
1631 int do_not_match;
1632 regex_t *value_regex;
1633 int multi_replace;
1634 size_t *offset;
1635 unsigned int offset_alloc;
1636 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1637 int seen;
1638 } store;
1639
1640 static int matches(const char *key, const char *value)
1641 {
1642 if (strcmp(key, store.key))
1643 return 0; /* not ours */
1644 if (!store.value_regex)
1645 return 1; /* always matches */
1646 if (store.value_regex == CONFIG_REGEX_NONE)
1647 return 0; /* never matches */
1648
1649 return store.do_not_match ^
1650 (value && !regexec(store.value_regex, value, 0, NULL, 0));
1651 }
1652
1653 static int store_aux(const char *key, const char *value, void *cb)
1654 {
1655 const char *ep;
1656 size_t section_len;
1657
1658 switch (store.state) {
1659 case KEY_SEEN:
1660 if (matches(key, value)) {
1661 if (store.seen == 1 && store.multi_replace == 0) {
1662 warning(_("%s has multiple values"), key);
1663 }
1664
1665 ALLOC_GROW(store.offset, store.seen + 1,
1666 store.offset_alloc);
1667
1668 store.offset[store.seen] = cf->do_ftell(cf);
1669 store.seen++;
1670 }
1671 break;
1672 case SECTION_SEEN:
1673 /*
1674 * What we are looking for is in store.key (both
1675 * section and var), and its section part is baselen
1676 * long. We found key (again, both section and var).
1677 * We would want to know if this key is in the same
1678 * section as what we are looking for. We already
1679 * know we are in the same section as what should
1680 * hold store.key.
1681 */
1682 ep = strrchr(key, '.');
1683 section_len = ep - key;
1684
1685 if ((section_len != store.baselen) ||
1686 memcmp(key, store.key, section_len+1)) {
1687 store.state = SECTION_END_SEEN;
1688 break;
1689 }
1690
1691 /*
1692 * Do not increment matches: this is no match, but we
1693 * just made sure we are in the desired section.
1694 */
1695 ALLOC_GROW(store.offset, store.seen + 1,
1696 store.offset_alloc);
1697 store.offset[store.seen] = cf->do_ftell(cf);
1698 /* fallthru */
1699 case SECTION_END_SEEN:
1700 case START:
1701 if (matches(key, value)) {
1702 ALLOC_GROW(store.offset, store.seen + 1,
1703 store.offset_alloc);
1704 store.offset[store.seen] = cf->do_ftell(cf);
1705 store.state = KEY_SEEN;
1706 store.seen++;
1707 } else {
1708 if (strrchr(key, '.') - key == store.baselen &&
1709 !strncmp(key, store.key, store.baselen)) {
1710 store.state = SECTION_SEEN;
1711 ALLOC_GROW(store.offset,
1712 store.seen + 1,
1713 store.offset_alloc);
1714 store.offset[store.seen] = cf->do_ftell(cf);
1715 }
1716 }
1717 }
1718 return 0;
1719 }
1720
1721 static int write_error(const char *filename)
1722 {
1723 error("failed to write new configuration file %s", filename);
1724
1725 /* Same error code as "failed to rename". */
1726 return 4;
1727 }
1728
1729 static int store_write_section(int fd, const char *key)
1730 {
1731 const char *dot;
1732 int i, success;
1733 struct strbuf sb = STRBUF_INIT;
1734
1735 dot = memchr(key, '.', store.baselen);
1736 if (dot) {
1737 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1738 for (i = dot - key + 1; i < store.baselen; i++) {
1739 if (key[i] == '"' || key[i] == '\\')
1740 strbuf_addch(&sb, '\\');
1741 strbuf_addch(&sb, key[i]);
1742 }
1743 strbuf_addstr(&sb, "\"]\n");
1744 } else {
1745 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1746 }
1747
1748 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1749 strbuf_release(&sb);
1750
1751 return success;
1752 }
1753
1754 static int store_write_pair(int fd, const char *key, const char *value)
1755 {
1756 int i, success;
1757 int length = strlen(key + store.baselen + 1);
1758 const char *quote = "";
1759 struct strbuf sb = STRBUF_INIT;
1760
1761 /*
1762 * Check to see if the value needs to be surrounded with a dq pair.
1763 * Note that problematic characters are always backslash-quoted; this
1764 * check is about not losing leading or trailing SP and strings that
1765 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1766 * configuration parser.
1767 */
1768 if (value[0] == ' ')
1769 quote = "\"";
1770 for (i = 0; value[i]; i++)
1771 if (value[i] == ';' || value[i] == '#')
1772 quote = "\"";
1773 if (i && value[i - 1] == ' ')
1774 quote = "\"";
1775
1776 strbuf_addf(&sb, "\t%.*s = %s",
1777 length, key + store.baselen + 1, quote);
1778
1779 for (i = 0; value[i]; i++)
1780 switch (value[i]) {
1781 case '\n':
1782 strbuf_addstr(&sb, "\\n");
1783 break;
1784 case '\t':
1785 strbuf_addstr(&sb, "\\t");
1786 break;
1787 case '"':
1788 case '\\':
1789 strbuf_addch(&sb, '\\');
1790 default:
1791 strbuf_addch(&sb, value[i]);
1792 break;
1793 }
1794 strbuf_addf(&sb, "%s\n", quote);
1795
1796 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1797 strbuf_release(&sb);
1798
1799 return success;
1800 }
1801
1802 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1803 size_t offset_, int *found_bracket)
1804 {
1805 size_t equal_offset = size, bracket_offset = size;
1806 ssize_t offset;
1807
1808 contline:
1809 for (offset = offset_-2; offset > 0
1810 && contents[offset] != '\n'; offset--)
1811 switch (contents[offset]) {
1812 case '=': equal_offset = offset; break;
1813 case ']': bracket_offset = offset; break;
1814 }
1815 if (offset > 0 && contents[offset-1] == '\\') {
1816 offset_ = offset;
1817 goto contline;
1818 }
1819 if (bracket_offset < equal_offset) {
1820 *found_bracket = 1;
1821 offset = bracket_offset+1;
1822 } else
1823 offset++;
1824
1825 return offset;
1826 }
1827
1828 int git_config_set_in_file(const char *config_filename,
1829 const char *key, const char *value)
1830 {
1831 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1832 }
1833
1834 int git_config_set(const char *key, const char *value)
1835 {
1836 return git_config_set_multivar(key, value, NULL, 0);
1837 }
1838
1839 /*
1840 * Auxiliary function to sanity-check and split the key into the section
1841 * identifier and variable name.
1842 *
1843 * Returns 0 on success, -1 when there is an invalid character in the key and
1844 * -2 if there is no section name in the key.
1845 *
1846 * store_key - pointer to char* which will hold a copy of the key with
1847 * lowercase section and variable name
1848 * baselen - pointer to int which will hold the length of the
1849 * section + subsection part, can be NULL
1850 */
1851 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1852 {
1853 int i, dot, baselen;
1854 const char *last_dot = strrchr(key, '.');
1855
1856 /*
1857 * Since "key" actually contains the section name and the real
1858 * key name separated by a dot, we have to know where the dot is.
1859 */
1860
1861 if (last_dot == NULL || last_dot == key) {
1862 error("key does not contain a section: %s", key);
1863 return -CONFIG_NO_SECTION_OR_NAME;
1864 }
1865
1866 if (!last_dot[1]) {
1867 error("key does not contain variable name: %s", key);
1868 return -CONFIG_NO_SECTION_OR_NAME;
1869 }
1870
1871 baselen = last_dot - key;
1872 if (baselen_)
1873 *baselen_ = baselen;
1874
1875 /*
1876 * Validate the key and while at it, lower case it for matching.
1877 */
1878 *store_key = xmalloc(strlen(key) + 1);
1879
1880 dot = 0;
1881 for (i = 0; key[i]; i++) {
1882 unsigned char c = key[i];
1883 if (c == '.')
1884 dot = 1;
1885 /* Leave the extended basename untouched.. */
1886 if (!dot || i > baselen) {
1887 if (!iskeychar(c) ||
1888 (i == baselen + 1 && !isalpha(c))) {
1889 error("invalid key: %s", key);
1890 goto out_free_ret_1;
1891 }
1892 c = tolower(c);
1893 } else if (c == '\n') {
1894 error("invalid key (newline): %s", key);
1895 goto out_free_ret_1;
1896 }
1897 (*store_key)[i] = c;
1898 }
1899 (*store_key)[i] = 0;
1900
1901 return 0;
1902
1903 out_free_ret_1:
1904 free(*store_key);
1905 *store_key = NULL;
1906 return -CONFIG_INVALID_KEY;
1907 }
1908
1909 /*
1910 * If value==NULL, unset in (remove from) config,
1911 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1912 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
1913 * (only add a new one)
1914 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1915 * else all matching key/values (regardless how many) are removed,
1916 * before the new pair is written.
1917 *
1918 * Returns 0 on success.
1919 *
1920 * This function does this:
1921 *
1922 * - it locks the config file by creating ".git/config.lock"
1923 *
1924 * - it then parses the config using store_aux() as validator to find
1925 * the position on the key/value pair to replace. If it is to be unset,
1926 * it must be found exactly once.
1927 *
1928 * - the config file is mmap()ed and the part before the match (if any) is
1929 * written to the lock file, then the changed part and the rest.
1930 *
1931 * - the config file is removed and the lock file rename()d to it.
1932 *
1933 */
1934 int git_config_set_multivar_in_file(const char *config_filename,
1935 const char *key, const char *value,
1936 const char *value_regex, int multi_replace)
1937 {
1938 int fd = -1, in_fd;
1939 int ret;
1940 struct lock_file *lock = NULL;
1941 char *filename_buf = NULL;
1942
1943 /* parse-key returns negative; flip the sign to feed exit(3) */
1944 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1945 if (ret)
1946 goto out_free;
1947
1948 store.multi_replace = multi_replace;
1949
1950 if (!config_filename)
1951 config_filename = filename_buf = git_pathdup("config");
1952
1953 /*
1954 * The lock serves a purpose in addition to locking: the new
1955 * contents of .git/config will be written into it.
1956 */
1957 lock = xcalloc(1, sizeof(struct lock_file));
1958 fd = hold_lock_file_for_update(lock, config_filename, 0);
1959 if (fd < 0) {
1960 error("could not lock config file %s: %s", config_filename, strerror(errno));
1961 free(store.key);
1962 ret = CONFIG_NO_LOCK;
1963 goto out_free;
1964 }
1965
1966 /*
1967 * If .git/config does not exist yet, write a minimal version.
1968 */
1969 in_fd = open(config_filename, O_RDONLY);
1970 if ( in_fd < 0 ) {
1971 free(store.key);
1972
1973 if ( ENOENT != errno ) {
1974 error("opening %s: %s", config_filename,
1975 strerror(errno));
1976 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1977 goto out_free;
1978 }
1979 /* if nothing to unset, error out */
1980 if (value == NULL) {
1981 ret = CONFIG_NOTHING_SET;
1982 goto out_free;
1983 }
1984
1985 store.key = (char *)key;
1986 if (!store_write_section(fd, key) ||
1987 !store_write_pair(fd, key, value))
1988 goto write_err_out;
1989 } else {
1990 struct stat st;
1991 char *contents;
1992 size_t contents_sz, copy_begin, copy_end;
1993 int i, new_line = 0;
1994
1995 if (value_regex == NULL)
1996 store.value_regex = NULL;
1997 else if (value_regex == CONFIG_REGEX_NONE)
1998 store.value_regex = CONFIG_REGEX_NONE;
1999 else {
2000 if (value_regex[0] == '!') {
2001 store.do_not_match = 1;
2002 value_regex++;
2003 } else
2004 store.do_not_match = 0;
2005
2006 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2007 if (regcomp(store.value_regex, value_regex,
2008 REG_EXTENDED)) {
2009 error("invalid pattern: %s", value_regex);
2010 free(store.value_regex);
2011 ret = CONFIG_INVALID_PATTERN;
2012 goto out_free;
2013 }
2014 }
2015
2016 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2017 store.offset[0] = 0;
2018 store.state = START;
2019 store.seen = 0;
2020
2021 /*
2022 * After this, store.offset will contain the *end* offset
2023 * of the last match, or remain at 0 if no match was found.
2024 * As a side effect, we make sure to transform only a valid
2025 * existing config file.
2026 */
2027 if (git_config_from_file(store_aux, config_filename, NULL)) {
2028 error("invalid config file %s", config_filename);
2029 free(store.key);
2030 if (store.value_regex != NULL &&
2031 store.value_regex != CONFIG_REGEX_NONE) {
2032 regfree(store.value_regex);
2033 free(store.value_regex);
2034 }
2035 ret = CONFIG_INVALID_FILE;
2036 goto out_free;
2037 }
2038
2039 free(store.key);
2040 if (store.value_regex != NULL &&
2041 store.value_regex != CONFIG_REGEX_NONE) {
2042 regfree(store.value_regex);
2043 free(store.value_regex);
2044 }
2045
2046 /* if nothing to unset, or too many matches, error out */
2047 if ((store.seen == 0 && value == NULL) ||
2048 (store.seen > 1 && multi_replace == 0)) {
2049 ret = CONFIG_NOTHING_SET;
2050 goto out_free;
2051 }
2052
2053 fstat(in_fd, &st);
2054 contents_sz = xsize_t(st.st_size);
2055 contents = xmmap(NULL, contents_sz, PROT_READ,
2056 MAP_PRIVATE, in_fd, 0);
2057 close(in_fd);
2058
2059 if (chmod(lock->filename.buf, st.st_mode & 07777) < 0) {
2060 error("chmod on %s failed: %s",
2061 lock->filename.buf, strerror(errno));
2062 ret = CONFIG_NO_WRITE;
2063 goto out_free;
2064 }
2065
2066 if (store.seen == 0)
2067 store.seen = 1;
2068
2069 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2070 if (store.offset[i] == 0) {
2071 store.offset[i] = copy_end = contents_sz;
2072 } else if (store.state != KEY_SEEN) {
2073 copy_end = store.offset[i];
2074 } else
2075 copy_end = find_beginning_of_line(
2076 contents, contents_sz,
2077 store.offset[i]-2, &new_line);
2078
2079 if (copy_end > 0 && contents[copy_end-1] != '\n')
2080 new_line = 1;
2081
2082 /* write the first part of the config */
2083 if (copy_end > copy_begin) {
2084 if (write_in_full(fd, contents + copy_begin,
2085 copy_end - copy_begin) <
2086 copy_end - copy_begin)
2087 goto write_err_out;
2088 if (new_line &&
2089 write_str_in_full(fd, "\n") != 1)
2090 goto write_err_out;
2091 }
2092 copy_begin = store.offset[i];
2093 }
2094
2095 /* write the pair (value == NULL means unset) */
2096 if (value != NULL) {
2097 if (store.state == START) {
2098 if (!store_write_section(fd, key))
2099 goto write_err_out;
2100 }
2101 if (!store_write_pair(fd, key, value))
2102 goto write_err_out;
2103 }
2104
2105 /* write the rest of the config */
2106 if (copy_begin < contents_sz)
2107 if (write_in_full(fd, contents + copy_begin,
2108 contents_sz - copy_begin) <
2109 contents_sz - copy_begin)
2110 goto write_err_out;
2111
2112 munmap(contents, contents_sz);
2113 }
2114
2115 if (commit_lock_file(lock) < 0) {
2116 error("could not commit config file %s", config_filename);
2117 ret = CONFIG_NO_WRITE;
2118 lock = NULL;
2119 goto out_free;
2120 }
2121
2122 /*
2123 * lock is committed, so don't try to roll it back below.
2124 * NOTE: Since lockfile.c keeps a linked list of all created
2125 * lock_file structures, it isn't safe to free(lock). It's
2126 * better to just leave it hanging around.
2127 */
2128 lock = NULL;
2129 ret = 0;
2130
2131 /* Invalidate the config cache */
2132 git_config_clear();
2133
2134 out_free:
2135 if (lock)
2136 rollback_lock_file(lock);
2137 free(filename_buf);
2138 return ret;
2139
2140 write_err_out:
2141 ret = write_error(lock->filename.buf);
2142 goto out_free;
2143
2144 }
2145
2146 int git_config_set_multivar(const char *key, const char *value,
2147 const char *value_regex, int multi_replace)
2148 {
2149 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
2150 multi_replace);
2151 }
2152
2153 static int section_name_match (const char *buf, const char *name)
2154 {
2155 int i = 0, j = 0, dot = 0;
2156 if (buf[i] != '[')
2157 return 0;
2158 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2159 if (!dot && isspace(buf[i])) {
2160 dot = 1;
2161 if (name[j++] != '.')
2162 break;
2163 for (i++; isspace(buf[i]); i++)
2164 ; /* do nothing */
2165 if (buf[i] != '"')
2166 break;
2167 continue;
2168 }
2169 if (buf[i] == '\\' && dot)
2170 i++;
2171 else if (buf[i] == '"' && dot) {
2172 for (i++; isspace(buf[i]); i++)
2173 ; /* do_nothing */
2174 break;
2175 }
2176 if (buf[i] != name[j++])
2177 break;
2178 }
2179 if (buf[i] == ']' && name[j] == 0) {
2180 /*
2181 * We match, now just find the right length offset by
2182 * gobbling up any whitespace after it, as well
2183 */
2184 i++;
2185 for (; buf[i] && isspace(buf[i]); i++)
2186 ; /* do nothing */
2187 return i;
2188 }
2189 return 0;
2190 }
2191
2192 static int section_name_is_ok(const char *name)
2193 {
2194 /* Empty section names are bogus. */
2195 if (!*name)
2196 return 0;
2197
2198 /*
2199 * Before a dot, we must be alphanumeric or dash. After the first dot,
2200 * anything goes, so we can stop checking.
2201 */
2202 for (; *name && *name != '.'; name++)
2203 if (*name != '-' && !isalnum(*name))
2204 return 0;
2205 return 1;
2206 }
2207
2208 /* if new_name == NULL, the section is removed instead */
2209 int git_config_rename_section_in_file(const char *config_filename,
2210 const char *old_name, const char *new_name)
2211 {
2212 int ret = 0, remove = 0;
2213 char *filename_buf = NULL;
2214 struct lock_file *lock;
2215 int out_fd;
2216 char buf[1024];
2217 FILE *config_file;
2218 struct stat st;
2219
2220 if (new_name && !section_name_is_ok(new_name)) {
2221 ret = error("invalid section name: %s", new_name);
2222 goto out;
2223 }
2224
2225 if (!config_filename)
2226 config_filename = filename_buf = git_pathdup("config");
2227
2228 lock = xcalloc(1, sizeof(struct lock_file));
2229 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2230 if (out_fd < 0) {
2231 ret = error("could not lock config file %s", config_filename);
2232 goto out;
2233 }
2234
2235 if (!(config_file = fopen(config_filename, "rb"))) {
2236 /* no config file means nothing to rename, no error */
2237 goto unlock_and_out;
2238 }
2239
2240 fstat(fileno(config_file), &st);
2241
2242 if (chmod(lock->filename.buf, st.st_mode & 07777) < 0) {
2243 ret = error("chmod on %s failed: %s",
2244 lock->filename.buf, strerror(errno));
2245 goto out;
2246 }
2247
2248 while (fgets(buf, sizeof(buf), config_file)) {
2249 int i;
2250 int length;
2251 char *output = buf;
2252 for (i = 0; buf[i] && isspace(buf[i]); i++)
2253 ; /* do nothing */
2254 if (buf[i] == '[') {
2255 /* it's a section */
2256 int offset = section_name_match(&buf[i], old_name);
2257 if (offset > 0) {
2258 ret++;
2259 if (new_name == NULL) {
2260 remove = 1;
2261 continue;
2262 }
2263 store.baselen = strlen(new_name);
2264 if (!store_write_section(out_fd, new_name)) {
2265 ret = write_error(lock->filename.buf);
2266 goto out;
2267 }
2268 /*
2269 * We wrote out the new section, with
2270 * a newline, now skip the old
2271 * section's length
2272 */
2273 output += offset + i;
2274 if (strlen(output) > 0) {
2275 /*
2276 * More content means there's
2277 * a declaration to put on the
2278 * next line; indent with a
2279 * tab
2280 */
2281 output -= 1;
2282 output[0] = '\t';
2283 }
2284 }
2285 remove = 0;
2286 }
2287 if (remove)
2288 continue;
2289 length = strlen(output);
2290 if (write_in_full(out_fd, output, length) != length) {
2291 ret = write_error(lock->filename.buf);
2292 goto out;
2293 }
2294 }
2295 fclose(config_file);
2296 unlock_and_out:
2297 if (commit_lock_file(lock) < 0)
2298 ret = error("could not commit config file %s", config_filename);
2299 out:
2300 free(filename_buf);
2301 return ret;
2302 }
2303
2304 int git_config_rename_section(const char *old_name, const char *new_name)
2305 {
2306 return git_config_rename_section_in_file(NULL, old_name, new_name);
2307 }
2308
2309 /*
2310 * Call this to report error for your variable that should not
2311 * get a boolean value (i.e. "[my] var" means "true").
2312 */
2313 #undef config_error_nonbool
2314 int config_error_nonbool(const char *var)
2315 {
2316 return error("Missing value for '%s'", var);
2317 }
2318
2319 int parse_config_key(const char *var,
2320 const char *section,
2321 const char **subsection, int *subsection_len,
2322 const char **key)
2323 {
2324 int section_len = strlen(section);
2325 const char *dot;
2326
2327 /* Does it start with "section." ? */
2328 if (!starts_with(var, section) || var[section_len] != '.')
2329 return -1;
2330
2331 /*
2332 * Find the key; we don't know yet if we have a subsection, but we must
2333 * parse backwards from the end, since the subsection may have dots in
2334 * it, too.
2335 */
2336 dot = strrchr(var, '.');
2337 *key = dot + 1;
2338
2339 /* Did we have a subsection at all? */
2340 if (dot == var + section_len) {
2341 *subsection = NULL;
2342 *subsection_len = 0;
2343 }
2344 else {
2345 *subsection = var + section_len + 1;
2346 *subsection_len = dot - *subsection;
2347 }
2348
2349 return 0;
2350 }