Update draft release notes
[git/git-svn.git] / config.c
blob7a85ebdbae79cf13305ebc821fafcd21a67c16d4
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 typedef struct config_file {
14 struct config_file *prev;
15 FILE *f;
16 const char *name;
17 int linenr;
18 int eof;
19 struct strbuf value;
20 struct strbuf var;
21 } config_file;
23 static config_file *cf;
25 static int zlib_compression_seen;
27 #define MAX_INCLUDE_DEPTH 10
28 static const char include_depth_advice[] =
29 "exceeded maximum include depth (%d) while including\n"
30 " %s\n"
31 "from\n"
32 " %s\n"
33 "Do you have circular includes?";
34 static int handle_path_include(const char *path, struct config_include_data *inc)
36 int ret = 0;
37 struct strbuf buf = STRBUF_INIT;
38 char *expanded = expand_user_path(path);
40 if (!expanded)
41 return error("Could not expand include path '%s'", path);
42 path = expanded;
45 * Use an absolute path as-is, but interpret relative paths
46 * based on the including config file.
48 if (!is_absolute_path(path)) {
49 char *slash;
51 if (!cf || !cf->name)
52 return error("relative config includes must come from files");
54 slash = find_last_dir_sep(cf->name);
55 if (slash)
56 strbuf_add(&buf, cf->name, slash - cf->name + 1);
57 strbuf_addstr(&buf, path);
58 path = buf.buf;
61 if (!access_or_die(path, R_OK, 0)) {
62 if (++inc->depth > MAX_INCLUDE_DEPTH)
63 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
64 cf && cf->name ? cf->name : "the command line");
65 ret = git_config_from_file(git_config_include, path, inc);
66 inc->depth--;
68 strbuf_release(&buf);
69 free(expanded);
70 return ret;
73 int git_config_include(const char *var, const char *value, void *data)
75 struct config_include_data *inc = data;
76 const char *type;
77 int ret;
80 * Pass along all values, including "include" directives; this makes it
81 * possible to query information on the includes themselves.
83 ret = inc->fn(var, value, inc->data);
84 if (ret < 0)
85 return ret;
87 type = skip_prefix(var, "include.");
88 if (!type)
89 return ret;
91 if (!strcmp(type, "path"))
92 ret = handle_path_include(value, inc);
93 return ret;
96 static void lowercase(char *p)
98 for (; *p; p++)
99 *p = tolower(*p);
102 void git_config_push_parameter(const char *text)
104 struct strbuf env = STRBUF_INIT;
105 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
106 if (old) {
107 strbuf_addstr(&env, old);
108 strbuf_addch(&env, ' ');
110 sq_quote_buf(&env, text);
111 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
112 strbuf_release(&env);
115 int git_config_parse_parameter(const char *text,
116 config_fn_t fn, void *data)
118 struct strbuf **pair;
119 pair = strbuf_split_str(text, '=', 2);
120 if (!pair[0])
121 return error("bogus config parameter: %s", text);
122 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
123 strbuf_setlen(pair[0], pair[0]->len - 1);
124 strbuf_trim(pair[0]);
125 if (!pair[0]->len) {
126 strbuf_list_free(pair);
127 return error("bogus config parameter: %s", text);
129 lowercase(pair[0]->buf);
130 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
131 strbuf_list_free(pair);
132 return -1;
134 strbuf_list_free(pair);
135 return 0;
138 int git_config_from_parameters(config_fn_t fn, void *data)
140 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
141 char *envw;
142 const char **argv = NULL;
143 int nr = 0, alloc = 0;
144 int i;
146 if (!env)
147 return 0;
148 /* sq_dequote will write over it */
149 envw = xstrdup(env);
151 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
152 free(envw);
153 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
156 for (i = 0; i < nr; i++) {
157 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
158 free(argv);
159 free(envw);
160 return -1;
164 free(argv);
165 free(envw);
166 return nr > 0;
169 static int get_next_char(void)
171 int c;
172 FILE *f;
174 c = '\n';
175 if (cf && ((f = cf->f) != NULL)) {
176 c = fgetc(f);
177 if (c == '\r') {
178 /* DOS like systems */
179 c = fgetc(f);
180 if (c != '\n') {
181 ungetc(c, f);
182 c = '\r';
185 if (c == '\n')
186 cf->linenr++;
187 if (c == EOF) {
188 cf->eof = 1;
189 c = '\n';
192 return c;
195 static char *parse_value(void)
197 int quote = 0, comment = 0, space = 0;
199 strbuf_reset(&cf->value);
200 for (;;) {
201 int c = get_next_char();
202 if (c == '\n') {
203 if (quote) {
204 cf->linenr--;
205 return NULL;
207 return cf->value.buf;
209 if (comment)
210 continue;
211 if (isspace(c) && !quote) {
212 if (cf->value.len)
213 space++;
214 continue;
216 if (!quote) {
217 if (c == ';' || c == '#') {
218 comment = 1;
219 continue;
222 for (; space; space--)
223 strbuf_addch(&cf->value, ' ');
224 if (c == '\\') {
225 c = get_next_char();
226 switch (c) {
227 case '\n':
228 continue;
229 case 't':
230 c = '\t';
231 break;
232 case 'b':
233 c = '\b';
234 break;
235 case 'n':
236 c = '\n';
237 break;
238 /* Some characters escape as themselves */
239 case '\\': case '"':
240 break;
241 /* Reject unknown escape sequences */
242 default:
243 return NULL;
245 strbuf_addch(&cf->value, c);
246 continue;
248 if (c == '"') {
249 quote = 1-quote;
250 continue;
252 strbuf_addch(&cf->value, c);
256 static inline int iskeychar(int c)
258 return isalnum(c) || c == '-';
261 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
263 int c;
264 char *value;
266 /* Get the full name */
267 for (;;) {
268 c = get_next_char();
269 if (cf->eof)
270 break;
271 if (!iskeychar(c))
272 break;
273 strbuf_addch(name, tolower(c));
276 while (c == ' ' || c == '\t')
277 c = get_next_char();
279 value = NULL;
280 if (c != '\n') {
281 if (c != '=')
282 return -1;
283 value = parse_value();
284 if (!value)
285 return -1;
287 return fn(name->buf, value, data);
290 static int get_extended_base_var(struct strbuf *name, int c)
292 do {
293 if (c == '\n')
294 goto error_incomplete_line;
295 c = get_next_char();
296 } while (isspace(c));
298 /* We require the format to be '[base "extension"]' */
299 if (c != '"')
300 return -1;
301 strbuf_addch(name, '.');
303 for (;;) {
304 int c = get_next_char();
305 if (c == '\n')
306 goto error_incomplete_line;
307 if (c == '"')
308 break;
309 if (c == '\\') {
310 c = get_next_char();
311 if (c == '\n')
312 goto error_incomplete_line;
314 strbuf_addch(name, c);
317 /* Final ']' */
318 if (get_next_char() != ']')
319 return -1;
320 return 0;
321 error_incomplete_line:
322 cf->linenr--;
323 return -1;
326 static int get_base_var(struct strbuf *name)
328 for (;;) {
329 int c = get_next_char();
330 if (cf->eof)
331 return -1;
332 if (c == ']')
333 return 0;
334 if (isspace(c))
335 return get_extended_base_var(name, c);
336 if (!iskeychar(c) && c != '.')
337 return -1;
338 strbuf_addch(name, tolower(c));
342 static int git_parse_file(config_fn_t fn, void *data)
344 int comment = 0;
345 int baselen = 0;
346 struct strbuf *var = &cf->var;
348 /* U+FEFF Byte Order Mark in UTF8 */
349 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
350 const unsigned char *bomptr = utf8_bom;
352 for (;;) {
353 int c = get_next_char();
354 if (bomptr && *bomptr) {
355 /* We are at the file beginning; skip UTF8-encoded BOM
356 * if present. Sane editors won't put this in on their
357 * own, but e.g. Windows Notepad will do it happily. */
358 if ((unsigned char) c == *bomptr) {
359 bomptr++;
360 continue;
361 } else {
362 /* Do not tolerate partial BOM. */
363 if (bomptr != utf8_bom)
364 break;
365 /* No BOM at file beginning. Cool. */
366 bomptr = NULL;
369 if (c == '\n') {
370 if (cf->eof)
371 return 0;
372 comment = 0;
373 continue;
375 if (comment || isspace(c))
376 continue;
377 if (c == '#' || c == ';') {
378 comment = 1;
379 continue;
381 if (c == '[') {
382 /* Reset prior to determining a new stem */
383 strbuf_reset(var);
384 if (get_base_var(var) < 0 || var->len < 1)
385 break;
386 strbuf_addch(var, '.');
387 baselen = var->len;
388 continue;
390 if (!isalpha(c))
391 break;
393 * Truncate the var name back to the section header
394 * stem prior to grabbing the suffix part of the name
395 * and the value.
397 strbuf_setlen(var, baselen);
398 strbuf_addch(var, tolower(c));
399 if (get_value(fn, data, var) < 0)
400 break;
402 die("bad config file line %d in %s", cf->linenr, cf->name);
405 static int parse_unit_factor(const char *end, uintmax_t *val)
407 if (!*end)
408 return 1;
409 else if (!strcasecmp(end, "k")) {
410 *val *= 1024;
411 return 1;
413 else if (!strcasecmp(end, "m")) {
414 *val *= 1024 * 1024;
415 return 1;
417 else if (!strcasecmp(end, "g")) {
418 *val *= 1024 * 1024 * 1024;
419 return 1;
421 return 0;
424 static int git_parse_long(const char *value, long *ret)
426 if (value && *value) {
427 char *end;
428 intmax_t val;
429 uintmax_t uval;
430 uintmax_t factor = 1;
432 errno = 0;
433 val = strtoimax(value, &end, 0);
434 if (errno == ERANGE)
435 return 0;
436 if (!parse_unit_factor(end, &factor))
437 return 0;
438 uval = abs(val);
439 uval *= factor;
440 if ((uval > maximum_signed_value_of_type(long)) ||
441 (abs(val) > uval))
442 return 0;
443 val *= factor;
444 *ret = val;
445 return 1;
447 return 0;
450 int git_parse_ulong(const char *value, unsigned long *ret)
452 if (value && *value) {
453 char *end;
454 uintmax_t val;
455 uintmax_t oldval;
457 errno = 0;
458 val = strtoumax(value, &end, 0);
459 if (errno == ERANGE)
460 return 0;
461 oldval = val;
462 if (!parse_unit_factor(end, &val))
463 return 0;
464 if ((val > maximum_unsigned_value_of_type(long)) ||
465 (oldval > val))
466 return 0;
467 *ret = val;
468 return 1;
470 return 0;
473 static void die_bad_config(const char *name)
475 if (cf && cf->name)
476 die("bad config value for '%s' in %s", name, cf->name);
477 die("bad config value for '%s'", name);
480 int git_config_int(const char *name, const char *value)
482 long ret = 0;
483 if (!git_parse_long(value, &ret))
484 die_bad_config(name);
485 return ret;
488 unsigned long git_config_ulong(const char *name, const char *value)
490 unsigned long ret;
491 if (!git_parse_ulong(value, &ret))
492 die_bad_config(name);
493 return ret;
496 static int git_config_maybe_bool_text(const char *name, const char *value)
498 if (!value)
499 return 1;
500 if (!*value)
501 return 0;
502 if (!strcasecmp(value, "true")
503 || !strcasecmp(value, "yes")
504 || !strcasecmp(value, "on"))
505 return 1;
506 if (!strcasecmp(value, "false")
507 || !strcasecmp(value, "no")
508 || !strcasecmp(value, "off"))
509 return 0;
510 return -1;
513 int git_config_maybe_bool(const char *name, const char *value)
515 long v = git_config_maybe_bool_text(name, value);
516 if (0 <= v)
517 return v;
518 if (git_parse_long(value, &v))
519 return !!v;
520 return -1;
523 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
525 int v = git_config_maybe_bool_text(name, value);
526 if (0 <= v) {
527 *is_bool = 1;
528 return v;
530 *is_bool = 0;
531 return git_config_int(name, value);
534 int git_config_bool(const char *name, const char *value)
536 int discard;
537 return !!git_config_bool_or_int(name, value, &discard);
540 int git_config_string(const char **dest, const char *var, const char *value)
542 if (!value)
543 return config_error_nonbool(var);
544 *dest = xstrdup(value);
545 return 0;
548 int git_config_pathname(const char **dest, const char *var, const char *value)
550 if (!value)
551 return config_error_nonbool(var);
552 *dest = expand_user_path(value);
553 if (!*dest)
554 die("Failed to expand user dir in: '%s'", value);
555 return 0;
558 static int git_default_core_config(const char *var, const char *value)
560 /* This needs a better name */
561 if (!strcmp(var, "core.filemode")) {
562 trust_executable_bit = git_config_bool(var, value);
563 return 0;
565 if (!strcmp(var, "core.trustctime")) {
566 trust_ctime = git_config_bool(var, value);
567 return 0;
569 if (!strcmp(var, "core.statinfo") ||
570 !strcmp(var, "core.checkstat")) {
572 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
573 * never been advertised. we will remove it at Git
574 * 2.0 boundary.
576 if (!strcmp(var, "core.statinfo")) {
577 static int warned;
578 if (!warned++) {
579 warning("'core.statinfo' will be removed in Git 2.0; "
580 "use 'core.checkstat' instead.");
583 if (!strcasecmp(value, "default"))
584 check_stat = 1;
585 else if (!strcasecmp(value, "minimal"))
586 check_stat = 0;
589 if (!strcmp(var, "core.quotepath")) {
590 quote_path_fully = git_config_bool(var, value);
591 return 0;
594 if (!strcmp(var, "core.symlinks")) {
595 has_symlinks = git_config_bool(var, value);
596 return 0;
599 if (!strcmp(var, "core.ignorecase")) {
600 ignore_case = git_config_bool(var, value);
601 return 0;
604 if (!strcmp(var, "core.attributesfile"))
605 return git_config_pathname(&git_attributes_file, var, value);
607 if (!strcmp(var, "core.bare")) {
608 is_bare_repository_cfg = git_config_bool(var, value);
609 return 0;
612 if (!strcmp(var, "core.ignorestat")) {
613 assume_unchanged = git_config_bool(var, value);
614 return 0;
617 if (!strcmp(var, "core.prefersymlinkrefs")) {
618 prefer_symlink_refs = git_config_bool(var, value);
619 return 0;
622 if (!strcmp(var, "core.logallrefupdates")) {
623 log_all_ref_updates = git_config_bool(var, value);
624 return 0;
627 if (!strcmp(var, "core.warnambiguousrefs")) {
628 warn_ambiguous_refs = git_config_bool(var, value);
629 return 0;
632 if (!strcmp(var, "core.abbrev")) {
633 int abbrev = git_config_int(var, value);
634 if (abbrev < minimum_abbrev || abbrev > 40)
635 return -1;
636 default_abbrev = abbrev;
637 return 0;
640 if (!strcmp(var, "core.loosecompression")) {
641 int level = git_config_int(var, value);
642 if (level == -1)
643 level = Z_DEFAULT_COMPRESSION;
644 else if (level < 0 || level > Z_BEST_COMPRESSION)
645 die("bad zlib compression level %d", level);
646 zlib_compression_level = level;
647 zlib_compression_seen = 1;
648 return 0;
651 if (!strcmp(var, "core.compression")) {
652 int level = git_config_int(var, value);
653 if (level == -1)
654 level = Z_DEFAULT_COMPRESSION;
655 else if (level < 0 || level > Z_BEST_COMPRESSION)
656 die("bad zlib compression level %d", level);
657 core_compression_level = level;
658 core_compression_seen = 1;
659 if (!zlib_compression_seen)
660 zlib_compression_level = level;
661 return 0;
664 if (!strcmp(var, "core.packedgitwindowsize")) {
665 int pgsz_x2 = getpagesize() * 2;
666 packed_git_window_size = git_config_ulong(var, value);
668 /* This value must be multiple of (pagesize * 2) */
669 packed_git_window_size /= pgsz_x2;
670 if (packed_git_window_size < 1)
671 packed_git_window_size = 1;
672 packed_git_window_size *= pgsz_x2;
673 return 0;
676 if (!strcmp(var, "core.bigfilethreshold")) {
677 big_file_threshold = git_config_ulong(var, value);
678 return 0;
681 if (!strcmp(var, "core.packedgitlimit")) {
682 packed_git_limit = git_config_ulong(var, value);
683 return 0;
686 if (!strcmp(var, "core.deltabasecachelimit")) {
687 delta_base_cache_limit = git_config_ulong(var, value);
688 return 0;
691 if (!strcmp(var, "core.logpackaccess"))
692 return git_config_string(&log_pack_access, var, value);
694 if (!strcmp(var, "core.autocrlf")) {
695 if (value && !strcasecmp(value, "input")) {
696 if (core_eol == EOL_CRLF)
697 return error("core.autocrlf=input conflicts with core.eol=crlf");
698 auto_crlf = AUTO_CRLF_INPUT;
699 return 0;
701 auto_crlf = git_config_bool(var, value);
702 return 0;
705 if (!strcmp(var, "core.safecrlf")) {
706 if (value && !strcasecmp(value, "warn")) {
707 safe_crlf = SAFE_CRLF_WARN;
708 return 0;
710 safe_crlf = git_config_bool(var, value);
711 return 0;
714 if (!strcmp(var, "core.eol")) {
715 if (value && !strcasecmp(value, "lf"))
716 core_eol = EOL_LF;
717 else if (value && !strcasecmp(value, "crlf"))
718 core_eol = EOL_CRLF;
719 else if (value && !strcasecmp(value, "native"))
720 core_eol = EOL_NATIVE;
721 else
722 core_eol = EOL_UNSET;
723 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
724 return error("core.autocrlf=input conflicts with core.eol=crlf");
725 return 0;
728 if (!strcmp(var, "core.notesref")) {
729 notes_ref_name = xstrdup(value);
730 return 0;
733 if (!strcmp(var, "core.pager"))
734 return git_config_string(&pager_program, var, value);
736 if (!strcmp(var, "core.editor"))
737 return git_config_string(&editor_program, var, value);
739 if (!strcmp(var, "core.commentchar")) {
740 const char *comment;
741 int ret = git_config_string(&comment, var, value);
742 if (!ret)
743 comment_line_char = comment[0];
744 return ret;
747 if (!strcmp(var, "core.askpass"))
748 return git_config_string(&askpass_program, var, value);
750 if (!strcmp(var, "core.excludesfile"))
751 return git_config_pathname(&excludes_file, var, value);
753 if (!strcmp(var, "core.whitespace")) {
754 if (!value)
755 return config_error_nonbool(var);
756 whitespace_rule_cfg = parse_whitespace_rule(value);
757 return 0;
760 if (!strcmp(var, "core.fsyncobjectfiles")) {
761 fsync_object_files = git_config_bool(var, value);
762 return 0;
765 if (!strcmp(var, "core.preloadindex")) {
766 core_preload_index = git_config_bool(var, value);
767 return 0;
770 if (!strcmp(var, "core.createobject")) {
771 if (!strcmp(value, "rename"))
772 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
773 else if (!strcmp(value, "link"))
774 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
775 else
776 die("Invalid mode for object creation: %s", value);
777 return 0;
780 if (!strcmp(var, "core.sparsecheckout")) {
781 core_apply_sparse_checkout = git_config_bool(var, value);
782 return 0;
785 if (!strcmp(var, "core.precomposeunicode")) {
786 precomposed_unicode = git_config_bool(var, value);
787 return 0;
790 /* Add other config variables here and to Documentation/config.txt. */
791 return 0;
794 static int git_default_i18n_config(const char *var, const char *value)
796 if (!strcmp(var, "i18n.commitencoding"))
797 return git_config_string(&git_commit_encoding, var, value);
799 if (!strcmp(var, "i18n.logoutputencoding"))
800 return git_config_string(&git_log_output_encoding, var, value);
802 /* Add other config variables here and to Documentation/config.txt. */
803 return 0;
806 static int git_default_branch_config(const char *var, const char *value)
808 if (!strcmp(var, "branch.autosetupmerge")) {
809 if (value && !strcasecmp(value, "always")) {
810 git_branch_track = BRANCH_TRACK_ALWAYS;
811 return 0;
813 git_branch_track = git_config_bool(var, value);
814 return 0;
816 if (!strcmp(var, "branch.autosetuprebase")) {
817 if (!value)
818 return config_error_nonbool(var);
819 else if (!strcmp(value, "never"))
820 autorebase = AUTOREBASE_NEVER;
821 else if (!strcmp(value, "local"))
822 autorebase = AUTOREBASE_LOCAL;
823 else if (!strcmp(value, "remote"))
824 autorebase = AUTOREBASE_REMOTE;
825 else if (!strcmp(value, "always"))
826 autorebase = AUTOREBASE_ALWAYS;
827 else
828 return error("Malformed value for %s", var);
829 return 0;
832 /* Add other config variables here and to Documentation/config.txt. */
833 return 0;
836 static int git_default_push_config(const char *var, const char *value)
838 if (!strcmp(var, "push.default")) {
839 if (!value)
840 return config_error_nonbool(var);
841 else if (!strcmp(value, "nothing"))
842 push_default = PUSH_DEFAULT_NOTHING;
843 else if (!strcmp(value, "matching"))
844 push_default = PUSH_DEFAULT_MATCHING;
845 else if (!strcmp(value, "simple"))
846 push_default = PUSH_DEFAULT_SIMPLE;
847 else if (!strcmp(value, "upstream"))
848 push_default = PUSH_DEFAULT_UPSTREAM;
849 else if (!strcmp(value, "tracking")) /* deprecated */
850 push_default = PUSH_DEFAULT_UPSTREAM;
851 else if (!strcmp(value, "current"))
852 push_default = PUSH_DEFAULT_CURRENT;
853 else {
854 error("Malformed value for %s: %s", var, value);
855 return error("Must be one of nothing, matching, simple, "
856 "upstream or current.");
858 return 0;
861 /* Add other config variables here and to Documentation/config.txt. */
862 return 0;
865 static int git_default_mailmap_config(const char *var, const char *value)
867 if (!strcmp(var, "mailmap.file"))
868 return git_config_string(&git_mailmap_file, var, value);
869 if (!strcmp(var, "mailmap.blob"))
870 return git_config_string(&git_mailmap_blob, var, value);
872 /* Add other config variables here and to Documentation/config.txt. */
873 return 0;
876 int git_default_config(const char *var, const char *value, void *dummy)
878 if (!prefixcmp(var, "core."))
879 return git_default_core_config(var, value);
881 if (!prefixcmp(var, "user."))
882 return git_ident_config(var, value, dummy);
884 if (!prefixcmp(var, "i18n."))
885 return git_default_i18n_config(var, value);
887 if (!prefixcmp(var, "branch."))
888 return git_default_branch_config(var, value);
890 if (!prefixcmp(var, "push."))
891 return git_default_push_config(var, value);
893 if (!prefixcmp(var, "mailmap."))
894 return git_default_mailmap_config(var, value);
896 if (!prefixcmp(var, "advice."))
897 return git_default_advice_config(var, value);
899 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
900 pager_use_color = git_config_bool(var,value);
901 return 0;
904 if (!strcmp(var, "pack.packsizelimit")) {
905 pack_size_limit_cfg = git_config_ulong(var, value);
906 return 0;
908 /* Add other config variables here and to Documentation/config.txt. */
909 return 0;
912 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
914 int ret;
915 FILE *f = fopen(filename, "r");
917 ret = -1;
918 if (f) {
919 config_file top;
921 /* push config-file parsing state stack */
922 top.prev = cf;
923 top.f = f;
924 top.name = filename;
925 top.linenr = 1;
926 top.eof = 0;
927 strbuf_init(&top.value, 1024);
928 strbuf_init(&top.var, 1024);
929 cf = &top;
931 ret = git_parse_file(fn, data);
933 /* pop config-file parsing state stack */
934 strbuf_release(&top.value);
935 strbuf_release(&top.var);
936 cf = top.prev;
938 fclose(f);
940 return ret;
943 const char *git_etc_gitconfig(void)
945 static const char *system_wide;
946 if (!system_wide)
947 system_wide = system_path(ETC_GITCONFIG);
948 return system_wide;
951 int git_env_bool(const char *k, int def)
953 const char *v = getenv(k);
954 return v ? git_config_bool(k, v) : def;
957 int git_config_system(void)
959 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
962 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
964 int ret = 0, found = 0;
965 char *xdg_config = NULL;
966 char *user_config = NULL;
968 home_config_paths(&user_config, &xdg_config, "config");
970 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
971 ret += git_config_from_file(fn, git_etc_gitconfig(),
972 data);
973 found += 1;
976 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
977 ret += git_config_from_file(fn, xdg_config, data);
978 found += 1;
981 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
982 ret += git_config_from_file(fn, user_config, data);
983 found += 1;
986 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
987 ret += git_config_from_file(fn, repo_config, data);
988 found += 1;
991 switch (git_config_from_parameters(fn, data)) {
992 case -1: /* error */
993 die("unable to parse command-line config");
994 break;
995 case 0: /* found nothing */
996 break;
997 default: /* found at least one item */
998 found++;
999 break;
1002 free(xdg_config);
1003 free(user_config);
1004 return ret == 0 ? found : ret;
1007 int git_config_with_options(config_fn_t fn, void *data,
1008 const char *filename, int respect_includes)
1010 char *repo_config = NULL;
1011 int ret;
1012 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1014 if (respect_includes) {
1015 inc.fn = fn;
1016 inc.data = data;
1017 fn = git_config_include;
1018 data = &inc;
1022 * If we have a specific filename, use it. Otherwise, follow the
1023 * regular lookup sequence.
1025 if (filename)
1026 return git_config_from_file(fn, filename, data);
1028 repo_config = git_pathdup("config");
1029 ret = git_config_early(fn, data, repo_config);
1030 if (repo_config)
1031 free(repo_config);
1032 return ret;
1035 int git_config(config_fn_t fn, void *data)
1037 return git_config_with_options(fn, data, NULL, 1);
1041 * Find all the stuff for git_config_set() below.
1044 #define MAX_MATCHES 512
1046 static struct {
1047 int baselen;
1048 char *key;
1049 int do_not_match;
1050 regex_t *value_regex;
1051 int multi_replace;
1052 size_t offset[MAX_MATCHES];
1053 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1054 int seen;
1055 } store;
1057 static int matches(const char *key, const char *value)
1059 return !strcmp(key, store.key) &&
1060 (store.value_regex == NULL ||
1061 (store.do_not_match ^
1062 !regexec(store.value_regex, value, 0, NULL, 0)));
1065 static int store_aux(const char *key, const char *value, void *cb)
1067 const char *ep;
1068 size_t section_len;
1069 FILE *f = cf->f;
1071 switch (store.state) {
1072 case KEY_SEEN:
1073 if (matches(key, value)) {
1074 if (store.seen == 1 && store.multi_replace == 0) {
1075 warning("%s has multiple values", key);
1076 } else if (store.seen >= MAX_MATCHES) {
1077 error("too many matches for %s", key);
1078 return 1;
1081 store.offset[store.seen] = ftell(f);
1082 store.seen++;
1084 break;
1085 case SECTION_SEEN:
1087 * What we are looking for is in store.key (both
1088 * section and var), and its section part is baselen
1089 * long. We found key (again, both section and var).
1090 * We would want to know if this key is in the same
1091 * section as what we are looking for. We already
1092 * know we are in the same section as what should
1093 * hold store.key.
1095 ep = strrchr(key, '.');
1096 section_len = ep - key;
1098 if ((section_len != store.baselen) ||
1099 memcmp(key, store.key, section_len+1)) {
1100 store.state = SECTION_END_SEEN;
1101 break;
1105 * Do not increment matches: this is no match, but we
1106 * just made sure we are in the desired section.
1108 store.offset[store.seen] = ftell(f);
1109 /* fallthru */
1110 case SECTION_END_SEEN:
1111 case START:
1112 if (matches(key, value)) {
1113 store.offset[store.seen] = ftell(f);
1114 store.state = KEY_SEEN;
1115 store.seen++;
1116 } else {
1117 if (strrchr(key, '.') - key == store.baselen &&
1118 !strncmp(key, store.key, store.baselen)) {
1119 store.state = SECTION_SEEN;
1120 store.offset[store.seen] = ftell(f);
1124 return 0;
1127 static int write_error(const char *filename)
1129 error("failed to write new configuration file %s", filename);
1131 /* Same error code as "failed to rename". */
1132 return 4;
1135 static int store_write_section(int fd, const char *key)
1137 const char *dot;
1138 int i, success;
1139 struct strbuf sb = STRBUF_INIT;
1141 dot = memchr(key, '.', store.baselen);
1142 if (dot) {
1143 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1144 for (i = dot - key + 1; i < store.baselen; i++) {
1145 if (key[i] == '"' || key[i] == '\\')
1146 strbuf_addch(&sb, '\\');
1147 strbuf_addch(&sb, key[i]);
1149 strbuf_addstr(&sb, "\"]\n");
1150 } else {
1151 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1154 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1155 strbuf_release(&sb);
1157 return success;
1160 static int store_write_pair(int fd, const char *key, const char *value)
1162 int i, success;
1163 int length = strlen(key + store.baselen + 1);
1164 const char *quote = "";
1165 struct strbuf sb = STRBUF_INIT;
1168 * Check to see if the value needs to be surrounded with a dq pair.
1169 * Note that problematic characters are always backslash-quoted; this
1170 * check is about not losing leading or trailing SP and strings that
1171 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1172 * configuration parser.
1174 if (value[0] == ' ')
1175 quote = "\"";
1176 for (i = 0; value[i]; i++)
1177 if (value[i] == ';' || value[i] == '#')
1178 quote = "\"";
1179 if (i && value[i - 1] == ' ')
1180 quote = "\"";
1182 strbuf_addf(&sb, "\t%.*s = %s",
1183 length, key + store.baselen + 1, quote);
1185 for (i = 0; value[i]; i++)
1186 switch (value[i]) {
1187 case '\n':
1188 strbuf_addstr(&sb, "\\n");
1189 break;
1190 case '\t':
1191 strbuf_addstr(&sb, "\\t");
1192 break;
1193 case '"':
1194 case '\\':
1195 strbuf_addch(&sb, '\\');
1196 default:
1197 strbuf_addch(&sb, value[i]);
1198 break;
1200 strbuf_addf(&sb, "%s\n", quote);
1202 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1203 strbuf_release(&sb);
1205 return success;
1208 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1209 size_t offset_, int *found_bracket)
1211 size_t equal_offset = size, bracket_offset = size;
1212 ssize_t offset;
1214 contline:
1215 for (offset = offset_-2; offset > 0
1216 && contents[offset] != '\n'; offset--)
1217 switch (contents[offset]) {
1218 case '=': equal_offset = offset; break;
1219 case ']': bracket_offset = offset; break;
1221 if (offset > 0 && contents[offset-1] == '\\') {
1222 offset_ = offset;
1223 goto contline;
1225 if (bracket_offset < equal_offset) {
1226 *found_bracket = 1;
1227 offset = bracket_offset+1;
1228 } else
1229 offset++;
1231 return offset;
1234 int git_config_set_in_file(const char *config_filename,
1235 const char *key, const char *value)
1237 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1240 int git_config_set(const char *key, const char *value)
1242 return git_config_set_multivar(key, value, NULL, 0);
1246 * Auxiliary function to sanity-check and split the key into the section
1247 * identifier and variable name.
1249 * Returns 0 on success, -1 when there is an invalid character in the key and
1250 * -2 if there is no section name in the key.
1252 * store_key - pointer to char* which will hold a copy of the key with
1253 * lowercase section and variable name
1254 * baselen - pointer to int which will hold the length of the
1255 * section + subsection part, can be NULL
1257 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1259 int i, dot, baselen;
1260 const char *last_dot = strrchr(key, '.');
1263 * Since "key" actually contains the section name and the real
1264 * key name separated by a dot, we have to know where the dot is.
1267 if (last_dot == NULL || last_dot == key) {
1268 error("key does not contain a section: %s", key);
1269 return -CONFIG_NO_SECTION_OR_NAME;
1272 if (!last_dot[1]) {
1273 error("key does not contain variable name: %s", key);
1274 return -CONFIG_NO_SECTION_OR_NAME;
1277 baselen = last_dot - key;
1278 if (baselen_)
1279 *baselen_ = baselen;
1282 * Validate the key and while at it, lower case it for matching.
1284 *store_key = xmalloc(strlen(key) + 1);
1286 dot = 0;
1287 for (i = 0; key[i]; i++) {
1288 unsigned char c = key[i];
1289 if (c == '.')
1290 dot = 1;
1291 /* Leave the extended basename untouched.. */
1292 if (!dot || i > baselen) {
1293 if (!iskeychar(c) ||
1294 (i == baselen + 1 && !isalpha(c))) {
1295 error("invalid key: %s", key);
1296 goto out_free_ret_1;
1298 c = tolower(c);
1299 } else if (c == '\n') {
1300 error("invalid key (newline): %s", key);
1301 goto out_free_ret_1;
1303 (*store_key)[i] = c;
1305 (*store_key)[i] = 0;
1307 return 0;
1309 out_free_ret_1:
1310 free(*store_key);
1311 *store_key = NULL;
1312 return -CONFIG_INVALID_KEY;
1316 * If value==NULL, unset in (remove from) config,
1317 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1318 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1319 * else all matching key/values (regardless how many) are removed,
1320 * before the new pair is written.
1322 * Returns 0 on success.
1324 * This function does this:
1326 * - it locks the config file by creating ".git/config.lock"
1328 * - it then parses the config using store_aux() as validator to find
1329 * the position on the key/value pair to replace. If it is to be unset,
1330 * it must be found exactly once.
1332 * - the config file is mmap()ed and the part before the match (if any) is
1333 * written to the lock file, then the changed part and the rest.
1335 * - the config file is removed and the lock file rename()d to it.
1338 int git_config_set_multivar_in_file(const char *config_filename,
1339 const char *key, const char *value,
1340 const char *value_regex, int multi_replace)
1342 int fd = -1, in_fd;
1343 int ret;
1344 struct lock_file *lock = NULL;
1345 char *filename_buf = NULL;
1347 /* parse-key returns negative; flip the sign to feed exit(3) */
1348 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1349 if (ret)
1350 goto out_free;
1352 store.multi_replace = multi_replace;
1354 if (!config_filename)
1355 config_filename = filename_buf = git_pathdup("config");
1358 * The lock serves a purpose in addition to locking: the new
1359 * contents of .git/config will be written into it.
1361 lock = xcalloc(sizeof(struct lock_file), 1);
1362 fd = hold_lock_file_for_update(lock, config_filename, 0);
1363 if (fd < 0) {
1364 error("could not lock config file %s: %s", config_filename, strerror(errno));
1365 free(store.key);
1366 ret = CONFIG_NO_LOCK;
1367 goto out_free;
1371 * If .git/config does not exist yet, write a minimal version.
1373 in_fd = open(config_filename, O_RDONLY);
1374 if ( in_fd < 0 ) {
1375 free(store.key);
1377 if ( ENOENT != errno ) {
1378 error("opening %s: %s", config_filename,
1379 strerror(errno));
1380 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1381 goto out_free;
1383 /* if nothing to unset, error out */
1384 if (value == NULL) {
1385 ret = CONFIG_NOTHING_SET;
1386 goto out_free;
1389 store.key = (char *)key;
1390 if (!store_write_section(fd, key) ||
1391 !store_write_pair(fd, key, value))
1392 goto write_err_out;
1393 } else {
1394 struct stat st;
1395 char *contents;
1396 size_t contents_sz, copy_begin, copy_end;
1397 int i, new_line = 0;
1399 if (value_regex == NULL)
1400 store.value_regex = NULL;
1401 else {
1402 if (value_regex[0] == '!') {
1403 store.do_not_match = 1;
1404 value_regex++;
1405 } else
1406 store.do_not_match = 0;
1408 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1409 if (regcomp(store.value_regex, value_regex,
1410 REG_EXTENDED)) {
1411 error("invalid pattern: %s", value_regex);
1412 free(store.value_regex);
1413 ret = CONFIG_INVALID_PATTERN;
1414 goto out_free;
1418 store.offset[0] = 0;
1419 store.state = START;
1420 store.seen = 0;
1423 * After this, store.offset will contain the *end* offset
1424 * of the last match, or remain at 0 if no match was found.
1425 * As a side effect, we make sure to transform only a valid
1426 * existing config file.
1428 if (git_config_from_file(store_aux, config_filename, NULL)) {
1429 error("invalid config file %s", config_filename);
1430 free(store.key);
1431 if (store.value_regex != NULL) {
1432 regfree(store.value_regex);
1433 free(store.value_regex);
1435 ret = CONFIG_INVALID_FILE;
1436 goto out_free;
1439 free(store.key);
1440 if (store.value_regex != NULL) {
1441 regfree(store.value_regex);
1442 free(store.value_regex);
1445 /* if nothing to unset, or too many matches, error out */
1446 if ((store.seen == 0 && value == NULL) ||
1447 (store.seen > 1 && multi_replace == 0)) {
1448 ret = CONFIG_NOTHING_SET;
1449 goto out_free;
1452 fstat(in_fd, &st);
1453 contents_sz = xsize_t(st.st_size);
1454 contents = xmmap(NULL, contents_sz, PROT_READ,
1455 MAP_PRIVATE, in_fd, 0);
1456 close(in_fd);
1458 if (store.seen == 0)
1459 store.seen = 1;
1461 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1462 if (store.offset[i] == 0) {
1463 store.offset[i] = copy_end = contents_sz;
1464 } else if (store.state != KEY_SEEN) {
1465 copy_end = store.offset[i];
1466 } else
1467 copy_end = find_beginning_of_line(
1468 contents, contents_sz,
1469 store.offset[i]-2, &new_line);
1471 if (copy_end > 0 && contents[copy_end-1] != '\n')
1472 new_line = 1;
1474 /* write the first part of the config */
1475 if (copy_end > copy_begin) {
1476 if (write_in_full(fd, contents + copy_begin,
1477 copy_end - copy_begin) <
1478 copy_end - copy_begin)
1479 goto write_err_out;
1480 if (new_line &&
1481 write_str_in_full(fd, "\n") != 1)
1482 goto write_err_out;
1484 copy_begin = store.offset[i];
1487 /* write the pair (value == NULL means unset) */
1488 if (value != NULL) {
1489 if (store.state == START) {
1490 if (!store_write_section(fd, key))
1491 goto write_err_out;
1493 if (!store_write_pair(fd, key, value))
1494 goto write_err_out;
1497 /* write the rest of the config */
1498 if (copy_begin < contents_sz)
1499 if (write_in_full(fd, contents + copy_begin,
1500 contents_sz - copy_begin) <
1501 contents_sz - copy_begin)
1502 goto write_err_out;
1504 munmap(contents, contents_sz);
1507 if (commit_lock_file(lock) < 0) {
1508 error("could not commit config file %s", config_filename);
1509 ret = CONFIG_NO_WRITE;
1510 goto out_free;
1514 * lock is committed, so don't try to roll it back below.
1515 * NOTE: Since lockfile.c keeps a linked list of all created
1516 * lock_file structures, it isn't safe to free(lock). It's
1517 * better to just leave it hanging around.
1519 lock = NULL;
1520 ret = 0;
1522 out_free:
1523 if (lock)
1524 rollback_lock_file(lock);
1525 free(filename_buf);
1526 return ret;
1528 write_err_out:
1529 ret = write_error(lock->filename);
1530 goto out_free;
1534 int git_config_set_multivar(const char *key, const char *value,
1535 const char *value_regex, int multi_replace)
1537 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1538 multi_replace);
1541 static int section_name_match (const char *buf, const char *name)
1543 int i = 0, j = 0, dot = 0;
1544 if (buf[i] != '[')
1545 return 0;
1546 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1547 if (!dot && isspace(buf[i])) {
1548 dot = 1;
1549 if (name[j++] != '.')
1550 break;
1551 for (i++; isspace(buf[i]); i++)
1552 ; /* do nothing */
1553 if (buf[i] != '"')
1554 break;
1555 continue;
1557 if (buf[i] == '\\' && dot)
1558 i++;
1559 else if (buf[i] == '"' && dot) {
1560 for (i++; isspace(buf[i]); i++)
1561 ; /* do_nothing */
1562 break;
1564 if (buf[i] != name[j++])
1565 break;
1567 if (buf[i] == ']' && name[j] == 0) {
1569 * We match, now just find the right length offset by
1570 * gobbling up any whitespace after it, as well
1572 i++;
1573 for (; buf[i] && isspace(buf[i]); i++)
1574 ; /* do nothing */
1575 return i;
1577 return 0;
1580 static int section_name_is_ok(const char *name)
1582 /* Empty section names are bogus. */
1583 if (!*name)
1584 return 0;
1587 * Before a dot, we must be alphanumeric or dash. After the first dot,
1588 * anything goes, so we can stop checking.
1590 for (; *name && *name != '.'; name++)
1591 if (*name != '-' && !isalnum(*name))
1592 return 0;
1593 return 1;
1596 /* if new_name == NULL, the section is removed instead */
1597 int git_config_rename_section_in_file(const char *config_filename,
1598 const char *old_name, const char *new_name)
1600 int ret = 0, remove = 0;
1601 char *filename_buf = NULL;
1602 struct lock_file *lock;
1603 int out_fd;
1604 char buf[1024];
1605 FILE *config_file;
1607 if (new_name && !section_name_is_ok(new_name)) {
1608 ret = error("invalid section name: %s", new_name);
1609 goto out;
1612 if (!config_filename)
1613 config_filename = filename_buf = git_pathdup("config");
1615 lock = xcalloc(sizeof(struct lock_file), 1);
1616 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1617 if (out_fd < 0) {
1618 ret = error("could not lock config file %s", config_filename);
1619 goto out;
1622 if (!(config_file = fopen(config_filename, "rb"))) {
1623 /* no config file means nothing to rename, no error */
1624 goto unlock_and_out;
1627 while (fgets(buf, sizeof(buf), config_file)) {
1628 int i;
1629 int length;
1630 char *output = buf;
1631 for (i = 0; buf[i] && isspace(buf[i]); i++)
1632 ; /* do nothing */
1633 if (buf[i] == '[') {
1634 /* it's a section */
1635 int offset = section_name_match(&buf[i], old_name);
1636 if (offset > 0) {
1637 ret++;
1638 if (new_name == NULL) {
1639 remove = 1;
1640 continue;
1642 store.baselen = strlen(new_name);
1643 if (!store_write_section(out_fd, new_name)) {
1644 ret = write_error(lock->filename);
1645 goto out;
1648 * We wrote out the new section, with
1649 * a newline, now skip the old
1650 * section's length
1652 output += offset + i;
1653 if (strlen(output) > 0) {
1655 * More content means there's
1656 * a declaration to put on the
1657 * next line; indent with a
1658 * tab
1660 output -= 1;
1661 output[0] = '\t';
1664 remove = 0;
1666 if (remove)
1667 continue;
1668 length = strlen(output);
1669 if (write_in_full(out_fd, output, length) != length) {
1670 ret = write_error(lock->filename);
1671 goto out;
1674 fclose(config_file);
1675 unlock_and_out:
1676 if (commit_lock_file(lock) < 0)
1677 ret = error("could not commit config file %s", config_filename);
1678 out:
1679 free(filename_buf);
1680 return ret;
1683 int git_config_rename_section(const char *old_name, const char *new_name)
1685 return git_config_rename_section_in_file(NULL, old_name, new_name);
1689 * Call this to report error for your variable that should not
1690 * get a boolean value (i.e. "[my] var" means "true").
1692 #undef config_error_nonbool
1693 int config_error_nonbool(const char *var)
1695 return error("Missing value for '%s'", var);
1698 int parse_config_key(const char *var,
1699 const char *section,
1700 const char **subsection, int *subsection_len,
1701 const char **key)
1703 int section_len = strlen(section);
1704 const char *dot;
1706 /* Does it start with "section." ? */
1707 if (prefixcmp(var, section) || var[section_len] != '.')
1708 return -1;
1711 * Find the key; we don't know yet if we have a subsection, but we must
1712 * parse backwards from the end, since the subsection may have dots in
1713 * it, too.
1715 dot = strrchr(var, '.');
1716 *key = dot + 1;
1718 /* Did we have a subsection at all? */
1719 if (dot == var + section_len) {
1720 *subsection = NULL;
1721 *subsection_len = 0;
1723 else {
1724 *subsection = var + section_len + 1;
1725 *subsection_len = dot - *subsection;
1728 return 0;