Merge branch 'jn/gitweb-time-hires-comes-with-5.8' into next
[git/dscho.git] / config.c
blobd3fa95353388a3b20b1ab523cd3e872a2376214f
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 static int git_config_maybe_bool_text(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_maybe_bool(const char *name, const char *value)
432 int v = git_config_maybe_bool_text(name, value);
433 if (0 <= v)
434 return v;
435 if (!strcmp(value, "0"))
436 return 0;
437 if (!strcmp(value, "1"))
438 return 1;
439 return -1;
442 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
444 int v = git_config_maybe_bool_text(name, value);
445 if (0 <= v) {
446 *is_bool = 1;
447 return v;
449 *is_bool = 0;
450 return git_config_int(name, value);
453 int git_config_bool(const char *name, const char *value)
455 int discard;
456 return !!git_config_bool_or_int(name, value, &discard);
459 int git_config_string(const char **dest, const char *var, const char *value)
461 if (!value)
462 return config_error_nonbool(var);
463 *dest = xstrdup(value);
464 return 0;
467 int git_config_pathname(const char **dest, const char *var, const char *value)
469 if (!value)
470 return config_error_nonbool(var);
471 *dest = expand_user_path(value);
472 if (!*dest)
473 die("Failed to expand user dir in: '%s'", value);
474 return 0;
477 static int git_default_core_config(const char *var, const char *value)
479 /* This needs a better name */
480 if (!strcmp(var, "core.filemode")) {
481 trust_executable_bit = git_config_bool(var, value);
482 return 0;
484 if (!strcmp(var, "core.trustctime")) {
485 trust_ctime = git_config_bool(var, value);
486 return 0;
489 if (!strcmp(var, "core.quotepath")) {
490 quote_path_fully = git_config_bool(var, value);
491 return 0;
494 if (!strcmp(var, "core.symlinks")) {
495 has_symlinks = git_config_bool(var, value);
496 return 0;
499 if (!strcmp(var, "core.ignorecase")) {
500 ignore_case = git_config_bool(var, value);
501 return 0;
504 if (!strcmp(var, "core.bare")) {
505 is_bare_repository_cfg = git_config_bool(var, value);
506 return 0;
509 if (!strcmp(var, "core.ignorestat")) {
510 assume_unchanged = git_config_bool(var, value);
511 return 0;
514 if (!strcmp(var, "core.prefersymlinkrefs")) {
515 prefer_symlink_refs = git_config_bool(var, value);
516 return 0;
519 if (!strcmp(var, "core.logallrefupdates")) {
520 log_all_ref_updates = git_config_bool(var, value);
521 return 0;
524 if (!strcmp(var, "core.warnambiguousrefs")) {
525 warn_ambiguous_refs = git_config_bool(var, value);
526 return 0;
529 if (!strcmp(var, "core.loosecompression")) {
530 int level = git_config_int(var, value);
531 if (level == -1)
532 level = Z_DEFAULT_COMPRESSION;
533 else if (level < 0 || level > Z_BEST_COMPRESSION)
534 die("bad zlib compression level %d", level);
535 zlib_compression_level = level;
536 zlib_compression_seen = 1;
537 return 0;
540 if (!strcmp(var, "core.compression")) {
541 int level = git_config_int(var, value);
542 if (level == -1)
543 level = Z_DEFAULT_COMPRESSION;
544 else if (level < 0 || level > Z_BEST_COMPRESSION)
545 die("bad zlib compression level %d", level);
546 core_compression_level = level;
547 core_compression_seen = 1;
548 if (!zlib_compression_seen)
549 zlib_compression_level = level;
550 return 0;
553 if (!strcmp(var, "core.packedgitwindowsize")) {
554 int pgsz_x2 = getpagesize() * 2;
555 packed_git_window_size = git_config_int(var, value);
557 /* This value must be multiple of (pagesize * 2) */
558 packed_git_window_size /= pgsz_x2;
559 if (packed_git_window_size < 1)
560 packed_git_window_size = 1;
561 packed_git_window_size *= pgsz_x2;
562 return 0;
565 if (!strcmp(var, "core.packedgitlimit")) {
566 packed_git_limit = git_config_int(var, value);
567 return 0;
570 if (!strcmp(var, "core.deltabasecachelimit")) {
571 delta_base_cache_limit = git_config_int(var, value);
572 return 0;
575 if (!strcmp(var, "core.autocrlf")) {
576 if (value && !strcasecmp(value, "input")) {
577 if (eol == EOL_CRLF)
578 return error("core.autocrlf=input conflicts with core.eol=crlf");
579 auto_crlf = AUTO_CRLF_INPUT;
580 return 0;
582 auto_crlf = git_config_bool(var, value);
583 return 0;
586 if (!strcmp(var, "core.safecrlf")) {
587 if (value && !strcasecmp(value, "warn")) {
588 safe_crlf = SAFE_CRLF_WARN;
589 return 0;
591 safe_crlf = git_config_bool(var, value);
592 return 0;
595 if (!strcmp(var, "core.eol")) {
596 if (value && !strcasecmp(value, "lf"))
597 eol = EOL_LF;
598 else if (value && !strcasecmp(value, "crlf"))
599 eol = EOL_CRLF;
600 else if (value && !strcasecmp(value, "native"))
601 eol = EOL_NATIVE;
602 else
603 eol = EOL_UNSET;
604 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
605 return error("core.autocrlf=input conflicts with core.eol=crlf");
606 return 0;
609 if (!strcmp(var, "core.notesref")) {
610 notes_ref_name = xstrdup(value);
611 return 0;
614 if (!strcmp(var, "core.pager"))
615 return git_config_string(&pager_program, var, value);
617 if (!strcmp(var, "core.editor"))
618 return git_config_string(&editor_program, var, value);
620 if (!strcmp(var, "core.askpass"))
621 return git_config_string(&askpass_program, var, value);
623 if (!strcmp(var, "core.excludesfile"))
624 return git_config_pathname(&excludes_file, var, value);
626 if (!strcmp(var, "core.whitespace")) {
627 if (!value)
628 return config_error_nonbool(var);
629 whitespace_rule_cfg = parse_whitespace_rule(value);
630 return 0;
633 if (!strcmp(var, "core.fsyncobjectfiles")) {
634 fsync_object_files = git_config_bool(var, value);
635 return 0;
638 if (!strcmp(var, "core.preloadindex")) {
639 core_preload_index = git_config_bool(var, value);
640 return 0;
643 if (!strcmp(var, "core.createobject")) {
644 if (!strcmp(value, "rename"))
645 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
646 else if (!strcmp(value, "link"))
647 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
648 else
649 die("Invalid mode for object creation: %s", value);
650 return 0;
653 if (!strcmp(var, "core.sparsecheckout")) {
654 core_apply_sparse_checkout = git_config_bool(var, value);
655 return 0;
658 /* Add other config variables here and to Documentation/config.txt. */
659 return 0;
662 static int git_default_user_config(const char *var, const char *value)
664 if (!strcmp(var, "user.name")) {
665 if (!value)
666 return config_error_nonbool(var);
667 strlcpy(git_default_name, value, sizeof(git_default_name));
668 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
669 return 0;
672 if (!strcmp(var, "user.email")) {
673 if (!value)
674 return config_error_nonbool(var);
675 strlcpy(git_default_email, value, sizeof(git_default_email));
676 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
677 return 0;
680 /* Add other config variables here and to Documentation/config.txt. */
681 return 0;
684 static int git_default_i18n_config(const char *var, const char *value)
686 if (!strcmp(var, "i18n.commitencoding"))
687 return git_config_string(&git_commit_encoding, var, value);
689 if (!strcmp(var, "i18n.logoutputencoding"))
690 return git_config_string(&git_log_output_encoding, var, value);
692 /* Add other config variables here and to Documentation/config.txt. */
693 return 0;
696 static int git_default_branch_config(const char *var, const char *value)
698 if (!strcmp(var, "branch.autosetupmerge")) {
699 if (value && !strcasecmp(value, "always")) {
700 git_branch_track = BRANCH_TRACK_ALWAYS;
701 return 0;
703 git_branch_track = git_config_bool(var, value);
704 return 0;
706 if (!strcmp(var, "branch.autosetuprebase")) {
707 if (!value)
708 return config_error_nonbool(var);
709 else if (!strcmp(value, "never"))
710 autorebase = AUTOREBASE_NEVER;
711 else if (!strcmp(value, "local"))
712 autorebase = AUTOREBASE_LOCAL;
713 else if (!strcmp(value, "remote"))
714 autorebase = AUTOREBASE_REMOTE;
715 else if (!strcmp(value, "always"))
716 autorebase = AUTOREBASE_ALWAYS;
717 else
718 return error("Malformed value for %s", var);
719 return 0;
722 /* Add other config variables here and to Documentation/config.txt. */
723 return 0;
726 static int git_default_push_config(const char *var, const char *value)
728 if (!strcmp(var, "push.default")) {
729 if (!value)
730 return config_error_nonbool(var);
731 else if (!strcmp(value, "nothing"))
732 push_default = PUSH_DEFAULT_NOTHING;
733 else if (!strcmp(value, "matching"))
734 push_default = PUSH_DEFAULT_MATCHING;
735 else if (!strcmp(value, "tracking"))
736 push_default = PUSH_DEFAULT_TRACKING;
737 else if (!strcmp(value, "current"))
738 push_default = PUSH_DEFAULT_CURRENT;
739 else {
740 error("Malformed value for %s: %s", var, value);
741 return error("Must be one of nothing, matching, "
742 "tracking or current.");
744 return 0;
747 /* Add other config variables here and to Documentation/config.txt. */
748 return 0;
751 static int git_default_mailmap_config(const char *var, const char *value)
753 if (!strcmp(var, "mailmap.file"))
754 return git_config_string(&git_mailmap_file, var, value);
756 /* Add other config variables here and to Documentation/config.txt. */
757 return 0;
760 int git_default_config(const char *var, const char *value, void *dummy)
762 if (!prefixcmp(var, "core."))
763 return git_default_core_config(var, value);
765 if (!prefixcmp(var, "user."))
766 return git_default_user_config(var, value);
768 if (!prefixcmp(var, "i18n."))
769 return git_default_i18n_config(var, value);
771 if (!prefixcmp(var, "branch."))
772 return git_default_branch_config(var, value);
774 if (!prefixcmp(var, "push."))
775 return git_default_push_config(var, value);
777 if (!prefixcmp(var, "mailmap."))
778 return git_default_mailmap_config(var, value);
780 if (!prefixcmp(var, "advice."))
781 return git_default_advice_config(var, value);
783 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
784 pager_use_color = git_config_bool(var,value);
785 return 0;
788 /* Add other config variables here and to Documentation/config.txt. */
789 return 0;
792 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
794 int ret;
795 FILE *f = fopen(filename, "r");
797 ret = -1;
798 if (f) {
799 config_file = f;
800 config_file_name = filename;
801 config_linenr = 1;
802 config_file_eof = 0;
803 ret = git_parse_file(fn, data);
804 fclose(f);
805 config_file_name = NULL;
807 return ret;
810 const char *git_etc_gitconfig(void)
812 static const char *system_wide;
813 if (!system_wide)
814 system_wide = system_path(ETC_GITCONFIG);
815 return system_wide;
818 int git_env_bool(const char *k, int def)
820 const char *v = getenv(k);
821 return v ? git_config_bool(k, v) : def;
824 int git_config_system(void)
826 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
829 int git_config_global(void)
831 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
834 int git_config_from_parameters(config_fn_t fn, void *data)
836 static int loaded_environment;
837 const struct config_item *ct;
839 if (!loaded_environment) {
840 if (git_config_parse_environment() < 0)
841 return -1;
842 loaded_environment = 1;
844 for (ct = config_parameters; ct; ct = ct->next)
845 if (fn(ct->name, ct->value, data) < 0)
846 return -1;
847 return 0;
850 int git_config(config_fn_t fn, void *data)
852 int ret = 0, found = 0;
853 char *repo_config = NULL;
854 const char *home = NULL;
856 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
857 if (config_exclusive_filename)
858 return git_config_from_file(fn, config_exclusive_filename, data);
859 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
860 ret += git_config_from_file(fn, git_etc_gitconfig(),
861 data);
862 found += 1;
865 home = getenv("HOME");
866 if (git_config_global() && home) {
867 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
868 if (!access(user_config, R_OK)) {
869 ret += git_config_from_file(fn, user_config, data);
870 found += 1;
872 free(user_config);
875 repo_config = git_pathdup("config");
876 if (!access(repo_config, R_OK)) {
877 ret += git_config_from_file(fn, repo_config, data);
878 found += 1;
880 free(repo_config);
882 ret += git_config_from_parameters(fn, data);
883 if (config_parameters)
884 found += 1;
886 return ret == 0 ? found : ret;
890 * Find all the stuff for git_config_set() below.
893 #define MAX_MATCHES 512
895 static struct {
896 int baselen;
897 char *key;
898 int do_not_match;
899 regex_t *value_regex;
900 int multi_replace;
901 size_t offset[MAX_MATCHES];
902 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
903 int seen;
904 } store;
906 static int matches(const char *key, const char *value)
908 return !strcmp(key, store.key) &&
909 (store.value_regex == NULL ||
910 (store.do_not_match ^
911 !regexec(store.value_regex, value, 0, NULL, 0)));
914 static int store_aux(const char *key, const char *value, void *cb)
916 const char *ep;
917 size_t section_len;
919 switch (store.state) {
920 case KEY_SEEN:
921 if (matches(key, value)) {
922 if (store.seen == 1 && store.multi_replace == 0) {
923 warning("%s has multiple values", key);
924 } else if (store.seen >= MAX_MATCHES) {
925 error("too many matches for %s", key);
926 return 1;
929 store.offset[store.seen] = ftell(config_file);
930 store.seen++;
932 break;
933 case SECTION_SEEN:
935 * What we are looking for is in store.key (both
936 * section and var), and its section part is baselen
937 * long. We found key (again, both section and var).
938 * We would want to know if this key is in the same
939 * section as what we are looking for. We already
940 * know we are in the same section as what should
941 * hold store.key.
943 ep = strrchr(key, '.');
944 section_len = ep - key;
946 if ((section_len != store.baselen) ||
947 memcmp(key, store.key, section_len+1)) {
948 store.state = SECTION_END_SEEN;
949 break;
953 * Do not increment matches: this is no match, but we
954 * just made sure we are in the desired section.
956 store.offset[store.seen] = ftell(config_file);
957 /* fallthru */
958 case SECTION_END_SEEN:
959 case START:
960 if (matches(key, value)) {
961 store.offset[store.seen] = ftell(config_file);
962 store.state = KEY_SEEN;
963 store.seen++;
964 } else {
965 if (strrchr(key, '.') - key == store.baselen &&
966 !strncmp(key, store.key, store.baselen)) {
967 store.state = SECTION_SEEN;
968 store.offset[store.seen] = ftell(config_file);
972 return 0;
975 static int write_error(const char *filename)
977 error("failed to write new configuration file %s", filename);
979 /* Same error code as "failed to rename". */
980 return 4;
983 static int store_write_section(int fd, const char *key)
985 const char *dot;
986 int i, success;
987 struct strbuf sb = STRBUF_INIT;
989 dot = memchr(key, '.', store.baselen);
990 if (dot) {
991 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
992 for (i = dot - key + 1; i < store.baselen; i++) {
993 if (key[i] == '"' || key[i] == '\\')
994 strbuf_addch(&sb, '\\');
995 strbuf_addch(&sb, key[i]);
997 strbuf_addstr(&sb, "\"]\n");
998 } else {
999 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1002 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1003 strbuf_release(&sb);
1005 return success;
1008 static int store_write_pair(int fd, const char *key, const char *value)
1010 int i, success;
1011 int length = strlen(key + store.baselen + 1);
1012 const char *quote = "";
1013 struct strbuf sb = STRBUF_INIT;
1016 * Check to see if the value needs to be surrounded with a dq pair.
1017 * Note that problematic characters are always backslash-quoted; this
1018 * check is about not losing leading or trailing SP and strings that
1019 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1020 * configuration parser.
1022 if (value[0] == ' ')
1023 quote = "\"";
1024 for (i = 0; value[i]; i++)
1025 if (value[i] == ';' || value[i] == '#')
1026 quote = "\"";
1027 if (i && value[i - 1] == ' ')
1028 quote = "\"";
1030 strbuf_addf(&sb, "\t%.*s = %s",
1031 length, key + store.baselen + 1, quote);
1033 for (i = 0; value[i]; i++)
1034 switch (value[i]) {
1035 case '\n':
1036 strbuf_addstr(&sb, "\\n");
1037 break;
1038 case '\t':
1039 strbuf_addstr(&sb, "\\t");
1040 break;
1041 case '"':
1042 case '\\':
1043 strbuf_addch(&sb, '\\');
1044 default:
1045 strbuf_addch(&sb, value[i]);
1046 break;
1048 strbuf_addf(&sb, "%s\n", quote);
1050 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1051 strbuf_release(&sb);
1053 return success;
1056 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1057 size_t offset_, int *found_bracket)
1059 size_t equal_offset = size, bracket_offset = size;
1060 ssize_t offset;
1062 contline:
1063 for (offset = offset_-2; offset > 0
1064 && contents[offset] != '\n'; offset--)
1065 switch (contents[offset]) {
1066 case '=': equal_offset = offset; break;
1067 case ']': bracket_offset = offset; break;
1069 if (offset > 0 && contents[offset-1] == '\\') {
1070 offset_ = offset;
1071 goto contline;
1073 if (bracket_offset < equal_offset) {
1074 *found_bracket = 1;
1075 offset = bracket_offset+1;
1076 } else
1077 offset++;
1079 return offset;
1082 int git_config_set(const char *key, const char *value)
1084 return git_config_set_multivar(key, value, NULL, 0);
1088 * If value==NULL, unset in (remove from) config,
1089 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1090 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1091 * else all matching key/values (regardless how many) are removed,
1092 * before the new pair is written.
1094 * Returns 0 on success.
1096 * This function does this:
1098 * - it locks the config file by creating ".git/config.lock"
1100 * - it then parses the config using store_aux() as validator to find
1101 * the position on the key/value pair to replace. If it is to be unset,
1102 * it must be found exactly once.
1104 * - the config file is mmap()ed and the part before the match (if any) is
1105 * written to the lock file, then the changed part and the rest.
1107 * - the config file is removed and the lock file rename()d to it.
1110 int git_config_set_multivar(const char *key, const char *value,
1111 const char *value_regex, int multi_replace)
1113 int i, dot;
1114 int fd = -1, in_fd;
1115 int ret;
1116 char *config_filename;
1117 struct lock_file *lock = NULL;
1118 const char *last_dot = strrchr(key, '.');
1120 if (config_exclusive_filename)
1121 config_filename = xstrdup(config_exclusive_filename);
1122 else
1123 config_filename = git_pathdup("config");
1126 * Since "key" actually contains the section name and the real
1127 * key name separated by a dot, we have to know where the dot is.
1130 if (last_dot == NULL) {
1131 error("key does not contain a section: %s", key);
1132 ret = 2;
1133 goto out_free;
1135 store.baselen = last_dot - key;
1137 store.multi_replace = multi_replace;
1140 * Validate the key and while at it, lower case it for matching.
1142 store.key = xmalloc(strlen(key) + 1);
1143 dot = 0;
1144 for (i = 0; key[i]; i++) {
1145 unsigned char c = key[i];
1146 if (c == '.')
1147 dot = 1;
1148 /* Leave the extended basename untouched.. */
1149 if (!dot || i > store.baselen) {
1150 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
1151 error("invalid key: %s", key);
1152 free(store.key);
1153 ret = 1;
1154 goto out_free;
1156 c = tolower(c);
1157 } else if (c == '\n') {
1158 error("invalid key (newline): %s", key);
1159 free(store.key);
1160 ret = 1;
1161 goto out_free;
1163 store.key[i] = c;
1165 store.key[i] = 0;
1168 * The lock serves a purpose in addition to locking: the new
1169 * contents of .git/config will be written into it.
1171 lock = xcalloc(sizeof(struct lock_file), 1);
1172 fd = hold_lock_file_for_update(lock, config_filename, 0);
1173 if (fd < 0) {
1174 error("could not lock config file %s: %s", config_filename, strerror(errno));
1175 free(store.key);
1176 ret = -1;
1177 goto out_free;
1181 * If .git/config does not exist yet, write a minimal version.
1183 in_fd = open(config_filename, O_RDONLY);
1184 if ( in_fd < 0 ) {
1185 free(store.key);
1187 if ( ENOENT != errno ) {
1188 error("opening %s: %s", config_filename,
1189 strerror(errno));
1190 ret = 3; /* same as "invalid config file" */
1191 goto out_free;
1193 /* if nothing to unset, error out */
1194 if (value == NULL) {
1195 ret = 5;
1196 goto out_free;
1199 store.key = (char *)key;
1200 if (!store_write_section(fd, key) ||
1201 !store_write_pair(fd, key, value))
1202 goto write_err_out;
1203 } else {
1204 struct stat st;
1205 char *contents;
1206 size_t contents_sz, copy_begin, copy_end;
1207 int i, new_line = 0;
1209 if (value_regex == NULL)
1210 store.value_regex = NULL;
1211 else {
1212 if (value_regex[0] == '!') {
1213 store.do_not_match = 1;
1214 value_regex++;
1215 } else
1216 store.do_not_match = 0;
1218 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1219 if (regcomp(store.value_regex, value_regex,
1220 REG_EXTENDED)) {
1221 error("invalid pattern: %s", value_regex);
1222 free(store.value_regex);
1223 ret = 6;
1224 goto out_free;
1228 store.offset[0] = 0;
1229 store.state = START;
1230 store.seen = 0;
1233 * After this, store.offset will contain the *end* offset
1234 * of the last match, or remain at 0 if no match was found.
1235 * As a side effect, we make sure to transform only a valid
1236 * existing config file.
1238 if (git_config_from_file(store_aux, config_filename, NULL)) {
1239 error("invalid config file %s", config_filename);
1240 free(store.key);
1241 if (store.value_regex != NULL) {
1242 regfree(store.value_regex);
1243 free(store.value_regex);
1245 ret = 3;
1246 goto out_free;
1249 free(store.key);
1250 if (store.value_regex != NULL) {
1251 regfree(store.value_regex);
1252 free(store.value_regex);
1255 /* if nothing to unset, or too many matches, error out */
1256 if ((store.seen == 0 && value == NULL) ||
1257 (store.seen > 1 && multi_replace == 0)) {
1258 ret = 5;
1259 goto out_free;
1262 fstat(in_fd, &st);
1263 contents_sz = xsize_t(st.st_size);
1264 contents = xmmap(NULL, contents_sz, PROT_READ,
1265 MAP_PRIVATE, in_fd, 0);
1266 close(in_fd);
1268 if (store.seen == 0)
1269 store.seen = 1;
1271 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1272 if (store.offset[i] == 0) {
1273 store.offset[i] = copy_end = contents_sz;
1274 } else if (store.state != KEY_SEEN) {
1275 copy_end = store.offset[i];
1276 } else
1277 copy_end = find_beginning_of_line(
1278 contents, contents_sz,
1279 store.offset[i]-2, &new_line);
1281 if (copy_end > 0 && contents[copy_end-1] != '\n')
1282 new_line = 1;
1284 /* write the first part of the config */
1285 if (copy_end > copy_begin) {
1286 if (write_in_full(fd, contents + copy_begin,
1287 copy_end - copy_begin) <
1288 copy_end - copy_begin)
1289 goto write_err_out;
1290 if (new_line &&
1291 write_str_in_full(fd, "\n") != 1)
1292 goto write_err_out;
1294 copy_begin = store.offset[i];
1297 /* write the pair (value == NULL means unset) */
1298 if (value != NULL) {
1299 if (store.state == START) {
1300 if (!store_write_section(fd, key))
1301 goto write_err_out;
1303 if (!store_write_pair(fd, key, value))
1304 goto write_err_out;
1307 /* write the rest of the config */
1308 if (copy_begin < contents_sz)
1309 if (write_in_full(fd, contents + copy_begin,
1310 contents_sz - copy_begin) <
1311 contents_sz - copy_begin)
1312 goto write_err_out;
1314 munmap(contents, contents_sz);
1317 if (commit_lock_file(lock) < 0) {
1318 error("could not commit config file %s", config_filename);
1319 ret = 4;
1320 goto out_free;
1324 * lock is committed, so don't try to roll it back below.
1325 * NOTE: Since lockfile.c keeps a linked list of all created
1326 * lock_file structures, it isn't safe to free(lock). It's
1327 * better to just leave it hanging around.
1329 lock = NULL;
1330 ret = 0;
1332 out_free:
1333 if (lock)
1334 rollback_lock_file(lock);
1335 free(config_filename);
1336 return ret;
1338 write_err_out:
1339 ret = write_error(lock->filename);
1340 goto out_free;
1344 static int section_name_match (const char *buf, const char *name)
1346 int i = 0, j = 0, dot = 0;
1347 if (buf[i] != '[')
1348 return 0;
1349 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1350 if (!dot && isspace(buf[i])) {
1351 dot = 1;
1352 if (name[j++] != '.')
1353 break;
1354 for (i++; isspace(buf[i]); i++)
1355 ; /* do nothing */
1356 if (buf[i] != '"')
1357 break;
1358 continue;
1360 if (buf[i] == '\\' && dot)
1361 i++;
1362 else if (buf[i] == '"' && dot) {
1363 for (i++; isspace(buf[i]); i++)
1364 ; /* do_nothing */
1365 break;
1367 if (buf[i] != name[j++])
1368 break;
1370 if (buf[i] == ']' && name[j] == 0) {
1372 * We match, now just find the right length offset by
1373 * gobbling up any whitespace after it, as well
1375 i++;
1376 for (; buf[i] && isspace(buf[i]); i++)
1377 ; /* do nothing */
1378 return i;
1380 return 0;
1383 /* if new_name == NULL, the section is removed instead */
1384 int git_config_rename_section(const char *old_name, const char *new_name)
1386 int ret = 0, remove = 0;
1387 char *config_filename;
1388 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1389 int out_fd;
1390 char buf[1024];
1392 if (config_exclusive_filename)
1393 config_filename = xstrdup(config_exclusive_filename);
1394 else
1395 config_filename = git_pathdup("config");
1396 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1397 if (out_fd < 0) {
1398 ret = error("could not lock config file %s", config_filename);
1399 goto out;
1402 if (!(config_file = fopen(config_filename, "rb"))) {
1403 /* no config file means nothing to rename, no error */
1404 goto unlock_and_out;
1407 while (fgets(buf, sizeof(buf), config_file)) {
1408 int i;
1409 int length;
1410 char *output = buf;
1411 for (i = 0; buf[i] && isspace(buf[i]); i++)
1412 ; /* do nothing */
1413 if (buf[i] == '[') {
1414 /* it's a section */
1415 int offset = section_name_match(&buf[i], old_name);
1416 if (offset > 0) {
1417 ret++;
1418 if (new_name == NULL) {
1419 remove = 1;
1420 continue;
1422 store.baselen = strlen(new_name);
1423 if (!store_write_section(out_fd, new_name)) {
1424 ret = write_error(lock->filename);
1425 goto out;
1428 * We wrote out the new section, with
1429 * a newline, now skip the old
1430 * section's length
1432 output += offset + i;
1433 if (strlen(output) > 0) {
1435 * More content means there's
1436 * a declaration to put on the
1437 * next line; indent with a
1438 * tab
1440 output -= 1;
1441 output[0] = '\t';
1444 remove = 0;
1446 if (remove)
1447 continue;
1448 length = strlen(output);
1449 if (write_in_full(out_fd, output, length) != length) {
1450 ret = write_error(lock->filename);
1451 goto out;
1454 fclose(config_file);
1455 unlock_and_out:
1456 if (commit_lock_file(lock) < 0)
1457 ret = error("could not commit config file %s", config_filename);
1458 out:
1459 free(config_filename);
1460 return ret;
1464 * Call this to report error for your variable that should not
1465 * get a boolean value (i.e. "[my] var" means "true").
1467 int config_error_nonbool(const char *var)
1469 return error("Missing value for '%s'", var);