doc: add missing git footers
[git/jrn.git] / config.c
blobb94de8f51c860b2804c8e16a33343d55e32c2733
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.bare")) {
503 is_bare_repository_cfg = git_config_bool(var, value);
504 return 0;
507 if (!strcmp(var, "core.ignorestat")) {
508 assume_unchanged = git_config_bool(var, value);
509 return 0;
512 if (!strcmp(var, "core.prefersymlinkrefs")) {
513 prefer_symlink_refs = git_config_bool(var, value);
514 return 0;
517 if (!strcmp(var, "core.logallrefupdates")) {
518 log_all_ref_updates = git_config_bool(var, value);
519 return 0;
522 if (!strcmp(var, "core.warnambiguousrefs")) {
523 warn_ambiguous_refs = git_config_bool(var, value);
524 return 0;
527 if (!strcmp(var, "core.loosecompression")) {
528 int level = git_config_int(var, value);
529 if (level == -1)
530 level = Z_DEFAULT_COMPRESSION;
531 else if (level < 0 || level > Z_BEST_COMPRESSION)
532 die("bad zlib compression level %d", level);
533 zlib_compression_level = level;
534 zlib_compression_seen = 1;
535 return 0;
538 if (!strcmp(var, "core.compression")) {
539 int level = git_config_int(var, value);
540 if (level == -1)
541 level = Z_DEFAULT_COMPRESSION;
542 else if (level < 0 || level > Z_BEST_COMPRESSION)
543 die("bad zlib compression level %d", level);
544 core_compression_level = level;
545 core_compression_seen = 1;
546 if (!zlib_compression_seen)
547 zlib_compression_level = level;
548 return 0;
551 if (!strcmp(var, "core.packedgitwindowsize")) {
552 int pgsz_x2 = getpagesize() * 2;
553 packed_git_window_size = git_config_int(var, value);
555 /* This value must be multiple of (pagesize * 2) */
556 packed_git_window_size /= pgsz_x2;
557 if (packed_git_window_size < 1)
558 packed_git_window_size = 1;
559 packed_git_window_size *= pgsz_x2;
560 return 0;
563 if (!strcmp(var, "core.packedgitlimit")) {
564 packed_git_limit = git_config_int(var, value);
565 return 0;
568 if (!strcmp(var, "core.deltabasecachelimit")) {
569 delta_base_cache_limit = git_config_int(var, value);
570 return 0;
573 if (!strcmp(var, "core.autocrlf")) {
574 if (value && !strcasecmp(value, "input")) {
575 if (eol == EOL_CRLF)
576 return error("core.autocrlf=input conflicts with core.eol=crlf");
577 auto_crlf = AUTO_CRLF_INPUT;
578 return 0;
580 auto_crlf = git_config_bool(var, value);
581 return 0;
584 if (!strcmp(var, "core.safecrlf")) {
585 if (value && !strcasecmp(value, "warn")) {
586 safe_crlf = SAFE_CRLF_WARN;
587 return 0;
589 safe_crlf = git_config_bool(var, value);
590 return 0;
593 if (!strcmp(var, "core.eol")) {
594 if (value && !strcasecmp(value, "lf"))
595 eol = EOL_LF;
596 else if (value && !strcasecmp(value, "crlf"))
597 eol = EOL_CRLF;
598 else if (value && !strcasecmp(value, "native"))
599 eol = EOL_NATIVE;
600 else
601 eol = EOL_UNSET;
602 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
603 return error("core.autocrlf=input conflicts with core.eol=crlf");
604 return 0;
607 if (!strcmp(var, "core.notesref")) {
608 notes_ref_name = xstrdup(value);
609 return 0;
612 if (!strcmp(var, "core.pager"))
613 return git_config_string(&pager_program, var, value);
615 if (!strcmp(var, "core.editor"))
616 return git_config_string(&editor_program, var, value);
618 if (!strcmp(var, "core.askpass"))
619 return git_config_string(&askpass_program, var, value);
621 if (!strcmp(var, "core.excludesfile"))
622 return git_config_pathname(&excludes_file, var, value);
624 if (!strcmp(var, "core.whitespace")) {
625 if (!value)
626 return config_error_nonbool(var);
627 whitespace_rule_cfg = parse_whitespace_rule(value);
628 return 0;
631 if (!strcmp(var, "core.fsyncobjectfiles")) {
632 fsync_object_files = git_config_bool(var, value);
633 return 0;
636 if (!strcmp(var, "core.preloadindex")) {
637 core_preload_index = git_config_bool(var, value);
638 return 0;
641 if (!strcmp(var, "core.createobject")) {
642 if (!strcmp(value, "rename"))
643 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
644 else if (!strcmp(value, "link"))
645 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
646 else
647 die("Invalid mode for object creation: %s", value);
648 return 0;
651 if (!strcmp(var, "core.sparsecheckout")) {
652 core_apply_sparse_checkout = git_config_bool(var, value);
653 return 0;
656 /* Add other config variables here and to Documentation/config.txt. */
657 return 0;
660 static int git_default_user_config(const char *var, const char *value)
662 if (!strcmp(var, "user.name")) {
663 if (!value)
664 return config_error_nonbool(var);
665 strlcpy(git_default_name, value, sizeof(git_default_name));
666 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
667 return 0;
670 if (!strcmp(var, "user.email")) {
671 if (!value)
672 return config_error_nonbool(var);
673 strlcpy(git_default_email, value, sizeof(git_default_email));
674 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
675 return 0;
678 /* Add other config variables here and to Documentation/config.txt. */
679 return 0;
682 static int git_default_i18n_config(const char *var, const char *value)
684 if (!strcmp(var, "i18n.commitencoding"))
685 return git_config_string(&git_commit_encoding, var, value);
687 if (!strcmp(var, "i18n.logoutputencoding"))
688 return git_config_string(&git_log_output_encoding, var, value);
690 /* Add other config variables here and to Documentation/config.txt. */
691 return 0;
694 static int git_default_branch_config(const char *var, const char *value)
696 if (!strcmp(var, "branch.autosetupmerge")) {
697 if (value && !strcasecmp(value, "always")) {
698 git_branch_track = BRANCH_TRACK_ALWAYS;
699 return 0;
701 git_branch_track = git_config_bool(var, value);
702 return 0;
704 if (!strcmp(var, "branch.autosetuprebase")) {
705 if (!value)
706 return config_error_nonbool(var);
707 else if (!strcmp(value, "never"))
708 autorebase = AUTOREBASE_NEVER;
709 else if (!strcmp(value, "local"))
710 autorebase = AUTOREBASE_LOCAL;
711 else if (!strcmp(value, "remote"))
712 autorebase = AUTOREBASE_REMOTE;
713 else if (!strcmp(value, "always"))
714 autorebase = AUTOREBASE_ALWAYS;
715 else
716 return error("Malformed value for %s", var);
717 return 0;
720 /* Add other config variables here and to Documentation/config.txt. */
721 return 0;
724 static int git_default_push_config(const char *var, const char *value)
726 if (!strcmp(var, "push.default")) {
727 if (!value)
728 return config_error_nonbool(var);
729 else if (!strcmp(value, "nothing"))
730 push_default = PUSH_DEFAULT_NOTHING;
731 else if (!strcmp(value, "matching"))
732 push_default = PUSH_DEFAULT_MATCHING;
733 else if (!strcmp(value, "upstream"))
734 push_default = PUSH_DEFAULT_UPSTREAM;
735 else if (!strcmp(value, "tracking")) /* deprecated */
736 push_default = PUSH_DEFAULT_UPSTREAM;
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_early(config_fn_t fn, void *data, const char *repo_config)
852 int ret = 0, found = 0;
853 const char *home = NULL;
855 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
856 if (config_exclusive_filename)
857 return git_config_from_file(fn, config_exclusive_filename, data);
858 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
859 ret += git_config_from_file(fn, git_etc_gitconfig(),
860 data);
861 found += 1;
864 home = getenv("HOME");
865 if (git_config_global() && home) {
866 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
867 if (!access(user_config, R_OK)) {
868 ret += git_config_from_file(fn, user_config, data);
869 found += 1;
871 free(user_config);
874 if (repo_config && !access(repo_config, R_OK)) {
875 ret += git_config_from_file(fn, repo_config, data);
876 found += 1;
879 ret += git_config_from_parameters(fn, data);
880 if (config_parameters)
881 found += 1;
883 return ret == 0 ? found : ret;
886 int git_config(config_fn_t fn, void *data)
888 char *repo_config = NULL;
889 int ret;
891 repo_config = git_pathdup("config");
892 ret = git_config_early(fn, data, repo_config);
893 if (repo_config)
894 free(repo_config);
895 return ret;
899 * Find all the stuff for git_config_set() below.
902 #define MAX_MATCHES 512
904 static struct {
905 int baselen;
906 char *key;
907 int do_not_match;
908 regex_t *value_regex;
909 int multi_replace;
910 size_t offset[MAX_MATCHES];
911 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
912 int seen;
913 } store;
915 static int matches(const char *key, const char *value)
917 return !strcmp(key, store.key) &&
918 (store.value_regex == NULL ||
919 (store.do_not_match ^
920 !regexec(store.value_regex, value, 0, NULL, 0)));
923 static int store_aux(const char *key, const char *value, void *cb)
925 const char *ep;
926 size_t section_len;
928 switch (store.state) {
929 case KEY_SEEN:
930 if (matches(key, value)) {
931 if (store.seen == 1 && store.multi_replace == 0) {
932 warning("%s has multiple values", key);
933 } else if (store.seen >= MAX_MATCHES) {
934 error("too many matches for %s", key);
935 return 1;
938 store.offset[store.seen] = ftell(config_file);
939 store.seen++;
941 break;
942 case SECTION_SEEN:
944 * What we are looking for is in store.key (both
945 * section and var), and its section part is baselen
946 * long. We found key (again, both section and var).
947 * We would want to know if this key is in the same
948 * section as what we are looking for. We already
949 * know we are in the same section as what should
950 * hold store.key.
952 ep = strrchr(key, '.');
953 section_len = ep - key;
955 if ((section_len != store.baselen) ||
956 memcmp(key, store.key, section_len+1)) {
957 store.state = SECTION_END_SEEN;
958 break;
962 * Do not increment matches: this is no match, but we
963 * just made sure we are in the desired section.
965 store.offset[store.seen] = ftell(config_file);
966 /* fallthru */
967 case SECTION_END_SEEN:
968 case START:
969 if (matches(key, value)) {
970 store.offset[store.seen] = ftell(config_file);
971 store.state = KEY_SEEN;
972 store.seen++;
973 } else {
974 if (strrchr(key, '.') - key == store.baselen &&
975 !strncmp(key, store.key, store.baselen)) {
976 store.state = SECTION_SEEN;
977 store.offset[store.seen] = ftell(config_file);
981 return 0;
984 static int write_error(const char *filename)
986 error("failed to write new configuration file %s", filename);
988 /* Same error code as "failed to rename". */
989 return 4;
992 static int store_write_section(int fd, const char *key)
994 const char *dot;
995 int i, success;
996 struct strbuf sb = STRBUF_INIT;
998 dot = memchr(key, '.', store.baselen);
999 if (dot) {
1000 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1001 for (i = dot - key + 1; i < store.baselen; i++) {
1002 if (key[i] == '"' || key[i] == '\\')
1003 strbuf_addch(&sb, '\\');
1004 strbuf_addch(&sb, key[i]);
1006 strbuf_addstr(&sb, "\"]\n");
1007 } else {
1008 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1011 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1012 strbuf_release(&sb);
1014 return success;
1017 static int store_write_pair(int fd, const char *key, const char *value)
1019 int i, success;
1020 int length = strlen(key + store.baselen + 1);
1021 const char *quote = "";
1022 struct strbuf sb = STRBUF_INIT;
1025 * Check to see if the value needs to be surrounded with a dq pair.
1026 * Note that problematic characters are always backslash-quoted; this
1027 * check is about not losing leading or trailing SP and strings that
1028 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1029 * configuration parser.
1031 if (value[0] == ' ')
1032 quote = "\"";
1033 for (i = 0; value[i]; i++)
1034 if (value[i] == ';' || value[i] == '#')
1035 quote = "\"";
1036 if (i && value[i - 1] == ' ')
1037 quote = "\"";
1039 strbuf_addf(&sb, "\t%.*s = %s",
1040 length, key + store.baselen + 1, quote);
1042 for (i = 0; value[i]; i++)
1043 switch (value[i]) {
1044 case '\n':
1045 strbuf_addstr(&sb, "\\n");
1046 break;
1047 case '\t':
1048 strbuf_addstr(&sb, "\\t");
1049 break;
1050 case '"':
1051 case '\\':
1052 strbuf_addch(&sb, '\\');
1053 default:
1054 strbuf_addch(&sb, value[i]);
1055 break;
1057 strbuf_addf(&sb, "%s\n", quote);
1059 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1060 strbuf_release(&sb);
1062 return success;
1065 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1066 size_t offset_, int *found_bracket)
1068 size_t equal_offset = size, bracket_offset = size;
1069 ssize_t offset;
1071 contline:
1072 for (offset = offset_-2; offset > 0
1073 && contents[offset] != '\n'; offset--)
1074 switch (contents[offset]) {
1075 case '=': equal_offset = offset; break;
1076 case ']': bracket_offset = offset; break;
1078 if (offset > 0 && contents[offset-1] == '\\') {
1079 offset_ = offset;
1080 goto contline;
1082 if (bracket_offset < equal_offset) {
1083 *found_bracket = 1;
1084 offset = bracket_offset+1;
1085 } else
1086 offset++;
1088 return offset;
1091 int git_config_set(const char *key, const char *value)
1093 return git_config_set_multivar(key, value, NULL, 0);
1097 * Auxiliary function to sanity-check and split the key into the section
1098 * identifier and variable name.
1100 * Returns 0 on success, -1 when there is an invalid character in the key and
1101 * -2 if there is no section name in the key.
1103 * store_key - pointer to char* which will hold a copy of the key with
1104 * lowercase section and variable name
1105 * baselen - pointer to int which will hold the length of the
1106 * section + subsection part, can be NULL
1108 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1110 int i, dot, baselen;
1111 const char *last_dot = strrchr(key, '.');
1114 * Since "key" actually contains the section name and the real
1115 * key name separated by a dot, we have to know where the dot is.
1118 if (last_dot == NULL || last_dot == key) {
1119 error("key does not contain a section: %s", key);
1120 return -2;
1123 if (!last_dot[1]) {
1124 error("key does not contain variable name: %s", key);
1125 return -2;
1128 baselen = last_dot - key;
1129 if (baselen_)
1130 *baselen_ = baselen;
1133 * Validate the key and while at it, lower case it for matching.
1135 *store_key = xmalloc(strlen(key) + 1);
1137 dot = 0;
1138 for (i = 0; key[i]; i++) {
1139 unsigned char c = key[i];
1140 if (c == '.')
1141 dot = 1;
1142 /* Leave the extended basename untouched.. */
1143 if (!dot || i > baselen) {
1144 if (!iskeychar(c) ||
1145 (i == baselen + 1 && !isalpha(c))) {
1146 error("invalid key: %s", key);
1147 goto out_free_ret_1;
1149 c = tolower(c);
1150 } else if (c == '\n') {
1151 error("invalid key (newline): %s", key);
1152 goto out_free_ret_1;
1154 (*store_key)[i] = c;
1156 (*store_key)[i] = 0;
1158 return 0;
1160 out_free_ret_1:
1161 free(*store_key);
1162 return -1;
1166 * If value==NULL, unset in (remove from) config,
1167 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1168 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1169 * else all matching key/values (regardless how many) are removed,
1170 * before the new pair is written.
1172 * Returns 0 on success.
1174 * This function does this:
1176 * - it locks the config file by creating ".git/config.lock"
1178 * - it then parses the config using store_aux() as validator to find
1179 * the position on the key/value pair to replace. If it is to be unset,
1180 * it must be found exactly once.
1182 * - the config file is mmap()ed and the part before the match (if any) is
1183 * written to the lock file, then the changed part and the rest.
1185 * - the config file is removed and the lock file rename()d to it.
1188 int git_config_set_multivar(const char *key, const char *value,
1189 const char *value_regex, int multi_replace)
1191 int fd = -1, in_fd;
1192 int ret;
1193 char *config_filename;
1194 struct lock_file *lock = NULL;
1196 if (config_exclusive_filename)
1197 config_filename = xstrdup(config_exclusive_filename);
1198 else
1199 config_filename = git_pathdup("config");
1201 /* parse-key returns negative; flip the sign to feed exit(3) */
1202 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1203 if (ret)
1204 goto out_free;
1206 store.multi_replace = multi_replace;
1210 * The lock serves a purpose in addition to locking: the new
1211 * contents of .git/config will be written into it.
1213 lock = xcalloc(sizeof(struct lock_file), 1);
1214 fd = hold_lock_file_for_update(lock, config_filename, 0);
1215 if (fd < 0) {
1216 error("could not lock config file %s: %s", config_filename, strerror(errno));
1217 free(store.key);
1218 ret = -1;
1219 goto out_free;
1223 * If .git/config does not exist yet, write a minimal version.
1225 in_fd = open(config_filename, O_RDONLY);
1226 if ( in_fd < 0 ) {
1227 free(store.key);
1229 if ( ENOENT != errno ) {
1230 error("opening %s: %s", config_filename,
1231 strerror(errno));
1232 ret = 3; /* same as "invalid config file" */
1233 goto out_free;
1235 /* if nothing to unset, error out */
1236 if (value == NULL) {
1237 ret = 5;
1238 goto out_free;
1241 store.key = (char *)key;
1242 if (!store_write_section(fd, key) ||
1243 !store_write_pair(fd, key, value))
1244 goto write_err_out;
1245 } else {
1246 struct stat st;
1247 char *contents;
1248 size_t contents_sz, copy_begin, copy_end;
1249 int i, new_line = 0;
1251 if (value_regex == NULL)
1252 store.value_regex = NULL;
1253 else {
1254 if (value_regex[0] == '!') {
1255 store.do_not_match = 1;
1256 value_regex++;
1257 } else
1258 store.do_not_match = 0;
1260 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1261 if (regcomp(store.value_regex, value_regex,
1262 REG_EXTENDED)) {
1263 error("invalid pattern: %s", value_regex);
1264 free(store.value_regex);
1265 ret = 6;
1266 goto out_free;
1270 store.offset[0] = 0;
1271 store.state = START;
1272 store.seen = 0;
1275 * After this, store.offset will contain the *end* offset
1276 * of the last match, or remain at 0 if no match was found.
1277 * As a side effect, we make sure to transform only a valid
1278 * existing config file.
1280 if (git_config_from_file(store_aux, config_filename, NULL)) {
1281 error("invalid config file %s", config_filename);
1282 free(store.key);
1283 if (store.value_regex != NULL) {
1284 regfree(store.value_regex);
1285 free(store.value_regex);
1287 ret = 3;
1288 goto out_free;
1291 free(store.key);
1292 if (store.value_regex != NULL) {
1293 regfree(store.value_regex);
1294 free(store.value_regex);
1297 /* if nothing to unset, or too many matches, error out */
1298 if ((store.seen == 0 && value == NULL) ||
1299 (store.seen > 1 && multi_replace == 0)) {
1300 ret = 5;
1301 goto out_free;
1304 fstat(in_fd, &st);
1305 contents_sz = xsize_t(st.st_size);
1306 contents = xmmap(NULL, contents_sz, PROT_READ,
1307 MAP_PRIVATE, in_fd, 0);
1308 close(in_fd);
1310 if (store.seen == 0)
1311 store.seen = 1;
1313 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1314 if (store.offset[i] == 0) {
1315 store.offset[i] = copy_end = contents_sz;
1316 } else if (store.state != KEY_SEEN) {
1317 copy_end = store.offset[i];
1318 } else
1319 copy_end = find_beginning_of_line(
1320 contents, contents_sz,
1321 store.offset[i]-2, &new_line);
1323 if (copy_end > 0 && contents[copy_end-1] != '\n')
1324 new_line = 1;
1326 /* write the first part of the config */
1327 if (copy_end > copy_begin) {
1328 if (write_in_full(fd, contents + copy_begin,
1329 copy_end - copy_begin) <
1330 copy_end - copy_begin)
1331 goto write_err_out;
1332 if (new_line &&
1333 write_str_in_full(fd, "\n") != 1)
1334 goto write_err_out;
1336 copy_begin = store.offset[i];
1339 /* write the pair (value == NULL means unset) */
1340 if (value != NULL) {
1341 if (store.state == START) {
1342 if (!store_write_section(fd, key))
1343 goto write_err_out;
1345 if (!store_write_pair(fd, key, value))
1346 goto write_err_out;
1349 /* write the rest of the config */
1350 if (copy_begin < contents_sz)
1351 if (write_in_full(fd, contents + copy_begin,
1352 contents_sz - copy_begin) <
1353 contents_sz - copy_begin)
1354 goto write_err_out;
1356 munmap(contents, contents_sz);
1359 if (commit_lock_file(lock) < 0) {
1360 error("could not commit config file %s", config_filename);
1361 ret = 4;
1362 goto out_free;
1366 * lock is committed, so don't try to roll it back below.
1367 * NOTE: Since lockfile.c keeps a linked list of all created
1368 * lock_file structures, it isn't safe to free(lock). It's
1369 * better to just leave it hanging around.
1371 lock = NULL;
1372 ret = 0;
1374 out_free:
1375 if (lock)
1376 rollback_lock_file(lock);
1377 free(config_filename);
1378 return ret;
1380 write_err_out:
1381 ret = write_error(lock->filename);
1382 goto out_free;
1386 static int section_name_match (const char *buf, const char *name)
1388 int i = 0, j = 0, dot = 0;
1389 if (buf[i] != '[')
1390 return 0;
1391 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1392 if (!dot && isspace(buf[i])) {
1393 dot = 1;
1394 if (name[j++] != '.')
1395 break;
1396 for (i++; isspace(buf[i]); i++)
1397 ; /* do nothing */
1398 if (buf[i] != '"')
1399 break;
1400 continue;
1402 if (buf[i] == '\\' && dot)
1403 i++;
1404 else if (buf[i] == '"' && dot) {
1405 for (i++; isspace(buf[i]); i++)
1406 ; /* do_nothing */
1407 break;
1409 if (buf[i] != name[j++])
1410 break;
1412 if (buf[i] == ']' && name[j] == 0) {
1414 * We match, now just find the right length offset by
1415 * gobbling up any whitespace after it, as well
1417 i++;
1418 for (; buf[i] && isspace(buf[i]); i++)
1419 ; /* do nothing */
1420 return i;
1422 return 0;
1425 /* if new_name == NULL, the section is removed instead */
1426 int git_config_rename_section(const char *old_name, const char *new_name)
1428 int ret = 0, remove = 0;
1429 char *config_filename;
1430 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1431 int out_fd;
1432 char buf[1024];
1434 if (config_exclusive_filename)
1435 config_filename = xstrdup(config_exclusive_filename);
1436 else
1437 config_filename = git_pathdup("config");
1438 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1439 if (out_fd < 0) {
1440 ret = error("could not lock config file %s", config_filename);
1441 goto out;
1444 if (!(config_file = fopen(config_filename, "rb"))) {
1445 /* no config file means nothing to rename, no error */
1446 goto unlock_and_out;
1449 while (fgets(buf, sizeof(buf), config_file)) {
1450 int i;
1451 int length;
1452 char *output = buf;
1453 for (i = 0; buf[i] && isspace(buf[i]); i++)
1454 ; /* do nothing */
1455 if (buf[i] == '[') {
1456 /* it's a section */
1457 int offset = section_name_match(&buf[i], old_name);
1458 if (offset > 0) {
1459 ret++;
1460 if (new_name == NULL) {
1461 remove = 1;
1462 continue;
1464 store.baselen = strlen(new_name);
1465 if (!store_write_section(out_fd, new_name)) {
1466 ret = write_error(lock->filename);
1467 goto out;
1470 * We wrote out the new section, with
1471 * a newline, now skip the old
1472 * section's length
1474 output += offset + i;
1475 if (strlen(output) > 0) {
1477 * More content means there's
1478 * a declaration to put on the
1479 * next line; indent with a
1480 * tab
1482 output -= 1;
1483 output[0] = '\t';
1486 remove = 0;
1488 if (remove)
1489 continue;
1490 length = strlen(output);
1491 if (write_in_full(out_fd, output, length) != length) {
1492 ret = write_error(lock->filename);
1493 goto out;
1496 fclose(config_file);
1497 unlock_and_out:
1498 if (commit_lock_file(lock) < 0)
1499 ret = error("could not commit config file %s", config_filename);
1500 out:
1501 free(config_filename);
1502 return ret;
1506 * Call this to report error for your variable that should not
1507 * get a boolean value (i.e. "[my] var" means "true").
1509 int config_error_nonbool(const char *var)
1511 return error("Missing value for '%s'", var);