Merge branch 'mg/rev-list-n-reverse-doc'
[git.git] / config.c
blobfa740a6a60a49512b613f70add97d445f622afd2
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, "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_from_parameters(config_fn_t fn, void *data)
835 static int loaded_environment;
836 const struct config_item *ct;
838 if (!loaded_environment) {
839 if (git_config_parse_environment() < 0)
840 return -1;
841 loaded_environment = 1;
843 for (ct = config_parameters; ct; ct = ct->next)
844 if (fn(ct->name, ct->value, data) < 0)
845 return -1;
846 return 0;
849 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
851 int ret = 0, found = 0;
852 const char *home = NULL;
854 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
855 if (config_exclusive_filename)
856 return git_config_from_file(fn, config_exclusive_filename, data);
857 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
858 ret += git_config_from_file(fn, git_etc_gitconfig(),
859 data);
860 found += 1;
863 home = getenv("HOME");
864 if (git_config_global() && home) {
865 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
866 if (!access(user_config, R_OK)) {
867 ret += git_config_from_file(fn, user_config, data);
868 found += 1;
870 free(user_config);
873 if (repo_config && !access(repo_config, R_OK)) {
874 ret += git_config_from_file(fn, repo_config, data);
875 found += 1;
878 ret += git_config_from_parameters(fn, data);
879 if (config_parameters)
880 found += 1;
882 return ret == 0 ? found : ret;
885 int git_config(config_fn_t fn, void *data)
887 char *repo_config = NULL;
888 int ret;
890 repo_config = git_pathdup("config");
891 ret = git_config_early(fn, data, repo_config);
892 if (repo_config)
893 free(repo_config);
894 return ret;
898 * Find all the stuff for git_config_set() below.
901 #define MAX_MATCHES 512
903 static struct {
904 int baselen;
905 char *key;
906 int do_not_match;
907 regex_t *value_regex;
908 int multi_replace;
909 size_t offset[MAX_MATCHES];
910 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
911 int seen;
912 } store;
914 static int matches(const char *key, const char *value)
916 return !strcmp(key, store.key) &&
917 (store.value_regex == NULL ||
918 (store.do_not_match ^
919 !regexec(store.value_regex, value, 0, NULL, 0)));
922 static int store_aux(const char *key, const char *value, void *cb)
924 const char *ep;
925 size_t section_len;
927 switch (store.state) {
928 case KEY_SEEN:
929 if (matches(key, value)) {
930 if (store.seen == 1 && store.multi_replace == 0) {
931 warning("%s has multiple values", key);
932 } else if (store.seen >= MAX_MATCHES) {
933 error("too many matches for %s", key);
934 return 1;
937 store.offset[store.seen] = ftell(config_file);
938 store.seen++;
940 break;
941 case SECTION_SEEN:
943 * What we are looking for is in store.key (both
944 * section and var), and its section part is baselen
945 * long. We found key (again, both section and var).
946 * We would want to know if this key is in the same
947 * section as what we are looking for. We already
948 * know we are in the same section as what should
949 * hold store.key.
951 ep = strrchr(key, '.');
952 section_len = ep - key;
954 if ((section_len != store.baselen) ||
955 memcmp(key, store.key, section_len+1)) {
956 store.state = SECTION_END_SEEN;
957 break;
961 * Do not increment matches: this is no match, but we
962 * just made sure we are in the desired section.
964 store.offset[store.seen] = ftell(config_file);
965 /* fallthru */
966 case SECTION_END_SEEN:
967 case START:
968 if (matches(key, value)) {
969 store.offset[store.seen] = ftell(config_file);
970 store.state = KEY_SEEN;
971 store.seen++;
972 } else {
973 if (strrchr(key, '.') - key == store.baselen &&
974 !strncmp(key, store.key, store.baselen)) {
975 store.state = SECTION_SEEN;
976 store.offset[store.seen] = ftell(config_file);
980 return 0;
983 static int write_error(const char *filename)
985 error("failed to write new configuration file %s", filename);
987 /* Same error code as "failed to rename". */
988 return 4;
991 static int store_write_section(int fd, const char *key)
993 const char *dot;
994 int i, success;
995 struct strbuf sb = STRBUF_INIT;
997 dot = memchr(key, '.', store.baselen);
998 if (dot) {
999 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1000 for (i = dot - key + 1; i < store.baselen; i++) {
1001 if (key[i] == '"' || key[i] == '\\')
1002 strbuf_addch(&sb, '\\');
1003 strbuf_addch(&sb, key[i]);
1005 strbuf_addstr(&sb, "\"]\n");
1006 } else {
1007 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1010 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1011 strbuf_release(&sb);
1013 return success;
1016 static int store_write_pair(int fd, const char *key, const char *value)
1018 int i, success;
1019 int length = strlen(key + store.baselen + 1);
1020 const char *quote = "";
1021 struct strbuf sb = STRBUF_INIT;
1024 * Check to see if the value needs to be surrounded with a dq pair.
1025 * Note that problematic characters are always backslash-quoted; this
1026 * check is about not losing leading or trailing SP and strings that
1027 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1028 * configuration parser.
1030 if (value[0] == ' ')
1031 quote = "\"";
1032 for (i = 0; value[i]; i++)
1033 if (value[i] == ';' || value[i] == '#')
1034 quote = "\"";
1035 if (i && value[i - 1] == ' ')
1036 quote = "\"";
1038 strbuf_addf(&sb, "\t%.*s = %s",
1039 length, key + store.baselen + 1, quote);
1041 for (i = 0; value[i]; i++)
1042 switch (value[i]) {
1043 case '\n':
1044 strbuf_addstr(&sb, "\\n");
1045 break;
1046 case '\t':
1047 strbuf_addstr(&sb, "\\t");
1048 break;
1049 case '"':
1050 case '\\':
1051 strbuf_addch(&sb, '\\');
1052 default:
1053 strbuf_addch(&sb, value[i]);
1054 break;
1056 strbuf_addf(&sb, "%s\n", quote);
1058 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1059 strbuf_release(&sb);
1061 return success;
1064 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1065 size_t offset_, int *found_bracket)
1067 size_t equal_offset = size, bracket_offset = size;
1068 ssize_t offset;
1070 contline:
1071 for (offset = offset_-2; offset > 0
1072 && contents[offset] != '\n'; offset--)
1073 switch (contents[offset]) {
1074 case '=': equal_offset = offset; break;
1075 case ']': bracket_offset = offset; break;
1077 if (offset > 0 && contents[offset-1] == '\\') {
1078 offset_ = offset;
1079 goto contline;
1081 if (bracket_offset < equal_offset) {
1082 *found_bracket = 1;
1083 offset = bracket_offset+1;
1084 } else
1085 offset++;
1087 return offset;
1090 int git_config_set(const char *key, const char *value)
1092 return git_config_set_multivar(key, value, NULL, 0);
1096 * Auxiliary function to sanity-check and split the key into the section
1097 * identifier and variable name.
1099 * Returns 0 on success, -1 when there is an invalid character in the key and
1100 * -2 if there is no section name in the key.
1102 * store_key - pointer to char* which will hold a copy of the key with
1103 * lowercase section and variable name
1104 * baselen - pointer to int which will hold the length of the
1105 * section + subsection part, can be NULL
1107 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1109 int i, dot, baselen;
1110 const char *last_dot = strrchr(key, '.');
1113 * Since "key" actually contains the section name and the real
1114 * key name separated by a dot, we have to know where the dot is.
1117 if (last_dot == NULL || last_dot == key) {
1118 error("key does not contain a section: %s", key);
1119 return -2;
1122 if (!last_dot[1]) {
1123 error("key does not contain variable name: %s", key);
1124 return -2;
1127 baselen = last_dot - key;
1128 if (baselen_)
1129 *baselen_ = baselen;
1132 * Validate the key and while at it, lower case it for matching.
1134 *store_key = xmalloc(strlen(key) + 1);
1136 dot = 0;
1137 for (i = 0; key[i]; i++) {
1138 unsigned char c = key[i];
1139 if (c == '.')
1140 dot = 1;
1141 /* Leave the extended basename untouched.. */
1142 if (!dot || i > baselen) {
1143 if (!iskeychar(c) ||
1144 (i == baselen + 1 && !isalpha(c))) {
1145 error("invalid key: %s", key);
1146 goto out_free_ret_1;
1148 c = tolower(c);
1149 } else if (c == '\n') {
1150 error("invalid key (newline): %s", key);
1151 goto out_free_ret_1;
1153 (*store_key)[i] = c;
1155 (*store_key)[i] = 0;
1157 return 0;
1159 out_free_ret_1:
1160 free(*store_key);
1161 return -1;
1165 * If value==NULL, unset in (remove from) config,
1166 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1167 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1168 * else all matching key/values (regardless how many) are removed,
1169 * before the new pair is written.
1171 * Returns 0 on success.
1173 * This function does this:
1175 * - it locks the config file by creating ".git/config.lock"
1177 * - it then parses the config using store_aux() as validator to find
1178 * the position on the key/value pair to replace. If it is to be unset,
1179 * it must be found exactly once.
1181 * - the config file is mmap()ed and the part before the match (if any) is
1182 * written to the lock file, then the changed part and the rest.
1184 * - the config file is removed and the lock file rename()d to it.
1187 int git_config_set_multivar(const char *key, const char *value,
1188 const char *value_regex, int multi_replace)
1190 int fd = -1, in_fd;
1191 int ret;
1192 char *config_filename;
1193 struct lock_file *lock = NULL;
1195 if (config_exclusive_filename)
1196 config_filename = xstrdup(config_exclusive_filename);
1197 else
1198 config_filename = git_pathdup("config");
1200 /* parse-key returns negative; flip the sign to feed exit(3) */
1201 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1202 if (ret)
1203 goto out_free;
1205 store.multi_replace = multi_replace;
1209 * The lock serves a purpose in addition to locking: the new
1210 * contents of .git/config will be written into it.
1212 lock = xcalloc(sizeof(struct lock_file), 1);
1213 fd = hold_lock_file_for_update(lock, config_filename, 0);
1214 if (fd < 0) {
1215 error("could not lock config file %s: %s", config_filename, strerror(errno));
1216 free(store.key);
1217 ret = -1;
1218 goto out_free;
1222 * If .git/config does not exist yet, write a minimal version.
1224 in_fd = open(config_filename, O_RDONLY);
1225 if ( in_fd < 0 ) {
1226 free(store.key);
1228 if ( ENOENT != errno ) {
1229 error("opening %s: %s", config_filename,
1230 strerror(errno));
1231 ret = 3; /* same as "invalid config file" */
1232 goto out_free;
1234 /* if nothing to unset, error out */
1235 if (value == NULL) {
1236 ret = 5;
1237 goto out_free;
1240 store.key = (char *)key;
1241 if (!store_write_section(fd, key) ||
1242 !store_write_pair(fd, key, value))
1243 goto write_err_out;
1244 } else {
1245 struct stat st;
1246 char *contents;
1247 size_t contents_sz, copy_begin, copy_end;
1248 int i, new_line = 0;
1250 if (value_regex == NULL)
1251 store.value_regex = NULL;
1252 else {
1253 if (value_regex[0] == '!') {
1254 store.do_not_match = 1;
1255 value_regex++;
1256 } else
1257 store.do_not_match = 0;
1259 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1260 if (regcomp(store.value_regex, value_regex,
1261 REG_EXTENDED)) {
1262 error("invalid pattern: %s", value_regex);
1263 free(store.value_regex);
1264 ret = 6;
1265 goto out_free;
1269 store.offset[0] = 0;
1270 store.state = START;
1271 store.seen = 0;
1274 * After this, store.offset will contain the *end* offset
1275 * of the last match, or remain at 0 if no match was found.
1276 * As a side effect, we make sure to transform only a valid
1277 * existing config file.
1279 if (git_config_from_file(store_aux, config_filename, NULL)) {
1280 error("invalid config file %s", config_filename);
1281 free(store.key);
1282 if (store.value_regex != NULL) {
1283 regfree(store.value_regex);
1284 free(store.value_regex);
1286 ret = 3;
1287 goto out_free;
1290 free(store.key);
1291 if (store.value_regex != NULL) {
1292 regfree(store.value_regex);
1293 free(store.value_regex);
1296 /* if nothing to unset, or too many matches, error out */
1297 if ((store.seen == 0 && value == NULL) ||
1298 (store.seen > 1 && multi_replace == 0)) {
1299 ret = 5;
1300 goto out_free;
1303 fstat(in_fd, &st);
1304 contents_sz = xsize_t(st.st_size);
1305 contents = xmmap(NULL, contents_sz, PROT_READ,
1306 MAP_PRIVATE, in_fd, 0);
1307 close(in_fd);
1309 if (store.seen == 0)
1310 store.seen = 1;
1312 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1313 if (store.offset[i] == 0) {
1314 store.offset[i] = copy_end = contents_sz;
1315 } else if (store.state != KEY_SEEN) {
1316 copy_end = store.offset[i];
1317 } else
1318 copy_end = find_beginning_of_line(
1319 contents, contents_sz,
1320 store.offset[i]-2, &new_line);
1322 if (copy_end > 0 && contents[copy_end-1] != '\n')
1323 new_line = 1;
1325 /* write the first part of the config */
1326 if (copy_end > copy_begin) {
1327 if (write_in_full(fd, contents + copy_begin,
1328 copy_end - copy_begin) <
1329 copy_end - copy_begin)
1330 goto write_err_out;
1331 if (new_line &&
1332 write_str_in_full(fd, "\n") != 1)
1333 goto write_err_out;
1335 copy_begin = store.offset[i];
1338 /* write the pair (value == NULL means unset) */
1339 if (value != NULL) {
1340 if (store.state == START) {
1341 if (!store_write_section(fd, key))
1342 goto write_err_out;
1344 if (!store_write_pair(fd, key, value))
1345 goto write_err_out;
1348 /* write the rest of the config */
1349 if (copy_begin < contents_sz)
1350 if (write_in_full(fd, contents + copy_begin,
1351 contents_sz - copy_begin) <
1352 contents_sz - copy_begin)
1353 goto write_err_out;
1355 munmap(contents, contents_sz);
1358 if (commit_lock_file(lock) < 0) {
1359 error("could not commit config file %s", config_filename);
1360 ret = 4;
1361 goto out_free;
1365 * lock is committed, so don't try to roll it back below.
1366 * NOTE: Since lockfile.c keeps a linked list of all created
1367 * lock_file structures, it isn't safe to free(lock). It's
1368 * better to just leave it hanging around.
1370 lock = NULL;
1371 ret = 0;
1373 out_free:
1374 if (lock)
1375 rollback_lock_file(lock);
1376 free(config_filename);
1377 return ret;
1379 write_err_out:
1380 ret = write_error(lock->filename);
1381 goto out_free;
1385 static int section_name_match (const char *buf, const char *name)
1387 int i = 0, j = 0, dot = 0;
1388 if (buf[i] != '[')
1389 return 0;
1390 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1391 if (!dot && isspace(buf[i])) {
1392 dot = 1;
1393 if (name[j++] != '.')
1394 break;
1395 for (i++; isspace(buf[i]); i++)
1396 ; /* do nothing */
1397 if (buf[i] != '"')
1398 break;
1399 continue;
1401 if (buf[i] == '\\' && dot)
1402 i++;
1403 else if (buf[i] == '"' && dot) {
1404 for (i++; isspace(buf[i]); i++)
1405 ; /* do_nothing */
1406 break;
1408 if (buf[i] != name[j++])
1409 break;
1411 if (buf[i] == ']' && name[j] == 0) {
1413 * We match, now just find the right length offset by
1414 * gobbling up any whitespace after it, as well
1416 i++;
1417 for (; buf[i] && isspace(buf[i]); i++)
1418 ; /* do nothing */
1419 return i;
1421 return 0;
1424 /* if new_name == NULL, the section is removed instead */
1425 int git_config_rename_section(const char *old_name, const char *new_name)
1427 int ret = 0, remove = 0;
1428 char *config_filename;
1429 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1430 int out_fd;
1431 char buf[1024];
1433 if (config_exclusive_filename)
1434 config_filename = xstrdup(config_exclusive_filename);
1435 else
1436 config_filename = git_pathdup("config");
1437 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1438 if (out_fd < 0) {
1439 ret = error("could not lock config file %s", config_filename);
1440 goto out;
1443 if (!(config_file = fopen(config_filename, "rb"))) {
1444 /* no config file means nothing to rename, no error */
1445 goto unlock_and_out;
1448 while (fgets(buf, sizeof(buf), config_file)) {
1449 int i;
1450 int length;
1451 char *output = buf;
1452 for (i = 0; buf[i] && isspace(buf[i]); i++)
1453 ; /* do nothing */
1454 if (buf[i] == '[') {
1455 /* it's a section */
1456 int offset = section_name_match(&buf[i], old_name);
1457 if (offset > 0) {
1458 ret++;
1459 if (new_name == NULL) {
1460 remove = 1;
1461 continue;
1463 store.baselen = strlen(new_name);
1464 if (!store_write_section(out_fd, new_name)) {
1465 ret = write_error(lock->filename);
1466 goto out;
1469 * We wrote out the new section, with
1470 * a newline, now skip the old
1471 * section's length
1473 output += offset + i;
1474 if (strlen(output) > 0) {
1476 * More content means there's
1477 * a declaration to put on the
1478 * next line; indent with a
1479 * tab
1481 output -= 1;
1482 output[0] = '\t';
1485 remove = 0;
1487 if (remove)
1488 continue;
1489 length = strlen(output);
1490 if (write_in_full(out_fd, output, length) != length) {
1491 ret = write_error(lock->filename);
1492 goto out;
1495 fclose(config_file);
1496 unlock_and_out:
1497 if (commit_lock_file(lock) < 0)
1498 ret = error("could not commit config file %s", config_filename);
1499 out:
1500 free(config_filename);
1501 return ret;
1505 * Call this to report error for your variable that should not
1506 * get a boolean value (i.e. "[my] var" means "true").
1508 int config_error_nonbool(const char *var)
1510 return error("Missing value for '%s'", var);