Documentation updates for 'GIT_WORK_TREE without GIT_DIR' historical usecase
[git/jnareb-git/bp-gitweb.git] / config.c
blob625e0518767712583f917762634c2fc852c4d2eb
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 long v = git_config_maybe_bool_text(name, value);
433 if (0 <= v)
434 return v;
435 if (git_parse_long(value, &v))
436 return !!v;
437 return -1;
440 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
442 int v = git_config_maybe_bool_text(name, value);
443 if (0 <= v) {
444 *is_bool = 1;
445 return v;
447 *is_bool = 0;
448 return git_config_int(name, value);
451 int git_config_bool(const char *name, const char *value)
453 int discard;
454 return !!git_config_bool_or_int(name, value, &discard);
457 int git_config_string(const char **dest, const char *var, const char *value)
459 if (!value)
460 return config_error_nonbool(var);
461 *dest = xstrdup(value);
462 return 0;
465 int git_config_pathname(const char **dest, const char *var, const char *value)
467 if (!value)
468 return config_error_nonbool(var);
469 *dest = expand_user_path(value);
470 if (!*dest)
471 die("Failed to expand user dir in: '%s'", value);
472 return 0;
475 static int git_default_core_config(const char *var, const char *value)
477 /* This needs a better name */
478 if (!strcmp(var, "core.filemode")) {
479 trust_executable_bit = git_config_bool(var, value);
480 return 0;
482 if (!strcmp(var, "core.trustctime")) {
483 trust_ctime = git_config_bool(var, value);
484 return 0;
487 if (!strcmp(var, "core.quotepath")) {
488 quote_path_fully = git_config_bool(var, value);
489 return 0;
492 if (!strcmp(var, "core.symlinks")) {
493 has_symlinks = git_config_bool(var, value);
494 return 0;
497 if (!strcmp(var, "core.ignorecase")) {
498 ignore_case = git_config_bool(var, value);
499 return 0;
502 if (!strcmp(var, "core.abbrevguard")) {
503 unique_abbrev_extra_length = git_config_int(var, value);
504 if (unique_abbrev_extra_length < 0)
505 unique_abbrev_extra_length = 0;
506 return 0;
509 if (!strcmp(var, "core.bare")) {
510 is_bare_repository_cfg = git_config_bool(var, value);
511 return 0;
514 if (!strcmp(var, "core.ignorestat")) {
515 assume_unchanged = git_config_bool(var, value);
516 return 0;
519 if (!strcmp(var, "core.prefersymlinkrefs")) {
520 prefer_symlink_refs = git_config_bool(var, value);
521 return 0;
524 if (!strcmp(var, "core.logallrefupdates")) {
525 log_all_ref_updates = git_config_bool(var, value);
526 return 0;
529 if (!strcmp(var, "core.warnambiguousrefs")) {
530 warn_ambiguous_refs = git_config_bool(var, value);
531 return 0;
534 if (!strcmp(var, "core.loosecompression")) {
535 int level = git_config_int(var, value);
536 if (level == -1)
537 level = Z_DEFAULT_COMPRESSION;
538 else if (level < 0 || level > Z_BEST_COMPRESSION)
539 die("bad zlib compression level %d", level);
540 zlib_compression_level = level;
541 zlib_compression_seen = 1;
542 return 0;
545 if (!strcmp(var, "core.compression")) {
546 int level = git_config_int(var, value);
547 if (level == -1)
548 level = Z_DEFAULT_COMPRESSION;
549 else if (level < 0 || level > Z_BEST_COMPRESSION)
550 die("bad zlib compression level %d", level);
551 core_compression_level = level;
552 core_compression_seen = 1;
553 if (!zlib_compression_seen)
554 zlib_compression_level = level;
555 return 0;
558 if (!strcmp(var, "core.packedgitwindowsize")) {
559 int pgsz_x2 = getpagesize() * 2;
560 packed_git_window_size = git_config_int(var, value);
562 /* This value must be multiple of (pagesize * 2) */
563 packed_git_window_size /= pgsz_x2;
564 if (packed_git_window_size < 1)
565 packed_git_window_size = 1;
566 packed_git_window_size *= pgsz_x2;
567 return 0;
570 if (!strcmp(var, "core.packedgitlimit")) {
571 packed_git_limit = git_config_int(var, value);
572 return 0;
575 if (!strcmp(var, "core.deltabasecachelimit")) {
576 delta_base_cache_limit = git_config_int(var, value);
577 return 0;
580 if (!strcmp(var, "core.autocrlf")) {
581 if (value && !strcasecmp(value, "input")) {
582 if (eol == EOL_CRLF)
583 return error("core.autocrlf=input conflicts with core.eol=crlf");
584 auto_crlf = AUTO_CRLF_INPUT;
585 return 0;
587 auto_crlf = git_config_bool(var, value);
588 return 0;
591 if (!strcmp(var, "core.safecrlf")) {
592 if (value && !strcasecmp(value, "warn")) {
593 safe_crlf = SAFE_CRLF_WARN;
594 return 0;
596 safe_crlf = git_config_bool(var, value);
597 return 0;
600 if (!strcmp(var, "core.eol")) {
601 if (value && !strcasecmp(value, "lf"))
602 eol = EOL_LF;
603 else if (value && !strcasecmp(value, "crlf"))
604 eol = EOL_CRLF;
605 else if (value && !strcasecmp(value, "native"))
606 eol = EOL_NATIVE;
607 else
608 eol = EOL_UNSET;
609 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
610 return error("core.autocrlf=input conflicts with core.eol=crlf");
611 return 0;
614 if (!strcmp(var, "core.notesref")) {
615 notes_ref_name = xstrdup(value);
616 return 0;
619 if (!strcmp(var, "core.pager"))
620 return git_config_string(&pager_program, var, value);
622 if (!strcmp(var, "core.editor"))
623 return git_config_string(&editor_program, var, value);
625 if (!strcmp(var, "core.askpass"))
626 return git_config_string(&askpass_program, var, value);
628 if (!strcmp(var, "core.excludesfile"))
629 return git_config_pathname(&excludes_file, var, value);
631 if (!strcmp(var, "core.whitespace")) {
632 if (!value)
633 return config_error_nonbool(var);
634 whitespace_rule_cfg = parse_whitespace_rule(value);
635 return 0;
638 if (!strcmp(var, "core.fsyncobjectfiles")) {
639 fsync_object_files = git_config_bool(var, value);
640 return 0;
643 if (!strcmp(var, "core.preloadindex")) {
644 core_preload_index = git_config_bool(var, value);
645 return 0;
648 if (!strcmp(var, "core.createobject")) {
649 if (!strcmp(value, "rename"))
650 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
651 else if (!strcmp(value, "link"))
652 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
653 else
654 die("Invalid mode for object creation: %s", value);
655 return 0;
658 if (!strcmp(var, "core.sparsecheckout")) {
659 core_apply_sparse_checkout = git_config_bool(var, value);
660 return 0;
663 /* Add other config variables here and to Documentation/config.txt. */
664 return 0;
667 static int git_default_user_config(const char *var, const char *value)
669 if (!strcmp(var, "user.name")) {
670 if (!value)
671 return config_error_nonbool(var);
672 strlcpy(git_default_name, value, sizeof(git_default_name));
673 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
674 return 0;
677 if (!strcmp(var, "user.email")) {
678 if (!value)
679 return config_error_nonbool(var);
680 strlcpy(git_default_email, value, sizeof(git_default_email));
681 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
682 return 0;
685 /* Add other config variables here and to Documentation/config.txt. */
686 return 0;
689 static int git_default_i18n_config(const char *var, const char *value)
691 if (!strcmp(var, "i18n.commitencoding"))
692 return git_config_string(&git_commit_encoding, var, value);
694 if (!strcmp(var, "i18n.logoutputencoding"))
695 return git_config_string(&git_log_output_encoding, var, value);
697 /* Add other config variables here and to Documentation/config.txt. */
698 return 0;
701 static int git_default_branch_config(const char *var, const char *value)
703 if (!strcmp(var, "branch.autosetupmerge")) {
704 if (value && !strcasecmp(value, "always")) {
705 git_branch_track = BRANCH_TRACK_ALWAYS;
706 return 0;
708 git_branch_track = git_config_bool(var, value);
709 return 0;
711 if (!strcmp(var, "branch.autosetuprebase")) {
712 if (!value)
713 return config_error_nonbool(var);
714 else if (!strcmp(value, "never"))
715 autorebase = AUTOREBASE_NEVER;
716 else if (!strcmp(value, "local"))
717 autorebase = AUTOREBASE_LOCAL;
718 else if (!strcmp(value, "remote"))
719 autorebase = AUTOREBASE_REMOTE;
720 else if (!strcmp(value, "always"))
721 autorebase = AUTOREBASE_ALWAYS;
722 else
723 return error("Malformed value for %s", var);
724 return 0;
727 /* Add other config variables here and to Documentation/config.txt. */
728 return 0;
731 static int git_default_push_config(const char *var, const char *value)
733 if (!strcmp(var, "push.default")) {
734 if (!value)
735 return config_error_nonbool(var);
736 else if (!strcmp(value, "nothing"))
737 push_default = PUSH_DEFAULT_NOTHING;
738 else if (!strcmp(value, "matching"))
739 push_default = PUSH_DEFAULT_MATCHING;
740 else if (!strcmp(value, "tracking"))
741 push_default = PUSH_DEFAULT_TRACKING;
742 else if (!strcmp(value, "current"))
743 push_default = PUSH_DEFAULT_CURRENT;
744 else {
745 error("Malformed value for %s: %s", var, value);
746 return error("Must be one of nothing, matching, "
747 "tracking or current.");
749 return 0;
752 /* Add other config variables here and to Documentation/config.txt. */
753 return 0;
756 static int git_default_mailmap_config(const char *var, const char *value)
758 if (!strcmp(var, "mailmap.file"))
759 return git_config_string(&git_mailmap_file, var, value);
761 /* Add other config variables here and to Documentation/config.txt. */
762 return 0;
765 int git_default_config(const char *var, const char *value, void *dummy)
767 if (!prefixcmp(var, "core."))
768 return git_default_core_config(var, value);
770 if (!prefixcmp(var, "user."))
771 return git_default_user_config(var, value);
773 if (!prefixcmp(var, "i18n."))
774 return git_default_i18n_config(var, value);
776 if (!prefixcmp(var, "branch."))
777 return git_default_branch_config(var, value);
779 if (!prefixcmp(var, "push."))
780 return git_default_push_config(var, value);
782 if (!prefixcmp(var, "mailmap."))
783 return git_default_mailmap_config(var, value);
785 if (!prefixcmp(var, "advice."))
786 return git_default_advice_config(var, value);
788 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
789 pager_use_color = git_config_bool(var,value);
790 return 0;
793 /* Add other config variables here and to Documentation/config.txt. */
794 return 0;
797 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
799 int ret;
800 FILE *f = fopen(filename, "r");
802 ret = -1;
803 if (f) {
804 config_file = f;
805 config_file_name = filename;
806 config_linenr = 1;
807 config_file_eof = 0;
808 ret = git_parse_file(fn, data);
809 fclose(f);
810 config_file_name = NULL;
812 return ret;
815 const char *git_etc_gitconfig(void)
817 static const char *system_wide;
818 if (!system_wide)
819 system_wide = system_path(ETC_GITCONFIG);
820 return system_wide;
823 int git_env_bool(const char *k, int def)
825 const char *v = getenv(k);
826 return v ? git_config_bool(k, v) : def;
829 int git_config_system(void)
831 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
834 int git_config_global(void)
836 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
839 int git_config_from_parameters(config_fn_t fn, void *data)
841 static int loaded_environment;
842 const struct config_item *ct;
844 if (!loaded_environment) {
845 if (git_config_parse_environment() < 0)
846 return -1;
847 loaded_environment = 1;
849 for (ct = config_parameters; ct; ct = ct->next)
850 if (fn(ct->name, ct->value, data) < 0)
851 return -1;
852 return 0;
855 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
857 int ret = 0, found = 0;
858 const char *home = NULL;
860 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
861 if (config_exclusive_filename)
862 return git_config_from_file(fn, config_exclusive_filename, data);
863 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
864 ret += git_config_from_file(fn, git_etc_gitconfig(),
865 data);
866 found += 1;
869 home = getenv("HOME");
870 if (git_config_global() && home) {
871 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
872 if (!access(user_config, R_OK)) {
873 ret += git_config_from_file(fn, user_config, data);
874 found += 1;
876 free(user_config);
879 if (repo_config && !access(repo_config, R_OK)) {
880 ret += git_config_from_file(fn, repo_config, data);
881 found += 1;
884 ret += git_config_from_parameters(fn, data);
885 if (config_parameters)
886 found += 1;
888 return ret == 0 ? found : ret;
891 int git_config(config_fn_t fn, void *data)
893 char *repo_config = NULL;
894 int ret;
896 repo_config = git_pathdup("config");
897 ret = git_config_early(fn, data, repo_config);
898 if (repo_config)
899 free(repo_config);
900 return ret;
904 * Find all the stuff for git_config_set() below.
907 #define MAX_MATCHES 512
909 static struct {
910 int baselen;
911 char *key;
912 int do_not_match;
913 regex_t *value_regex;
914 int multi_replace;
915 size_t offset[MAX_MATCHES];
916 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
917 int seen;
918 } store;
920 static int matches(const char *key, const char *value)
922 return !strcmp(key, store.key) &&
923 (store.value_regex == NULL ||
924 (store.do_not_match ^
925 !regexec(store.value_regex, value, 0, NULL, 0)));
928 static int store_aux(const char *key, const char *value, void *cb)
930 const char *ep;
931 size_t section_len;
933 switch (store.state) {
934 case KEY_SEEN:
935 if (matches(key, value)) {
936 if (store.seen == 1 && store.multi_replace == 0) {
937 warning("%s has multiple values", key);
938 } else if (store.seen >= MAX_MATCHES) {
939 error("too many matches for %s", key);
940 return 1;
943 store.offset[store.seen] = ftell(config_file);
944 store.seen++;
946 break;
947 case SECTION_SEEN:
949 * What we are looking for is in store.key (both
950 * section and var), and its section part is baselen
951 * long. We found key (again, both section and var).
952 * We would want to know if this key is in the same
953 * section as what we are looking for. We already
954 * know we are in the same section as what should
955 * hold store.key.
957 ep = strrchr(key, '.');
958 section_len = ep - key;
960 if ((section_len != store.baselen) ||
961 memcmp(key, store.key, section_len+1)) {
962 store.state = SECTION_END_SEEN;
963 break;
967 * Do not increment matches: this is no match, but we
968 * just made sure we are in the desired section.
970 store.offset[store.seen] = ftell(config_file);
971 /* fallthru */
972 case SECTION_END_SEEN:
973 case START:
974 if (matches(key, value)) {
975 store.offset[store.seen] = ftell(config_file);
976 store.state = KEY_SEEN;
977 store.seen++;
978 } else {
979 if (strrchr(key, '.') - key == store.baselen &&
980 !strncmp(key, store.key, store.baselen)) {
981 store.state = SECTION_SEEN;
982 store.offset[store.seen] = ftell(config_file);
986 return 0;
989 static int write_error(const char *filename)
991 error("failed to write new configuration file %s", filename);
993 /* Same error code as "failed to rename". */
994 return 4;
997 static int store_write_section(int fd, const char *key)
999 const char *dot;
1000 int i, success;
1001 struct strbuf sb = STRBUF_INIT;
1003 dot = memchr(key, '.', store.baselen);
1004 if (dot) {
1005 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1006 for (i = dot - key + 1; i < store.baselen; i++) {
1007 if (key[i] == '"' || key[i] == '\\')
1008 strbuf_addch(&sb, '\\');
1009 strbuf_addch(&sb, key[i]);
1011 strbuf_addstr(&sb, "\"]\n");
1012 } else {
1013 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1016 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1017 strbuf_release(&sb);
1019 return success;
1022 static int store_write_pair(int fd, const char *key, const char *value)
1024 int i, success;
1025 int length = strlen(key + store.baselen + 1);
1026 const char *quote = "";
1027 struct strbuf sb = STRBUF_INIT;
1030 * Check to see if the value needs to be surrounded with a dq pair.
1031 * Note that problematic characters are always backslash-quoted; this
1032 * check is about not losing leading or trailing SP and strings that
1033 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1034 * configuration parser.
1036 if (value[0] == ' ')
1037 quote = "\"";
1038 for (i = 0; value[i]; i++)
1039 if (value[i] == ';' || value[i] == '#')
1040 quote = "\"";
1041 if (i && value[i - 1] == ' ')
1042 quote = "\"";
1044 strbuf_addf(&sb, "\t%.*s = %s",
1045 length, key + store.baselen + 1, quote);
1047 for (i = 0; value[i]; i++)
1048 switch (value[i]) {
1049 case '\n':
1050 strbuf_addstr(&sb, "\\n");
1051 break;
1052 case '\t':
1053 strbuf_addstr(&sb, "\\t");
1054 break;
1055 case '"':
1056 case '\\':
1057 strbuf_addch(&sb, '\\');
1058 default:
1059 strbuf_addch(&sb, value[i]);
1060 break;
1062 strbuf_addf(&sb, "%s\n", quote);
1064 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1065 strbuf_release(&sb);
1067 return success;
1070 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1071 size_t offset_, int *found_bracket)
1073 size_t equal_offset = size, bracket_offset = size;
1074 ssize_t offset;
1076 contline:
1077 for (offset = offset_-2; offset > 0
1078 && contents[offset] != '\n'; offset--)
1079 switch (contents[offset]) {
1080 case '=': equal_offset = offset; break;
1081 case ']': bracket_offset = offset; break;
1083 if (offset > 0 && contents[offset-1] == '\\') {
1084 offset_ = offset;
1085 goto contline;
1087 if (bracket_offset < equal_offset) {
1088 *found_bracket = 1;
1089 offset = bracket_offset+1;
1090 } else
1091 offset++;
1093 return offset;
1096 int git_config_set(const char *key, const char *value)
1098 return git_config_set_multivar(key, value, NULL, 0);
1102 * If value==NULL, unset in (remove from) config,
1103 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1104 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1105 * else all matching key/values (regardless how many) are removed,
1106 * before the new pair is written.
1108 * Returns 0 on success.
1110 * This function does this:
1112 * - it locks the config file by creating ".git/config.lock"
1114 * - it then parses the config using store_aux() as validator to find
1115 * the position on the key/value pair to replace. If it is to be unset,
1116 * it must be found exactly once.
1118 * - the config file is mmap()ed and the part before the match (if any) is
1119 * written to the lock file, then the changed part and the rest.
1121 * - the config file is removed and the lock file rename()d to it.
1124 int git_config_set_multivar(const char *key, const char *value,
1125 const char *value_regex, int multi_replace)
1127 int i, dot;
1128 int fd = -1, in_fd;
1129 int ret;
1130 char *config_filename;
1131 struct lock_file *lock = NULL;
1132 const char *last_dot = strrchr(key, '.');
1134 if (config_exclusive_filename)
1135 config_filename = xstrdup(config_exclusive_filename);
1136 else
1137 config_filename = git_pathdup("config");
1140 * Since "key" actually contains the section name and the real
1141 * key name separated by a dot, we have to know where the dot is.
1144 if (last_dot == NULL) {
1145 error("key does not contain a section: %s", key);
1146 ret = 2;
1147 goto out_free;
1149 store.baselen = last_dot - key;
1151 store.multi_replace = multi_replace;
1154 * Validate the key and while at it, lower case it for matching.
1156 store.key = xmalloc(strlen(key) + 1);
1157 dot = 0;
1158 for (i = 0; key[i]; i++) {
1159 unsigned char c = key[i];
1160 if (c == '.')
1161 dot = 1;
1162 /* Leave the extended basename untouched.. */
1163 if (!dot || i > store.baselen) {
1164 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
1165 error("invalid key: %s", key);
1166 free(store.key);
1167 ret = 1;
1168 goto out_free;
1170 c = tolower(c);
1171 } else if (c == '\n') {
1172 error("invalid key (newline): %s", key);
1173 free(store.key);
1174 ret = 1;
1175 goto out_free;
1177 store.key[i] = c;
1179 store.key[i] = 0;
1182 * The lock serves a purpose in addition to locking: the new
1183 * contents of .git/config will be written into it.
1185 lock = xcalloc(sizeof(struct lock_file), 1);
1186 fd = hold_lock_file_for_update(lock, config_filename, 0);
1187 if (fd < 0) {
1188 error("could not lock config file %s: %s", config_filename, strerror(errno));
1189 free(store.key);
1190 ret = -1;
1191 goto out_free;
1195 * If .git/config does not exist yet, write a minimal version.
1197 in_fd = open(config_filename, O_RDONLY);
1198 if ( in_fd < 0 ) {
1199 free(store.key);
1201 if ( ENOENT != errno ) {
1202 error("opening %s: %s", config_filename,
1203 strerror(errno));
1204 ret = 3; /* same as "invalid config file" */
1205 goto out_free;
1207 /* if nothing to unset, error out */
1208 if (value == NULL) {
1209 ret = 5;
1210 goto out_free;
1213 store.key = (char *)key;
1214 if (!store_write_section(fd, key) ||
1215 !store_write_pair(fd, key, value))
1216 goto write_err_out;
1217 } else {
1218 struct stat st;
1219 char *contents;
1220 size_t contents_sz, copy_begin, copy_end;
1221 int i, new_line = 0;
1223 if (value_regex == NULL)
1224 store.value_regex = NULL;
1225 else {
1226 if (value_regex[0] == '!') {
1227 store.do_not_match = 1;
1228 value_regex++;
1229 } else
1230 store.do_not_match = 0;
1232 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1233 if (regcomp(store.value_regex, value_regex,
1234 REG_EXTENDED)) {
1235 error("invalid pattern: %s", value_regex);
1236 free(store.value_regex);
1237 ret = 6;
1238 goto out_free;
1242 store.offset[0] = 0;
1243 store.state = START;
1244 store.seen = 0;
1247 * After this, store.offset will contain the *end* offset
1248 * of the last match, or remain at 0 if no match was found.
1249 * As a side effect, we make sure to transform only a valid
1250 * existing config file.
1252 if (git_config_from_file(store_aux, config_filename, NULL)) {
1253 error("invalid config file %s", config_filename);
1254 free(store.key);
1255 if (store.value_regex != NULL) {
1256 regfree(store.value_regex);
1257 free(store.value_regex);
1259 ret = 3;
1260 goto out_free;
1263 free(store.key);
1264 if (store.value_regex != NULL) {
1265 regfree(store.value_regex);
1266 free(store.value_regex);
1269 /* if nothing to unset, or too many matches, error out */
1270 if ((store.seen == 0 && value == NULL) ||
1271 (store.seen > 1 && multi_replace == 0)) {
1272 ret = 5;
1273 goto out_free;
1276 fstat(in_fd, &st);
1277 contents_sz = xsize_t(st.st_size);
1278 contents = xmmap(NULL, contents_sz, PROT_READ,
1279 MAP_PRIVATE, in_fd, 0);
1280 close(in_fd);
1282 if (store.seen == 0)
1283 store.seen = 1;
1285 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1286 if (store.offset[i] == 0) {
1287 store.offset[i] = copy_end = contents_sz;
1288 } else if (store.state != KEY_SEEN) {
1289 copy_end = store.offset[i];
1290 } else
1291 copy_end = find_beginning_of_line(
1292 contents, contents_sz,
1293 store.offset[i]-2, &new_line);
1295 if (copy_end > 0 && contents[copy_end-1] != '\n')
1296 new_line = 1;
1298 /* write the first part of the config */
1299 if (copy_end > copy_begin) {
1300 if (write_in_full(fd, contents + copy_begin,
1301 copy_end - copy_begin) <
1302 copy_end - copy_begin)
1303 goto write_err_out;
1304 if (new_line &&
1305 write_str_in_full(fd, "\n") != 1)
1306 goto write_err_out;
1308 copy_begin = store.offset[i];
1311 /* write the pair (value == NULL means unset) */
1312 if (value != NULL) {
1313 if (store.state == START) {
1314 if (!store_write_section(fd, key))
1315 goto write_err_out;
1317 if (!store_write_pair(fd, key, value))
1318 goto write_err_out;
1321 /* write the rest of the config */
1322 if (copy_begin < contents_sz)
1323 if (write_in_full(fd, contents + copy_begin,
1324 contents_sz - copy_begin) <
1325 contents_sz - copy_begin)
1326 goto write_err_out;
1328 munmap(contents, contents_sz);
1331 if (commit_lock_file(lock) < 0) {
1332 error("could not commit config file %s", config_filename);
1333 ret = 4;
1334 goto out_free;
1338 * lock is committed, so don't try to roll it back below.
1339 * NOTE: Since lockfile.c keeps a linked list of all created
1340 * lock_file structures, it isn't safe to free(lock). It's
1341 * better to just leave it hanging around.
1343 lock = NULL;
1344 ret = 0;
1346 out_free:
1347 if (lock)
1348 rollback_lock_file(lock);
1349 free(config_filename);
1350 return ret;
1352 write_err_out:
1353 ret = write_error(lock->filename);
1354 goto out_free;
1358 static int section_name_match (const char *buf, const char *name)
1360 int i = 0, j = 0, dot = 0;
1361 if (buf[i] != '[')
1362 return 0;
1363 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1364 if (!dot && isspace(buf[i])) {
1365 dot = 1;
1366 if (name[j++] != '.')
1367 break;
1368 for (i++; isspace(buf[i]); i++)
1369 ; /* do nothing */
1370 if (buf[i] != '"')
1371 break;
1372 continue;
1374 if (buf[i] == '\\' && dot)
1375 i++;
1376 else if (buf[i] == '"' && dot) {
1377 for (i++; isspace(buf[i]); i++)
1378 ; /* do_nothing */
1379 break;
1381 if (buf[i] != name[j++])
1382 break;
1384 if (buf[i] == ']' && name[j] == 0) {
1386 * We match, now just find the right length offset by
1387 * gobbling up any whitespace after it, as well
1389 i++;
1390 for (; buf[i] && isspace(buf[i]); i++)
1391 ; /* do nothing */
1392 return i;
1394 return 0;
1397 /* if new_name == NULL, the section is removed instead */
1398 int git_config_rename_section(const char *old_name, const char *new_name)
1400 int ret = 0, remove = 0;
1401 char *config_filename;
1402 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1403 int out_fd;
1404 char buf[1024];
1406 if (config_exclusive_filename)
1407 config_filename = xstrdup(config_exclusive_filename);
1408 else
1409 config_filename = git_pathdup("config");
1410 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1411 if (out_fd < 0) {
1412 ret = error("could not lock config file %s", config_filename);
1413 goto out;
1416 if (!(config_file = fopen(config_filename, "rb"))) {
1417 /* no config file means nothing to rename, no error */
1418 goto unlock_and_out;
1421 while (fgets(buf, sizeof(buf), config_file)) {
1422 int i;
1423 int length;
1424 char *output = buf;
1425 for (i = 0; buf[i] && isspace(buf[i]); i++)
1426 ; /* do nothing */
1427 if (buf[i] == '[') {
1428 /* it's a section */
1429 int offset = section_name_match(&buf[i], old_name);
1430 if (offset > 0) {
1431 ret++;
1432 if (new_name == NULL) {
1433 remove = 1;
1434 continue;
1436 store.baselen = strlen(new_name);
1437 if (!store_write_section(out_fd, new_name)) {
1438 ret = write_error(lock->filename);
1439 goto out;
1442 * We wrote out the new section, with
1443 * a newline, now skip the old
1444 * section's length
1446 output += offset + i;
1447 if (strlen(output) > 0) {
1449 * More content means there's
1450 * a declaration to put on the
1451 * next line; indent with a
1452 * tab
1454 output -= 1;
1455 output[0] = '\t';
1458 remove = 0;
1460 if (remove)
1461 continue;
1462 length = strlen(output);
1463 if (write_in_full(out_fd, output, length) != length) {
1464 ret = write_error(lock->filename);
1465 goto out;
1468 fclose(config_file);
1469 unlock_and_out:
1470 if (commit_lock_file(lock) < 0)
1471 ret = error("could not commit config file %s", config_filename);
1472 out:
1473 free(config_filename);
1474 return ret;
1478 * Call this to report error for your variable that should not
1479 * get a boolean value (i.e. "[my] var" means "true").
1481 int config_error_nonbool(const char *var)
1483 return error("Missing value for '%s'", var);