add git-remote-hg
[git/srabbelier.git] / config.c
blob32c0b2c41e01a754060e73bbf20a7f0e9c43bb10
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 static FILE *config_file;
16 static const char *config_file_name;
17 static int config_linenr;
18 static int config_file_eof;
19 static int zlib_compression_seen;
21 const char *config_exclusive_filename = NULL;
23 struct config_item
25 struct config_item *next;
26 char *name;
27 char *value;
29 static struct config_item *config_parameters;
30 static struct config_item **config_parameters_tail = &config_parameters;
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)
53 struct config_item *ct;
54 struct strbuf tmp = STRBUF_INIT;
55 struct strbuf **pair;
56 strbuf_addstr(&tmp, text);
57 pair = strbuf_split(&tmp, '=');
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 -1;
65 ct = xcalloc(1, sizeof(struct config_item));
66 ct->name = strbuf_detach(pair[0], NULL);
67 if (pair[1]) {
68 strbuf_trim(pair[1]);
69 ct->value = strbuf_detach(pair[1], NULL);
71 strbuf_list_free(pair);
72 lowercase(ct->name);
73 *config_parameters_tail = ct;
74 config_parameters_tail = &ct->next;
75 return 0;
78 int git_config_parse_environment(void) {
79 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
80 char *envw;
81 const char **argv = NULL;
82 int nr = 0, alloc = 0;
83 int i;
85 if (!env)
86 return 0;
87 /* sq_dequote will write over it */
88 envw = xstrdup(env);
90 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
91 free(envw);
92 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
95 for (i = 0; i < nr; i++) {
96 if (git_config_parse_parameter(argv[i]) < 0) {
97 error("bogus config parameter: %s", argv[i]);
98 free(argv);
99 free(envw);
100 return -1;
104 free(argv);
105 free(envw);
106 return 0;
109 static int get_next_char(void)
111 int c;
112 FILE *f;
114 c = '\n';
115 if ((f = config_file) != NULL) {
116 c = fgetc(f);
117 if (c == '\r') {
118 /* DOS like systems */
119 c = fgetc(f);
120 if (c != '\n') {
121 ungetc(c, f);
122 c = '\r';
125 if (c == '\n')
126 config_linenr++;
127 if (c == EOF) {
128 config_file_eof = 1;
129 c = '\n';
132 return c;
135 static char *parse_value(void)
137 static char value[1024];
138 int quote = 0, comment = 0, len = 0, space = 0;
140 for (;;) {
141 int c = get_next_char();
142 if (len >= sizeof(value) - 1)
143 return NULL;
144 if (c == '\n') {
145 if (quote)
146 return NULL;
147 value[len] = 0;
148 return value;
150 if (comment)
151 continue;
152 if (isspace(c) && !quote) {
153 if (len)
154 space++;
155 continue;
157 if (!quote) {
158 if (c == ';' || c == '#') {
159 comment = 1;
160 continue;
163 for (; space; space--)
164 value[len++] = ' ';
165 if (c == '\\') {
166 c = get_next_char();
167 switch (c) {
168 case '\n':
169 continue;
170 case 't':
171 c = '\t';
172 break;
173 case 'b':
174 c = '\b';
175 break;
176 case 'n':
177 c = '\n';
178 break;
179 /* Some characters escape as themselves */
180 case '\\': case '"':
181 break;
182 /* Reject unknown escape sequences */
183 default:
184 return NULL;
186 value[len++] = c;
187 continue;
189 if (c == '"') {
190 quote = 1-quote;
191 continue;
193 value[len++] = c;
197 static inline int iskeychar(int c)
199 return isalnum(c) || c == '-';
202 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
204 int c;
205 char *value;
207 /* Get the full name */
208 for (;;) {
209 c = get_next_char();
210 if (config_file_eof)
211 break;
212 if (!iskeychar(c))
213 break;
214 name[len++] = tolower(c);
215 if (len >= MAXNAME)
216 return -1;
218 name[len] = 0;
219 while (c == ' ' || c == '\t')
220 c = get_next_char();
222 value = NULL;
223 if (c != '\n') {
224 if (c != '=')
225 return -1;
226 value = parse_value();
227 if (!value)
228 return -1;
230 return fn(name, value, data);
233 static int get_extended_base_var(char *name, int baselen, int c)
235 do {
236 if (c == '\n')
237 return -1;
238 c = get_next_char();
239 } while (isspace(c));
241 /* We require the format to be '[base "extension"]' */
242 if (c != '"')
243 return -1;
244 name[baselen++] = '.';
246 for (;;) {
247 int c = get_next_char();
248 if (c == '\n')
249 return -1;
250 if (c == '"')
251 break;
252 if (c == '\\') {
253 c = get_next_char();
254 if (c == '\n')
255 return -1;
257 name[baselen++] = c;
258 if (baselen > MAXNAME / 2)
259 return -1;
262 /* Final ']' */
263 if (get_next_char() != ']')
264 return -1;
265 return baselen;
268 static int get_base_var(char *name)
270 int baselen = 0;
272 for (;;) {
273 int c = get_next_char();
274 if (config_file_eof)
275 return -1;
276 if (c == ']')
277 return baselen;
278 if (isspace(c))
279 return get_extended_base_var(name, baselen, c);
280 if (!iskeychar(c) && c != '.')
281 return -1;
282 if (baselen > MAXNAME / 2)
283 return -1;
284 name[baselen++] = tolower(c);
288 static int git_parse_file(config_fn_t fn, void *data)
290 int comment = 0;
291 int baselen = 0;
292 static char var[MAXNAME];
294 /* U+FEFF Byte Order Mark in UTF8 */
295 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
296 const unsigned char *bomptr = utf8_bom;
298 for (;;) {
299 int c = get_next_char();
300 if (bomptr && *bomptr) {
301 /* We are at the file beginning; skip UTF8-encoded BOM
302 * if present. Sane editors won't put this in on their
303 * own, but e.g. Windows Notepad will do it happily. */
304 if ((unsigned char) c == *bomptr) {
305 bomptr++;
306 continue;
307 } else {
308 /* Do not tolerate partial BOM. */
309 if (bomptr != utf8_bom)
310 break;
311 /* No BOM at file beginning. Cool. */
312 bomptr = NULL;
315 if (c == '\n') {
316 if (config_file_eof)
317 return 0;
318 comment = 0;
319 continue;
321 if (comment || isspace(c))
322 continue;
323 if (c == '#' || c == ';') {
324 comment = 1;
325 continue;
327 if (c == '[') {
328 baselen = get_base_var(var);
329 if (baselen <= 0)
330 break;
331 var[baselen++] = '.';
332 var[baselen] = 0;
333 continue;
335 if (!isalpha(c))
336 break;
337 var[baselen] = tolower(c);
338 if (get_value(fn, data, var, baselen+1) < 0)
339 break;
341 die("bad config file line %d in %s", config_linenr, config_file_name);
344 static int parse_unit_factor(const char *end, unsigned long *val)
346 if (!*end)
347 return 1;
348 else if (!strcasecmp(end, "k")) {
349 *val *= 1024;
350 return 1;
352 else if (!strcasecmp(end, "m")) {
353 *val *= 1024 * 1024;
354 return 1;
356 else if (!strcasecmp(end, "g")) {
357 *val *= 1024 * 1024 * 1024;
358 return 1;
360 return 0;
363 static int git_parse_long(const char *value, long *ret)
365 if (value && *value) {
366 char *end;
367 long val = strtol(value, &end, 0);
368 unsigned long factor = 1;
369 if (!parse_unit_factor(end, &factor))
370 return 0;
371 *ret = val * factor;
372 return 1;
374 return 0;
377 int git_parse_ulong(const char *value, unsigned long *ret)
379 if (value && *value) {
380 char *end;
381 unsigned long val = strtoul(value, &end, 0);
382 if (!parse_unit_factor(end, &val))
383 return 0;
384 *ret = val;
385 return 1;
387 return 0;
390 static void die_bad_config(const char *name)
392 if (config_file_name)
393 die("bad config value for '%s' in %s", name, config_file_name);
394 die("bad config value for '%s'", name);
397 int git_config_int(const char *name, const char *value)
399 long ret = 0;
400 if (!git_parse_long(value, &ret))
401 die_bad_config(name);
402 return ret;
405 unsigned long git_config_ulong(const char *name, const char *value)
407 unsigned long ret;
408 if (!git_parse_ulong(value, &ret))
409 die_bad_config(name);
410 return ret;
413 static int git_config_maybe_bool_text(const char *name, const char *value)
415 if (!value)
416 return 1;
417 if (!*value)
418 return 0;
419 if (!strcasecmp(value, "true")
420 || !strcasecmp(value, "yes")
421 || !strcasecmp(value, "on"))
422 return 1;
423 if (!strcasecmp(value, "false")
424 || !strcasecmp(value, "no")
425 || !strcasecmp(value, "off"))
426 return 0;
427 return -1;
430 int git_config_maybe_bool(const char *name, const char *value)
432 int v = git_config_maybe_bool_text(name, value);
433 if (0 <= v)
434 return v;
435 if (!strcmp(value, "0"))
436 return 0;
437 if (!strcmp(value, "1"))
438 return 1;
439 return -1;
442 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
444 int v = git_config_maybe_bool_text(name, value);
445 if (0 <= v) {
446 *is_bool = 1;
447 return v;
449 *is_bool = 0;
450 return git_config_int(name, value);
453 int git_config_bool(const char *name, const char *value)
455 int discard;
456 return !!git_config_bool_or_int(name, value, &discard);
459 int git_config_string(const char **dest, const char *var, const char *value)
461 if (!value)
462 return config_error_nonbool(var);
463 *dest = xstrdup(value);
464 return 0;
467 int git_config_pathname(const char **dest, const char *var, const char *value)
469 if (!value)
470 return config_error_nonbool(var);
471 *dest = expand_user_path(value);
472 if (!*dest)
473 die("Failed to expand user dir in: '%s'", value);
474 return 0;
477 static int git_default_core_config(const char *var, const char *value)
479 /* This needs a better name */
480 if (!strcmp(var, "core.filemode")) {
481 trust_executable_bit = git_config_bool(var, value);
482 return 0;
484 if (!strcmp(var, "core.trustctime")) {
485 trust_ctime = git_config_bool(var, value);
486 return 0;
489 if (!strcmp(var, "core.quotepath")) {
490 quote_path_fully = git_config_bool(var, value);
491 return 0;
494 if (!strcmp(var, "core.symlinks")) {
495 has_symlinks = git_config_bool(var, value);
496 return 0;
499 if (!strcmp(var, "core.ignorecase")) {
500 ignore_case = git_config_bool(var, value);
501 return 0;
504 if (!strcmp(var, "core.abbrevguard")) {
505 unique_abbrev_extra_length = git_config_int(var, value);
506 if (unique_abbrev_extra_length < 0)
507 unique_abbrev_extra_length = 0;
508 return 0;
511 if (!strcmp(var, "core.bare")) {
512 is_bare_repository_cfg = git_config_bool(var, value);
513 return 0;
516 if (!strcmp(var, "core.ignorestat")) {
517 assume_unchanged = git_config_bool(var, value);
518 return 0;
521 if (!strcmp(var, "core.prefersymlinkrefs")) {
522 prefer_symlink_refs = git_config_bool(var, value);
523 return 0;
526 if (!strcmp(var, "core.logallrefupdates")) {
527 log_all_ref_updates = git_config_bool(var, value);
528 return 0;
531 if (!strcmp(var, "core.warnambiguousrefs")) {
532 warn_ambiguous_refs = git_config_bool(var, value);
533 return 0;
536 if (!strcmp(var, "core.loosecompression")) {
537 int level = git_config_int(var, value);
538 if (level == -1)
539 level = Z_DEFAULT_COMPRESSION;
540 else if (level < 0 || level > Z_BEST_COMPRESSION)
541 die("bad zlib compression level %d", level);
542 zlib_compression_level = level;
543 zlib_compression_seen = 1;
544 return 0;
547 if (!strcmp(var, "core.compression")) {
548 int level = git_config_int(var, value);
549 if (level == -1)
550 level = Z_DEFAULT_COMPRESSION;
551 else if (level < 0 || level > Z_BEST_COMPRESSION)
552 die("bad zlib compression level %d", level);
553 core_compression_level = level;
554 core_compression_seen = 1;
555 if (!zlib_compression_seen)
556 zlib_compression_level = level;
557 return 0;
560 if (!strcmp(var, "core.packedgitwindowsize")) {
561 int pgsz_x2 = getpagesize() * 2;
562 packed_git_window_size = git_config_int(var, value);
564 /* This value must be multiple of (pagesize * 2) */
565 packed_git_window_size /= pgsz_x2;
566 if (packed_git_window_size < 1)
567 packed_git_window_size = 1;
568 packed_git_window_size *= pgsz_x2;
569 return 0;
572 if (!strcmp(var, "core.packedgitlimit")) {
573 packed_git_limit = git_config_int(var, value);
574 return 0;
577 if (!strcmp(var, "core.deltabasecachelimit")) {
578 delta_base_cache_limit = git_config_int(var, value);
579 return 0;
582 if (!strcmp(var, "core.autocrlf")) {
583 if (value && !strcasecmp(value, "input")) {
584 if (eol == EOL_CRLF)
585 return error("core.autocrlf=input conflicts with core.eol=crlf");
586 auto_crlf = AUTO_CRLF_INPUT;
587 return 0;
589 auto_crlf = git_config_bool(var, value);
590 return 0;
593 if (!strcmp(var, "core.safecrlf")) {
594 if (value && !strcasecmp(value, "warn")) {
595 safe_crlf = SAFE_CRLF_WARN;
596 return 0;
598 safe_crlf = git_config_bool(var, value);
599 return 0;
602 if (!strcmp(var, "core.eol")) {
603 if (value && !strcasecmp(value, "lf"))
604 eol = EOL_LF;
605 else if (value && !strcasecmp(value, "crlf"))
606 eol = EOL_CRLF;
607 else if (value && !strcasecmp(value, "native"))
608 eol = EOL_NATIVE;
609 else
610 eol = EOL_UNSET;
611 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
612 return error("core.autocrlf=input conflicts with core.eol=crlf");
613 return 0;
616 if (!strcmp(var, "core.notesref")) {
617 notes_ref_name = xstrdup(value);
618 return 0;
621 if (!strcmp(var, "core.pager"))
622 return git_config_string(&pager_program, var, value);
624 if (!strcmp(var, "core.editor"))
625 return git_config_string(&editor_program, var, value);
627 if (!strcmp(var, "core.askpass"))
628 return git_config_string(&askpass_program, var, value);
630 if (!strcmp(var, "core.excludesfile"))
631 return git_config_pathname(&excludes_file, var, value);
633 if (!strcmp(var, "core.whitespace")) {
634 if (!value)
635 return config_error_nonbool(var);
636 whitespace_rule_cfg = parse_whitespace_rule(value);
637 return 0;
640 if (!strcmp(var, "core.fsyncobjectfiles")) {
641 fsync_object_files = git_config_bool(var, value);
642 return 0;
645 if (!strcmp(var, "core.preloadindex")) {
646 core_preload_index = git_config_bool(var, value);
647 return 0;
650 if (!strcmp(var, "core.createobject")) {
651 if (!strcmp(value, "rename"))
652 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
653 else if (!strcmp(value, "link"))
654 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
655 else
656 die("Invalid mode for object creation: %s", value);
657 return 0;
660 if (!strcmp(var, "core.sparsecheckout")) {
661 core_apply_sparse_checkout = git_config_bool(var, value);
662 return 0;
665 /* Add other config variables here and to Documentation/config.txt. */
666 return 0;
669 static int git_default_user_config(const char *var, const char *value)
671 if (!strcmp(var, "user.name")) {
672 if (!value)
673 return config_error_nonbool(var);
674 strlcpy(git_default_name, value, sizeof(git_default_name));
675 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
676 return 0;
679 if (!strcmp(var, "user.email")) {
680 if (!value)
681 return config_error_nonbool(var);
682 strlcpy(git_default_email, value, sizeof(git_default_email));
683 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
684 return 0;
687 /* Add other config variables here and to Documentation/config.txt. */
688 return 0;
691 static int git_default_i18n_config(const char *var, const char *value)
693 if (!strcmp(var, "i18n.commitencoding"))
694 return git_config_string(&git_commit_encoding, var, value);
696 if (!strcmp(var, "i18n.logoutputencoding"))
697 return git_config_string(&git_log_output_encoding, var, value);
699 /* Add other config variables here and to Documentation/config.txt. */
700 return 0;
703 static int git_default_branch_config(const char *var, const char *value)
705 if (!strcmp(var, "branch.autosetupmerge")) {
706 if (value && !strcasecmp(value, "always")) {
707 git_branch_track = BRANCH_TRACK_ALWAYS;
708 return 0;
710 git_branch_track = git_config_bool(var, value);
711 return 0;
713 if (!strcmp(var, "branch.autosetuprebase")) {
714 if (!value)
715 return config_error_nonbool(var);
716 else if (!strcmp(value, "never"))
717 autorebase = AUTOREBASE_NEVER;
718 else if (!strcmp(value, "local"))
719 autorebase = AUTOREBASE_LOCAL;
720 else if (!strcmp(value, "remote"))
721 autorebase = AUTOREBASE_REMOTE;
722 else if (!strcmp(value, "always"))
723 autorebase = AUTOREBASE_ALWAYS;
724 else
725 return error("Malformed value for %s", var);
726 return 0;
729 /* Add other config variables here and to Documentation/config.txt. */
730 return 0;
733 static int git_default_push_config(const char *var, const char *value)
735 if (!strcmp(var, "push.default")) {
736 if (!value)
737 return config_error_nonbool(var);
738 else if (!strcmp(value, "nothing"))
739 push_default = PUSH_DEFAULT_NOTHING;
740 else if (!strcmp(value, "matching"))
741 push_default = PUSH_DEFAULT_MATCHING;
742 else if (!strcmp(value, "tracking"))
743 push_default = PUSH_DEFAULT_TRACKING;
744 else if (!strcmp(value, "current"))
745 push_default = PUSH_DEFAULT_CURRENT;
746 else {
747 error("Malformed value for %s: %s", var, value);
748 return error("Must be one of nothing, matching, "
749 "tracking or current.");
751 return 0;
754 /* Add other config variables here and to Documentation/config.txt. */
755 return 0;
758 static int git_default_mailmap_config(const char *var, const char *value)
760 if (!strcmp(var, "mailmap.file"))
761 return git_config_string(&git_mailmap_file, var, value);
763 /* Add other config variables here and to Documentation/config.txt. */
764 return 0;
767 int git_default_config(const char *var, const char *value, void *dummy)
769 if (!prefixcmp(var, "core."))
770 return git_default_core_config(var, value);
772 if (!prefixcmp(var, "user."))
773 return git_default_user_config(var, value);
775 if (!prefixcmp(var, "i18n."))
776 return git_default_i18n_config(var, value);
778 if (!prefixcmp(var, "branch."))
779 return git_default_branch_config(var, value);
781 if (!prefixcmp(var, "push."))
782 return git_default_push_config(var, value);
784 if (!prefixcmp(var, "mailmap."))
785 return git_default_mailmap_config(var, value);
787 if (!prefixcmp(var, "advice."))
788 return git_default_advice_config(var, value);
790 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
791 pager_use_color = git_config_bool(var,value);
792 return 0;
795 /* Add other config variables here and to Documentation/config.txt. */
796 return 0;
799 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
801 int ret;
802 FILE *f = fopen(filename, "r");
804 ret = -1;
805 if (f) {
806 config_file = f;
807 config_file_name = filename;
808 config_linenr = 1;
809 config_file_eof = 0;
810 ret = git_parse_file(fn, data);
811 fclose(f);
812 config_file_name = NULL;
814 return ret;
817 const char *git_etc_gitconfig(void)
819 static const char *system_wide;
820 if (!system_wide)
821 system_wide = system_path(ETC_GITCONFIG);
822 return system_wide;
825 int git_env_bool(const char *k, int def)
827 const char *v = getenv(k);
828 return v ? git_config_bool(k, v) : def;
831 int git_config_system(void)
833 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
836 int git_config_global(void)
838 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
841 int git_config_from_parameters(config_fn_t fn, void *data)
843 static int loaded_environment;
844 const struct config_item *ct;
846 if (!loaded_environment) {
847 if (git_config_parse_environment() < 0)
848 return -1;
849 loaded_environment = 1;
851 for (ct = config_parameters; ct; ct = ct->next)
852 if (fn(ct->name, ct->value, data) < 0)
853 return -1;
854 return 0;
857 int git_config(config_fn_t fn, void *data)
859 int ret = 0, found = 0;
860 char *repo_config = NULL;
861 const char *home = NULL;
863 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
864 if (config_exclusive_filename)
865 return git_config_from_file(fn, config_exclusive_filename, data);
866 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
867 ret += git_config_from_file(fn, git_etc_gitconfig(),
868 data);
869 found += 1;
872 home = getenv("HOME");
873 if (git_config_global() && home) {
874 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
875 if (!access(user_config, R_OK)) {
876 ret += git_config_from_file(fn, user_config, data);
877 found += 1;
879 free(user_config);
882 repo_config = git_pathdup("config");
883 if (!access(repo_config, R_OK)) {
884 ret += git_config_from_file(fn, repo_config, data);
885 found += 1;
887 free(repo_config);
889 ret += git_config_from_parameters(fn, data);
890 if (config_parameters)
891 found += 1;
893 return ret == 0 ? found : ret;
897 * Find all the stuff for git_config_set() below.
900 #define MAX_MATCHES 512
902 static struct {
903 int baselen;
904 char *key;
905 int do_not_match;
906 regex_t *value_regex;
907 int multi_replace;
908 size_t offset[MAX_MATCHES];
909 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
910 int seen;
911 } store;
913 static int matches(const char *key, const char *value)
915 return !strcmp(key, store.key) &&
916 (store.value_regex == NULL ||
917 (store.do_not_match ^
918 !regexec(store.value_regex, value, 0, NULL, 0)));
921 static int store_aux(const char *key, const char *value, void *cb)
923 const char *ep;
924 size_t section_len;
926 switch (store.state) {
927 case KEY_SEEN:
928 if (matches(key, value)) {
929 if (store.seen == 1 && store.multi_replace == 0) {
930 warning("%s has multiple values", key);
931 } else if (store.seen >= MAX_MATCHES) {
932 error("too many matches for %s", key);
933 return 1;
936 store.offset[store.seen] = ftell(config_file);
937 store.seen++;
939 break;
940 case SECTION_SEEN:
942 * What we are looking for is in store.key (both
943 * section and var), and its section part is baselen
944 * long. We found key (again, both section and var).
945 * We would want to know if this key is in the same
946 * section as what we are looking for. We already
947 * know we are in the same section as what should
948 * hold store.key.
950 ep = strrchr(key, '.');
951 section_len = ep - key;
953 if ((section_len != store.baselen) ||
954 memcmp(key, store.key, section_len+1)) {
955 store.state = SECTION_END_SEEN;
956 break;
960 * Do not increment matches: this is no match, but we
961 * just made sure we are in the desired section.
963 store.offset[store.seen] = ftell(config_file);
964 /* fallthru */
965 case SECTION_END_SEEN:
966 case START:
967 if (matches(key, value)) {
968 store.offset[store.seen] = ftell(config_file);
969 store.state = KEY_SEEN;
970 store.seen++;
971 } else {
972 if (strrchr(key, '.') - key == store.baselen &&
973 !strncmp(key, store.key, store.baselen)) {
974 store.state = SECTION_SEEN;
975 store.offset[store.seen] = ftell(config_file);
979 return 0;
982 static int write_error(const char *filename)
984 error("failed to write new configuration file %s", filename);
986 /* Same error code as "failed to rename". */
987 return 4;
990 static int store_write_section(int fd, const char *key)
992 const char *dot;
993 int i, success;
994 struct strbuf sb = STRBUF_INIT;
996 dot = memchr(key, '.', store.baselen);
997 if (dot) {
998 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
999 for (i = dot - key + 1; i < store.baselen; i++) {
1000 if (key[i] == '"' || key[i] == '\\')
1001 strbuf_addch(&sb, '\\');
1002 strbuf_addch(&sb, key[i]);
1004 strbuf_addstr(&sb, "\"]\n");
1005 } else {
1006 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1009 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1010 strbuf_release(&sb);
1012 return success;
1015 static int store_write_pair(int fd, const char *key, const char *value)
1017 int i, success;
1018 int length = strlen(key + store.baselen + 1);
1019 const char *quote = "";
1020 struct strbuf sb = STRBUF_INIT;
1023 * Check to see if the value needs to be surrounded with a dq pair.
1024 * Note that problematic characters are always backslash-quoted; this
1025 * check is about not losing leading or trailing SP and strings that
1026 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1027 * configuration parser.
1029 if (value[0] == ' ')
1030 quote = "\"";
1031 for (i = 0; value[i]; i++)
1032 if (value[i] == ';' || value[i] == '#')
1033 quote = "\"";
1034 if (i && value[i - 1] == ' ')
1035 quote = "\"";
1037 strbuf_addf(&sb, "\t%.*s = %s",
1038 length, key + store.baselen + 1, quote);
1040 for (i = 0; value[i]; i++)
1041 switch (value[i]) {
1042 case '\n':
1043 strbuf_addstr(&sb, "\\n");
1044 break;
1045 case '\t':
1046 strbuf_addstr(&sb, "\\t");
1047 break;
1048 case '"':
1049 case '\\':
1050 strbuf_addch(&sb, '\\');
1051 default:
1052 strbuf_addch(&sb, value[i]);
1053 break;
1055 strbuf_addf(&sb, "%s\n", quote);
1057 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1058 strbuf_release(&sb);
1060 return success;
1063 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1064 size_t offset_, int *found_bracket)
1066 size_t equal_offset = size, bracket_offset = size;
1067 ssize_t offset;
1069 contline:
1070 for (offset = offset_-2; offset > 0
1071 && contents[offset] != '\n'; offset--)
1072 switch (contents[offset]) {
1073 case '=': equal_offset = offset; break;
1074 case ']': bracket_offset = offset; break;
1076 if (offset > 0 && contents[offset-1] == '\\') {
1077 offset_ = offset;
1078 goto contline;
1080 if (bracket_offset < equal_offset) {
1081 *found_bracket = 1;
1082 offset = bracket_offset+1;
1083 } else
1084 offset++;
1086 return offset;
1089 int git_config_set(const char *key, const char *value)
1091 return git_config_set_multivar(key, value, NULL, 0);
1095 * If value==NULL, unset in (remove from) config,
1096 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1097 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1098 * else all matching key/values (regardless how many) are removed,
1099 * before the new pair is written.
1101 * Returns 0 on success.
1103 * This function does this:
1105 * - it locks the config file by creating ".git/config.lock"
1107 * - it then parses the config using store_aux() as validator to find
1108 * the position on the key/value pair to replace. If it is to be unset,
1109 * it must be found exactly once.
1111 * - the config file is mmap()ed and the part before the match (if any) is
1112 * written to the lock file, then the changed part and the rest.
1114 * - the config file is removed and the lock file rename()d to it.
1117 int git_config_set_multivar(const char *key, const char *value,
1118 const char *value_regex, int multi_replace)
1120 int i, dot;
1121 int fd = -1, in_fd;
1122 int ret;
1123 char *config_filename;
1124 struct lock_file *lock = NULL;
1125 const char *last_dot = strrchr(key, '.');
1127 if (config_exclusive_filename)
1128 config_filename = xstrdup(config_exclusive_filename);
1129 else
1130 config_filename = git_pathdup("config");
1133 * Since "key" actually contains the section name and the real
1134 * key name separated by a dot, we have to know where the dot is.
1137 if (last_dot == NULL) {
1138 error("key does not contain a section: %s", key);
1139 ret = 2;
1140 goto out_free;
1142 store.baselen = last_dot - key;
1144 store.multi_replace = multi_replace;
1147 * Validate the key and while at it, lower case it for matching.
1149 store.key = xmalloc(strlen(key) + 1);
1150 dot = 0;
1151 for (i = 0; key[i]; i++) {
1152 unsigned char c = key[i];
1153 if (c == '.')
1154 dot = 1;
1155 /* Leave the extended basename untouched.. */
1156 if (!dot || i > store.baselen) {
1157 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
1158 error("invalid key: %s", key);
1159 free(store.key);
1160 ret = 1;
1161 goto out_free;
1163 c = tolower(c);
1164 } else if (c == '\n') {
1165 error("invalid key (newline): %s", key);
1166 free(store.key);
1167 ret = 1;
1168 goto out_free;
1170 store.key[i] = c;
1172 store.key[i] = 0;
1175 * The lock serves a purpose in addition to locking: the new
1176 * contents of .git/config will be written into it.
1178 lock = xcalloc(sizeof(struct lock_file), 1);
1179 fd = hold_lock_file_for_update(lock, config_filename, 0);
1180 if (fd < 0) {
1181 error("could not lock config file %s: %s", config_filename, strerror(errno));
1182 free(store.key);
1183 ret = -1;
1184 goto out_free;
1188 * If .git/config does not exist yet, write a minimal version.
1190 in_fd = open(config_filename, O_RDONLY);
1191 if ( in_fd < 0 ) {
1192 free(store.key);
1194 if ( ENOENT != errno ) {
1195 error("opening %s: %s", config_filename,
1196 strerror(errno));
1197 ret = 3; /* same as "invalid config file" */
1198 goto out_free;
1200 /* if nothing to unset, error out */
1201 if (value == NULL) {
1202 ret = 5;
1203 goto out_free;
1206 store.key = (char *)key;
1207 if (!store_write_section(fd, key) ||
1208 !store_write_pair(fd, key, value))
1209 goto write_err_out;
1210 } else {
1211 struct stat st;
1212 char *contents;
1213 size_t contents_sz, copy_begin, copy_end;
1214 int i, new_line = 0;
1216 if (value_regex == NULL)
1217 store.value_regex = NULL;
1218 else {
1219 if (value_regex[0] == '!') {
1220 store.do_not_match = 1;
1221 value_regex++;
1222 } else
1223 store.do_not_match = 0;
1225 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1226 if (regcomp(store.value_regex, value_regex,
1227 REG_EXTENDED)) {
1228 error("invalid pattern: %s", value_regex);
1229 free(store.value_regex);
1230 ret = 6;
1231 goto out_free;
1235 store.offset[0] = 0;
1236 store.state = START;
1237 store.seen = 0;
1240 * After this, store.offset will contain the *end* offset
1241 * of the last match, or remain at 0 if no match was found.
1242 * As a side effect, we make sure to transform only a valid
1243 * existing config file.
1245 if (git_config_from_file(store_aux, config_filename, NULL)) {
1246 error("invalid config file %s", config_filename);
1247 free(store.key);
1248 if (store.value_regex != NULL) {
1249 regfree(store.value_regex);
1250 free(store.value_regex);
1252 ret = 3;
1253 goto out_free;
1256 free(store.key);
1257 if (store.value_regex != NULL) {
1258 regfree(store.value_regex);
1259 free(store.value_regex);
1262 /* if nothing to unset, or too many matches, error out */
1263 if ((store.seen == 0 && value == NULL) ||
1264 (store.seen > 1 && multi_replace == 0)) {
1265 ret = 5;
1266 goto out_free;
1269 fstat(in_fd, &st);
1270 contents_sz = xsize_t(st.st_size);
1271 contents = xmmap(NULL, contents_sz, PROT_READ,
1272 MAP_PRIVATE, in_fd, 0);
1273 close(in_fd);
1275 if (store.seen == 0)
1276 store.seen = 1;
1278 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1279 if (store.offset[i] == 0) {
1280 store.offset[i] = copy_end = contents_sz;
1281 } else if (store.state != KEY_SEEN) {
1282 copy_end = store.offset[i];
1283 } else
1284 copy_end = find_beginning_of_line(
1285 contents, contents_sz,
1286 store.offset[i]-2, &new_line);
1288 if (copy_end > 0 && contents[copy_end-1] != '\n')
1289 new_line = 1;
1291 /* write the first part of the config */
1292 if (copy_end > copy_begin) {
1293 if (write_in_full(fd, contents + copy_begin,
1294 copy_end - copy_begin) <
1295 copy_end - copy_begin)
1296 goto write_err_out;
1297 if (new_line &&
1298 write_str_in_full(fd, "\n") != 1)
1299 goto write_err_out;
1301 copy_begin = store.offset[i];
1304 /* write the pair (value == NULL means unset) */
1305 if (value != NULL) {
1306 if (store.state == START) {
1307 if (!store_write_section(fd, key))
1308 goto write_err_out;
1310 if (!store_write_pair(fd, key, value))
1311 goto write_err_out;
1314 /* write the rest of the config */
1315 if (copy_begin < contents_sz)
1316 if (write_in_full(fd, contents + copy_begin,
1317 contents_sz - copy_begin) <
1318 contents_sz - copy_begin)
1319 goto write_err_out;
1321 munmap(contents, contents_sz);
1324 if (commit_lock_file(lock) < 0) {
1325 error("could not commit config file %s", config_filename);
1326 ret = 4;
1327 goto out_free;
1331 * lock is committed, so don't try to roll it back below.
1332 * NOTE: Since lockfile.c keeps a linked list of all created
1333 * lock_file structures, it isn't safe to free(lock). It's
1334 * better to just leave it hanging around.
1336 lock = NULL;
1337 ret = 0;
1339 out_free:
1340 if (lock)
1341 rollback_lock_file(lock);
1342 free(config_filename);
1343 return ret;
1345 write_err_out:
1346 ret = write_error(lock->filename);
1347 goto out_free;
1351 static int section_name_match (const char *buf, const char *name)
1353 int i = 0, j = 0, dot = 0;
1354 if (buf[i] != '[')
1355 return 0;
1356 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1357 if (!dot && isspace(buf[i])) {
1358 dot = 1;
1359 if (name[j++] != '.')
1360 break;
1361 for (i++; isspace(buf[i]); i++)
1362 ; /* do nothing */
1363 if (buf[i] != '"')
1364 break;
1365 continue;
1367 if (buf[i] == '\\' && dot)
1368 i++;
1369 else if (buf[i] == '"' && dot) {
1370 for (i++; isspace(buf[i]); i++)
1371 ; /* do_nothing */
1372 break;
1374 if (buf[i] != name[j++])
1375 break;
1377 if (buf[i] == ']' && name[j] == 0) {
1379 * We match, now just find the right length offset by
1380 * gobbling up any whitespace after it, as well
1382 i++;
1383 for (; buf[i] && isspace(buf[i]); i++)
1384 ; /* do nothing */
1385 return i;
1387 return 0;
1390 /* if new_name == NULL, the section is removed instead */
1391 int git_config_rename_section(const char *old_name, const char *new_name)
1393 int ret = 0, remove = 0;
1394 char *config_filename;
1395 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1396 int out_fd;
1397 char buf[1024];
1399 if (config_exclusive_filename)
1400 config_filename = xstrdup(config_exclusive_filename);
1401 else
1402 config_filename = git_pathdup("config");
1403 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1404 if (out_fd < 0) {
1405 ret = error("could not lock config file %s", config_filename);
1406 goto out;
1409 if (!(config_file = fopen(config_filename, "rb"))) {
1410 /* no config file means nothing to rename, no error */
1411 goto unlock_and_out;
1414 while (fgets(buf, sizeof(buf), config_file)) {
1415 int i;
1416 int length;
1417 char *output = buf;
1418 for (i = 0; buf[i] && isspace(buf[i]); i++)
1419 ; /* do nothing */
1420 if (buf[i] == '[') {
1421 /* it's a section */
1422 int offset = section_name_match(&buf[i], old_name);
1423 if (offset > 0) {
1424 ret++;
1425 if (new_name == NULL) {
1426 remove = 1;
1427 continue;
1429 store.baselen = strlen(new_name);
1430 if (!store_write_section(out_fd, new_name)) {
1431 ret = write_error(lock->filename);
1432 goto out;
1435 * We wrote out the new section, with
1436 * a newline, now skip the old
1437 * section's length
1439 output += offset + i;
1440 if (strlen(output) > 0) {
1442 * More content means there's
1443 * a declaration to put on the
1444 * next line; indent with a
1445 * tab
1447 output -= 1;
1448 output[0] = '\t';
1451 remove = 0;
1453 if (remove)
1454 continue;
1455 length = strlen(output);
1456 if (write_in_full(out_fd, output, length) != length) {
1457 ret = write_error(lock->filename);
1458 goto out;
1461 fclose(config_file);
1462 unlock_and_out:
1463 if (commit_lock_file(lock) < 0)
1464 ret = error("could not commit config file %s", config_filename);
1465 out:
1466 free(config_filename);
1467 return ret;
1471 * Call this to report error for your variable that should not
1472 * get a boolean value (i.e. "[my] var" means "true").
1474 int config_error_nonbool(const char *var)
1476 return error("Missing value for '%s'", var);