submodule: Use cat instead of echo to avoid DOS line-endings
[git/dscho.git] / config.c
blobfe38074678e7c067fbe3ca7d5469eb71db6a2515
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 typedef struct config_file {
16 struct config_file *prev;
17 FILE *f;
18 const char *name;
19 int linenr;
20 int eof;
21 struct strbuf value;
22 char var[MAXNAME];
23 } config_file;
25 static config_file *cf;
27 static int zlib_compression_seen;
29 const char *config_exclusive_filename = NULL;
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,
51 config_fn_t fn, void *data)
53 struct strbuf **pair;
54 pair = strbuf_split_str(text, '=', 2);
55 if (!pair[0])
56 return error("bogus config parameter: %s", text);
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 error("bogus config parameter: %s", text);
64 lowercase(pair[0]->buf);
65 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
66 strbuf_list_free(pair);
67 return -1;
69 strbuf_list_free(pair);
70 return 0;
73 int git_config_from_parameters(config_fn_t fn, void *data)
75 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
76 char *envw;
77 const char **argv = NULL;
78 int nr = 0, alloc = 0;
79 int i;
81 if (!env)
82 return 0;
83 /* sq_dequote will write over it */
84 envw = xstrdup(env);
86 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
87 free(envw);
88 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
91 for (i = 0; i < nr; i++) {
92 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
93 free(argv);
94 free(envw);
95 return -1;
99 free(argv);
100 free(envw);
101 return nr > 0;
104 static int get_next_char(void)
106 int c;
107 FILE *f;
109 c = '\n';
110 if (cf && ((f = cf->f) != NULL)) {
111 c = fgetc(f);
112 if (c == '\r') {
113 /* DOS like systems */
114 c = fgetc(f);
115 if (c != '\n') {
116 ungetc(c, f);
117 c = '\r';
120 if (c == '\n')
121 cf->linenr++;
122 if (c == EOF) {
123 cf->eof = 1;
124 c = '\n';
127 return c;
130 static char *parse_value(void)
132 int quote = 0, comment = 0, space = 0;
134 strbuf_reset(&cf->value);
135 for (;;) {
136 int c = get_next_char();
137 if (c == '\n') {
138 if (quote)
139 return NULL;
140 return cf->value.buf;
142 if (comment)
143 continue;
144 if (isspace(c) && !quote) {
145 if (cf->value.len)
146 space++;
147 continue;
149 if (!quote) {
150 if (c == ';' || c == '#') {
151 comment = 1;
152 continue;
155 for (; space; space--)
156 strbuf_addch(&cf->value, ' ');
157 if (c == '\\') {
158 c = get_next_char();
159 switch (c) {
160 case '\n':
161 continue;
162 case 't':
163 c = '\t';
164 break;
165 case 'b':
166 c = '\b';
167 break;
168 case 'n':
169 c = '\n';
170 break;
171 /* Some characters escape as themselves */
172 case '\\': case '"':
173 break;
174 /* Reject unknown escape sequences */
175 default:
176 return NULL;
178 strbuf_addch(&cf->value, c);
179 continue;
181 if (c == '"') {
182 quote = 1-quote;
183 continue;
185 strbuf_addch(&cf->value, c);
189 static inline int iskeychar(int c)
191 return isalnum(c) || c == '-';
194 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
196 int c;
197 char *value;
199 /* Get the full name */
200 for (;;) {
201 c = get_next_char();
202 if (cf->eof)
203 break;
204 if (!iskeychar(c))
205 break;
206 name[len++] = tolower(c);
207 if (len >= MAXNAME)
208 return -1;
210 name[len] = 0;
211 while (c == ' ' || c == '\t')
212 c = get_next_char();
214 value = NULL;
215 if (c != '\n') {
216 if (c != '=')
217 return -1;
218 value = parse_value();
219 if (!value)
220 return -1;
222 return fn(name, value, data);
225 static int get_extended_base_var(char *name, int baselen, int c)
227 do {
228 if (c == '\n')
229 return -1;
230 c = get_next_char();
231 } while (isspace(c));
233 /* We require the format to be '[base "extension"]' */
234 if (c != '"')
235 return -1;
236 name[baselen++] = '.';
238 for (;;) {
239 int c = get_next_char();
240 if (c == '\n')
241 return -1;
242 if (c == '"')
243 break;
244 if (c == '\\') {
245 c = get_next_char();
246 if (c == '\n')
247 return -1;
249 name[baselen++] = c;
250 if (baselen > MAXNAME / 2)
251 return -1;
254 /* Final ']' */
255 if (get_next_char() != ']')
256 return -1;
257 return baselen;
260 static int get_base_var(char *name)
262 int baselen = 0;
264 for (;;) {
265 int c = get_next_char();
266 if (cf->eof)
267 return -1;
268 if (c == ']')
269 return baselen;
270 if (isspace(c))
271 return get_extended_base_var(name, baselen, c);
272 if (!iskeychar(c) && c != '.')
273 return -1;
274 if (baselen > MAXNAME / 2)
275 return -1;
276 name[baselen++] = tolower(c);
280 static int git_parse_file(config_fn_t fn, void *data)
282 int comment = 0;
283 int baselen = 0;
284 char *var = cf->var;
286 /* U+FEFF Byte Order Mark in UTF8 */
287 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
288 const unsigned char *bomptr = utf8_bom;
290 for (;;) {
291 int c = get_next_char();
292 if (bomptr && *bomptr) {
293 /* We are at the file beginning; skip UTF8-encoded BOM
294 * if present. Sane editors won't put this in on their
295 * own, but e.g. Windows Notepad will do it happily. */
296 if ((unsigned char) c == *bomptr) {
297 bomptr++;
298 continue;
299 } else {
300 /* Do not tolerate partial BOM. */
301 if (bomptr != utf8_bom)
302 break;
303 /* No BOM at file beginning. Cool. */
304 bomptr = NULL;
307 if (c == '\n') {
308 if (cf->eof)
309 return 0;
310 comment = 0;
311 continue;
313 if (comment || isspace(c))
314 continue;
315 if (c == '#' || c == ';') {
316 comment = 1;
317 continue;
319 if (c == '[') {
320 baselen = get_base_var(var);
321 if (baselen <= 0)
322 break;
323 var[baselen++] = '.';
324 var[baselen] = 0;
325 continue;
327 if (!isalpha(c))
328 break;
329 var[baselen] = tolower(c);
330 if (get_value(fn, data, var, baselen+1) < 0)
331 break;
333 die("bad config file line %d in %s", cf->linenr, cf->name);
336 static int parse_unit_factor(const char *end, unsigned long *val)
338 if (!*end)
339 return 1;
340 else if (!strcasecmp(end, "k")) {
341 *val *= 1024;
342 return 1;
344 else if (!strcasecmp(end, "m")) {
345 *val *= 1024 * 1024;
346 return 1;
348 else if (!strcasecmp(end, "g")) {
349 *val *= 1024 * 1024 * 1024;
350 return 1;
352 return 0;
355 static int git_parse_long(const char *value, long *ret)
357 if (value && *value) {
358 char *end;
359 long val = strtol(value, &end, 0);
360 unsigned long factor = 1;
361 if (!parse_unit_factor(end, &factor))
362 return 0;
363 *ret = val * factor;
364 return 1;
366 return 0;
369 int git_parse_ulong(const char *value, unsigned long *ret)
371 if (value && *value) {
372 char *end;
373 unsigned long val = strtoul(value, &end, 0);
374 if (!parse_unit_factor(end, &val))
375 return 0;
376 *ret = val;
377 return 1;
379 return 0;
382 static void die_bad_config(const char *name)
384 if (cf && cf->name)
385 die("bad config value for '%s' in %s", name, cf->name);
386 die("bad config value for '%s'", name);
389 int git_config_int(const char *name, const char *value)
391 long ret = 0;
392 if (!git_parse_long(value, &ret))
393 die_bad_config(name);
394 return ret;
397 unsigned long git_config_ulong(const char *name, const char *value)
399 unsigned long ret;
400 if (!git_parse_ulong(value, &ret))
401 die_bad_config(name);
402 return ret;
405 static int git_config_maybe_bool_text(const char *name, const char *value)
407 if (!value)
408 return 1;
409 if (!*value)
410 return 0;
411 if (!strcasecmp(value, "true")
412 || !strcasecmp(value, "yes")
413 || !strcasecmp(value, "on"))
414 return 1;
415 if (!strcasecmp(value, "false")
416 || !strcasecmp(value, "no")
417 || !strcasecmp(value, "off"))
418 return 0;
419 return -1;
422 int git_config_maybe_bool(const char *name, const char *value)
424 long v = git_config_maybe_bool_text(name, value);
425 if (0 <= v)
426 return v;
427 if (git_parse_long(value, &v))
428 return !!v;
429 return -1;
432 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
434 int v = git_config_maybe_bool_text(name, value);
435 if (0 <= v) {
436 *is_bool = 1;
437 return v;
439 *is_bool = 0;
440 return git_config_int(name, value);
443 int git_config_bool(const char *name, const char *value)
445 int discard;
446 return !!git_config_bool_or_int(name, value, &discard);
449 int git_config_string(const char **dest, const char *var, const char *value)
451 if (!value)
452 return config_error_nonbool(var);
453 *dest = xstrdup(value);
454 return 0;
457 int git_config_pathname(const char **dest, const char *var, const char *value)
459 if (!value)
460 return config_error_nonbool(var);
461 *dest = expand_user_path(value);
462 if (!*dest)
463 die("Failed to expand user dir in: '%s'", value);
464 return 0;
467 static int git_default_core_config(const char *var, const char *value)
469 /* This needs a better name */
470 if (!strcmp(var, "core.filemode")) {
471 trust_executable_bit = git_config_bool(var, value);
472 return 0;
474 if (!strcmp(var, "core.trustctime")) {
475 trust_ctime = git_config_bool(var, value);
476 return 0;
479 if (!strcmp(var, "core.quotepath")) {
480 quote_path_fully = git_config_bool(var, value);
481 return 0;
484 if (!strcmp(var, "core.symlinks")) {
485 has_symlinks = git_config_bool(var, value);
486 return 0;
489 if (!strcmp(var, "core.ignorecase")) {
490 ignore_case = git_config_bool(var, value);
491 return 0;
494 if (!strcmp(var, "core.bare")) {
495 is_bare_repository_cfg = git_config_bool(var, value);
496 return 0;
499 if (!strcmp(var, "core.ignorestat")) {
500 assume_unchanged = git_config_bool(var, value);
501 return 0;
504 if (!strcmp(var, "core.prefersymlinkrefs")) {
505 prefer_symlink_refs = git_config_bool(var, value);
506 return 0;
509 if (!strcmp(var, "core.logallrefupdates")) {
510 log_all_ref_updates = git_config_bool(var, value);
511 return 0;
514 if (!strcmp(var, "core.warnambiguousrefs")) {
515 warn_ambiguous_refs = git_config_bool(var, value);
516 return 0;
519 if (!strcmp(var, "core.abbrev")) {
520 int abbrev = git_config_int(var, value);
521 if (abbrev < minimum_abbrev || abbrev > 40)
522 return -1;
523 default_abbrev = abbrev;
524 return 0;
527 if (!strcmp(var, "core.loosecompression")) {
528 int level = git_config_int(var, value);
529 if (level == -1)
530 level = Z_DEFAULT_COMPRESSION;
531 else if (level < 0 || level > Z_BEST_COMPRESSION)
532 die("bad zlib compression level %d", level);
533 zlib_compression_level = level;
534 zlib_compression_seen = 1;
535 return 0;
538 if (!strcmp(var, "core.compression")) {
539 int level = git_config_int(var, value);
540 if (level == -1)
541 level = Z_DEFAULT_COMPRESSION;
542 else if (level < 0 || level > Z_BEST_COMPRESSION)
543 die("bad zlib compression level %d", level);
544 core_compression_level = level;
545 core_compression_seen = 1;
546 if (!zlib_compression_seen)
547 zlib_compression_level = level;
548 return 0;
551 if (!strcmp(var, "core.packedgitwindowsize")) {
552 int pgsz_x2 = getpagesize() * 2;
553 packed_git_window_size = git_config_int(var, value);
555 /* This value must be multiple of (pagesize * 2) */
556 packed_git_window_size /= pgsz_x2;
557 if (packed_git_window_size < 1)
558 packed_git_window_size = 1;
559 packed_git_window_size *= pgsz_x2;
560 return 0;
563 if (!strcmp(var, "core.bigfilethreshold")) {
564 long n = git_config_int(var, value);
565 big_file_threshold = 0 < n ? n : 0;
566 return 0;
569 if (!strcmp(var, "core.packedgitlimit")) {
570 packed_git_limit = git_config_int(var, value);
571 return 0;
574 if (!strcmp(var, "core.deltabasecachelimit")) {
575 delta_base_cache_limit = git_config_int(var, value);
576 return 0;
579 if (!strcmp(var, "core.logpackaccess"))
580 return git_config_string(&log_pack_access, var, value);
582 if (!strcmp(var, "core.autocrlf")) {
583 if (value && !strcasecmp(value, "input")) {
584 if (core_eol == EOL_CRLF)
585 return error("core.autocrlf=input conflicts with core.eol=crlf");
586 auto_crlf = AUTO_CRLF_INPUT;
587 return 0;
589 auto_crlf = git_config_bool(var, value);
590 return 0;
593 if (!strcmp(var, "core.safecrlf")) {
594 if (value && !strcasecmp(value, "warn")) {
595 safe_crlf = SAFE_CRLF_WARN;
596 return 0;
598 safe_crlf = git_config_bool(var, value);
599 return 0;
602 if (!strcmp(var, "core.eol")) {
603 if (value && !strcasecmp(value, "lf"))
604 core_eol = EOL_LF;
605 else if (value && !strcasecmp(value, "crlf"))
606 core_eol = EOL_CRLF;
607 else if (value && !strcasecmp(value, "native"))
608 core_eol = EOL_NATIVE;
609 else
610 core_eol = EOL_UNSET;
611 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
612 return error("core.autocrlf=input conflicts with core.eol=crlf");
613 return 0;
616 if (!strcmp(var, "core.notesref")) {
617 notes_ref_name = xstrdup(value);
618 return 0;
621 if (!strcmp(var, "core.pager"))
622 return git_config_string(&pager_program, var, value);
624 if (!strcmp(var, "core.editor"))
625 return git_config_string(&editor_program, var, value);
627 if (!strcmp(var, "core.askpass"))
628 return git_config_string(&askpass_program, var, value);
630 if (!strcmp(var, "core.excludesfile"))
631 return git_config_pathname(&excludes_file, var, value);
633 if (!strcmp(var, "core.whitespace")) {
634 if (!value)
635 return config_error_nonbool(var);
636 whitespace_rule_cfg = parse_whitespace_rule(value);
637 return 0;
640 if (!strcmp(var, "core.fsyncobjectfiles")) {
641 fsync_object_files = git_config_bool(var, value);
642 return 0;
645 if (!strcmp(var, "core.preloadindex")) {
646 core_preload_index = git_config_bool(var, value);
647 return 0;
650 if (!strcmp(var, "core.createobject")) {
651 if (!strcmp(value, "rename"))
652 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
653 else if (!strcmp(value, "link"))
654 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
655 else
656 die("Invalid mode for object creation: %s", value);
657 return 0;
660 if (!strcmp(var, "core.sparsecheckout")) {
661 core_apply_sparse_checkout = git_config_bool(var, value);
662 return 0;
665 if (!strcmp(var, "core.hidedotfiles")) {
666 if (value && !strcasecmp(value, "dotgitonly")) {
667 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
668 return 0;
670 hide_dotfiles = git_config_bool(var, value);
671 return 0;
674 /* Add other config variables here and to Documentation/config.txt. */
675 return 0;
678 static int git_default_user_config(const char *var, const char *value)
680 if (!strcmp(var, "user.name")) {
681 if (!value)
682 return config_error_nonbool(var);
683 strlcpy(git_default_name, value, sizeof(git_default_name));
684 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
685 return 0;
688 if (!strcmp(var, "user.email")) {
689 if (!value)
690 return config_error_nonbool(var);
691 strlcpy(git_default_email, value, sizeof(git_default_email));
692 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
693 return 0;
696 /* Add other config variables here and to Documentation/config.txt. */
697 return 0;
700 static int git_default_i18n_config(const char *var, const char *value)
702 if (!strcmp(var, "i18n.commitencoding"))
703 return git_config_string(&git_commit_encoding, var, value);
705 if (!strcmp(var, "i18n.logoutputencoding"))
706 return git_config_string(&git_log_output_encoding, var, value);
708 /* Add other config variables here and to Documentation/config.txt. */
709 return 0;
712 static int git_default_branch_config(const char *var, const char *value)
714 if (!strcmp(var, "branch.autosetupmerge")) {
715 if (value && !strcasecmp(value, "always")) {
716 git_branch_track = BRANCH_TRACK_ALWAYS;
717 return 0;
719 git_branch_track = git_config_bool(var, value);
720 return 0;
722 if (!strcmp(var, "branch.autosetuprebase")) {
723 if (!value)
724 return config_error_nonbool(var);
725 else if (!strcmp(value, "never"))
726 autorebase = AUTOREBASE_NEVER;
727 else if (!strcmp(value, "local"))
728 autorebase = AUTOREBASE_LOCAL;
729 else if (!strcmp(value, "remote"))
730 autorebase = AUTOREBASE_REMOTE;
731 else if (!strcmp(value, "always"))
732 autorebase = AUTOREBASE_ALWAYS;
733 else
734 return error("Malformed value for %s", var);
735 return 0;
738 /* Add other config variables here and to Documentation/config.txt. */
739 return 0;
742 static int git_default_push_config(const char *var, const char *value)
744 if (!strcmp(var, "push.default")) {
745 if (!value)
746 return config_error_nonbool(var);
747 else if (!strcmp(value, "nothing"))
748 push_default = PUSH_DEFAULT_NOTHING;
749 else if (!strcmp(value, "matching"))
750 push_default = PUSH_DEFAULT_MATCHING;
751 else if (!strcmp(value, "upstream"))
752 push_default = PUSH_DEFAULT_UPSTREAM;
753 else if (!strcmp(value, "tracking")) /* deprecated */
754 push_default = PUSH_DEFAULT_UPSTREAM;
755 else if (!strcmp(value, "current"))
756 push_default = PUSH_DEFAULT_CURRENT;
757 else {
758 error("Malformed value for %s: %s", var, value);
759 return error("Must be one of nothing, matching, "
760 "tracking or current.");
762 return 0;
765 /* Add other config variables here and to Documentation/config.txt. */
766 return 0;
769 static int git_default_mailmap_config(const char *var, const char *value)
771 if (!strcmp(var, "mailmap.file"))
772 return git_config_string(&git_mailmap_file, var, value);
774 /* Add other config variables here and to Documentation/config.txt. */
775 return 0;
778 int git_default_config(const char *var, const char *value, void *dummy)
780 if (!prefixcmp(var, "core."))
781 return git_default_core_config(var, value);
783 if (!prefixcmp(var, "user."))
784 return git_default_user_config(var, value);
786 if (!prefixcmp(var, "i18n."))
787 return git_default_i18n_config(var, value);
789 if (!prefixcmp(var, "branch."))
790 return git_default_branch_config(var, value);
792 if (!prefixcmp(var, "push."))
793 return git_default_push_config(var, value);
795 if (!prefixcmp(var, "mailmap."))
796 return git_default_mailmap_config(var, value);
798 if (!prefixcmp(var, "advice."))
799 return git_default_advice_config(var, value);
801 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
802 pager_use_color = git_config_bool(var,value);
803 return 0;
806 /* Add other config variables here and to Documentation/config.txt. */
807 return 0;
810 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
812 int ret;
813 FILE *f = fopen(filename, "r");
815 ret = -1;
816 if (f) {
817 config_file top;
819 /* push config-file parsing state stack */
820 top.prev = cf;
821 top.f = f;
822 top.name = filename;
823 top.linenr = 1;
824 top.eof = 0;
825 strbuf_init(&top.value, 1024);
826 cf = &top;
828 ret = git_parse_file(fn, data);
830 /* pop config-file parsing state stack */
831 strbuf_release(&top.value);
832 cf = top.prev;
834 fclose(f);
836 return ret;
839 const char *git_etc_gitconfig(void)
841 static const char *system_wide;
842 if (!system_wide)
843 system_wide = system_path(ETC_GITCONFIG);
844 return system_wide;
847 int git_env_bool(const char *k, int def)
849 const char *v = getenv(k);
850 return v ? git_config_bool(k, v) : def;
853 int git_config_system(void)
855 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 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 = get_home_directory();
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 switch (git_config_from_parameters(fn, data)) {
888 case -1: /* error */
889 die("unable to parse command-line config");
890 break;
891 case 0: /* found nothing */
892 break;
893 default: /* found at least one item */
894 found++;
895 break;
898 return ret == 0 ? found : ret;
901 int git_config(config_fn_t fn, void *data)
903 char *repo_config = NULL;
904 int ret;
906 repo_config = git_pathdup("config");
907 ret = git_config_early(fn, data, repo_config);
908 if (repo_config)
909 free(repo_config);
910 return ret;
914 * Find all the stuff for git_config_set() below.
917 #define MAX_MATCHES 512
919 static struct {
920 int baselen;
921 char *key;
922 int do_not_match;
923 regex_t *value_regex;
924 int multi_replace;
925 size_t offset[MAX_MATCHES];
926 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
927 int seen;
928 } store;
930 static int matches(const char *key, const char *value)
932 return !strcmp(key, store.key) &&
933 (store.value_regex == NULL ||
934 (store.do_not_match ^
935 !regexec(store.value_regex, value, 0, NULL, 0)));
938 static int store_aux(const char *key, const char *value, void *cb)
940 const char *ep;
941 size_t section_len;
942 FILE *f = cf->f;
944 switch (store.state) {
945 case KEY_SEEN:
946 if (matches(key, value)) {
947 if (store.seen == 1 && store.multi_replace == 0) {
948 warning("%s has multiple values", key);
949 } else if (store.seen >= MAX_MATCHES) {
950 error("too many matches for %s", key);
951 return 1;
954 store.offset[store.seen] = ftell(f);
955 store.seen++;
957 break;
958 case SECTION_SEEN:
960 * What we are looking for is in store.key (both
961 * section and var), and its section part is baselen
962 * long. We found key (again, both section and var).
963 * We would want to know if this key is in the same
964 * section as what we are looking for. We already
965 * know we are in the same section as what should
966 * hold store.key.
968 ep = strrchr(key, '.');
969 section_len = ep - key;
971 if ((section_len != store.baselen) ||
972 memcmp(key, store.key, section_len+1)) {
973 store.state = SECTION_END_SEEN;
974 break;
978 * Do not increment matches: this is no match, but we
979 * just made sure we are in the desired section.
981 store.offset[store.seen] = ftell(f);
982 /* fallthru */
983 case SECTION_END_SEEN:
984 case START:
985 if (matches(key, value)) {
986 store.offset[store.seen] = ftell(f);
987 store.state = KEY_SEEN;
988 store.seen++;
989 } else {
990 if (strrchr(key, '.') - key == store.baselen &&
991 !strncmp(key, store.key, store.baselen)) {
992 store.state = SECTION_SEEN;
993 store.offset[store.seen] = ftell(f);
997 return 0;
1000 static int write_error(const char *filename)
1002 error("failed to write new configuration file %s", filename);
1004 /* Same error code as "failed to rename". */
1005 return 4;
1008 static int store_write_section(int fd, const char *key)
1010 const char *dot;
1011 int i, success;
1012 struct strbuf sb = STRBUF_INIT;
1014 dot = memchr(key, '.', store.baselen);
1015 if (dot) {
1016 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1017 for (i = dot - key + 1; i < store.baselen; i++) {
1018 if (key[i] == '"' || key[i] == '\\')
1019 strbuf_addch(&sb, '\\');
1020 strbuf_addch(&sb, key[i]);
1022 strbuf_addstr(&sb, "\"]\n");
1023 } else {
1024 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1027 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1028 strbuf_release(&sb);
1030 return success;
1033 static int store_write_pair(int fd, const char *key, const char *value)
1035 int i, success;
1036 int length = strlen(key + store.baselen + 1);
1037 const char *quote = "";
1038 struct strbuf sb = STRBUF_INIT;
1041 * Check to see if the value needs to be surrounded with a dq pair.
1042 * Note that problematic characters are always backslash-quoted; this
1043 * check is about not losing leading or trailing SP and strings that
1044 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1045 * configuration parser.
1047 if (value[0] == ' ')
1048 quote = "\"";
1049 for (i = 0; value[i]; i++)
1050 if (value[i] == ';' || value[i] == '#')
1051 quote = "\"";
1052 if (i && value[i - 1] == ' ')
1053 quote = "\"";
1055 strbuf_addf(&sb, "\t%.*s = %s",
1056 length, key + store.baselen + 1, quote);
1058 for (i = 0; value[i]; i++)
1059 switch (value[i]) {
1060 case '\n':
1061 strbuf_addstr(&sb, "\\n");
1062 break;
1063 case '\t':
1064 strbuf_addstr(&sb, "\\t");
1065 break;
1066 case '"':
1067 case '\\':
1068 strbuf_addch(&sb, '\\');
1069 default:
1070 strbuf_addch(&sb, value[i]);
1071 break;
1073 strbuf_addf(&sb, "%s\n", quote);
1075 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1076 strbuf_release(&sb);
1078 return success;
1081 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1082 size_t offset_, int *found_bracket)
1084 size_t equal_offset = size, bracket_offset = size;
1085 ssize_t offset;
1087 contline:
1088 for (offset = offset_-2; offset > 0
1089 && contents[offset] != '\n'; offset--)
1090 switch (contents[offset]) {
1091 case '=': equal_offset = offset; break;
1092 case ']': bracket_offset = offset; break;
1094 if (offset > 0 && contents[offset-1] == '\\') {
1095 offset_ = offset;
1096 goto contline;
1098 if (bracket_offset < equal_offset) {
1099 *found_bracket = 1;
1100 offset = bracket_offset+1;
1101 } else
1102 offset++;
1104 return offset;
1107 int git_config_set_in_file(const char *config_filename,
1108 const char *key, const char *value)
1110 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1113 int git_config_set(const char *key, const char *value)
1115 return git_config_set_multivar(key, value, NULL, 0);
1119 * Auxiliary function to sanity-check and split the key into the section
1120 * identifier and variable name.
1122 * Returns 0 on success, -1 when there is an invalid character in the key and
1123 * -2 if there is no section name in the key.
1125 * store_key - pointer to char* which will hold a copy of the key with
1126 * lowercase section and variable name
1127 * baselen - pointer to int which will hold the length of the
1128 * section + subsection part, can be NULL
1130 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1132 int i, dot, baselen;
1133 const char *last_dot = strrchr(key, '.');
1136 * Since "key" actually contains the section name and the real
1137 * key name separated by a dot, we have to know where the dot is.
1140 if (last_dot == NULL || last_dot == key) {
1141 error("key does not contain a section: %s", key);
1142 return -CONFIG_NO_SECTION_OR_NAME;
1145 if (!last_dot[1]) {
1146 error("key does not contain variable name: %s", key);
1147 return -CONFIG_NO_SECTION_OR_NAME;
1150 baselen = last_dot - key;
1151 if (baselen_)
1152 *baselen_ = baselen;
1155 * Validate the key and while at it, lower case it for matching.
1157 *store_key = xmalloc(strlen(key) + 1);
1159 dot = 0;
1160 for (i = 0; key[i]; i++) {
1161 unsigned char c = key[i];
1162 if (c == '.')
1163 dot = 1;
1164 /* Leave the extended basename untouched.. */
1165 if (!dot || i > baselen) {
1166 if (!iskeychar(c) ||
1167 (i == baselen + 1 && !isalpha(c))) {
1168 error("invalid key: %s", key);
1169 goto out_free_ret_1;
1171 c = tolower(c);
1172 } else if (c == '\n') {
1173 error("invalid key (newline): %s", key);
1174 goto out_free_ret_1;
1176 (*store_key)[i] = c;
1178 (*store_key)[i] = 0;
1180 return 0;
1182 out_free_ret_1:
1183 free(*store_key);
1184 return -CONFIG_INVALID_KEY;
1188 * If value==NULL, unset in (remove from) config,
1189 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1190 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1191 * else all matching key/values (regardless how many) are removed,
1192 * before the new pair is written.
1194 * Returns 0 on success.
1196 * This function does this:
1198 * - it locks the config file by creating ".git/config.lock"
1200 * - it then parses the config using store_aux() as validator to find
1201 * the position on the key/value pair to replace. If it is to be unset,
1202 * it must be found exactly once.
1204 * - the config file is mmap()ed and the part before the match (if any) is
1205 * written to the lock file, then the changed part and the rest.
1207 * - the config file is removed and the lock file rename()d to it.
1210 int git_config_set_multivar_in_file(const char *config_filename,
1211 const char *key, const char *value,
1212 const char *value_regex, int multi_replace)
1214 int fd = -1, in_fd;
1215 int ret;
1216 struct lock_file *lock = NULL;
1218 /* parse-key returns negative; flip the sign to feed exit(3) */
1219 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1220 if (ret)
1221 goto out_free;
1223 store.multi_replace = multi_replace;
1227 * The lock serves a purpose in addition to locking: the new
1228 * contents of .git/config will be written into it.
1230 lock = xcalloc(sizeof(struct lock_file), 1);
1231 fd = hold_lock_file_for_update(lock, config_filename, 0);
1232 if (fd < 0) {
1233 error("could not lock config file %s: %s", config_filename, strerror(errno));
1234 free(store.key);
1235 ret = CONFIG_NO_LOCK;
1236 goto out_free;
1240 * If .git/config does not exist yet, write a minimal version.
1242 in_fd = open(config_filename, O_RDONLY);
1243 if ( in_fd < 0 ) {
1244 free(store.key);
1246 if ( ENOENT != errno ) {
1247 error("opening %s: %s", config_filename,
1248 strerror(errno));
1249 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1250 goto out_free;
1252 /* if nothing to unset, error out */
1253 if (value == NULL) {
1254 ret = CONFIG_NOTHING_SET;
1255 goto out_free;
1258 store.key = (char *)key;
1259 if (!store_write_section(fd, key) ||
1260 !store_write_pair(fd, key, value))
1261 goto write_err_out;
1262 } else {
1263 struct stat st;
1264 char *contents;
1265 size_t contents_sz, copy_begin, copy_end;
1266 int i, new_line = 0;
1268 if (value_regex == NULL)
1269 store.value_regex = NULL;
1270 else {
1271 if (value_regex[0] == '!') {
1272 store.do_not_match = 1;
1273 value_regex++;
1274 } else
1275 store.do_not_match = 0;
1277 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1278 if (regcomp(store.value_regex, value_regex,
1279 REG_EXTENDED)) {
1280 error("invalid pattern: %s", value_regex);
1281 free(store.value_regex);
1282 ret = CONFIG_INVALID_PATTERN;
1283 goto out_free;
1287 store.offset[0] = 0;
1288 store.state = START;
1289 store.seen = 0;
1292 * After this, store.offset will contain the *end* offset
1293 * of the last match, or remain at 0 if no match was found.
1294 * As a side effect, we make sure to transform only a valid
1295 * existing config file.
1297 if (git_config_from_file(store_aux, config_filename, NULL)) {
1298 error("invalid config file %s", config_filename);
1299 free(store.key);
1300 if (store.value_regex != NULL) {
1301 regfree(store.value_regex);
1302 free(store.value_regex);
1304 ret = CONFIG_INVALID_FILE;
1305 goto out_free;
1308 free(store.key);
1309 if (store.value_regex != NULL) {
1310 regfree(store.value_regex);
1311 free(store.value_regex);
1314 /* if nothing to unset, or too many matches, error out */
1315 if ((store.seen == 0 && value == NULL) ||
1316 (store.seen > 1 && multi_replace == 0)) {
1317 ret = CONFIG_NOTHING_SET;
1318 goto out_free;
1321 fstat(in_fd, &st);
1322 contents_sz = xsize_t(st.st_size);
1323 contents = xmmap(NULL, contents_sz, PROT_READ,
1324 MAP_PRIVATE, in_fd, 0);
1325 close(in_fd);
1327 if (store.seen == 0)
1328 store.seen = 1;
1330 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1331 if (store.offset[i] == 0) {
1332 store.offset[i] = copy_end = contents_sz;
1333 } else if (store.state != KEY_SEEN) {
1334 copy_end = store.offset[i];
1335 } else
1336 copy_end = find_beginning_of_line(
1337 contents, contents_sz,
1338 store.offset[i]-2, &new_line);
1340 if (copy_end > 0 && contents[copy_end-1] != '\n')
1341 new_line = 1;
1343 /* write the first part of the config */
1344 if (copy_end > copy_begin) {
1345 if (write_in_full(fd, contents + copy_begin,
1346 copy_end - copy_begin) <
1347 copy_end - copy_begin)
1348 goto write_err_out;
1349 if (new_line &&
1350 write_str_in_full(fd, "\n") != 1)
1351 goto write_err_out;
1353 copy_begin = store.offset[i];
1356 /* write the pair (value == NULL means unset) */
1357 if (value != NULL) {
1358 if (store.state == START) {
1359 if (!store_write_section(fd, key))
1360 goto write_err_out;
1362 if (!store_write_pair(fd, key, value))
1363 goto write_err_out;
1366 /* write the rest of the config */
1367 if (copy_begin < contents_sz)
1368 if (write_in_full(fd, contents + copy_begin,
1369 contents_sz - copy_begin) <
1370 contents_sz - copy_begin)
1371 goto write_err_out;
1373 munmap(contents, contents_sz);
1376 if (commit_lock_file(lock) < 0) {
1377 error("could not commit config file %s", config_filename);
1378 ret = CONFIG_NO_WRITE;
1379 goto out_free;
1383 * lock is committed, so don't try to roll it back below.
1384 * NOTE: Since lockfile.c keeps a linked list of all created
1385 * lock_file structures, it isn't safe to free(lock). It's
1386 * better to just leave it hanging around.
1388 lock = NULL;
1389 ret = 0;
1391 out_free:
1392 if (lock)
1393 rollback_lock_file(lock);
1394 return ret;
1396 write_err_out:
1397 ret = write_error(lock->filename);
1398 goto out_free;
1402 int git_config_set_multivar(const char *key, const char *value,
1403 const char *value_regex, int multi_replace)
1405 const char *config_filename;
1406 char *buf = NULL;
1407 int ret;
1409 if (config_exclusive_filename)
1410 config_filename = config_exclusive_filename;
1411 else
1412 config_filename = buf = git_pathdup("config");
1414 ret = git_config_set_multivar_in_file(config_filename, key, value,
1415 value_regex, multi_replace);
1416 free(buf);
1417 return ret;
1420 static int section_name_match (const char *buf, const char *name)
1422 int i = 0, j = 0, dot = 0;
1423 if (buf[i] != '[')
1424 return 0;
1425 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1426 if (!dot && isspace(buf[i])) {
1427 dot = 1;
1428 if (name[j++] != '.')
1429 break;
1430 for (i++; isspace(buf[i]); i++)
1431 ; /* do nothing */
1432 if (buf[i] != '"')
1433 break;
1434 continue;
1436 if (buf[i] == '\\' && dot)
1437 i++;
1438 else if (buf[i] == '"' && dot) {
1439 for (i++; isspace(buf[i]); i++)
1440 ; /* do_nothing */
1441 break;
1443 if (buf[i] != name[j++])
1444 break;
1446 if (buf[i] == ']' && name[j] == 0) {
1448 * We match, now just find the right length offset by
1449 * gobbling up any whitespace after it, as well
1451 i++;
1452 for (; buf[i] && isspace(buf[i]); i++)
1453 ; /* do nothing */
1454 return i;
1456 return 0;
1459 /* if new_name == NULL, the section is removed instead */
1460 int git_config_rename_section(const char *old_name, const char *new_name)
1462 int ret = 0, remove = 0;
1463 char *config_filename;
1464 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1465 int out_fd;
1466 char buf[1024];
1467 FILE *config_file;
1469 if (config_exclusive_filename)
1470 config_filename = xstrdup(config_exclusive_filename);
1471 else
1472 config_filename = git_pathdup("config");
1473 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1474 if (out_fd < 0) {
1475 ret = error("could not lock config file %s", config_filename);
1476 goto out;
1479 if (!(config_file = fopen(config_filename, "rb"))) {
1480 /* no config file means nothing to rename, no error */
1481 goto unlock_and_out;
1484 while (fgets(buf, sizeof(buf), config_file)) {
1485 int i;
1486 int length;
1487 char *output = buf;
1488 for (i = 0; buf[i] && isspace(buf[i]); i++)
1489 ; /* do nothing */
1490 if (buf[i] == '[') {
1491 /* it's a section */
1492 int offset = section_name_match(&buf[i], old_name);
1493 if (offset > 0) {
1494 ret++;
1495 if (new_name == NULL) {
1496 remove = 1;
1497 continue;
1499 store.baselen = strlen(new_name);
1500 if (!store_write_section(out_fd, new_name)) {
1501 ret = write_error(lock->filename);
1502 goto out;
1505 * We wrote out the new section, with
1506 * a newline, now skip the old
1507 * section's length
1509 output += offset + i;
1510 if (strlen(output) > 0) {
1512 * More content means there's
1513 * a declaration to put on the
1514 * next line; indent with a
1515 * tab
1517 output -= 1;
1518 output[0] = '\t';
1521 remove = 0;
1523 if (remove)
1524 continue;
1525 length = strlen(output);
1526 if (write_in_full(out_fd, output, length) != length) {
1527 ret = write_error(lock->filename);
1528 goto out;
1531 fclose(config_file);
1532 unlock_and_out:
1533 if (commit_lock_file(lock) < 0)
1534 ret = error("could not commit config file %s", config_filename);
1535 out:
1536 free(config_filename);
1537 return ret;
1541 * Call this to report error for your variable that should not
1542 * get a boolean value (i.e. "[my] var" means "true").
1544 int config_error_nonbool(const char *var)
1546 return error("Missing value for '%s'", var);