Merge branch 'jn/format-patch-doc' into maint
[git/mjg.git] / config.c
blobd06fb19d511c29e92aa840c664618ca4a6f73fe6
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 {
24 struct config_item *next;
25 char *name;
26 char *value;
28 static struct config_item *config_parameters;
29 static struct config_item **config_parameters_tail = &config_parameters;
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)
52 struct config_item *ct;
53 struct strbuf tmp = STRBUF_INIT;
54 struct strbuf **pair;
55 strbuf_addstr(&tmp, text);
56 pair = strbuf_split(&tmp, '=');
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 -1;
64 ct = xcalloc(1, sizeof(struct config_item));
65 ct->name = strbuf_detach(pair[0], NULL);
66 if (pair[1]) {
67 strbuf_trim(pair[1]);
68 ct->value = strbuf_detach(pair[1], NULL);
70 strbuf_list_free(pair);
71 lowercase(ct->name);
72 *config_parameters_tail = ct;
73 config_parameters_tail = &ct->next;
74 return 0;
77 int git_config_parse_environment(void) {
78 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
79 char *envw;
80 const char **argv = NULL;
81 int nr = 0, alloc = 0;
82 int i;
84 if (!env)
85 return 0;
86 /* sq_dequote will write over it */
87 envw = xstrdup(env);
89 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
90 free(envw);
91 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
94 for (i = 0; i < nr; i++) {
95 if (git_config_parse_parameter(argv[i]) < 0) {
96 error("bogus config parameter: %s", argv[i]);
97 free(argv);
98 free(envw);
99 return -1;
103 free(argv);
104 free(envw);
105 return 0;
108 static int get_next_char(void)
110 int c;
111 FILE *f;
113 c = '\n';
114 if ((f = config_file) != NULL) {
115 c = fgetc(f);
116 if (c == '\r') {
117 /* DOS like systems */
118 c = fgetc(f);
119 if (c != '\n') {
120 ungetc(c, f);
121 c = '\r';
124 if (c == '\n')
125 config_linenr++;
126 if (c == EOF) {
127 config_file_eof = 1;
128 c = '\n';
131 return c;
134 static char *parse_value(void)
136 static char value[1024];
137 int quote = 0, comment = 0, len = 0, space = 0;
139 for (;;) {
140 int c = get_next_char();
141 if (len >= sizeof(value) - 1)
142 return NULL;
143 if (c == '\n') {
144 if (quote)
145 return NULL;
146 value[len] = 0;
147 return value;
149 if (comment)
150 continue;
151 if (isspace(c) && !quote) {
152 if (len)
153 space++;
154 continue;
156 if (!quote) {
157 if (c == ';' || c == '#') {
158 comment = 1;
159 continue;
162 for (; space; space--)
163 value[len++] = ' ';
164 if (c == '\\') {
165 c = get_next_char();
166 switch (c) {
167 case '\n':
168 continue;
169 case 't':
170 c = '\t';
171 break;
172 case 'b':
173 c = '\b';
174 break;
175 case 'n':
176 c = '\n';
177 break;
178 /* Some characters escape as themselves */
179 case '\\': case '"':
180 break;
181 /* Reject unknown escape sequences */
182 default:
183 return NULL;
185 value[len++] = c;
186 continue;
188 if (c == '"') {
189 quote = 1-quote;
190 continue;
192 value[len++] = c;
196 static inline int iskeychar(int c)
198 return isalnum(c) || c == '-';
201 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
203 int c;
204 char *value;
206 /* Get the full name */
207 for (;;) {
208 c = get_next_char();
209 if (config_file_eof)
210 break;
211 if (!iskeychar(c))
212 break;
213 name[len++] = tolower(c);
214 if (len >= MAXNAME)
215 return -1;
217 name[len] = 0;
218 while (c == ' ' || c == '\t')
219 c = get_next_char();
221 value = NULL;
222 if (c != '\n') {
223 if (c != '=')
224 return -1;
225 value = parse_value();
226 if (!value)
227 return -1;
229 return fn(name, value, data);
232 static int get_extended_base_var(char *name, int baselen, int c)
234 do {
235 if (c == '\n')
236 return -1;
237 c = get_next_char();
238 } while (isspace(c));
240 /* We require the format to be '[base "extension"]' */
241 if (c != '"')
242 return -1;
243 name[baselen++] = '.';
245 for (;;) {
246 int c = get_next_char();
247 if (c == '\n')
248 return -1;
249 if (c == '"')
250 break;
251 if (c == '\\') {
252 c = get_next_char();
253 if (c == '\n')
254 return -1;
256 name[baselen++] = c;
257 if (baselen > MAXNAME / 2)
258 return -1;
261 /* Final ']' */
262 if (get_next_char() != ']')
263 return -1;
264 return baselen;
267 static int get_base_var(char *name)
269 int baselen = 0;
271 for (;;) {
272 int c = get_next_char();
273 if (config_file_eof)
274 return -1;
275 if (c == ']')
276 return baselen;
277 if (isspace(c))
278 return get_extended_base_var(name, baselen, c);
279 if (!iskeychar(c) && c != '.')
280 return -1;
281 if (baselen > MAXNAME / 2)
282 return -1;
283 name[baselen++] = tolower(c);
287 static int git_parse_file(config_fn_t fn, void *data)
289 int comment = 0;
290 int baselen = 0;
291 static char var[MAXNAME];
293 /* U+FEFF Byte Order Mark in UTF8 */
294 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
295 const unsigned char *bomptr = utf8_bom;
297 for (;;) {
298 int c = get_next_char();
299 if (bomptr && *bomptr) {
300 /* We are at the file beginning; skip UTF8-encoded BOM
301 * if present. Sane editors won't put this in on their
302 * own, but e.g. Windows Notepad will do it happily. */
303 if ((unsigned char) c == *bomptr) {
304 bomptr++;
305 continue;
306 } else {
307 /* Do not tolerate partial BOM. */
308 if (bomptr != utf8_bom)
309 break;
310 /* No BOM at file beginning. Cool. */
311 bomptr = NULL;
314 if (c == '\n') {
315 if (config_file_eof)
316 return 0;
317 comment = 0;
318 continue;
320 if (comment || isspace(c))
321 continue;
322 if (c == '#' || c == ';') {
323 comment = 1;
324 continue;
326 if (c == '[') {
327 baselen = get_base_var(var);
328 if (baselen <= 0)
329 break;
330 var[baselen++] = '.';
331 var[baselen] = 0;
332 continue;
334 if (!isalpha(c))
335 break;
336 var[baselen] = tolower(c);
337 if (get_value(fn, data, var, baselen+1) < 0)
338 break;
340 die("bad config file line %d in %s", config_linenr, config_file_name);
343 static int parse_unit_factor(const char *end, unsigned long *val)
345 if (!*end)
346 return 1;
347 else if (!strcasecmp(end, "k")) {
348 *val *= 1024;
349 return 1;
351 else if (!strcasecmp(end, "m")) {
352 *val *= 1024 * 1024;
353 return 1;
355 else if (!strcasecmp(end, "g")) {
356 *val *= 1024 * 1024 * 1024;
357 return 1;
359 return 0;
362 static int git_parse_long(const char *value, long *ret)
364 if (value && *value) {
365 char *end;
366 long val = strtol(value, &end, 0);
367 unsigned long factor = 1;
368 if (!parse_unit_factor(end, &factor))
369 return 0;
370 *ret = val * factor;
371 return 1;
373 return 0;
376 int git_parse_ulong(const char *value, unsigned long *ret)
378 if (value && *value) {
379 char *end;
380 unsigned long val = strtoul(value, &end, 0);
381 if (!parse_unit_factor(end, &val))
382 return 0;
383 *ret = val;
384 return 1;
386 return 0;
389 static void die_bad_config(const char *name)
391 if (config_file_name)
392 die("bad config value for '%s' in %s", name, config_file_name);
393 die("bad config value for '%s'", name);
396 int git_config_int(const char *name, const char *value)
398 long ret = 0;
399 if (!git_parse_long(value, &ret))
400 die_bad_config(name);
401 return ret;
404 unsigned long git_config_ulong(const char *name, const char *value)
406 unsigned long ret;
407 if (!git_parse_ulong(value, &ret))
408 die_bad_config(name);
409 return ret;
412 static int git_config_maybe_bool_text(const char *name, const char *value)
414 if (!value)
415 return 1;
416 if (!*value)
417 return 0;
418 if (!strcasecmp(value, "true")
419 || !strcasecmp(value, "yes")
420 || !strcasecmp(value, "on"))
421 return 1;
422 if (!strcasecmp(value, "false")
423 || !strcasecmp(value, "no")
424 || !strcasecmp(value, "off"))
425 return 0;
426 return -1;
429 int git_config_maybe_bool(const char *name, const char *value)
431 long v = git_config_maybe_bool_text(name, value);
432 if (0 <= v)
433 return v;
434 if (git_parse_long(value, &v))
435 return !!v;
436 return -1;
439 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
441 int v = git_config_maybe_bool_text(name, value);
442 if (0 <= v) {
443 *is_bool = 1;
444 return v;
446 *is_bool = 0;
447 return git_config_int(name, value);
450 int git_config_bool(const char *name, const char *value)
452 int discard;
453 return !!git_config_bool_or_int(name, value, &discard);
456 int git_config_string(const char **dest, const char *var, const char *value)
458 if (!value)
459 return config_error_nonbool(var);
460 *dest = xstrdup(value);
461 return 0;
464 int git_config_pathname(const char **dest, const char *var, const char *value)
466 if (!value)
467 return config_error_nonbool(var);
468 *dest = expand_user_path(value);
469 if (!*dest)
470 die("Failed to expand user dir in: '%s'", value);
471 return 0;
474 static int git_default_core_config(const char *var, const char *value)
476 /* This needs a better name */
477 if (!strcmp(var, "core.filemode")) {
478 trust_executable_bit = git_config_bool(var, value);
479 return 0;
481 if (!strcmp(var, "core.trustctime")) {
482 trust_ctime = git_config_bool(var, value);
483 return 0;
486 if (!strcmp(var, "core.quotepath")) {
487 quote_path_fully = git_config_bool(var, value);
488 return 0;
491 if (!strcmp(var, "core.symlinks")) {
492 has_symlinks = git_config_bool(var, value);
493 return 0;
496 if (!strcmp(var, "core.ignorecase")) {
497 ignore_case = git_config_bool(var, value);
498 return 0;
501 if (!strcmp(var, "core.bare")) {
502 is_bare_repository_cfg = git_config_bool(var, value);
503 return 0;
506 if (!strcmp(var, "core.ignorestat")) {
507 assume_unchanged = git_config_bool(var, value);
508 return 0;
511 if (!strcmp(var, "core.prefersymlinkrefs")) {
512 prefer_symlink_refs = git_config_bool(var, value);
513 return 0;
516 if (!strcmp(var, "core.logallrefupdates")) {
517 log_all_ref_updates = git_config_bool(var, value);
518 return 0;
521 if (!strcmp(var, "core.warnambiguousrefs")) {
522 warn_ambiguous_refs = git_config_bool(var, value);
523 return 0;
526 if (!strcmp(var, "core.abbrev")) {
527 int abbrev = git_config_int(var, value);
528 if (abbrev < minimum_abbrev || abbrev > 40)
529 return -1;
530 default_abbrev = abbrev;
531 return 0;
534 if (!strcmp(var, "core.loosecompression")) {
535 int level = git_config_int(var, value);
536 if (level == -1)
537 level = Z_DEFAULT_COMPRESSION;
538 else if (level < 0 || level > Z_BEST_COMPRESSION)
539 die("bad zlib compression level %d", level);
540 zlib_compression_level = level;
541 zlib_compression_seen = 1;
542 return 0;
545 if (!strcmp(var, "core.compression")) {
546 int level = git_config_int(var, value);
547 if (level == -1)
548 level = Z_DEFAULT_COMPRESSION;
549 else if (level < 0 || level > Z_BEST_COMPRESSION)
550 die("bad zlib compression level %d", level);
551 core_compression_level = level;
552 core_compression_seen = 1;
553 if (!zlib_compression_seen)
554 zlib_compression_level = level;
555 return 0;
558 if (!strcmp(var, "core.packedgitwindowsize")) {
559 int pgsz_x2 = getpagesize() * 2;
560 packed_git_window_size = git_config_int(var, value);
562 /* This value must be multiple of (pagesize * 2) */
563 packed_git_window_size /= pgsz_x2;
564 if (packed_git_window_size < 1)
565 packed_git_window_size = 1;
566 packed_git_window_size *= pgsz_x2;
567 return 0;
570 if (!strcmp(var, "core.bigfilethreshold")) {
571 long n = git_config_int(var, value);
572 big_file_threshold = 0 < n ? n : 0;
573 return 0;
576 if (!strcmp(var, "core.packedgitlimit")) {
577 packed_git_limit = git_config_int(var, value);
578 return 0;
581 if (!strcmp(var, "core.deltabasecachelimit")) {
582 delta_base_cache_limit = git_config_int(var, value);
583 return 0;
586 if (!strcmp(var, "core.autocrlf")) {
587 if (value && !strcasecmp(value, "input")) {
588 if (eol == EOL_CRLF)
589 return error("core.autocrlf=input conflicts with core.eol=crlf");
590 auto_crlf = AUTO_CRLF_INPUT;
591 return 0;
593 auto_crlf = git_config_bool(var, value);
594 return 0;
597 if (!strcmp(var, "core.safecrlf")) {
598 if (value && !strcasecmp(value, "warn")) {
599 safe_crlf = SAFE_CRLF_WARN;
600 return 0;
602 safe_crlf = git_config_bool(var, value);
603 return 0;
606 if (!strcmp(var, "core.eol")) {
607 if (value && !strcasecmp(value, "lf"))
608 eol = EOL_LF;
609 else if (value && !strcasecmp(value, "crlf"))
610 eol = EOL_CRLF;
611 else if (value && !strcasecmp(value, "native"))
612 eol = EOL_NATIVE;
613 else
614 eol = EOL_UNSET;
615 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
616 return error("core.autocrlf=input conflicts with core.eol=crlf");
617 return 0;
620 if (!strcmp(var, "core.notesref")) {
621 notes_ref_name = xstrdup(value);
622 return 0;
625 if (!strcmp(var, "core.pager"))
626 return git_config_string(&pager_program, var, value);
628 if (!strcmp(var, "core.editor"))
629 return git_config_string(&editor_program, var, value);
631 if (!strcmp(var, "core.askpass"))
632 return git_config_string(&askpass_program, var, value);
634 if (!strcmp(var, "core.excludesfile"))
635 return git_config_pathname(&excludes_file, var, value);
637 if (!strcmp(var, "core.whitespace")) {
638 if (!value)
639 return config_error_nonbool(var);
640 whitespace_rule_cfg = parse_whitespace_rule(value);
641 return 0;
644 if (!strcmp(var, "core.fsyncobjectfiles")) {
645 fsync_object_files = git_config_bool(var, value);
646 return 0;
649 if (!strcmp(var, "core.preloadindex")) {
650 core_preload_index = git_config_bool(var, value);
651 return 0;
654 if (!strcmp(var, "core.createobject")) {
655 if (!strcmp(value, "rename"))
656 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
657 else if (!strcmp(value, "link"))
658 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
659 else
660 die("Invalid mode for object creation: %s", value);
661 return 0;
664 if (!strcmp(var, "core.sparsecheckout")) {
665 core_apply_sparse_checkout = git_config_bool(var, value);
666 return 0;
669 /* Add other config variables here and to Documentation/config.txt. */
670 return 0;
673 static int git_default_user_config(const char *var, const char *value)
675 if (!strcmp(var, "user.name")) {
676 if (!value)
677 return config_error_nonbool(var);
678 strlcpy(git_default_name, value, sizeof(git_default_name));
679 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
680 return 0;
683 if (!strcmp(var, "user.email")) {
684 if (!value)
685 return config_error_nonbool(var);
686 strlcpy(git_default_email, value, sizeof(git_default_email));
687 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
688 return 0;
691 /* Add other config variables here and to Documentation/config.txt. */
692 return 0;
695 static int git_default_i18n_config(const char *var, const char *value)
697 if (!strcmp(var, "i18n.commitencoding"))
698 return git_config_string(&git_commit_encoding, var, value);
700 if (!strcmp(var, "i18n.logoutputencoding"))
701 return git_config_string(&git_log_output_encoding, var, value);
703 /* Add other config variables here and to Documentation/config.txt. */
704 return 0;
707 static int git_default_branch_config(const char *var, const char *value)
709 if (!strcmp(var, "branch.autosetupmerge")) {
710 if (value && !strcasecmp(value, "always")) {
711 git_branch_track = BRANCH_TRACK_ALWAYS;
712 return 0;
714 git_branch_track = git_config_bool(var, value);
715 return 0;
717 if (!strcmp(var, "branch.autosetuprebase")) {
718 if (!value)
719 return config_error_nonbool(var);
720 else if (!strcmp(value, "never"))
721 autorebase = AUTOREBASE_NEVER;
722 else if (!strcmp(value, "local"))
723 autorebase = AUTOREBASE_LOCAL;
724 else if (!strcmp(value, "remote"))
725 autorebase = AUTOREBASE_REMOTE;
726 else if (!strcmp(value, "always"))
727 autorebase = AUTOREBASE_ALWAYS;
728 else
729 return error("Malformed value for %s", var);
730 return 0;
733 /* Add other config variables here and to Documentation/config.txt. */
734 return 0;
737 static int git_default_push_config(const char *var, const char *value)
739 if (!strcmp(var, "push.default")) {
740 if (!value)
741 return config_error_nonbool(var);
742 else if (!strcmp(value, "nothing"))
743 push_default = PUSH_DEFAULT_NOTHING;
744 else if (!strcmp(value, "matching"))
745 push_default = PUSH_DEFAULT_MATCHING;
746 else if (!strcmp(value, "upstream"))
747 push_default = PUSH_DEFAULT_UPSTREAM;
748 else if (!strcmp(value, "tracking")) /* deprecated */
749 push_default = PUSH_DEFAULT_UPSTREAM;
750 else if (!strcmp(value, "current"))
751 push_default = PUSH_DEFAULT_CURRENT;
752 else {
753 error("Malformed value for %s: %s", var, value);
754 return error("Must be one of nothing, matching, "
755 "tracking or current.");
757 return 0;
760 /* Add other config variables here and to Documentation/config.txt. */
761 return 0;
764 static int git_default_mailmap_config(const char *var, const char *value)
766 if (!strcmp(var, "mailmap.file"))
767 return git_config_string(&git_mailmap_file, var, value);
769 /* Add other config variables here and to Documentation/config.txt. */
770 return 0;
773 int git_default_config(const char *var, const char *value, void *dummy)
775 if (!prefixcmp(var, "core."))
776 return git_default_core_config(var, value);
778 if (!prefixcmp(var, "user."))
779 return git_default_user_config(var, value);
781 if (!prefixcmp(var, "i18n."))
782 return git_default_i18n_config(var, value);
784 if (!prefixcmp(var, "branch."))
785 return git_default_branch_config(var, value);
787 if (!prefixcmp(var, "push."))
788 return git_default_push_config(var, value);
790 if (!prefixcmp(var, "mailmap."))
791 return git_default_mailmap_config(var, value);
793 if (!prefixcmp(var, "advice."))
794 return git_default_advice_config(var, value);
796 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
797 pager_use_color = git_config_bool(var,value);
798 return 0;
801 /* Add other config variables here and to Documentation/config.txt. */
802 return 0;
805 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
807 int ret;
808 FILE *f = fopen(filename, "r");
810 ret = -1;
811 if (f) {
812 config_file = f;
813 config_file_name = filename;
814 config_linenr = 1;
815 config_file_eof = 0;
816 ret = git_parse_file(fn, data);
817 fclose(f);
818 config_file_name = NULL;
820 return ret;
823 const char *git_etc_gitconfig(void)
825 static const char *system_wide;
826 if (!system_wide)
827 system_wide = system_path(ETC_GITCONFIG);
828 return system_wide;
831 int git_env_bool(const char *k, int def)
833 const char *v = getenv(k);
834 return v ? git_config_bool(k, v) : def;
837 int git_config_system(void)
839 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
842 int git_config_from_parameters(config_fn_t fn, void *data)
844 static int loaded_environment;
845 const struct config_item *ct;
847 if (!loaded_environment) {
848 if (git_config_parse_environment() < 0)
849 return -1;
850 loaded_environment = 1;
852 for (ct = config_parameters; ct; ct = ct->next)
853 if (fn(ct->name, ct->value, data) < 0)
854 return -1;
855 return 0;
858 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
860 int ret = 0, found = 0;
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 (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 if (repo_config && !access(repo_config, R_OK)) {
883 ret += git_config_from_file(fn, repo_config, data);
884 found += 1;
887 ret += git_config_from_parameters(fn, data);
888 if (config_parameters)
889 found += 1;
891 return ret == 0 ? found : ret;
894 int git_config(config_fn_t fn, void *data)
896 char *repo_config = NULL;
897 int ret;
899 repo_config = git_pathdup("config");
900 ret = git_config_early(fn, data, repo_config);
901 if (repo_config)
902 free(repo_config);
903 return ret;
907 * Find all the stuff for git_config_set() below.
910 #define MAX_MATCHES 512
912 static struct {
913 int baselen;
914 char *key;
915 int do_not_match;
916 regex_t *value_regex;
917 int multi_replace;
918 size_t offset[MAX_MATCHES];
919 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
920 int seen;
921 } store;
923 static int matches(const char *key, const char *value)
925 return !strcmp(key, store.key) &&
926 (store.value_regex == NULL ||
927 (store.do_not_match ^
928 !regexec(store.value_regex, value, 0, NULL, 0)));
931 static int store_aux(const char *key, const char *value, void *cb)
933 const char *ep;
934 size_t section_len;
936 switch (store.state) {
937 case KEY_SEEN:
938 if (matches(key, value)) {
939 if (store.seen == 1 && store.multi_replace == 0) {
940 warning("%s has multiple values", key);
941 } else if (store.seen >= MAX_MATCHES) {
942 error("too many matches for %s", key);
943 return 1;
946 store.offset[store.seen] = ftell(config_file);
947 store.seen++;
949 break;
950 case SECTION_SEEN:
952 * What we are looking for is in store.key (both
953 * section and var), and its section part is baselen
954 * long. We found key (again, both section and var).
955 * We would want to know if this key is in the same
956 * section as what we are looking for. We already
957 * know we are in the same section as what should
958 * hold store.key.
960 ep = strrchr(key, '.');
961 section_len = ep - key;
963 if ((section_len != store.baselen) ||
964 memcmp(key, store.key, section_len+1)) {
965 store.state = SECTION_END_SEEN;
966 break;
970 * Do not increment matches: this is no match, but we
971 * just made sure we are in the desired section.
973 store.offset[store.seen] = ftell(config_file);
974 /* fallthru */
975 case SECTION_END_SEEN:
976 case START:
977 if (matches(key, value)) {
978 store.offset[store.seen] = ftell(config_file);
979 store.state = KEY_SEEN;
980 store.seen++;
981 } else {
982 if (strrchr(key, '.') - key == store.baselen &&
983 !strncmp(key, store.key, store.baselen)) {
984 store.state = SECTION_SEEN;
985 store.offset[store.seen] = ftell(config_file);
989 return 0;
992 static int write_error(const char *filename)
994 error("failed to write new configuration file %s", filename);
996 /* Same error code as "failed to rename". */
997 return 4;
1000 static int store_write_section(int fd, const char *key)
1002 const char *dot;
1003 int i, success;
1004 struct strbuf sb = STRBUF_INIT;
1006 dot = memchr(key, '.', store.baselen);
1007 if (dot) {
1008 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1009 for (i = dot - key + 1; i < store.baselen; i++) {
1010 if (key[i] == '"' || key[i] == '\\')
1011 strbuf_addch(&sb, '\\');
1012 strbuf_addch(&sb, key[i]);
1014 strbuf_addstr(&sb, "\"]\n");
1015 } else {
1016 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1019 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1020 strbuf_release(&sb);
1022 return success;
1025 static int store_write_pair(int fd, const char *key, const char *value)
1027 int i, success;
1028 int length = strlen(key + store.baselen + 1);
1029 const char *quote = "";
1030 struct strbuf sb = STRBUF_INIT;
1033 * Check to see if the value needs to be surrounded with a dq pair.
1034 * Note that problematic characters are always backslash-quoted; this
1035 * check is about not losing leading or trailing SP and strings that
1036 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1037 * configuration parser.
1039 if (value[0] == ' ')
1040 quote = "\"";
1041 for (i = 0; value[i]; i++)
1042 if (value[i] == ';' || value[i] == '#')
1043 quote = "\"";
1044 if (i && value[i - 1] == ' ')
1045 quote = "\"";
1047 strbuf_addf(&sb, "\t%.*s = %s",
1048 length, key + store.baselen + 1, quote);
1050 for (i = 0; value[i]; i++)
1051 switch (value[i]) {
1052 case '\n':
1053 strbuf_addstr(&sb, "\\n");
1054 break;
1055 case '\t':
1056 strbuf_addstr(&sb, "\\t");
1057 break;
1058 case '"':
1059 case '\\':
1060 strbuf_addch(&sb, '\\');
1061 default:
1062 strbuf_addch(&sb, value[i]);
1063 break;
1065 strbuf_addf(&sb, "%s\n", quote);
1067 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1068 strbuf_release(&sb);
1070 return success;
1073 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1074 size_t offset_, int *found_bracket)
1076 size_t equal_offset = size, bracket_offset = size;
1077 ssize_t offset;
1079 contline:
1080 for (offset = offset_-2; offset > 0
1081 && contents[offset] != '\n'; offset--)
1082 switch (contents[offset]) {
1083 case '=': equal_offset = offset; break;
1084 case ']': bracket_offset = offset; break;
1086 if (offset > 0 && contents[offset-1] == '\\') {
1087 offset_ = offset;
1088 goto contline;
1090 if (bracket_offset < equal_offset) {
1091 *found_bracket = 1;
1092 offset = bracket_offset+1;
1093 } else
1094 offset++;
1096 return offset;
1099 int git_config_set(const char *key, const char *value)
1101 return git_config_set_multivar(key, value, NULL, 0);
1105 * Auxiliary function to sanity-check and split the key into the section
1106 * identifier and variable name.
1108 * Returns 0 on success, -1 when there is an invalid character in the key and
1109 * -2 if there is no section name in the key.
1111 * store_key - pointer to char* which will hold a copy of the key with
1112 * lowercase section and variable name
1113 * baselen - pointer to int which will hold the length of the
1114 * section + subsection part, can be NULL
1116 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1118 int i, dot, baselen;
1119 const char *last_dot = strrchr(key, '.');
1122 * Since "key" actually contains the section name and the real
1123 * key name separated by a dot, we have to know where the dot is.
1126 if (last_dot == NULL || last_dot == key) {
1127 error("key does not contain a section: %s", key);
1128 return -2;
1131 if (!last_dot[1]) {
1132 error("key does not contain variable name: %s", key);
1133 return -2;
1136 baselen = last_dot - key;
1137 if (baselen_)
1138 *baselen_ = baselen;
1141 * Validate the key and while at it, lower case it for matching.
1143 *store_key = xmalloc(strlen(key) + 1);
1145 dot = 0;
1146 for (i = 0; key[i]; i++) {
1147 unsigned char c = key[i];
1148 if (c == '.')
1149 dot = 1;
1150 /* Leave the extended basename untouched.. */
1151 if (!dot || i > baselen) {
1152 if (!iskeychar(c) ||
1153 (i == baselen + 1 && !isalpha(c))) {
1154 error("invalid key: %s", key);
1155 goto out_free_ret_1;
1157 c = tolower(c);
1158 } else if (c == '\n') {
1159 error("invalid key (newline): %s", key);
1160 goto out_free_ret_1;
1162 (*store_key)[i] = c;
1164 (*store_key)[i] = 0;
1166 return 0;
1168 out_free_ret_1:
1169 free(*store_key);
1170 return -1;
1174 * If value==NULL, unset in (remove from) config,
1175 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1176 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1177 * else all matching key/values (regardless how many) are removed,
1178 * before the new pair is written.
1180 * Returns 0 on success.
1182 * This function does this:
1184 * - it locks the config file by creating ".git/config.lock"
1186 * - it then parses the config using store_aux() as validator to find
1187 * the position on the key/value pair to replace. If it is to be unset,
1188 * it must be found exactly once.
1190 * - the config file is mmap()ed and the part before the match (if any) is
1191 * written to the lock file, then the changed part and the rest.
1193 * - the config file is removed and the lock file rename()d to it.
1196 int git_config_set_multivar(const char *key, const char *value,
1197 const char *value_regex, int multi_replace)
1199 int fd = -1, in_fd;
1200 int ret;
1201 char *config_filename;
1202 struct lock_file *lock = NULL;
1204 if (config_exclusive_filename)
1205 config_filename = xstrdup(config_exclusive_filename);
1206 else
1207 config_filename = git_pathdup("config");
1209 /* parse-key returns negative; flip the sign to feed exit(3) */
1210 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1211 if (ret)
1212 goto out_free;
1214 store.multi_replace = multi_replace;
1218 * The lock serves a purpose in addition to locking: the new
1219 * contents of .git/config will be written into it.
1221 lock = xcalloc(sizeof(struct lock_file), 1);
1222 fd = hold_lock_file_for_update(lock, config_filename, 0);
1223 if (fd < 0) {
1224 error("could not lock config file %s: %s", config_filename, strerror(errno));
1225 free(store.key);
1226 ret = -1;
1227 goto out_free;
1231 * If .git/config does not exist yet, write a minimal version.
1233 in_fd = open(config_filename, O_RDONLY);
1234 if ( in_fd < 0 ) {
1235 free(store.key);
1237 if ( ENOENT != errno ) {
1238 error("opening %s: %s", config_filename,
1239 strerror(errno));
1240 ret = 3; /* same as "invalid config file" */
1241 goto out_free;
1243 /* if nothing to unset, error out */
1244 if (value == NULL) {
1245 ret = 5;
1246 goto out_free;
1249 store.key = (char *)key;
1250 if (!store_write_section(fd, key) ||
1251 !store_write_pair(fd, key, value))
1252 goto write_err_out;
1253 } else {
1254 struct stat st;
1255 char *contents;
1256 size_t contents_sz, copy_begin, copy_end;
1257 int i, new_line = 0;
1259 if (value_regex == NULL)
1260 store.value_regex = NULL;
1261 else {
1262 if (value_regex[0] == '!') {
1263 store.do_not_match = 1;
1264 value_regex++;
1265 } else
1266 store.do_not_match = 0;
1268 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1269 if (regcomp(store.value_regex, value_regex,
1270 REG_EXTENDED)) {
1271 error("invalid pattern: %s", value_regex);
1272 free(store.value_regex);
1273 ret = 6;
1274 goto out_free;
1278 store.offset[0] = 0;
1279 store.state = START;
1280 store.seen = 0;
1283 * After this, store.offset will contain the *end* offset
1284 * of the last match, or remain at 0 if no match was found.
1285 * As a side effect, we make sure to transform only a valid
1286 * existing config file.
1288 if (git_config_from_file(store_aux, config_filename, NULL)) {
1289 error("invalid config file %s", config_filename);
1290 free(store.key);
1291 if (store.value_regex != NULL) {
1292 regfree(store.value_regex);
1293 free(store.value_regex);
1295 ret = 3;
1296 goto out_free;
1299 free(store.key);
1300 if (store.value_regex != NULL) {
1301 regfree(store.value_regex);
1302 free(store.value_regex);
1305 /* if nothing to unset, or too many matches, error out */
1306 if ((store.seen == 0 && value == NULL) ||
1307 (store.seen > 1 && multi_replace == 0)) {
1308 ret = 5;
1309 goto out_free;
1312 fstat(in_fd, &st);
1313 contents_sz = xsize_t(st.st_size);
1314 contents = xmmap(NULL, contents_sz, PROT_READ,
1315 MAP_PRIVATE, in_fd, 0);
1316 close(in_fd);
1318 if (store.seen == 0)
1319 store.seen = 1;
1321 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1322 if (store.offset[i] == 0) {
1323 store.offset[i] = copy_end = contents_sz;
1324 } else if (store.state != KEY_SEEN) {
1325 copy_end = store.offset[i];
1326 } else
1327 copy_end = find_beginning_of_line(
1328 contents, contents_sz,
1329 store.offset[i]-2, &new_line);
1331 if (copy_end > 0 && contents[copy_end-1] != '\n')
1332 new_line = 1;
1334 /* write the first part of the config */
1335 if (copy_end > copy_begin) {
1336 if (write_in_full(fd, contents + copy_begin,
1337 copy_end - copy_begin) <
1338 copy_end - copy_begin)
1339 goto write_err_out;
1340 if (new_line &&
1341 write_str_in_full(fd, "\n") != 1)
1342 goto write_err_out;
1344 copy_begin = store.offset[i];
1347 /* write the pair (value == NULL means unset) */
1348 if (value != NULL) {
1349 if (store.state == START) {
1350 if (!store_write_section(fd, key))
1351 goto write_err_out;
1353 if (!store_write_pair(fd, key, value))
1354 goto write_err_out;
1357 /* write the rest of the config */
1358 if (copy_begin < contents_sz)
1359 if (write_in_full(fd, contents + copy_begin,
1360 contents_sz - copy_begin) <
1361 contents_sz - copy_begin)
1362 goto write_err_out;
1364 munmap(contents, contents_sz);
1367 if (commit_lock_file(lock) < 0) {
1368 error("could not commit config file %s", config_filename);
1369 ret = 4;
1370 goto out_free;
1374 * lock is committed, so don't try to roll it back below.
1375 * NOTE: Since lockfile.c keeps a linked list of all created
1376 * lock_file structures, it isn't safe to free(lock). It's
1377 * better to just leave it hanging around.
1379 lock = NULL;
1380 ret = 0;
1382 out_free:
1383 if (lock)
1384 rollback_lock_file(lock);
1385 free(config_filename);
1386 return ret;
1388 write_err_out:
1389 ret = write_error(lock->filename);
1390 goto out_free;
1394 static int section_name_match (const char *buf, const char *name)
1396 int i = 0, j = 0, dot = 0;
1397 if (buf[i] != '[')
1398 return 0;
1399 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1400 if (!dot && isspace(buf[i])) {
1401 dot = 1;
1402 if (name[j++] != '.')
1403 break;
1404 for (i++; isspace(buf[i]); i++)
1405 ; /* do nothing */
1406 if (buf[i] != '"')
1407 break;
1408 continue;
1410 if (buf[i] == '\\' && dot)
1411 i++;
1412 else if (buf[i] == '"' && dot) {
1413 for (i++; isspace(buf[i]); i++)
1414 ; /* do_nothing */
1415 break;
1417 if (buf[i] != name[j++])
1418 break;
1420 if (buf[i] == ']' && name[j] == 0) {
1422 * We match, now just find the right length offset by
1423 * gobbling up any whitespace after it, as well
1425 i++;
1426 for (; buf[i] && isspace(buf[i]); i++)
1427 ; /* do nothing */
1428 return i;
1430 return 0;
1433 /* if new_name == NULL, the section is removed instead */
1434 int git_config_rename_section(const char *old_name, const char *new_name)
1436 int ret = 0, remove = 0;
1437 char *config_filename;
1438 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1439 int out_fd;
1440 char buf[1024];
1442 if (config_exclusive_filename)
1443 config_filename = xstrdup(config_exclusive_filename);
1444 else
1445 config_filename = git_pathdup("config");
1446 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1447 if (out_fd < 0) {
1448 ret = error("could not lock config file %s", config_filename);
1449 goto out;
1452 if (!(config_file = fopen(config_filename, "rb"))) {
1453 /* no config file means nothing to rename, no error */
1454 goto unlock_and_out;
1457 while (fgets(buf, sizeof(buf), config_file)) {
1458 int i;
1459 int length;
1460 char *output = buf;
1461 for (i = 0; buf[i] && isspace(buf[i]); i++)
1462 ; /* do nothing */
1463 if (buf[i] == '[') {
1464 /* it's a section */
1465 int offset = section_name_match(&buf[i], old_name);
1466 if (offset > 0) {
1467 ret++;
1468 if (new_name == NULL) {
1469 remove = 1;
1470 continue;
1472 store.baselen = strlen(new_name);
1473 if (!store_write_section(out_fd, new_name)) {
1474 ret = write_error(lock->filename);
1475 goto out;
1478 * We wrote out the new section, with
1479 * a newline, now skip the old
1480 * section's length
1482 output += offset + i;
1483 if (strlen(output) > 0) {
1485 * More content means there's
1486 * a declaration to put on the
1487 * next line; indent with a
1488 * tab
1490 output -= 1;
1491 output[0] = '\t';
1494 remove = 0;
1496 if (remove)
1497 continue;
1498 length = strlen(output);
1499 if (write_in_full(out_fd, output, length) != length) {
1500 ret = write_error(lock->filename);
1501 goto out;
1504 fclose(config_file);
1505 unlock_and_out:
1506 if (commit_lock_file(lock) < 0)
1507 ret = error("could not commit config file %s", config_filename);
1508 out:
1509 free(config_filename);
1510 return ret;
1514 * Call this to report error for your variable that should not
1515 * get a boolean value (i.e. "[my] var" means "true").
1517 int config_error_nonbool(const char *var)
1519 return error("Missing value for '%s'", var);