gitweb/lib - Cache captured output (using get/set)
[git/jnareb-git.git] / config.c
blobf138c34721b4751f3e8b0a1d10680f70ebfa2741
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.abbrevguard")) {
493 unique_abbrev_extra_length = git_config_int(var, value);
494 if (unique_abbrev_extra_length < 0)
495 unique_abbrev_extra_length = 0;
496 return 0;
499 if (!strcmp(var, "core.bare")) {
500 is_bare_repository_cfg = git_config_bool(var, value);
501 return 0;
504 if (!strcmp(var, "core.ignorestat")) {
505 assume_unchanged = git_config_bool(var, value);
506 return 0;
509 if (!strcmp(var, "core.prefersymlinkrefs")) {
510 prefer_symlink_refs = git_config_bool(var, value);
511 return 0;
514 if (!strcmp(var, "core.logallrefupdates")) {
515 log_all_ref_updates = git_config_bool(var, value);
516 return 0;
519 if (!strcmp(var, "core.warnambiguousrefs")) {
520 warn_ambiguous_refs = git_config_bool(var, value);
521 return 0;
524 if (!strcmp(var, "core.loosecompression")) {
525 int level = git_config_int(var, value);
526 if (level == -1)
527 level = Z_DEFAULT_COMPRESSION;
528 else if (level < 0 || level > Z_BEST_COMPRESSION)
529 die("bad zlib compression level %d", level);
530 zlib_compression_level = level;
531 zlib_compression_seen = 1;
532 return 0;
535 if (!strcmp(var, "core.compression")) {
536 int level = git_config_int(var, value);
537 if (level == -1)
538 level = Z_DEFAULT_COMPRESSION;
539 else if (level < 0 || level > Z_BEST_COMPRESSION)
540 die("bad zlib compression level %d", level);
541 core_compression_level = level;
542 core_compression_seen = 1;
543 if (!zlib_compression_seen)
544 zlib_compression_level = level;
545 return 0;
548 if (!strcmp(var, "core.packedgitwindowsize")) {
549 int pgsz_x2 = getpagesize() * 2;
550 packed_git_window_size = git_config_int(var, value);
552 /* This value must be multiple of (pagesize * 2) */
553 packed_git_window_size /= pgsz_x2;
554 if (packed_git_window_size < 1)
555 packed_git_window_size = 1;
556 packed_git_window_size *= pgsz_x2;
557 return 0;
560 if (!strcmp(var, "core.packedgitlimit")) {
561 packed_git_limit = git_config_int(var, value);
562 return 0;
565 if (!strcmp(var, "core.deltabasecachelimit")) {
566 delta_base_cache_limit = git_config_int(var, value);
567 return 0;
570 if (!strcmp(var, "core.autocrlf")) {
571 if (value && !strcasecmp(value, "input")) {
572 if (eol == EOL_CRLF)
573 return error("core.autocrlf=input conflicts with core.eol=crlf");
574 auto_crlf = AUTO_CRLF_INPUT;
575 return 0;
577 auto_crlf = git_config_bool(var, value);
578 return 0;
581 if (!strcmp(var, "core.safecrlf")) {
582 if (value && !strcasecmp(value, "warn")) {
583 safe_crlf = SAFE_CRLF_WARN;
584 return 0;
586 safe_crlf = git_config_bool(var, value);
587 return 0;
590 if (!strcmp(var, "core.eol")) {
591 if (value && !strcasecmp(value, "lf"))
592 eol = EOL_LF;
593 else if (value && !strcasecmp(value, "crlf"))
594 eol = EOL_CRLF;
595 else if (value && !strcasecmp(value, "native"))
596 eol = EOL_NATIVE;
597 else
598 eol = EOL_UNSET;
599 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
600 return error("core.autocrlf=input conflicts with core.eol=crlf");
601 return 0;
604 if (!strcmp(var, "core.notesref")) {
605 notes_ref_name = xstrdup(value);
606 return 0;
609 if (!strcmp(var, "core.pager"))
610 return git_config_string(&pager_program, var, value);
612 if (!strcmp(var, "core.editor"))
613 return git_config_string(&editor_program, var, value);
615 if (!strcmp(var, "core.askpass"))
616 return git_config_string(&askpass_program, var, value);
618 if (!strcmp(var, "core.excludesfile"))
619 return git_config_pathname(&excludes_file, var, value);
621 if (!strcmp(var, "core.whitespace")) {
622 if (!value)
623 return config_error_nonbool(var);
624 whitespace_rule_cfg = parse_whitespace_rule(value);
625 return 0;
628 if (!strcmp(var, "core.fsyncobjectfiles")) {
629 fsync_object_files = git_config_bool(var, value);
630 return 0;
633 if (!strcmp(var, "core.preloadindex")) {
634 core_preload_index = git_config_bool(var, value);
635 return 0;
638 if (!strcmp(var, "core.createobject")) {
639 if (!strcmp(value, "rename"))
640 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
641 else if (!strcmp(value, "link"))
642 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
643 else
644 die("Invalid mode for object creation: %s", value);
645 return 0;
648 if (!strcmp(var, "core.sparsecheckout")) {
649 core_apply_sparse_checkout = git_config_bool(var, value);
650 return 0;
653 /* Add other config variables here and to Documentation/config.txt. */
654 return 0;
657 static int git_default_user_config(const char *var, const char *value)
659 if (!strcmp(var, "user.name")) {
660 if (!value)
661 return config_error_nonbool(var);
662 strlcpy(git_default_name, value, sizeof(git_default_name));
663 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
664 return 0;
667 if (!strcmp(var, "user.email")) {
668 if (!value)
669 return config_error_nonbool(var);
670 strlcpy(git_default_email, value, sizeof(git_default_email));
671 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
672 return 0;
675 /* Add other config variables here and to Documentation/config.txt. */
676 return 0;
679 static int git_default_i18n_config(const char *var, const char *value)
681 if (!strcmp(var, "i18n.commitencoding"))
682 return git_config_string(&git_commit_encoding, var, value);
684 if (!strcmp(var, "i18n.logoutputencoding"))
685 return git_config_string(&git_log_output_encoding, var, value);
687 /* Add other config variables here and to Documentation/config.txt. */
688 return 0;
691 static int git_default_branch_config(const char *var, const char *value)
693 if (!strcmp(var, "branch.autosetupmerge")) {
694 if (value && !strcasecmp(value, "always")) {
695 git_branch_track = BRANCH_TRACK_ALWAYS;
696 return 0;
698 git_branch_track = git_config_bool(var, value);
699 return 0;
701 if (!strcmp(var, "branch.autosetuprebase")) {
702 if (!value)
703 return config_error_nonbool(var);
704 else if (!strcmp(value, "never"))
705 autorebase = AUTOREBASE_NEVER;
706 else if (!strcmp(value, "local"))
707 autorebase = AUTOREBASE_LOCAL;
708 else if (!strcmp(value, "remote"))
709 autorebase = AUTOREBASE_REMOTE;
710 else if (!strcmp(value, "always"))
711 autorebase = AUTOREBASE_ALWAYS;
712 else
713 return error("Malformed value for %s", var);
714 return 0;
717 /* Add other config variables here and to Documentation/config.txt. */
718 return 0;
721 static int git_default_push_config(const char *var, const char *value)
723 if (!strcmp(var, "push.default")) {
724 if (!value)
725 return config_error_nonbool(var);
726 else if (!strcmp(value, "nothing"))
727 push_default = PUSH_DEFAULT_NOTHING;
728 else if (!strcmp(value, "matching"))
729 push_default = PUSH_DEFAULT_MATCHING;
730 else if (!strcmp(value, "tracking"))
731 push_default = PUSH_DEFAULT_TRACKING;
732 else if (!strcmp(value, "current"))
733 push_default = PUSH_DEFAULT_CURRENT;
734 else {
735 error("Malformed value for %s: %s", var, value);
736 return error("Must be one of nothing, matching, "
737 "tracking or current.");
739 return 0;
742 /* Add other config variables here and to Documentation/config.txt. */
743 return 0;
746 static int git_default_mailmap_config(const char *var, const char *value)
748 if (!strcmp(var, "mailmap.file"))
749 return git_config_string(&git_mailmap_file, var, value);
751 /* Add other config variables here and to Documentation/config.txt. */
752 return 0;
755 int git_default_config(const char *var, const char *value, void *dummy)
757 if (!prefixcmp(var, "core."))
758 return git_default_core_config(var, value);
760 if (!prefixcmp(var, "user."))
761 return git_default_user_config(var, value);
763 if (!prefixcmp(var, "i18n."))
764 return git_default_i18n_config(var, value);
766 if (!prefixcmp(var, "branch."))
767 return git_default_branch_config(var, value);
769 if (!prefixcmp(var, "push."))
770 return git_default_push_config(var, value);
772 if (!prefixcmp(var, "mailmap."))
773 return git_default_mailmap_config(var, value);
775 if (!prefixcmp(var, "advice."))
776 return git_default_advice_config(var, value);
778 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
779 pager_use_color = git_config_bool(var,value);
780 return 0;
783 /* Add other config variables here and to Documentation/config.txt. */
784 return 0;
787 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
789 int ret;
790 FILE *f = fopen(filename, "r");
792 ret = -1;
793 if (f) {
794 config_file = f;
795 config_file_name = filename;
796 config_linenr = 1;
797 config_file_eof = 0;
798 ret = git_parse_file(fn, data);
799 fclose(f);
800 config_file_name = NULL;
802 return ret;
805 const char *git_etc_gitconfig(void)
807 static const char *system_wide;
808 if (!system_wide)
809 system_wide = system_path(ETC_GITCONFIG);
810 return system_wide;
813 int git_env_bool(const char *k, int def)
815 const char *v = getenv(k);
816 return v ? git_config_bool(k, v) : def;
819 int git_config_system(void)
821 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
824 int git_config_global(void)
826 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
829 int git_config_from_parameters(config_fn_t fn, void *data)
831 static int loaded_environment;
832 const struct config_item *ct;
834 if (!loaded_environment) {
835 if (git_config_parse_environment() < 0)
836 return -1;
837 loaded_environment = 1;
839 for (ct = config_parameters; ct; ct = ct->next)
840 if (fn(ct->name, ct->value, data) < 0)
841 return -1;
842 return 0;
845 int git_config(config_fn_t fn, void *data)
847 int ret = 0, found = 0;
848 char *repo_config = NULL;
849 const char *home = NULL;
851 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
852 if (config_exclusive_filename)
853 return git_config_from_file(fn, config_exclusive_filename, data);
854 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
855 ret += git_config_from_file(fn, git_etc_gitconfig(),
856 data);
857 found += 1;
860 home = getenv("HOME");
861 if (git_config_global() && home) {
862 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
863 if (!access(user_config, R_OK)) {
864 ret += git_config_from_file(fn, user_config, data);
865 found += 1;
867 free(user_config);
870 repo_config = git_pathdup("config");
871 if (!access(repo_config, R_OK)) {
872 ret += git_config_from_file(fn, repo_config, data);
873 found += 1;
875 free(repo_config);
877 ret += git_config_from_parameters(fn, data);
878 if (config_parameters)
879 found += 1;
881 return ret == 0 ? found : ret;
885 * Find all the stuff for git_config_set() below.
888 #define MAX_MATCHES 512
890 static struct {
891 int baselen;
892 char *key;
893 int do_not_match;
894 regex_t *value_regex;
895 int multi_replace;
896 size_t offset[MAX_MATCHES];
897 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
898 int seen;
899 } store;
901 static int matches(const char *key, const char *value)
903 return !strcmp(key, store.key) &&
904 (store.value_regex == NULL ||
905 (store.do_not_match ^
906 !regexec(store.value_regex, value, 0, NULL, 0)));
909 static int store_aux(const char *key, const char *value, void *cb)
911 const char *ep;
912 size_t section_len;
914 switch (store.state) {
915 case KEY_SEEN:
916 if (matches(key, value)) {
917 if (store.seen == 1 && store.multi_replace == 0) {
918 warning("%s has multiple values", key);
919 } else if (store.seen >= MAX_MATCHES) {
920 error("too many matches for %s", key);
921 return 1;
924 store.offset[store.seen] = ftell(config_file);
925 store.seen++;
927 break;
928 case SECTION_SEEN:
930 * What we are looking for is in store.key (both
931 * section and var), and its section part is baselen
932 * long. We found key (again, both section and var).
933 * We would want to know if this key is in the same
934 * section as what we are looking for. We already
935 * know we are in the same section as what should
936 * hold store.key.
938 ep = strrchr(key, '.');
939 section_len = ep - key;
941 if ((section_len != store.baselen) ||
942 memcmp(key, store.key, section_len+1)) {
943 store.state = SECTION_END_SEEN;
944 break;
948 * Do not increment matches: this is no match, but we
949 * just made sure we are in the desired section.
951 store.offset[store.seen] = ftell(config_file);
952 /* fallthru */
953 case SECTION_END_SEEN:
954 case START:
955 if (matches(key, value)) {
956 store.offset[store.seen] = ftell(config_file);
957 store.state = KEY_SEEN;
958 store.seen++;
959 } else {
960 if (strrchr(key, '.') - key == store.baselen &&
961 !strncmp(key, store.key, store.baselen)) {
962 store.state = SECTION_SEEN;
963 store.offset[store.seen] = ftell(config_file);
967 return 0;
970 static int write_error(const char *filename)
972 error("failed to write new configuration file %s", filename);
974 /* Same error code as "failed to rename". */
975 return 4;
978 static int store_write_section(int fd, const char *key)
980 const char *dot;
981 int i, success;
982 struct strbuf sb = STRBUF_INIT;
984 dot = memchr(key, '.', store.baselen);
985 if (dot) {
986 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
987 for (i = dot - key + 1; i < store.baselen; i++) {
988 if (key[i] == '"' || key[i] == '\\')
989 strbuf_addch(&sb, '\\');
990 strbuf_addch(&sb, key[i]);
992 strbuf_addstr(&sb, "\"]\n");
993 } else {
994 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
997 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
998 strbuf_release(&sb);
1000 return success;
1003 static int store_write_pair(int fd, const char *key, const char *value)
1005 int i, success;
1006 int length = strlen(key + store.baselen + 1);
1007 const char *quote = "";
1008 struct strbuf sb = STRBUF_INIT;
1011 * Check to see if the value needs to be surrounded with a dq pair.
1012 * Note that problematic characters are always backslash-quoted; this
1013 * check is about not losing leading or trailing SP and strings that
1014 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1015 * configuration parser.
1017 if (value[0] == ' ')
1018 quote = "\"";
1019 for (i = 0; value[i]; i++)
1020 if (value[i] == ';' || value[i] == '#')
1021 quote = "\"";
1022 if (i && value[i - 1] == ' ')
1023 quote = "\"";
1025 strbuf_addf(&sb, "\t%.*s = %s",
1026 length, key + store.baselen + 1, quote);
1028 for (i = 0; value[i]; i++)
1029 switch (value[i]) {
1030 case '\n':
1031 strbuf_addstr(&sb, "\\n");
1032 break;
1033 case '\t':
1034 strbuf_addstr(&sb, "\\t");
1035 break;
1036 case '"':
1037 case '\\':
1038 strbuf_addch(&sb, '\\');
1039 default:
1040 strbuf_addch(&sb, value[i]);
1041 break;
1043 strbuf_addf(&sb, "%s\n", quote);
1045 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1046 strbuf_release(&sb);
1048 return success;
1051 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1052 size_t offset_, int *found_bracket)
1054 size_t equal_offset = size, bracket_offset = size;
1055 ssize_t offset;
1057 contline:
1058 for (offset = offset_-2; offset > 0
1059 && contents[offset] != '\n'; offset--)
1060 switch (contents[offset]) {
1061 case '=': equal_offset = offset; break;
1062 case ']': bracket_offset = offset; break;
1064 if (offset > 0 && contents[offset-1] == '\\') {
1065 offset_ = offset;
1066 goto contline;
1068 if (bracket_offset < equal_offset) {
1069 *found_bracket = 1;
1070 offset = bracket_offset+1;
1071 } else
1072 offset++;
1074 return offset;
1077 int git_config_set(const char *key, const char *value)
1079 return git_config_set_multivar(key, value, NULL, 0);
1083 * If value==NULL, unset in (remove from) config,
1084 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1085 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1086 * else all matching key/values (regardless how many) are removed,
1087 * before the new pair is written.
1089 * Returns 0 on success.
1091 * This function does this:
1093 * - it locks the config file by creating ".git/config.lock"
1095 * - it then parses the config using store_aux() as validator to find
1096 * the position on the key/value pair to replace. If it is to be unset,
1097 * it must be found exactly once.
1099 * - the config file is mmap()ed and the part before the match (if any) is
1100 * written to the lock file, then the changed part and the rest.
1102 * - the config file is removed and the lock file rename()d to it.
1105 int git_config_set_multivar(const char *key, const char *value,
1106 const char *value_regex, int multi_replace)
1108 int i, dot;
1109 int fd = -1, in_fd;
1110 int ret;
1111 char *config_filename;
1112 struct lock_file *lock = NULL;
1113 const char *last_dot = strrchr(key, '.');
1115 if (config_exclusive_filename)
1116 config_filename = xstrdup(config_exclusive_filename);
1117 else
1118 config_filename = git_pathdup("config");
1121 * Since "key" actually contains the section name and the real
1122 * key name separated by a dot, we have to know where the dot is.
1125 if (last_dot == NULL) {
1126 error("key does not contain a section: %s", key);
1127 ret = 2;
1128 goto out_free;
1130 store.baselen = last_dot - key;
1132 store.multi_replace = multi_replace;
1135 * Validate the key and while at it, lower case it for matching.
1137 store.key = xmalloc(strlen(key) + 1);
1138 dot = 0;
1139 for (i = 0; key[i]; i++) {
1140 unsigned char c = key[i];
1141 if (c == '.')
1142 dot = 1;
1143 /* Leave the extended basename untouched.. */
1144 if (!dot || i > store.baselen) {
1145 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
1146 error("invalid key: %s", key);
1147 free(store.key);
1148 ret = 1;
1149 goto out_free;
1151 c = tolower(c);
1152 } else if (c == '\n') {
1153 error("invalid key (newline): %s", key);
1154 free(store.key);
1155 ret = 1;
1156 goto out_free;
1158 store.key[i] = c;
1160 store.key[i] = 0;
1163 * The lock serves a purpose in addition to locking: the new
1164 * contents of .git/config will be written into it.
1166 lock = xcalloc(sizeof(struct lock_file), 1);
1167 fd = hold_lock_file_for_update(lock, config_filename, 0);
1168 if (fd < 0) {
1169 error("could not lock config file %s: %s", config_filename, strerror(errno));
1170 free(store.key);
1171 ret = -1;
1172 goto out_free;
1176 * If .git/config does not exist yet, write a minimal version.
1178 in_fd = open(config_filename, O_RDONLY);
1179 if ( in_fd < 0 ) {
1180 free(store.key);
1182 if ( ENOENT != errno ) {
1183 error("opening %s: %s", config_filename,
1184 strerror(errno));
1185 ret = 3; /* same as "invalid config file" */
1186 goto out_free;
1188 /* if nothing to unset, error out */
1189 if (value == NULL) {
1190 ret = 5;
1191 goto out_free;
1194 store.key = (char *)key;
1195 if (!store_write_section(fd, key) ||
1196 !store_write_pair(fd, key, value))
1197 goto write_err_out;
1198 } else {
1199 struct stat st;
1200 char *contents;
1201 size_t contents_sz, copy_begin, copy_end;
1202 int i, new_line = 0;
1204 if (value_regex == NULL)
1205 store.value_regex = NULL;
1206 else {
1207 if (value_regex[0] == '!') {
1208 store.do_not_match = 1;
1209 value_regex++;
1210 } else
1211 store.do_not_match = 0;
1213 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1214 if (regcomp(store.value_regex, value_regex,
1215 REG_EXTENDED)) {
1216 error("invalid pattern: %s", value_regex);
1217 free(store.value_regex);
1218 ret = 6;
1219 goto out_free;
1223 store.offset[0] = 0;
1224 store.state = START;
1225 store.seen = 0;
1228 * After this, store.offset will contain the *end* offset
1229 * of the last match, or remain at 0 if no match was found.
1230 * As a side effect, we make sure to transform only a valid
1231 * existing config file.
1233 if (git_config_from_file(store_aux, config_filename, NULL)) {
1234 error("invalid config file %s", config_filename);
1235 free(store.key);
1236 if (store.value_regex != NULL) {
1237 regfree(store.value_regex);
1238 free(store.value_regex);
1240 ret = 3;
1241 goto out_free;
1244 free(store.key);
1245 if (store.value_regex != NULL) {
1246 regfree(store.value_regex);
1247 free(store.value_regex);
1250 /* if nothing to unset, or too many matches, error out */
1251 if ((store.seen == 0 && value == NULL) ||
1252 (store.seen > 1 && multi_replace == 0)) {
1253 ret = 5;
1254 goto out_free;
1257 fstat(in_fd, &st);
1258 contents_sz = xsize_t(st.st_size);
1259 contents = xmmap(NULL, contents_sz, PROT_READ,
1260 MAP_PRIVATE, in_fd, 0);
1261 close(in_fd);
1263 if (store.seen == 0)
1264 store.seen = 1;
1266 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1267 if (store.offset[i] == 0) {
1268 store.offset[i] = copy_end = contents_sz;
1269 } else if (store.state != KEY_SEEN) {
1270 copy_end = store.offset[i];
1271 } else
1272 copy_end = find_beginning_of_line(
1273 contents, contents_sz,
1274 store.offset[i]-2, &new_line);
1276 if (copy_end > 0 && contents[copy_end-1] != '\n')
1277 new_line = 1;
1279 /* write the first part of the config */
1280 if (copy_end > copy_begin) {
1281 if (write_in_full(fd, contents + copy_begin,
1282 copy_end - copy_begin) <
1283 copy_end - copy_begin)
1284 goto write_err_out;
1285 if (new_line &&
1286 write_str_in_full(fd, "\n") != 1)
1287 goto write_err_out;
1289 copy_begin = store.offset[i];
1292 /* write the pair (value == NULL means unset) */
1293 if (value != NULL) {
1294 if (store.state == START) {
1295 if (!store_write_section(fd, key))
1296 goto write_err_out;
1298 if (!store_write_pair(fd, key, value))
1299 goto write_err_out;
1302 /* write the rest of the config */
1303 if (copy_begin < contents_sz)
1304 if (write_in_full(fd, contents + copy_begin,
1305 contents_sz - copy_begin) <
1306 contents_sz - copy_begin)
1307 goto write_err_out;
1309 munmap(contents, contents_sz);
1312 if (commit_lock_file(lock) < 0) {
1313 error("could not commit config file %s", config_filename);
1314 ret = 4;
1315 goto out_free;
1319 * lock is committed, so don't try to roll it back below.
1320 * NOTE: Since lockfile.c keeps a linked list of all created
1321 * lock_file structures, it isn't safe to free(lock). It's
1322 * better to just leave it hanging around.
1324 lock = NULL;
1325 ret = 0;
1327 out_free:
1328 if (lock)
1329 rollback_lock_file(lock);
1330 free(config_filename);
1331 return ret;
1333 write_err_out:
1334 ret = write_error(lock->filename);
1335 goto out_free;
1339 static int section_name_match (const char *buf, const char *name)
1341 int i = 0, j = 0, dot = 0;
1342 if (buf[i] != '[')
1343 return 0;
1344 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1345 if (!dot && isspace(buf[i])) {
1346 dot = 1;
1347 if (name[j++] != '.')
1348 break;
1349 for (i++; isspace(buf[i]); i++)
1350 ; /* do nothing */
1351 if (buf[i] != '"')
1352 break;
1353 continue;
1355 if (buf[i] == '\\' && dot)
1356 i++;
1357 else if (buf[i] == '"' && dot) {
1358 for (i++; isspace(buf[i]); i++)
1359 ; /* do_nothing */
1360 break;
1362 if (buf[i] != name[j++])
1363 break;
1365 if (buf[i] == ']' && name[j] == 0) {
1367 * We match, now just find the right length offset by
1368 * gobbling up any whitespace after it, as well
1370 i++;
1371 for (; buf[i] && isspace(buf[i]); i++)
1372 ; /* do nothing */
1373 return i;
1375 return 0;
1378 /* if new_name == NULL, the section is removed instead */
1379 int git_config_rename_section(const char *old_name, const char *new_name)
1381 int ret = 0, remove = 0;
1382 char *config_filename;
1383 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1384 int out_fd;
1385 char buf[1024];
1387 if (config_exclusive_filename)
1388 config_filename = xstrdup(config_exclusive_filename);
1389 else
1390 config_filename = git_pathdup("config");
1391 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1392 if (out_fd < 0) {
1393 ret = error("could not lock config file %s", config_filename);
1394 goto out;
1397 if (!(config_file = fopen(config_filename, "rb"))) {
1398 /* no config file means nothing to rename, no error */
1399 goto unlock_and_out;
1402 while (fgets(buf, sizeof(buf), config_file)) {
1403 int i;
1404 int length;
1405 char *output = buf;
1406 for (i = 0; buf[i] && isspace(buf[i]); i++)
1407 ; /* do nothing */
1408 if (buf[i] == '[') {
1409 /* it's a section */
1410 int offset = section_name_match(&buf[i], old_name);
1411 if (offset > 0) {
1412 ret++;
1413 if (new_name == NULL) {
1414 remove = 1;
1415 continue;
1417 store.baselen = strlen(new_name);
1418 if (!store_write_section(out_fd, new_name)) {
1419 ret = write_error(lock->filename);
1420 goto out;
1423 * We wrote out the new section, with
1424 * a newline, now skip the old
1425 * section's length
1427 output += offset + i;
1428 if (strlen(output) > 0) {
1430 * More content means there's
1431 * a declaration to put on the
1432 * next line; indent with a
1433 * tab
1435 output -= 1;
1436 output[0] = '\t';
1439 remove = 0;
1441 if (remove)
1442 continue;
1443 length = strlen(output);
1444 if (write_in_full(out_fd, output, length) != length) {
1445 ret = write_error(lock->filename);
1446 goto out;
1449 fclose(config_file);
1450 unlock_and_out:
1451 if (commit_lock_file(lock) < 0)
1452 ret = error("could not commit config file %s", config_filename);
1453 out:
1454 free(config_filename);
1455 return ret;
1459 * Call this to report error for your variable that should not
1460 * get a boolean value (i.e. "[my] var" means "true").
1462 int config_error_nonbool(const char *var)
1464 return error("Missing value for '%s'", var);