Merge branch 'jl/maint-pull-tags-doc'
[alt-git.git] / config.c
blobc63d6834e087bbe2469cb285d3b3de475b76b972
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
25 struct config_item *next;
26 char *name;
27 char *value;
29 static struct config_item *config_parameters;
30 static struct config_item **config_parameters_tail = &config_parameters;
32 static void lowercase(char *p)
34 for (; *p; p++)
35 *p = tolower(*p);
38 void git_config_push_parameter(const char *text)
40 struct strbuf env = STRBUF_INIT;
41 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
42 if (old) {
43 strbuf_addstr(&env, old);
44 strbuf_addch(&env, ' ');
46 sq_quote_buf(&env, text);
47 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
48 strbuf_release(&env);
51 int git_config_parse_parameter(const char *text)
53 struct config_item *ct;
54 struct strbuf tmp = STRBUF_INIT;
55 struct strbuf **pair;
56 strbuf_addstr(&tmp, text);
57 pair = strbuf_split(&tmp, '=');
58 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
59 strbuf_setlen(pair[0], pair[0]->len - 1);
60 strbuf_trim(pair[0]);
61 if (!pair[0]->len) {
62 strbuf_list_free(pair);
63 return -1;
65 ct = xcalloc(1, sizeof(struct config_item));
66 ct->name = strbuf_detach(pair[0], NULL);
67 if (pair[1]) {
68 strbuf_trim(pair[1]);
69 ct->value = strbuf_detach(pair[1], NULL);
71 strbuf_list_free(pair);
72 lowercase(ct->name);
73 *config_parameters_tail = ct;
74 config_parameters_tail = &ct->next;
75 return 0;
78 int git_config_parse_environment(void) {
79 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
80 char *envw;
81 const char **argv = NULL;
82 int nr = 0, alloc = 0;
83 int i;
85 if (!env)
86 return 0;
87 /* sq_dequote will write over it */
88 envw = xstrdup(env);
90 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
91 free(envw);
92 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
95 for (i = 0; i < nr; i++) {
96 if (git_config_parse_parameter(argv[i]) < 0) {
97 error("bogus config parameter: %s", argv[i]);
98 free(argv);
99 free(envw);
100 return -1;
104 free(argv);
105 free(envw);
106 return 0;
109 static int get_next_char(void)
111 int c;
112 FILE *f;
114 c = '\n';
115 if ((f = config_file) != NULL) {
116 c = fgetc(f);
117 if (c == '\r') {
118 /* DOS like systems */
119 c = fgetc(f);
120 if (c != '\n') {
121 ungetc(c, f);
122 c = '\r';
125 if (c == '\n')
126 config_linenr++;
127 if (c == EOF) {
128 config_file_eof = 1;
129 c = '\n';
132 return c;
135 static char *parse_value(void)
137 static char value[1024];
138 int quote = 0, comment = 0, len = 0, space = 0;
140 for (;;) {
141 int c = get_next_char();
142 if (len >= sizeof(value) - 1)
143 return NULL;
144 if (c == '\n') {
145 if (quote)
146 return NULL;
147 value[len] = 0;
148 return value;
150 if (comment)
151 continue;
152 if (isspace(c) && !quote) {
153 if (len)
154 space++;
155 continue;
157 if (!quote) {
158 if (c == ';' || c == '#') {
159 comment = 1;
160 continue;
163 for (; space; space--)
164 value[len++] = ' ';
165 if (c == '\\') {
166 c = get_next_char();
167 switch (c) {
168 case '\n':
169 continue;
170 case 't':
171 c = '\t';
172 break;
173 case 'b':
174 c = '\b';
175 break;
176 case 'n':
177 c = '\n';
178 break;
179 /* Some characters escape as themselves */
180 case '\\': case '"':
181 break;
182 /* Reject unknown escape sequences */
183 default:
184 return NULL;
186 value[len++] = c;
187 continue;
189 if (c == '"') {
190 quote = 1-quote;
191 continue;
193 value[len++] = c;
197 static inline int iskeychar(int c)
199 return isalnum(c) || c == '-';
202 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
204 int c;
205 char *value;
207 /* Get the full name */
208 for (;;) {
209 c = get_next_char();
210 if (config_file_eof)
211 break;
212 if (!iskeychar(c))
213 break;
214 name[len++] = tolower(c);
215 if (len >= MAXNAME)
216 return -1;
218 name[len] = 0;
219 while (c == ' ' || c == '\t')
220 c = get_next_char();
222 value = NULL;
223 if (c != '\n') {
224 if (c != '=')
225 return -1;
226 value = parse_value();
227 if (!value)
228 return -1;
230 return fn(name, value, data);
233 static int get_extended_base_var(char *name, int baselen, int c)
235 do {
236 if (c == '\n')
237 return -1;
238 c = get_next_char();
239 } while (isspace(c));
241 /* We require the format to be '[base "extension"]' */
242 if (c != '"')
243 return -1;
244 name[baselen++] = '.';
246 for (;;) {
247 int c = get_next_char();
248 if (c == '\n')
249 return -1;
250 if (c == '"')
251 break;
252 if (c == '\\') {
253 c = get_next_char();
254 if (c == '\n')
255 return -1;
257 name[baselen++] = c;
258 if (baselen > MAXNAME / 2)
259 return -1;
262 /* Final ']' */
263 if (get_next_char() != ']')
264 return -1;
265 return baselen;
268 static int get_base_var(char *name)
270 int baselen = 0;
272 for (;;) {
273 int c = get_next_char();
274 if (config_file_eof)
275 return -1;
276 if (c == ']')
277 return baselen;
278 if (isspace(c))
279 return get_extended_base_var(name, baselen, c);
280 if (!iskeychar(c) && c != '.')
281 return -1;
282 if (baselen > MAXNAME / 2)
283 return -1;
284 name[baselen++] = tolower(c);
288 static int git_parse_file(config_fn_t fn, void *data)
290 int comment = 0;
291 int baselen = 0;
292 static char var[MAXNAME];
294 /* U+FEFF Byte Order Mark in UTF8 */
295 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
296 const unsigned char *bomptr = utf8_bom;
298 for (;;) {
299 int c = get_next_char();
300 if (bomptr && *bomptr) {
301 /* We are at the file beginning; skip UTF8-encoded BOM
302 * if present. Sane editors won't put this in on their
303 * own, but e.g. Windows Notepad will do it happily. */
304 if ((unsigned char) c == *bomptr) {
305 bomptr++;
306 continue;
307 } else {
308 /* Do not tolerate partial BOM. */
309 if (bomptr != utf8_bom)
310 break;
311 /* No BOM at file beginning. Cool. */
312 bomptr = NULL;
315 if (c == '\n') {
316 if (config_file_eof)
317 return 0;
318 comment = 0;
319 continue;
321 if (comment || isspace(c))
322 continue;
323 if (c == '#' || c == ';') {
324 comment = 1;
325 continue;
327 if (c == '[') {
328 baselen = get_base_var(var);
329 if (baselen <= 0)
330 break;
331 var[baselen++] = '.';
332 var[baselen] = 0;
333 continue;
335 if (!isalpha(c))
336 break;
337 var[baselen] = tolower(c);
338 if (get_value(fn, data, var, baselen+1) < 0)
339 break;
341 die("bad config file line %d in %s", config_linenr, config_file_name);
344 static int parse_unit_factor(const char *end, unsigned long *val)
346 if (!*end)
347 return 1;
348 else if (!strcasecmp(end, "k")) {
349 *val *= 1024;
350 return 1;
352 else if (!strcasecmp(end, "m")) {
353 *val *= 1024 * 1024;
354 return 1;
356 else if (!strcasecmp(end, "g")) {
357 *val *= 1024 * 1024 * 1024;
358 return 1;
360 return 0;
363 static int git_parse_long(const char *value, long *ret)
365 if (value && *value) {
366 char *end;
367 long val = strtol(value, &end, 0);
368 unsigned long factor = 1;
369 if (!parse_unit_factor(end, &factor))
370 return 0;
371 *ret = val * factor;
372 return 1;
374 return 0;
377 int git_parse_ulong(const char *value, unsigned long *ret)
379 if (value && *value) {
380 char *end;
381 unsigned long val = strtoul(value, &end, 0);
382 if (!parse_unit_factor(end, &val))
383 return 0;
384 *ret = val;
385 return 1;
387 return 0;
390 static void die_bad_config(const char *name)
392 if (config_file_name)
393 die("bad config value for '%s' in %s", name, config_file_name);
394 die("bad config value for '%s'", name);
397 int git_config_int(const char *name, const char *value)
399 long ret = 0;
400 if (!git_parse_long(value, &ret))
401 die_bad_config(name);
402 return ret;
405 unsigned long git_config_ulong(const char *name, const char *value)
407 unsigned long ret;
408 if (!git_parse_ulong(value, &ret))
409 die_bad_config(name);
410 return ret;
413 int git_config_maybe_bool(const char *name, const char *value)
415 if (!value)
416 return 1;
417 if (!*value)
418 return 0;
419 if (!strcasecmp(value, "true")
420 || !strcasecmp(value, "yes")
421 || !strcasecmp(value, "on"))
422 return 1;
423 if (!strcasecmp(value, "false")
424 || !strcasecmp(value, "no")
425 || !strcasecmp(value, "off"))
426 return 0;
427 return -1;
430 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
432 int v = git_config_maybe_bool(name, value);
433 if (0 <= v) {
434 *is_bool = 1;
435 return v;
437 *is_bool = 0;
438 return git_config_int(name, value);
441 int git_config_bool(const char *name, const char *value)
443 int discard;
444 return !!git_config_bool_or_int(name, value, &discard);
447 int git_config_string(const char **dest, const char *var, const char *value)
449 if (!value)
450 return config_error_nonbool(var);
451 *dest = xstrdup(value);
452 return 0;
455 int git_config_pathname(const char **dest, const char *var, const char *value)
457 if (!value)
458 return config_error_nonbool(var);
459 *dest = expand_user_path(value);
460 if (!*dest)
461 die("Failed to expand user dir in: '%s'", value);
462 return 0;
465 static int git_default_core_config(const char *var, const char *value)
467 /* This needs a better name */
468 if (!strcmp(var, "core.filemode")) {
469 trust_executable_bit = git_config_bool(var, value);
470 return 0;
472 if (!strcmp(var, "core.trustctime")) {
473 trust_ctime = git_config_bool(var, value);
474 return 0;
477 if (!strcmp(var, "core.quotepath")) {
478 quote_path_fully = git_config_bool(var, value);
479 return 0;
482 if (!strcmp(var, "core.symlinks")) {
483 has_symlinks = git_config_bool(var, value);
484 return 0;
487 if (!strcmp(var, "core.ignorecase")) {
488 ignore_case = git_config_bool(var, value);
489 return 0;
492 if (!strcmp(var, "core.bare")) {
493 is_bare_repository_cfg = git_config_bool(var, value);
494 return 0;
497 if (!strcmp(var, "core.ignorestat")) {
498 assume_unchanged = git_config_bool(var, value);
499 return 0;
502 if (!strcmp(var, "core.prefersymlinkrefs")) {
503 prefer_symlink_refs = git_config_bool(var, value);
504 return 0;
507 if (!strcmp(var, "core.logallrefupdates")) {
508 log_all_ref_updates = git_config_bool(var, value);
509 return 0;
512 if (!strcmp(var, "core.warnambiguousrefs")) {
513 warn_ambiguous_refs = git_config_bool(var, value);
514 return 0;
517 if (!strcmp(var, "core.loosecompression")) {
518 int level = git_config_int(var, value);
519 if (level == -1)
520 level = Z_DEFAULT_COMPRESSION;
521 else if (level < 0 || level > Z_BEST_COMPRESSION)
522 die("bad zlib compression level %d", level);
523 zlib_compression_level = level;
524 zlib_compression_seen = 1;
525 return 0;
528 if (!strcmp(var, "core.compression")) {
529 int level = git_config_int(var, value);
530 if (level == -1)
531 level = Z_DEFAULT_COMPRESSION;
532 else if (level < 0 || level > Z_BEST_COMPRESSION)
533 die("bad zlib compression level %d", level);
534 core_compression_level = level;
535 core_compression_seen = 1;
536 if (!zlib_compression_seen)
537 zlib_compression_level = level;
538 return 0;
541 if (!strcmp(var, "core.packedgitwindowsize")) {
542 int pgsz_x2 = getpagesize() * 2;
543 packed_git_window_size = git_config_int(var, value);
545 /* This value must be multiple of (pagesize * 2) */
546 packed_git_window_size /= pgsz_x2;
547 if (packed_git_window_size < 1)
548 packed_git_window_size = 1;
549 packed_git_window_size *= pgsz_x2;
550 return 0;
553 if (!strcmp(var, "core.packedgitlimit")) {
554 packed_git_limit = git_config_int(var, value);
555 return 0;
558 if (!strcmp(var, "core.deltabasecachelimit")) {
559 delta_base_cache_limit = git_config_int(var, value);
560 return 0;
563 if (!strcmp(var, "core.autocrlf")) {
564 if (value && !strcasecmp(value, "input")) {
565 if (eol == EOL_CRLF)
566 return error("core.autocrlf=input conflicts with core.eol=crlf");
567 auto_crlf = AUTO_CRLF_INPUT;
568 return 0;
570 auto_crlf = git_config_bool(var, value);
571 return 0;
574 if (!strcmp(var, "core.safecrlf")) {
575 if (value && !strcasecmp(value, "warn")) {
576 safe_crlf = SAFE_CRLF_WARN;
577 return 0;
579 safe_crlf = git_config_bool(var, value);
580 return 0;
583 if (!strcmp(var, "core.eol")) {
584 if (value && !strcasecmp(value, "lf"))
585 eol = EOL_LF;
586 else if (value && !strcasecmp(value, "crlf"))
587 eol = EOL_CRLF;
588 else if (value && !strcasecmp(value, "native"))
589 eol = EOL_NATIVE;
590 else
591 eol = EOL_UNSET;
592 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
593 return error("core.autocrlf=input conflicts with core.eol=crlf");
594 return 0;
597 if (!strcmp(var, "core.notesref")) {
598 notes_ref_name = xstrdup(value);
599 return 0;
602 if (!strcmp(var, "core.pager"))
603 return git_config_string(&pager_program, var, value);
605 if (!strcmp(var, "core.editor"))
606 return git_config_string(&editor_program, var, value);
608 if (!strcmp(var, "core.askpass"))
609 return git_config_string(&askpass_program, var, value);
611 if (!strcmp(var, "core.excludesfile"))
612 return git_config_pathname(&excludes_file, var, value);
614 if (!strcmp(var, "core.whitespace")) {
615 if (!value)
616 return config_error_nonbool(var);
617 whitespace_rule_cfg = parse_whitespace_rule(value);
618 return 0;
621 if (!strcmp(var, "core.fsyncobjectfiles")) {
622 fsync_object_files = git_config_bool(var, value);
623 return 0;
626 if (!strcmp(var, "core.preloadindex")) {
627 core_preload_index = git_config_bool(var, value);
628 return 0;
631 if (!strcmp(var, "core.createobject")) {
632 if (!strcmp(value, "rename"))
633 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
634 else if (!strcmp(value, "link"))
635 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
636 else
637 die("Invalid mode for object creation: %s", value);
638 return 0;
641 if (!strcmp(var, "core.sparsecheckout")) {
642 core_apply_sparse_checkout = git_config_bool(var, value);
643 return 0;
646 /* Add other config variables here and to Documentation/config.txt. */
647 return 0;
650 static int git_default_user_config(const char *var, const char *value)
652 if (!strcmp(var, "user.name")) {
653 if (!value)
654 return config_error_nonbool(var);
655 strlcpy(git_default_name, value, sizeof(git_default_name));
656 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
657 return 0;
660 if (!strcmp(var, "user.email")) {
661 if (!value)
662 return config_error_nonbool(var);
663 strlcpy(git_default_email, value, sizeof(git_default_email));
664 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
665 return 0;
668 /* Add other config variables here and to Documentation/config.txt. */
669 return 0;
672 static int git_default_i18n_config(const char *var, const char *value)
674 if (!strcmp(var, "i18n.commitencoding"))
675 return git_config_string(&git_commit_encoding, var, value);
677 if (!strcmp(var, "i18n.logoutputencoding"))
678 return git_config_string(&git_log_output_encoding, var, value);
680 /* Add other config variables here and to Documentation/config.txt. */
681 return 0;
684 static int git_default_branch_config(const char *var, const char *value)
686 if (!strcmp(var, "branch.autosetupmerge")) {
687 if (value && !strcasecmp(value, "always")) {
688 git_branch_track = BRANCH_TRACK_ALWAYS;
689 return 0;
691 git_branch_track = git_config_bool(var, value);
692 return 0;
694 if (!strcmp(var, "branch.autosetuprebase")) {
695 if (!value)
696 return config_error_nonbool(var);
697 else if (!strcmp(value, "never"))
698 autorebase = AUTOREBASE_NEVER;
699 else if (!strcmp(value, "local"))
700 autorebase = AUTOREBASE_LOCAL;
701 else if (!strcmp(value, "remote"))
702 autorebase = AUTOREBASE_REMOTE;
703 else if (!strcmp(value, "always"))
704 autorebase = AUTOREBASE_ALWAYS;
705 else
706 return error("Malformed value for %s", var);
707 return 0;
710 /* Add other config variables here and to Documentation/config.txt. */
711 return 0;
714 static int git_default_push_config(const char *var, const char *value)
716 if (!strcmp(var, "push.default")) {
717 if (!value)
718 return config_error_nonbool(var);
719 else if (!strcmp(value, "nothing"))
720 push_default = PUSH_DEFAULT_NOTHING;
721 else if (!strcmp(value, "matching"))
722 push_default = PUSH_DEFAULT_MATCHING;
723 else if (!strcmp(value, "tracking"))
724 push_default = PUSH_DEFAULT_TRACKING;
725 else if (!strcmp(value, "current"))
726 push_default = PUSH_DEFAULT_CURRENT;
727 else {
728 error("Malformed value for %s: %s", var, value);
729 return error("Must be one of nothing, matching, "
730 "tracking or current.");
732 return 0;
735 /* Add other config variables here and to Documentation/config.txt. */
736 return 0;
739 static int git_default_mailmap_config(const char *var, const char *value)
741 if (!strcmp(var, "mailmap.file"))
742 return git_config_string(&git_mailmap_file, var, value);
744 /* Add other config variables here and to Documentation/config.txt. */
745 return 0;
748 int git_default_config(const char *var, const char *value, void *dummy)
750 if (!prefixcmp(var, "core."))
751 return git_default_core_config(var, value);
753 if (!prefixcmp(var, "user."))
754 return git_default_user_config(var, value);
756 if (!prefixcmp(var, "i18n."))
757 return git_default_i18n_config(var, value);
759 if (!prefixcmp(var, "branch."))
760 return git_default_branch_config(var, value);
762 if (!prefixcmp(var, "push."))
763 return git_default_push_config(var, value);
765 if (!prefixcmp(var, "mailmap."))
766 return git_default_mailmap_config(var, value);
768 if (!prefixcmp(var, "advice."))
769 return git_default_advice_config(var, value);
771 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
772 pager_use_color = git_config_bool(var,value);
773 return 0;
776 /* Add other config variables here and to Documentation/config.txt. */
777 return 0;
780 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
782 int ret;
783 FILE *f = fopen(filename, "r");
785 ret = -1;
786 if (f) {
787 config_file = f;
788 config_file_name = filename;
789 config_linenr = 1;
790 config_file_eof = 0;
791 ret = git_parse_file(fn, data);
792 fclose(f);
793 config_file_name = NULL;
795 return ret;
798 const char *git_etc_gitconfig(void)
800 static const char *system_wide;
801 if (!system_wide)
802 system_wide = system_path(ETC_GITCONFIG);
803 return system_wide;
806 int git_env_bool(const char *k, int def)
808 const char *v = getenv(k);
809 return v ? git_config_bool(k, v) : def;
812 int git_config_system(void)
814 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
817 int git_config_global(void)
819 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
822 int git_config_from_parameters(config_fn_t fn, void *data)
824 static int loaded_environment;
825 const struct config_item *ct;
827 if (!loaded_environment) {
828 if (git_config_parse_environment() < 0)
829 return -1;
830 loaded_environment = 1;
832 for (ct = config_parameters; ct; ct = ct->next)
833 if (fn(ct->name, ct->value, data) < 0)
834 return -1;
835 return 0;
838 int git_config(config_fn_t fn, void *data)
840 int ret = 0, found = 0;
841 char *repo_config = NULL;
842 const char *home = NULL;
844 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
845 if (config_exclusive_filename)
846 return git_config_from_file(fn, config_exclusive_filename, data);
847 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
848 ret += git_config_from_file(fn, git_etc_gitconfig(),
849 data);
850 found += 1;
853 home = getenv("HOME");
854 if (git_config_global() && home) {
855 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
856 if (!access(user_config, R_OK)) {
857 ret += git_config_from_file(fn, user_config, data);
858 found += 1;
860 free(user_config);
863 repo_config = git_pathdup("config");
864 if (!access(repo_config, R_OK)) {
865 ret += git_config_from_file(fn, repo_config, data);
866 found += 1;
868 free(repo_config);
870 ret += git_config_from_parameters(fn, data);
871 if (config_parameters)
872 found += 1;
874 return ret == 0 ? found : ret;
878 * Find all the stuff for git_config_set() below.
881 #define MAX_MATCHES 512
883 static struct {
884 int baselen;
885 char *key;
886 int do_not_match;
887 regex_t *value_regex;
888 int multi_replace;
889 size_t offset[MAX_MATCHES];
890 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
891 int seen;
892 } store;
894 static int matches(const char *key, const char *value)
896 return !strcmp(key, store.key) &&
897 (store.value_regex == NULL ||
898 (store.do_not_match ^
899 !regexec(store.value_regex, value, 0, NULL, 0)));
902 static int store_aux(const char *key, const char *value, void *cb)
904 const char *ep;
905 size_t section_len;
907 switch (store.state) {
908 case KEY_SEEN:
909 if (matches(key, value)) {
910 if (store.seen == 1 && store.multi_replace == 0) {
911 warning("%s has multiple values", key);
912 } else if (store.seen >= MAX_MATCHES) {
913 error("too many matches for %s", key);
914 return 1;
917 store.offset[store.seen] = ftell(config_file);
918 store.seen++;
920 break;
921 case SECTION_SEEN:
923 * What we are looking for is in store.key (both
924 * section and var), and its section part is baselen
925 * long. We found key (again, both section and var).
926 * We would want to know if this key is in the same
927 * section as what we are looking for. We already
928 * know we are in the same section as what should
929 * hold store.key.
931 ep = strrchr(key, '.');
932 section_len = ep - key;
934 if ((section_len != store.baselen) ||
935 memcmp(key, store.key, section_len+1)) {
936 store.state = SECTION_END_SEEN;
937 break;
941 * Do not increment matches: this is no match, but we
942 * just made sure we are in the desired section.
944 store.offset[store.seen] = ftell(config_file);
945 /* fallthru */
946 case SECTION_END_SEEN:
947 case START:
948 if (matches(key, value)) {
949 store.offset[store.seen] = ftell(config_file);
950 store.state = KEY_SEEN;
951 store.seen++;
952 } else {
953 if (strrchr(key, '.') - key == store.baselen &&
954 !strncmp(key, store.key, store.baselen)) {
955 store.state = SECTION_SEEN;
956 store.offset[store.seen] = ftell(config_file);
960 return 0;
963 static int write_error(const char *filename)
965 error("failed to write new configuration file %s", filename);
967 /* Same error code as "failed to rename". */
968 return 4;
971 static int store_write_section(int fd, const char *key)
973 const char *dot;
974 int i, success;
975 struct strbuf sb = STRBUF_INIT;
977 dot = memchr(key, '.', store.baselen);
978 if (dot) {
979 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
980 for (i = dot - key + 1; i < store.baselen; i++) {
981 if (key[i] == '"' || key[i] == '\\')
982 strbuf_addch(&sb, '\\');
983 strbuf_addch(&sb, key[i]);
985 strbuf_addstr(&sb, "\"]\n");
986 } else {
987 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
990 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
991 strbuf_release(&sb);
993 return success;
996 static int store_write_pair(int fd, const char *key, const char *value)
998 int i, success;
999 int length = strlen(key + store.baselen + 1);
1000 const char *quote = "";
1001 struct strbuf sb = STRBUF_INIT;
1004 * Check to see if the value needs to be surrounded with a dq pair.
1005 * Note that problematic characters are always backslash-quoted; this
1006 * check is about not losing leading or trailing SP and strings that
1007 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1008 * configuration parser.
1010 if (value[0] == ' ')
1011 quote = "\"";
1012 for (i = 0; value[i]; i++)
1013 if (value[i] == ';' || value[i] == '#')
1014 quote = "\"";
1015 if (i && value[i - 1] == ' ')
1016 quote = "\"";
1018 strbuf_addf(&sb, "\t%.*s = %s",
1019 length, key + store.baselen + 1, quote);
1021 for (i = 0; value[i]; i++)
1022 switch (value[i]) {
1023 case '\n':
1024 strbuf_addstr(&sb, "\\n");
1025 break;
1026 case '\t':
1027 strbuf_addstr(&sb, "\\t");
1028 break;
1029 case '"':
1030 case '\\':
1031 strbuf_addch(&sb, '\\');
1032 default:
1033 strbuf_addch(&sb, value[i]);
1034 break;
1036 strbuf_addf(&sb, "%s\n", quote);
1038 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1039 strbuf_release(&sb);
1041 return success;
1044 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1045 size_t offset_, int *found_bracket)
1047 size_t equal_offset = size, bracket_offset = size;
1048 ssize_t offset;
1050 contline:
1051 for (offset = offset_-2; offset > 0
1052 && contents[offset] != '\n'; offset--)
1053 switch (contents[offset]) {
1054 case '=': equal_offset = offset; break;
1055 case ']': bracket_offset = offset; break;
1057 if (offset > 0 && contents[offset-1] == '\\') {
1058 offset_ = offset;
1059 goto contline;
1061 if (bracket_offset < equal_offset) {
1062 *found_bracket = 1;
1063 offset = bracket_offset+1;
1064 } else
1065 offset++;
1067 return offset;
1070 int git_config_set(const char *key, const char *value)
1072 return git_config_set_multivar(key, value, NULL, 0);
1076 * If value==NULL, unset in (remove from) config,
1077 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1078 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1079 * else all matching key/values (regardless how many) are removed,
1080 * before the new pair is written.
1082 * Returns 0 on success.
1084 * This function does this:
1086 * - it locks the config file by creating ".git/config.lock"
1088 * - it then parses the config using store_aux() as validator to find
1089 * the position on the key/value pair to replace. If it is to be unset,
1090 * it must be found exactly once.
1092 * - the config file is mmap()ed and the part before the match (if any) is
1093 * written to the lock file, then the changed part and the rest.
1095 * - the config file is removed and the lock file rename()d to it.
1098 int git_config_set_multivar(const char *key, const char *value,
1099 const char *value_regex, int multi_replace)
1101 int i, dot;
1102 int fd = -1, in_fd;
1103 int ret;
1104 char *config_filename;
1105 struct lock_file *lock = NULL;
1106 const char *last_dot = strrchr(key, '.');
1108 if (config_exclusive_filename)
1109 config_filename = xstrdup(config_exclusive_filename);
1110 else
1111 config_filename = git_pathdup("config");
1114 * Since "key" actually contains the section name and the real
1115 * key name separated by a dot, we have to know where the dot is.
1118 if (last_dot == NULL) {
1119 error("key does not contain a section: %s", key);
1120 ret = 2;
1121 goto out_free;
1123 store.baselen = last_dot - key;
1125 store.multi_replace = multi_replace;
1128 * Validate the key and while at it, lower case it for matching.
1130 store.key = xmalloc(strlen(key) + 1);
1131 dot = 0;
1132 for (i = 0; key[i]; i++) {
1133 unsigned char c = key[i];
1134 if (c == '.')
1135 dot = 1;
1136 /* Leave the extended basename untouched.. */
1137 if (!dot || i > store.baselen) {
1138 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
1139 error("invalid key: %s", key);
1140 free(store.key);
1141 ret = 1;
1142 goto out_free;
1144 c = tolower(c);
1145 } else if (c == '\n') {
1146 error("invalid key (newline): %s", key);
1147 free(store.key);
1148 ret = 1;
1149 goto out_free;
1151 store.key[i] = c;
1153 store.key[i] = 0;
1156 * The lock serves a purpose in addition to locking: the new
1157 * contents of .git/config will be written into it.
1159 lock = xcalloc(sizeof(struct lock_file), 1);
1160 fd = hold_lock_file_for_update(lock, config_filename, 0);
1161 if (fd < 0) {
1162 error("could not lock config file %s: %s", config_filename, strerror(errno));
1163 free(store.key);
1164 ret = -1;
1165 goto out_free;
1169 * If .git/config does not exist yet, write a minimal version.
1171 in_fd = open(config_filename, O_RDONLY);
1172 if ( in_fd < 0 ) {
1173 free(store.key);
1175 if ( ENOENT != errno ) {
1176 error("opening %s: %s", config_filename,
1177 strerror(errno));
1178 ret = 3; /* same as "invalid config file" */
1179 goto out_free;
1181 /* if nothing to unset, error out */
1182 if (value == NULL) {
1183 ret = 5;
1184 goto out_free;
1187 store.key = (char *)key;
1188 if (!store_write_section(fd, key) ||
1189 !store_write_pair(fd, key, value))
1190 goto write_err_out;
1191 } else {
1192 struct stat st;
1193 char *contents;
1194 size_t contents_sz, copy_begin, copy_end;
1195 int i, new_line = 0;
1197 if (value_regex == NULL)
1198 store.value_regex = NULL;
1199 else {
1200 if (value_regex[0] == '!') {
1201 store.do_not_match = 1;
1202 value_regex++;
1203 } else
1204 store.do_not_match = 0;
1206 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1207 if (regcomp(store.value_regex, value_regex,
1208 REG_EXTENDED)) {
1209 error("invalid pattern: %s", value_regex);
1210 free(store.value_regex);
1211 ret = 6;
1212 goto out_free;
1216 store.offset[0] = 0;
1217 store.state = START;
1218 store.seen = 0;
1221 * After this, store.offset will contain the *end* offset
1222 * of the last match, or remain at 0 if no match was found.
1223 * As a side effect, we make sure to transform only a valid
1224 * existing config file.
1226 if (git_config_from_file(store_aux, config_filename, NULL)) {
1227 error("invalid config file %s", config_filename);
1228 free(store.key);
1229 if (store.value_regex != NULL) {
1230 regfree(store.value_regex);
1231 free(store.value_regex);
1233 ret = 3;
1234 goto out_free;
1237 free(store.key);
1238 if (store.value_regex != NULL) {
1239 regfree(store.value_regex);
1240 free(store.value_regex);
1243 /* if nothing to unset, or too many matches, error out */
1244 if ((store.seen == 0 && value == NULL) ||
1245 (store.seen > 1 && multi_replace == 0)) {
1246 ret = 5;
1247 goto out_free;
1250 fstat(in_fd, &st);
1251 contents_sz = xsize_t(st.st_size);
1252 contents = xmmap(NULL, contents_sz, PROT_READ,
1253 MAP_PRIVATE, in_fd, 0);
1254 close(in_fd);
1256 if (store.seen == 0)
1257 store.seen = 1;
1259 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1260 if (store.offset[i] == 0) {
1261 store.offset[i] = copy_end = contents_sz;
1262 } else if (store.state != KEY_SEEN) {
1263 copy_end = store.offset[i];
1264 } else
1265 copy_end = find_beginning_of_line(
1266 contents, contents_sz,
1267 store.offset[i]-2, &new_line);
1269 if (copy_end > 0 && contents[copy_end-1] != '\n')
1270 new_line = 1;
1272 /* write the first part of the config */
1273 if (copy_end > copy_begin) {
1274 if (write_in_full(fd, contents + copy_begin,
1275 copy_end - copy_begin) <
1276 copy_end - copy_begin)
1277 goto write_err_out;
1278 if (new_line &&
1279 write_str_in_full(fd, "\n") != 1)
1280 goto write_err_out;
1282 copy_begin = store.offset[i];
1285 /* write the pair (value == NULL means unset) */
1286 if (value != NULL) {
1287 if (store.state == START) {
1288 if (!store_write_section(fd, key))
1289 goto write_err_out;
1291 if (!store_write_pair(fd, key, value))
1292 goto write_err_out;
1295 /* write the rest of the config */
1296 if (copy_begin < contents_sz)
1297 if (write_in_full(fd, contents + copy_begin,
1298 contents_sz - copy_begin) <
1299 contents_sz - copy_begin)
1300 goto write_err_out;
1302 munmap(contents, contents_sz);
1305 if (commit_lock_file(lock) < 0) {
1306 error("could not commit config file %s", config_filename);
1307 ret = 4;
1308 goto out_free;
1312 * lock is committed, so don't try to roll it back below.
1313 * NOTE: Since lockfile.c keeps a linked list of all created
1314 * lock_file structures, it isn't safe to free(lock). It's
1315 * better to just leave it hanging around.
1317 lock = NULL;
1318 ret = 0;
1320 out_free:
1321 if (lock)
1322 rollback_lock_file(lock);
1323 free(config_filename);
1324 return ret;
1326 write_err_out:
1327 ret = write_error(lock->filename);
1328 goto out_free;
1332 static int section_name_match (const char *buf, const char *name)
1334 int i = 0, j = 0, dot = 0;
1335 if (buf[i] != '[')
1336 return 0;
1337 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1338 if (!dot && isspace(buf[i])) {
1339 dot = 1;
1340 if (name[j++] != '.')
1341 break;
1342 for (i++; isspace(buf[i]); i++)
1343 ; /* do nothing */
1344 if (buf[i] != '"')
1345 break;
1346 continue;
1348 if (buf[i] == '\\' && dot)
1349 i++;
1350 else if (buf[i] == '"' && dot) {
1351 for (i++; isspace(buf[i]); i++)
1352 ; /* do_nothing */
1353 break;
1355 if (buf[i] != name[j++])
1356 break;
1358 if (buf[i] == ']' && name[j] == 0) {
1360 * We match, now just find the right length offset by
1361 * gobbling up any whitespace after it, as well
1363 i++;
1364 for (; buf[i] && isspace(buf[i]); i++)
1365 ; /* do nothing */
1366 return i;
1368 return 0;
1371 /* if new_name == NULL, the section is removed instead */
1372 int git_config_rename_section(const char *old_name, const char *new_name)
1374 int ret = 0, remove = 0;
1375 char *config_filename;
1376 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1377 int out_fd;
1378 char buf[1024];
1380 if (config_exclusive_filename)
1381 config_filename = xstrdup(config_exclusive_filename);
1382 else
1383 config_filename = git_pathdup("config");
1384 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1385 if (out_fd < 0) {
1386 ret = error("could not lock config file %s", config_filename);
1387 goto out;
1390 if (!(config_file = fopen(config_filename, "rb"))) {
1391 /* no config file means nothing to rename, no error */
1392 goto unlock_and_out;
1395 while (fgets(buf, sizeof(buf), config_file)) {
1396 int i;
1397 int length;
1398 char *output = buf;
1399 for (i = 0; buf[i] && isspace(buf[i]); i++)
1400 ; /* do nothing */
1401 if (buf[i] == '[') {
1402 /* it's a section */
1403 int offset = section_name_match(&buf[i], old_name);
1404 if (offset > 0) {
1405 ret++;
1406 if (new_name == NULL) {
1407 remove = 1;
1408 continue;
1410 store.baselen = strlen(new_name);
1411 if (!store_write_section(out_fd, new_name)) {
1412 ret = write_error(lock->filename);
1413 goto out;
1416 * We wrote out the new section, with
1417 * a newline, now skip the old
1418 * section's length
1420 output += offset + i;
1421 if (strlen(output) > 0) {
1423 * More content means there's
1424 * a declaration to put on the
1425 * next line; indent with a
1426 * tab
1428 output -= 1;
1429 output[0] = '\t';
1432 remove = 0;
1434 if (remove)
1435 continue;
1436 length = strlen(output);
1437 if (write_in_full(out_fd, output, length) != length) {
1438 ret = write_error(lock->filename);
1439 goto out;
1442 fclose(config_file);
1443 unlock_and_out:
1444 if (commit_lock_file(lock) < 0)
1445 ret = error("could not commit config file %s", config_filename);
1446 out:
1447 free(config_filename);
1448 return ret;
1452 * Call this to report error for your variable that should not
1453 * get a boolean value (i.e. "[my] var" means "true").
1455 int config_error_nonbool(const char *var)
1457 return error("Missing value for '%s'", var);