config.c: trivial fix for compile-time warning
[git/dscho.git] / config.c
blob1f4b703a6ba3cf0ada510717a7f9ac9ca51981a5
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"
12 #include "credential.h"
14 #define MAXNAME (256)
16 typedef struct config_file {
17 struct config_file *prev;
18 FILE *f;
19 const char *name;
20 int linenr;
21 int eof;
22 struct strbuf value;
23 char var[MAXNAME];
24 } config_file;
26 static config_file *cf;
28 static int zlib_compression_seen;
30 const char *config_exclusive_filename = NULL;
32 static void lowercase(char *p)
34 for (; *p; p++)
35 *p = tolower(*p);
38 void git_config_push_parameter(const char *text)
40 struct strbuf env = STRBUF_INIT;
41 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
42 if (old) {
43 strbuf_addstr(&env, old);
44 strbuf_addch(&env, ' ');
46 sq_quote_buf(&env, text);
47 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
48 strbuf_release(&env);
51 int git_config_parse_parameter(const char *text,
52 config_fn_t fn, void *data)
54 struct strbuf **pair;
55 pair = strbuf_split_str(text, '=', 2);
56 if (!pair[0])
57 return error("bogus config parameter: %s", text);
58 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
59 strbuf_setlen(pair[0], pair[0]->len - 1);
60 strbuf_trim(pair[0]);
61 if (!pair[0]->len) {
62 strbuf_list_free(pair);
63 return error("bogus config parameter: %s", text);
65 lowercase(pair[0]->buf);
66 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
67 strbuf_list_free(pair);
68 return -1;
70 strbuf_list_free(pair);
71 return 0;
74 int git_config_from_parameters(config_fn_t fn, void *data)
76 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
77 char *envw;
78 const char **argv = NULL;
79 int nr = 0, alloc = 0;
80 int i;
82 if (!env)
83 return 0;
84 /* sq_dequote will write over it */
85 envw = xstrdup(env);
87 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
88 free(envw);
89 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
92 for (i = 0; i < nr; i++) {
93 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
94 free(argv);
95 free(envw);
96 return -1;
100 free(argv);
101 free(envw);
102 return nr > 0;
105 static int get_next_char(void)
107 int c;
108 FILE *f;
110 c = '\n';
111 if (cf && ((f = cf->f) != NULL)) {
112 c = fgetc(f);
113 if (c == '\r') {
114 /* DOS like systems */
115 c = fgetc(f);
116 if (c != '\n') {
117 ungetc(c, f);
118 c = '\r';
121 if (c == '\n')
122 cf->linenr++;
123 if (c == EOF) {
124 cf->eof = 1;
125 c = '\n';
128 return c;
131 static char *parse_value(void)
133 int quote = 0, comment = 0, space = 0;
135 strbuf_reset(&cf->value);
136 for (;;) {
137 int c = get_next_char();
138 if (c == '\n') {
139 if (quote)
140 return NULL;
141 return cf->value.buf;
143 if (comment)
144 continue;
145 if (isspace(c) && !quote) {
146 if (cf->value.len)
147 space++;
148 continue;
150 if (!quote) {
151 if (c == ';' || c == '#') {
152 comment = 1;
153 continue;
156 for (; space; space--)
157 strbuf_addch(&cf->value, ' ');
158 if (c == '\\') {
159 c = get_next_char();
160 switch (c) {
161 case '\n':
162 continue;
163 case 't':
164 c = '\t';
165 break;
166 case 'b':
167 c = '\b';
168 break;
169 case 'n':
170 c = '\n';
171 break;
172 /* Some characters escape as themselves */
173 case '\\': case '"':
174 break;
175 /* Reject unknown escape sequences */
176 default:
177 return NULL;
179 strbuf_addch(&cf->value, c);
180 continue;
182 if (c == '"') {
183 quote = 1-quote;
184 continue;
186 strbuf_addch(&cf->value, c);
190 static inline int iskeychar(int c)
192 return isalnum(c) || c == '-';
195 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
197 int c;
198 char *value;
200 /* Get the full name */
201 for (;;) {
202 c = get_next_char();
203 if (cf->eof)
204 break;
205 if (!iskeychar(c))
206 break;
207 name[len++] = tolower(c);
208 if (len >= MAXNAME)
209 return -1;
211 name[len] = 0;
212 while (c == ' ' || c == '\t')
213 c = get_next_char();
215 value = NULL;
216 if (c != '\n') {
217 if (c != '=')
218 return -1;
219 value = parse_value();
220 if (!value)
221 return -1;
223 return fn(name, value, data);
226 static int get_extended_base_var(char *name, int baselen, int c)
228 do {
229 if (c == '\n')
230 return -1;
231 c = get_next_char();
232 } while (isspace(c));
234 /* We require the format to be '[base "extension"]' */
235 if (c != '"')
236 return -1;
237 name[baselen++] = '.';
239 for (;;) {
240 int c = get_next_char();
241 if (c == '\n')
242 return -1;
243 if (c == '"')
244 break;
245 if (c == '\\') {
246 c = get_next_char();
247 if (c == '\n')
248 return -1;
250 name[baselen++] = c;
251 if (baselen > MAXNAME / 2)
252 return -1;
255 /* Final ']' */
256 if (get_next_char() != ']')
257 return -1;
258 return baselen;
261 static int get_base_var(char *name)
263 int baselen = 0;
265 for (;;) {
266 int c = get_next_char();
267 if (cf->eof)
268 return -1;
269 if (c == ']')
270 return baselen;
271 if (isspace(c))
272 return get_extended_base_var(name, baselen, c);
273 if (!iskeychar(c) && c != '.')
274 return -1;
275 if (baselen > MAXNAME / 2)
276 return -1;
277 name[baselen++] = tolower(c);
281 static int git_parse_file(config_fn_t fn, void *data)
283 int comment = 0;
284 int baselen = 0;
285 char *var = cf->var;
287 /* U+FEFF Byte Order Mark in UTF8 */
288 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
289 const unsigned char *bomptr = utf8_bom;
291 for (;;) {
292 int c = get_next_char();
293 if (bomptr && *bomptr) {
294 /* We are at the file beginning; skip UTF8-encoded BOM
295 * if present. Sane editors won't put this in on their
296 * own, but e.g. Windows Notepad will do it happily. */
297 if ((unsigned char) c == *bomptr) {
298 bomptr++;
299 continue;
300 } else {
301 /* Do not tolerate partial BOM. */
302 if (bomptr != utf8_bom)
303 break;
304 /* No BOM at file beginning. Cool. */
305 bomptr = NULL;
308 if (c == '\n') {
309 if (cf->eof)
310 return 0;
311 comment = 0;
312 continue;
314 if (comment || isspace(c))
315 continue;
316 if (c == '#' || c == ';') {
317 comment = 1;
318 continue;
320 if (c == '[') {
321 baselen = get_base_var(var);
322 if (baselen <= 0)
323 break;
324 var[baselen++] = '.';
325 var[baselen] = 0;
326 continue;
328 if (!isalpha(c))
329 break;
330 var[baselen] = tolower(c);
331 if (get_value(fn, data, var, baselen+1) < 0)
332 break;
334 die("bad config file line %d in %s", cf->linenr, cf->name);
337 static int parse_unit_factor(const char *end, unsigned long *val)
339 if (!*end)
340 return 1;
341 else if (!strcasecmp(end, "k")) {
342 *val *= 1024;
343 return 1;
345 else if (!strcasecmp(end, "m")) {
346 *val *= 1024 * 1024;
347 return 1;
349 else if (!strcasecmp(end, "g")) {
350 *val *= 1024 * 1024 * 1024;
351 return 1;
353 return 0;
356 static int git_parse_long(const char *value, long *ret)
358 if (value && *value) {
359 char *end;
360 long val = strtol(value, &end, 0);
361 unsigned long factor = 1;
362 if (!parse_unit_factor(end, &factor))
363 return 0;
364 *ret = val * factor;
365 return 1;
367 return 0;
370 int git_parse_ulong(const char *value, unsigned long *ret)
372 if (value && *value) {
373 char *end;
374 unsigned long val = strtoul(value, &end, 0);
375 if (!parse_unit_factor(end, &val))
376 return 0;
377 *ret = val;
378 return 1;
380 return 0;
383 static void die_bad_config(const char *name)
385 if (cf && cf->name)
386 die("bad config value for '%s' in %s", name, cf->name);
387 die("bad config value for '%s'", name);
390 int git_config_int(const char *name, const char *value)
392 long ret = 0;
393 if (!git_parse_long(value, &ret))
394 die_bad_config(name);
395 return ret;
398 unsigned long git_config_ulong(const char *name, const char *value)
400 unsigned long ret;
401 if (!git_parse_ulong(value, &ret))
402 die_bad_config(name);
403 return ret;
406 static int git_config_maybe_bool_text(const char *name, const char *value)
408 if (!value)
409 return 1;
410 if (!*value)
411 return 0;
412 if (!strcasecmp(value, "true")
413 || !strcasecmp(value, "yes")
414 || !strcasecmp(value, "on"))
415 return 1;
416 if (!strcasecmp(value, "false")
417 || !strcasecmp(value, "no")
418 || !strcasecmp(value, "off"))
419 return 0;
420 return -1;
423 int git_config_maybe_bool(const char *name, const char *value)
425 long v = git_config_maybe_bool_text(name, value);
426 if (0 <= v)
427 return v;
428 if (git_parse_long(value, &v))
429 return !!v;
430 return -1;
433 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
435 int v = git_config_maybe_bool_text(name, value);
436 if (0 <= v) {
437 *is_bool = 1;
438 return v;
440 *is_bool = 0;
441 return git_config_int(name, value);
444 int git_config_bool(const char *name, const char *value)
446 int discard;
447 return !!git_config_bool_or_int(name, value, &discard);
450 int git_config_string(const char **dest, const char *var, const char *value)
452 if (!value)
453 return config_error_nonbool(var);
454 *dest = xstrdup(value);
455 return 0;
458 int git_config_pathname(const char **dest, const char *var, const char *value)
460 if (!value)
461 return config_error_nonbool(var);
462 *dest = expand_user_path(value);
463 if (!*dest)
464 die("Failed to expand user dir in: '%s'", value);
465 return 0;
468 static int git_default_core_config(const char *var, const char *value)
470 /* This needs a better name */
471 if (!strcmp(var, "core.filemode")) {
472 trust_executable_bit = git_config_bool(var, value);
473 return 0;
475 if (!strcmp(var, "core.trustctime")) {
476 trust_ctime = git_config_bool(var, value);
477 return 0;
480 if (!strcmp(var, "core.quotepath")) {
481 quote_path_fully = git_config_bool(var, value);
482 return 0;
485 if (!strcmp(var, "core.symlinks")) {
486 has_symlinks = git_config_bool(var, value);
487 return 0;
490 if (!strcmp(var, "core.ignorecase")) {
491 ignore_case = git_config_bool(var, value);
492 return 0;
495 if (!strcmp(var, "core.bare")) {
496 is_bare_repository_cfg = git_config_bool(var, value);
497 return 0;
500 if (!strcmp(var, "core.ignorestat")) {
501 assume_unchanged = git_config_bool(var, value);
502 return 0;
505 if (!strcmp(var, "core.prefersymlinkrefs")) {
506 prefer_symlink_refs = git_config_bool(var, value);
507 return 0;
510 if (!strcmp(var, "core.logallrefupdates")) {
511 log_all_ref_updates = git_config_bool(var, value);
512 return 0;
515 if (!strcmp(var, "core.warnambiguousrefs")) {
516 warn_ambiguous_refs = git_config_bool(var, value);
517 return 0;
520 if (!strcmp(var, "core.abbrev")) {
521 int abbrev = git_config_int(var, value);
522 if (abbrev < minimum_abbrev || abbrev > 40)
523 return -1;
524 default_abbrev = abbrev;
525 return 0;
528 if (!strcmp(var, "core.loosecompression")) {
529 int level = git_config_int(var, value);
530 if (level == -1)
531 level = Z_DEFAULT_COMPRESSION;
532 else if (level < 0 || level > Z_BEST_COMPRESSION)
533 die("bad zlib compression level %d", level);
534 zlib_compression_level = level;
535 zlib_compression_seen = 1;
536 return 0;
539 if (!strcmp(var, "core.compression")) {
540 int level = git_config_int(var, value);
541 if (level == -1)
542 level = Z_DEFAULT_COMPRESSION;
543 else if (level < 0 || level > Z_BEST_COMPRESSION)
544 die("bad zlib compression level %d", level);
545 core_compression_level = level;
546 core_compression_seen = 1;
547 if (!zlib_compression_seen)
548 zlib_compression_level = level;
549 return 0;
552 if (!strcmp(var, "core.packedgitwindowsize")) {
553 int pgsz_x2 = getpagesize() * 2;
554 packed_git_window_size = git_config_int(var, value);
556 /* This value must be multiple of (pagesize * 2) */
557 packed_git_window_size /= pgsz_x2;
558 if (packed_git_window_size < 1)
559 packed_git_window_size = 1;
560 packed_git_window_size *= pgsz_x2;
561 return 0;
564 if (!strcmp(var, "core.bigfilethreshold")) {
565 long n = git_config_int(var, value);
566 big_file_threshold = 0 < n ? n : 0;
567 return 0;
570 if (!strcmp(var, "core.packedgitlimit")) {
571 packed_git_limit = git_config_int(var, value);
572 return 0;
575 if (!strcmp(var, "core.deltabasecachelimit")) {
576 delta_base_cache_limit = git_config_int(var, value);
577 return 0;
580 if (!strcmp(var, "core.logpackaccess"))
581 return git_config_string(&log_pack_access, var, value);
583 if (!strcmp(var, "core.autocrlf")) {
584 if (value && !strcasecmp(value, "input")) {
585 if (core_eol == EOL_CRLF)
586 return error("core.autocrlf=input conflicts with core.eol=crlf");
587 auto_crlf = AUTO_CRLF_INPUT;
588 return 0;
590 auto_crlf = git_config_bool(var, value);
591 return 0;
594 if (!strcmp(var, "core.safecrlf")) {
595 if (value && !strcasecmp(value, "warn")) {
596 safe_crlf = SAFE_CRLF_WARN;
597 return 0;
599 safe_crlf = git_config_bool(var, value);
600 return 0;
603 if (!strcmp(var, "core.eol")) {
604 if (value && !strcasecmp(value, "lf"))
605 core_eol = EOL_LF;
606 else if (value && !strcasecmp(value, "crlf"))
607 core_eol = EOL_CRLF;
608 else if (value && !strcasecmp(value, "native"))
609 core_eol = EOL_NATIVE;
610 else
611 core_eol = EOL_UNSET;
612 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
613 return error("core.autocrlf=input conflicts with core.eol=crlf");
614 return 0;
617 if (!strcmp(var, "core.notesref")) {
618 notes_ref_name = xstrdup(value);
619 return 0;
622 if (!strcmp(var, "core.pager"))
623 return git_config_string(&pager_program, var, value);
625 if (!strcmp(var, "core.editor"))
626 return git_config_string(&editor_program, var, value);
628 if (!strcmp(var, "core.askpass"))
629 return git_config_string(&askpass_program, var, value);
631 if (!strcmp(var, "core.excludesfile"))
632 return git_config_pathname(&excludes_file, var, value);
634 if (!strcmp(var, "core.whitespace")) {
635 if (!value)
636 return config_error_nonbool(var);
637 whitespace_rule_cfg = parse_whitespace_rule(value);
638 return 0;
641 if (!strcmp(var, "core.fsyncobjectfiles")) {
642 fsync_object_files = git_config_bool(var, value);
643 return 0;
646 if (!strcmp(var, "core.preloadindex")) {
647 core_preload_index = git_config_bool(var, value);
648 return 0;
651 if (!strcmp(var, "core.createobject")) {
652 if (!strcmp(value, "rename"))
653 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
654 else if (!strcmp(value, "link"))
655 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
656 else
657 die("Invalid mode for object creation: %s", value);
658 return 0;
661 if (!strcmp(var, "core.sparsecheckout")) {
662 core_apply_sparse_checkout = git_config_bool(var, value);
663 return 0;
666 if (!strcmp(var, "core.hidedotfiles")) {
667 if (value && !strcasecmp(value, "dotgitonly")) {
668 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
669 return 0;
671 hide_dotfiles = git_config_bool(var, value);
672 return 0;
675 /* Add other config variables here and to Documentation/config.txt. */
676 return 0;
679 static int git_default_user_config(const char *var, const char *value)
681 if (!strcmp(var, "user.name")) {
682 if (!value)
683 return config_error_nonbool(var);
684 strlcpy(git_default_name, value, sizeof(git_default_name));
685 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
686 return 0;
689 if (!strcmp(var, "user.email")) {
690 if (!value)
691 return config_error_nonbool(var);
692 strlcpy(git_default_email, value, sizeof(git_default_email));
693 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
694 return 0;
697 /* Add other config variables here and to Documentation/config.txt. */
698 return 0;
701 static int git_default_i18n_config(const char *var, const char *value)
703 if (!strcmp(var, "i18n.commitencoding"))
704 return git_config_string(&git_commit_encoding, var, value);
706 if (!strcmp(var, "i18n.logoutputencoding"))
707 return git_config_string(&git_log_output_encoding, var, value);
709 /* Add other config variables here and to Documentation/config.txt. */
710 return 0;
713 static int git_default_branch_config(const char *var, const char *value)
715 if (!strcmp(var, "branch.autosetupmerge")) {
716 if (value && !strcasecmp(value, "always")) {
717 git_branch_track = BRANCH_TRACK_ALWAYS;
718 return 0;
720 git_branch_track = git_config_bool(var, value);
721 return 0;
723 if (!strcmp(var, "branch.autosetuprebase")) {
724 if (!value)
725 return config_error_nonbool(var);
726 else if (!strcmp(value, "never"))
727 autorebase = AUTOREBASE_NEVER;
728 else if (!strcmp(value, "local"))
729 autorebase = AUTOREBASE_LOCAL;
730 else if (!strcmp(value, "remote"))
731 autorebase = AUTOREBASE_REMOTE;
732 else if (!strcmp(value, "always"))
733 autorebase = AUTOREBASE_ALWAYS;
734 else
735 return error("Malformed value for %s", var);
736 return 0;
739 /* Add other config variables here and to Documentation/config.txt. */
740 return 0;
743 static int git_default_push_config(const char *var, const char *value)
745 if (!strcmp(var, "push.default")) {
746 if (!value)
747 return config_error_nonbool(var);
748 else if (!strcmp(value, "nothing"))
749 push_default = PUSH_DEFAULT_NOTHING;
750 else if (!strcmp(value, "matching"))
751 push_default = PUSH_DEFAULT_MATCHING;
752 else if (!strcmp(value, "upstream"))
753 push_default = PUSH_DEFAULT_UPSTREAM;
754 else if (!strcmp(value, "tracking")) /* deprecated */
755 push_default = PUSH_DEFAULT_UPSTREAM;
756 else if (!strcmp(value, "current"))
757 push_default = PUSH_DEFAULT_CURRENT;
758 else {
759 error("Malformed value for %s: %s", var, value);
760 return error("Must be one of nothing, matching, "
761 "tracking or current.");
763 return 0;
766 /* Add other config variables here and to Documentation/config.txt. */
767 return 0;
770 static int git_default_mailmap_config(const char *var, const char *value)
772 if (!strcmp(var, "mailmap.file"))
773 return git_config_string(&git_mailmap_file, var, value);
775 /* Add other config variables here and to Documentation/config.txt. */
776 return 0;
779 int git_default_config(const char *var, const char *value, void *dummy)
781 if (!prefixcmp(var, "core."))
782 return git_default_core_config(var, value);
784 if (!prefixcmp(var, "user."))
785 return git_default_user_config(var, value);
787 if (!prefixcmp(var, "i18n."))
788 return git_default_i18n_config(var, value);
790 if (!prefixcmp(var, "branch."))
791 return git_default_branch_config(var, value);
793 if (!prefixcmp(var, "push."))
794 return git_default_push_config(var, value);
796 if (!prefixcmp(var, "mailmap."))
797 return git_default_mailmap_config(var, value);
799 if (!prefixcmp(var, "advice."))
800 return git_default_advice_config(var, value);
802 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
803 pager_use_color = git_config_bool(var,value);
804 return 0;
807 if (!prefixcmp(var, "credential."))
808 return git_default_credential_config(var, value);
810 /* Add other config variables here and to Documentation/config.txt. */
811 return 0;
814 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
816 int ret;
817 FILE *f = fopen(filename, "r");
819 ret = -1;
820 if (f) {
821 config_file top;
823 /* push config-file parsing state stack */
824 top.prev = cf;
825 top.f = f;
826 top.name = filename;
827 top.linenr = 1;
828 top.eof = 0;
829 strbuf_init(&top.value, 1024);
830 cf = &top;
832 ret = git_parse_file(fn, data);
834 /* pop config-file parsing state stack */
835 strbuf_release(&top.value);
836 cf = top.prev;
838 fclose(f);
840 return ret;
843 const char *git_etc_gitconfig(void)
845 static const char *system_wide;
846 if (!system_wide)
847 system_wide = system_path(ETC_GITCONFIG);
848 return system_wide;
851 int git_env_bool(const char *k, int def)
853 const char *v = getenv(k);
854 return v ? git_config_bool(k, v) : def;
857 int git_config_system(void)
859 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
862 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
864 int ret = 0, found = 0;
865 const char *home = NULL;
867 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
868 if (config_exclusive_filename)
869 return git_config_from_file(fn, config_exclusive_filename, data);
870 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
871 ret += git_config_from_file(fn, git_etc_gitconfig(),
872 data);
873 found += 1;
876 home = get_home_directory();
877 if (home) {
878 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
879 if (!access(user_config, R_OK)) {
880 ret += git_config_from_file(fn, user_config, data);
881 found += 1;
883 free(user_config);
886 if (repo_config && !access(repo_config, R_OK)) {
887 ret += git_config_from_file(fn, repo_config, data);
888 found += 1;
891 switch (git_config_from_parameters(fn, data)) {
892 case -1: /* error */
893 die("unable to parse command-line config");
894 break;
895 case 0: /* found nothing */
896 break;
897 default: /* found at least one item */
898 found++;
899 break;
902 return ret == 0 ? found : ret;
905 int git_config(config_fn_t fn, void *data)
907 char *repo_config = NULL;
908 int ret;
910 repo_config = git_pathdup("config");
911 ret = git_config_early(fn, data, repo_config);
912 if (repo_config)
913 free(repo_config);
914 return ret;
918 * Find all the stuff for git_config_set() below.
921 #define MAX_MATCHES 512
923 static struct {
924 int baselen;
925 char *key;
926 int do_not_match;
927 regex_t *value_regex;
928 int multi_replace;
929 size_t offset[MAX_MATCHES];
930 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
931 int seen;
932 } store;
934 static int matches(const char *key, const char *value)
936 return !strcmp(key, store.key) &&
937 (store.value_regex == NULL ||
938 (store.do_not_match ^
939 !regexec(store.value_regex, value, 0, NULL, 0)));
942 static int store_aux(const char *key, const char *value, void *cb)
944 const char *ep;
945 size_t section_len;
946 FILE *f = cf->f;
948 switch (store.state) {
949 case KEY_SEEN:
950 if (matches(key, value)) {
951 if (store.seen == 1 && store.multi_replace == 0) {
952 warning("%s has multiple values", key);
953 } else if (store.seen >= MAX_MATCHES) {
954 error("too many matches for %s", key);
955 return 1;
958 store.offset[store.seen] = ftell(f);
959 store.seen++;
961 break;
962 case SECTION_SEEN:
964 * What we are looking for is in store.key (both
965 * section and var), and its section part is baselen
966 * long. We found key (again, both section and var).
967 * We would want to know if this key is in the same
968 * section as what we are looking for. We already
969 * know we are in the same section as what should
970 * hold store.key.
972 ep = strrchr(key, '.');
973 section_len = ep - key;
975 if ((section_len != store.baselen) ||
976 memcmp(key, store.key, section_len+1)) {
977 store.state = SECTION_END_SEEN;
978 break;
982 * Do not increment matches: this is no match, but we
983 * just made sure we are in the desired section.
985 store.offset[store.seen] = ftell(f);
986 /* fallthru */
987 case SECTION_END_SEEN:
988 case START:
989 if (matches(key, value)) {
990 store.offset[store.seen] = ftell(f);
991 store.state = KEY_SEEN;
992 store.seen++;
993 } else {
994 if (strrchr(key, '.') - key == store.baselen &&
995 !strncmp(key, store.key, store.baselen)) {
996 store.state = SECTION_SEEN;
997 store.offset[store.seen] = ftell(f);
1001 return 0;
1004 static int write_error(const char *filename)
1006 error("failed to write new configuration file %s", filename);
1008 /* Same error code as "failed to rename". */
1009 return 4;
1012 static int store_write_section(int fd, const char *key)
1014 const char *dot;
1015 int i, success;
1016 struct strbuf sb = STRBUF_INIT;
1018 dot = memchr(key, '.', store.baselen);
1019 if (dot) {
1020 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1021 for (i = dot - key + 1; i < store.baselen; i++) {
1022 if (key[i] == '"' || key[i] == '\\')
1023 strbuf_addch(&sb, '\\');
1024 strbuf_addch(&sb, key[i]);
1026 strbuf_addstr(&sb, "\"]\n");
1027 } else {
1028 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1031 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1032 strbuf_release(&sb);
1034 return success;
1037 static int store_write_pair(int fd, const char *key, const char *value)
1039 int i, success;
1040 int length = strlen(key + store.baselen + 1);
1041 const char *quote = "";
1042 struct strbuf sb = STRBUF_INIT;
1045 * Check to see if the value needs to be surrounded with a dq pair.
1046 * Note that problematic characters are always backslash-quoted; this
1047 * check is about not losing leading or trailing SP and strings that
1048 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1049 * configuration parser.
1051 if (value[0] == ' ')
1052 quote = "\"";
1053 for (i = 0; value[i]; i++)
1054 if (value[i] == ';' || value[i] == '#')
1055 quote = "\"";
1056 if (i && value[i - 1] == ' ')
1057 quote = "\"";
1059 strbuf_addf(&sb, "\t%.*s = %s",
1060 length, key + store.baselen + 1, quote);
1062 for (i = 0; value[i]; i++)
1063 switch (value[i]) {
1064 case '\n':
1065 strbuf_addstr(&sb, "\\n");
1066 break;
1067 case '\t':
1068 strbuf_addstr(&sb, "\\t");
1069 break;
1070 case '"':
1071 case '\\':
1072 strbuf_addch(&sb, '\\');
1073 default:
1074 strbuf_addch(&sb, value[i]);
1075 break;
1077 strbuf_addf(&sb, "%s\n", quote);
1079 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1080 strbuf_release(&sb);
1082 return success;
1085 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1086 size_t offset_, int *found_bracket)
1088 size_t equal_offset = size, bracket_offset = size;
1089 ssize_t offset;
1091 contline:
1092 for (offset = offset_-2; offset > 0
1093 && contents[offset] != '\n'; offset--)
1094 switch (contents[offset]) {
1095 case '=': equal_offset = offset; break;
1096 case ']': bracket_offset = offset; break;
1098 if (offset > 0 && contents[offset-1] == '\\') {
1099 offset_ = offset;
1100 goto contline;
1102 if (bracket_offset < equal_offset) {
1103 *found_bracket = 1;
1104 offset = bracket_offset+1;
1105 } else
1106 offset++;
1108 return offset;
1111 int git_config_set(const char *key, const char *value)
1113 return git_config_set_multivar(key, value, NULL, 0);
1117 * Auxiliary function to sanity-check and split the key into the section
1118 * identifier and variable name.
1120 * Returns 0 on success, -1 when there is an invalid character in the key and
1121 * -2 if there is no section name in the key.
1123 * store_key - pointer to char* which will hold a copy of the key with
1124 * lowercase section and variable name
1125 * baselen - pointer to int which will hold the length of the
1126 * section + subsection part, can be NULL
1128 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1130 int i, dot, baselen;
1131 const char *last_dot = strrchr(key, '.');
1134 * Since "key" actually contains the section name and the real
1135 * key name separated by a dot, we have to know where the dot is.
1138 if (last_dot == NULL || last_dot == key) {
1139 error("key does not contain a section: %s", key);
1140 return -CONFIG_NO_SECTION_OR_NAME;
1143 if (!last_dot[1]) {
1144 error("key does not contain variable name: %s", key);
1145 return -CONFIG_NO_SECTION_OR_NAME;
1148 baselen = last_dot - key;
1149 if (baselen_)
1150 *baselen_ = baselen;
1153 * Validate the key and while at it, lower case it for matching.
1155 *store_key = xmalloc(strlen(key) + 1);
1157 dot = 0;
1158 for (i = 0; key[i]; i++) {
1159 unsigned char c = key[i];
1160 if (c == '.')
1161 dot = 1;
1162 /* Leave the extended basename untouched.. */
1163 if (!dot || i > baselen) {
1164 if (!iskeychar(c) ||
1165 (i == baselen + 1 && !isalpha(c))) {
1166 error("invalid key: %s", key);
1167 goto out_free_ret_1;
1169 c = tolower(c);
1170 } else if (c == '\n') {
1171 error("invalid key (newline): %s", key);
1172 goto out_free_ret_1;
1174 (*store_key)[i] = c;
1176 (*store_key)[i] = 0;
1178 return 0;
1180 out_free_ret_1:
1181 free(*store_key);
1182 return -CONFIG_INVALID_KEY;
1186 * If value==NULL, unset in (remove from) config,
1187 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1188 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1189 * else all matching key/values (regardless how many) are removed,
1190 * before the new pair is written.
1192 * Returns 0 on success.
1194 * This function does this:
1196 * - it locks the config file by creating ".git/config.lock"
1198 * - it then parses the config using store_aux() as validator to find
1199 * the position on the key/value pair to replace. If it is to be unset,
1200 * it must be found exactly once.
1202 * - the config file is mmap()ed and the part before the match (if any) is
1203 * written to the lock file, then the changed part and the rest.
1205 * - the config file is removed and the lock file rename()d to it.
1208 int git_config_set_multivar(const char *key, const char *value,
1209 const char *value_regex, int multi_replace)
1211 int fd = -1, in_fd;
1212 int ret;
1213 char *config_filename;
1214 struct lock_file *lock = NULL;
1216 if (config_exclusive_filename)
1217 config_filename = xstrdup(config_exclusive_filename);
1218 else
1219 config_filename = git_pathdup("config");
1221 /* parse-key returns negative; flip the sign to feed exit(3) */
1222 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1223 if (ret)
1224 goto out_free;
1226 store.multi_replace = multi_replace;
1230 * The lock serves a purpose in addition to locking: the new
1231 * contents of .git/config will be written into it.
1233 lock = xcalloc(sizeof(struct lock_file), 1);
1234 fd = hold_lock_file_for_update(lock, config_filename, 0);
1235 if (fd < 0) {
1236 error("could not lock config file %s: %s", config_filename, strerror(errno));
1237 free(store.key);
1238 ret = CONFIG_NO_LOCK;
1239 goto out_free;
1243 * If .git/config does not exist yet, write a minimal version.
1245 in_fd = open(config_filename, O_RDONLY);
1246 if ( in_fd < 0 ) {
1247 free(store.key);
1249 if ( ENOENT != errno ) {
1250 error("opening %s: %s", config_filename,
1251 strerror(errno));
1252 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1253 goto out_free;
1255 /* if nothing to unset, error out */
1256 if (value == NULL) {
1257 ret = CONFIG_NOTHING_SET;
1258 goto out_free;
1261 store.key = (char *)key;
1262 if (!store_write_section(fd, key) ||
1263 !store_write_pair(fd, key, value))
1264 goto write_err_out;
1265 } else {
1266 struct stat st;
1267 char *contents;
1268 size_t contents_sz, copy_begin, copy_end;
1269 int i, new_line = 0;
1271 if (value_regex == NULL)
1272 store.value_regex = NULL;
1273 else {
1274 if (value_regex[0] == '!') {
1275 store.do_not_match = 1;
1276 value_regex++;
1277 } else
1278 store.do_not_match = 0;
1280 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1281 if (regcomp(store.value_regex, value_regex,
1282 REG_EXTENDED)) {
1283 error("invalid pattern: %s", value_regex);
1284 free(store.value_regex);
1285 ret = CONFIG_INVALID_PATTERN;
1286 goto out_free;
1290 store.offset[0] = 0;
1291 store.state = START;
1292 store.seen = 0;
1295 * After this, store.offset will contain the *end* offset
1296 * of the last match, or remain at 0 if no match was found.
1297 * As a side effect, we make sure to transform only a valid
1298 * existing config file.
1300 if (git_config_from_file(store_aux, config_filename, NULL)) {
1301 error("invalid config file %s", config_filename);
1302 free(store.key);
1303 if (store.value_regex != NULL) {
1304 regfree(store.value_regex);
1305 free(store.value_regex);
1307 ret = CONFIG_INVALID_FILE;
1308 goto out_free;
1311 free(store.key);
1312 if (store.value_regex != NULL) {
1313 regfree(store.value_regex);
1314 free(store.value_regex);
1317 /* if nothing to unset, or too many matches, error out */
1318 if ((store.seen == 0 && value == NULL) ||
1319 (store.seen > 1 && multi_replace == 0)) {
1320 ret = CONFIG_NOTHING_SET;
1321 goto out_free;
1324 fstat(in_fd, &st);
1325 contents_sz = xsize_t(st.st_size);
1326 contents = xmmap(NULL, contents_sz, PROT_READ,
1327 MAP_PRIVATE, in_fd, 0);
1328 close(in_fd);
1330 if (store.seen == 0)
1331 store.seen = 1;
1333 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1334 if (store.offset[i] == 0) {
1335 store.offset[i] = copy_end = contents_sz;
1336 } else if (store.state != KEY_SEEN) {
1337 copy_end = store.offset[i];
1338 } else
1339 copy_end = find_beginning_of_line(
1340 contents, contents_sz,
1341 store.offset[i]-2, &new_line);
1343 if (copy_end > 0 && contents[copy_end-1] != '\n')
1344 new_line = 1;
1346 /* write the first part of the config */
1347 if (copy_end > copy_begin) {
1348 if (write_in_full(fd, contents + copy_begin,
1349 copy_end - copy_begin) <
1350 copy_end - copy_begin)
1351 goto write_err_out;
1352 if (new_line &&
1353 write_str_in_full(fd, "\n") != 1)
1354 goto write_err_out;
1356 copy_begin = store.offset[i];
1359 /* write the pair (value == NULL means unset) */
1360 if (value != NULL) {
1361 if (store.state == START) {
1362 if (!store_write_section(fd, key))
1363 goto write_err_out;
1365 if (!store_write_pair(fd, key, value))
1366 goto write_err_out;
1369 /* write the rest of the config */
1370 if (copy_begin < contents_sz)
1371 if (write_in_full(fd, contents + copy_begin,
1372 contents_sz - copy_begin) <
1373 contents_sz - copy_begin)
1374 goto write_err_out;
1376 munmap(contents, contents_sz);
1379 if (commit_lock_file(lock) < 0) {
1380 error("could not commit config file %s", config_filename);
1381 ret = CONFIG_NO_WRITE;
1382 goto out_free;
1386 * lock is committed, so don't try to roll it back below.
1387 * NOTE: Since lockfile.c keeps a linked list of all created
1388 * lock_file structures, it isn't safe to free(lock). It's
1389 * better to just leave it hanging around.
1391 lock = NULL;
1392 ret = 0;
1394 out_free:
1395 if (lock)
1396 rollback_lock_file(lock);
1397 free(config_filename);
1398 return ret;
1400 write_err_out:
1401 ret = write_error(lock->filename);
1402 goto out_free;
1406 static int section_name_match (const char *buf, const char *name)
1408 int i = 0, j = 0, dot = 0;
1409 if (buf[i] != '[')
1410 return 0;
1411 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1412 if (!dot && isspace(buf[i])) {
1413 dot = 1;
1414 if (name[j++] != '.')
1415 break;
1416 for (i++; isspace(buf[i]); i++)
1417 ; /* do nothing */
1418 if (buf[i] != '"')
1419 break;
1420 continue;
1422 if (buf[i] == '\\' && dot)
1423 i++;
1424 else if (buf[i] == '"' && dot) {
1425 for (i++; isspace(buf[i]); i++)
1426 ; /* do_nothing */
1427 break;
1429 if (buf[i] != name[j++])
1430 break;
1432 if (buf[i] == ']' && name[j] == 0) {
1434 * We match, now just find the right length offset by
1435 * gobbling up any whitespace after it, as well
1437 i++;
1438 for (; buf[i] && isspace(buf[i]); i++)
1439 ; /* do nothing */
1440 return i;
1442 return 0;
1445 /* if new_name == NULL, the section is removed instead */
1446 int git_config_rename_section(const char *old_name, const char *new_name)
1448 int ret = 0, remove = 0;
1449 char *config_filename;
1450 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1451 int out_fd;
1452 char buf[1024];
1453 FILE *config_file;
1455 if (config_exclusive_filename)
1456 config_filename = xstrdup(config_exclusive_filename);
1457 else
1458 config_filename = git_pathdup("config");
1459 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1460 if (out_fd < 0) {
1461 ret = error("could not lock config file %s", config_filename);
1462 goto out;
1465 if (!(config_file = fopen(config_filename, "rb"))) {
1466 /* no config file means nothing to rename, no error */
1467 goto unlock_and_out;
1470 while (fgets(buf, sizeof(buf), config_file)) {
1471 int i;
1472 int length;
1473 char *output = buf;
1474 for (i = 0; buf[i] && isspace(buf[i]); i++)
1475 ; /* do nothing */
1476 if (buf[i] == '[') {
1477 /* it's a section */
1478 int offset = section_name_match(&buf[i], old_name);
1479 if (offset > 0) {
1480 ret++;
1481 if (new_name == NULL) {
1482 remove = 1;
1483 continue;
1485 store.baselen = strlen(new_name);
1486 if (!store_write_section(out_fd, new_name)) {
1487 ret = write_error(lock->filename);
1488 goto out;
1491 * We wrote out the new section, with
1492 * a newline, now skip the old
1493 * section's length
1495 output += offset + i;
1496 if (strlen(output) > 0) {
1498 * More content means there's
1499 * a declaration to put on the
1500 * next line; indent with a
1501 * tab
1503 output -= 1;
1504 output[0] = '\t';
1507 remove = 0;
1509 if (remove)
1510 continue;
1511 length = strlen(output);
1512 if (write_in_full(out_fd, output, length) != length) {
1513 ret = write_error(lock->filename);
1514 goto out;
1517 fclose(config_file);
1518 unlock_and_out:
1519 if (commit_lock_file(lock) < 0)
1520 ret = error("could not commit config file %s", config_filename);
1521 out:
1522 free(config_filename);
1523 return ret;
1527 * Call this to report error for your variable that should not
1528 * get a boolean value (i.e. "[my] var" means "true").
1530 int config_error_nonbool(const char *var)
1532 return error("Missing value for '%s'", var);