git-config doc: unconfuse an example
[git.git] / config.c
blob818ba6df00e342f55fb7151b05299848240e61bd
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 typedef struct config_file {
16 struct config_file *prev;
17 FILE *f;
18 const char *name;
19 int linenr;
20 int eof;
21 struct strbuf value;
22 char var[MAXNAME];
23 } config_file;
25 static config_file *cf;
27 static int zlib_compression_seen;
29 const char *config_exclusive_filename = NULL;
31 static void lowercase(char *p)
33 for (; *p; p++)
34 *p = tolower(*p);
37 void git_config_push_parameter(const char *text)
39 struct strbuf env = STRBUF_INIT;
40 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
41 if (old) {
42 strbuf_addstr(&env, old);
43 strbuf_addch(&env, ' ');
45 sq_quote_buf(&env, text);
46 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
47 strbuf_release(&env);
50 int git_config_parse_parameter(const char *text,
51 config_fn_t fn, void *data)
53 struct strbuf **pair;
54 pair = strbuf_split_str(text, '=', 2);
55 if (!pair[0])
56 return error("bogus config parameter: %s", text);
57 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
58 strbuf_setlen(pair[0], pair[0]->len - 1);
59 strbuf_trim(pair[0]);
60 if (!pair[0]->len) {
61 strbuf_list_free(pair);
62 return error("bogus config parameter: %s", text);
64 lowercase(pair[0]->buf);
65 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
66 strbuf_list_free(pair);
67 return -1;
69 strbuf_list_free(pair);
70 return 0;
73 int git_config_from_parameters(config_fn_t fn, void *data)
75 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
76 char *envw;
77 const char **argv = NULL;
78 int nr = 0, alloc = 0;
79 int i;
81 if (!env)
82 return 0;
83 /* sq_dequote will write over it */
84 envw = xstrdup(env);
86 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
87 free(envw);
88 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
91 for (i = 0; i < nr; i++) {
92 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
93 free(argv);
94 free(envw);
95 return -1;
99 free(argv);
100 free(envw);
101 return nr > 0;
104 static int get_next_char(void)
106 int c;
107 FILE *f;
109 c = '\n';
110 if (cf && ((f = cf->f) != NULL)) {
111 c = fgetc(f);
112 if (c == '\r') {
113 /* DOS like systems */
114 c = fgetc(f);
115 if (c != '\n') {
116 ungetc(c, f);
117 c = '\r';
120 if (c == '\n')
121 cf->linenr++;
122 if (c == EOF) {
123 cf->eof = 1;
124 c = '\n';
127 return c;
130 static char *parse_value(void)
132 int quote = 0, comment = 0, space = 0;
134 strbuf_reset(&cf->value);
135 for (;;) {
136 int c = get_next_char();
137 if (c == '\n') {
138 if (quote) {
139 cf->linenr--;
140 return NULL;
142 return cf->value.buf;
144 if (comment)
145 continue;
146 if (isspace(c) && !quote) {
147 if (cf->value.len)
148 space++;
149 continue;
151 if (!quote) {
152 if (c == ';' || c == '#') {
153 comment = 1;
154 continue;
157 for (; space; space--)
158 strbuf_addch(&cf->value, ' ');
159 if (c == '\\') {
160 c = get_next_char();
161 switch (c) {
162 case '\n':
163 continue;
164 case 't':
165 c = '\t';
166 break;
167 case 'b':
168 c = '\b';
169 break;
170 case 'n':
171 c = '\n';
172 break;
173 /* Some characters escape as themselves */
174 case '\\': case '"':
175 break;
176 /* Reject unknown escape sequences */
177 default:
178 return NULL;
180 strbuf_addch(&cf->value, c);
181 continue;
183 if (c == '"') {
184 quote = 1-quote;
185 continue;
187 strbuf_addch(&cf->value, c);
191 static inline int iskeychar(int c)
193 return isalnum(c) || c == '-';
196 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
198 int c;
199 char *value;
201 /* Get the full name */
202 for (;;) {
203 c = get_next_char();
204 if (cf->eof)
205 break;
206 if (!iskeychar(c))
207 break;
208 name[len++] = tolower(c);
209 if (len >= MAXNAME)
210 return -1;
212 name[len] = 0;
213 while (c == ' ' || c == '\t')
214 c = get_next_char();
216 value = NULL;
217 if (c != '\n') {
218 if (c != '=')
219 return -1;
220 value = parse_value();
221 if (!value)
222 return -1;
224 return fn(name, value, data);
227 static int get_extended_base_var(char *name, int baselen, int c)
229 do {
230 if (c == '\n')
231 goto error_incomplete_line;
232 c = get_next_char();
233 } while (isspace(c));
235 /* We require the format to be '[base "extension"]' */
236 if (c != '"')
237 return -1;
238 name[baselen++] = '.';
240 for (;;) {
241 int c = get_next_char();
242 if (c == '\n')
243 goto error_incomplete_line;
244 if (c == '"')
245 break;
246 if (c == '\\') {
247 c = get_next_char();
248 if (c == '\n')
249 goto error_incomplete_line;
251 name[baselen++] = c;
252 if (baselen > MAXNAME / 2)
253 return -1;
256 /* Final ']' */
257 if (get_next_char() != ']')
258 return -1;
259 return baselen;
260 error_incomplete_line:
261 cf->linenr--;
262 return -1;
265 static int get_base_var(char *name)
267 int baselen = 0;
269 for (;;) {
270 int c = get_next_char();
271 if (cf->eof)
272 return -1;
273 if (c == ']')
274 return baselen;
275 if (isspace(c))
276 return get_extended_base_var(name, baselen, c);
277 if (!iskeychar(c) && c != '.')
278 return -1;
279 if (baselen > MAXNAME / 2)
280 return -1;
281 name[baselen++] = tolower(c);
285 static int git_parse_file(config_fn_t fn, void *data)
287 int comment = 0;
288 int baselen = 0;
289 char *var = cf->var;
291 /* U+FEFF Byte Order Mark in UTF8 */
292 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
293 const unsigned char *bomptr = utf8_bom;
295 for (;;) {
296 int c = get_next_char();
297 if (bomptr && *bomptr) {
298 /* We are at the file beginning; skip UTF8-encoded BOM
299 * if present. Sane editors won't put this in on their
300 * own, but e.g. Windows Notepad will do it happily. */
301 if ((unsigned char) c == *bomptr) {
302 bomptr++;
303 continue;
304 } else {
305 /* Do not tolerate partial BOM. */
306 if (bomptr != utf8_bom)
307 break;
308 /* No BOM at file beginning. Cool. */
309 bomptr = NULL;
312 if (c == '\n') {
313 if (cf->eof)
314 return 0;
315 comment = 0;
316 continue;
318 if (comment || isspace(c))
319 continue;
320 if (c == '#' || c == ';') {
321 comment = 1;
322 continue;
324 if (c == '[') {
325 baselen = get_base_var(var);
326 if (baselen <= 0)
327 break;
328 var[baselen++] = '.';
329 var[baselen] = 0;
330 continue;
332 if (!isalpha(c))
333 break;
334 var[baselen] = tolower(c);
335 if (get_value(fn, data, var, baselen+1) < 0)
336 break;
338 die("bad config file line %d in %s", cf->linenr, cf->name);
341 static int parse_unit_factor(const char *end, uintmax_t *val)
343 if (!*end)
344 return 1;
345 else if (!strcasecmp(end, "k")) {
346 *val *= 1024;
347 return 1;
349 else if (!strcasecmp(end, "m")) {
350 *val *= 1024 * 1024;
351 return 1;
353 else if (!strcasecmp(end, "g")) {
354 *val *= 1024 * 1024 * 1024;
355 return 1;
357 return 0;
360 static int git_parse_long(const char *value, long *ret)
362 if (value && *value) {
363 char *end;
364 intmax_t val;
365 uintmax_t uval;
366 uintmax_t factor = 1;
368 errno = 0;
369 val = strtoimax(value, &end, 0);
370 if (errno == ERANGE)
371 return 0;
372 if (!parse_unit_factor(end, &factor))
373 return 0;
374 uval = abs(val);
375 uval *= factor;
376 if ((uval > maximum_signed_value_of_type(long)) ||
377 (abs(val) > uval))
378 return 0;
379 val *= factor;
380 *ret = val;
381 return 1;
383 return 0;
386 int git_parse_ulong(const char *value, unsigned long *ret)
388 if (value && *value) {
389 char *end;
390 uintmax_t val;
391 uintmax_t oldval;
393 errno = 0;
394 val = strtoumax(value, &end, 0);
395 if (errno == ERANGE)
396 return 0;
397 oldval = val;
398 if (!parse_unit_factor(end, &val))
399 return 0;
400 if ((val > maximum_unsigned_value_of_type(long)) ||
401 (oldval > val))
402 return 0;
403 *ret = val;
404 return 1;
406 return 0;
409 static void die_bad_config(const char *name)
411 if (cf && cf->name)
412 die("bad config value for '%s' in %s", name, cf->name);
413 die("bad config value for '%s'", name);
416 int git_config_int(const char *name, const char *value)
418 long ret = 0;
419 if (!git_parse_long(value, &ret))
420 die_bad_config(name);
421 return ret;
424 unsigned long git_config_ulong(const char *name, const char *value)
426 unsigned long ret;
427 if (!git_parse_ulong(value, &ret))
428 die_bad_config(name);
429 return ret;
432 static int git_config_maybe_bool_text(const char *name, const char *value)
434 if (!value)
435 return 1;
436 if (!*value)
437 return 0;
438 if (!strcasecmp(value, "true")
439 || !strcasecmp(value, "yes")
440 || !strcasecmp(value, "on"))
441 return 1;
442 if (!strcasecmp(value, "false")
443 || !strcasecmp(value, "no")
444 || !strcasecmp(value, "off"))
445 return 0;
446 return -1;
449 int git_config_maybe_bool(const char *name, const char *value)
451 long v = git_config_maybe_bool_text(name, value);
452 if (0 <= v)
453 return v;
454 if (git_parse_long(value, &v))
455 return !!v;
456 return -1;
459 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
461 int v = git_config_maybe_bool_text(name, value);
462 if (0 <= v) {
463 *is_bool = 1;
464 return v;
466 *is_bool = 0;
467 return git_config_int(name, value);
470 int git_config_bool(const char *name, const char *value)
472 int discard;
473 return !!git_config_bool_or_int(name, value, &discard);
476 int git_config_string(const char **dest, const char *var, const char *value)
478 if (!value)
479 return config_error_nonbool(var);
480 *dest = xstrdup(value);
481 return 0;
484 int git_config_pathname(const char **dest, const char *var, const char *value)
486 if (!value)
487 return config_error_nonbool(var);
488 *dest = expand_user_path(value);
489 if (!*dest)
490 die("Failed to expand user dir in: '%s'", value);
491 return 0;
494 static int git_default_core_config(const char *var, const char *value)
496 /* This needs a better name */
497 if (!strcmp(var, "core.filemode")) {
498 trust_executable_bit = git_config_bool(var, value);
499 return 0;
501 if (!strcmp(var, "core.trustctime")) {
502 trust_ctime = git_config_bool(var, value);
503 return 0;
506 if (!strcmp(var, "core.quotepath")) {
507 quote_path_fully = git_config_bool(var, value);
508 return 0;
511 if (!strcmp(var, "core.symlinks")) {
512 has_symlinks = git_config_bool(var, value);
513 return 0;
516 if (!strcmp(var, "core.ignorecase")) {
517 ignore_case = git_config_bool(var, value);
518 return 0;
521 if (!strcmp(var, "core.attributesfile"))
522 return git_config_pathname(&git_attributes_file, var, value);
524 if (!strcmp(var, "core.bare")) {
525 is_bare_repository_cfg = git_config_bool(var, value);
526 return 0;
529 if (!strcmp(var, "core.ignorestat")) {
530 assume_unchanged = git_config_bool(var, value);
531 return 0;
534 if (!strcmp(var, "core.prefersymlinkrefs")) {
535 prefer_symlink_refs = git_config_bool(var, value);
536 return 0;
539 if (!strcmp(var, "core.logallrefupdates")) {
540 log_all_ref_updates = git_config_bool(var, value);
541 return 0;
544 if (!strcmp(var, "core.warnambiguousrefs")) {
545 warn_ambiguous_refs = git_config_bool(var, value);
546 return 0;
549 if (!strcmp(var, "core.abbrev")) {
550 int abbrev = git_config_int(var, value);
551 if (abbrev < minimum_abbrev || abbrev > 40)
552 return -1;
553 default_abbrev = abbrev;
554 return 0;
557 if (!strcmp(var, "core.loosecompression")) {
558 int level = git_config_int(var, value);
559 if (level == -1)
560 level = Z_DEFAULT_COMPRESSION;
561 else if (level < 0 || level > Z_BEST_COMPRESSION)
562 die("bad zlib compression level %d", level);
563 zlib_compression_level = level;
564 zlib_compression_seen = 1;
565 return 0;
568 if (!strcmp(var, "core.compression")) {
569 int level = git_config_int(var, value);
570 if (level == -1)
571 level = Z_DEFAULT_COMPRESSION;
572 else if (level < 0 || level > Z_BEST_COMPRESSION)
573 die("bad zlib compression level %d", level);
574 core_compression_level = level;
575 core_compression_seen = 1;
576 if (!zlib_compression_seen)
577 zlib_compression_level = level;
578 return 0;
581 if (!strcmp(var, "core.packedgitwindowsize")) {
582 int pgsz_x2 = getpagesize() * 2;
583 packed_git_window_size = git_config_ulong(var, value);
585 /* This value must be multiple of (pagesize * 2) */
586 packed_git_window_size /= pgsz_x2;
587 if (packed_git_window_size < 1)
588 packed_git_window_size = 1;
589 packed_git_window_size *= pgsz_x2;
590 return 0;
593 if (!strcmp(var, "core.bigfilethreshold")) {
594 big_file_threshold = git_config_ulong(var, value);
595 return 0;
598 if (!strcmp(var, "core.packedgitlimit")) {
599 packed_git_limit = git_config_ulong(var, value);
600 return 0;
603 if (!strcmp(var, "core.deltabasecachelimit")) {
604 delta_base_cache_limit = git_config_ulong(var, value);
605 return 0;
608 if (!strcmp(var, "core.logpackaccess"))
609 return git_config_string(&log_pack_access, var, value);
611 if (!strcmp(var, "core.autocrlf")) {
612 if (value && !strcasecmp(value, "input")) {
613 if (core_eol == EOL_CRLF)
614 return error("core.autocrlf=input conflicts with core.eol=crlf");
615 auto_crlf = AUTO_CRLF_INPUT;
616 return 0;
618 auto_crlf = git_config_bool(var, value);
619 return 0;
622 if (!strcmp(var, "core.safecrlf")) {
623 if (value && !strcasecmp(value, "warn")) {
624 safe_crlf = SAFE_CRLF_WARN;
625 return 0;
627 safe_crlf = git_config_bool(var, value);
628 return 0;
631 if (!strcmp(var, "core.eol")) {
632 if (value && !strcasecmp(value, "lf"))
633 core_eol = EOL_LF;
634 else if (value && !strcasecmp(value, "crlf"))
635 core_eol = EOL_CRLF;
636 else if (value && !strcasecmp(value, "native"))
637 core_eol = EOL_NATIVE;
638 else
639 core_eol = EOL_UNSET;
640 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
641 return error("core.autocrlf=input conflicts with core.eol=crlf");
642 return 0;
645 if (!strcmp(var, "core.notesref")) {
646 notes_ref_name = xstrdup(value);
647 return 0;
650 if (!strcmp(var, "core.pager"))
651 return git_config_string(&pager_program, var, value);
653 if (!strcmp(var, "core.editor"))
654 return git_config_string(&editor_program, var, value);
656 if (!strcmp(var, "core.askpass"))
657 return git_config_string(&askpass_program, var, value);
659 if (!strcmp(var, "core.excludesfile"))
660 return git_config_pathname(&excludes_file, var, value);
662 if (!strcmp(var, "core.whitespace")) {
663 if (!value)
664 return config_error_nonbool(var);
665 whitespace_rule_cfg = parse_whitespace_rule(value);
666 return 0;
669 if (!strcmp(var, "core.fsyncobjectfiles")) {
670 fsync_object_files = git_config_bool(var, value);
671 return 0;
674 if (!strcmp(var, "core.preloadindex")) {
675 core_preload_index = git_config_bool(var, value);
676 return 0;
679 if (!strcmp(var, "core.createobject")) {
680 if (!strcmp(value, "rename"))
681 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
682 else if (!strcmp(value, "link"))
683 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
684 else
685 die("Invalid mode for object creation: %s", value);
686 return 0;
689 if (!strcmp(var, "core.sparsecheckout")) {
690 core_apply_sparse_checkout = git_config_bool(var, value);
691 return 0;
694 /* Add other config variables here and to Documentation/config.txt. */
695 return 0;
698 static int git_default_user_config(const char *var, const char *value)
700 if (!strcmp(var, "user.name")) {
701 if (!value)
702 return config_error_nonbool(var);
703 strlcpy(git_default_name, value, sizeof(git_default_name));
704 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
705 return 0;
708 if (!strcmp(var, "user.email")) {
709 if (!value)
710 return config_error_nonbool(var);
711 strlcpy(git_default_email, value, sizeof(git_default_email));
712 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
713 return 0;
716 /* Add other config variables here and to Documentation/config.txt. */
717 return 0;
720 static int git_default_i18n_config(const char *var, const char *value)
722 if (!strcmp(var, "i18n.commitencoding"))
723 return git_config_string(&git_commit_encoding, var, value);
725 if (!strcmp(var, "i18n.logoutputencoding"))
726 return git_config_string(&git_log_output_encoding, var, value);
728 /* Add other config variables here and to Documentation/config.txt. */
729 return 0;
732 static int git_default_branch_config(const char *var, const char *value)
734 if (!strcmp(var, "branch.autosetupmerge")) {
735 if (value && !strcasecmp(value, "always")) {
736 git_branch_track = BRANCH_TRACK_ALWAYS;
737 return 0;
739 git_branch_track = git_config_bool(var, value);
740 return 0;
742 if (!strcmp(var, "branch.autosetuprebase")) {
743 if (!value)
744 return config_error_nonbool(var);
745 else if (!strcmp(value, "never"))
746 autorebase = AUTOREBASE_NEVER;
747 else if (!strcmp(value, "local"))
748 autorebase = AUTOREBASE_LOCAL;
749 else if (!strcmp(value, "remote"))
750 autorebase = AUTOREBASE_REMOTE;
751 else if (!strcmp(value, "always"))
752 autorebase = AUTOREBASE_ALWAYS;
753 else
754 return error("Malformed value for %s", var);
755 return 0;
758 /* Add other config variables here and to Documentation/config.txt. */
759 return 0;
762 static int git_default_push_config(const char *var, const char *value)
764 if (!strcmp(var, "push.default")) {
765 if (!value)
766 return config_error_nonbool(var);
767 else if (!strcmp(value, "nothing"))
768 push_default = PUSH_DEFAULT_NOTHING;
769 else if (!strcmp(value, "matching"))
770 push_default = PUSH_DEFAULT_MATCHING;
771 else if (!strcmp(value, "upstream"))
772 push_default = PUSH_DEFAULT_UPSTREAM;
773 else if (!strcmp(value, "tracking")) /* deprecated */
774 push_default = PUSH_DEFAULT_UPSTREAM;
775 else if (!strcmp(value, "current"))
776 push_default = PUSH_DEFAULT_CURRENT;
777 else {
778 error("Malformed value for %s: %s", var, value);
779 return error("Must be one of nothing, matching, "
780 "tracking or current.");
782 return 0;
785 /* Add other config variables here and to Documentation/config.txt. */
786 return 0;
789 static int git_default_mailmap_config(const char *var, const char *value)
791 if (!strcmp(var, "mailmap.file"))
792 return git_config_string(&git_mailmap_file, var, value);
794 /* Add other config variables here and to Documentation/config.txt. */
795 return 0;
798 int git_default_config(const char *var, const char *value, void *dummy)
800 if (!prefixcmp(var, "core."))
801 return git_default_core_config(var, value);
803 if (!prefixcmp(var, "user."))
804 return git_default_user_config(var, value);
806 if (!prefixcmp(var, "i18n."))
807 return git_default_i18n_config(var, value);
809 if (!prefixcmp(var, "branch."))
810 return git_default_branch_config(var, value);
812 if (!prefixcmp(var, "push."))
813 return git_default_push_config(var, value);
815 if (!prefixcmp(var, "mailmap."))
816 return git_default_mailmap_config(var, value);
818 if (!prefixcmp(var, "advice."))
819 return git_default_advice_config(var, value);
821 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
822 pager_use_color = git_config_bool(var,value);
823 return 0;
826 if (!strcmp(var, "pack.packsizelimit")) {
827 pack_size_limit_cfg = git_config_ulong(var, value);
828 return 0;
830 /* Add other config variables here and to Documentation/config.txt. */
831 return 0;
834 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
836 int ret;
837 FILE *f = fopen(filename, "r");
839 ret = -1;
840 if (f) {
841 config_file top;
843 /* push config-file parsing state stack */
844 top.prev = cf;
845 top.f = f;
846 top.name = filename;
847 top.linenr = 1;
848 top.eof = 0;
849 strbuf_init(&top.value, 1024);
850 cf = &top;
852 ret = git_parse_file(fn, data);
854 /* pop config-file parsing state stack */
855 strbuf_release(&top.value);
856 cf = top.prev;
858 fclose(f);
860 return ret;
863 const char *git_etc_gitconfig(void)
865 static const char *system_wide;
866 if (!system_wide)
867 system_wide = system_path(ETC_GITCONFIG);
868 return system_wide;
871 int git_env_bool(const char *k, int def)
873 const char *v = getenv(k);
874 return v ? git_config_bool(k, v) : def;
877 int git_config_system(void)
879 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
882 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
884 int ret = 0, found = 0;
885 const char *home = NULL;
887 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
888 if (config_exclusive_filename)
889 return git_config_from_file(fn, config_exclusive_filename, data);
890 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
891 ret += git_config_from_file(fn, git_etc_gitconfig(),
892 data);
893 found += 1;
896 home = getenv("HOME");
897 if (home) {
898 char buf[PATH_MAX];
899 char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
900 if (!access(user_config, R_OK)) {
901 ret += git_config_from_file(fn, user_config, data);
902 found += 1;
906 if (repo_config && !access(repo_config, R_OK)) {
907 ret += git_config_from_file(fn, repo_config, data);
908 found += 1;
911 switch (git_config_from_parameters(fn, data)) {
912 case -1: /* error */
913 die("unable to parse command-line config");
914 break;
915 case 0: /* found nothing */
916 break;
917 default: /* found at least one item */
918 found++;
919 break;
922 return ret == 0 ? found : ret;
925 int git_config(config_fn_t fn, void *data)
927 char *repo_config = NULL;
928 int ret;
930 repo_config = git_pathdup("config");
931 ret = git_config_early(fn, data, repo_config);
932 if (repo_config)
933 free(repo_config);
934 return ret;
938 * Find all the stuff for git_config_set() below.
941 #define MAX_MATCHES 512
943 static struct {
944 int baselen;
945 char *key;
946 int do_not_match;
947 regex_t *value_regex;
948 int multi_replace;
949 size_t offset[MAX_MATCHES];
950 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
951 int seen;
952 } store;
954 static int matches(const char *key, const char *value)
956 return !strcmp(key, store.key) &&
957 (store.value_regex == NULL ||
958 (store.do_not_match ^
959 !regexec(store.value_regex, value, 0, NULL, 0)));
962 static int store_aux(const char *key, const char *value, void *cb)
964 const char *ep;
965 size_t section_len;
966 FILE *f = cf->f;
968 switch (store.state) {
969 case KEY_SEEN:
970 if (matches(key, value)) {
971 if (store.seen == 1 && store.multi_replace == 0) {
972 warning("%s has multiple values", key);
973 } else if (store.seen >= MAX_MATCHES) {
974 error("too many matches for %s", key);
975 return 1;
978 store.offset[store.seen] = ftell(f);
979 store.seen++;
981 break;
982 case SECTION_SEEN:
984 * What we are looking for is in store.key (both
985 * section and var), and its section part is baselen
986 * long. We found key (again, both section and var).
987 * We would want to know if this key is in the same
988 * section as what we are looking for. We already
989 * know we are in the same section as what should
990 * hold store.key.
992 ep = strrchr(key, '.');
993 section_len = ep - key;
995 if ((section_len != store.baselen) ||
996 memcmp(key, store.key, section_len+1)) {
997 store.state = SECTION_END_SEEN;
998 break;
1002 * Do not increment matches: this is no match, but we
1003 * just made sure we are in the desired section.
1005 store.offset[store.seen] = ftell(f);
1006 /* fallthru */
1007 case SECTION_END_SEEN:
1008 case START:
1009 if (matches(key, value)) {
1010 store.offset[store.seen] = ftell(f);
1011 store.state = KEY_SEEN;
1012 store.seen++;
1013 } else {
1014 if (strrchr(key, '.') - key == store.baselen &&
1015 !strncmp(key, store.key, store.baselen)) {
1016 store.state = SECTION_SEEN;
1017 store.offset[store.seen] = ftell(f);
1021 return 0;
1024 static int write_error(const char *filename)
1026 error("failed to write new configuration file %s", filename);
1028 /* Same error code as "failed to rename". */
1029 return 4;
1032 static int store_write_section(int fd, const char *key)
1034 const char *dot;
1035 int i, success;
1036 struct strbuf sb = STRBUF_INIT;
1038 dot = memchr(key, '.', store.baselen);
1039 if (dot) {
1040 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1041 for (i = dot - key + 1; i < store.baselen; i++) {
1042 if (key[i] == '"' || key[i] == '\\')
1043 strbuf_addch(&sb, '\\');
1044 strbuf_addch(&sb, key[i]);
1046 strbuf_addstr(&sb, "\"]\n");
1047 } else {
1048 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1051 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1052 strbuf_release(&sb);
1054 return success;
1057 static int store_write_pair(int fd, const char *key, const char *value)
1059 int i, success;
1060 int length = strlen(key + store.baselen + 1);
1061 const char *quote = "";
1062 struct strbuf sb = STRBUF_INIT;
1065 * Check to see if the value needs to be surrounded with a dq pair.
1066 * Note that problematic characters are always backslash-quoted; this
1067 * check is about not losing leading or trailing SP and strings that
1068 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1069 * configuration parser.
1071 if (value[0] == ' ')
1072 quote = "\"";
1073 for (i = 0; value[i]; i++)
1074 if (value[i] == ';' || value[i] == '#')
1075 quote = "\"";
1076 if (i && value[i - 1] == ' ')
1077 quote = "\"";
1079 strbuf_addf(&sb, "\t%.*s = %s",
1080 length, key + store.baselen + 1, quote);
1082 for (i = 0; value[i]; i++)
1083 switch (value[i]) {
1084 case '\n':
1085 strbuf_addstr(&sb, "\\n");
1086 break;
1087 case '\t':
1088 strbuf_addstr(&sb, "\\t");
1089 break;
1090 case '"':
1091 case '\\':
1092 strbuf_addch(&sb, '\\');
1093 default:
1094 strbuf_addch(&sb, value[i]);
1095 break;
1097 strbuf_addf(&sb, "%s\n", quote);
1099 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1100 strbuf_release(&sb);
1102 return success;
1105 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1106 size_t offset_, int *found_bracket)
1108 size_t equal_offset = size, bracket_offset = size;
1109 ssize_t offset;
1111 contline:
1112 for (offset = offset_-2; offset > 0
1113 && contents[offset] != '\n'; offset--)
1114 switch (contents[offset]) {
1115 case '=': equal_offset = offset; break;
1116 case ']': bracket_offset = offset; break;
1118 if (offset > 0 && contents[offset-1] == '\\') {
1119 offset_ = offset;
1120 goto contline;
1122 if (bracket_offset < equal_offset) {
1123 *found_bracket = 1;
1124 offset = bracket_offset+1;
1125 } else
1126 offset++;
1128 return offset;
1131 int git_config_set_in_file(const char *config_filename,
1132 const char *key, const char *value)
1134 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1137 int git_config_set(const char *key, const char *value)
1139 return git_config_set_multivar(key, value, NULL, 0);
1143 * Auxiliary function to sanity-check and split the key into the section
1144 * identifier and variable name.
1146 * Returns 0 on success, -1 when there is an invalid character in the key and
1147 * -2 if there is no section name in the key.
1149 * store_key - pointer to char* which will hold a copy of the key with
1150 * lowercase section and variable name
1151 * baselen - pointer to int which will hold the length of the
1152 * section + subsection part, can be NULL
1154 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1156 int i, dot, baselen;
1157 const char *last_dot = strrchr(key, '.');
1160 * Since "key" actually contains the section name and the real
1161 * key name separated by a dot, we have to know where the dot is.
1164 if (last_dot == NULL || last_dot == key) {
1165 error("key does not contain a section: %s", key);
1166 return -CONFIG_NO_SECTION_OR_NAME;
1169 if (!last_dot[1]) {
1170 error("key does not contain variable name: %s", key);
1171 return -CONFIG_NO_SECTION_OR_NAME;
1174 baselen = last_dot - key;
1175 if (baselen_)
1176 *baselen_ = baselen;
1179 * Validate the key and while at it, lower case it for matching.
1181 *store_key = xmalloc(strlen(key) + 1);
1183 dot = 0;
1184 for (i = 0; key[i]; i++) {
1185 unsigned char c = key[i];
1186 if (c == '.')
1187 dot = 1;
1188 /* Leave the extended basename untouched.. */
1189 if (!dot || i > baselen) {
1190 if (!iskeychar(c) ||
1191 (i == baselen + 1 && !isalpha(c))) {
1192 error("invalid key: %s", key);
1193 goto out_free_ret_1;
1195 c = tolower(c);
1196 } else if (c == '\n') {
1197 error("invalid key (newline): %s", key);
1198 goto out_free_ret_1;
1200 (*store_key)[i] = c;
1202 (*store_key)[i] = 0;
1204 return 0;
1206 out_free_ret_1:
1207 free(*store_key);
1208 return -CONFIG_INVALID_KEY;
1212 * If value==NULL, unset in (remove from) config,
1213 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1214 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1215 * else all matching key/values (regardless how many) are removed,
1216 * before the new pair is written.
1218 * Returns 0 on success.
1220 * This function does this:
1222 * - it locks the config file by creating ".git/config.lock"
1224 * - it then parses the config using store_aux() as validator to find
1225 * the position on the key/value pair to replace. If it is to be unset,
1226 * it must be found exactly once.
1228 * - the config file is mmap()ed and the part before the match (if any) is
1229 * written to the lock file, then the changed part and the rest.
1231 * - the config file is removed and the lock file rename()d to it.
1234 int git_config_set_multivar_in_file(const char *config_filename,
1235 const char *key, const char *value,
1236 const char *value_regex, int multi_replace)
1238 int fd = -1, in_fd;
1239 int ret;
1240 struct lock_file *lock = NULL;
1242 /* parse-key returns negative; flip the sign to feed exit(3) */
1243 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1244 if (ret)
1245 goto out_free;
1247 store.multi_replace = multi_replace;
1251 * The lock serves a purpose in addition to locking: the new
1252 * contents of .git/config will be written into it.
1254 lock = xcalloc(sizeof(struct lock_file), 1);
1255 fd = hold_lock_file_for_update(lock, config_filename, 0);
1256 if (fd < 0) {
1257 error("could not lock config file %s: %s", config_filename, strerror(errno));
1258 free(store.key);
1259 ret = CONFIG_NO_LOCK;
1260 goto out_free;
1264 * If .git/config does not exist yet, write a minimal version.
1266 in_fd = open(config_filename, O_RDONLY);
1267 if ( in_fd < 0 ) {
1268 free(store.key);
1270 if ( ENOENT != errno ) {
1271 error("opening %s: %s", config_filename,
1272 strerror(errno));
1273 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1274 goto out_free;
1276 /* if nothing to unset, error out */
1277 if (value == NULL) {
1278 ret = CONFIG_NOTHING_SET;
1279 goto out_free;
1282 store.key = (char *)key;
1283 if (!store_write_section(fd, key) ||
1284 !store_write_pair(fd, key, value))
1285 goto write_err_out;
1286 } else {
1287 struct stat st;
1288 char *contents;
1289 size_t contents_sz, copy_begin, copy_end;
1290 int i, new_line = 0;
1292 if (value_regex == NULL)
1293 store.value_regex = NULL;
1294 else {
1295 if (value_regex[0] == '!') {
1296 store.do_not_match = 1;
1297 value_regex++;
1298 } else
1299 store.do_not_match = 0;
1301 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1302 if (regcomp(store.value_regex, value_regex,
1303 REG_EXTENDED)) {
1304 error("invalid pattern: %s", value_regex);
1305 free(store.value_regex);
1306 ret = CONFIG_INVALID_PATTERN;
1307 goto out_free;
1311 store.offset[0] = 0;
1312 store.state = START;
1313 store.seen = 0;
1316 * After this, store.offset will contain the *end* offset
1317 * of the last match, or remain at 0 if no match was found.
1318 * As a side effect, we make sure to transform only a valid
1319 * existing config file.
1321 if (git_config_from_file(store_aux, config_filename, NULL)) {
1322 error("invalid config file %s", config_filename);
1323 free(store.key);
1324 if (store.value_regex != NULL) {
1325 regfree(store.value_regex);
1326 free(store.value_regex);
1328 ret = CONFIG_INVALID_FILE;
1329 goto out_free;
1332 free(store.key);
1333 if (store.value_regex != NULL) {
1334 regfree(store.value_regex);
1335 free(store.value_regex);
1338 /* if nothing to unset, or too many matches, error out */
1339 if ((store.seen == 0 && value == NULL) ||
1340 (store.seen > 1 && multi_replace == 0)) {
1341 ret = CONFIG_NOTHING_SET;
1342 goto out_free;
1345 fstat(in_fd, &st);
1346 contents_sz = xsize_t(st.st_size);
1347 contents = xmmap(NULL, contents_sz, PROT_READ,
1348 MAP_PRIVATE, in_fd, 0);
1349 close(in_fd);
1351 if (store.seen == 0)
1352 store.seen = 1;
1354 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1355 if (store.offset[i] == 0) {
1356 store.offset[i] = copy_end = contents_sz;
1357 } else if (store.state != KEY_SEEN) {
1358 copy_end = store.offset[i];
1359 } else
1360 copy_end = find_beginning_of_line(
1361 contents, contents_sz,
1362 store.offset[i]-2, &new_line);
1364 if (copy_end > 0 && contents[copy_end-1] != '\n')
1365 new_line = 1;
1367 /* write the first part of the config */
1368 if (copy_end > copy_begin) {
1369 if (write_in_full(fd, contents + copy_begin,
1370 copy_end - copy_begin) <
1371 copy_end - copy_begin)
1372 goto write_err_out;
1373 if (new_line &&
1374 write_str_in_full(fd, "\n") != 1)
1375 goto write_err_out;
1377 copy_begin = store.offset[i];
1380 /* write the pair (value == NULL means unset) */
1381 if (value != NULL) {
1382 if (store.state == START) {
1383 if (!store_write_section(fd, key))
1384 goto write_err_out;
1386 if (!store_write_pair(fd, key, value))
1387 goto write_err_out;
1390 /* write the rest of the config */
1391 if (copy_begin < contents_sz)
1392 if (write_in_full(fd, contents + copy_begin,
1393 contents_sz - copy_begin) <
1394 contents_sz - copy_begin)
1395 goto write_err_out;
1397 munmap(contents, contents_sz);
1400 if (commit_lock_file(lock) < 0) {
1401 error("could not commit config file %s", config_filename);
1402 ret = CONFIG_NO_WRITE;
1403 goto out_free;
1407 * lock is committed, so don't try to roll it back below.
1408 * NOTE: Since lockfile.c keeps a linked list of all created
1409 * lock_file structures, it isn't safe to free(lock). It's
1410 * better to just leave it hanging around.
1412 lock = NULL;
1413 ret = 0;
1415 out_free:
1416 if (lock)
1417 rollback_lock_file(lock);
1418 return ret;
1420 write_err_out:
1421 ret = write_error(lock->filename);
1422 goto out_free;
1426 int git_config_set_multivar(const char *key, const char *value,
1427 const char *value_regex, int multi_replace)
1429 const char *config_filename;
1430 char *buf = NULL;
1431 int ret;
1433 if (config_exclusive_filename)
1434 config_filename = config_exclusive_filename;
1435 else
1436 config_filename = buf = git_pathdup("config");
1438 ret = git_config_set_multivar_in_file(config_filename, key, value,
1439 value_regex, multi_replace);
1440 free(buf);
1441 return ret;
1444 static int section_name_match (const char *buf, const char *name)
1446 int i = 0, j = 0, dot = 0;
1447 if (buf[i] != '[')
1448 return 0;
1449 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1450 if (!dot && isspace(buf[i])) {
1451 dot = 1;
1452 if (name[j++] != '.')
1453 break;
1454 for (i++; isspace(buf[i]); i++)
1455 ; /* do nothing */
1456 if (buf[i] != '"')
1457 break;
1458 continue;
1460 if (buf[i] == '\\' && dot)
1461 i++;
1462 else if (buf[i] == '"' && dot) {
1463 for (i++; isspace(buf[i]); i++)
1464 ; /* do_nothing */
1465 break;
1467 if (buf[i] != name[j++])
1468 break;
1470 if (buf[i] == ']' && name[j] == 0) {
1472 * We match, now just find the right length offset by
1473 * gobbling up any whitespace after it, as well
1475 i++;
1476 for (; buf[i] && isspace(buf[i]); i++)
1477 ; /* do nothing */
1478 return i;
1480 return 0;
1483 /* if new_name == NULL, the section is removed instead */
1484 int git_config_rename_section(const char *old_name, const char *new_name)
1486 int ret = 0, remove = 0;
1487 char *config_filename;
1488 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1489 int out_fd;
1490 char buf[1024];
1491 FILE *config_file;
1493 if (config_exclusive_filename)
1494 config_filename = xstrdup(config_exclusive_filename);
1495 else
1496 config_filename = git_pathdup("config");
1497 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1498 if (out_fd < 0) {
1499 ret = error("could not lock config file %s", config_filename);
1500 goto out;
1503 if (!(config_file = fopen(config_filename, "rb"))) {
1504 /* no config file means nothing to rename, no error */
1505 goto unlock_and_out;
1508 while (fgets(buf, sizeof(buf), config_file)) {
1509 int i;
1510 int length;
1511 char *output = buf;
1512 for (i = 0; buf[i] && isspace(buf[i]); i++)
1513 ; /* do nothing */
1514 if (buf[i] == '[') {
1515 /* it's a section */
1516 int offset = section_name_match(&buf[i], old_name);
1517 if (offset > 0) {
1518 ret++;
1519 if (new_name == NULL) {
1520 remove = 1;
1521 continue;
1523 store.baselen = strlen(new_name);
1524 if (!store_write_section(out_fd, new_name)) {
1525 ret = write_error(lock->filename);
1526 goto out;
1529 * We wrote out the new section, with
1530 * a newline, now skip the old
1531 * section's length
1533 output += offset + i;
1534 if (strlen(output) > 0) {
1536 * More content means there's
1537 * a declaration to put on the
1538 * next line; indent with a
1539 * tab
1541 output -= 1;
1542 output[0] = '\t';
1545 remove = 0;
1547 if (remove)
1548 continue;
1549 length = strlen(output);
1550 if (write_in_full(out_fd, output, length) != length) {
1551 ret = write_error(lock->filename);
1552 goto out;
1555 fclose(config_file);
1556 unlock_and_out:
1557 if (commit_lock_file(lock) < 0)
1558 ret = error("could not commit config file %s", config_filename);
1559 out:
1560 free(config_filename);
1561 return ret;
1565 * Call this to report error for your variable that should not
1566 * get a boolean value (i.e. "[my] var" means "true").
1568 int config_error_nonbool(const char *var)
1570 return error("Missing value for '%s'", var);