combine-diff: split header printing into its own function
[git/mjg.git] / config.c
blob671c8df2cc4a856b3b32d4ec047298f0e5547878
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 struct strbuf value = STRBUF_INIT;
137 int quote = 0, comment = 0, space = 0;
139 strbuf_reset(&value);
140 for (;;) {
141 int c = get_next_char();
142 if (c == '\n') {
143 if (quote)
144 return NULL;
145 return value.buf;
147 if (comment)
148 continue;
149 if (isspace(c) && !quote) {
150 if (value.len)
151 space++;
152 continue;
154 if (!quote) {
155 if (c == ';' || c == '#') {
156 comment = 1;
157 continue;
160 for (; space; space--)
161 strbuf_addch(&value, ' ');
162 if (c == '\\') {
163 c = get_next_char();
164 switch (c) {
165 case '\n':
166 continue;
167 case 't':
168 c = '\t';
169 break;
170 case 'b':
171 c = '\b';
172 break;
173 case 'n':
174 c = '\n';
175 break;
176 /* Some characters escape as themselves */
177 case '\\': case '"':
178 break;
179 /* Reject unknown escape sequences */
180 default:
181 return NULL;
183 strbuf_addch(&value, c);
184 continue;
186 if (c == '"') {
187 quote = 1-quote;
188 continue;
190 strbuf_addch(&value, c);
194 static inline int iskeychar(int c)
196 return isalnum(c) || c == '-';
199 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
201 int c;
202 char *value;
204 /* Get the full name */
205 for (;;) {
206 c = get_next_char();
207 if (config_file_eof)
208 break;
209 if (!iskeychar(c))
210 break;
211 name[len++] = tolower(c);
212 if (len >= MAXNAME)
213 return -1;
215 name[len] = 0;
216 while (c == ' ' || c == '\t')
217 c = get_next_char();
219 value = NULL;
220 if (c != '\n') {
221 if (c != '=')
222 return -1;
223 value = parse_value();
224 if (!value)
225 return -1;
227 return fn(name, value, data);
230 static int get_extended_base_var(char *name, int baselen, int c)
232 do {
233 if (c == '\n')
234 return -1;
235 c = get_next_char();
236 } while (isspace(c));
238 /* We require the format to be '[base "extension"]' */
239 if (c != '"')
240 return -1;
241 name[baselen++] = '.';
243 for (;;) {
244 int c = get_next_char();
245 if (c == '\n')
246 return -1;
247 if (c == '"')
248 break;
249 if (c == '\\') {
250 c = get_next_char();
251 if (c == '\n')
252 return -1;
254 name[baselen++] = c;
255 if (baselen > MAXNAME / 2)
256 return -1;
259 /* Final ']' */
260 if (get_next_char() != ']')
261 return -1;
262 return baselen;
265 static int get_base_var(char *name)
267 int baselen = 0;
269 for (;;) {
270 int c = get_next_char();
271 if (config_file_eof)
272 return -1;
273 if (c == ']')
274 return baselen;
275 if (isspace(c))
276 return get_extended_base_var(name, baselen, c);
277 if (!iskeychar(c) && c != '.')
278 return -1;
279 if (baselen > MAXNAME / 2)
280 return -1;
281 name[baselen++] = tolower(c);
285 static int git_parse_file(config_fn_t fn, void *data)
287 int comment = 0;
288 int baselen = 0;
289 static char var[MAXNAME];
291 /* U+FEFF Byte Order Mark in UTF8 */
292 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
293 const unsigned char *bomptr = utf8_bom;
295 for (;;) {
296 int c = get_next_char();
297 if (bomptr && *bomptr) {
298 /* We are at the file beginning; skip UTF8-encoded BOM
299 * if present. Sane editors won't put this in on their
300 * own, but e.g. Windows Notepad will do it happily. */
301 if ((unsigned char) c == *bomptr) {
302 bomptr++;
303 continue;
304 } else {
305 /* Do not tolerate partial BOM. */
306 if (bomptr != utf8_bom)
307 break;
308 /* No BOM at file beginning. Cool. */
309 bomptr = NULL;
312 if (c == '\n') {
313 if (config_file_eof)
314 return 0;
315 comment = 0;
316 continue;
318 if (comment || isspace(c))
319 continue;
320 if (c == '#' || c == ';') {
321 comment = 1;
322 continue;
324 if (c == '[') {
325 baselen = get_base_var(var);
326 if (baselen <= 0)
327 break;
328 var[baselen++] = '.';
329 var[baselen] = 0;
330 continue;
332 if (!isalpha(c))
333 break;
334 var[baselen] = tolower(c);
335 if (get_value(fn, data, var, baselen+1) < 0)
336 break;
338 die("bad config file line %d in %s", config_linenr, config_file_name);
341 static int parse_unit_factor(const char *end, unsigned long *val)
343 if (!*end)
344 return 1;
345 else if (!strcasecmp(end, "k")) {
346 *val *= 1024;
347 return 1;
349 else if (!strcasecmp(end, "m")) {
350 *val *= 1024 * 1024;
351 return 1;
353 else if (!strcasecmp(end, "g")) {
354 *val *= 1024 * 1024 * 1024;
355 return 1;
357 return 0;
360 static int git_parse_long(const char *value, long *ret)
362 if (value && *value) {
363 char *end;
364 long val = strtol(value, &end, 0);
365 unsigned long factor = 1;
366 if (!parse_unit_factor(end, &factor))
367 return 0;
368 *ret = val * factor;
369 return 1;
371 return 0;
374 int git_parse_ulong(const char *value, unsigned long *ret)
376 if (value && *value) {
377 char *end;
378 unsigned long val = strtoul(value, &end, 0);
379 if (!parse_unit_factor(end, &val))
380 return 0;
381 *ret = val;
382 return 1;
384 return 0;
387 static void die_bad_config(const char *name)
389 if (config_file_name)
390 die("bad config value for '%s' in %s", name, config_file_name);
391 die("bad config value for '%s'", name);
394 int git_config_int(const char *name, const char *value)
396 long ret = 0;
397 if (!git_parse_long(value, &ret))
398 die_bad_config(name);
399 return ret;
402 unsigned long git_config_ulong(const char *name, const char *value)
404 unsigned long ret;
405 if (!git_parse_ulong(value, &ret))
406 die_bad_config(name);
407 return ret;
410 static int git_config_maybe_bool_text(const char *name, const char *value)
412 if (!value)
413 return 1;
414 if (!*value)
415 return 0;
416 if (!strcasecmp(value, "true")
417 || !strcasecmp(value, "yes")
418 || !strcasecmp(value, "on"))
419 return 1;
420 if (!strcasecmp(value, "false")
421 || !strcasecmp(value, "no")
422 || !strcasecmp(value, "off"))
423 return 0;
424 return -1;
427 int git_config_maybe_bool(const char *name, const char *value)
429 long v = git_config_maybe_bool_text(name, value);
430 if (0 <= v)
431 return v;
432 if (git_parse_long(value, &v))
433 return !!v;
434 return -1;
437 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
439 int v = git_config_maybe_bool_text(name, value);
440 if (0 <= v) {
441 *is_bool = 1;
442 return v;
444 *is_bool = 0;
445 return git_config_int(name, value);
448 int git_config_bool(const char *name, const char *value)
450 int discard;
451 return !!git_config_bool_or_int(name, value, &discard);
454 int git_config_string(const char **dest, const char *var, const char *value)
456 if (!value)
457 return config_error_nonbool(var);
458 *dest = xstrdup(value);
459 return 0;
462 int git_config_pathname(const char **dest, const char *var, const char *value)
464 if (!value)
465 return config_error_nonbool(var);
466 *dest = expand_user_path(value);
467 if (!*dest)
468 die("Failed to expand user dir in: '%s'", value);
469 return 0;
472 static int git_default_core_config(const char *var, const char *value)
474 /* This needs a better name */
475 if (!strcmp(var, "core.filemode")) {
476 trust_executable_bit = git_config_bool(var, value);
477 return 0;
479 if (!strcmp(var, "core.trustctime")) {
480 trust_ctime = git_config_bool(var, value);
481 return 0;
484 if (!strcmp(var, "core.quotepath")) {
485 quote_path_fully = git_config_bool(var, value);
486 return 0;
489 if (!strcmp(var, "core.symlinks")) {
490 has_symlinks = git_config_bool(var, value);
491 return 0;
494 if (!strcmp(var, "core.ignorecase")) {
495 ignore_case = git_config_bool(var, value);
496 return 0;
499 if (!strcmp(var, "core.bare")) {
500 is_bare_repository_cfg = git_config_bool(var, value);
501 return 0;
504 if (!strcmp(var, "core.ignorestat")) {
505 assume_unchanged = git_config_bool(var, value);
506 return 0;
509 if (!strcmp(var, "core.prefersymlinkrefs")) {
510 prefer_symlink_refs = git_config_bool(var, value);
511 return 0;
514 if (!strcmp(var, "core.logallrefupdates")) {
515 log_all_ref_updates = git_config_bool(var, value);
516 return 0;
519 if (!strcmp(var, "core.warnambiguousrefs")) {
520 warn_ambiguous_refs = git_config_bool(var, value);
521 return 0;
524 if (!strcmp(var, "core.abbrev")) {
525 int abbrev = git_config_int(var, value);
526 if (abbrev < minimum_abbrev || abbrev > 40)
527 return -1;
528 default_abbrev = abbrev;
529 return 0;
532 if (!strcmp(var, "core.loosecompression")) {
533 int level = git_config_int(var, value);
534 if (level == -1)
535 level = Z_DEFAULT_COMPRESSION;
536 else if (level < 0 || level > Z_BEST_COMPRESSION)
537 die("bad zlib compression level %d", level);
538 zlib_compression_level = level;
539 zlib_compression_seen = 1;
540 return 0;
543 if (!strcmp(var, "core.compression")) {
544 int level = git_config_int(var, value);
545 if (level == -1)
546 level = Z_DEFAULT_COMPRESSION;
547 else if (level < 0 || level > Z_BEST_COMPRESSION)
548 die("bad zlib compression level %d", level);
549 core_compression_level = level;
550 core_compression_seen = 1;
551 if (!zlib_compression_seen)
552 zlib_compression_level = level;
553 return 0;
556 if (!strcmp(var, "core.packedgitwindowsize")) {
557 int pgsz_x2 = getpagesize() * 2;
558 packed_git_window_size = git_config_int(var, value);
560 /* This value must be multiple of (pagesize * 2) */
561 packed_git_window_size /= pgsz_x2;
562 if (packed_git_window_size < 1)
563 packed_git_window_size = 1;
564 packed_git_window_size *= pgsz_x2;
565 return 0;
568 if (!strcmp(var, "core.bigfilethreshold")) {
569 long n = git_config_int(var, value);
570 big_file_threshold = 0 < n ? n : 0;
571 return 0;
574 if (!strcmp(var, "core.packedgitlimit")) {
575 packed_git_limit = git_config_int(var, value);
576 return 0;
579 if (!strcmp(var, "core.deltabasecachelimit")) {
580 delta_base_cache_limit = git_config_int(var, value);
581 return 0;
584 if (!strcmp(var, "core.autocrlf")) {
585 if (value && !strcasecmp(value, "input")) {
586 if (core_eol == EOL_CRLF)
587 return error("core.autocrlf=input conflicts with core.eol=crlf");
588 auto_crlf = AUTO_CRLF_INPUT;
589 return 0;
591 auto_crlf = git_config_bool(var, value);
592 return 0;
595 if (!strcmp(var, "core.safecrlf")) {
596 if (value && !strcasecmp(value, "warn")) {
597 safe_crlf = SAFE_CRLF_WARN;
598 return 0;
600 safe_crlf = git_config_bool(var, value);
601 return 0;
604 if (!strcmp(var, "core.eol")) {
605 if (value && !strcasecmp(value, "lf"))
606 core_eol = EOL_LF;
607 else if (value && !strcasecmp(value, "crlf"))
608 core_eol = EOL_CRLF;
609 else if (value && !strcasecmp(value, "native"))
610 core_eol = EOL_NATIVE;
611 else
612 core_eol = EOL_UNSET;
613 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
614 return error("core.autocrlf=input conflicts with core.eol=crlf");
615 return 0;
618 if (!strcmp(var, "core.notesref")) {
619 notes_ref_name = xstrdup(value);
620 return 0;
623 if (!strcmp(var, "core.pager"))
624 return git_config_string(&pager_program, var, value);
626 if (!strcmp(var, "core.editor"))
627 return git_config_string(&editor_program, var, value);
629 if (!strcmp(var, "core.askpass"))
630 return git_config_string(&askpass_program, var, value);
632 if (!strcmp(var, "core.excludesfile"))
633 return git_config_pathname(&excludes_file, var, value);
635 if (!strcmp(var, "core.whitespace")) {
636 if (!value)
637 return config_error_nonbool(var);
638 whitespace_rule_cfg = parse_whitespace_rule(value);
639 return 0;
642 if (!strcmp(var, "core.fsyncobjectfiles")) {
643 fsync_object_files = git_config_bool(var, value);
644 return 0;
647 if (!strcmp(var, "core.preloadindex")) {
648 core_preload_index = git_config_bool(var, value);
649 return 0;
652 if (!strcmp(var, "core.createobject")) {
653 if (!strcmp(value, "rename"))
654 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
655 else if (!strcmp(value, "link"))
656 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
657 else
658 die("Invalid mode for object creation: %s", value);
659 return 0;
662 if (!strcmp(var, "core.sparsecheckout")) {
663 core_apply_sparse_checkout = git_config_bool(var, value);
664 return 0;
667 /* Add other config variables here and to Documentation/config.txt. */
668 return 0;
671 static int git_default_user_config(const char *var, const char *value)
673 if (!strcmp(var, "user.name")) {
674 if (!value)
675 return config_error_nonbool(var);
676 strlcpy(git_default_name, value, sizeof(git_default_name));
677 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
678 return 0;
681 if (!strcmp(var, "user.email")) {
682 if (!value)
683 return config_error_nonbool(var);
684 strlcpy(git_default_email, value, sizeof(git_default_email));
685 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
686 return 0;
689 /* Add other config variables here and to Documentation/config.txt. */
690 return 0;
693 static int git_default_i18n_config(const char *var, const char *value)
695 if (!strcmp(var, "i18n.commitencoding"))
696 return git_config_string(&git_commit_encoding, var, value);
698 if (!strcmp(var, "i18n.logoutputencoding"))
699 return git_config_string(&git_log_output_encoding, var, value);
701 /* Add other config variables here and to Documentation/config.txt. */
702 return 0;
705 static int git_default_branch_config(const char *var, const char *value)
707 if (!strcmp(var, "branch.autosetupmerge")) {
708 if (value && !strcasecmp(value, "always")) {
709 git_branch_track = BRANCH_TRACK_ALWAYS;
710 return 0;
712 git_branch_track = git_config_bool(var, value);
713 return 0;
715 if (!strcmp(var, "branch.autosetuprebase")) {
716 if (!value)
717 return config_error_nonbool(var);
718 else if (!strcmp(value, "never"))
719 autorebase = AUTOREBASE_NEVER;
720 else if (!strcmp(value, "local"))
721 autorebase = AUTOREBASE_LOCAL;
722 else if (!strcmp(value, "remote"))
723 autorebase = AUTOREBASE_REMOTE;
724 else if (!strcmp(value, "always"))
725 autorebase = AUTOREBASE_ALWAYS;
726 else
727 return error("Malformed value for %s", var);
728 return 0;
731 /* Add other config variables here and to Documentation/config.txt. */
732 return 0;
735 static int git_default_push_config(const char *var, const char *value)
737 if (!strcmp(var, "push.default")) {
738 if (!value)
739 return config_error_nonbool(var);
740 else if (!strcmp(value, "nothing"))
741 push_default = PUSH_DEFAULT_NOTHING;
742 else if (!strcmp(value, "matching"))
743 push_default = PUSH_DEFAULT_MATCHING;
744 else if (!strcmp(value, "upstream"))
745 push_default = PUSH_DEFAULT_UPSTREAM;
746 else if (!strcmp(value, "tracking")) /* deprecated */
747 push_default = PUSH_DEFAULT_UPSTREAM;
748 else if (!strcmp(value, "current"))
749 push_default = PUSH_DEFAULT_CURRENT;
750 else {
751 error("Malformed value for %s: %s", var, value);
752 return error("Must be one of nothing, matching, "
753 "tracking or current.");
755 return 0;
758 /* Add other config variables here and to Documentation/config.txt. */
759 return 0;
762 static int git_default_mailmap_config(const char *var, const char *value)
764 if (!strcmp(var, "mailmap.file"))
765 return git_config_string(&git_mailmap_file, var, value);
767 /* Add other config variables here and to Documentation/config.txt. */
768 return 0;
771 int git_default_config(const char *var, const char *value, void *dummy)
773 if (!prefixcmp(var, "core."))
774 return git_default_core_config(var, value);
776 if (!prefixcmp(var, "user."))
777 return git_default_user_config(var, value);
779 if (!prefixcmp(var, "i18n."))
780 return git_default_i18n_config(var, value);
782 if (!prefixcmp(var, "branch."))
783 return git_default_branch_config(var, value);
785 if (!prefixcmp(var, "push."))
786 return git_default_push_config(var, value);
788 if (!prefixcmp(var, "mailmap."))
789 return git_default_mailmap_config(var, value);
791 if (!prefixcmp(var, "advice."))
792 return git_default_advice_config(var, value);
794 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
795 pager_use_color = git_config_bool(var,value);
796 return 0;
799 /* Add other config variables here and to Documentation/config.txt. */
800 return 0;
803 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
805 int ret;
806 FILE *f = fopen(filename, "r");
808 ret = -1;
809 if (f) {
810 config_file = f;
811 config_file_name = filename;
812 config_linenr = 1;
813 config_file_eof = 0;
814 ret = git_parse_file(fn, data);
815 fclose(f);
816 config_file_name = NULL;
818 return ret;
821 const char *git_etc_gitconfig(void)
823 static const char *system_wide;
824 if (!system_wide)
825 system_wide = system_path(ETC_GITCONFIG);
826 return system_wide;
829 int git_env_bool(const char *k, int def)
831 const char *v = getenv(k);
832 return v ? git_config_bool(k, v) : def;
835 int git_config_system(void)
837 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
840 int git_config_from_parameters(config_fn_t fn, void *data)
842 static int loaded_environment;
843 const struct config_item *ct;
845 if (!loaded_environment) {
846 if (git_config_parse_environment() < 0)
847 return -1;
848 loaded_environment = 1;
850 for (ct = config_parameters; ct; ct = ct->next)
851 if (fn(ct->name, ct->value, data) < 0)
852 return -1;
853 return 0;
856 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
858 int ret = 0, found = 0;
859 const char *home = NULL;
861 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
862 if (config_exclusive_filename)
863 return git_config_from_file(fn, config_exclusive_filename, data);
864 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
865 ret += git_config_from_file(fn, git_etc_gitconfig(),
866 data);
867 found += 1;
870 home = getenv("HOME");
871 if (home) {
872 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
873 if (!access(user_config, R_OK)) {
874 ret += git_config_from_file(fn, user_config, data);
875 found += 1;
877 free(user_config);
880 if (repo_config && !access(repo_config, R_OK)) {
881 ret += git_config_from_file(fn, repo_config, data);
882 found += 1;
885 ret += git_config_from_parameters(fn, data);
886 if (config_parameters)
887 found += 1;
889 return ret == 0 ? found : ret;
892 int git_config(config_fn_t fn, void *data)
894 char *repo_config = NULL;
895 int ret;
897 repo_config = git_pathdup("config");
898 ret = git_config_early(fn, data, repo_config);
899 if (repo_config)
900 free(repo_config);
901 return ret;
905 * Find all the stuff for git_config_set() below.
908 #define MAX_MATCHES 512
910 static struct {
911 int baselen;
912 char *key;
913 int do_not_match;
914 regex_t *value_regex;
915 int multi_replace;
916 size_t offset[MAX_MATCHES];
917 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
918 int seen;
919 } store;
921 static int matches(const char *key, const char *value)
923 return !strcmp(key, store.key) &&
924 (store.value_regex == NULL ||
925 (store.do_not_match ^
926 !regexec(store.value_regex, value, 0, NULL, 0)));
929 static int store_aux(const char *key, const char *value, void *cb)
931 const char *ep;
932 size_t section_len;
934 switch (store.state) {
935 case KEY_SEEN:
936 if (matches(key, value)) {
937 if (store.seen == 1 && store.multi_replace == 0) {
938 warning("%s has multiple values", key);
939 } else if (store.seen >= MAX_MATCHES) {
940 error("too many matches for %s", key);
941 return 1;
944 store.offset[store.seen] = ftell(config_file);
945 store.seen++;
947 break;
948 case SECTION_SEEN:
950 * What we are looking for is in store.key (both
951 * section and var), and its section part is baselen
952 * long. We found key (again, both section and var).
953 * We would want to know if this key is in the same
954 * section as what we are looking for. We already
955 * know we are in the same section as what should
956 * hold store.key.
958 ep = strrchr(key, '.');
959 section_len = ep - key;
961 if ((section_len != store.baselen) ||
962 memcmp(key, store.key, section_len+1)) {
963 store.state = SECTION_END_SEEN;
964 break;
968 * Do not increment matches: this is no match, but we
969 * just made sure we are in the desired section.
971 store.offset[store.seen] = ftell(config_file);
972 /* fallthru */
973 case SECTION_END_SEEN:
974 case START:
975 if (matches(key, value)) {
976 store.offset[store.seen] = ftell(config_file);
977 store.state = KEY_SEEN;
978 store.seen++;
979 } else {
980 if (strrchr(key, '.') - key == store.baselen &&
981 !strncmp(key, store.key, store.baselen)) {
982 store.state = SECTION_SEEN;
983 store.offset[store.seen] = ftell(config_file);
987 return 0;
990 static int write_error(const char *filename)
992 error("failed to write new configuration file %s", filename);
994 /* Same error code as "failed to rename". */
995 return 4;
998 static int store_write_section(int fd, const char *key)
1000 const char *dot;
1001 int i, success;
1002 struct strbuf sb = STRBUF_INIT;
1004 dot = memchr(key, '.', store.baselen);
1005 if (dot) {
1006 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1007 for (i = dot - key + 1; i < store.baselen; i++) {
1008 if (key[i] == '"' || key[i] == '\\')
1009 strbuf_addch(&sb, '\\');
1010 strbuf_addch(&sb, key[i]);
1012 strbuf_addstr(&sb, "\"]\n");
1013 } else {
1014 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1017 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1018 strbuf_release(&sb);
1020 return success;
1023 static int store_write_pair(int fd, const char *key, const char *value)
1025 int i, success;
1026 int length = strlen(key + store.baselen + 1);
1027 const char *quote = "";
1028 struct strbuf sb = STRBUF_INIT;
1031 * Check to see if the value needs to be surrounded with a dq pair.
1032 * Note that problematic characters are always backslash-quoted; this
1033 * check is about not losing leading or trailing SP and strings that
1034 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1035 * configuration parser.
1037 if (value[0] == ' ')
1038 quote = "\"";
1039 for (i = 0; value[i]; i++)
1040 if (value[i] == ';' || value[i] == '#')
1041 quote = "\"";
1042 if (i && value[i - 1] == ' ')
1043 quote = "\"";
1045 strbuf_addf(&sb, "\t%.*s = %s",
1046 length, key + store.baselen + 1, quote);
1048 for (i = 0; value[i]; i++)
1049 switch (value[i]) {
1050 case '\n':
1051 strbuf_addstr(&sb, "\\n");
1052 break;
1053 case '\t':
1054 strbuf_addstr(&sb, "\\t");
1055 break;
1056 case '"':
1057 case '\\':
1058 strbuf_addch(&sb, '\\');
1059 default:
1060 strbuf_addch(&sb, value[i]);
1061 break;
1063 strbuf_addf(&sb, "%s\n", quote);
1065 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1066 strbuf_release(&sb);
1068 return success;
1071 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1072 size_t offset_, int *found_bracket)
1074 size_t equal_offset = size, bracket_offset = size;
1075 ssize_t offset;
1077 contline:
1078 for (offset = offset_-2; offset > 0
1079 && contents[offset] != '\n'; offset--)
1080 switch (contents[offset]) {
1081 case '=': equal_offset = offset; break;
1082 case ']': bracket_offset = offset; break;
1084 if (offset > 0 && contents[offset-1] == '\\') {
1085 offset_ = offset;
1086 goto contline;
1088 if (bracket_offset < equal_offset) {
1089 *found_bracket = 1;
1090 offset = bracket_offset+1;
1091 } else
1092 offset++;
1094 return offset;
1097 int git_config_set(const char *key, const char *value)
1099 return git_config_set_multivar(key, value, NULL, 0);
1103 * Auxiliary function to sanity-check and split the key into the section
1104 * identifier and variable name.
1106 * Returns 0 on success, -1 when there is an invalid character in the key and
1107 * -2 if there is no section name in the key.
1109 * store_key - pointer to char* which will hold a copy of the key with
1110 * lowercase section and variable name
1111 * baselen - pointer to int which will hold the length of the
1112 * section + subsection part, can be NULL
1114 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1116 int i, dot, baselen;
1117 const char *last_dot = strrchr(key, '.');
1120 * Since "key" actually contains the section name and the real
1121 * key name separated by a dot, we have to know where the dot is.
1124 if (last_dot == NULL || last_dot == key) {
1125 error("key does not contain a section: %s", key);
1126 return -2;
1129 if (!last_dot[1]) {
1130 error("key does not contain variable name: %s", key);
1131 return -2;
1134 baselen = last_dot - key;
1135 if (baselen_)
1136 *baselen_ = baselen;
1139 * Validate the key and while at it, lower case it for matching.
1141 *store_key = xmalloc(strlen(key) + 1);
1143 dot = 0;
1144 for (i = 0; key[i]; i++) {
1145 unsigned char c = key[i];
1146 if (c == '.')
1147 dot = 1;
1148 /* Leave the extended basename untouched.. */
1149 if (!dot || i > baselen) {
1150 if (!iskeychar(c) ||
1151 (i == baselen + 1 && !isalpha(c))) {
1152 error("invalid key: %s", key);
1153 goto out_free_ret_1;
1155 c = tolower(c);
1156 } else if (c == '\n') {
1157 error("invalid key (newline): %s", key);
1158 goto out_free_ret_1;
1160 (*store_key)[i] = c;
1162 (*store_key)[i] = 0;
1164 return 0;
1166 out_free_ret_1:
1167 free(*store_key);
1168 return -1;
1172 * If value==NULL, unset in (remove from) config,
1173 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1174 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1175 * else all matching key/values (regardless how many) are removed,
1176 * before the new pair is written.
1178 * Returns 0 on success.
1180 * This function does this:
1182 * - it locks the config file by creating ".git/config.lock"
1184 * - it then parses the config using store_aux() as validator to find
1185 * the position on the key/value pair to replace. If it is to be unset,
1186 * it must be found exactly once.
1188 * - the config file is mmap()ed and the part before the match (if any) is
1189 * written to the lock file, then the changed part and the rest.
1191 * - the config file is removed and the lock file rename()d to it.
1194 int git_config_set_multivar(const char *key, const char *value,
1195 const char *value_regex, int multi_replace)
1197 int fd = -1, in_fd;
1198 int ret;
1199 char *config_filename;
1200 struct lock_file *lock = NULL;
1202 if (config_exclusive_filename)
1203 config_filename = xstrdup(config_exclusive_filename);
1204 else
1205 config_filename = git_pathdup("config");
1207 /* parse-key returns negative; flip the sign to feed exit(3) */
1208 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1209 if (ret)
1210 goto out_free;
1212 store.multi_replace = multi_replace;
1216 * The lock serves a purpose in addition to locking: the new
1217 * contents of .git/config will be written into it.
1219 lock = xcalloc(sizeof(struct lock_file), 1);
1220 fd = hold_lock_file_for_update(lock, config_filename, 0);
1221 if (fd < 0) {
1222 error("could not lock config file %s: %s", config_filename, strerror(errno));
1223 free(store.key);
1224 ret = -1;
1225 goto out_free;
1229 * If .git/config does not exist yet, write a minimal version.
1231 in_fd = open(config_filename, O_RDONLY);
1232 if ( in_fd < 0 ) {
1233 free(store.key);
1235 if ( ENOENT != errno ) {
1236 error("opening %s: %s", config_filename,
1237 strerror(errno));
1238 ret = 3; /* same as "invalid config file" */
1239 goto out_free;
1241 /* if nothing to unset, error out */
1242 if (value == NULL) {
1243 ret = 5;
1244 goto out_free;
1247 store.key = (char *)key;
1248 if (!store_write_section(fd, key) ||
1249 !store_write_pair(fd, key, value))
1250 goto write_err_out;
1251 } else {
1252 struct stat st;
1253 char *contents;
1254 size_t contents_sz, copy_begin, copy_end;
1255 int i, new_line = 0;
1257 if (value_regex == NULL)
1258 store.value_regex = NULL;
1259 else {
1260 if (value_regex[0] == '!') {
1261 store.do_not_match = 1;
1262 value_regex++;
1263 } else
1264 store.do_not_match = 0;
1266 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1267 if (regcomp(store.value_regex, value_regex,
1268 REG_EXTENDED)) {
1269 error("invalid pattern: %s", value_regex);
1270 free(store.value_regex);
1271 ret = 6;
1272 goto out_free;
1276 store.offset[0] = 0;
1277 store.state = START;
1278 store.seen = 0;
1281 * After this, store.offset will contain the *end* offset
1282 * of the last match, or remain at 0 if no match was found.
1283 * As a side effect, we make sure to transform only a valid
1284 * existing config file.
1286 if (git_config_from_file(store_aux, config_filename, NULL)) {
1287 error("invalid config file %s", config_filename);
1288 free(store.key);
1289 if (store.value_regex != NULL) {
1290 regfree(store.value_regex);
1291 free(store.value_regex);
1293 ret = 3;
1294 goto out_free;
1297 free(store.key);
1298 if (store.value_regex != NULL) {
1299 regfree(store.value_regex);
1300 free(store.value_regex);
1303 /* if nothing to unset, or too many matches, error out */
1304 if ((store.seen == 0 && value == NULL) ||
1305 (store.seen > 1 && multi_replace == 0)) {
1306 ret = 5;
1307 goto out_free;
1310 fstat(in_fd, &st);
1311 contents_sz = xsize_t(st.st_size);
1312 contents = xmmap(NULL, contents_sz, PROT_READ,
1313 MAP_PRIVATE, in_fd, 0);
1314 close(in_fd);
1316 if (store.seen == 0)
1317 store.seen = 1;
1319 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1320 if (store.offset[i] == 0) {
1321 store.offset[i] = copy_end = contents_sz;
1322 } else if (store.state != KEY_SEEN) {
1323 copy_end = store.offset[i];
1324 } else
1325 copy_end = find_beginning_of_line(
1326 contents, contents_sz,
1327 store.offset[i]-2, &new_line);
1329 if (copy_end > 0 && contents[copy_end-1] != '\n')
1330 new_line = 1;
1332 /* write the first part of the config */
1333 if (copy_end > copy_begin) {
1334 if (write_in_full(fd, contents + copy_begin,
1335 copy_end - copy_begin) <
1336 copy_end - copy_begin)
1337 goto write_err_out;
1338 if (new_line &&
1339 write_str_in_full(fd, "\n") != 1)
1340 goto write_err_out;
1342 copy_begin = store.offset[i];
1345 /* write the pair (value == NULL means unset) */
1346 if (value != NULL) {
1347 if (store.state == START) {
1348 if (!store_write_section(fd, key))
1349 goto write_err_out;
1351 if (!store_write_pair(fd, key, value))
1352 goto write_err_out;
1355 /* write the rest of the config */
1356 if (copy_begin < contents_sz)
1357 if (write_in_full(fd, contents + copy_begin,
1358 contents_sz - copy_begin) <
1359 contents_sz - copy_begin)
1360 goto write_err_out;
1362 munmap(contents, contents_sz);
1365 if (commit_lock_file(lock) < 0) {
1366 error("could not commit config file %s", config_filename);
1367 ret = 4;
1368 goto out_free;
1372 * lock is committed, so don't try to roll it back below.
1373 * NOTE: Since lockfile.c keeps a linked list of all created
1374 * lock_file structures, it isn't safe to free(lock). It's
1375 * better to just leave it hanging around.
1377 lock = NULL;
1378 ret = 0;
1380 out_free:
1381 if (lock)
1382 rollback_lock_file(lock);
1383 free(config_filename);
1384 return ret;
1386 write_err_out:
1387 ret = write_error(lock->filename);
1388 goto out_free;
1392 static int section_name_match (const char *buf, const char *name)
1394 int i = 0, j = 0, dot = 0;
1395 if (buf[i] != '[')
1396 return 0;
1397 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1398 if (!dot && isspace(buf[i])) {
1399 dot = 1;
1400 if (name[j++] != '.')
1401 break;
1402 for (i++; isspace(buf[i]); i++)
1403 ; /* do nothing */
1404 if (buf[i] != '"')
1405 break;
1406 continue;
1408 if (buf[i] == '\\' && dot)
1409 i++;
1410 else if (buf[i] == '"' && dot) {
1411 for (i++; isspace(buf[i]); i++)
1412 ; /* do_nothing */
1413 break;
1415 if (buf[i] != name[j++])
1416 break;
1418 if (buf[i] == ']' && name[j] == 0) {
1420 * We match, now just find the right length offset by
1421 * gobbling up any whitespace after it, as well
1423 i++;
1424 for (; buf[i] && isspace(buf[i]); i++)
1425 ; /* do nothing */
1426 return i;
1428 return 0;
1431 /* if new_name == NULL, the section is removed instead */
1432 int git_config_rename_section(const char *old_name, const char *new_name)
1434 int ret = 0, remove = 0;
1435 char *config_filename;
1436 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1437 int out_fd;
1438 char buf[1024];
1440 if (config_exclusive_filename)
1441 config_filename = xstrdup(config_exclusive_filename);
1442 else
1443 config_filename = git_pathdup("config");
1444 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1445 if (out_fd < 0) {
1446 ret = error("could not lock config file %s", config_filename);
1447 goto out;
1450 if (!(config_file = fopen(config_filename, "rb"))) {
1451 /* no config file means nothing to rename, no error */
1452 goto unlock_and_out;
1455 while (fgets(buf, sizeof(buf), config_file)) {
1456 int i;
1457 int length;
1458 char *output = buf;
1459 for (i = 0; buf[i] && isspace(buf[i]); i++)
1460 ; /* do nothing */
1461 if (buf[i] == '[') {
1462 /* it's a section */
1463 int offset = section_name_match(&buf[i], old_name);
1464 if (offset > 0) {
1465 ret++;
1466 if (new_name == NULL) {
1467 remove = 1;
1468 continue;
1470 store.baselen = strlen(new_name);
1471 if (!store_write_section(out_fd, new_name)) {
1472 ret = write_error(lock->filename);
1473 goto out;
1476 * We wrote out the new section, with
1477 * a newline, now skip the old
1478 * section's length
1480 output += offset + i;
1481 if (strlen(output) > 0) {
1483 * More content means there's
1484 * a declaration to put on the
1485 * next line; indent with a
1486 * tab
1488 output -= 1;
1489 output[0] = '\t';
1492 remove = 0;
1494 if (remove)
1495 continue;
1496 length = strlen(output);
1497 if (write_in_full(out_fd, output, length) != length) {
1498 ret = write_error(lock->filename);
1499 goto out;
1502 fclose(config_file);
1503 unlock_and_out:
1504 if (commit_lock_file(lock) < 0)
1505 ret = error("could not commit config file %s", config_filename);
1506 out:
1507 free(config_filename);
1508 return ret;
1512 * Call this to report error for your variable that should not
1513 * get a boolean value (i.e. "[my] var" means "true").
1515 int config_error_nonbool(const char *var)
1517 return error("Missing value for '%s'", var);