config: add include directive
[git/jrn.git] / config.c
blobad0390819d2701d6153adf9db2947ee4908742ce
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 #define MAXNAME (256)
15 typedef struct config_file {
16 struct config_file *prev;
17 FILE *f;
18 const char *name;
19 int linenr;
20 int eof;
21 struct strbuf value;
22 char var[MAXNAME];
23 } config_file;
25 static config_file *cf;
27 static int zlib_compression_seen;
29 #define MAX_INCLUDE_DEPTH 10
30 static const char include_depth_advice[] =
31 "exceeded maximum include depth (%d) while including\n"
32 " %s\n"
33 "from\n"
34 " %s\n"
35 "Do you have circular includes?";
36 static int handle_path_include(const char *path, struct config_include_data *inc)
38 int ret = 0;
39 struct strbuf buf = STRBUF_INIT;
42 * Use an absolute path as-is, but interpret relative paths
43 * based on the including config file.
45 if (!is_absolute_path(path)) {
46 char *slash;
48 if (!cf || !cf->name)
49 return error("relative config includes must come from files");
51 slash = find_last_dir_sep(cf->name);
52 if (slash)
53 strbuf_add(&buf, cf->name, slash - cf->name + 1);
54 strbuf_addstr(&buf, path);
55 path = buf.buf;
58 if (!access(path, R_OK)) {
59 if (++inc->depth > MAX_INCLUDE_DEPTH)
60 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
61 cf && cf->name ? cf->name : "the command line");
62 ret = git_config_from_file(git_config_include, path, inc);
63 inc->depth--;
65 strbuf_release(&buf);
66 return ret;
69 int git_config_include(const char *var, const char *value, void *data)
71 struct config_include_data *inc = data;
72 const char *type;
73 int ret;
76 * Pass along all values, including "include" directives; this makes it
77 * possible to query information on the includes themselves.
79 ret = inc->fn(var, value, inc->data);
80 if (ret < 0)
81 return ret;
83 type = skip_prefix(var, "include.");
84 if (!type)
85 return ret;
87 if (!strcmp(type, "path"))
88 ret = handle_path_include(value, inc);
89 return ret;
92 static void lowercase(char *p)
94 for (; *p; p++)
95 *p = tolower(*p);
98 void git_config_push_parameter(const char *text)
100 struct strbuf env = STRBUF_INIT;
101 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
102 if (old) {
103 strbuf_addstr(&env, old);
104 strbuf_addch(&env, ' ');
106 sq_quote_buf(&env, text);
107 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
108 strbuf_release(&env);
111 int git_config_parse_parameter(const char *text,
112 config_fn_t fn, void *data)
114 struct strbuf **pair;
115 pair = strbuf_split_str(text, '=', 2);
116 if (!pair[0])
117 return error("bogus config parameter: %s", text);
118 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
119 strbuf_setlen(pair[0], pair[0]->len - 1);
120 strbuf_trim(pair[0]);
121 if (!pair[0]->len) {
122 strbuf_list_free(pair);
123 return error("bogus config parameter: %s", text);
125 lowercase(pair[0]->buf);
126 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
127 strbuf_list_free(pair);
128 return -1;
130 strbuf_list_free(pair);
131 return 0;
134 int git_config_from_parameters(config_fn_t fn, void *data)
136 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
137 char *envw;
138 const char **argv = NULL;
139 int nr = 0, alloc = 0;
140 int i;
142 if (!env)
143 return 0;
144 /* sq_dequote will write over it */
145 envw = xstrdup(env);
147 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
148 free(envw);
149 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
152 for (i = 0; i < nr; i++) {
153 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
154 free(argv);
155 free(envw);
156 return -1;
160 free(argv);
161 free(envw);
162 return nr > 0;
165 static int get_next_char(void)
167 int c;
168 FILE *f;
170 c = '\n';
171 if (cf && ((f = cf->f) != NULL)) {
172 c = fgetc(f);
173 if (c == '\r') {
174 /* DOS like systems */
175 c = fgetc(f);
176 if (c != '\n') {
177 ungetc(c, f);
178 c = '\r';
181 if (c == '\n')
182 cf->linenr++;
183 if (c == EOF) {
184 cf->eof = 1;
185 c = '\n';
188 return c;
191 static char *parse_value(void)
193 int quote = 0, comment = 0, space = 0;
195 strbuf_reset(&cf->value);
196 for (;;) {
197 int c = get_next_char();
198 if (c == '\n') {
199 if (quote)
200 return NULL;
201 return cf->value.buf;
203 if (comment)
204 continue;
205 if (isspace(c) && !quote) {
206 if (cf->value.len)
207 space++;
208 continue;
210 if (!quote) {
211 if (c == ';' || c == '#') {
212 comment = 1;
213 continue;
216 for (; space; space--)
217 strbuf_addch(&cf->value, ' ');
218 if (c == '\\') {
219 c = get_next_char();
220 switch (c) {
221 case '\n':
222 continue;
223 case 't':
224 c = '\t';
225 break;
226 case 'b':
227 c = '\b';
228 break;
229 case 'n':
230 c = '\n';
231 break;
232 /* Some characters escape as themselves */
233 case '\\': case '"':
234 break;
235 /* Reject unknown escape sequences */
236 default:
237 return NULL;
239 strbuf_addch(&cf->value, c);
240 continue;
242 if (c == '"') {
243 quote = 1-quote;
244 continue;
246 strbuf_addch(&cf->value, c);
250 static inline int iskeychar(int c)
252 return isalnum(c) || c == '-';
255 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
257 int c;
258 char *value;
260 /* Get the full name */
261 for (;;) {
262 c = get_next_char();
263 if (cf->eof)
264 break;
265 if (!iskeychar(c))
266 break;
267 name[len++] = tolower(c);
268 if (len >= MAXNAME)
269 return -1;
271 name[len] = 0;
272 while (c == ' ' || c == '\t')
273 c = get_next_char();
275 value = NULL;
276 if (c != '\n') {
277 if (c != '=')
278 return -1;
279 value = parse_value();
280 if (!value)
281 return -1;
283 return fn(name, value, data);
286 static int get_extended_base_var(char *name, int baselen, int c)
288 do {
289 if (c == '\n')
290 return -1;
291 c = get_next_char();
292 } while (isspace(c));
294 /* We require the format to be '[base "extension"]' */
295 if (c != '"')
296 return -1;
297 name[baselen++] = '.';
299 for (;;) {
300 int c = get_next_char();
301 if (c == '\n')
302 return -1;
303 if (c == '"')
304 break;
305 if (c == '\\') {
306 c = get_next_char();
307 if (c == '\n')
308 return -1;
310 name[baselen++] = c;
311 if (baselen > MAXNAME / 2)
312 return -1;
315 /* Final ']' */
316 if (get_next_char() != ']')
317 return -1;
318 return baselen;
321 static int get_base_var(char *name)
323 int baselen = 0;
325 for (;;) {
326 int c = get_next_char();
327 if (cf->eof)
328 return -1;
329 if (c == ']')
330 return baselen;
331 if (isspace(c))
332 return get_extended_base_var(name, baselen, c);
333 if (!iskeychar(c) && c != '.')
334 return -1;
335 if (baselen > MAXNAME / 2)
336 return -1;
337 name[baselen++] = tolower(c);
341 static int git_parse_file(config_fn_t fn, void *data)
343 int comment = 0;
344 int baselen = 0;
345 char *var = cf->var;
347 /* U+FEFF Byte Order Mark in UTF8 */
348 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
349 const unsigned char *bomptr = utf8_bom;
351 for (;;) {
352 int c = get_next_char();
353 if (bomptr && *bomptr) {
354 /* We are at the file beginning; skip UTF8-encoded BOM
355 * if present. Sane editors won't put this in on their
356 * own, but e.g. Windows Notepad will do it happily. */
357 if ((unsigned char) c == *bomptr) {
358 bomptr++;
359 continue;
360 } else {
361 /* Do not tolerate partial BOM. */
362 if (bomptr != utf8_bom)
363 break;
364 /* No BOM at file beginning. Cool. */
365 bomptr = NULL;
368 if (c == '\n') {
369 if (cf->eof)
370 return 0;
371 comment = 0;
372 continue;
374 if (comment || isspace(c))
375 continue;
376 if (c == '#' || c == ';') {
377 comment = 1;
378 continue;
380 if (c == '[') {
381 baselen = get_base_var(var);
382 if (baselen <= 0)
383 break;
384 var[baselen++] = '.';
385 var[baselen] = 0;
386 continue;
388 if (!isalpha(c))
389 break;
390 var[baselen] = tolower(c);
391 if (get_value(fn, data, var, baselen+1) < 0)
392 break;
394 die("bad config file line %d in %s", cf->linenr, cf->name);
397 static int parse_unit_factor(const char *end, uintmax_t *val)
399 if (!*end)
400 return 1;
401 else if (!strcasecmp(end, "k")) {
402 *val *= 1024;
403 return 1;
405 else if (!strcasecmp(end, "m")) {
406 *val *= 1024 * 1024;
407 return 1;
409 else if (!strcasecmp(end, "g")) {
410 *val *= 1024 * 1024 * 1024;
411 return 1;
413 return 0;
416 static int git_parse_long(const char *value, long *ret)
418 if (value && *value) {
419 char *end;
420 intmax_t val;
421 uintmax_t uval;
422 uintmax_t factor = 1;
424 errno = 0;
425 val = strtoimax(value, &end, 0);
426 if (errno == ERANGE)
427 return 0;
428 if (!parse_unit_factor(end, &factor))
429 return 0;
430 uval = abs(val);
431 uval *= factor;
432 if ((uval > maximum_signed_value_of_type(long)) ||
433 (abs(val) > uval))
434 return 0;
435 val *= factor;
436 *ret = val;
437 return 1;
439 return 0;
442 int git_parse_ulong(const char *value, unsigned long *ret)
444 if (value && *value) {
445 char *end;
446 uintmax_t val;
447 uintmax_t oldval;
449 errno = 0;
450 val = strtoumax(value, &end, 0);
451 if (errno == ERANGE)
452 return 0;
453 oldval = val;
454 if (!parse_unit_factor(end, &val))
455 return 0;
456 if ((val > maximum_unsigned_value_of_type(long)) ||
457 (oldval > val))
458 return 0;
459 *ret = val;
460 return 1;
462 return 0;
465 static void die_bad_config(const char *name)
467 if (cf && cf->name)
468 die("bad config value for '%s' in %s", name, cf->name);
469 die("bad config value for '%s'", name);
472 int git_config_int(const char *name, const char *value)
474 long ret = 0;
475 if (!git_parse_long(value, &ret))
476 die_bad_config(name);
477 return ret;
480 unsigned long git_config_ulong(const char *name, const char *value)
482 unsigned long ret;
483 if (!git_parse_ulong(value, &ret))
484 die_bad_config(name);
485 return ret;
488 static int git_config_maybe_bool_text(const char *name, const char *value)
490 if (!value)
491 return 1;
492 if (!*value)
493 return 0;
494 if (!strcasecmp(value, "true")
495 || !strcasecmp(value, "yes")
496 || !strcasecmp(value, "on"))
497 return 1;
498 if (!strcasecmp(value, "false")
499 || !strcasecmp(value, "no")
500 || !strcasecmp(value, "off"))
501 return 0;
502 return -1;
505 int git_config_maybe_bool(const char *name, const char *value)
507 long v = git_config_maybe_bool_text(name, value);
508 if (0 <= v)
509 return v;
510 if (git_parse_long(value, &v))
511 return !!v;
512 return -1;
515 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
517 int v = git_config_maybe_bool_text(name, value);
518 if (0 <= v) {
519 *is_bool = 1;
520 return v;
522 *is_bool = 0;
523 return git_config_int(name, value);
526 int git_config_bool(const char *name, const char *value)
528 int discard;
529 return !!git_config_bool_or_int(name, value, &discard);
532 int git_config_string(const char **dest, const char *var, const char *value)
534 if (!value)
535 return config_error_nonbool(var);
536 *dest = xstrdup(value);
537 return 0;
540 int git_config_pathname(const char **dest, const char *var, const char *value)
542 if (!value)
543 return config_error_nonbool(var);
544 *dest = expand_user_path(value);
545 if (!*dest)
546 die("Failed to expand user dir in: '%s'", value);
547 return 0;
550 static int git_default_core_config(const char *var, const char *value)
552 /* This needs a better name */
553 if (!strcmp(var, "core.filemode")) {
554 trust_executable_bit = git_config_bool(var, value);
555 return 0;
557 if (!strcmp(var, "core.trustctime")) {
558 trust_ctime = git_config_bool(var, value);
559 return 0;
562 if (!strcmp(var, "core.quotepath")) {
563 quote_path_fully = git_config_bool(var, value);
564 return 0;
567 if (!strcmp(var, "core.symlinks")) {
568 has_symlinks = git_config_bool(var, value);
569 return 0;
572 if (!strcmp(var, "core.ignorecase")) {
573 ignore_case = git_config_bool(var, value);
574 return 0;
577 if (!strcmp(var, "core.attributesfile"))
578 return git_config_pathname(&git_attributes_file, var, value);
580 if (!strcmp(var, "core.bare")) {
581 is_bare_repository_cfg = git_config_bool(var, value);
582 return 0;
585 if (!strcmp(var, "core.ignorestat")) {
586 assume_unchanged = git_config_bool(var, value);
587 return 0;
590 if (!strcmp(var, "core.prefersymlinkrefs")) {
591 prefer_symlink_refs = git_config_bool(var, value);
592 return 0;
595 if (!strcmp(var, "core.logallrefupdates")) {
596 log_all_ref_updates = git_config_bool(var, value);
597 return 0;
600 if (!strcmp(var, "core.warnambiguousrefs")) {
601 warn_ambiguous_refs = git_config_bool(var, value);
602 return 0;
605 if (!strcmp(var, "core.abbrev")) {
606 int abbrev = git_config_int(var, value);
607 if (abbrev < minimum_abbrev || abbrev > 40)
608 return -1;
609 default_abbrev = abbrev;
610 return 0;
613 if (!strcmp(var, "core.loosecompression")) {
614 int level = git_config_int(var, value);
615 if (level == -1)
616 level = Z_DEFAULT_COMPRESSION;
617 else if (level < 0 || level > Z_BEST_COMPRESSION)
618 die("bad zlib compression level %d", level);
619 zlib_compression_level = level;
620 zlib_compression_seen = 1;
621 return 0;
624 if (!strcmp(var, "core.compression")) {
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 core_compression_level = level;
631 core_compression_seen = 1;
632 if (!zlib_compression_seen)
633 zlib_compression_level = level;
634 return 0;
637 if (!strcmp(var, "core.packedgitwindowsize")) {
638 int pgsz_x2 = getpagesize() * 2;
639 packed_git_window_size = git_config_ulong(var, value);
641 /* This value must be multiple of (pagesize * 2) */
642 packed_git_window_size /= pgsz_x2;
643 if (packed_git_window_size < 1)
644 packed_git_window_size = 1;
645 packed_git_window_size *= pgsz_x2;
646 return 0;
649 if (!strcmp(var, "core.bigfilethreshold")) {
650 big_file_threshold = git_config_ulong(var, value);
651 return 0;
654 if (!strcmp(var, "core.packedgitlimit")) {
655 packed_git_limit = git_config_ulong(var, value);
656 return 0;
659 if (!strcmp(var, "core.deltabasecachelimit")) {
660 delta_base_cache_limit = git_config_ulong(var, value);
661 return 0;
664 if (!strcmp(var, "core.logpackaccess"))
665 return git_config_string(&log_pack_access, var, value);
667 if (!strcmp(var, "core.autocrlf")) {
668 if (value && !strcasecmp(value, "input")) {
669 if (core_eol == EOL_CRLF)
670 return error("core.autocrlf=input conflicts with core.eol=crlf");
671 auto_crlf = AUTO_CRLF_INPUT;
672 return 0;
674 auto_crlf = git_config_bool(var, value);
675 return 0;
678 if (!strcmp(var, "core.safecrlf")) {
679 if (value && !strcasecmp(value, "warn")) {
680 safe_crlf = SAFE_CRLF_WARN;
681 return 0;
683 safe_crlf = git_config_bool(var, value);
684 return 0;
687 if (!strcmp(var, "core.eol")) {
688 if (value && !strcasecmp(value, "lf"))
689 core_eol = EOL_LF;
690 else if (value && !strcasecmp(value, "crlf"))
691 core_eol = EOL_CRLF;
692 else if (value && !strcasecmp(value, "native"))
693 core_eol = EOL_NATIVE;
694 else
695 core_eol = EOL_UNSET;
696 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
697 return error("core.autocrlf=input conflicts with core.eol=crlf");
698 return 0;
701 if (!strcmp(var, "core.notesref")) {
702 notes_ref_name = xstrdup(value);
703 return 0;
706 if (!strcmp(var, "core.pager"))
707 return git_config_string(&pager_program, var, value);
709 if (!strcmp(var, "core.editor"))
710 return git_config_string(&editor_program, var, value);
712 if (!strcmp(var, "core.askpass"))
713 return git_config_string(&askpass_program, var, value);
715 if (!strcmp(var, "core.excludesfile"))
716 return git_config_pathname(&excludes_file, var, value);
718 if (!strcmp(var, "core.whitespace")) {
719 if (!value)
720 return config_error_nonbool(var);
721 whitespace_rule_cfg = parse_whitespace_rule(value);
722 return 0;
725 if (!strcmp(var, "core.fsyncobjectfiles")) {
726 fsync_object_files = git_config_bool(var, value);
727 return 0;
730 if (!strcmp(var, "core.preloadindex")) {
731 core_preload_index = git_config_bool(var, value);
732 return 0;
735 if (!strcmp(var, "core.createobject")) {
736 if (!strcmp(value, "rename"))
737 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
738 else if (!strcmp(value, "link"))
739 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
740 else
741 die("Invalid mode for object creation: %s", value);
742 return 0;
745 if (!strcmp(var, "core.sparsecheckout")) {
746 core_apply_sparse_checkout = git_config_bool(var, value);
747 return 0;
750 /* Add other config variables here and to Documentation/config.txt. */
751 return 0;
754 static int git_default_user_config(const char *var, const char *value)
756 if (!strcmp(var, "user.name")) {
757 if (!value)
758 return config_error_nonbool(var);
759 strlcpy(git_default_name, value, sizeof(git_default_name));
760 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
761 return 0;
764 if (!strcmp(var, "user.email")) {
765 if (!value)
766 return config_error_nonbool(var);
767 strlcpy(git_default_email, value, sizeof(git_default_email));
768 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
769 return 0;
772 /* Add other config variables here and to Documentation/config.txt. */
773 return 0;
776 static int git_default_i18n_config(const char *var, const char *value)
778 if (!strcmp(var, "i18n.commitencoding"))
779 return git_config_string(&git_commit_encoding, var, value);
781 if (!strcmp(var, "i18n.logoutputencoding"))
782 return git_config_string(&git_log_output_encoding, var, value);
784 /* Add other config variables here and to Documentation/config.txt. */
785 return 0;
788 static int git_default_branch_config(const char *var, const char *value)
790 if (!strcmp(var, "branch.autosetupmerge")) {
791 if (value && !strcasecmp(value, "always")) {
792 git_branch_track = BRANCH_TRACK_ALWAYS;
793 return 0;
795 git_branch_track = git_config_bool(var, value);
796 return 0;
798 if (!strcmp(var, "branch.autosetuprebase")) {
799 if (!value)
800 return config_error_nonbool(var);
801 else if (!strcmp(value, "never"))
802 autorebase = AUTOREBASE_NEVER;
803 else if (!strcmp(value, "local"))
804 autorebase = AUTOREBASE_LOCAL;
805 else if (!strcmp(value, "remote"))
806 autorebase = AUTOREBASE_REMOTE;
807 else if (!strcmp(value, "always"))
808 autorebase = AUTOREBASE_ALWAYS;
809 else
810 return error("Malformed value for %s", var);
811 return 0;
814 /* Add other config variables here and to Documentation/config.txt. */
815 return 0;
818 static int git_default_push_config(const char *var, const char *value)
820 if (!strcmp(var, "push.default")) {
821 if (!value)
822 return config_error_nonbool(var);
823 else if (!strcmp(value, "nothing"))
824 push_default = PUSH_DEFAULT_NOTHING;
825 else if (!strcmp(value, "matching"))
826 push_default = PUSH_DEFAULT_MATCHING;
827 else if (!strcmp(value, "upstream"))
828 push_default = PUSH_DEFAULT_UPSTREAM;
829 else if (!strcmp(value, "tracking")) /* deprecated */
830 push_default = PUSH_DEFAULT_UPSTREAM;
831 else if (!strcmp(value, "current"))
832 push_default = PUSH_DEFAULT_CURRENT;
833 else {
834 error("Malformed value for %s: %s", var, value);
835 return error("Must be one of nothing, matching, "
836 "tracking or current.");
838 return 0;
841 /* Add other config variables here and to Documentation/config.txt. */
842 return 0;
845 static int git_default_mailmap_config(const char *var, const char *value)
847 if (!strcmp(var, "mailmap.file"))
848 return git_config_string(&git_mailmap_file, var, value);
850 /* Add other config variables here and to Documentation/config.txt. */
851 return 0;
854 int git_default_config(const char *var, const char *value, void *dummy)
856 if (!prefixcmp(var, "core."))
857 return git_default_core_config(var, value);
859 if (!prefixcmp(var, "user."))
860 return git_default_user_config(var, value);
862 if (!prefixcmp(var, "i18n."))
863 return git_default_i18n_config(var, value);
865 if (!prefixcmp(var, "branch."))
866 return git_default_branch_config(var, value);
868 if (!prefixcmp(var, "push."))
869 return git_default_push_config(var, value);
871 if (!prefixcmp(var, "mailmap."))
872 return git_default_mailmap_config(var, value);
874 if (!prefixcmp(var, "advice."))
875 return git_default_advice_config(var, value);
877 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
878 pager_use_color = git_config_bool(var,value);
879 return 0;
882 if (!strcmp(var, "pack.packsizelimit")) {
883 pack_size_limit_cfg = git_config_ulong(var, value);
884 return 0;
886 /* Add other config variables here and to Documentation/config.txt. */
887 return 0;
890 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
892 int ret;
893 FILE *f = fopen(filename, "r");
895 ret = -1;
896 if (f) {
897 config_file top;
899 /* push config-file parsing state stack */
900 top.prev = cf;
901 top.f = f;
902 top.name = filename;
903 top.linenr = 1;
904 top.eof = 0;
905 strbuf_init(&top.value, 1024);
906 cf = &top;
908 ret = git_parse_file(fn, data);
910 /* pop config-file parsing state stack */
911 strbuf_release(&top.value);
912 cf = top.prev;
914 fclose(f);
916 return ret;
919 const char *git_etc_gitconfig(void)
921 static const char *system_wide;
922 if (!system_wide)
923 system_wide = system_path(ETC_GITCONFIG);
924 return system_wide;
927 int git_env_bool(const char *k, int def)
929 const char *v = getenv(k);
930 return v ? git_config_bool(k, v) : def;
933 int git_config_system(void)
935 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
938 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
940 int ret = 0, found = 0;
941 const char *home = NULL;
943 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
944 ret += git_config_from_file(fn, git_etc_gitconfig(),
945 data);
946 found += 1;
949 home = getenv("HOME");
950 if (home) {
951 char buf[PATH_MAX];
952 char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
953 if (!access(user_config, R_OK)) {
954 ret += git_config_from_file(fn, user_config, data);
955 found += 1;
959 if (repo_config && !access(repo_config, R_OK)) {
960 ret += git_config_from_file(fn, repo_config, data);
961 found += 1;
964 switch (git_config_from_parameters(fn, data)) {
965 case -1: /* error */
966 die("unable to parse command-line config");
967 break;
968 case 0: /* found nothing */
969 break;
970 default: /* found at least one item */
971 found++;
972 break;
975 return ret == 0 ? found : ret;
978 int git_config_with_options(config_fn_t fn, void *data,
979 const char *filename, int respect_includes)
981 char *repo_config = NULL;
982 int ret;
983 struct config_include_data inc = CONFIG_INCLUDE_INIT;
985 if (respect_includes) {
986 inc.fn = fn;
987 inc.data = data;
988 fn = git_config_include;
989 data = &inc;
993 * If we have a specific filename, use it. Otherwise, follow the
994 * regular lookup sequence.
996 if (filename)
997 return git_config_from_file(fn, filename, data);
999 repo_config = git_pathdup("config");
1000 ret = git_config_early(fn, data, repo_config);
1001 if (repo_config)
1002 free(repo_config);
1003 return ret;
1006 int git_config(config_fn_t fn, void *data)
1008 return git_config_with_options(fn, data, NULL, 1);
1012 * Find all the stuff for git_config_set() below.
1015 #define MAX_MATCHES 512
1017 static struct {
1018 int baselen;
1019 char *key;
1020 int do_not_match;
1021 regex_t *value_regex;
1022 int multi_replace;
1023 size_t offset[MAX_MATCHES];
1024 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1025 int seen;
1026 } store;
1028 static int matches(const char *key, const char *value)
1030 return !strcmp(key, store.key) &&
1031 (store.value_regex == NULL ||
1032 (store.do_not_match ^
1033 !regexec(store.value_regex, value, 0, NULL, 0)));
1036 static int store_aux(const char *key, const char *value, void *cb)
1038 const char *ep;
1039 size_t section_len;
1040 FILE *f = cf->f;
1042 switch (store.state) {
1043 case KEY_SEEN:
1044 if (matches(key, value)) {
1045 if (store.seen == 1 && store.multi_replace == 0) {
1046 warning("%s has multiple values", key);
1047 } else if (store.seen >= MAX_MATCHES) {
1048 error("too many matches for %s", key);
1049 return 1;
1052 store.offset[store.seen] = ftell(f);
1053 store.seen++;
1055 break;
1056 case SECTION_SEEN:
1058 * What we are looking for is in store.key (both
1059 * section and var), and its section part is baselen
1060 * long. We found key (again, both section and var).
1061 * We would want to know if this key is in the same
1062 * section as what we are looking for. We already
1063 * know we are in the same section as what should
1064 * hold store.key.
1066 ep = strrchr(key, '.');
1067 section_len = ep - key;
1069 if ((section_len != store.baselen) ||
1070 memcmp(key, store.key, section_len+1)) {
1071 store.state = SECTION_END_SEEN;
1072 break;
1076 * Do not increment matches: this is no match, but we
1077 * just made sure we are in the desired section.
1079 store.offset[store.seen] = ftell(f);
1080 /* fallthru */
1081 case SECTION_END_SEEN:
1082 case START:
1083 if (matches(key, value)) {
1084 store.offset[store.seen] = ftell(f);
1085 store.state = KEY_SEEN;
1086 store.seen++;
1087 } else {
1088 if (strrchr(key, '.') - key == store.baselen &&
1089 !strncmp(key, store.key, store.baselen)) {
1090 store.state = SECTION_SEEN;
1091 store.offset[store.seen] = ftell(f);
1095 return 0;
1098 static int write_error(const char *filename)
1100 error("failed to write new configuration file %s", filename);
1102 /* Same error code as "failed to rename". */
1103 return 4;
1106 static int store_write_section(int fd, const char *key)
1108 const char *dot;
1109 int i, success;
1110 struct strbuf sb = STRBUF_INIT;
1112 dot = memchr(key, '.', store.baselen);
1113 if (dot) {
1114 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1115 for (i = dot - key + 1; i < store.baselen; i++) {
1116 if (key[i] == '"' || key[i] == '\\')
1117 strbuf_addch(&sb, '\\');
1118 strbuf_addch(&sb, key[i]);
1120 strbuf_addstr(&sb, "\"]\n");
1121 } else {
1122 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1125 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1126 strbuf_release(&sb);
1128 return success;
1131 static int store_write_pair(int fd, const char *key, const char *value)
1133 int i, success;
1134 int length = strlen(key + store.baselen + 1);
1135 const char *quote = "";
1136 struct strbuf sb = STRBUF_INIT;
1139 * Check to see if the value needs to be surrounded with a dq pair.
1140 * Note that problematic characters are always backslash-quoted; this
1141 * check is about not losing leading or trailing SP and strings that
1142 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1143 * configuration parser.
1145 if (value[0] == ' ')
1146 quote = "\"";
1147 for (i = 0; value[i]; i++)
1148 if (value[i] == ';' || value[i] == '#')
1149 quote = "\"";
1150 if (i && value[i - 1] == ' ')
1151 quote = "\"";
1153 strbuf_addf(&sb, "\t%.*s = %s",
1154 length, key + store.baselen + 1, quote);
1156 for (i = 0; value[i]; i++)
1157 switch (value[i]) {
1158 case '\n':
1159 strbuf_addstr(&sb, "\\n");
1160 break;
1161 case '\t':
1162 strbuf_addstr(&sb, "\\t");
1163 break;
1164 case '"':
1165 case '\\':
1166 strbuf_addch(&sb, '\\');
1167 default:
1168 strbuf_addch(&sb, value[i]);
1169 break;
1171 strbuf_addf(&sb, "%s\n", quote);
1173 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1174 strbuf_release(&sb);
1176 return success;
1179 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1180 size_t offset_, int *found_bracket)
1182 size_t equal_offset = size, bracket_offset = size;
1183 ssize_t offset;
1185 contline:
1186 for (offset = offset_-2; offset > 0
1187 && contents[offset] != '\n'; offset--)
1188 switch (contents[offset]) {
1189 case '=': equal_offset = offset; break;
1190 case ']': bracket_offset = offset; break;
1192 if (offset > 0 && contents[offset-1] == '\\') {
1193 offset_ = offset;
1194 goto contline;
1196 if (bracket_offset < equal_offset) {
1197 *found_bracket = 1;
1198 offset = bracket_offset+1;
1199 } else
1200 offset++;
1202 return offset;
1205 int git_config_set_in_file(const char *config_filename,
1206 const char *key, const char *value)
1208 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1211 int git_config_set(const char *key, const char *value)
1213 return git_config_set_multivar(key, value, NULL, 0);
1217 * Auxiliary function to sanity-check and split the key into the section
1218 * identifier and variable name.
1220 * Returns 0 on success, -1 when there is an invalid character in the key and
1221 * -2 if there is no section name in the key.
1223 * store_key - pointer to char* which will hold a copy of the key with
1224 * lowercase section and variable name
1225 * baselen - pointer to int which will hold the length of the
1226 * section + subsection part, can be NULL
1228 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1230 int i, dot, baselen;
1231 const char *last_dot = strrchr(key, '.');
1234 * Since "key" actually contains the section name and the real
1235 * key name separated by a dot, we have to know where the dot is.
1238 if (last_dot == NULL || last_dot == key) {
1239 error("key does not contain a section: %s", key);
1240 return -CONFIG_NO_SECTION_OR_NAME;
1243 if (!last_dot[1]) {
1244 error("key does not contain variable name: %s", key);
1245 return -CONFIG_NO_SECTION_OR_NAME;
1248 baselen = last_dot - key;
1249 if (baselen_)
1250 *baselen_ = baselen;
1253 * Validate the key and while at it, lower case it for matching.
1255 *store_key = xmalloc(strlen(key) + 1);
1257 dot = 0;
1258 for (i = 0; key[i]; i++) {
1259 unsigned char c = key[i];
1260 if (c == '.')
1261 dot = 1;
1262 /* Leave the extended basename untouched.. */
1263 if (!dot || i > baselen) {
1264 if (!iskeychar(c) ||
1265 (i == baselen + 1 && !isalpha(c))) {
1266 error("invalid key: %s", key);
1267 goto out_free_ret_1;
1269 c = tolower(c);
1270 } else if (c == '\n') {
1271 error("invalid key (newline): %s", key);
1272 goto out_free_ret_1;
1274 (*store_key)[i] = c;
1276 (*store_key)[i] = 0;
1278 return 0;
1280 out_free_ret_1:
1281 free(*store_key);
1282 return -CONFIG_INVALID_KEY;
1286 * If value==NULL, unset in (remove from) config,
1287 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1288 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1289 * else all matching key/values (regardless how many) are removed,
1290 * before the new pair is written.
1292 * Returns 0 on success.
1294 * This function does this:
1296 * - it locks the config file by creating ".git/config.lock"
1298 * - it then parses the config using store_aux() as validator to find
1299 * the position on the key/value pair to replace. If it is to be unset,
1300 * it must be found exactly once.
1302 * - the config file is mmap()ed and the part before the match (if any) is
1303 * written to the lock file, then the changed part and the rest.
1305 * - the config file is removed and the lock file rename()d to it.
1308 int git_config_set_multivar_in_file(const char *config_filename,
1309 const char *key, const char *value,
1310 const char *value_regex, int multi_replace)
1312 int fd = -1, in_fd;
1313 int ret;
1314 struct lock_file *lock = NULL;
1315 char *filename_buf = NULL;
1317 /* parse-key returns negative; flip the sign to feed exit(3) */
1318 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1319 if (ret)
1320 goto out_free;
1322 store.multi_replace = multi_replace;
1324 if (!config_filename)
1325 config_filename = filename_buf = git_pathdup("config");
1328 * The lock serves a purpose in addition to locking: the new
1329 * contents of .git/config will be written into it.
1331 lock = xcalloc(sizeof(struct lock_file), 1);
1332 fd = hold_lock_file_for_update(lock, config_filename, 0);
1333 if (fd < 0) {
1334 error("could not lock config file %s: %s", config_filename, strerror(errno));
1335 free(store.key);
1336 ret = CONFIG_NO_LOCK;
1337 goto out_free;
1341 * If .git/config does not exist yet, write a minimal version.
1343 in_fd = open(config_filename, O_RDONLY);
1344 if ( in_fd < 0 ) {
1345 free(store.key);
1347 if ( ENOENT != errno ) {
1348 error("opening %s: %s", config_filename,
1349 strerror(errno));
1350 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1351 goto out_free;
1353 /* if nothing to unset, error out */
1354 if (value == NULL) {
1355 ret = CONFIG_NOTHING_SET;
1356 goto out_free;
1359 store.key = (char *)key;
1360 if (!store_write_section(fd, key) ||
1361 !store_write_pair(fd, key, value))
1362 goto write_err_out;
1363 } else {
1364 struct stat st;
1365 char *contents;
1366 size_t contents_sz, copy_begin, copy_end;
1367 int i, new_line = 0;
1369 if (value_regex == NULL)
1370 store.value_regex = NULL;
1371 else {
1372 if (value_regex[0] == '!') {
1373 store.do_not_match = 1;
1374 value_regex++;
1375 } else
1376 store.do_not_match = 0;
1378 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1379 if (regcomp(store.value_regex, value_regex,
1380 REG_EXTENDED)) {
1381 error("invalid pattern: %s", value_regex);
1382 free(store.value_regex);
1383 ret = CONFIG_INVALID_PATTERN;
1384 goto out_free;
1388 store.offset[0] = 0;
1389 store.state = START;
1390 store.seen = 0;
1393 * After this, store.offset will contain the *end* offset
1394 * of the last match, or remain at 0 if no match was found.
1395 * As a side effect, we make sure to transform only a valid
1396 * existing config file.
1398 if (git_config_from_file(store_aux, config_filename, NULL)) {
1399 error("invalid config file %s", config_filename);
1400 free(store.key);
1401 if (store.value_regex != NULL) {
1402 regfree(store.value_regex);
1403 free(store.value_regex);
1405 ret = CONFIG_INVALID_FILE;
1406 goto out_free;
1409 free(store.key);
1410 if (store.value_regex != NULL) {
1411 regfree(store.value_regex);
1412 free(store.value_regex);
1415 /* if nothing to unset, or too many matches, error out */
1416 if ((store.seen == 0 && value == NULL) ||
1417 (store.seen > 1 && multi_replace == 0)) {
1418 ret = CONFIG_NOTHING_SET;
1419 goto out_free;
1422 fstat(in_fd, &st);
1423 contents_sz = xsize_t(st.st_size);
1424 contents = xmmap(NULL, contents_sz, PROT_READ,
1425 MAP_PRIVATE, in_fd, 0);
1426 close(in_fd);
1428 if (store.seen == 0)
1429 store.seen = 1;
1431 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1432 if (store.offset[i] == 0) {
1433 store.offset[i] = copy_end = contents_sz;
1434 } else if (store.state != KEY_SEEN) {
1435 copy_end = store.offset[i];
1436 } else
1437 copy_end = find_beginning_of_line(
1438 contents, contents_sz,
1439 store.offset[i]-2, &new_line);
1441 if (copy_end > 0 && contents[copy_end-1] != '\n')
1442 new_line = 1;
1444 /* write the first part of the config */
1445 if (copy_end > copy_begin) {
1446 if (write_in_full(fd, contents + copy_begin,
1447 copy_end - copy_begin) <
1448 copy_end - copy_begin)
1449 goto write_err_out;
1450 if (new_line &&
1451 write_str_in_full(fd, "\n") != 1)
1452 goto write_err_out;
1454 copy_begin = store.offset[i];
1457 /* write the pair (value == NULL means unset) */
1458 if (value != NULL) {
1459 if (store.state == START) {
1460 if (!store_write_section(fd, key))
1461 goto write_err_out;
1463 if (!store_write_pair(fd, key, value))
1464 goto write_err_out;
1467 /* write the rest of the config */
1468 if (copy_begin < contents_sz)
1469 if (write_in_full(fd, contents + copy_begin,
1470 contents_sz - copy_begin) <
1471 contents_sz - copy_begin)
1472 goto write_err_out;
1474 munmap(contents, contents_sz);
1477 if (commit_lock_file(lock) < 0) {
1478 error("could not commit config file %s", config_filename);
1479 ret = CONFIG_NO_WRITE;
1480 goto out_free;
1484 * lock is committed, so don't try to roll it back below.
1485 * NOTE: Since lockfile.c keeps a linked list of all created
1486 * lock_file structures, it isn't safe to free(lock). It's
1487 * better to just leave it hanging around.
1489 lock = NULL;
1490 ret = 0;
1492 out_free:
1493 if (lock)
1494 rollback_lock_file(lock);
1495 free(filename_buf);
1496 return ret;
1498 write_err_out:
1499 ret = write_error(lock->filename);
1500 goto out_free;
1504 int git_config_set_multivar(const char *key, const char *value,
1505 const char *value_regex, int multi_replace)
1507 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1508 multi_replace);
1511 static int section_name_match (const char *buf, const char *name)
1513 int i = 0, j = 0, dot = 0;
1514 if (buf[i] != '[')
1515 return 0;
1516 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1517 if (!dot && isspace(buf[i])) {
1518 dot = 1;
1519 if (name[j++] != '.')
1520 break;
1521 for (i++; isspace(buf[i]); i++)
1522 ; /* do nothing */
1523 if (buf[i] != '"')
1524 break;
1525 continue;
1527 if (buf[i] == '\\' && dot)
1528 i++;
1529 else if (buf[i] == '"' && dot) {
1530 for (i++; isspace(buf[i]); i++)
1531 ; /* do_nothing */
1532 break;
1534 if (buf[i] != name[j++])
1535 break;
1537 if (buf[i] == ']' && name[j] == 0) {
1539 * We match, now just find the right length offset by
1540 * gobbling up any whitespace after it, as well
1542 i++;
1543 for (; buf[i] && isspace(buf[i]); i++)
1544 ; /* do nothing */
1545 return i;
1547 return 0;
1550 /* if new_name == NULL, the section is removed instead */
1551 int git_config_rename_section_in_file(const char *config_filename,
1552 const char *old_name, const char *new_name)
1554 int ret = 0, remove = 0;
1555 char *filename_buf = NULL;
1556 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1557 int out_fd;
1558 char buf[1024];
1559 FILE *config_file;
1561 if (!config_filename)
1562 config_filename = filename_buf = git_pathdup("config");
1564 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1565 if (out_fd < 0) {
1566 ret = error("could not lock config file %s", config_filename);
1567 goto out;
1570 if (!(config_file = fopen(config_filename, "rb"))) {
1571 /* no config file means nothing to rename, no error */
1572 goto unlock_and_out;
1575 while (fgets(buf, sizeof(buf), config_file)) {
1576 int i;
1577 int length;
1578 char *output = buf;
1579 for (i = 0; buf[i] && isspace(buf[i]); i++)
1580 ; /* do nothing */
1581 if (buf[i] == '[') {
1582 /* it's a section */
1583 int offset = section_name_match(&buf[i], old_name);
1584 if (offset > 0) {
1585 ret++;
1586 if (new_name == NULL) {
1587 remove = 1;
1588 continue;
1590 store.baselen = strlen(new_name);
1591 if (!store_write_section(out_fd, new_name)) {
1592 ret = write_error(lock->filename);
1593 goto out;
1596 * We wrote out the new section, with
1597 * a newline, now skip the old
1598 * section's length
1600 output += offset + i;
1601 if (strlen(output) > 0) {
1603 * More content means there's
1604 * a declaration to put on the
1605 * next line; indent with a
1606 * tab
1608 output -= 1;
1609 output[0] = '\t';
1612 remove = 0;
1614 if (remove)
1615 continue;
1616 length = strlen(output);
1617 if (write_in_full(out_fd, output, length) != length) {
1618 ret = write_error(lock->filename);
1619 goto out;
1622 fclose(config_file);
1623 unlock_and_out:
1624 if (commit_lock_file(lock) < 0)
1625 ret = error("could not commit config file %s", config_filename);
1626 out:
1627 free(filename_buf);
1628 return ret;
1631 int git_config_rename_section(const char *old_name, const char *new_name)
1633 return git_config_rename_section_in_file(NULL, old_name, new_name);
1637 * Call this to report error for your variable that should not
1638 * get a boolean value (i.e. "[my] var" means "true").
1640 int config_error_nonbool(const char *var)
1642 return error("Missing value for '%s'", var);