Merge git://ozlabs.org/~paulus/gitk
[git/mingw.git] / config.c
blob3f638e3c00c9ee5000a0f3d3518fd1e7bc1457b6
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;
174 c = '\n';
175 if (cf && ((f = cf->f) != NULL)) {
176 c = fgetc(f);
177 if (c == '\r') {
178 /* DOS like systems */
179 c = fgetc(f);
180 if (c != '\n') {
181 ungetc(c, f);
182 c = '\r';
185 if (c == '\n')
186 cf->linenr++;
187 if (c == EOF) {
188 cf->eof = 1;
189 c = '\n';
192 return c;
195 static char *parse_value(void)
197 int quote = 0, comment = 0, space = 0;
199 strbuf_reset(&cf->value);
200 for (;;) {
201 int c = get_next_char();
202 if (c == '\n') {
203 if (quote) {
204 cf->linenr--;
205 return NULL;
207 return cf->value.buf;
209 if (comment)
210 continue;
211 if (isspace(c) && !quote) {
212 if (cf->value.len)
213 space++;
214 continue;
216 if (!quote) {
217 if (c == ';' || c == '#') {
218 comment = 1;
219 continue;
222 for (; space; space--)
223 strbuf_addch(&cf->value, ' ');
224 if (c == '\\') {
225 c = get_next_char();
226 switch (c) {
227 case '\n':
228 continue;
229 case 't':
230 c = '\t';
231 break;
232 case 'b':
233 c = '\b';
234 break;
235 case 'n':
236 c = '\n';
237 break;
238 /* Some characters escape as themselves */
239 case '\\': case '"':
240 break;
241 /* Reject unknown escape sequences */
242 default:
243 return NULL;
245 strbuf_addch(&cf->value, c);
246 continue;
248 if (c == '"') {
249 quote = 1-quote;
250 continue;
252 strbuf_addch(&cf->value, c);
256 static inline int iskeychar(int c)
258 return isalnum(c) || c == '-';
261 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
263 int c;
264 char *value;
266 /* Get the full name */
267 for (;;) {
268 c = get_next_char();
269 if (cf->eof)
270 break;
271 if (!iskeychar(c))
272 break;
273 strbuf_addch(name, tolower(c));
276 while (c == ' ' || c == '\t')
277 c = get_next_char();
279 value = NULL;
280 if (c != '\n') {
281 if (c != '=')
282 return -1;
283 value = parse_value();
284 if (!value)
285 return -1;
287 return fn(name->buf, value, data);
290 static int get_extended_base_var(struct strbuf *name, int c)
292 do {
293 if (c == '\n')
294 goto error_incomplete_line;
295 c = get_next_char();
296 } while (isspace(c));
298 /* We require the format to be '[base "extension"]' */
299 if (c != '"')
300 return -1;
301 strbuf_addch(name, '.');
303 for (;;) {
304 int c = get_next_char();
305 if (c == '\n')
306 goto error_incomplete_line;
307 if (c == '"')
308 break;
309 if (c == '\\') {
310 c = get_next_char();
311 if (c == '\n')
312 goto error_incomplete_line;
314 strbuf_addch(name, c);
317 /* Final ']' */
318 if (get_next_char() != ']')
319 return -1;
320 return 0;
321 error_incomplete_line:
322 cf->linenr--;
323 return -1;
326 static int get_base_var(struct strbuf *name)
328 for (;;) {
329 int c = get_next_char();
330 if (cf->eof)
331 return -1;
332 if (c == ']')
333 return 0;
334 if (isspace(c))
335 return get_extended_base_var(name, c);
336 if (!iskeychar(c) && c != '.')
337 return -1;
338 strbuf_addch(name, tolower(c));
342 static int git_parse_file(config_fn_t fn, void *data)
344 int comment = 0;
345 int baselen = 0;
346 struct strbuf *var = &cf->var;
348 /* U+FEFF Byte Order Mark in UTF8 */
349 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
350 const unsigned char *bomptr = utf8_bom;
352 for (;;) {
353 int c = get_next_char();
354 if (bomptr && *bomptr) {
355 /* We are at the file beginning; skip UTF8-encoded BOM
356 * if present. Sane editors won't put this in on their
357 * own, but e.g. Windows Notepad will do it happily. */
358 if ((unsigned char) c == *bomptr) {
359 bomptr++;
360 continue;
361 } else {
362 /* Do not tolerate partial BOM. */
363 if (bomptr != utf8_bom)
364 break;
365 /* No BOM at file beginning. Cool. */
366 bomptr = NULL;
369 if (c == '\n') {
370 if (cf->eof)
371 return 0;
372 comment = 0;
373 continue;
375 if (comment || isspace(c))
376 continue;
377 if (c == '#' || c == ';') {
378 comment = 1;
379 continue;
381 if (c == '[') {
382 /* Reset prior to determining a new stem */
383 strbuf_reset(var);
384 if (get_base_var(var) < 0 || var->len < 1)
385 break;
386 strbuf_addch(var, '.');
387 baselen = var->len;
388 continue;
390 if (!isalpha(c))
391 break;
393 * Truncate the var name back to the section header
394 * stem prior to grabbing the suffix part of the name
395 * and the value.
397 strbuf_setlen(var, baselen);
398 strbuf_addch(var, tolower(c));
399 if (get_value(fn, data, var) < 0)
400 break;
402 die("bad config file line %d in %s", cf->linenr, cf->name);
405 static int parse_unit_factor(const char *end, uintmax_t *val)
407 if (!*end)
408 return 1;
409 else if (!strcasecmp(end, "k")) {
410 *val *= 1024;
411 return 1;
413 else if (!strcasecmp(end, "m")) {
414 *val *= 1024 * 1024;
415 return 1;
417 else if (!strcasecmp(end, "g")) {
418 *val *= 1024 * 1024 * 1024;
419 return 1;
421 return 0;
424 static int git_parse_long(const char *value, long *ret)
426 if (value && *value) {
427 char *end;
428 intmax_t val;
429 uintmax_t uval;
430 uintmax_t factor = 1;
432 errno = 0;
433 val = strtoimax(value, &end, 0);
434 if (errno == ERANGE)
435 return 0;
436 if (!parse_unit_factor(end, &factor))
437 return 0;
438 uval = abs(val);
439 uval *= factor;
440 if ((uval > maximum_signed_value_of_type(long)) ||
441 (abs(val) > uval))
442 return 0;
443 val *= factor;
444 *ret = val;
445 return 1;
447 return 0;
450 int git_parse_ulong(const char *value, unsigned long *ret)
452 if (value && *value) {
453 char *end;
454 uintmax_t val;
455 uintmax_t oldval;
457 errno = 0;
458 val = strtoumax(value, &end, 0);
459 if (errno == ERANGE)
460 return 0;
461 oldval = val;
462 if (!parse_unit_factor(end, &val))
463 return 0;
464 if ((val > maximum_unsigned_value_of_type(long)) ||
465 (oldval > val))
466 return 0;
467 *ret = val;
468 return 1;
470 return 0;
473 static void die_bad_config(const char *name)
475 if (cf && cf->name)
476 die("bad config value for '%s' in %s", name, cf->name);
477 die("bad config value for '%s'", name);
480 int git_config_int(const char *name, const char *value)
482 long ret = 0;
483 if (!git_parse_long(value, &ret))
484 die_bad_config(name);
485 return ret;
488 unsigned long git_config_ulong(const char *name, const char *value)
490 unsigned long ret;
491 if (!git_parse_ulong(value, &ret))
492 die_bad_config(name);
493 return ret;
496 static int git_config_maybe_bool_text(const char *name, const char *value)
498 if (!value)
499 return 1;
500 if (!*value)
501 return 0;
502 if (!strcasecmp(value, "true")
503 || !strcasecmp(value, "yes")
504 || !strcasecmp(value, "on"))
505 return 1;
506 if (!strcasecmp(value, "false")
507 || !strcasecmp(value, "no")
508 || !strcasecmp(value, "off"))
509 return 0;
510 return -1;
513 int git_config_maybe_bool(const char *name, const char *value)
515 long v = git_config_maybe_bool_text(name, value);
516 if (0 <= v)
517 return v;
518 if (git_parse_long(value, &v))
519 return !!v;
520 return -1;
523 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
525 int v = git_config_maybe_bool_text(name, value);
526 if (0 <= v) {
527 *is_bool = 1;
528 return v;
530 *is_bool = 0;
531 return git_config_int(name, value);
534 int git_config_bool(const char *name, const char *value)
536 int discard;
537 return !!git_config_bool_or_int(name, value, &discard);
540 int git_config_string(const char **dest, const char *var, const char *value)
542 if (!value)
543 return config_error_nonbool(var);
544 *dest = xstrdup(value);
545 return 0;
548 int git_config_pathname(const char **dest, const char *var, const char *value)
550 if (!value)
551 return config_error_nonbool(var);
552 *dest = expand_user_path(value);
553 if (!*dest)
554 die("Failed to expand user dir in: '%s'", value);
555 return 0;
558 static int git_default_core_config(const char *var, const char *value)
560 /* This needs a better name */
561 if (!strcmp(var, "core.filemode")) {
562 trust_executable_bit = git_config_bool(var, value);
563 return 0;
565 if (!strcmp(var, "core.trustctime")) {
566 trust_ctime = git_config_bool(var, value);
567 return 0;
569 if (!strcmp(var, "core.statinfo")) {
570 if (!strcasecmp(value, "default"))
571 check_stat = 1;
572 else if (!strcasecmp(value, "minimal"))
573 check_stat = 0;
576 if (!strcmp(var, "core.quotepath")) {
577 quote_path_fully = git_config_bool(var, value);
578 return 0;
581 if (!strcmp(var, "core.symlinks")) {
582 has_symlinks = git_config_bool(var, value);
583 return 0;
586 if (!strcmp(var, "core.ignorecase")) {
587 ignore_case = git_config_bool(var, value);
588 return 0;
591 if (!strcmp(var, "core.attributesfile"))
592 return git_config_pathname(&git_attributes_file, var, value);
594 if (!strcmp(var, "core.bare")) {
595 is_bare_repository_cfg = git_config_bool(var, value);
596 return 0;
599 if (!strcmp(var, "core.ignorestat")) {
600 assume_unchanged = git_config_bool(var, value);
601 return 0;
604 if (!strcmp(var, "core.prefersymlinkrefs")) {
605 prefer_symlink_refs = git_config_bool(var, value);
606 return 0;
609 if (!strcmp(var, "core.logallrefupdates")) {
610 log_all_ref_updates = git_config_bool(var, value);
611 return 0;
614 if (!strcmp(var, "core.warnambiguousrefs")) {
615 warn_ambiguous_refs = git_config_bool(var, value);
616 return 0;
619 if (!strcmp(var, "core.abbrev")) {
620 int abbrev = git_config_int(var, value);
621 if (abbrev < minimum_abbrev || abbrev > 40)
622 return -1;
623 default_abbrev = abbrev;
624 return 0;
627 if (!strcmp(var, "core.loosecompression")) {
628 int level = git_config_int(var, value);
629 if (level == -1)
630 level = Z_DEFAULT_COMPRESSION;
631 else if (level < 0 || level > Z_BEST_COMPRESSION)
632 die("bad zlib compression level %d", level);
633 zlib_compression_level = level;
634 zlib_compression_seen = 1;
635 return 0;
638 if (!strcmp(var, "core.compression")) {
639 int level = git_config_int(var, value);
640 if (level == -1)
641 level = Z_DEFAULT_COMPRESSION;
642 else if (level < 0 || level > Z_BEST_COMPRESSION)
643 die("bad zlib compression level %d", level);
644 core_compression_level = level;
645 core_compression_seen = 1;
646 if (!zlib_compression_seen)
647 zlib_compression_level = level;
648 return 0;
651 if (!strcmp(var, "core.packedgitwindowsize")) {
652 int pgsz_x2 = getpagesize() * 2;
653 packed_git_window_size = git_config_ulong(var, value);
655 /* This value must be multiple of (pagesize * 2) */
656 packed_git_window_size /= pgsz_x2;
657 if (packed_git_window_size < 1)
658 packed_git_window_size = 1;
659 packed_git_window_size *= pgsz_x2;
660 return 0;
663 if (!strcmp(var, "core.bigfilethreshold")) {
664 big_file_threshold = git_config_ulong(var, value);
665 return 0;
668 if (!strcmp(var, "core.packedgitlimit")) {
669 packed_git_limit = git_config_ulong(var, value);
670 return 0;
673 if (!strcmp(var, "core.deltabasecachelimit")) {
674 delta_base_cache_limit = git_config_ulong(var, value);
675 return 0;
678 if (!strcmp(var, "core.logpackaccess"))
679 return git_config_string(&log_pack_access, var, value);
681 if (!strcmp(var, "core.autocrlf")) {
682 if (value && !strcasecmp(value, "input")) {
683 if (core_eol == EOL_CRLF)
684 return error("core.autocrlf=input conflicts with core.eol=crlf");
685 auto_crlf = AUTO_CRLF_INPUT;
686 return 0;
688 auto_crlf = git_config_bool(var, value);
689 return 0;
692 if (!strcmp(var, "core.safecrlf")) {
693 if (value && !strcasecmp(value, "warn")) {
694 safe_crlf = SAFE_CRLF_WARN;
695 return 0;
697 safe_crlf = git_config_bool(var, value);
698 return 0;
701 if (!strcmp(var, "core.eol")) {
702 if (value && !strcasecmp(value, "lf"))
703 core_eol = EOL_LF;
704 else if (value && !strcasecmp(value, "crlf"))
705 core_eol = EOL_CRLF;
706 else if (value && !strcasecmp(value, "native"))
707 core_eol = EOL_NATIVE;
708 else
709 core_eol = EOL_UNSET;
710 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
711 return error("core.autocrlf=input conflicts with core.eol=crlf");
712 return 0;
715 if (!strcmp(var, "core.notesref")) {
716 notes_ref_name = xstrdup(value);
717 return 0;
720 if (!strcmp(var, "core.pager"))
721 return git_config_string(&pager_program, var, value);
723 if (!strcmp(var, "core.editor"))
724 return git_config_string(&editor_program, var, value);
726 if (!strcmp(var, "core.askpass"))
727 return git_config_string(&askpass_program, var, value);
729 if (!strcmp(var, "core.excludesfile"))
730 return git_config_pathname(&excludes_file, var, value);
732 if (!strcmp(var, "core.whitespace")) {
733 if (!value)
734 return config_error_nonbool(var);
735 whitespace_rule_cfg = parse_whitespace_rule(value);
736 return 0;
739 if (!strcmp(var, "core.fsyncobjectfiles")) {
740 fsync_object_files = git_config_bool(var, value);
741 return 0;
744 if (!strcmp(var, "core.preloadindex")) {
745 core_preload_index = git_config_bool(var, value);
746 return 0;
749 if (!strcmp(var, "core.createobject")) {
750 if (!strcmp(value, "rename"))
751 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
752 else if (!strcmp(value, "link"))
753 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
754 else
755 die("Invalid mode for object creation: %s", value);
756 return 0;
759 if (!strcmp(var, "core.sparsecheckout")) {
760 core_apply_sparse_checkout = git_config_bool(var, value);
761 return 0;
764 if (!strcmp(var, "core.precomposeunicode")) {
765 precomposed_unicode = git_config_bool(var, value);
766 return 0;
769 /* Add other config variables here and to Documentation/config.txt. */
770 return 0;
773 static int git_default_i18n_config(const char *var, const char *value)
775 if (!strcmp(var, "i18n.commitencoding"))
776 return git_config_string(&git_commit_encoding, var, value);
778 if (!strcmp(var, "i18n.logoutputencoding"))
779 return git_config_string(&git_log_output_encoding, var, value);
781 /* Add other config variables here and to Documentation/config.txt. */
782 return 0;
785 static int git_default_branch_config(const char *var, const char *value)
787 if (!strcmp(var, "branch.autosetupmerge")) {
788 if (value && !strcasecmp(value, "always")) {
789 git_branch_track = BRANCH_TRACK_ALWAYS;
790 return 0;
792 git_branch_track = git_config_bool(var, value);
793 return 0;
795 if (!strcmp(var, "branch.autosetuprebase")) {
796 if (!value)
797 return config_error_nonbool(var);
798 else if (!strcmp(value, "never"))
799 autorebase = AUTOREBASE_NEVER;
800 else if (!strcmp(value, "local"))
801 autorebase = AUTOREBASE_LOCAL;
802 else if (!strcmp(value, "remote"))
803 autorebase = AUTOREBASE_REMOTE;
804 else if (!strcmp(value, "always"))
805 autorebase = AUTOREBASE_ALWAYS;
806 else
807 return error("Malformed value for %s", var);
808 return 0;
811 /* Add other config variables here and to Documentation/config.txt. */
812 return 0;
815 static int git_default_push_config(const char *var, const char *value)
817 if (!strcmp(var, "push.default")) {
818 if (!value)
819 return config_error_nonbool(var);
820 else if (!strcmp(value, "nothing"))
821 push_default = PUSH_DEFAULT_NOTHING;
822 else if (!strcmp(value, "matching"))
823 push_default = PUSH_DEFAULT_MATCHING;
824 else if (!strcmp(value, "simple"))
825 push_default = PUSH_DEFAULT_SIMPLE;
826 else if (!strcmp(value, "upstream"))
827 push_default = PUSH_DEFAULT_UPSTREAM;
828 else if (!strcmp(value, "tracking")) /* deprecated */
829 push_default = PUSH_DEFAULT_UPSTREAM;
830 else if (!strcmp(value, "current"))
831 push_default = PUSH_DEFAULT_CURRENT;
832 else {
833 error("Malformed value for %s: %s", var, value);
834 return error("Must be one of nothing, matching, simple, "
835 "upstream or current.");
837 return 0;
840 /* Add other config variables here and to Documentation/config.txt. */
841 return 0;
844 static int git_default_mailmap_config(const char *var, const char *value)
846 if (!strcmp(var, "mailmap.file"))
847 return git_config_string(&git_mailmap_file, var, value);
848 if (!strcmp(var, "mailmap.blob"))
849 return git_config_string(&git_mailmap_blob, var, value);
851 /* Add other config variables here and to Documentation/config.txt. */
852 return 0;
855 int git_default_config(const char *var, const char *value, void *dummy)
857 if (!prefixcmp(var, "core."))
858 return git_default_core_config(var, value);
860 if (!prefixcmp(var, "user."))
861 return git_ident_config(var, value, dummy);
863 if (!prefixcmp(var, "i18n."))
864 return git_default_i18n_config(var, value);
866 if (!prefixcmp(var, "branch."))
867 return git_default_branch_config(var, value);
869 if (!prefixcmp(var, "push."))
870 return git_default_push_config(var, value);
872 if (!prefixcmp(var, "mailmap."))
873 return git_default_mailmap_config(var, value);
875 if (!prefixcmp(var, "advice."))
876 return git_default_advice_config(var, value);
878 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
879 pager_use_color = git_config_bool(var,value);
880 return 0;
883 if (!strcmp(var, "pack.packsizelimit")) {
884 pack_size_limit_cfg = git_config_ulong(var, value);
885 return 0;
887 /* Add other config variables here and to Documentation/config.txt. */
888 return 0;
891 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
893 int ret;
894 FILE *f = fopen(filename, "r");
896 ret = -1;
897 if (f) {
898 config_file top;
900 /* push config-file parsing state stack */
901 top.prev = cf;
902 top.f = f;
903 top.name = filename;
904 top.linenr = 1;
905 top.eof = 0;
906 strbuf_init(&top.value, 1024);
907 strbuf_init(&top.var, 1024);
908 cf = &top;
910 ret = git_parse_file(fn, data);
912 /* pop config-file parsing state stack */
913 strbuf_release(&top.value);
914 strbuf_release(&top.var);
915 cf = top.prev;
917 fclose(f);
919 return ret;
922 const char *git_etc_gitconfig(void)
924 static const char *system_wide;
925 if (!system_wide)
926 system_wide = system_path(ETC_GITCONFIG);
927 return system_wide;
930 int git_env_bool(const char *k, int def)
932 const char *v = getenv(k);
933 return v ? git_config_bool(k, v) : def;
936 int git_config_system(void)
938 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
941 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
943 int ret = 0, found = 0;
944 char *xdg_config = NULL;
945 char *user_config = NULL;
947 home_config_paths(&user_config, &xdg_config, "config");
949 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK)) {
950 ret += git_config_from_file(fn, git_etc_gitconfig(),
951 data);
952 found += 1;
955 if (xdg_config && !access_or_die(xdg_config, R_OK)) {
956 ret += git_config_from_file(fn, xdg_config, data);
957 found += 1;
960 if (user_config && !access_or_die(user_config, R_OK)) {
961 ret += git_config_from_file(fn, user_config, data);
962 found += 1;
965 if (repo_config && !access_or_die(repo_config, R_OK)) {
966 ret += git_config_from_file(fn, repo_config, data);
967 found += 1;
970 switch (git_config_from_parameters(fn, data)) {
971 case -1: /* error */
972 die("unable to parse command-line config");
973 break;
974 case 0: /* found nothing */
975 break;
976 default: /* found at least one item */
977 found++;
978 break;
981 free(xdg_config);
982 free(user_config);
983 return ret == 0 ? found : ret;
986 int git_config_with_options(config_fn_t fn, void *data,
987 const char *filename, int respect_includes)
989 char *repo_config = NULL;
990 int ret;
991 struct config_include_data inc = CONFIG_INCLUDE_INIT;
993 if (respect_includes) {
994 inc.fn = fn;
995 inc.data = data;
996 fn = git_config_include;
997 data = &inc;
1001 * If we have a specific filename, use it. Otherwise, follow the
1002 * regular lookup sequence.
1004 if (filename)
1005 return git_config_from_file(fn, filename, data);
1007 repo_config = git_pathdup("config");
1008 ret = git_config_early(fn, data, repo_config);
1009 if (repo_config)
1010 free(repo_config);
1011 return ret;
1014 int git_config(config_fn_t fn, void *data)
1016 return git_config_with_options(fn, data, NULL, 1);
1020 * Find all the stuff for git_config_set() below.
1023 #define MAX_MATCHES 512
1025 static struct {
1026 int baselen;
1027 char *key;
1028 int do_not_match;
1029 regex_t *value_regex;
1030 int multi_replace;
1031 size_t offset[MAX_MATCHES];
1032 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1033 int seen;
1034 } store;
1036 static int matches(const char *key, const char *value)
1038 return !strcmp(key, store.key) &&
1039 (store.value_regex == NULL ||
1040 (store.do_not_match ^
1041 !regexec(store.value_regex, value, 0, NULL, 0)));
1044 static int store_aux(const char *key, const char *value, void *cb)
1046 const char *ep;
1047 size_t section_len;
1048 FILE *f = cf->f;
1050 switch (store.state) {
1051 case KEY_SEEN:
1052 if (matches(key, value)) {
1053 if (store.seen == 1 && store.multi_replace == 0) {
1054 warning("%s has multiple values", key);
1055 } else if (store.seen >= MAX_MATCHES) {
1056 error("too many matches for %s", key);
1057 return 1;
1060 store.offset[store.seen] = ftell(f);
1061 store.seen++;
1063 break;
1064 case SECTION_SEEN:
1066 * What we are looking for is in store.key (both
1067 * section and var), and its section part is baselen
1068 * long. We found key (again, both section and var).
1069 * We would want to know if this key is in the same
1070 * section as what we are looking for. We already
1071 * know we are in the same section as what should
1072 * hold store.key.
1074 ep = strrchr(key, '.');
1075 section_len = ep - key;
1077 if ((section_len != store.baselen) ||
1078 memcmp(key, store.key, section_len+1)) {
1079 store.state = SECTION_END_SEEN;
1080 break;
1084 * Do not increment matches: this is no match, but we
1085 * just made sure we are in the desired section.
1087 store.offset[store.seen] = ftell(f);
1088 /* fallthru */
1089 case SECTION_END_SEEN:
1090 case START:
1091 if (matches(key, value)) {
1092 store.offset[store.seen] = ftell(f);
1093 store.state = KEY_SEEN;
1094 store.seen++;
1095 } else {
1096 if (strrchr(key, '.') - key == store.baselen &&
1097 !strncmp(key, store.key, store.baselen)) {
1098 store.state = SECTION_SEEN;
1099 store.offset[store.seen] = ftell(f);
1103 return 0;
1106 static int write_error(const char *filename)
1108 error("failed to write new configuration file %s", filename);
1110 /* Same error code as "failed to rename". */
1111 return 4;
1114 static int store_write_section(int fd, const char *key)
1116 const char *dot;
1117 int i, success;
1118 struct strbuf sb = STRBUF_INIT;
1120 dot = memchr(key, '.', store.baselen);
1121 if (dot) {
1122 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1123 for (i = dot - key + 1; i < store.baselen; i++) {
1124 if (key[i] == '"' || key[i] == '\\')
1125 strbuf_addch(&sb, '\\');
1126 strbuf_addch(&sb, key[i]);
1128 strbuf_addstr(&sb, "\"]\n");
1129 } else {
1130 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1133 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1134 strbuf_release(&sb);
1136 return success;
1139 static int store_write_pair(int fd, const char *key, const char *value)
1141 int i, success;
1142 int length = strlen(key + store.baselen + 1);
1143 const char *quote = "";
1144 struct strbuf sb = STRBUF_INIT;
1147 * Check to see if the value needs to be surrounded with a dq pair.
1148 * Note that problematic characters are always backslash-quoted; this
1149 * check is about not losing leading or trailing SP and strings that
1150 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1151 * configuration parser.
1153 if (value[0] == ' ')
1154 quote = "\"";
1155 for (i = 0; value[i]; i++)
1156 if (value[i] == ';' || value[i] == '#')
1157 quote = "\"";
1158 if (i && value[i - 1] == ' ')
1159 quote = "\"";
1161 strbuf_addf(&sb, "\t%.*s = %s",
1162 length, key + store.baselen + 1, quote);
1164 for (i = 0; value[i]; i++)
1165 switch (value[i]) {
1166 case '\n':
1167 strbuf_addstr(&sb, "\\n");
1168 break;
1169 case '\t':
1170 strbuf_addstr(&sb, "\\t");
1171 break;
1172 case '"':
1173 case '\\':
1174 strbuf_addch(&sb, '\\');
1175 default:
1176 strbuf_addch(&sb, value[i]);
1177 break;
1179 strbuf_addf(&sb, "%s\n", quote);
1181 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1182 strbuf_release(&sb);
1184 return success;
1187 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1188 size_t offset_, int *found_bracket)
1190 size_t equal_offset = size, bracket_offset = size;
1191 ssize_t offset;
1193 contline:
1194 for (offset = offset_-2; offset > 0
1195 && contents[offset] != '\n'; offset--)
1196 switch (contents[offset]) {
1197 case '=': equal_offset = offset; break;
1198 case ']': bracket_offset = offset; break;
1200 if (offset > 0 && contents[offset-1] == '\\') {
1201 offset_ = offset;
1202 goto contline;
1204 if (bracket_offset < equal_offset) {
1205 *found_bracket = 1;
1206 offset = bracket_offset+1;
1207 } else
1208 offset++;
1210 return offset;
1213 int git_config_set_in_file(const char *config_filename,
1214 const char *key, const char *value)
1216 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1219 int git_config_set(const char *key, const char *value)
1221 return git_config_set_multivar(key, value, NULL, 0);
1225 * Auxiliary function to sanity-check and split the key into the section
1226 * identifier and variable name.
1228 * Returns 0 on success, -1 when there is an invalid character in the key and
1229 * -2 if there is no section name in the key.
1231 * store_key - pointer to char* which will hold a copy of the key with
1232 * lowercase section and variable name
1233 * baselen - pointer to int which will hold the length of the
1234 * section + subsection part, can be NULL
1236 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1238 int i, dot, baselen;
1239 const char *last_dot = strrchr(key, '.');
1242 * Since "key" actually contains the section name and the real
1243 * key name separated by a dot, we have to know where the dot is.
1246 if (last_dot == NULL || last_dot == key) {
1247 error("key does not contain a section: %s", key);
1248 return -CONFIG_NO_SECTION_OR_NAME;
1251 if (!last_dot[1]) {
1252 error("key does not contain variable name: %s", key);
1253 return -CONFIG_NO_SECTION_OR_NAME;
1256 baselen = last_dot - key;
1257 if (baselen_)
1258 *baselen_ = baselen;
1261 * Validate the key and while at it, lower case it for matching.
1263 *store_key = xmalloc(strlen(key) + 1);
1265 dot = 0;
1266 for (i = 0; key[i]; i++) {
1267 unsigned char c = key[i];
1268 if (c == '.')
1269 dot = 1;
1270 /* Leave the extended basename untouched.. */
1271 if (!dot || i > baselen) {
1272 if (!iskeychar(c) ||
1273 (i == baselen + 1 && !isalpha(c))) {
1274 error("invalid key: %s", key);
1275 goto out_free_ret_1;
1277 c = tolower(c);
1278 } else if (c == '\n') {
1279 error("invalid key (newline): %s", key);
1280 goto out_free_ret_1;
1282 (*store_key)[i] = c;
1284 (*store_key)[i] = 0;
1286 return 0;
1288 out_free_ret_1:
1289 free(*store_key);
1290 *store_key = NULL;
1291 return -CONFIG_INVALID_KEY;
1295 * If value==NULL, unset in (remove from) config,
1296 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1297 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1298 * else all matching key/values (regardless how many) are removed,
1299 * before the new pair is written.
1301 * Returns 0 on success.
1303 * This function does this:
1305 * - it locks the config file by creating ".git/config.lock"
1307 * - it then parses the config using store_aux() as validator to find
1308 * the position on the key/value pair to replace. If it is to be unset,
1309 * it must be found exactly once.
1311 * - the config file is mmap()ed and the part before the match (if any) is
1312 * written to the lock file, then the changed part and the rest.
1314 * - the config file is removed and the lock file rename()d to it.
1317 int git_config_set_multivar_in_file(const char *config_filename,
1318 const char *key, const char *value,
1319 const char *value_regex, int multi_replace)
1321 int fd = -1, in_fd;
1322 int ret;
1323 struct lock_file *lock = NULL;
1324 char *filename_buf = NULL;
1326 /* parse-key returns negative; flip the sign to feed exit(3) */
1327 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1328 if (ret)
1329 goto out_free;
1331 store.multi_replace = multi_replace;
1333 if (!config_filename)
1334 config_filename = filename_buf = git_pathdup("config");
1337 * The lock serves a purpose in addition to locking: the new
1338 * contents of .git/config will be written into it.
1340 lock = xcalloc(sizeof(struct lock_file), 1);
1341 fd = hold_lock_file_for_update(lock, config_filename, 0);
1342 if (fd < 0) {
1343 error("could not lock config file %s: %s", config_filename, strerror(errno));
1344 free(store.key);
1345 ret = CONFIG_NO_LOCK;
1346 goto out_free;
1350 * If .git/config does not exist yet, write a minimal version.
1352 in_fd = open(config_filename, O_RDONLY);
1353 if ( in_fd < 0 ) {
1354 free(store.key);
1356 if ( ENOENT != errno ) {
1357 error("opening %s: %s", config_filename,
1358 strerror(errno));
1359 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1360 goto out_free;
1362 /* if nothing to unset, error out */
1363 if (value == NULL) {
1364 ret = CONFIG_NOTHING_SET;
1365 goto out_free;
1368 store.key = (char *)key;
1369 if (!store_write_section(fd, key) ||
1370 !store_write_pair(fd, key, value))
1371 goto write_err_out;
1372 } else {
1373 struct stat st;
1374 char *contents;
1375 size_t contents_sz, copy_begin, copy_end;
1376 int i, new_line = 0;
1378 if (value_regex == NULL)
1379 store.value_regex = NULL;
1380 else {
1381 if (value_regex[0] == '!') {
1382 store.do_not_match = 1;
1383 value_regex++;
1384 } else
1385 store.do_not_match = 0;
1387 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1388 if (regcomp(store.value_regex, value_regex,
1389 REG_EXTENDED)) {
1390 error("invalid pattern: %s", value_regex);
1391 free(store.value_regex);
1392 ret = CONFIG_INVALID_PATTERN;
1393 goto out_free;
1397 store.offset[0] = 0;
1398 store.state = START;
1399 store.seen = 0;
1402 * After this, store.offset will contain the *end* offset
1403 * of the last match, or remain at 0 if no match was found.
1404 * As a side effect, we make sure to transform only a valid
1405 * existing config file.
1407 if (git_config_from_file(store_aux, config_filename, NULL)) {
1408 error("invalid config file %s", config_filename);
1409 free(store.key);
1410 if (store.value_regex != NULL) {
1411 regfree(store.value_regex);
1412 free(store.value_regex);
1414 ret = CONFIG_INVALID_FILE;
1415 goto out_free;
1418 free(store.key);
1419 if (store.value_regex != NULL) {
1420 regfree(store.value_regex);
1421 free(store.value_regex);
1424 /* if nothing to unset, or too many matches, error out */
1425 if ((store.seen == 0 && value == NULL) ||
1426 (store.seen > 1 && multi_replace == 0)) {
1427 ret = CONFIG_NOTHING_SET;
1428 goto out_free;
1431 fstat(in_fd, &st);
1432 contents_sz = xsize_t(st.st_size);
1433 contents = xmmap(NULL, contents_sz, PROT_READ,
1434 MAP_PRIVATE, in_fd, 0);
1435 close(in_fd);
1437 if (store.seen == 0)
1438 store.seen = 1;
1440 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1441 if (store.offset[i] == 0) {
1442 store.offset[i] = copy_end = contents_sz;
1443 } else if (store.state != KEY_SEEN) {
1444 copy_end = store.offset[i];
1445 } else
1446 copy_end = find_beginning_of_line(
1447 contents, contents_sz,
1448 store.offset[i]-2, &new_line);
1450 if (copy_end > 0 && contents[copy_end-1] != '\n')
1451 new_line = 1;
1453 /* write the first part of the config */
1454 if (copy_end > copy_begin) {
1455 if (write_in_full(fd, contents + copy_begin,
1456 copy_end - copy_begin) <
1457 copy_end - copy_begin)
1458 goto write_err_out;
1459 if (new_line &&
1460 write_str_in_full(fd, "\n") != 1)
1461 goto write_err_out;
1463 copy_begin = store.offset[i];
1466 /* write the pair (value == NULL means unset) */
1467 if (value != NULL) {
1468 if (store.state == START) {
1469 if (!store_write_section(fd, key))
1470 goto write_err_out;
1472 if (!store_write_pair(fd, key, value))
1473 goto write_err_out;
1476 /* write the rest of the config */
1477 if (copy_begin < contents_sz)
1478 if (write_in_full(fd, contents + copy_begin,
1479 contents_sz - copy_begin) <
1480 contents_sz - copy_begin)
1481 goto write_err_out;
1483 munmap(contents, contents_sz);
1486 if (commit_lock_file(lock) < 0) {
1487 error("could not commit config file %s", config_filename);
1488 ret = CONFIG_NO_WRITE;
1489 goto out_free;
1493 * lock is committed, so don't try to roll it back below.
1494 * NOTE: Since lockfile.c keeps a linked list of all created
1495 * lock_file structures, it isn't safe to free(lock). It's
1496 * better to just leave it hanging around.
1498 lock = NULL;
1499 ret = 0;
1501 out_free:
1502 if (lock)
1503 rollback_lock_file(lock);
1504 free(filename_buf);
1505 return ret;
1507 write_err_out:
1508 ret = write_error(lock->filename);
1509 goto out_free;
1513 int git_config_set_multivar(const char *key, const char *value,
1514 const char *value_regex, int multi_replace)
1516 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1517 multi_replace);
1520 static int section_name_match (const char *buf, const char *name)
1522 int i = 0, j = 0, dot = 0;
1523 if (buf[i] != '[')
1524 return 0;
1525 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1526 if (!dot && isspace(buf[i])) {
1527 dot = 1;
1528 if (name[j++] != '.')
1529 break;
1530 for (i++; isspace(buf[i]); i++)
1531 ; /* do nothing */
1532 if (buf[i] != '"')
1533 break;
1534 continue;
1536 if (buf[i] == '\\' && dot)
1537 i++;
1538 else if (buf[i] == '"' && dot) {
1539 for (i++; isspace(buf[i]); i++)
1540 ; /* do_nothing */
1541 break;
1543 if (buf[i] != name[j++])
1544 break;
1546 if (buf[i] == ']' && name[j] == 0) {
1548 * We match, now just find the right length offset by
1549 * gobbling up any whitespace after it, as well
1551 i++;
1552 for (; buf[i] && isspace(buf[i]); i++)
1553 ; /* do nothing */
1554 return i;
1556 return 0;
1559 static int section_name_is_ok(const char *name)
1561 /* Empty section names are bogus. */
1562 if (!*name)
1563 return 0;
1566 * Before a dot, we must be alphanumeric or dash. After the first dot,
1567 * anything goes, so we can stop checking.
1569 for (; *name && *name != '.'; name++)
1570 if (*name != '-' && !isalnum(*name))
1571 return 0;
1572 return 1;
1575 /* if new_name == NULL, the section is removed instead */
1576 int git_config_rename_section_in_file(const char *config_filename,
1577 const char *old_name, const char *new_name)
1579 int ret = 0, remove = 0;
1580 char *filename_buf = NULL;
1581 struct lock_file *lock;
1582 int out_fd;
1583 char buf[1024];
1584 FILE *config_file;
1586 if (new_name && !section_name_is_ok(new_name)) {
1587 ret = error("invalid section name: %s", new_name);
1588 goto out;
1591 if (!config_filename)
1592 config_filename = filename_buf = git_pathdup("config");
1594 lock = xcalloc(sizeof(struct lock_file), 1);
1595 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1596 if (out_fd < 0) {
1597 ret = error("could not lock config file %s", config_filename);
1598 goto out;
1601 if (!(config_file = fopen(config_filename, "rb"))) {
1602 /* no config file means nothing to rename, no error */
1603 goto unlock_and_out;
1606 while (fgets(buf, sizeof(buf), config_file)) {
1607 int i;
1608 int length;
1609 char *output = buf;
1610 for (i = 0; buf[i] && isspace(buf[i]); i++)
1611 ; /* do nothing */
1612 if (buf[i] == '[') {
1613 /* it's a section */
1614 int offset = section_name_match(&buf[i], old_name);
1615 if (offset > 0) {
1616 ret++;
1617 if (new_name == NULL) {
1618 remove = 1;
1619 continue;
1621 store.baselen = strlen(new_name);
1622 if (!store_write_section(out_fd, new_name)) {
1623 ret = write_error(lock->filename);
1624 goto out;
1627 * We wrote out the new section, with
1628 * a newline, now skip the old
1629 * section's length
1631 output += offset + i;
1632 if (strlen(output) > 0) {
1634 * More content means there's
1635 * a declaration to put on the
1636 * next line; indent with a
1637 * tab
1639 output -= 1;
1640 output[0] = '\t';
1643 remove = 0;
1645 if (remove)
1646 continue;
1647 length = strlen(output);
1648 if (write_in_full(out_fd, output, length) != length) {
1649 ret = write_error(lock->filename);
1650 goto out;
1653 fclose(config_file);
1654 unlock_and_out:
1655 if (commit_lock_file(lock) < 0)
1656 ret = error("could not commit config file %s", config_filename);
1657 out:
1658 free(filename_buf);
1659 return ret;
1662 int git_config_rename_section(const char *old_name, const char *new_name)
1664 return git_config_rename_section_in_file(NULL, old_name, new_name);
1668 * Call this to report error for your variable that should not
1669 * get a boolean value (i.e. "[my] var" means "true").
1671 #undef config_error_nonbool
1672 int config_error_nonbool(const char *var)
1674 return error("Missing value for '%s'", var);