Merge branch 'jk/maint-config-alias-fix'
[git/dscho.git] / config.c
bloba8267e926581378e46b83bd11ab38eac76886430
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 static void lowercase(char *p)
25 for (; *p; p++)
26 *p = tolower(*p);
29 void git_config_push_parameter(const char *text)
31 struct strbuf env = STRBUF_INIT;
32 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
33 if (old) {
34 strbuf_addstr(&env, old);
35 strbuf_addch(&env, ' ');
37 sq_quote_buf(&env, text);
38 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
39 strbuf_release(&env);
42 static int git_config_parse_parameter(const char *text,
43 config_fn_t fn, void *data)
45 struct strbuf tmp = STRBUF_INIT;
46 struct strbuf **pair;
47 strbuf_addstr(&tmp, text);
48 pair = strbuf_split(&tmp, '=');
49 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
50 strbuf_setlen(pair[0], pair[0]->len - 1);
51 strbuf_trim(pair[0]);
52 if (!pair[0]->len) {
53 strbuf_list_free(pair);
54 return error("bogus config parameter: %s", text);
56 lowercase(pair[0]->buf);
57 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
58 strbuf_list_free(pair);
59 return -1;
61 strbuf_list_free(pair);
62 return 0;
65 int git_config_from_parameters(config_fn_t fn, void *data)
67 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
68 char *envw;
69 const char **argv = NULL;
70 int nr = 0, alloc = 0;
71 int i;
73 if (!env)
74 return 0;
75 /* sq_dequote will write over it */
76 envw = xstrdup(env);
78 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
79 free(envw);
80 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
83 for (i = 0; i < nr; i++) {
84 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
85 free(argv);
86 free(envw);
87 return -1;
91 free(argv);
92 free(envw);
93 return nr > 0;
96 static int get_next_char(void)
98 int c;
99 FILE *f;
101 c = '\n';
102 if ((f = config_file) != NULL) {
103 c = fgetc(f);
104 if (c == '\r') {
105 /* DOS like systems */
106 c = fgetc(f);
107 if (c != '\n') {
108 ungetc(c, f);
109 c = '\r';
112 if (c == '\n')
113 config_linenr++;
114 if (c == EOF) {
115 config_file_eof = 1;
116 c = '\n';
119 return c;
122 static char *parse_value(void)
124 static struct strbuf value = STRBUF_INIT;
125 int quote = 0, comment = 0, space = 0;
127 strbuf_reset(&value);
128 for (;;) {
129 int c = get_next_char();
130 if (c == '\n') {
131 if (quote)
132 return NULL;
133 return value.buf;
135 if (comment)
136 continue;
137 if (isspace(c) && !quote) {
138 if (value.len)
139 space++;
140 continue;
142 if (!quote) {
143 if (c == ';' || c == '#') {
144 comment = 1;
145 continue;
148 for (; space; space--)
149 strbuf_addch(&value, ' ');
150 if (c == '\\') {
151 c = get_next_char();
152 switch (c) {
153 case '\n':
154 continue;
155 case 't':
156 c = '\t';
157 break;
158 case 'b':
159 c = '\b';
160 break;
161 case 'n':
162 c = '\n';
163 break;
164 /* Some characters escape as themselves */
165 case '\\': case '"':
166 break;
167 /* Reject unknown escape sequences */
168 default:
169 return NULL;
171 strbuf_addch(&value, c);
172 continue;
174 if (c == '"') {
175 quote = 1-quote;
176 continue;
178 strbuf_addch(&value, c);
182 static inline int iskeychar(int c)
184 return isalnum(c) || c == '-';
187 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
189 int c;
190 char *value;
192 /* Get the full name */
193 for (;;) {
194 c = get_next_char();
195 if (config_file_eof)
196 break;
197 if (!iskeychar(c))
198 break;
199 name[len++] = tolower(c);
200 if (len >= MAXNAME)
201 return -1;
203 name[len] = 0;
204 while (c == ' ' || c == '\t')
205 c = get_next_char();
207 value = NULL;
208 if (c != '\n') {
209 if (c != '=')
210 return -1;
211 value = parse_value();
212 if (!value)
213 return -1;
215 return fn(name, value, data);
218 static int get_extended_base_var(char *name, int baselen, int c)
220 do {
221 if (c == '\n')
222 return -1;
223 c = get_next_char();
224 } while (isspace(c));
226 /* We require the format to be '[base "extension"]' */
227 if (c != '"')
228 return -1;
229 name[baselen++] = '.';
231 for (;;) {
232 int c = get_next_char();
233 if (c == '\n')
234 return -1;
235 if (c == '"')
236 break;
237 if (c == '\\') {
238 c = get_next_char();
239 if (c == '\n')
240 return -1;
242 name[baselen++] = c;
243 if (baselen > MAXNAME / 2)
244 return -1;
247 /* Final ']' */
248 if (get_next_char() != ']')
249 return -1;
250 return baselen;
253 static int get_base_var(char *name)
255 int baselen = 0;
257 for (;;) {
258 int c = get_next_char();
259 if (config_file_eof)
260 return -1;
261 if (c == ']')
262 return baselen;
263 if (isspace(c))
264 return get_extended_base_var(name, baselen, c);
265 if (!iskeychar(c) && c != '.')
266 return -1;
267 if (baselen > MAXNAME / 2)
268 return -1;
269 name[baselen++] = tolower(c);
273 static int git_parse_file(config_fn_t fn, void *data)
275 int comment = 0;
276 int baselen = 0;
277 static char var[MAXNAME];
279 /* U+FEFF Byte Order Mark in UTF8 */
280 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
281 const unsigned char *bomptr = utf8_bom;
283 for (;;) {
284 int c = get_next_char();
285 if (bomptr && *bomptr) {
286 /* We are at the file beginning; skip UTF8-encoded BOM
287 * if present. Sane editors won't put this in on their
288 * own, but e.g. Windows Notepad will do it happily. */
289 if ((unsigned char) c == *bomptr) {
290 bomptr++;
291 continue;
292 } else {
293 /* Do not tolerate partial BOM. */
294 if (bomptr != utf8_bom)
295 break;
296 /* No BOM at file beginning. Cool. */
297 bomptr = NULL;
300 if (c == '\n') {
301 if (config_file_eof)
302 return 0;
303 comment = 0;
304 continue;
306 if (comment || isspace(c))
307 continue;
308 if (c == '#' || c == ';') {
309 comment = 1;
310 continue;
312 if (c == '[') {
313 baselen = get_base_var(var);
314 if (baselen <= 0)
315 break;
316 var[baselen++] = '.';
317 var[baselen] = 0;
318 continue;
320 if (!isalpha(c))
321 break;
322 var[baselen] = tolower(c);
323 if (get_value(fn, data, var, baselen+1) < 0)
324 break;
326 die("bad config file line %d in %s", config_linenr, config_file_name);
329 static int parse_unit_factor(const char *end, unsigned long *val)
331 if (!*end)
332 return 1;
333 else if (!strcasecmp(end, "k")) {
334 *val *= 1024;
335 return 1;
337 else if (!strcasecmp(end, "m")) {
338 *val *= 1024 * 1024;
339 return 1;
341 else if (!strcasecmp(end, "g")) {
342 *val *= 1024 * 1024 * 1024;
343 return 1;
345 return 0;
348 static int git_parse_long(const char *value, long *ret)
350 if (value && *value) {
351 char *end;
352 long val = strtol(value, &end, 0);
353 unsigned long factor = 1;
354 if (!parse_unit_factor(end, &factor))
355 return 0;
356 *ret = val * factor;
357 return 1;
359 return 0;
362 int git_parse_ulong(const char *value, unsigned long *ret)
364 if (value && *value) {
365 char *end;
366 unsigned long val = strtoul(value, &end, 0);
367 if (!parse_unit_factor(end, &val))
368 return 0;
369 *ret = val;
370 return 1;
372 return 0;
375 static void die_bad_config(const char *name)
377 if (config_file_name)
378 die("bad config value for '%s' in %s", name, config_file_name);
379 die("bad config value for '%s'", name);
382 int git_config_int(const char *name, const char *value)
384 long ret = 0;
385 if (!git_parse_long(value, &ret))
386 die_bad_config(name);
387 return ret;
390 unsigned long git_config_ulong(const char *name, const char *value)
392 unsigned long ret;
393 if (!git_parse_ulong(value, &ret))
394 die_bad_config(name);
395 return ret;
398 static int git_config_maybe_bool_text(const char *name, const char *value)
400 if (!value)
401 return 1;
402 if (!*value)
403 return 0;
404 if (!strcasecmp(value, "true")
405 || !strcasecmp(value, "yes")
406 || !strcasecmp(value, "on"))
407 return 1;
408 if (!strcasecmp(value, "false")
409 || !strcasecmp(value, "no")
410 || !strcasecmp(value, "off"))
411 return 0;
412 return -1;
415 int git_config_maybe_bool(const char *name, const char *value)
417 long v = git_config_maybe_bool_text(name, value);
418 if (0 <= v)
419 return v;
420 if (git_parse_long(value, &v))
421 return !!v;
422 return -1;
425 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
427 int v = git_config_maybe_bool_text(name, value);
428 if (0 <= v) {
429 *is_bool = 1;
430 return v;
432 *is_bool = 0;
433 return git_config_int(name, value);
436 int git_config_bool(const char *name, const char *value)
438 int discard;
439 return !!git_config_bool_or_int(name, value, &discard);
442 int git_config_string(const char **dest, const char *var, const char *value)
444 if (!value)
445 return config_error_nonbool(var);
446 *dest = xstrdup(value);
447 return 0;
450 int git_config_pathname(const char **dest, const char *var, const char *value)
452 if (!value)
453 return config_error_nonbool(var);
454 *dest = expand_user_path(value);
455 if (!*dest)
456 die("Failed to expand user dir in: '%s'", value);
457 return 0;
460 static int git_default_core_config(const char *var, const char *value)
462 /* This needs a better name */
463 if (!strcmp(var, "core.filemode")) {
464 trust_executable_bit = git_config_bool(var, value);
465 return 0;
467 if (!strcmp(var, "core.trustctime")) {
468 trust_ctime = git_config_bool(var, value);
469 return 0;
472 if (!strcmp(var, "core.quotepath")) {
473 quote_path_fully = git_config_bool(var, value);
474 return 0;
477 if (!strcmp(var, "core.symlinks")) {
478 has_symlinks = git_config_bool(var, value);
479 return 0;
482 if (!strcmp(var, "core.ignorecase")) {
483 ignore_case = git_config_bool(var, value);
484 return 0;
487 if (!strcmp(var, "core.bare")) {
488 is_bare_repository_cfg = git_config_bool(var, value);
489 return 0;
492 if (!strcmp(var, "core.ignorestat")) {
493 assume_unchanged = git_config_bool(var, value);
494 return 0;
497 if (!strcmp(var, "core.prefersymlinkrefs")) {
498 prefer_symlink_refs = git_config_bool(var, value);
499 return 0;
502 if (!strcmp(var, "core.logallrefupdates")) {
503 log_all_ref_updates = git_config_bool(var, value);
504 return 0;
507 if (!strcmp(var, "core.warnambiguousrefs")) {
508 warn_ambiguous_refs = git_config_bool(var, value);
509 return 0;
512 if (!strcmp(var, "core.abbrev")) {
513 int abbrev = git_config_int(var, value);
514 if (abbrev < minimum_abbrev || abbrev > 40)
515 return -1;
516 default_abbrev = abbrev;
517 return 0;
520 if (!strcmp(var, "core.loosecompression")) {
521 int level = git_config_int(var, value);
522 if (level == -1)
523 level = Z_DEFAULT_COMPRESSION;
524 else if (level < 0 || level > Z_BEST_COMPRESSION)
525 die("bad zlib compression level %d", level);
526 zlib_compression_level = level;
527 zlib_compression_seen = 1;
528 return 0;
531 if (!strcmp(var, "core.compression")) {
532 int level = git_config_int(var, value);
533 if (level == -1)
534 level = Z_DEFAULT_COMPRESSION;
535 else if (level < 0 || level > Z_BEST_COMPRESSION)
536 die("bad zlib compression level %d", level);
537 core_compression_level = level;
538 core_compression_seen = 1;
539 if (!zlib_compression_seen)
540 zlib_compression_level = level;
541 return 0;
544 if (!strcmp(var, "core.packedgitwindowsize")) {
545 int pgsz_x2 = getpagesize() * 2;
546 packed_git_window_size = git_config_int(var, value);
548 /* This value must be multiple of (pagesize * 2) */
549 packed_git_window_size /= pgsz_x2;
550 if (packed_git_window_size < 1)
551 packed_git_window_size = 1;
552 packed_git_window_size *= pgsz_x2;
553 return 0;
556 if (!strcmp(var, "core.bigfilethreshold")) {
557 long n = git_config_int(var, value);
558 big_file_threshold = 0 < n ? n : 0;
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 (core_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 core_eol = EOL_LF;
595 else if (value && !strcasecmp(value, "crlf"))
596 core_eol = EOL_CRLF;
597 else if (value && !strcasecmp(value, "native"))
598 core_eol = EOL_NATIVE;
599 else
600 core_eol = EOL_UNSET;
601 if (core_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, "upstream"))
733 push_default = PUSH_DEFAULT_UPSTREAM;
734 else if (!strcmp(value, "tracking")) /* deprecated */
735 push_default = PUSH_DEFAULT_UPSTREAM;
736 else if (!strcmp(value, "current"))
737 push_default = PUSH_DEFAULT_CURRENT;
738 else {
739 error("Malformed value for %s: %s", var, value);
740 return error("Must be one of nothing, matching, "
741 "tracking or current.");
743 return 0;
746 /* Add other config variables here and to Documentation/config.txt. */
747 return 0;
750 static int git_default_mailmap_config(const char *var, const char *value)
752 if (!strcmp(var, "mailmap.file"))
753 return git_config_string(&git_mailmap_file, var, value);
755 /* Add other config variables here and to Documentation/config.txt. */
756 return 0;
759 int git_default_config(const char *var, const char *value, void *dummy)
761 if (!prefixcmp(var, "core."))
762 return git_default_core_config(var, value);
764 if (!prefixcmp(var, "user."))
765 return git_default_user_config(var, value);
767 if (!prefixcmp(var, "i18n."))
768 return git_default_i18n_config(var, value);
770 if (!prefixcmp(var, "branch."))
771 return git_default_branch_config(var, value);
773 if (!prefixcmp(var, "push."))
774 return git_default_push_config(var, value);
776 if (!prefixcmp(var, "mailmap."))
777 return git_default_mailmap_config(var, value);
779 if (!prefixcmp(var, "advice."))
780 return git_default_advice_config(var, value);
782 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
783 pager_use_color = git_config_bool(var,value);
784 return 0;
787 /* Add other config variables here and to Documentation/config.txt. */
788 return 0;
791 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
793 int ret;
794 FILE *f = fopen(filename, "r");
796 ret = -1;
797 if (f) {
798 config_file = f;
799 config_file_name = filename;
800 config_linenr = 1;
801 config_file_eof = 0;
802 ret = git_parse_file(fn, data);
803 fclose(f);
804 config_file_name = NULL;
806 return ret;
809 const char *git_etc_gitconfig(void)
811 static const char *system_wide;
812 if (!system_wide)
813 system_wide = system_path(ETC_GITCONFIG);
814 return system_wide;
817 int git_env_bool(const char *k, int def)
819 const char *v = getenv(k);
820 return v ? git_config_bool(k, v) : def;
823 int git_config_system(void)
825 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
828 int git_config_global(void)
830 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
833 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
835 int ret = 0, found = 0;
836 const char *home = NULL;
838 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
839 if (config_exclusive_filename)
840 return git_config_from_file(fn, config_exclusive_filename, data);
841 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
842 ret += git_config_from_file(fn, git_etc_gitconfig(),
843 data);
844 found += 1;
847 home = getenv("HOME");
848 if (home) {
849 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
850 if (!access(user_config, R_OK)) {
851 ret += git_config_from_file(fn, user_config, data);
852 found += 1;
854 free(user_config);
857 if (repo_config && !access(repo_config, R_OK)) {
858 ret += git_config_from_file(fn, repo_config, data);
859 found += 1;
862 switch (git_config_from_parameters(fn, data)) {
863 case -1: /* error */
864 ret--;
865 break;
866 case 0: /* found nothing */
867 break;
868 default: /* found at least one item */
869 found++;
870 break;
873 return ret == 0 ? found : ret;
876 int git_config(config_fn_t fn, void *data)
878 char *repo_config = NULL;
879 int ret;
881 repo_config = git_pathdup("config");
882 ret = git_config_early(fn, data, repo_config);
883 if (repo_config)
884 free(repo_config);
885 return ret;
889 * Find all the stuff for git_config_set() below.
892 #define MAX_MATCHES 512
894 static struct {
895 int baselen;
896 char *key;
897 int do_not_match;
898 regex_t *value_regex;
899 int multi_replace;
900 size_t offset[MAX_MATCHES];
901 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
902 int seen;
903 } store;
905 static int matches(const char *key, const char *value)
907 return !strcmp(key, store.key) &&
908 (store.value_regex == NULL ||
909 (store.do_not_match ^
910 !regexec(store.value_regex, value, 0, NULL, 0)));
913 static int store_aux(const char *key, const char *value, void *cb)
915 const char *ep;
916 size_t section_len;
918 switch (store.state) {
919 case KEY_SEEN:
920 if (matches(key, value)) {
921 if (store.seen == 1 && store.multi_replace == 0) {
922 warning("%s has multiple values", key);
923 } else if (store.seen >= MAX_MATCHES) {
924 error("too many matches for %s", key);
925 return 1;
928 store.offset[store.seen] = ftell(config_file);
929 store.seen++;
931 break;
932 case SECTION_SEEN:
934 * What we are looking for is in store.key (both
935 * section and var), and its section part is baselen
936 * long. We found key (again, both section and var).
937 * We would want to know if this key is in the same
938 * section as what we are looking for. We already
939 * know we are in the same section as what should
940 * hold store.key.
942 ep = strrchr(key, '.');
943 section_len = ep - key;
945 if ((section_len != store.baselen) ||
946 memcmp(key, store.key, section_len+1)) {
947 store.state = SECTION_END_SEEN;
948 break;
952 * Do not increment matches: this is no match, but we
953 * just made sure we are in the desired section.
955 store.offset[store.seen] = ftell(config_file);
956 /* fallthru */
957 case SECTION_END_SEEN:
958 case START:
959 if (matches(key, value)) {
960 store.offset[store.seen] = ftell(config_file);
961 store.state = KEY_SEEN;
962 store.seen++;
963 } else {
964 if (strrchr(key, '.') - key == store.baselen &&
965 !strncmp(key, store.key, store.baselen)) {
966 store.state = SECTION_SEEN;
967 store.offset[store.seen] = ftell(config_file);
971 return 0;
974 static int write_error(const char *filename)
976 error("failed to write new configuration file %s", filename);
978 /* Same error code as "failed to rename". */
979 return 4;
982 static int store_write_section(int fd, const char *key)
984 const char *dot;
985 int i, success;
986 struct strbuf sb = STRBUF_INIT;
988 dot = memchr(key, '.', store.baselen);
989 if (dot) {
990 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
991 for (i = dot - key + 1; i < store.baselen; i++) {
992 if (key[i] == '"' || key[i] == '\\')
993 strbuf_addch(&sb, '\\');
994 strbuf_addch(&sb, key[i]);
996 strbuf_addstr(&sb, "\"]\n");
997 } else {
998 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1001 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1002 strbuf_release(&sb);
1004 return success;
1007 static int store_write_pair(int fd, const char *key, const char *value)
1009 int i, success;
1010 int length = strlen(key + store.baselen + 1);
1011 const char *quote = "";
1012 struct strbuf sb = STRBUF_INIT;
1015 * Check to see if the value needs to be surrounded with a dq pair.
1016 * Note that problematic characters are always backslash-quoted; this
1017 * check is about not losing leading or trailing SP and strings that
1018 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1019 * configuration parser.
1021 if (value[0] == ' ')
1022 quote = "\"";
1023 for (i = 0; value[i]; i++)
1024 if (value[i] == ';' || value[i] == '#')
1025 quote = "\"";
1026 if (i && value[i - 1] == ' ')
1027 quote = "\"";
1029 strbuf_addf(&sb, "\t%.*s = %s",
1030 length, key + store.baselen + 1, quote);
1032 for (i = 0; value[i]; i++)
1033 switch (value[i]) {
1034 case '\n':
1035 strbuf_addstr(&sb, "\\n");
1036 break;
1037 case '\t':
1038 strbuf_addstr(&sb, "\\t");
1039 break;
1040 case '"':
1041 case '\\':
1042 strbuf_addch(&sb, '\\');
1043 default:
1044 strbuf_addch(&sb, value[i]);
1045 break;
1047 strbuf_addf(&sb, "%s\n", quote);
1049 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1050 strbuf_release(&sb);
1052 return success;
1055 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1056 size_t offset_, int *found_bracket)
1058 size_t equal_offset = size, bracket_offset = size;
1059 ssize_t offset;
1061 contline:
1062 for (offset = offset_-2; offset > 0
1063 && contents[offset] != '\n'; offset--)
1064 switch (contents[offset]) {
1065 case '=': equal_offset = offset; break;
1066 case ']': bracket_offset = offset; break;
1068 if (offset > 0 && contents[offset-1] == '\\') {
1069 offset_ = offset;
1070 goto contline;
1072 if (bracket_offset < equal_offset) {
1073 *found_bracket = 1;
1074 offset = bracket_offset+1;
1075 } else
1076 offset++;
1078 return offset;
1081 int git_config_set(const char *key, const char *value)
1083 return git_config_set_multivar(key, value, NULL, 0);
1087 * Auxiliary function to sanity-check and split the key into the section
1088 * identifier and variable name.
1090 * Returns 0 on success, -1 when there is an invalid character in the key and
1091 * -2 if there is no section name in the key.
1093 * store_key - pointer to char* which will hold a copy of the key with
1094 * lowercase section and variable name
1095 * baselen - pointer to int which will hold the length of the
1096 * section + subsection part, can be NULL
1098 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1100 int i, dot, baselen;
1101 const char *last_dot = strrchr(key, '.');
1104 * Since "key" actually contains the section name and the real
1105 * key name separated by a dot, we have to know where the dot is.
1108 if (last_dot == NULL || last_dot == key) {
1109 error("key does not contain a section: %s", key);
1110 return -CONFIG_NO_SECTION_OR_NAME;
1113 if (!last_dot[1]) {
1114 error("key does not contain variable name: %s", key);
1115 return -CONFIG_NO_SECTION_OR_NAME;
1118 baselen = last_dot - key;
1119 if (baselen_)
1120 *baselen_ = baselen;
1123 * Validate the key and while at it, lower case it for matching.
1125 *store_key = xmalloc(strlen(key) + 1);
1127 dot = 0;
1128 for (i = 0; key[i]; i++) {
1129 unsigned char c = key[i];
1130 if (c == '.')
1131 dot = 1;
1132 /* Leave the extended basename untouched.. */
1133 if (!dot || i > baselen) {
1134 if (!iskeychar(c) ||
1135 (i == baselen + 1 && !isalpha(c))) {
1136 error("invalid key: %s", key);
1137 goto out_free_ret_1;
1139 c = tolower(c);
1140 } else if (c == '\n') {
1141 error("invalid key (newline): %s", key);
1142 goto out_free_ret_1;
1144 (*store_key)[i] = c;
1146 (*store_key)[i] = 0;
1148 return 0;
1150 out_free_ret_1:
1151 free(*store_key);
1152 return -CONFIG_INVALID_KEY;
1156 * If value==NULL, unset in (remove from) config,
1157 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1158 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1159 * else all matching key/values (regardless how many) are removed,
1160 * before the new pair is written.
1162 * Returns 0 on success.
1164 * This function does this:
1166 * - it locks the config file by creating ".git/config.lock"
1168 * - it then parses the config using store_aux() as validator to find
1169 * the position on the key/value pair to replace. If it is to be unset,
1170 * it must be found exactly once.
1172 * - the config file is mmap()ed and the part before the match (if any) is
1173 * written to the lock file, then the changed part and the rest.
1175 * - the config file is removed and the lock file rename()d to it.
1178 int git_config_set_multivar(const char *key, const char *value,
1179 const char *value_regex, int multi_replace)
1181 int fd = -1, in_fd;
1182 int ret;
1183 char *config_filename;
1184 struct lock_file *lock = NULL;
1186 if (config_exclusive_filename)
1187 config_filename = xstrdup(config_exclusive_filename);
1188 else
1189 config_filename = git_pathdup("config");
1191 /* parse-key returns negative; flip the sign to feed exit(3) */
1192 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1193 if (ret)
1194 goto out_free;
1196 store.multi_replace = multi_replace;
1200 * The lock serves a purpose in addition to locking: the new
1201 * contents of .git/config will be written into it.
1203 lock = xcalloc(sizeof(struct lock_file), 1);
1204 fd = hold_lock_file_for_update(lock, config_filename, 0);
1205 if (fd < 0) {
1206 error("could not lock config file %s: %s", config_filename, strerror(errno));
1207 free(store.key);
1208 ret = CONFIG_NO_LOCK;
1209 goto out_free;
1213 * If .git/config does not exist yet, write a minimal version.
1215 in_fd = open(config_filename, O_RDONLY);
1216 if ( in_fd < 0 ) {
1217 free(store.key);
1219 if ( ENOENT != errno ) {
1220 error("opening %s: %s", config_filename,
1221 strerror(errno));
1222 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1223 goto out_free;
1225 /* if nothing to unset, error out */
1226 if (value == NULL) {
1227 ret = CONFIG_NOTHING_SET;
1228 goto out_free;
1231 store.key = (char *)key;
1232 if (!store_write_section(fd, key) ||
1233 !store_write_pair(fd, key, value))
1234 goto write_err_out;
1235 } else {
1236 struct stat st;
1237 char *contents;
1238 size_t contents_sz, copy_begin, copy_end;
1239 int i, new_line = 0;
1241 if (value_regex == NULL)
1242 store.value_regex = NULL;
1243 else {
1244 if (value_regex[0] == '!') {
1245 store.do_not_match = 1;
1246 value_regex++;
1247 } else
1248 store.do_not_match = 0;
1250 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1251 if (regcomp(store.value_regex, value_regex,
1252 REG_EXTENDED)) {
1253 error("invalid pattern: %s", value_regex);
1254 free(store.value_regex);
1255 ret = CONFIG_INVALID_PATTERN;
1256 goto out_free;
1260 store.offset[0] = 0;
1261 store.state = START;
1262 store.seen = 0;
1265 * After this, store.offset will contain the *end* offset
1266 * of the last match, or remain at 0 if no match was found.
1267 * As a side effect, we make sure to transform only a valid
1268 * existing config file.
1270 if (git_config_from_file(store_aux, config_filename, NULL)) {
1271 error("invalid config file %s", config_filename);
1272 free(store.key);
1273 if (store.value_regex != NULL) {
1274 regfree(store.value_regex);
1275 free(store.value_regex);
1277 ret = CONFIG_INVALID_FILE;
1278 goto out_free;
1281 free(store.key);
1282 if (store.value_regex != NULL) {
1283 regfree(store.value_regex);
1284 free(store.value_regex);
1287 /* if nothing to unset, or too many matches, error out */
1288 if ((store.seen == 0 && value == NULL) ||
1289 (store.seen > 1 && multi_replace == 0)) {
1290 ret = CONFIG_NOTHING_SET;
1291 goto out_free;
1294 fstat(in_fd, &st);
1295 contents_sz = xsize_t(st.st_size);
1296 contents = xmmap(NULL, contents_sz, PROT_READ,
1297 MAP_PRIVATE, in_fd, 0);
1298 close(in_fd);
1300 if (store.seen == 0)
1301 store.seen = 1;
1303 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1304 if (store.offset[i] == 0) {
1305 store.offset[i] = copy_end = contents_sz;
1306 } else if (store.state != KEY_SEEN) {
1307 copy_end = store.offset[i];
1308 } else
1309 copy_end = find_beginning_of_line(
1310 contents, contents_sz,
1311 store.offset[i]-2, &new_line);
1313 if (copy_end > 0 && contents[copy_end-1] != '\n')
1314 new_line = 1;
1316 /* write the first part of the config */
1317 if (copy_end > copy_begin) {
1318 if (write_in_full(fd, contents + copy_begin,
1319 copy_end - copy_begin) <
1320 copy_end - copy_begin)
1321 goto write_err_out;
1322 if (new_line &&
1323 write_str_in_full(fd, "\n") != 1)
1324 goto write_err_out;
1326 copy_begin = store.offset[i];
1329 /* write the pair (value == NULL means unset) */
1330 if (value != NULL) {
1331 if (store.state == START) {
1332 if (!store_write_section(fd, key))
1333 goto write_err_out;
1335 if (!store_write_pair(fd, key, value))
1336 goto write_err_out;
1339 /* write the rest of the config */
1340 if (copy_begin < contents_sz)
1341 if (write_in_full(fd, contents + copy_begin,
1342 contents_sz - copy_begin) <
1343 contents_sz - copy_begin)
1344 goto write_err_out;
1346 munmap(contents, contents_sz);
1349 if (commit_lock_file(lock) < 0) {
1350 error("could not commit config file %s", config_filename);
1351 ret = CONFIG_NO_WRITE;
1352 goto out_free;
1356 * lock is committed, so don't try to roll it back below.
1357 * NOTE: Since lockfile.c keeps a linked list of all created
1358 * lock_file structures, it isn't safe to free(lock). It's
1359 * better to just leave it hanging around.
1361 lock = NULL;
1362 ret = 0;
1364 out_free:
1365 if (lock)
1366 rollback_lock_file(lock);
1367 free(config_filename);
1368 return ret;
1370 write_err_out:
1371 ret = write_error(lock->filename);
1372 goto out_free;
1376 static int section_name_match (const char *buf, const char *name)
1378 int i = 0, j = 0, dot = 0;
1379 if (buf[i] != '[')
1380 return 0;
1381 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1382 if (!dot && isspace(buf[i])) {
1383 dot = 1;
1384 if (name[j++] != '.')
1385 break;
1386 for (i++; isspace(buf[i]); i++)
1387 ; /* do nothing */
1388 if (buf[i] != '"')
1389 break;
1390 continue;
1392 if (buf[i] == '\\' && dot)
1393 i++;
1394 else if (buf[i] == '"' && dot) {
1395 for (i++; isspace(buf[i]); i++)
1396 ; /* do_nothing */
1397 break;
1399 if (buf[i] != name[j++])
1400 break;
1402 if (buf[i] == ']' && name[j] == 0) {
1404 * We match, now just find the right length offset by
1405 * gobbling up any whitespace after it, as well
1407 i++;
1408 for (; buf[i] && isspace(buf[i]); i++)
1409 ; /* do nothing */
1410 return i;
1412 return 0;
1415 /* if new_name == NULL, the section is removed instead */
1416 int git_config_rename_section(const char *old_name, const char *new_name)
1418 int ret = 0, remove = 0;
1419 char *config_filename;
1420 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1421 int out_fd;
1422 char buf[1024];
1424 if (config_exclusive_filename)
1425 config_filename = xstrdup(config_exclusive_filename);
1426 else
1427 config_filename = git_pathdup("config");
1428 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1429 if (out_fd < 0) {
1430 ret = error("could not lock config file %s", config_filename);
1431 goto out;
1434 if (!(config_file = fopen(config_filename, "rb"))) {
1435 /* no config file means nothing to rename, no error */
1436 goto unlock_and_out;
1439 while (fgets(buf, sizeof(buf), config_file)) {
1440 int i;
1441 int length;
1442 char *output = buf;
1443 for (i = 0; buf[i] && isspace(buf[i]); i++)
1444 ; /* do nothing */
1445 if (buf[i] == '[') {
1446 /* it's a section */
1447 int offset = section_name_match(&buf[i], old_name);
1448 if (offset > 0) {
1449 ret++;
1450 if (new_name == NULL) {
1451 remove = 1;
1452 continue;
1454 store.baselen = strlen(new_name);
1455 if (!store_write_section(out_fd, new_name)) {
1456 ret = write_error(lock->filename);
1457 goto out;
1460 * We wrote out the new section, with
1461 * a newline, now skip the old
1462 * section's length
1464 output += offset + i;
1465 if (strlen(output) > 0) {
1467 * More content means there's
1468 * a declaration to put on the
1469 * next line; indent with a
1470 * tab
1472 output -= 1;
1473 output[0] = '\t';
1476 remove = 0;
1478 if (remove)
1479 continue;
1480 length = strlen(output);
1481 if (write_in_full(out_fd, output, length) != length) {
1482 ret = write_error(lock->filename);
1483 goto out;
1486 fclose(config_file);
1487 unlock_and_out:
1488 if (commit_lock_file(lock) < 0)
1489 ret = error("could not commit config file %s", config_filename);
1490 out:
1491 free(config_filename);
1492 return ret;
1496 * Call this to report error for your variable that should not
1497 * get a boolean value (i.e. "[my] var" means "true").
1499 int config_error_nonbool(const char *var)
1501 return error("Missing value for '%s'", var);