gitweb: highlight: replace tabs with spaces
[git/mjg.git] / config.c
blob3dd55d507b5e3551e2ec315dda3fc37d2a74ad5a
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.loosecompression")) {
527 int level = git_config_int(var, value);
528 if (level == -1)
529 level = Z_DEFAULT_COMPRESSION;
530 else if (level < 0 || level > Z_BEST_COMPRESSION)
531 die("bad zlib compression level %d", level);
532 zlib_compression_level = level;
533 zlib_compression_seen = 1;
534 return 0;
537 if (!strcmp(var, "core.compression")) {
538 int level = git_config_int(var, value);
539 if (level == -1)
540 level = Z_DEFAULT_COMPRESSION;
541 else if (level < 0 || level > Z_BEST_COMPRESSION)
542 die("bad zlib compression level %d", level);
543 core_compression_level = level;
544 core_compression_seen = 1;
545 if (!zlib_compression_seen)
546 zlib_compression_level = level;
547 return 0;
550 if (!strcmp(var, "core.packedgitwindowsize")) {
551 int pgsz_x2 = getpagesize() * 2;
552 packed_git_window_size = git_config_int(var, value);
554 /* This value must be multiple of (pagesize * 2) */
555 packed_git_window_size /= pgsz_x2;
556 if (packed_git_window_size < 1)
557 packed_git_window_size = 1;
558 packed_git_window_size *= pgsz_x2;
559 return 0;
562 if (!strcmp(var, "core.packedgitlimit")) {
563 packed_git_limit = git_config_int(var, value);
564 return 0;
567 if (!strcmp(var, "core.deltabasecachelimit")) {
568 delta_base_cache_limit = git_config_int(var, value);
569 return 0;
572 if (!strcmp(var, "core.autocrlf")) {
573 if (value && !strcasecmp(value, "input")) {
574 if (eol == EOL_CRLF)
575 return error("core.autocrlf=input conflicts with core.eol=crlf");
576 auto_crlf = AUTO_CRLF_INPUT;
577 return 0;
579 auto_crlf = git_config_bool(var, value);
580 return 0;
583 if (!strcmp(var, "core.safecrlf")) {
584 if (value && !strcasecmp(value, "warn")) {
585 safe_crlf = SAFE_CRLF_WARN;
586 return 0;
588 safe_crlf = git_config_bool(var, value);
589 return 0;
592 if (!strcmp(var, "core.eol")) {
593 if (value && !strcasecmp(value, "lf"))
594 eol = EOL_LF;
595 else if (value && !strcasecmp(value, "crlf"))
596 eol = EOL_CRLF;
597 else if (value && !strcasecmp(value, "native"))
598 eol = EOL_NATIVE;
599 else
600 eol = EOL_UNSET;
601 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
602 return error("core.autocrlf=input conflicts with core.eol=crlf");
603 return 0;
606 if (!strcmp(var, "core.notesref")) {
607 notes_ref_name = xstrdup(value);
608 return 0;
611 if (!strcmp(var, "core.pager"))
612 return git_config_string(&pager_program, var, value);
614 if (!strcmp(var, "core.editor"))
615 return git_config_string(&editor_program, var, value);
617 if (!strcmp(var, "core.askpass"))
618 return git_config_string(&askpass_program, var, value);
620 if (!strcmp(var, "core.excludesfile"))
621 return git_config_pathname(&excludes_file, var, value);
623 if (!strcmp(var, "core.whitespace")) {
624 if (!value)
625 return config_error_nonbool(var);
626 whitespace_rule_cfg = parse_whitespace_rule(value);
627 return 0;
630 if (!strcmp(var, "core.fsyncobjectfiles")) {
631 fsync_object_files = git_config_bool(var, value);
632 return 0;
635 if (!strcmp(var, "core.preloadindex")) {
636 core_preload_index = git_config_bool(var, value);
637 return 0;
640 if (!strcmp(var, "core.createobject")) {
641 if (!strcmp(value, "rename"))
642 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
643 else if (!strcmp(value, "link"))
644 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
645 else
646 die("Invalid mode for object creation: %s", value);
647 return 0;
650 if (!strcmp(var, "core.sparsecheckout")) {
651 core_apply_sparse_checkout = git_config_bool(var, value);
652 return 0;
655 /* Add other config variables here and to Documentation/config.txt. */
656 return 0;
659 static int git_default_user_config(const char *var, const char *value)
661 if (!strcmp(var, "user.name")) {
662 if (!value)
663 return config_error_nonbool(var);
664 strlcpy(git_default_name, value, sizeof(git_default_name));
665 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
666 return 0;
669 if (!strcmp(var, "user.email")) {
670 if (!value)
671 return config_error_nonbool(var);
672 strlcpy(git_default_email, value, sizeof(git_default_email));
673 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
674 return 0;
677 /* Add other config variables here and to Documentation/config.txt. */
678 return 0;
681 static int git_default_i18n_config(const char *var, const char *value)
683 if (!strcmp(var, "i18n.commitencoding"))
684 return git_config_string(&git_commit_encoding, var, value);
686 if (!strcmp(var, "i18n.logoutputencoding"))
687 return git_config_string(&git_log_output_encoding, var, value);
689 /* Add other config variables here and to Documentation/config.txt. */
690 return 0;
693 static int git_default_branch_config(const char *var, const char *value)
695 if (!strcmp(var, "branch.autosetupmerge")) {
696 if (value && !strcasecmp(value, "always")) {
697 git_branch_track = BRANCH_TRACK_ALWAYS;
698 return 0;
700 git_branch_track = git_config_bool(var, value);
701 return 0;
703 if (!strcmp(var, "branch.autosetuprebase")) {
704 if (!value)
705 return config_error_nonbool(var);
706 else if (!strcmp(value, "never"))
707 autorebase = AUTOREBASE_NEVER;
708 else if (!strcmp(value, "local"))
709 autorebase = AUTOREBASE_LOCAL;
710 else if (!strcmp(value, "remote"))
711 autorebase = AUTOREBASE_REMOTE;
712 else if (!strcmp(value, "always"))
713 autorebase = AUTOREBASE_ALWAYS;
714 else
715 return error("Malformed value for %s", var);
716 return 0;
719 /* Add other config variables here and to Documentation/config.txt. */
720 return 0;
723 static int git_default_push_config(const char *var, const char *value)
725 if (!strcmp(var, "push.default")) {
726 if (!value)
727 return config_error_nonbool(var);
728 else if (!strcmp(value, "nothing"))
729 push_default = PUSH_DEFAULT_NOTHING;
730 else if (!strcmp(value, "matching"))
731 push_default = PUSH_DEFAULT_MATCHING;
732 else if (!strcmp(value, "tracking"))
733 push_default = PUSH_DEFAULT_TRACKING;
734 else if (!strcmp(value, "current"))
735 push_default = PUSH_DEFAULT_CURRENT;
736 else {
737 error("Malformed value for %s: %s", var, value);
738 return error("Must be one of nothing, matching, "
739 "tracking or current.");
741 return 0;
744 /* Add other config variables here and to Documentation/config.txt. */
745 return 0;
748 static int git_default_mailmap_config(const char *var, const char *value)
750 if (!strcmp(var, "mailmap.file"))
751 return git_config_string(&git_mailmap_file, var, value);
753 /* Add other config variables here and to Documentation/config.txt. */
754 return 0;
757 int git_default_config(const char *var, const char *value, void *dummy)
759 if (!prefixcmp(var, "core."))
760 return git_default_core_config(var, value);
762 if (!prefixcmp(var, "user."))
763 return git_default_user_config(var, value);
765 if (!prefixcmp(var, "i18n."))
766 return git_default_i18n_config(var, value);
768 if (!prefixcmp(var, "branch."))
769 return git_default_branch_config(var, value);
771 if (!prefixcmp(var, "push."))
772 return git_default_push_config(var, value);
774 if (!prefixcmp(var, "mailmap."))
775 return git_default_mailmap_config(var, value);
777 if (!prefixcmp(var, "advice."))
778 return git_default_advice_config(var, value);
780 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
781 pager_use_color = git_config_bool(var,value);
782 return 0;
785 /* Add other config variables here and to Documentation/config.txt. */
786 return 0;
789 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
791 int ret;
792 FILE *f = fopen(filename, "r");
794 ret = -1;
795 if (f) {
796 config_file = f;
797 config_file_name = filename;
798 config_linenr = 1;
799 config_file_eof = 0;
800 ret = git_parse_file(fn, data);
801 fclose(f);
802 config_file_name = NULL;
804 return ret;
807 const char *git_etc_gitconfig(void)
809 static const char *system_wide;
810 if (!system_wide)
811 system_wide = system_path(ETC_GITCONFIG);
812 return system_wide;
815 int git_env_bool(const char *k, int def)
817 const char *v = getenv(k);
818 return v ? git_config_bool(k, v) : def;
821 int git_config_system(void)
823 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
826 int git_config_global(void)
828 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
831 int git_config_from_parameters(config_fn_t fn, void *data)
833 static int loaded_environment;
834 const struct config_item *ct;
836 if (!loaded_environment) {
837 if (git_config_parse_environment() < 0)
838 return -1;
839 loaded_environment = 1;
841 for (ct = config_parameters; ct; ct = ct->next)
842 if (fn(ct->name, ct->value, data) < 0)
843 return -1;
844 return 0;
847 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
849 int ret = 0, found = 0;
850 const char *home = NULL;
852 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
853 if (config_exclusive_filename)
854 return git_config_from_file(fn, config_exclusive_filename, data);
855 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
856 ret += git_config_from_file(fn, git_etc_gitconfig(),
857 data);
858 found += 1;
861 home = getenv("HOME");
862 if (git_config_global() && home) {
863 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
864 if (!access(user_config, R_OK)) {
865 ret += git_config_from_file(fn, user_config, data);
866 found += 1;
868 free(user_config);
871 if (repo_config && !access(repo_config, R_OK)) {
872 ret += git_config_from_file(fn, repo_config, data);
873 found += 1;
876 ret += git_config_from_parameters(fn, data);
877 if (config_parameters)
878 found += 1;
880 return ret == 0 ? found : ret;
883 int git_config(config_fn_t fn, void *data)
885 char *repo_config = NULL;
886 int ret;
888 repo_config = git_pathdup("config");
889 ret = git_config_early(fn, data, repo_config);
890 if (repo_config)
891 free(repo_config);
892 return ret;
896 * Find all the stuff for git_config_set() below.
899 #define MAX_MATCHES 512
901 static struct {
902 int baselen;
903 char *key;
904 int do_not_match;
905 regex_t *value_regex;
906 int multi_replace;
907 size_t offset[MAX_MATCHES];
908 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
909 int seen;
910 } store;
912 static int matches(const char *key, const char *value)
914 return !strcmp(key, store.key) &&
915 (store.value_regex == NULL ||
916 (store.do_not_match ^
917 !regexec(store.value_regex, value, 0, NULL, 0)));
920 static int store_aux(const char *key, const char *value, void *cb)
922 const char *ep;
923 size_t section_len;
925 switch (store.state) {
926 case KEY_SEEN:
927 if (matches(key, value)) {
928 if (store.seen == 1 && store.multi_replace == 0) {
929 warning("%s has multiple values", key);
930 } else if (store.seen >= MAX_MATCHES) {
931 error("too many matches for %s", key);
932 return 1;
935 store.offset[store.seen] = ftell(config_file);
936 store.seen++;
938 break;
939 case SECTION_SEEN:
941 * What we are looking for is in store.key (both
942 * section and var), and its section part is baselen
943 * long. We found key (again, both section and var).
944 * We would want to know if this key is in the same
945 * section as what we are looking for. We already
946 * know we are in the same section as what should
947 * hold store.key.
949 ep = strrchr(key, '.');
950 section_len = ep - key;
952 if ((section_len != store.baselen) ||
953 memcmp(key, store.key, section_len+1)) {
954 store.state = SECTION_END_SEEN;
955 break;
959 * Do not increment matches: this is no match, but we
960 * just made sure we are in the desired section.
962 store.offset[store.seen] = ftell(config_file);
963 /* fallthru */
964 case SECTION_END_SEEN:
965 case START:
966 if (matches(key, value)) {
967 store.offset[store.seen] = ftell(config_file);
968 store.state = KEY_SEEN;
969 store.seen++;
970 } else {
971 if (strrchr(key, '.') - key == store.baselen &&
972 !strncmp(key, store.key, store.baselen)) {
973 store.state = SECTION_SEEN;
974 store.offset[store.seen] = ftell(config_file);
978 return 0;
981 static int write_error(const char *filename)
983 error("failed to write new configuration file %s", filename);
985 /* Same error code as "failed to rename". */
986 return 4;
989 static int store_write_section(int fd, const char *key)
991 const char *dot;
992 int i, success;
993 struct strbuf sb = STRBUF_INIT;
995 dot = memchr(key, '.', store.baselen);
996 if (dot) {
997 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
998 for (i = dot - key + 1; i < store.baselen; i++) {
999 if (key[i] == '"' || key[i] == '\\')
1000 strbuf_addch(&sb, '\\');
1001 strbuf_addch(&sb, key[i]);
1003 strbuf_addstr(&sb, "\"]\n");
1004 } else {
1005 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1008 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1009 strbuf_release(&sb);
1011 return success;
1014 static int store_write_pair(int fd, const char *key, const char *value)
1016 int i, success;
1017 int length = strlen(key + store.baselen + 1);
1018 const char *quote = "";
1019 struct strbuf sb = STRBUF_INIT;
1022 * Check to see if the value needs to be surrounded with a dq pair.
1023 * Note that problematic characters are always backslash-quoted; this
1024 * check is about not losing leading or trailing SP and strings that
1025 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1026 * configuration parser.
1028 if (value[0] == ' ')
1029 quote = "\"";
1030 for (i = 0; value[i]; i++)
1031 if (value[i] == ';' || value[i] == '#')
1032 quote = "\"";
1033 if (i && value[i - 1] == ' ')
1034 quote = "\"";
1036 strbuf_addf(&sb, "\t%.*s = %s",
1037 length, key + store.baselen + 1, quote);
1039 for (i = 0; value[i]; i++)
1040 switch (value[i]) {
1041 case '\n':
1042 strbuf_addstr(&sb, "\\n");
1043 break;
1044 case '\t':
1045 strbuf_addstr(&sb, "\\t");
1046 break;
1047 case '"':
1048 case '\\':
1049 strbuf_addch(&sb, '\\');
1050 default:
1051 strbuf_addch(&sb, value[i]);
1052 break;
1054 strbuf_addf(&sb, "%s\n", quote);
1056 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1057 strbuf_release(&sb);
1059 return success;
1062 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1063 size_t offset_, int *found_bracket)
1065 size_t equal_offset = size, bracket_offset = size;
1066 ssize_t offset;
1068 contline:
1069 for (offset = offset_-2; offset > 0
1070 && contents[offset] != '\n'; offset--)
1071 switch (contents[offset]) {
1072 case '=': equal_offset = offset; break;
1073 case ']': bracket_offset = offset; break;
1075 if (offset > 0 && contents[offset-1] == '\\') {
1076 offset_ = offset;
1077 goto contline;
1079 if (bracket_offset < equal_offset) {
1080 *found_bracket = 1;
1081 offset = bracket_offset+1;
1082 } else
1083 offset++;
1085 return offset;
1088 int git_config_set(const char *key, const char *value)
1090 return git_config_set_multivar(key, value, NULL, 0);
1094 * If value==NULL, unset in (remove from) config,
1095 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1096 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1097 * else all matching key/values (regardless how many) are removed,
1098 * before the new pair is written.
1100 * Returns 0 on success.
1102 * This function does this:
1104 * - it locks the config file by creating ".git/config.lock"
1106 * - it then parses the config using store_aux() as validator to find
1107 * the position on the key/value pair to replace. If it is to be unset,
1108 * it must be found exactly once.
1110 * - the config file is mmap()ed and the part before the match (if any) is
1111 * written to the lock file, then the changed part and the rest.
1113 * - the config file is removed and the lock file rename()d to it.
1116 int git_config_set_multivar(const char *key, const char *value,
1117 const char *value_regex, int multi_replace)
1119 int i, dot;
1120 int fd = -1, in_fd;
1121 int ret;
1122 char *config_filename;
1123 struct lock_file *lock = NULL;
1124 const char *last_dot = strrchr(key, '.');
1126 if (config_exclusive_filename)
1127 config_filename = xstrdup(config_exclusive_filename);
1128 else
1129 config_filename = git_pathdup("config");
1132 * Since "key" actually contains the section name and the real
1133 * key name separated by a dot, we have to know where the dot is.
1136 if (last_dot == NULL) {
1137 error("key does not contain a section: %s", key);
1138 ret = 2;
1139 goto out_free;
1141 store.baselen = last_dot - key;
1143 store.multi_replace = multi_replace;
1146 * Validate the key and while at it, lower case it for matching.
1148 store.key = xmalloc(strlen(key) + 1);
1149 dot = 0;
1150 for (i = 0; key[i]; i++) {
1151 unsigned char c = key[i];
1152 if (c == '.')
1153 dot = 1;
1154 /* Leave the extended basename untouched.. */
1155 if (!dot || i > store.baselen) {
1156 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
1157 error("invalid key: %s", key);
1158 free(store.key);
1159 ret = 1;
1160 goto out_free;
1162 c = tolower(c);
1163 } else if (c == '\n') {
1164 error("invalid key (newline): %s", key);
1165 free(store.key);
1166 ret = 1;
1167 goto out_free;
1169 store.key[i] = c;
1171 store.key[i] = 0;
1174 * The lock serves a purpose in addition to locking: the new
1175 * contents of .git/config will be written into it.
1177 lock = xcalloc(sizeof(struct lock_file), 1);
1178 fd = hold_lock_file_for_update(lock, config_filename, 0);
1179 if (fd < 0) {
1180 error("could not lock config file %s: %s", config_filename, strerror(errno));
1181 free(store.key);
1182 ret = -1;
1183 goto out_free;
1187 * If .git/config does not exist yet, write a minimal version.
1189 in_fd = open(config_filename, O_RDONLY);
1190 if ( in_fd < 0 ) {
1191 free(store.key);
1193 if ( ENOENT != errno ) {
1194 error("opening %s: %s", config_filename,
1195 strerror(errno));
1196 ret = 3; /* same as "invalid config file" */
1197 goto out_free;
1199 /* if nothing to unset, error out */
1200 if (value == NULL) {
1201 ret = 5;
1202 goto out_free;
1205 store.key = (char *)key;
1206 if (!store_write_section(fd, key) ||
1207 !store_write_pair(fd, key, value))
1208 goto write_err_out;
1209 } else {
1210 struct stat st;
1211 char *contents;
1212 size_t contents_sz, copy_begin, copy_end;
1213 int i, new_line = 0;
1215 if (value_regex == NULL)
1216 store.value_regex = NULL;
1217 else {
1218 if (value_regex[0] == '!') {
1219 store.do_not_match = 1;
1220 value_regex++;
1221 } else
1222 store.do_not_match = 0;
1224 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1225 if (regcomp(store.value_regex, value_regex,
1226 REG_EXTENDED)) {
1227 error("invalid pattern: %s", value_regex);
1228 free(store.value_regex);
1229 ret = 6;
1230 goto out_free;
1234 store.offset[0] = 0;
1235 store.state = START;
1236 store.seen = 0;
1239 * After this, store.offset will contain the *end* offset
1240 * of the last match, or remain at 0 if no match was found.
1241 * As a side effect, we make sure to transform only a valid
1242 * existing config file.
1244 if (git_config_from_file(store_aux, config_filename, NULL)) {
1245 error("invalid config file %s", config_filename);
1246 free(store.key);
1247 if (store.value_regex != NULL) {
1248 regfree(store.value_regex);
1249 free(store.value_regex);
1251 ret = 3;
1252 goto out_free;
1255 free(store.key);
1256 if (store.value_regex != NULL) {
1257 regfree(store.value_regex);
1258 free(store.value_regex);
1261 /* if nothing to unset, or too many matches, error out */
1262 if ((store.seen == 0 && value == NULL) ||
1263 (store.seen > 1 && multi_replace == 0)) {
1264 ret = 5;
1265 goto out_free;
1268 fstat(in_fd, &st);
1269 contents_sz = xsize_t(st.st_size);
1270 contents = xmmap(NULL, contents_sz, PROT_READ,
1271 MAP_PRIVATE, in_fd, 0);
1272 close(in_fd);
1274 if (store.seen == 0)
1275 store.seen = 1;
1277 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1278 if (store.offset[i] == 0) {
1279 store.offset[i] = copy_end = contents_sz;
1280 } else if (store.state != KEY_SEEN) {
1281 copy_end = store.offset[i];
1282 } else
1283 copy_end = find_beginning_of_line(
1284 contents, contents_sz,
1285 store.offset[i]-2, &new_line);
1287 if (copy_end > 0 && contents[copy_end-1] != '\n')
1288 new_line = 1;
1290 /* write the first part of the config */
1291 if (copy_end > copy_begin) {
1292 if (write_in_full(fd, contents + copy_begin,
1293 copy_end - copy_begin) <
1294 copy_end - copy_begin)
1295 goto write_err_out;
1296 if (new_line &&
1297 write_str_in_full(fd, "\n") != 1)
1298 goto write_err_out;
1300 copy_begin = store.offset[i];
1303 /* write the pair (value == NULL means unset) */
1304 if (value != NULL) {
1305 if (store.state == START) {
1306 if (!store_write_section(fd, key))
1307 goto write_err_out;
1309 if (!store_write_pair(fd, key, value))
1310 goto write_err_out;
1313 /* write the rest of the config */
1314 if (copy_begin < contents_sz)
1315 if (write_in_full(fd, contents + copy_begin,
1316 contents_sz - copy_begin) <
1317 contents_sz - copy_begin)
1318 goto write_err_out;
1320 munmap(contents, contents_sz);
1323 if (commit_lock_file(lock) < 0) {
1324 error("could not commit config file %s", config_filename);
1325 ret = 4;
1326 goto out_free;
1330 * lock is committed, so don't try to roll it back below.
1331 * NOTE: Since lockfile.c keeps a linked list of all created
1332 * lock_file structures, it isn't safe to free(lock). It's
1333 * better to just leave it hanging around.
1335 lock = NULL;
1336 ret = 0;
1338 out_free:
1339 if (lock)
1340 rollback_lock_file(lock);
1341 free(config_filename);
1342 return ret;
1344 write_err_out:
1345 ret = write_error(lock->filename);
1346 goto out_free;
1350 static int section_name_match (const char *buf, const char *name)
1352 int i = 0, j = 0, dot = 0;
1353 if (buf[i] != '[')
1354 return 0;
1355 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1356 if (!dot && isspace(buf[i])) {
1357 dot = 1;
1358 if (name[j++] != '.')
1359 break;
1360 for (i++; isspace(buf[i]); i++)
1361 ; /* do nothing */
1362 if (buf[i] != '"')
1363 break;
1364 continue;
1366 if (buf[i] == '\\' && dot)
1367 i++;
1368 else if (buf[i] == '"' && dot) {
1369 for (i++; isspace(buf[i]); i++)
1370 ; /* do_nothing */
1371 break;
1373 if (buf[i] != name[j++])
1374 break;
1376 if (buf[i] == ']' && name[j] == 0) {
1378 * We match, now just find the right length offset by
1379 * gobbling up any whitespace after it, as well
1381 i++;
1382 for (; buf[i] && isspace(buf[i]); i++)
1383 ; /* do nothing */
1384 return i;
1386 return 0;
1389 /* if new_name == NULL, the section is removed instead */
1390 int git_config_rename_section(const char *old_name, const char *new_name)
1392 int ret = 0, remove = 0;
1393 char *config_filename;
1394 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1395 int out_fd;
1396 char buf[1024];
1398 if (config_exclusive_filename)
1399 config_filename = xstrdup(config_exclusive_filename);
1400 else
1401 config_filename = git_pathdup("config");
1402 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1403 if (out_fd < 0) {
1404 ret = error("could not lock config file %s", config_filename);
1405 goto out;
1408 if (!(config_file = fopen(config_filename, "rb"))) {
1409 /* no config file means nothing to rename, no error */
1410 goto unlock_and_out;
1413 while (fgets(buf, sizeof(buf), config_file)) {
1414 int i;
1415 int length;
1416 char *output = buf;
1417 for (i = 0; buf[i] && isspace(buf[i]); i++)
1418 ; /* do nothing */
1419 if (buf[i] == '[') {
1420 /* it's a section */
1421 int offset = section_name_match(&buf[i], old_name);
1422 if (offset > 0) {
1423 ret++;
1424 if (new_name == NULL) {
1425 remove = 1;
1426 continue;
1428 store.baselen = strlen(new_name);
1429 if (!store_write_section(out_fd, new_name)) {
1430 ret = write_error(lock->filename);
1431 goto out;
1434 * We wrote out the new section, with
1435 * a newline, now skip the old
1436 * section's length
1438 output += offset + i;
1439 if (strlen(output) > 0) {
1441 * More content means there's
1442 * a declaration to put on the
1443 * next line; indent with a
1444 * tab
1446 output -= 1;
1447 output[0] = '\t';
1450 remove = 0;
1452 if (remove)
1453 continue;
1454 length = strlen(output);
1455 if (write_in_full(out_fd, output, length) != length) {
1456 ret = write_error(lock->filename);
1457 goto out;
1460 fclose(config_file);
1461 unlock_and_out:
1462 if (commit_lock_file(lock) < 0)
1463 ret = error("could not commit config file %s", config_filename);
1464 out:
1465 free(config_filename);
1466 return ret;
1470 * Call this to report error for your variable that should not
1471 * get a boolean value (i.e. "[my] var" means "true").
1473 int config_error_nonbool(const char *var)
1475 return error("Missing value for '%s'", var);