config: drop cf validity check in get_next_char()
[alt-git.git] / config.c
blob046642b69f1791373593403ad873b67ed764885f
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "exec_cmd.h"
10 #include "strbuf.h"
11 #include "quote.h"
13 typedef struct config_file {
14 struct config_file *prev;
15 FILE *f;
16 const char *name;
17 int linenr;
18 int eof;
19 struct strbuf value;
20 struct strbuf var;
21 } config_file;
23 static config_file *cf;
25 static int zlib_compression_seen;
27 #define MAX_INCLUDE_DEPTH 10
28 static const char include_depth_advice[] =
29 "exceeded maximum include depth (%d) while including\n"
30 " %s\n"
31 "from\n"
32 " %s\n"
33 "Do you have circular includes?";
34 static int handle_path_include(const char *path, struct config_include_data *inc)
36 int ret = 0;
37 struct strbuf buf = STRBUF_INIT;
38 char *expanded = expand_user_path(path);
40 if (!expanded)
41 return error("Could not expand include path '%s'", path);
42 path = expanded;
45 * Use an absolute path as-is, but interpret relative paths
46 * based on the including config file.
48 if (!is_absolute_path(path)) {
49 char *slash;
51 if (!cf || !cf->name)
52 return error("relative config includes must come from files");
54 slash = find_last_dir_sep(cf->name);
55 if (slash)
56 strbuf_add(&buf, cf->name, slash - cf->name + 1);
57 strbuf_addstr(&buf, path);
58 path = buf.buf;
61 if (!access_or_die(path, R_OK)) {
62 if (++inc->depth > MAX_INCLUDE_DEPTH)
63 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
64 cf && cf->name ? cf->name : "the command line");
65 ret = git_config_from_file(git_config_include, path, inc);
66 inc->depth--;
68 strbuf_release(&buf);
69 free(expanded);
70 return ret;
73 int git_config_include(const char *var, const char *value, void *data)
75 struct config_include_data *inc = data;
76 const char *type;
77 int ret;
80 * Pass along all values, including "include" directives; this makes it
81 * possible to query information on the includes themselves.
83 ret = inc->fn(var, value, inc->data);
84 if (ret < 0)
85 return ret;
87 type = skip_prefix(var, "include.");
88 if (!type)
89 return ret;
91 if (!strcmp(type, "path"))
92 ret = handle_path_include(value, inc);
93 return ret;
96 static void lowercase(char *p)
98 for (; *p; p++)
99 *p = tolower(*p);
102 void git_config_push_parameter(const char *text)
104 struct strbuf env = STRBUF_INIT;
105 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
106 if (old) {
107 strbuf_addstr(&env, old);
108 strbuf_addch(&env, ' ');
110 sq_quote_buf(&env, text);
111 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
112 strbuf_release(&env);
115 int git_config_parse_parameter(const char *text,
116 config_fn_t fn, void *data)
118 struct strbuf **pair;
119 pair = strbuf_split_str(text, '=', 2);
120 if (!pair[0])
121 return error("bogus config parameter: %s", text);
122 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
123 strbuf_setlen(pair[0], pair[0]->len - 1);
124 strbuf_trim(pair[0]);
125 if (!pair[0]->len) {
126 strbuf_list_free(pair);
127 return error("bogus config parameter: %s", text);
129 lowercase(pair[0]->buf);
130 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
131 strbuf_list_free(pair);
132 return -1;
134 strbuf_list_free(pair);
135 return 0;
138 int git_config_from_parameters(config_fn_t fn, void *data)
140 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
141 char *envw;
142 const char **argv = NULL;
143 int nr = 0, alloc = 0;
144 int i;
146 if (!env)
147 return 0;
148 /* sq_dequote will write over it */
149 envw = xstrdup(env);
151 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
152 free(envw);
153 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
156 for (i = 0; i < nr; i++) {
157 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
158 free(argv);
159 free(envw);
160 return -1;
164 free(argv);
165 free(envw);
166 return nr > 0;
169 static int get_next_char(void)
171 int c;
172 FILE *f = cf->f;
174 c = fgetc(f);
175 if (c == '\r') {
176 /* DOS like systems */
177 c = fgetc(f);
178 if (c != '\n') {
179 ungetc(c, f);
180 c = '\r';
183 if (c == '\n')
184 cf->linenr++;
185 if (c == EOF) {
186 cf->eof = 1;
187 c = '\n';
189 return c;
192 static char *parse_value(void)
194 int quote = 0, comment = 0, space = 0;
196 strbuf_reset(&cf->value);
197 for (;;) {
198 int c = get_next_char();
199 if (c == '\n') {
200 if (quote) {
201 cf->linenr--;
202 return NULL;
204 return cf->value.buf;
206 if (comment)
207 continue;
208 if (isspace(c) && !quote) {
209 if (cf->value.len)
210 space++;
211 continue;
213 if (!quote) {
214 if (c == ';' || c == '#') {
215 comment = 1;
216 continue;
219 for (; space; space--)
220 strbuf_addch(&cf->value, ' ');
221 if (c == '\\') {
222 c = get_next_char();
223 switch (c) {
224 case '\n':
225 continue;
226 case 't':
227 c = '\t';
228 break;
229 case 'b':
230 c = '\b';
231 break;
232 case 'n':
233 c = '\n';
234 break;
235 /* Some characters escape as themselves */
236 case '\\': case '"':
237 break;
238 /* Reject unknown escape sequences */
239 default:
240 return NULL;
242 strbuf_addch(&cf->value, c);
243 continue;
245 if (c == '"') {
246 quote = 1-quote;
247 continue;
249 strbuf_addch(&cf->value, c);
253 static inline int iskeychar(int c)
255 return isalnum(c) || c == '-';
258 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
260 int c;
261 char *value;
263 /* Get the full name */
264 for (;;) {
265 c = get_next_char();
266 if (cf->eof)
267 break;
268 if (!iskeychar(c))
269 break;
270 strbuf_addch(name, tolower(c));
273 while (c == ' ' || c == '\t')
274 c = get_next_char();
276 value = NULL;
277 if (c != '\n') {
278 if (c != '=')
279 return -1;
280 value = parse_value();
281 if (!value)
282 return -1;
284 return fn(name->buf, value, data);
287 static int get_extended_base_var(struct strbuf *name, int c)
289 do {
290 if (c == '\n')
291 goto error_incomplete_line;
292 c = get_next_char();
293 } while (isspace(c));
295 /* We require the format to be '[base "extension"]' */
296 if (c != '"')
297 return -1;
298 strbuf_addch(name, '.');
300 for (;;) {
301 int c = get_next_char();
302 if (c == '\n')
303 goto error_incomplete_line;
304 if (c == '"')
305 break;
306 if (c == '\\') {
307 c = get_next_char();
308 if (c == '\n')
309 goto error_incomplete_line;
311 strbuf_addch(name, c);
314 /* Final ']' */
315 if (get_next_char() != ']')
316 return -1;
317 return 0;
318 error_incomplete_line:
319 cf->linenr--;
320 return -1;
323 static int get_base_var(struct strbuf *name)
325 for (;;) {
326 int c = get_next_char();
327 if (cf->eof)
328 return -1;
329 if (c == ']')
330 return 0;
331 if (isspace(c))
332 return get_extended_base_var(name, c);
333 if (!iskeychar(c) && c != '.')
334 return -1;
335 strbuf_addch(name, tolower(c));
339 static int git_parse_file(config_fn_t fn, void *data)
341 int comment = 0;
342 int baselen = 0;
343 struct strbuf *var = &cf->var;
345 /* U+FEFF Byte Order Mark in UTF8 */
346 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
347 const unsigned char *bomptr = utf8_bom;
349 for (;;) {
350 int c = get_next_char();
351 if (bomptr && *bomptr) {
352 /* We are at the file beginning; skip UTF8-encoded BOM
353 * if present. Sane editors won't put this in on their
354 * own, but e.g. Windows Notepad will do it happily. */
355 if ((unsigned char) c == *bomptr) {
356 bomptr++;
357 continue;
358 } else {
359 /* Do not tolerate partial BOM. */
360 if (bomptr != utf8_bom)
361 break;
362 /* No BOM at file beginning. Cool. */
363 bomptr = NULL;
366 if (c == '\n') {
367 if (cf->eof)
368 return 0;
369 comment = 0;
370 continue;
372 if (comment || isspace(c))
373 continue;
374 if (c == '#' || c == ';') {
375 comment = 1;
376 continue;
378 if (c == '[') {
379 /* Reset prior to determining a new stem */
380 strbuf_reset(var);
381 if (get_base_var(var) < 0 || var->len < 1)
382 break;
383 strbuf_addch(var, '.');
384 baselen = var->len;
385 continue;
387 if (!isalpha(c))
388 break;
390 * Truncate the var name back to the section header
391 * stem prior to grabbing the suffix part of the name
392 * and the value.
394 strbuf_setlen(var, baselen);
395 strbuf_addch(var, tolower(c));
396 if (get_value(fn, data, var) < 0)
397 break;
399 die("bad config file line %d in %s", cf->linenr, cf->name);
402 static int parse_unit_factor(const char *end, uintmax_t *val)
404 if (!*end)
405 return 1;
406 else if (!strcasecmp(end, "k")) {
407 *val *= 1024;
408 return 1;
410 else if (!strcasecmp(end, "m")) {
411 *val *= 1024 * 1024;
412 return 1;
414 else if (!strcasecmp(end, "g")) {
415 *val *= 1024 * 1024 * 1024;
416 return 1;
418 return 0;
421 static int git_parse_long(const char *value, long *ret)
423 if (value && *value) {
424 char *end;
425 intmax_t val;
426 uintmax_t uval;
427 uintmax_t factor = 1;
429 errno = 0;
430 val = strtoimax(value, &end, 0);
431 if (errno == ERANGE)
432 return 0;
433 if (!parse_unit_factor(end, &factor))
434 return 0;
435 uval = abs(val);
436 uval *= factor;
437 if ((uval > maximum_signed_value_of_type(long)) ||
438 (abs(val) > uval))
439 return 0;
440 val *= factor;
441 *ret = val;
442 return 1;
444 return 0;
447 int git_parse_ulong(const char *value, unsigned long *ret)
449 if (value && *value) {
450 char *end;
451 uintmax_t val;
452 uintmax_t oldval;
454 errno = 0;
455 val = strtoumax(value, &end, 0);
456 if (errno == ERANGE)
457 return 0;
458 oldval = val;
459 if (!parse_unit_factor(end, &val))
460 return 0;
461 if ((val > maximum_unsigned_value_of_type(long)) ||
462 (oldval > val))
463 return 0;
464 *ret = val;
465 return 1;
467 return 0;
470 static void die_bad_config(const char *name)
472 if (cf && cf->name)
473 die("bad config value for '%s' in %s", name, cf->name);
474 die("bad config value for '%s'", name);
477 int git_config_int(const char *name, const char *value)
479 long ret = 0;
480 if (!git_parse_long(value, &ret))
481 die_bad_config(name);
482 return ret;
485 unsigned long git_config_ulong(const char *name, const char *value)
487 unsigned long ret;
488 if (!git_parse_ulong(value, &ret))
489 die_bad_config(name);
490 return ret;
493 static int git_config_maybe_bool_text(const char *name, const char *value)
495 if (!value)
496 return 1;
497 if (!*value)
498 return 0;
499 if (!strcasecmp(value, "true")
500 || !strcasecmp(value, "yes")
501 || !strcasecmp(value, "on"))
502 return 1;
503 if (!strcasecmp(value, "false")
504 || !strcasecmp(value, "no")
505 || !strcasecmp(value, "off"))
506 return 0;
507 return -1;
510 int git_config_maybe_bool(const char *name, const char *value)
512 long v = git_config_maybe_bool_text(name, value);
513 if (0 <= v)
514 return v;
515 if (git_parse_long(value, &v))
516 return !!v;
517 return -1;
520 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
522 int v = git_config_maybe_bool_text(name, value);
523 if (0 <= v) {
524 *is_bool = 1;
525 return v;
527 *is_bool = 0;
528 return git_config_int(name, value);
531 int git_config_bool(const char *name, const char *value)
533 int discard;
534 return !!git_config_bool_or_int(name, value, &discard);
537 int git_config_string(const char **dest, const char *var, const char *value)
539 if (!value)
540 return config_error_nonbool(var);
541 *dest = xstrdup(value);
542 return 0;
545 int git_config_pathname(const char **dest, const char *var, const char *value)
547 if (!value)
548 return config_error_nonbool(var);
549 *dest = expand_user_path(value);
550 if (!*dest)
551 die("Failed to expand user dir in: '%s'", value);
552 return 0;
555 static int git_default_core_config(const char *var, const char *value)
557 /* This needs a better name */
558 if (!strcmp(var, "core.filemode")) {
559 trust_executable_bit = git_config_bool(var, value);
560 return 0;
562 if (!strcmp(var, "core.trustctime")) {
563 trust_ctime = git_config_bool(var, value);
564 return 0;
566 if (!strcmp(var, "core.statinfo")) {
567 if (!strcasecmp(value, "default"))
568 check_stat = 1;
569 else if (!strcasecmp(value, "minimal"))
570 check_stat = 0;
573 if (!strcmp(var, "core.quotepath")) {
574 quote_path_fully = git_config_bool(var, value);
575 return 0;
578 if (!strcmp(var, "core.symlinks")) {
579 has_symlinks = git_config_bool(var, value);
580 return 0;
583 if (!strcmp(var, "core.ignorecase")) {
584 ignore_case = git_config_bool(var, value);
585 return 0;
588 if (!strcmp(var, "core.attributesfile"))
589 return git_config_pathname(&git_attributes_file, var, value);
591 if (!strcmp(var, "core.bare")) {
592 is_bare_repository_cfg = git_config_bool(var, value);
593 return 0;
596 if (!strcmp(var, "core.ignorestat")) {
597 assume_unchanged = git_config_bool(var, value);
598 return 0;
601 if (!strcmp(var, "core.prefersymlinkrefs")) {
602 prefer_symlink_refs = git_config_bool(var, value);
603 return 0;
606 if (!strcmp(var, "core.logallrefupdates")) {
607 log_all_ref_updates = git_config_bool(var, value);
608 return 0;
611 if (!strcmp(var, "core.warnambiguousrefs")) {
612 warn_ambiguous_refs = git_config_bool(var, value);
613 return 0;
616 if (!strcmp(var, "core.abbrev")) {
617 int abbrev = git_config_int(var, value);
618 if (abbrev < minimum_abbrev || abbrev > 40)
619 return -1;
620 default_abbrev = abbrev;
621 return 0;
624 if (!strcmp(var, "core.loosecompression")) {
625 int level = git_config_int(var, value);
626 if (level == -1)
627 level = Z_DEFAULT_COMPRESSION;
628 else if (level < 0 || level > Z_BEST_COMPRESSION)
629 die("bad zlib compression level %d", level);
630 zlib_compression_level = level;
631 zlib_compression_seen = 1;
632 return 0;
635 if (!strcmp(var, "core.compression")) {
636 int level = git_config_int(var, value);
637 if (level == -1)
638 level = Z_DEFAULT_COMPRESSION;
639 else if (level < 0 || level > Z_BEST_COMPRESSION)
640 die("bad zlib compression level %d", level);
641 core_compression_level = level;
642 core_compression_seen = 1;
643 if (!zlib_compression_seen)
644 zlib_compression_level = level;
645 return 0;
648 if (!strcmp(var, "core.packedgitwindowsize")) {
649 int pgsz_x2 = getpagesize() * 2;
650 packed_git_window_size = git_config_ulong(var, value);
652 /* This value must be multiple of (pagesize * 2) */
653 packed_git_window_size /= pgsz_x2;
654 if (packed_git_window_size < 1)
655 packed_git_window_size = 1;
656 packed_git_window_size *= pgsz_x2;
657 return 0;
660 if (!strcmp(var, "core.bigfilethreshold")) {
661 big_file_threshold = git_config_ulong(var, value);
662 return 0;
665 if (!strcmp(var, "core.packedgitlimit")) {
666 packed_git_limit = git_config_ulong(var, value);
667 return 0;
670 if (!strcmp(var, "core.deltabasecachelimit")) {
671 delta_base_cache_limit = git_config_ulong(var, value);
672 return 0;
675 if (!strcmp(var, "core.logpackaccess"))
676 return git_config_string(&log_pack_access, var, value);
678 if (!strcmp(var, "core.autocrlf")) {
679 if (value && !strcasecmp(value, "input")) {
680 if (core_eol == EOL_CRLF)
681 return error("core.autocrlf=input conflicts with core.eol=crlf");
682 auto_crlf = AUTO_CRLF_INPUT;
683 return 0;
685 auto_crlf = git_config_bool(var, value);
686 return 0;
689 if (!strcmp(var, "core.safecrlf")) {
690 if (value && !strcasecmp(value, "warn")) {
691 safe_crlf = SAFE_CRLF_WARN;
692 return 0;
694 safe_crlf = git_config_bool(var, value);
695 return 0;
698 if (!strcmp(var, "core.eol")) {
699 if (value && !strcasecmp(value, "lf"))
700 core_eol = EOL_LF;
701 else if (value && !strcasecmp(value, "crlf"))
702 core_eol = EOL_CRLF;
703 else if (value && !strcasecmp(value, "native"))
704 core_eol = EOL_NATIVE;
705 else
706 core_eol = EOL_UNSET;
707 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
708 return error("core.autocrlf=input conflicts with core.eol=crlf");
709 return 0;
712 if (!strcmp(var, "core.notesref")) {
713 notes_ref_name = xstrdup(value);
714 return 0;
717 if (!strcmp(var, "core.pager"))
718 return git_config_string(&pager_program, var, value);
720 if (!strcmp(var, "core.editor"))
721 return git_config_string(&editor_program, var, value);
723 if (!strcmp(var, "core.commentchar")) {
724 const char *comment;
725 int ret = git_config_string(&comment, var, value);
726 if (!ret)
727 comment_line_char = comment[0];
728 return ret;
731 if (!strcmp(var, "core.askpass"))
732 return git_config_string(&askpass_program, var, value);
734 if (!strcmp(var, "core.excludesfile"))
735 return git_config_pathname(&excludes_file, var, value);
737 if (!strcmp(var, "core.whitespace")) {
738 if (!value)
739 return config_error_nonbool(var);
740 whitespace_rule_cfg = parse_whitespace_rule(value);
741 return 0;
744 if (!strcmp(var, "core.fsyncobjectfiles")) {
745 fsync_object_files = git_config_bool(var, value);
746 return 0;
749 if (!strcmp(var, "core.preloadindex")) {
750 core_preload_index = git_config_bool(var, value);
751 return 0;
754 if (!strcmp(var, "core.createobject")) {
755 if (!strcmp(value, "rename"))
756 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
757 else if (!strcmp(value, "link"))
758 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
759 else
760 die("Invalid mode for object creation: %s", value);
761 return 0;
764 if (!strcmp(var, "core.sparsecheckout")) {
765 core_apply_sparse_checkout = git_config_bool(var, value);
766 return 0;
769 if (!strcmp(var, "core.precomposeunicode")) {
770 precomposed_unicode = git_config_bool(var, value);
771 return 0;
774 /* Add other config variables here and to Documentation/config.txt. */
775 return 0;
778 static int git_default_i18n_config(const char *var, const char *value)
780 if (!strcmp(var, "i18n.commitencoding"))
781 return git_config_string(&git_commit_encoding, var, value);
783 if (!strcmp(var, "i18n.logoutputencoding"))
784 return git_config_string(&git_log_output_encoding, var, value);
786 /* Add other config variables here and to Documentation/config.txt. */
787 return 0;
790 static int git_default_branch_config(const char *var, const char *value)
792 if (!strcmp(var, "branch.autosetupmerge")) {
793 if (value && !strcasecmp(value, "always")) {
794 git_branch_track = BRANCH_TRACK_ALWAYS;
795 return 0;
797 git_branch_track = git_config_bool(var, value);
798 return 0;
800 if (!strcmp(var, "branch.autosetuprebase")) {
801 if (!value)
802 return config_error_nonbool(var);
803 else if (!strcmp(value, "never"))
804 autorebase = AUTOREBASE_NEVER;
805 else if (!strcmp(value, "local"))
806 autorebase = AUTOREBASE_LOCAL;
807 else if (!strcmp(value, "remote"))
808 autorebase = AUTOREBASE_REMOTE;
809 else if (!strcmp(value, "always"))
810 autorebase = AUTOREBASE_ALWAYS;
811 else
812 return error("Malformed value for %s", var);
813 return 0;
816 /* Add other config variables here and to Documentation/config.txt. */
817 return 0;
820 static int git_default_push_config(const char *var, const char *value)
822 if (!strcmp(var, "push.default")) {
823 if (!value)
824 return config_error_nonbool(var);
825 else if (!strcmp(value, "nothing"))
826 push_default = PUSH_DEFAULT_NOTHING;
827 else if (!strcmp(value, "matching"))
828 push_default = PUSH_DEFAULT_MATCHING;
829 else if (!strcmp(value, "simple"))
830 push_default = PUSH_DEFAULT_SIMPLE;
831 else if (!strcmp(value, "upstream"))
832 push_default = PUSH_DEFAULT_UPSTREAM;
833 else if (!strcmp(value, "tracking")) /* deprecated */
834 push_default = PUSH_DEFAULT_UPSTREAM;
835 else if (!strcmp(value, "current"))
836 push_default = PUSH_DEFAULT_CURRENT;
837 else {
838 error("Malformed value for %s: %s", var, value);
839 return error("Must be one of nothing, matching, simple, "
840 "upstream or current.");
842 return 0;
845 /* Add other config variables here and to Documentation/config.txt. */
846 return 0;
849 static int git_default_mailmap_config(const char *var, const char *value)
851 if (!strcmp(var, "mailmap.file"))
852 return git_config_string(&git_mailmap_file, var, value);
853 if (!strcmp(var, "mailmap.blob"))
854 return git_config_string(&git_mailmap_blob, var, value);
856 /* Add other config variables here and to Documentation/config.txt. */
857 return 0;
860 int git_default_config(const char *var, const char *value, void *dummy)
862 if (!prefixcmp(var, "core."))
863 return git_default_core_config(var, value);
865 if (!prefixcmp(var, "user."))
866 return git_ident_config(var, value, dummy);
868 if (!prefixcmp(var, "i18n."))
869 return git_default_i18n_config(var, value);
871 if (!prefixcmp(var, "branch."))
872 return git_default_branch_config(var, value);
874 if (!prefixcmp(var, "push."))
875 return git_default_push_config(var, value);
877 if (!prefixcmp(var, "mailmap."))
878 return git_default_mailmap_config(var, value);
880 if (!prefixcmp(var, "advice."))
881 return git_default_advice_config(var, value);
883 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
884 pager_use_color = git_config_bool(var,value);
885 return 0;
888 if (!strcmp(var, "pack.packsizelimit")) {
889 pack_size_limit_cfg = git_config_ulong(var, value);
890 return 0;
892 /* Add other config variables here and to Documentation/config.txt. */
893 return 0;
897 * The fields f and name of top need to be initialized before calling
898 * this function.
900 static int do_config_from(struct config_file *top, config_fn_t fn, void *data)
902 int ret;
904 /* push config-file parsing state stack */
905 top->prev = cf;
906 top->linenr = 1;
907 top->eof = 0;
908 strbuf_init(&top->value, 1024);
909 strbuf_init(&top->var, 1024);
910 cf = top;
912 ret = git_parse_file(fn, data);
914 /* pop config-file parsing state stack */
915 strbuf_release(&top->value);
916 strbuf_release(&top->var);
917 cf = top->prev;
919 return ret;
922 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
924 int ret;
925 FILE *f = fopen(filename, "r");
927 ret = -1;
928 if (f) {
929 config_file top;
931 top.f = f;
932 top.name = filename;
934 ret = do_config_from(&top, fn, data);
936 fclose(f);
938 return ret;
941 const char *git_etc_gitconfig(void)
943 static const char *system_wide;
944 if (!system_wide)
945 system_wide = system_path(ETC_GITCONFIG);
946 return system_wide;
949 int git_env_bool(const char *k, int def)
951 const char *v = getenv(k);
952 return v ? git_config_bool(k, v) : def;
955 int git_config_system(void)
957 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
960 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
962 int ret = 0, found = 0;
963 char *xdg_config = NULL;
964 char *user_config = NULL;
966 home_config_paths(&user_config, &xdg_config, "config");
968 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK)) {
969 ret += git_config_from_file(fn, git_etc_gitconfig(),
970 data);
971 found += 1;
974 if (xdg_config && !access_or_die(xdg_config, R_OK)) {
975 ret += git_config_from_file(fn, xdg_config, data);
976 found += 1;
979 if (user_config && !access_or_die(user_config, R_OK)) {
980 ret += git_config_from_file(fn, user_config, data);
981 found += 1;
984 if (repo_config && !access_or_die(repo_config, R_OK)) {
985 ret += git_config_from_file(fn, repo_config, data);
986 found += 1;
989 switch (git_config_from_parameters(fn, data)) {
990 case -1: /* error */
991 die("unable to parse command-line config");
992 break;
993 case 0: /* found nothing */
994 break;
995 default: /* found at least one item */
996 found++;
997 break;
1000 free(xdg_config);
1001 free(user_config);
1002 return ret == 0 ? found : ret;
1005 int git_config_with_options(config_fn_t fn, void *data,
1006 const char *filename, int respect_includes)
1008 char *repo_config = NULL;
1009 int ret;
1010 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1012 if (respect_includes) {
1013 inc.fn = fn;
1014 inc.data = data;
1015 fn = git_config_include;
1016 data = &inc;
1020 * If we have a specific filename, use it. Otherwise, follow the
1021 * regular lookup sequence.
1023 if (filename)
1024 return git_config_from_file(fn, filename, data);
1026 repo_config = git_pathdup("config");
1027 ret = git_config_early(fn, data, repo_config);
1028 if (repo_config)
1029 free(repo_config);
1030 return ret;
1033 int git_config(config_fn_t fn, void *data)
1035 return git_config_with_options(fn, data, NULL, 1);
1039 * Find all the stuff for git_config_set() below.
1042 #define MAX_MATCHES 512
1044 static struct {
1045 int baselen;
1046 char *key;
1047 int do_not_match;
1048 regex_t *value_regex;
1049 int multi_replace;
1050 size_t offset[MAX_MATCHES];
1051 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1052 int seen;
1053 } store;
1055 static int matches(const char *key, const char *value)
1057 return !strcmp(key, store.key) &&
1058 (store.value_regex == NULL ||
1059 (store.do_not_match ^
1060 !regexec(store.value_regex, value, 0, NULL, 0)));
1063 static int store_aux(const char *key, const char *value, void *cb)
1065 const char *ep;
1066 size_t section_len;
1067 FILE *f = cf->f;
1069 switch (store.state) {
1070 case KEY_SEEN:
1071 if (matches(key, value)) {
1072 if (store.seen == 1 && store.multi_replace == 0) {
1073 warning("%s has multiple values", key);
1074 } else if (store.seen >= MAX_MATCHES) {
1075 error("too many matches for %s", key);
1076 return 1;
1079 store.offset[store.seen] = ftell(f);
1080 store.seen++;
1082 break;
1083 case SECTION_SEEN:
1085 * What we are looking for is in store.key (both
1086 * section and var), and its section part is baselen
1087 * long. We found key (again, both section and var).
1088 * We would want to know if this key is in the same
1089 * section as what we are looking for. We already
1090 * know we are in the same section as what should
1091 * hold store.key.
1093 ep = strrchr(key, '.');
1094 section_len = ep - key;
1096 if ((section_len != store.baselen) ||
1097 memcmp(key, store.key, section_len+1)) {
1098 store.state = SECTION_END_SEEN;
1099 break;
1103 * Do not increment matches: this is no match, but we
1104 * just made sure we are in the desired section.
1106 store.offset[store.seen] = ftell(f);
1107 /* fallthru */
1108 case SECTION_END_SEEN:
1109 case START:
1110 if (matches(key, value)) {
1111 store.offset[store.seen] = ftell(f);
1112 store.state = KEY_SEEN;
1113 store.seen++;
1114 } else {
1115 if (strrchr(key, '.') - key == store.baselen &&
1116 !strncmp(key, store.key, store.baselen)) {
1117 store.state = SECTION_SEEN;
1118 store.offset[store.seen] = ftell(f);
1122 return 0;
1125 static int write_error(const char *filename)
1127 error("failed to write new configuration file %s", filename);
1129 /* Same error code as "failed to rename". */
1130 return 4;
1133 static int store_write_section(int fd, const char *key)
1135 const char *dot;
1136 int i, success;
1137 struct strbuf sb = STRBUF_INIT;
1139 dot = memchr(key, '.', store.baselen);
1140 if (dot) {
1141 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1142 for (i = dot - key + 1; i < store.baselen; i++) {
1143 if (key[i] == '"' || key[i] == '\\')
1144 strbuf_addch(&sb, '\\');
1145 strbuf_addch(&sb, key[i]);
1147 strbuf_addstr(&sb, "\"]\n");
1148 } else {
1149 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1152 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1153 strbuf_release(&sb);
1155 return success;
1158 static int store_write_pair(int fd, const char *key, const char *value)
1160 int i, success;
1161 int length = strlen(key + store.baselen + 1);
1162 const char *quote = "";
1163 struct strbuf sb = STRBUF_INIT;
1166 * Check to see if the value needs to be surrounded with a dq pair.
1167 * Note that problematic characters are always backslash-quoted; this
1168 * check is about not losing leading or trailing SP and strings that
1169 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1170 * configuration parser.
1172 if (value[0] == ' ')
1173 quote = "\"";
1174 for (i = 0; value[i]; i++)
1175 if (value[i] == ';' || value[i] == '#')
1176 quote = "\"";
1177 if (i && value[i - 1] == ' ')
1178 quote = "\"";
1180 strbuf_addf(&sb, "\t%.*s = %s",
1181 length, key + store.baselen + 1, quote);
1183 for (i = 0; value[i]; i++)
1184 switch (value[i]) {
1185 case '\n':
1186 strbuf_addstr(&sb, "\\n");
1187 break;
1188 case '\t':
1189 strbuf_addstr(&sb, "\\t");
1190 break;
1191 case '"':
1192 case '\\':
1193 strbuf_addch(&sb, '\\');
1194 default:
1195 strbuf_addch(&sb, value[i]);
1196 break;
1198 strbuf_addf(&sb, "%s\n", quote);
1200 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1201 strbuf_release(&sb);
1203 return success;
1206 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1207 size_t offset_, int *found_bracket)
1209 size_t equal_offset = size, bracket_offset = size;
1210 ssize_t offset;
1212 contline:
1213 for (offset = offset_-2; offset > 0
1214 && contents[offset] != '\n'; offset--)
1215 switch (contents[offset]) {
1216 case '=': equal_offset = offset; break;
1217 case ']': bracket_offset = offset; break;
1219 if (offset > 0 && contents[offset-1] == '\\') {
1220 offset_ = offset;
1221 goto contline;
1223 if (bracket_offset < equal_offset) {
1224 *found_bracket = 1;
1225 offset = bracket_offset+1;
1226 } else
1227 offset++;
1229 return offset;
1232 int git_config_set_in_file(const char *config_filename,
1233 const char *key, const char *value)
1235 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1238 int git_config_set(const char *key, const char *value)
1240 return git_config_set_multivar(key, value, NULL, 0);
1244 * Auxiliary function to sanity-check and split the key into the section
1245 * identifier and variable name.
1247 * Returns 0 on success, -1 when there is an invalid character in the key and
1248 * -2 if there is no section name in the key.
1250 * store_key - pointer to char* which will hold a copy of the key with
1251 * lowercase section and variable name
1252 * baselen - pointer to int which will hold the length of the
1253 * section + subsection part, can be NULL
1255 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1257 int i, dot, baselen;
1258 const char *last_dot = strrchr(key, '.');
1261 * Since "key" actually contains the section name and the real
1262 * key name separated by a dot, we have to know where the dot is.
1265 if (last_dot == NULL || last_dot == key) {
1266 error("key does not contain a section: %s", key);
1267 return -CONFIG_NO_SECTION_OR_NAME;
1270 if (!last_dot[1]) {
1271 error("key does not contain variable name: %s", key);
1272 return -CONFIG_NO_SECTION_OR_NAME;
1275 baselen = last_dot - key;
1276 if (baselen_)
1277 *baselen_ = baselen;
1280 * Validate the key and while at it, lower case it for matching.
1282 *store_key = xmalloc(strlen(key) + 1);
1284 dot = 0;
1285 for (i = 0; key[i]; i++) {
1286 unsigned char c = key[i];
1287 if (c == '.')
1288 dot = 1;
1289 /* Leave the extended basename untouched.. */
1290 if (!dot || i > baselen) {
1291 if (!iskeychar(c) ||
1292 (i == baselen + 1 && !isalpha(c))) {
1293 error("invalid key: %s", key);
1294 goto out_free_ret_1;
1296 c = tolower(c);
1297 } else if (c == '\n') {
1298 error("invalid key (newline): %s", key);
1299 goto out_free_ret_1;
1301 (*store_key)[i] = c;
1303 (*store_key)[i] = 0;
1305 return 0;
1307 out_free_ret_1:
1308 free(*store_key);
1309 *store_key = NULL;
1310 return -CONFIG_INVALID_KEY;
1314 * If value==NULL, unset in (remove from) config,
1315 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1316 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1317 * else all matching key/values (regardless how many) are removed,
1318 * before the new pair is written.
1320 * Returns 0 on success.
1322 * This function does this:
1324 * - it locks the config file by creating ".git/config.lock"
1326 * - it then parses the config using store_aux() as validator to find
1327 * the position on the key/value pair to replace. If it is to be unset,
1328 * it must be found exactly once.
1330 * - the config file is mmap()ed and the part before the match (if any) is
1331 * written to the lock file, then the changed part and the rest.
1333 * - the config file is removed and the lock file rename()d to it.
1336 int git_config_set_multivar_in_file(const char *config_filename,
1337 const char *key, const char *value,
1338 const char *value_regex, int multi_replace)
1340 int fd = -1, in_fd;
1341 int ret;
1342 struct lock_file *lock = NULL;
1343 char *filename_buf = NULL;
1345 /* parse-key returns negative; flip the sign to feed exit(3) */
1346 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1347 if (ret)
1348 goto out_free;
1350 store.multi_replace = multi_replace;
1352 if (!config_filename)
1353 config_filename = filename_buf = git_pathdup("config");
1356 * The lock serves a purpose in addition to locking: the new
1357 * contents of .git/config will be written into it.
1359 lock = xcalloc(sizeof(struct lock_file), 1);
1360 fd = hold_lock_file_for_update(lock, config_filename, 0);
1361 if (fd < 0) {
1362 error("could not lock config file %s: %s", config_filename, strerror(errno));
1363 free(store.key);
1364 ret = CONFIG_NO_LOCK;
1365 goto out_free;
1369 * If .git/config does not exist yet, write a minimal version.
1371 in_fd = open(config_filename, O_RDONLY);
1372 if ( in_fd < 0 ) {
1373 free(store.key);
1375 if ( ENOENT != errno ) {
1376 error("opening %s: %s", config_filename,
1377 strerror(errno));
1378 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1379 goto out_free;
1381 /* if nothing to unset, error out */
1382 if (value == NULL) {
1383 ret = CONFIG_NOTHING_SET;
1384 goto out_free;
1387 store.key = (char *)key;
1388 if (!store_write_section(fd, key) ||
1389 !store_write_pair(fd, key, value))
1390 goto write_err_out;
1391 } else {
1392 struct stat st;
1393 char *contents;
1394 size_t contents_sz, copy_begin, copy_end;
1395 int i, new_line = 0;
1397 if (value_regex == NULL)
1398 store.value_regex = NULL;
1399 else {
1400 if (value_regex[0] == '!') {
1401 store.do_not_match = 1;
1402 value_regex++;
1403 } else
1404 store.do_not_match = 0;
1406 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1407 if (regcomp(store.value_regex, value_regex,
1408 REG_EXTENDED)) {
1409 error("invalid pattern: %s", value_regex);
1410 free(store.value_regex);
1411 ret = CONFIG_INVALID_PATTERN;
1412 goto out_free;
1416 store.offset[0] = 0;
1417 store.state = START;
1418 store.seen = 0;
1421 * After this, store.offset will contain the *end* offset
1422 * of the last match, or remain at 0 if no match was found.
1423 * As a side effect, we make sure to transform only a valid
1424 * existing config file.
1426 if (git_config_from_file(store_aux, config_filename, NULL)) {
1427 error("invalid config file %s", config_filename);
1428 free(store.key);
1429 if (store.value_regex != NULL) {
1430 regfree(store.value_regex);
1431 free(store.value_regex);
1433 ret = CONFIG_INVALID_FILE;
1434 goto out_free;
1437 free(store.key);
1438 if (store.value_regex != NULL) {
1439 regfree(store.value_regex);
1440 free(store.value_regex);
1443 /* if nothing to unset, or too many matches, error out */
1444 if ((store.seen == 0 && value == NULL) ||
1445 (store.seen > 1 && multi_replace == 0)) {
1446 ret = CONFIG_NOTHING_SET;
1447 goto out_free;
1450 fstat(in_fd, &st);
1451 contents_sz = xsize_t(st.st_size);
1452 contents = xmmap(NULL, contents_sz, PROT_READ,
1453 MAP_PRIVATE, in_fd, 0);
1454 close(in_fd);
1456 if (store.seen == 0)
1457 store.seen = 1;
1459 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1460 if (store.offset[i] == 0) {
1461 store.offset[i] = copy_end = contents_sz;
1462 } else if (store.state != KEY_SEEN) {
1463 copy_end = store.offset[i];
1464 } else
1465 copy_end = find_beginning_of_line(
1466 contents, contents_sz,
1467 store.offset[i]-2, &new_line);
1469 if (copy_end > 0 && contents[copy_end-1] != '\n')
1470 new_line = 1;
1472 /* write the first part of the config */
1473 if (copy_end > copy_begin) {
1474 if (write_in_full(fd, contents + copy_begin,
1475 copy_end - copy_begin) <
1476 copy_end - copy_begin)
1477 goto write_err_out;
1478 if (new_line &&
1479 write_str_in_full(fd, "\n") != 1)
1480 goto write_err_out;
1482 copy_begin = store.offset[i];
1485 /* write the pair (value == NULL means unset) */
1486 if (value != NULL) {
1487 if (store.state == START) {
1488 if (!store_write_section(fd, key))
1489 goto write_err_out;
1491 if (!store_write_pair(fd, key, value))
1492 goto write_err_out;
1495 /* write the rest of the config */
1496 if (copy_begin < contents_sz)
1497 if (write_in_full(fd, contents + copy_begin,
1498 contents_sz - copy_begin) <
1499 contents_sz - copy_begin)
1500 goto write_err_out;
1502 munmap(contents, contents_sz);
1505 if (commit_lock_file(lock) < 0) {
1506 error("could not commit config file %s", config_filename);
1507 ret = CONFIG_NO_WRITE;
1508 goto out_free;
1512 * lock is committed, so don't try to roll it back below.
1513 * NOTE: Since lockfile.c keeps a linked list of all created
1514 * lock_file structures, it isn't safe to free(lock). It's
1515 * better to just leave it hanging around.
1517 lock = NULL;
1518 ret = 0;
1520 out_free:
1521 if (lock)
1522 rollback_lock_file(lock);
1523 free(filename_buf);
1524 return ret;
1526 write_err_out:
1527 ret = write_error(lock->filename);
1528 goto out_free;
1532 int git_config_set_multivar(const char *key, const char *value,
1533 const char *value_regex, int multi_replace)
1535 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1536 multi_replace);
1539 static int section_name_match (const char *buf, const char *name)
1541 int i = 0, j = 0, dot = 0;
1542 if (buf[i] != '[')
1543 return 0;
1544 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1545 if (!dot && isspace(buf[i])) {
1546 dot = 1;
1547 if (name[j++] != '.')
1548 break;
1549 for (i++; isspace(buf[i]); i++)
1550 ; /* do nothing */
1551 if (buf[i] != '"')
1552 break;
1553 continue;
1555 if (buf[i] == '\\' && dot)
1556 i++;
1557 else if (buf[i] == '"' && dot) {
1558 for (i++; isspace(buf[i]); i++)
1559 ; /* do_nothing */
1560 break;
1562 if (buf[i] != name[j++])
1563 break;
1565 if (buf[i] == ']' && name[j] == 0) {
1567 * We match, now just find the right length offset by
1568 * gobbling up any whitespace after it, as well
1570 i++;
1571 for (; buf[i] && isspace(buf[i]); i++)
1572 ; /* do nothing */
1573 return i;
1575 return 0;
1578 static int section_name_is_ok(const char *name)
1580 /* Empty section names are bogus. */
1581 if (!*name)
1582 return 0;
1585 * Before a dot, we must be alphanumeric or dash. After the first dot,
1586 * anything goes, so we can stop checking.
1588 for (; *name && *name != '.'; name++)
1589 if (*name != '-' && !isalnum(*name))
1590 return 0;
1591 return 1;
1594 /* if new_name == NULL, the section is removed instead */
1595 int git_config_rename_section_in_file(const char *config_filename,
1596 const char *old_name, const char *new_name)
1598 int ret = 0, remove = 0;
1599 char *filename_buf = NULL;
1600 struct lock_file *lock;
1601 int out_fd;
1602 char buf[1024];
1603 FILE *config_file;
1605 if (new_name && !section_name_is_ok(new_name)) {
1606 ret = error("invalid section name: %s", new_name);
1607 goto out;
1610 if (!config_filename)
1611 config_filename = filename_buf = git_pathdup("config");
1613 lock = xcalloc(sizeof(struct lock_file), 1);
1614 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1615 if (out_fd < 0) {
1616 ret = error("could not lock config file %s", config_filename);
1617 goto out;
1620 if (!(config_file = fopen(config_filename, "rb"))) {
1621 /* no config file means nothing to rename, no error */
1622 goto unlock_and_out;
1625 while (fgets(buf, sizeof(buf), config_file)) {
1626 int i;
1627 int length;
1628 char *output = buf;
1629 for (i = 0; buf[i] && isspace(buf[i]); i++)
1630 ; /* do nothing */
1631 if (buf[i] == '[') {
1632 /* it's a section */
1633 int offset = section_name_match(&buf[i], old_name);
1634 if (offset > 0) {
1635 ret++;
1636 if (new_name == NULL) {
1637 remove = 1;
1638 continue;
1640 store.baselen = strlen(new_name);
1641 if (!store_write_section(out_fd, new_name)) {
1642 ret = write_error(lock->filename);
1643 goto out;
1646 * We wrote out the new section, with
1647 * a newline, now skip the old
1648 * section's length
1650 output += offset + i;
1651 if (strlen(output) > 0) {
1653 * More content means there's
1654 * a declaration to put on the
1655 * next line; indent with a
1656 * tab
1658 output -= 1;
1659 output[0] = '\t';
1662 remove = 0;
1664 if (remove)
1665 continue;
1666 length = strlen(output);
1667 if (write_in_full(out_fd, output, length) != length) {
1668 ret = write_error(lock->filename);
1669 goto out;
1672 fclose(config_file);
1673 unlock_and_out:
1674 if (commit_lock_file(lock) < 0)
1675 ret = error("could not commit config file %s", config_filename);
1676 out:
1677 free(filename_buf);
1678 return ret;
1681 int git_config_rename_section(const char *old_name, const char *new_name)
1683 return git_config_rename_section_in_file(NULL, old_name, new_name);
1687 * Call this to report error for your variable that should not
1688 * get a boolean value (i.e. "[my] var" means "true").
1690 #undef config_error_nonbool
1691 int config_error_nonbool(const char *var)
1693 return error("Missing value for '%s'", var);
1696 int parse_config_key(const char *var,
1697 const char *section,
1698 const char **subsection, int *subsection_len,
1699 const char **key)
1701 int section_len = strlen(section);
1702 const char *dot;
1704 /* Does it start with "section." ? */
1705 if (prefixcmp(var, section) || var[section_len] != '.')
1706 return -1;
1709 * Find the key; we don't know yet if we have a subsection, but we must
1710 * parse backwards from the end, since the subsection may have dots in
1711 * it, too.
1713 dot = strrchr(var, '.');
1714 *key = dot + 1;
1716 /* Did we have a subsection at all? */
1717 if (dot == var + section_len) {
1718 *subsection = NULL;
1719 *subsection_len = 0;
1721 else {
1722 *subsection = var + section_len + 1;
1723 *subsection_len = dot - *subsection;
1726 return 0;