git grep -O -i: if the pager is 'less', pass the '-i' option
[git/dscho.git] / config.c
blob298bbcf2e5ff21c31fcb094530b15b458aaf7681
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 const char *config_exclusive_filename = NULL;
31 static void lowercase(char *p)
33 for (; *p; p++)
34 *p = tolower(*p);
37 void git_config_push_parameter(const char *text)
39 struct strbuf env = STRBUF_INIT;
40 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
41 if (old) {
42 strbuf_addstr(&env, old);
43 strbuf_addch(&env, ' ');
45 sq_quote_buf(&env, text);
46 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
47 strbuf_release(&env);
50 int git_config_parse_parameter(const char *text,
51 config_fn_t fn, void *data)
53 struct strbuf **pair;
54 pair = strbuf_split_str(text, '=', 2);
55 if (!pair[0])
56 return error("bogus config parameter: %s", text);
57 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
58 strbuf_setlen(pair[0], pair[0]->len - 1);
59 strbuf_trim(pair[0]);
60 if (!pair[0]->len) {
61 strbuf_list_free(pair);
62 return error("bogus config parameter: %s", text);
64 lowercase(pair[0]->buf);
65 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
66 strbuf_list_free(pair);
67 return -1;
69 strbuf_list_free(pair);
70 return 0;
73 int git_config_from_parameters(config_fn_t fn, void *data)
75 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
76 char *envw;
77 const char **argv = NULL;
78 int nr = 0, alloc = 0;
79 int i;
81 if (!env)
82 return 0;
83 /* sq_dequote will write over it */
84 envw = xstrdup(env);
86 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
87 free(envw);
88 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
91 for (i = 0; i < nr; i++) {
92 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
93 free(argv);
94 free(envw);
95 return -1;
99 free(argv);
100 free(envw);
101 return nr > 0;
104 static int get_next_char(void)
106 int c;
107 FILE *f;
109 c = '\n';
110 if (cf && ((f = cf->f) != NULL)) {
111 c = fgetc(f);
112 if (c == '\r') {
113 /* DOS like systems */
114 c = fgetc(f);
115 if (c != '\n') {
116 ungetc(c, f);
117 c = '\r';
120 if (c == '\n')
121 cf->linenr++;
122 if (c == EOF) {
123 cf->eof = 1;
124 c = '\n';
127 return c;
130 static char *parse_value(void)
132 int quote = 0, comment = 0, space = 0;
134 strbuf_reset(&cf->value);
135 for (;;) {
136 int c = get_next_char();
137 if (c == '\n') {
138 if (quote)
139 return NULL;
140 return cf->value.buf;
142 if (comment)
143 continue;
144 if (isspace(c) && !quote) {
145 if (cf->value.len)
146 space++;
147 continue;
149 if (!quote) {
150 if (c == ';' || c == '#') {
151 comment = 1;
152 continue;
155 for (; space; space--)
156 strbuf_addch(&cf->value, ' ');
157 if (c == '\\') {
158 c = get_next_char();
159 switch (c) {
160 case '\n':
161 continue;
162 case 't':
163 c = '\t';
164 break;
165 case 'b':
166 c = '\b';
167 break;
168 case 'n':
169 c = '\n';
170 break;
171 /* Some characters escape as themselves */
172 case '\\': case '"':
173 break;
174 /* Reject unknown escape sequences */
175 default:
176 return NULL;
178 strbuf_addch(&cf->value, c);
179 continue;
181 if (c == '"') {
182 quote = 1-quote;
183 continue;
185 strbuf_addch(&cf->value, c);
189 static inline int iskeychar(int c)
191 return isalnum(c) || c == '-';
194 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
196 int c;
197 char *value;
199 /* Get the full name */
200 for (;;) {
201 c = get_next_char();
202 if (cf->eof)
203 break;
204 if (!iskeychar(c))
205 break;
206 name[len++] = tolower(c);
207 if (len >= MAXNAME)
208 return -1;
210 name[len] = 0;
211 while (c == ' ' || c == '\t')
212 c = get_next_char();
214 value = NULL;
215 if (c != '\n') {
216 if (c != '=')
217 return -1;
218 value = parse_value();
219 if (!value)
220 return -1;
222 return fn(name, value, data);
225 static int get_extended_base_var(char *name, int baselen, int c)
227 do {
228 if (c == '\n')
229 return -1;
230 c = get_next_char();
231 } while (isspace(c));
233 /* We require the format to be '[base "extension"]' */
234 if (c != '"')
235 return -1;
236 name[baselen++] = '.';
238 for (;;) {
239 int c = get_next_char();
240 if (c == '\n')
241 return -1;
242 if (c == '"')
243 break;
244 if (c == '\\') {
245 c = get_next_char();
246 if (c == '\n')
247 return -1;
249 name[baselen++] = c;
250 if (baselen > MAXNAME / 2)
251 return -1;
254 /* Final ']' */
255 if (get_next_char() != ']')
256 return -1;
257 return baselen;
260 static int get_base_var(char *name)
262 int baselen = 0;
264 for (;;) {
265 int c = get_next_char();
266 if (cf->eof)
267 return -1;
268 if (c == ']')
269 return baselen;
270 if (isspace(c))
271 return get_extended_base_var(name, baselen, c);
272 if (!iskeychar(c) && c != '.')
273 return -1;
274 if (baselen > MAXNAME / 2)
275 return -1;
276 name[baselen++] = tolower(c);
280 static int git_parse_file(config_fn_t fn, void *data)
282 int comment = 0;
283 int baselen = 0;
284 char *var = cf->var;
286 /* U+FEFF Byte Order Mark in UTF8 */
287 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
288 const unsigned char *bomptr = utf8_bom;
290 for (;;) {
291 int c = get_next_char();
292 if (bomptr && *bomptr) {
293 /* We are at the file beginning; skip UTF8-encoded BOM
294 * if present. Sane editors won't put this in on their
295 * own, but e.g. Windows Notepad will do it happily. */
296 if ((unsigned char) c == *bomptr) {
297 bomptr++;
298 continue;
299 } else {
300 /* Do not tolerate partial BOM. */
301 if (bomptr != utf8_bom)
302 break;
303 /* No BOM at file beginning. Cool. */
304 bomptr = NULL;
307 if (c == '\n') {
308 if (cf->eof)
309 return 0;
310 comment = 0;
311 continue;
313 if (comment || isspace(c))
314 continue;
315 if (c == '#' || c == ';') {
316 comment = 1;
317 continue;
319 if (c == '[') {
320 baselen = get_base_var(var);
321 if (baselen <= 0)
322 break;
323 var[baselen++] = '.';
324 var[baselen] = 0;
325 continue;
327 if (!isalpha(c))
328 break;
329 var[baselen] = tolower(c);
330 if (get_value(fn, data, var, baselen+1) < 0)
331 break;
333 die("bad config file line %d in %s", cf->linenr, cf->name);
336 static int parse_unit_factor(const char *end, uintmax_t *val)
338 if (!*end)
339 return 1;
340 else if (!strcasecmp(end, "k")) {
341 *val *= 1024;
342 return 1;
344 else if (!strcasecmp(end, "m")) {
345 *val *= 1024 * 1024;
346 return 1;
348 else if (!strcasecmp(end, "g")) {
349 *val *= 1024 * 1024 * 1024;
350 return 1;
352 return 0;
355 static int git_parse_long(const char *value, long *ret)
357 if (value && *value) {
358 char *end;
359 intmax_t val;
360 uintmax_t uval;
361 uintmax_t factor = 1;
363 errno = 0;
364 val = strtoimax(value, &end, 0);
365 if (errno == ERANGE)
366 return 0;
367 if (!parse_unit_factor(end, &factor))
368 return 0;
369 uval = abs(val);
370 uval *= factor;
371 if ((uval > maximum_signed_value_of_type(long)) ||
372 (abs(val) > uval))
373 return 0;
374 val *= factor;
375 *ret = val;
376 return 1;
378 return 0;
381 int git_parse_ulong(const char *value, unsigned long *ret)
383 if (value && *value) {
384 char *end;
385 uintmax_t val;
386 uintmax_t oldval;
388 errno = 0;
389 val = strtoumax(value, &end, 0);
390 if (errno == ERANGE)
391 return 0;
392 oldval = val;
393 if (!parse_unit_factor(end, &val))
394 return 0;
395 if ((val > maximum_unsigned_value_of_type(long)) ||
396 (oldval > val))
397 return 0;
398 *ret = val;
399 return 1;
401 return 0;
404 static void die_bad_config(const char *name)
406 if (cf && cf->name)
407 die("bad config value for '%s' in %s", name, cf->name);
408 die("bad config value for '%s'", name);
411 int git_config_int(const char *name, const char *value)
413 long ret = 0;
414 if (!git_parse_long(value, &ret))
415 die_bad_config(name);
416 return ret;
419 unsigned long git_config_ulong(const char *name, const char *value)
421 unsigned long ret;
422 if (!git_parse_ulong(value, &ret))
423 die_bad_config(name);
424 return ret;
427 static int git_config_maybe_bool_text(const char *name, const char *value)
429 if (!value)
430 return 1;
431 if (!*value)
432 return 0;
433 if (!strcasecmp(value, "true")
434 || !strcasecmp(value, "yes")
435 || !strcasecmp(value, "on"))
436 return 1;
437 if (!strcasecmp(value, "false")
438 || !strcasecmp(value, "no")
439 || !strcasecmp(value, "off"))
440 return 0;
441 return -1;
444 int git_config_maybe_bool(const char *name, const char *value)
446 long v = git_config_maybe_bool_text(name, value);
447 if (0 <= v)
448 return v;
449 if (git_parse_long(value, &v))
450 return !!v;
451 return -1;
454 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
456 int v = git_config_maybe_bool_text(name, value);
457 if (0 <= v) {
458 *is_bool = 1;
459 return v;
461 *is_bool = 0;
462 return git_config_int(name, value);
465 int git_config_bool(const char *name, const char *value)
467 int discard;
468 return !!git_config_bool_or_int(name, value, &discard);
471 int git_config_string(const char **dest, const char *var, const char *value)
473 if (!value)
474 return config_error_nonbool(var);
475 *dest = xstrdup(value);
476 return 0;
479 int git_config_pathname(const char **dest, const char *var, const char *value)
481 if (!value)
482 return config_error_nonbool(var);
483 *dest = expand_user_path(value);
484 if (!*dest)
485 die("Failed to expand user dir in: '%s'", value);
486 return 0;
489 static int git_default_core_config(const char *var, const char *value)
491 /* This needs a better name */
492 if (!strcmp(var, "core.filemode")) {
493 trust_executable_bit = git_config_bool(var, value);
494 return 0;
496 if (!strcmp(var, "core.trustctime")) {
497 trust_ctime = git_config_bool(var, value);
498 return 0;
501 if (!strcmp(var, "core.quotepath")) {
502 quote_path_fully = git_config_bool(var, value);
503 return 0;
506 if (!strcmp(var, "core.symlinks")) {
507 has_symlinks = git_config_bool(var, value);
508 return 0;
511 if (!strcmp(var, "core.ignorecase")) {
512 ignore_case = git_config_bool(var, value);
513 return 0;
516 if (!strcmp(var, "core.attributesfile"))
517 return git_config_pathname(&git_attributes_file, var, value);
519 if (!strcmp(var, "core.bare")) {
520 is_bare_repository_cfg = git_config_bool(var, value);
521 return 0;
524 if (!strcmp(var, "core.ignorestat")) {
525 assume_unchanged = git_config_bool(var, value);
526 return 0;
529 if (!strcmp(var, "core.prefersymlinkrefs")) {
530 prefer_symlink_refs = git_config_bool(var, value);
531 return 0;
534 if (!strcmp(var, "core.logallrefupdates")) {
535 log_all_ref_updates = git_config_bool(var, value);
536 return 0;
539 if (!strcmp(var, "core.warnambiguousrefs")) {
540 warn_ambiguous_refs = git_config_bool(var, value);
541 return 0;
544 if (!strcmp(var, "core.abbrev")) {
545 int abbrev = git_config_int(var, value);
546 if (abbrev < minimum_abbrev || abbrev > 40)
547 return -1;
548 default_abbrev = abbrev;
549 return 0;
552 if (!strcmp(var, "core.loosecompression")) {
553 int level = git_config_int(var, value);
554 if (level == -1)
555 level = Z_DEFAULT_COMPRESSION;
556 else if (level < 0 || level > Z_BEST_COMPRESSION)
557 die("bad zlib compression level %d", level);
558 zlib_compression_level = level;
559 zlib_compression_seen = 1;
560 return 0;
563 if (!strcmp(var, "core.compression")) {
564 int level = git_config_int(var, value);
565 if (level == -1)
566 level = Z_DEFAULT_COMPRESSION;
567 else if (level < 0 || level > Z_BEST_COMPRESSION)
568 die("bad zlib compression level %d", level);
569 core_compression_level = level;
570 core_compression_seen = 1;
571 if (!zlib_compression_seen)
572 zlib_compression_level = level;
573 return 0;
576 if (!strcmp(var, "core.packedgitwindowsize")) {
577 int pgsz_x2 = getpagesize() * 2;
578 packed_git_window_size = git_config_ulong(var, value);
580 /* This value must be multiple of (pagesize * 2) */
581 packed_git_window_size /= pgsz_x2;
582 if (packed_git_window_size < 1)
583 packed_git_window_size = 1;
584 packed_git_window_size *= pgsz_x2;
585 return 0;
588 if (!strcmp(var, "core.bigfilethreshold")) {
589 big_file_threshold = git_config_ulong(var, value);
590 return 0;
593 if (!strcmp(var, "core.packedgitlimit")) {
594 packed_git_limit = git_config_ulong(var, value);
595 return 0;
598 if (!strcmp(var, "core.deltabasecachelimit")) {
599 delta_base_cache_limit = git_config_ulong(var, value);
600 return 0;
603 if (!strcmp(var, "core.logpackaccess"))
604 return git_config_string(&log_pack_access, var, value);
606 if (!strcmp(var, "core.autocrlf")) {
607 if (value && !strcasecmp(value, "input")) {
608 if (core_eol == EOL_CRLF)
609 return error("core.autocrlf=input conflicts with core.eol=crlf");
610 auto_crlf = AUTO_CRLF_INPUT;
611 return 0;
613 auto_crlf = git_config_bool(var, value);
614 return 0;
617 if (!strcmp(var, "core.safecrlf")) {
618 if (value && !strcasecmp(value, "warn")) {
619 safe_crlf = SAFE_CRLF_WARN;
620 return 0;
622 safe_crlf = git_config_bool(var, value);
623 return 0;
626 if (!strcmp(var, "core.eol")) {
627 if (value && !strcasecmp(value, "lf"))
628 core_eol = EOL_LF;
629 else if (value && !strcasecmp(value, "crlf"))
630 core_eol = EOL_CRLF;
631 else if (value && !strcasecmp(value, "native"))
632 core_eol = EOL_NATIVE;
633 else
634 core_eol = EOL_UNSET;
635 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
636 return error("core.autocrlf=input conflicts with core.eol=crlf");
637 return 0;
640 if (!strcmp(var, "core.notesref")) {
641 notes_ref_name = xstrdup(value);
642 return 0;
645 if (!strcmp(var, "core.pager"))
646 return git_config_string(&pager_program, var, value);
648 if (!strcmp(var, "core.editor"))
649 return git_config_string(&editor_program, var, value);
651 if (!strcmp(var, "core.askpass"))
652 return git_config_string(&askpass_program, var, value);
654 if (!strcmp(var, "core.excludesfile"))
655 return git_config_pathname(&excludes_file, var, value);
657 if (!strcmp(var, "core.whitespace")) {
658 if (!value)
659 return config_error_nonbool(var);
660 whitespace_rule_cfg = parse_whitespace_rule(value);
661 return 0;
664 if (!strcmp(var, "core.fsyncobjectfiles")) {
665 fsync_object_files = git_config_bool(var, value);
666 return 0;
669 if (!strcmp(var, "core.preloadindex")) {
670 core_preload_index = git_config_bool(var, value);
671 return 0;
674 if (!strcmp(var, "core.createobject")) {
675 if (!strcmp(value, "rename"))
676 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
677 else if (!strcmp(value, "link"))
678 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
679 else
680 die("Invalid mode for object creation: %s", value);
681 return 0;
684 if (!strcmp(var, "core.sparsecheckout")) {
685 core_apply_sparse_checkout = git_config_bool(var, value);
686 return 0;
689 if (!strcmp(var, "core.hidedotfiles")) {
690 if (value && !strcasecmp(value, "dotgitonly")) {
691 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
692 return 0;
694 hide_dotfiles = git_config_bool(var, value);
695 return 0;
698 /* Add other config variables here and to Documentation/config.txt. */
699 return 0;
702 static int git_default_user_config(const char *var, const char *value)
704 if (!strcmp(var, "user.name")) {
705 if (!value)
706 return config_error_nonbool(var);
707 strlcpy(git_default_name, value, sizeof(git_default_name));
708 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
709 return 0;
712 if (!strcmp(var, "user.email")) {
713 if (!value)
714 return config_error_nonbool(var);
715 strlcpy(git_default_email, value, sizeof(git_default_email));
716 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
717 return 0;
720 /* Add other config variables here and to Documentation/config.txt. */
721 return 0;
724 static int git_default_i18n_config(const char *var, const char *value)
726 if (!strcmp(var, "i18n.commitencoding"))
727 return git_config_string(&git_commit_encoding, var, value);
729 if (!strcmp(var, "i18n.logoutputencoding"))
730 return git_config_string(&git_log_output_encoding, var, value);
732 /* Add other config variables here and to Documentation/config.txt. */
733 return 0;
736 static int git_default_branch_config(const char *var, const char *value)
738 if (!strcmp(var, "branch.autosetupmerge")) {
739 if (value && !strcasecmp(value, "always")) {
740 git_branch_track = BRANCH_TRACK_ALWAYS;
741 return 0;
743 git_branch_track = git_config_bool(var, value);
744 return 0;
746 if (!strcmp(var, "branch.autosetuprebase")) {
747 if (!value)
748 return config_error_nonbool(var);
749 else if (!strcmp(value, "never"))
750 autorebase = AUTOREBASE_NEVER;
751 else if (!strcmp(value, "local"))
752 autorebase = AUTOREBASE_LOCAL;
753 else if (!strcmp(value, "remote"))
754 autorebase = AUTOREBASE_REMOTE;
755 else if (!strcmp(value, "always"))
756 autorebase = AUTOREBASE_ALWAYS;
757 else
758 return error("Malformed value for %s", var);
759 return 0;
762 /* Add other config variables here and to Documentation/config.txt. */
763 return 0;
766 static int git_default_push_config(const char *var, const char *value)
768 if (!strcmp(var, "push.default")) {
769 if (!value)
770 return config_error_nonbool(var);
771 else if (!strcmp(value, "nothing"))
772 push_default = PUSH_DEFAULT_NOTHING;
773 else if (!strcmp(value, "matching"))
774 push_default = PUSH_DEFAULT_MATCHING;
775 else if (!strcmp(value, "upstream"))
776 push_default = PUSH_DEFAULT_UPSTREAM;
777 else if (!strcmp(value, "tracking")) /* deprecated */
778 push_default = PUSH_DEFAULT_UPSTREAM;
779 else if (!strcmp(value, "current"))
780 push_default = PUSH_DEFAULT_CURRENT;
781 else {
782 error("Malformed value for %s: %s", var, value);
783 return error("Must be one of nothing, matching, "
784 "tracking or current.");
786 return 0;
789 /* Add other config variables here and to Documentation/config.txt. */
790 return 0;
793 static int git_default_mailmap_config(const char *var, const char *value)
795 if (!strcmp(var, "mailmap.file"))
796 return git_config_string(&git_mailmap_file, var, value);
798 /* Add other config variables here and to Documentation/config.txt. */
799 return 0;
802 int git_default_config(const char *var, const char *value, void *dummy)
804 if (!prefixcmp(var, "core."))
805 return git_default_core_config(var, value);
807 if (!prefixcmp(var, "user."))
808 return git_default_user_config(var, value);
810 if (!prefixcmp(var, "i18n."))
811 return git_default_i18n_config(var, value);
813 if (!prefixcmp(var, "branch."))
814 return git_default_branch_config(var, value);
816 if (!prefixcmp(var, "push."))
817 return git_default_push_config(var, value);
819 if (!prefixcmp(var, "mailmap."))
820 return git_default_mailmap_config(var, value);
822 if (!prefixcmp(var, "advice."))
823 return git_default_advice_config(var, value);
825 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
826 pager_use_color = git_config_bool(var,value);
827 return 0;
830 if (!strcmp(var, "pack.packsizelimit")) {
831 pack_size_limit_cfg = git_config_ulong(var, value);
832 return 0;
834 /* Add other config variables here and to Documentation/config.txt. */
835 return 0;
838 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
840 int ret;
841 FILE *f = fopen(filename, "r");
843 ret = -1;
844 if (f) {
845 config_file top;
847 /* push config-file parsing state stack */
848 top.prev = cf;
849 top.f = f;
850 top.name = filename;
851 top.linenr = 1;
852 top.eof = 0;
853 strbuf_init(&top.value, 1024);
854 cf = &top;
856 ret = git_parse_file(fn, data);
858 /* pop config-file parsing state stack */
859 strbuf_release(&top.value);
860 cf = top.prev;
862 fclose(f);
864 return ret;
867 const char *git_etc_gitconfig(void)
869 static const char *system_wide;
870 if (!system_wide)
871 system_wide = system_path(ETC_GITCONFIG);
872 return system_wide;
875 int git_env_bool(const char *k, int def)
877 const char *v = getenv(k);
878 return v ? git_config_bool(k, v) : def;
881 int git_config_system(void)
883 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
886 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
888 int ret = 0, found = 0;
889 const char *home = NULL;
891 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
892 if (config_exclusive_filename)
893 return git_config_from_file(fn, config_exclusive_filename, data);
894 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
895 ret += git_config_from_file(fn, git_etc_gitconfig(),
896 data);
897 found += 1;
900 home = get_home_directory();
901 if (home) {
902 char buf[PATH_MAX];
903 char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
904 if (!access(user_config, R_OK)) {
905 ret += git_config_from_file(fn, user_config, data);
906 found += 1;
910 if (repo_config && !access(repo_config, R_OK)) {
911 ret += git_config_from_file(fn, repo_config, data);
912 found += 1;
915 switch (git_config_from_parameters(fn, data)) {
916 case -1: /* error */
917 die("unable to parse command-line config");
918 break;
919 case 0: /* found nothing */
920 break;
921 default: /* found at least one item */
922 found++;
923 break;
926 return ret == 0 ? found : ret;
929 int git_config(config_fn_t fn, void *data)
931 char *repo_config = NULL;
932 int ret;
934 repo_config = git_pathdup("config");
935 ret = git_config_early(fn, data, repo_config);
936 if (repo_config)
937 free(repo_config);
938 return ret;
942 * Find all the stuff for git_config_set() below.
945 #define MAX_MATCHES 512
947 static struct {
948 int baselen;
949 char *key;
950 int do_not_match;
951 regex_t *value_regex;
952 int multi_replace;
953 size_t offset[MAX_MATCHES];
954 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
955 int seen;
956 } store;
958 static int matches(const char *key, const char *value)
960 return !strcmp(key, store.key) &&
961 (store.value_regex == NULL ||
962 (store.do_not_match ^
963 !regexec(store.value_regex, value, 0, NULL, 0)));
966 static int store_aux(const char *key, const char *value, void *cb)
968 const char *ep;
969 size_t section_len;
970 FILE *f = cf->f;
972 switch (store.state) {
973 case KEY_SEEN:
974 if (matches(key, value)) {
975 if (store.seen == 1 && store.multi_replace == 0) {
976 warning("%s has multiple values", key);
977 } else if (store.seen >= MAX_MATCHES) {
978 error("too many matches for %s", key);
979 return 1;
982 store.offset[store.seen] = ftell(f);
983 store.seen++;
985 break;
986 case SECTION_SEEN:
988 * What we are looking for is in store.key (both
989 * section and var), and its section part is baselen
990 * long. We found key (again, both section and var).
991 * We would want to know if this key is in the same
992 * section as what we are looking for. We already
993 * know we are in the same section as what should
994 * hold store.key.
996 ep = strrchr(key, '.');
997 section_len = ep - key;
999 if ((section_len != store.baselen) ||
1000 memcmp(key, store.key, section_len+1)) {
1001 store.state = SECTION_END_SEEN;
1002 break;
1006 * Do not increment matches: this is no match, but we
1007 * just made sure we are in the desired section.
1009 store.offset[store.seen] = ftell(f);
1010 /* fallthru */
1011 case SECTION_END_SEEN:
1012 case START:
1013 if (matches(key, value)) {
1014 store.offset[store.seen] = ftell(f);
1015 store.state = KEY_SEEN;
1016 store.seen++;
1017 } else {
1018 if (strrchr(key, '.') - key == store.baselen &&
1019 !strncmp(key, store.key, store.baselen)) {
1020 store.state = SECTION_SEEN;
1021 store.offset[store.seen] = ftell(f);
1025 return 0;
1028 static int write_error(const char *filename)
1030 error("failed to write new configuration file %s", filename);
1032 /* Same error code as "failed to rename". */
1033 return 4;
1036 static int store_write_section(int fd, const char *key)
1038 const char *dot;
1039 int i, success;
1040 struct strbuf sb = STRBUF_INIT;
1042 dot = memchr(key, '.', store.baselen);
1043 if (dot) {
1044 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1045 for (i = dot - key + 1; i < store.baselen; i++) {
1046 if (key[i] == '"' || key[i] == '\\')
1047 strbuf_addch(&sb, '\\');
1048 strbuf_addch(&sb, key[i]);
1050 strbuf_addstr(&sb, "\"]\n");
1051 } else {
1052 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1055 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1056 strbuf_release(&sb);
1058 return success;
1061 static int store_write_pair(int fd, const char *key, const char *value)
1063 int i, success;
1064 int length = strlen(key + store.baselen + 1);
1065 const char *quote = "";
1066 struct strbuf sb = STRBUF_INIT;
1069 * Check to see if the value needs to be surrounded with a dq pair.
1070 * Note that problematic characters are always backslash-quoted; this
1071 * check is about not losing leading or trailing SP and strings that
1072 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1073 * configuration parser.
1075 if (value[0] == ' ')
1076 quote = "\"";
1077 for (i = 0; value[i]; i++)
1078 if (value[i] == ';' || value[i] == '#')
1079 quote = "\"";
1080 if (i && value[i - 1] == ' ')
1081 quote = "\"";
1083 strbuf_addf(&sb, "\t%.*s = %s",
1084 length, key + store.baselen + 1, quote);
1086 for (i = 0; value[i]; i++)
1087 switch (value[i]) {
1088 case '\n':
1089 strbuf_addstr(&sb, "\\n");
1090 break;
1091 case '\t':
1092 strbuf_addstr(&sb, "\\t");
1093 break;
1094 case '"':
1095 case '\\':
1096 strbuf_addch(&sb, '\\');
1097 default:
1098 strbuf_addch(&sb, value[i]);
1099 break;
1101 strbuf_addf(&sb, "%s\n", quote);
1103 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1104 strbuf_release(&sb);
1106 return success;
1109 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1110 size_t offset_, int *found_bracket)
1112 size_t equal_offset = size, bracket_offset = size;
1113 ssize_t offset;
1115 contline:
1116 for (offset = offset_-2; offset > 0
1117 && contents[offset] != '\n'; offset--)
1118 switch (contents[offset]) {
1119 case '=': equal_offset = offset; break;
1120 case ']': bracket_offset = offset; break;
1122 if (offset > 0 && contents[offset-1] == '\\') {
1123 offset_ = offset;
1124 goto contline;
1126 if (bracket_offset < equal_offset) {
1127 *found_bracket = 1;
1128 offset = bracket_offset+1;
1129 } else
1130 offset++;
1132 return offset;
1135 int git_config_set_in_file(const char *config_filename,
1136 const char *key, const char *value)
1138 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1141 int git_config_set(const char *key, const char *value)
1143 return git_config_set_multivar(key, value, NULL, 0);
1147 * Auxiliary function to sanity-check and split the key into the section
1148 * identifier and variable name.
1150 * Returns 0 on success, -1 when there is an invalid character in the key and
1151 * -2 if there is no section name in the key.
1153 * store_key - pointer to char* which will hold a copy of the key with
1154 * lowercase section and variable name
1155 * baselen - pointer to int which will hold the length of the
1156 * section + subsection part, can be NULL
1158 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1160 int i, dot, baselen;
1161 const char *last_dot = strrchr(key, '.');
1164 * Since "key" actually contains the section name and the real
1165 * key name separated by a dot, we have to know where the dot is.
1168 if (last_dot == NULL || last_dot == key) {
1169 error("key does not contain a section: %s", key);
1170 return -CONFIG_NO_SECTION_OR_NAME;
1173 if (!last_dot[1]) {
1174 error("key does not contain variable name: %s", key);
1175 return -CONFIG_NO_SECTION_OR_NAME;
1178 baselen = last_dot - key;
1179 if (baselen_)
1180 *baselen_ = baselen;
1183 * Validate the key and while at it, lower case it for matching.
1185 *store_key = xmalloc(strlen(key) + 1);
1187 dot = 0;
1188 for (i = 0; key[i]; i++) {
1189 unsigned char c = key[i];
1190 if (c == '.')
1191 dot = 1;
1192 /* Leave the extended basename untouched.. */
1193 if (!dot || i > baselen) {
1194 if (!iskeychar(c) ||
1195 (i == baselen + 1 && !isalpha(c))) {
1196 error("invalid key: %s", key);
1197 goto out_free_ret_1;
1199 c = tolower(c);
1200 } else if (c == '\n') {
1201 error("invalid key (newline): %s", key);
1202 goto out_free_ret_1;
1204 (*store_key)[i] = c;
1206 (*store_key)[i] = 0;
1208 return 0;
1210 out_free_ret_1:
1211 free(*store_key);
1212 return -CONFIG_INVALID_KEY;
1216 * If value==NULL, unset in (remove from) config,
1217 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1218 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1219 * else all matching key/values (regardless how many) are removed,
1220 * before the new pair is written.
1222 * Returns 0 on success.
1224 * This function does this:
1226 * - it locks the config file by creating ".git/config.lock"
1228 * - it then parses the config using store_aux() as validator to find
1229 * the position on the key/value pair to replace. If it is to be unset,
1230 * it must be found exactly once.
1232 * - the config file is mmap()ed and the part before the match (if any) is
1233 * written to the lock file, then the changed part and the rest.
1235 * - the config file is removed and the lock file rename()d to it.
1238 int git_config_set_multivar_in_file(const char *config_filename,
1239 const char *key, const char *value,
1240 const char *value_regex, int multi_replace)
1242 int fd = -1, in_fd;
1243 int ret;
1244 struct lock_file *lock = NULL;
1246 /* parse-key returns negative; flip the sign to feed exit(3) */
1247 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1248 if (ret)
1249 goto out_free;
1251 store.multi_replace = multi_replace;
1255 * The lock serves a purpose in addition to locking: the new
1256 * contents of .git/config will be written into it.
1258 lock = xcalloc(sizeof(struct lock_file), 1);
1259 fd = hold_lock_file_for_update(lock, config_filename, 0);
1260 if (fd < 0) {
1261 error("could not lock config file %s: %s", config_filename, strerror(errno));
1262 free(store.key);
1263 ret = CONFIG_NO_LOCK;
1264 goto out_free;
1268 * If .git/config does not exist yet, write a minimal version.
1270 in_fd = open(config_filename, O_RDONLY);
1271 if ( in_fd < 0 ) {
1272 free(store.key);
1274 if ( ENOENT != errno ) {
1275 error("opening %s: %s", config_filename,
1276 strerror(errno));
1277 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1278 goto out_free;
1280 /* if nothing to unset, error out */
1281 if (value == NULL) {
1282 ret = CONFIG_NOTHING_SET;
1283 goto out_free;
1286 store.key = (char *)key;
1287 if (!store_write_section(fd, key) ||
1288 !store_write_pair(fd, key, value))
1289 goto write_err_out;
1290 } else {
1291 struct stat st;
1292 char *contents;
1293 size_t contents_sz, copy_begin, copy_end;
1294 int i, new_line = 0;
1296 if (value_regex == NULL)
1297 store.value_regex = NULL;
1298 else {
1299 if (value_regex[0] == '!') {
1300 store.do_not_match = 1;
1301 value_regex++;
1302 } else
1303 store.do_not_match = 0;
1305 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1306 if (regcomp(store.value_regex, value_regex,
1307 REG_EXTENDED)) {
1308 error("invalid pattern: %s", value_regex);
1309 free(store.value_regex);
1310 ret = CONFIG_INVALID_PATTERN;
1311 goto out_free;
1315 store.offset[0] = 0;
1316 store.state = START;
1317 store.seen = 0;
1320 * After this, store.offset will contain the *end* offset
1321 * of the last match, or remain at 0 if no match was found.
1322 * As a side effect, we make sure to transform only a valid
1323 * existing config file.
1325 if (git_config_from_file(store_aux, config_filename, NULL)) {
1326 error("invalid config file %s", config_filename);
1327 free(store.key);
1328 if (store.value_regex != NULL) {
1329 regfree(store.value_regex);
1330 free(store.value_regex);
1332 ret = CONFIG_INVALID_FILE;
1333 goto out_free;
1336 free(store.key);
1337 if (store.value_regex != NULL) {
1338 regfree(store.value_regex);
1339 free(store.value_regex);
1342 /* if nothing to unset, or too many matches, error out */
1343 if ((store.seen == 0 && value == NULL) ||
1344 (store.seen > 1 && multi_replace == 0)) {
1345 ret = CONFIG_NOTHING_SET;
1346 goto out_free;
1349 fstat(in_fd, &st);
1350 contents_sz = xsize_t(st.st_size);
1351 contents = xmmap(NULL, contents_sz, PROT_READ,
1352 MAP_PRIVATE, in_fd, 0);
1353 close(in_fd);
1355 if (store.seen == 0)
1356 store.seen = 1;
1358 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1359 if (store.offset[i] == 0) {
1360 store.offset[i] = copy_end = contents_sz;
1361 } else if (store.state != KEY_SEEN) {
1362 copy_end = store.offset[i];
1363 } else
1364 copy_end = find_beginning_of_line(
1365 contents, contents_sz,
1366 store.offset[i]-2, &new_line);
1368 if (copy_end > 0 && contents[copy_end-1] != '\n')
1369 new_line = 1;
1371 /* write the first part of the config */
1372 if (copy_end > copy_begin) {
1373 if (write_in_full(fd, contents + copy_begin,
1374 copy_end - copy_begin) <
1375 copy_end - copy_begin)
1376 goto write_err_out;
1377 if (new_line &&
1378 write_str_in_full(fd, "\n") != 1)
1379 goto write_err_out;
1381 copy_begin = store.offset[i];
1384 /* write the pair (value == NULL means unset) */
1385 if (value != NULL) {
1386 if (store.state == START) {
1387 if (!store_write_section(fd, key))
1388 goto write_err_out;
1390 if (!store_write_pair(fd, key, value))
1391 goto write_err_out;
1394 /* write the rest of the config */
1395 if (copy_begin < contents_sz)
1396 if (write_in_full(fd, contents + copy_begin,
1397 contents_sz - copy_begin) <
1398 contents_sz - copy_begin)
1399 goto write_err_out;
1401 munmap(contents, contents_sz);
1404 if (commit_lock_file(lock) < 0) {
1405 error("could not commit config file %s", config_filename);
1406 ret = CONFIG_NO_WRITE;
1407 goto out_free;
1411 * lock is committed, so don't try to roll it back below.
1412 * NOTE: Since lockfile.c keeps a linked list of all created
1413 * lock_file structures, it isn't safe to free(lock). It's
1414 * better to just leave it hanging around.
1416 lock = NULL;
1417 ret = 0;
1419 out_free:
1420 if (lock)
1421 rollback_lock_file(lock);
1422 return ret;
1424 write_err_out:
1425 ret = write_error(lock->filename);
1426 goto out_free;
1430 int git_config_set_multivar(const char *key, const char *value,
1431 const char *value_regex, int multi_replace)
1433 const char *config_filename;
1434 char *buf = NULL;
1435 int ret;
1437 if (config_exclusive_filename)
1438 config_filename = config_exclusive_filename;
1439 else
1440 config_filename = buf = git_pathdup("config");
1442 ret = git_config_set_multivar_in_file(config_filename, key, value,
1443 value_regex, multi_replace);
1444 free(buf);
1445 return ret;
1448 static int section_name_match (const char *buf, const char *name)
1450 int i = 0, j = 0, dot = 0;
1451 if (buf[i] != '[')
1452 return 0;
1453 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1454 if (!dot && isspace(buf[i])) {
1455 dot = 1;
1456 if (name[j++] != '.')
1457 break;
1458 for (i++; isspace(buf[i]); i++)
1459 ; /* do nothing */
1460 if (buf[i] != '"')
1461 break;
1462 continue;
1464 if (buf[i] == '\\' && dot)
1465 i++;
1466 else if (buf[i] == '"' && dot) {
1467 for (i++; isspace(buf[i]); i++)
1468 ; /* do_nothing */
1469 break;
1471 if (buf[i] != name[j++])
1472 break;
1474 if (buf[i] == ']' && name[j] == 0) {
1476 * We match, now just find the right length offset by
1477 * gobbling up any whitespace after it, as well
1479 i++;
1480 for (; buf[i] && isspace(buf[i]); i++)
1481 ; /* do nothing */
1482 return i;
1484 return 0;
1487 /* if new_name == NULL, the section is removed instead */
1488 int git_config_rename_section(const char *old_name, const char *new_name)
1490 int ret = 0, remove = 0;
1491 char *config_filename;
1492 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1493 int out_fd;
1494 char buf[1024];
1495 FILE *config_file;
1497 if (config_exclusive_filename)
1498 config_filename = xstrdup(config_exclusive_filename);
1499 else
1500 config_filename = git_pathdup("config");
1501 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1502 if (out_fd < 0) {
1503 ret = error("could not lock config file %s", config_filename);
1504 goto out;
1507 if (!(config_file = fopen(config_filename, "rb"))) {
1508 /* no config file means nothing to rename, no error */
1509 goto unlock_and_out;
1512 while (fgets(buf, sizeof(buf), config_file)) {
1513 int i;
1514 int length;
1515 char *output = buf;
1516 for (i = 0; buf[i] && isspace(buf[i]); i++)
1517 ; /* do nothing */
1518 if (buf[i] == '[') {
1519 /* it's a section */
1520 int offset = section_name_match(&buf[i], old_name);
1521 if (offset > 0) {
1522 ret++;
1523 if (new_name == NULL) {
1524 remove = 1;
1525 continue;
1527 store.baselen = strlen(new_name);
1528 if (!store_write_section(out_fd, new_name)) {
1529 ret = write_error(lock->filename);
1530 goto out;
1533 * We wrote out the new section, with
1534 * a newline, now skip the old
1535 * section's length
1537 output += offset + i;
1538 if (strlen(output) > 0) {
1540 * More content means there's
1541 * a declaration to put on the
1542 * next line; indent with a
1543 * tab
1545 output -= 1;
1546 output[0] = '\t';
1549 remove = 0;
1551 if (remove)
1552 continue;
1553 length = strlen(output);
1554 if (write_in_full(out_fd, output, length) != length) {
1555 ret = write_error(lock->filename);
1556 goto out;
1559 fclose(config_file);
1560 unlock_and_out:
1561 if (commit_lock_file(lock) < 0)
1562 ret = error("could not commit config file %s", config_filename);
1563 out:
1564 free(config_filename);
1565 return ret;
1569 * Call this to report error for your variable that should not
1570 * get a boolean value (i.e. "[my] var" means "true").
1572 int config_error_nonbool(const char *var)
1574 return error("Missing value for '%s'", var);