am: Use cat instead of echo to avoid DOS line-endings (fixes t4150)
[git/dscho.git] / config.c
blob96661cd5473fa6db92f3b01ce0d8dfe1101d84c4
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 #define MAX_INCLUDE_DEPTH 10
30 static const char include_depth_advice[] =
31 "exceeded maximum include depth (%d) while including\n"
32 " %s\n"
33 "from\n"
34 " %s\n"
35 "Do you have circular includes?";
36 static int handle_path_include(const char *path, struct config_include_data *inc)
38 int ret = 0;
39 struct strbuf buf = STRBUF_INIT;
40 char *expanded = expand_user_path(path);
42 if (!expanded)
43 return error("Could not expand include path '%s'", path);
44 path = expanded;
47 * Use an absolute path as-is, but interpret relative paths
48 * based on the including config file.
50 if (!is_absolute_path(path)) {
51 char *slash;
53 if (!cf || !cf->name)
54 return error("relative config includes must come from files");
56 slash = find_last_dir_sep(cf->name);
57 if (slash)
58 strbuf_add(&buf, cf->name, slash - cf->name + 1);
59 strbuf_addstr(&buf, path);
60 path = buf.buf;
63 if (!access(path, R_OK)) {
64 if (++inc->depth > MAX_INCLUDE_DEPTH)
65 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
66 cf && cf->name ? cf->name : "the command line");
67 ret = git_config_from_file(git_config_include, path, inc);
68 inc->depth--;
70 strbuf_release(&buf);
71 free(expanded);
72 return ret;
75 int git_config_include(const char *var, const char *value, void *data)
77 struct config_include_data *inc = data;
78 const char *type;
79 int ret;
82 * Pass along all values, including "include" directives; this makes it
83 * possible to query information on the includes themselves.
85 ret = inc->fn(var, value, inc->data);
86 if (ret < 0)
87 return ret;
89 type = skip_prefix(var, "include.");
90 if (!type)
91 return ret;
93 if (!strcmp(type, "path"))
94 ret = handle_path_include(value, inc);
95 return ret;
98 static void lowercase(char *p)
100 for (; *p; p++)
101 *p = tolower(*p);
104 void git_config_push_parameter(const char *text)
106 struct strbuf env = STRBUF_INIT;
107 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
108 if (old) {
109 strbuf_addstr(&env, old);
110 strbuf_addch(&env, ' ');
112 sq_quote_buf(&env, text);
113 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
114 strbuf_release(&env);
117 int git_config_parse_parameter(const char *text,
118 config_fn_t fn, void *data)
120 struct strbuf **pair;
121 pair = strbuf_split_str(text, '=', 2);
122 if (!pair[0])
123 return error("bogus config parameter: %s", text);
124 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
125 strbuf_setlen(pair[0], pair[0]->len - 1);
126 strbuf_trim(pair[0]);
127 if (!pair[0]->len) {
128 strbuf_list_free(pair);
129 return error("bogus config parameter: %s", text);
131 lowercase(pair[0]->buf);
132 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
133 strbuf_list_free(pair);
134 return -1;
136 strbuf_list_free(pair);
137 return 0;
140 int git_config_from_parameters(config_fn_t fn, void *data)
142 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
143 char *envw;
144 const char **argv = NULL;
145 int nr = 0, alloc = 0;
146 int i;
148 if (!env)
149 return 0;
150 /* sq_dequote will write over it */
151 envw = xstrdup(env);
153 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
154 free(envw);
155 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
158 for (i = 0; i < nr; i++) {
159 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
160 free(argv);
161 free(envw);
162 return -1;
166 free(argv);
167 free(envw);
168 return nr > 0;
171 static int get_next_char(void)
173 int c;
174 FILE *f;
176 c = '\n';
177 if (cf && ((f = cf->f) != NULL)) {
178 c = fgetc(f);
179 if (c == '\r') {
180 /* DOS like systems */
181 c = fgetc(f);
182 if (c != '\n') {
183 ungetc(c, f);
184 c = '\r';
187 if (c == '\n')
188 cf->linenr++;
189 if (c == EOF) {
190 cf->eof = 1;
191 c = '\n';
194 return c;
197 static char *parse_value(void)
199 int quote = 0, comment = 0, space = 0;
201 strbuf_reset(&cf->value);
202 for (;;) {
203 int c = get_next_char();
204 if (c == '\n') {
205 if (quote) {
206 cf->linenr--;
207 return NULL;
209 return cf->value.buf;
211 if (comment)
212 continue;
213 if (isspace(c) && !quote) {
214 if (cf->value.len)
215 space++;
216 continue;
218 if (!quote) {
219 if (c == ';' || c == '#') {
220 comment = 1;
221 continue;
224 for (; space; space--)
225 strbuf_addch(&cf->value, ' ');
226 if (c == '\\') {
227 c = get_next_char();
228 switch (c) {
229 case '\n':
230 continue;
231 case 't':
232 c = '\t';
233 break;
234 case 'b':
235 c = '\b';
236 break;
237 case 'n':
238 c = '\n';
239 break;
240 /* Some characters escape as themselves */
241 case '\\': case '"':
242 break;
243 /* Reject unknown escape sequences */
244 default:
245 return NULL;
247 strbuf_addch(&cf->value, c);
248 continue;
250 if (c == '"') {
251 quote = 1-quote;
252 continue;
254 strbuf_addch(&cf->value, c);
258 static inline int iskeychar(int c)
260 return isalnum(c) || c == '-';
263 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
265 int c;
266 char *value;
268 /* Get the full name */
269 for (;;) {
270 c = get_next_char();
271 if (cf->eof)
272 break;
273 if (!iskeychar(c))
274 break;
275 name[len++] = tolower(c);
276 if (len >= MAXNAME)
277 return -1;
279 name[len] = 0;
280 while (c == ' ' || c == '\t')
281 c = get_next_char();
283 value = NULL;
284 if (c != '\n') {
285 if (c != '=')
286 return -1;
287 value = parse_value();
288 if (!value)
289 return -1;
291 return fn(name, value, data);
294 static int get_extended_base_var(char *name, int baselen, int c)
296 do {
297 if (c == '\n')
298 goto error_incomplete_line;
299 c = get_next_char();
300 } while (isspace(c));
302 /* We require the format to be '[base "extension"]' */
303 if (c != '"')
304 return -1;
305 name[baselen++] = '.';
307 for (;;) {
308 int c = get_next_char();
309 if (c == '\n')
310 goto error_incomplete_line;
311 if (c == '"')
312 break;
313 if (c == '\\') {
314 c = get_next_char();
315 if (c == '\n')
316 goto error_incomplete_line;
318 name[baselen++] = c;
319 if (baselen > MAXNAME / 2)
320 return -1;
323 /* Final ']' */
324 if (get_next_char() != ']')
325 return -1;
326 return baselen;
327 error_incomplete_line:
328 cf->linenr--;
329 return -1;
332 static int get_base_var(char *name)
334 int baselen = 0;
336 for (;;) {
337 int c = get_next_char();
338 if (cf->eof)
339 return -1;
340 if (c == ']')
341 return baselen;
342 if (isspace(c))
343 return get_extended_base_var(name, baselen, c);
344 if (!iskeychar(c) && c != '.')
345 return -1;
346 if (baselen > MAXNAME / 2)
347 return -1;
348 name[baselen++] = tolower(c);
352 static int git_parse_file(config_fn_t fn, void *data)
354 int comment = 0;
355 int baselen = 0;
356 char *var = cf->var;
358 /* U+FEFF Byte Order Mark in UTF8 */
359 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
360 const unsigned char *bomptr = utf8_bom;
362 for (;;) {
363 int c = get_next_char();
364 if (bomptr && *bomptr) {
365 /* We are at the file beginning; skip UTF8-encoded BOM
366 * if present. Sane editors won't put this in on their
367 * own, but e.g. Windows Notepad will do it happily. */
368 if ((unsigned char) c == *bomptr) {
369 bomptr++;
370 continue;
371 } else {
372 /* Do not tolerate partial BOM. */
373 if (bomptr != utf8_bom)
374 break;
375 /* No BOM at file beginning. Cool. */
376 bomptr = NULL;
379 if (c == '\n') {
380 if (cf->eof)
381 return 0;
382 comment = 0;
383 continue;
385 if (comment || isspace(c))
386 continue;
387 if (c == '#' || c == ';') {
388 comment = 1;
389 continue;
391 if (c == '[') {
392 baselen = get_base_var(var);
393 if (baselen <= 0)
394 break;
395 var[baselen++] = '.';
396 var[baselen] = 0;
397 continue;
399 if (!isalpha(c))
400 break;
401 var[baselen] = tolower(c);
402 if (get_value(fn, data, var, baselen+1) < 0)
403 break;
405 die("bad config file line %d in %s", cf->linenr, cf->name);
408 static int parse_unit_factor(const char *end, uintmax_t *val)
410 if (!*end)
411 return 1;
412 else if (!strcasecmp(end, "k")) {
413 *val *= 1024;
414 return 1;
416 else if (!strcasecmp(end, "m")) {
417 *val *= 1024 * 1024;
418 return 1;
420 else if (!strcasecmp(end, "g")) {
421 *val *= 1024 * 1024 * 1024;
422 return 1;
424 return 0;
427 static int git_parse_long(const char *value, long *ret)
429 if (value && *value) {
430 char *end;
431 intmax_t val;
432 uintmax_t uval;
433 uintmax_t factor = 1;
435 errno = 0;
436 val = strtoimax(value, &end, 0);
437 if (errno == ERANGE)
438 return 0;
439 if (!parse_unit_factor(end, &factor))
440 return 0;
441 uval = abs(val);
442 uval *= factor;
443 if ((uval > maximum_signed_value_of_type(long)) ||
444 (abs(val) > uval))
445 return 0;
446 val *= factor;
447 *ret = val;
448 return 1;
450 return 0;
453 int git_parse_ulong(const char *value, unsigned long *ret)
455 if (value && *value) {
456 char *end;
457 uintmax_t val;
458 uintmax_t oldval;
460 errno = 0;
461 val = strtoumax(value, &end, 0);
462 if (errno == ERANGE)
463 return 0;
464 oldval = val;
465 if (!parse_unit_factor(end, &val))
466 return 0;
467 if ((val > maximum_unsigned_value_of_type(long)) ||
468 (oldval > val))
469 return 0;
470 *ret = val;
471 return 1;
473 return 0;
476 static void die_bad_config(const char *name)
478 if (cf && cf->name)
479 die("bad config value for '%s' in %s", name, cf->name);
480 die("bad config value for '%s'", name);
483 int git_config_int(const char *name, const char *value)
485 long ret = 0;
486 if (!git_parse_long(value, &ret))
487 die_bad_config(name);
488 return ret;
491 unsigned long git_config_ulong(const char *name, const char *value)
493 unsigned long ret;
494 if (!git_parse_ulong(value, &ret))
495 die_bad_config(name);
496 return ret;
499 static int git_config_maybe_bool_text(const char *name, const char *value)
501 if (!value)
502 return 1;
503 if (!*value)
504 return 0;
505 if (!strcasecmp(value, "true")
506 || !strcasecmp(value, "yes")
507 || !strcasecmp(value, "on"))
508 return 1;
509 if (!strcasecmp(value, "false")
510 || !strcasecmp(value, "no")
511 || !strcasecmp(value, "off"))
512 return 0;
513 return -1;
516 int git_config_maybe_bool(const char *name, const char *value)
518 long v = git_config_maybe_bool_text(name, value);
519 if (0 <= v)
520 return v;
521 if (git_parse_long(value, &v))
522 return !!v;
523 return -1;
526 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
528 int v = git_config_maybe_bool_text(name, value);
529 if (0 <= v) {
530 *is_bool = 1;
531 return v;
533 *is_bool = 0;
534 return git_config_int(name, value);
537 int git_config_bool(const char *name, const char *value)
539 int discard;
540 return !!git_config_bool_or_int(name, value, &discard);
543 int git_config_string(const char **dest, const char *var, const char *value)
545 if (!value)
546 return config_error_nonbool(var);
547 *dest = xstrdup(value);
548 return 0;
551 int git_config_pathname(const char **dest, const char *var, const char *value)
553 if (!value)
554 return config_error_nonbool(var);
555 *dest = expand_user_path(value);
556 if (!*dest)
557 die("Failed to expand user dir in: '%s'", value);
558 return 0;
561 static int git_default_core_config(const char *var, const char *value)
563 /* This needs a better name */
564 if (!strcmp(var, "core.filemode")) {
565 trust_executable_bit = git_config_bool(var, value);
566 return 0;
568 if (!strcmp(var, "core.trustctime")) {
569 trust_ctime = git_config_bool(var, value);
570 return 0;
573 if (!strcmp(var, "core.quotepath")) {
574 quote_path_fully = git_config_bool(var, value);
575 return 0;
578 if (!strcmp(var, "core.symlinks")) {
579 has_symlinks = git_config_bool(var, value);
580 return 0;
583 if (!strcmp(var, "core.ignorecase")) {
584 ignore_case = git_config_bool(var, value);
585 return 0;
588 if (!strcmp(var, "core.attributesfile"))
589 return git_config_pathname(&git_attributes_file, var, value);
591 if (!strcmp(var, "core.bare")) {
592 is_bare_repository_cfg = git_config_bool(var, value);
593 return 0;
596 if (!strcmp(var, "core.ignorestat")) {
597 assume_unchanged = git_config_bool(var, value);
598 return 0;
601 if (!strcmp(var, "core.prefersymlinkrefs")) {
602 prefer_symlink_refs = git_config_bool(var, value);
603 return 0;
606 if (!strcmp(var, "core.logallrefupdates")) {
607 log_all_ref_updates = git_config_bool(var, value);
608 return 0;
611 if (!strcmp(var, "core.warnambiguousrefs")) {
612 warn_ambiguous_refs = git_config_bool(var, value);
613 return 0;
616 if (!strcmp(var, "core.abbrev")) {
617 int abbrev = git_config_int(var, value);
618 if (abbrev < minimum_abbrev || abbrev > 40)
619 return -1;
620 default_abbrev = abbrev;
621 return 0;
624 if (!strcmp(var, "core.loosecompression")) {
625 int level = git_config_int(var, value);
626 if (level == -1)
627 level = Z_DEFAULT_COMPRESSION;
628 else if (level < 0 || level > Z_BEST_COMPRESSION)
629 die("bad zlib compression level %d", level);
630 zlib_compression_level = level;
631 zlib_compression_seen = 1;
632 return 0;
635 if (!strcmp(var, "core.compression")) {
636 int level = git_config_int(var, value);
637 if (level == -1)
638 level = Z_DEFAULT_COMPRESSION;
639 else if (level < 0 || level > Z_BEST_COMPRESSION)
640 die("bad zlib compression level %d", level);
641 core_compression_level = level;
642 core_compression_seen = 1;
643 if (!zlib_compression_seen)
644 zlib_compression_level = level;
645 return 0;
648 if (!strcmp(var, "core.packedgitwindowsize")) {
649 int pgsz_x2 = getpagesize() * 2;
650 packed_git_window_size = git_config_ulong(var, value);
652 /* This value must be multiple of (pagesize * 2) */
653 packed_git_window_size /= pgsz_x2;
654 if (packed_git_window_size < 1)
655 packed_git_window_size = 1;
656 packed_git_window_size *= pgsz_x2;
657 return 0;
660 if (!strcmp(var, "core.bigfilethreshold")) {
661 big_file_threshold = git_config_ulong(var, value);
662 return 0;
665 if (!strcmp(var, "core.packedgitlimit")) {
666 packed_git_limit = git_config_ulong(var, value);
667 return 0;
670 if (!strcmp(var, "core.deltabasecachelimit")) {
671 delta_base_cache_limit = git_config_ulong(var, value);
672 return 0;
675 if (!strcmp(var, "core.logpackaccess"))
676 return git_config_string(&log_pack_access, var, value);
678 if (!strcmp(var, "core.autocrlf")) {
679 if (value && !strcasecmp(value, "input")) {
680 if (core_eol == EOL_CRLF)
681 return error("core.autocrlf=input conflicts with core.eol=crlf");
682 auto_crlf = AUTO_CRLF_INPUT;
683 return 0;
685 auto_crlf = git_config_bool(var, value);
686 return 0;
689 if (!strcmp(var, "core.safecrlf")) {
690 if (value && !strcasecmp(value, "warn")) {
691 safe_crlf = SAFE_CRLF_WARN;
692 return 0;
694 safe_crlf = git_config_bool(var, value);
695 return 0;
698 if (!strcmp(var, "core.eol")) {
699 if (value && !strcasecmp(value, "lf"))
700 core_eol = EOL_LF;
701 else if (value && !strcasecmp(value, "crlf"))
702 core_eol = EOL_CRLF;
703 else if (value && !strcasecmp(value, "native"))
704 core_eol = EOL_NATIVE;
705 else
706 core_eol = EOL_UNSET;
707 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
708 return error("core.autocrlf=input conflicts with core.eol=crlf");
709 return 0;
712 if (!strcmp(var, "core.notesref")) {
713 notes_ref_name = xstrdup(value);
714 return 0;
717 if (!strcmp(var, "core.pager"))
718 return git_config_string(&pager_program, var, value);
720 if (!strcmp(var, "core.editor"))
721 return git_config_string(&editor_program, var, value);
723 if (!strcmp(var, "core.askpass"))
724 return git_config_string(&askpass_program, var, value);
726 if (!strcmp(var, "core.excludesfile"))
727 return git_config_pathname(&excludes_file, var, value);
729 if (!strcmp(var, "core.whitespace")) {
730 if (!value)
731 return config_error_nonbool(var);
732 whitespace_rule_cfg = parse_whitespace_rule(value);
733 return 0;
736 if (!strcmp(var, "core.fsyncobjectfiles")) {
737 fsync_object_files = git_config_bool(var, value);
738 return 0;
741 if (!strcmp(var, "core.preloadindex")) {
742 core_preload_index = git_config_bool(var, value);
743 return 0;
746 if (!strcmp(var, "core.createobject")) {
747 if (!strcmp(value, "rename"))
748 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
749 else if (!strcmp(value, "link"))
750 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
751 else
752 die("Invalid mode for object creation: %s", value);
753 return 0;
756 if (!strcmp(var, "core.sparsecheckout")) {
757 core_apply_sparse_checkout = git_config_bool(var, value);
758 return 0;
761 if (!strcmp(var, "core.hidedotfiles")) {
762 if (value && !strcasecmp(value, "dotgitonly")) {
763 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
764 return 0;
766 hide_dotfiles = git_config_bool(var, value);
767 return 0;
770 /* Add other config variables here and to Documentation/config.txt. */
771 return 0;
774 static int git_default_user_config(const char *var, const char *value)
776 if (!strcmp(var, "user.name")) {
777 if (!value)
778 return config_error_nonbool(var);
779 strlcpy(git_default_name, value, sizeof(git_default_name));
780 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
781 return 0;
784 if (!strcmp(var, "user.email")) {
785 if (!value)
786 return config_error_nonbool(var);
787 strlcpy(git_default_email, value, sizeof(git_default_email));
788 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
789 return 0;
792 /* Add other config variables here and to Documentation/config.txt. */
793 return 0;
796 static int git_default_i18n_config(const char *var, const char *value)
798 if (!strcmp(var, "i18n.commitencoding"))
799 return git_config_string(&git_commit_encoding, var, value);
801 if (!strcmp(var, "i18n.logoutputencoding"))
802 return git_config_string(&git_log_output_encoding, var, value);
804 /* Add other config variables here and to Documentation/config.txt. */
805 return 0;
808 static int git_default_branch_config(const char *var, const char *value)
810 if (!strcmp(var, "branch.autosetupmerge")) {
811 if (value && !strcasecmp(value, "always")) {
812 git_branch_track = BRANCH_TRACK_ALWAYS;
813 return 0;
815 git_branch_track = git_config_bool(var, value);
816 return 0;
818 if (!strcmp(var, "branch.autosetuprebase")) {
819 if (!value)
820 return config_error_nonbool(var);
821 else if (!strcmp(value, "never"))
822 autorebase = AUTOREBASE_NEVER;
823 else if (!strcmp(value, "local"))
824 autorebase = AUTOREBASE_LOCAL;
825 else if (!strcmp(value, "remote"))
826 autorebase = AUTOREBASE_REMOTE;
827 else if (!strcmp(value, "always"))
828 autorebase = AUTOREBASE_ALWAYS;
829 else
830 return error("Malformed value for %s", var);
831 return 0;
834 /* Add other config variables here and to Documentation/config.txt. */
835 return 0;
838 static int git_default_push_config(const char *var, const char *value)
840 if (!strcmp(var, "push.default")) {
841 if (!value)
842 return config_error_nonbool(var);
843 else if (!strcmp(value, "nothing"))
844 push_default = PUSH_DEFAULT_NOTHING;
845 else if (!strcmp(value, "matching"))
846 push_default = PUSH_DEFAULT_MATCHING;
847 else if (!strcmp(value, "simple"))
848 push_default = PUSH_DEFAULT_SIMPLE;
849 else if (!strcmp(value, "upstream"))
850 push_default = PUSH_DEFAULT_UPSTREAM;
851 else if (!strcmp(value, "tracking")) /* deprecated */
852 push_default = PUSH_DEFAULT_UPSTREAM;
853 else if (!strcmp(value, "current"))
854 push_default = PUSH_DEFAULT_CURRENT;
855 else {
856 error("Malformed value for %s: %s", var, value);
857 return error("Must be one of nothing, matching, simple, "
858 "upstream or current.");
860 return 0;
863 /* Add other config variables here and to Documentation/config.txt. */
864 return 0;
867 static int git_default_mailmap_config(const char *var, const char *value)
869 if (!strcmp(var, "mailmap.file"))
870 return git_config_string(&git_mailmap_file, 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_default_user_config(var, value);
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 cf = &top;
930 ret = git_parse_file(fn, data);
932 /* pop config-file parsing state stack */
933 strbuf_release(&top.value);
934 cf = top.prev;
936 fclose(f);
938 return ret;
941 const char *git_etc_gitconfig(void)
943 static const char *system_wide;
944 if (!system_wide)
945 system_wide = system_path(ETC_GITCONFIG);
946 return system_wide;
949 int git_env_bool(const char *k, int def)
951 const char *v = getenv(k);
952 return v ? git_config_bool(k, v) : def;
955 int git_config_system(void)
957 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
960 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
962 int ret = 0, found = 0;
963 const char *home = NULL;
965 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
966 ret += git_config_from_file(fn, git_etc_gitconfig(),
967 data);
968 found += 1;
971 home = get_home_directory();
972 if (home) {
973 char buf[PATH_MAX];
974 char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
975 if (!access(user_config, R_OK)) {
976 ret += git_config_from_file(fn, user_config, data);
977 found += 1;
981 if (repo_config && !access(repo_config, R_OK)) {
982 ret += git_config_from_file(fn, repo_config, data);
983 found += 1;
986 switch (git_config_from_parameters(fn, data)) {
987 case -1: /* error */
988 die("unable to parse command-line config");
989 break;
990 case 0: /* found nothing */
991 break;
992 default: /* found at least one item */
993 found++;
994 break;
997 return ret == 0 ? found : ret;
1000 int git_config_with_options(config_fn_t fn, void *data,
1001 const char *filename, int respect_includes)
1003 char *repo_config = NULL;
1004 int ret;
1005 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1007 if (respect_includes) {
1008 inc.fn = fn;
1009 inc.data = data;
1010 fn = git_config_include;
1011 data = &inc;
1015 * If we have a specific filename, use it. Otherwise, follow the
1016 * regular lookup sequence.
1018 if (filename)
1019 return git_config_from_file(fn, filename, data);
1021 repo_config = git_pathdup("config");
1022 ret = git_config_early(fn, data, repo_config);
1023 if (repo_config)
1024 free(repo_config);
1025 return ret;
1028 int git_config(config_fn_t fn, void *data)
1030 return git_config_with_options(fn, data, NULL, 1);
1034 * Find all the stuff for git_config_set() below.
1037 #define MAX_MATCHES 512
1039 static struct {
1040 int baselen;
1041 char *key;
1042 int do_not_match;
1043 regex_t *value_regex;
1044 int multi_replace;
1045 size_t offset[MAX_MATCHES];
1046 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1047 int seen;
1048 } store;
1050 static int matches(const char *key, const char *value)
1052 return !strcmp(key, store.key) &&
1053 (store.value_regex == NULL ||
1054 (store.do_not_match ^
1055 !regexec(store.value_regex, value, 0, NULL, 0)));
1058 static int store_aux(const char *key, const char *value, void *cb)
1060 const char *ep;
1061 size_t section_len;
1062 FILE *f = cf->f;
1064 switch (store.state) {
1065 case KEY_SEEN:
1066 if (matches(key, value)) {
1067 if (store.seen == 1 && store.multi_replace == 0) {
1068 warning("%s has multiple values", key);
1069 } else if (store.seen >= MAX_MATCHES) {
1070 error("too many matches for %s", key);
1071 return 1;
1074 store.offset[store.seen] = ftell(f);
1075 store.seen++;
1077 break;
1078 case SECTION_SEEN:
1080 * What we are looking for is in store.key (both
1081 * section and var), and its section part is baselen
1082 * long. We found key (again, both section and var).
1083 * We would want to know if this key is in the same
1084 * section as what we are looking for. We already
1085 * know we are in the same section as what should
1086 * hold store.key.
1088 ep = strrchr(key, '.');
1089 section_len = ep - key;
1091 if ((section_len != store.baselen) ||
1092 memcmp(key, store.key, section_len+1)) {
1093 store.state = SECTION_END_SEEN;
1094 break;
1098 * Do not increment matches: this is no match, but we
1099 * just made sure we are in the desired section.
1101 store.offset[store.seen] = ftell(f);
1102 /* fallthru */
1103 case SECTION_END_SEEN:
1104 case START:
1105 if (matches(key, value)) {
1106 store.offset[store.seen] = ftell(f);
1107 store.state = KEY_SEEN;
1108 store.seen++;
1109 } else {
1110 if (strrchr(key, '.') - key == store.baselen &&
1111 !strncmp(key, store.key, store.baselen)) {
1112 store.state = SECTION_SEEN;
1113 store.offset[store.seen] = ftell(f);
1117 return 0;
1120 static int write_error(const char *filename)
1122 error("failed to write new configuration file %s", filename);
1124 /* Same error code as "failed to rename". */
1125 return 4;
1128 static int store_write_section(int fd, const char *key)
1130 const char *dot;
1131 int i, success;
1132 struct strbuf sb = STRBUF_INIT;
1134 dot = memchr(key, '.', store.baselen);
1135 if (dot) {
1136 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1137 for (i = dot - key + 1; i < store.baselen; i++) {
1138 if (key[i] == '"' || key[i] == '\\')
1139 strbuf_addch(&sb, '\\');
1140 strbuf_addch(&sb, key[i]);
1142 strbuf_addstr(&sb, "\"]\n");
1143 } else {
1144 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1147 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1148 strbuf_release(&sb);
1150 return success;
1153 static int store_write_pair(int fd, const char *key, const char *value)
1155 int i, success;
1156 int length = strlen(key + store.baselen + 1);
1157 const char *quote = "";
1158 struct strbuf sb = STRBUF_INIT;
1161 * Check to see if the value needs to be surrounded with a dq pair.
1162 * Note that problematic characters are always backslash-quoted; this
1163 * check is about not losing leading or trailing SP and strings that
1164 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1165 * configuration parser.
1167 if (value[0] == ' ')
1168 quote = "\"";
1169 for (i = 0; value[i]; i++)
1170 if (value[i] == ';' || value[i] == '#')
1171 quote = "\"";
1172 if (i && value[i - 1] == ' ')
1173 quote = "\"";
1175 strbuf_addf(&sb, "\t%.*s = %s",
1176 length, key + store.baselen + 1, quote);
1178 for (i = 0; value[i]; i++)
1179 switch (value[i]) {
1180 case '\n':
1181 strbuf_addstr(&sb, "\\n");
1182 break;
1183 case '\t':
1184 strbuf_addstr(&sb, "\\t");
1185 break;
1186 case '"':
1187 case '\\':
1188 strbuf_addch(&sb, '\\');
1189 default:
1190 strbuf_addch(&sb, value[i]);
1191 break;
1193 strbuf_addf(&sb, "%s\n", quote);
1195 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1196 strbuf_release(&sb);
1198 return success;
1201 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1202 size_t offset_, int *found_bracket)
1204 size_t equal_offset = size, bracket_offset = size;
1205 ssize_t offset;
1207 contline:
1208 for (offset = offset_-2; offset > 0
1209 && contents[offset] != '\n'; offset--)
1210 switch (contents[offset]) {
1211 case '=': equal_offset = offset; break;
1212 case ']': bracket_offset = offset; break;
1214 if (offset > 0 && contents[offset-1] == '\\') {
1215 offset_ = offset;
1216 goto contline;
1218 if (bracket_offset < equal_offset) {
1219 *found_bracket = 1;
1220 offset = bracket_offset+1;
1221 } else
1222 offset++;
1224 return offset;
1227 int git_config_set_in_file(const char *config_filename,
1228 const char *key, const char *value)
1230 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1233 int git_config_set(const char *key, const char *value)
1235 return git_config_set_multivar(key, value, NULL, 0);
1239 * Auxiliary function to sanity-check and split the key into the section
1240 * identifier and variable name.
1242 * Returns 0 on success, -1 when there is an invalid character in the key and
1243 * -2 if there is no section name in the key.
1245 * store_key - pointer to char* which will hold a copy of the key with
1246 * lowercase section and variable name
1247 * baselen - pointer to int which will hold the length of the
1248 * section + subsection part, can be NULL
1250 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1252 int i, dot, baselen;
1253 const char *last_dot = strrchr(key, '.');
1256 * Since "key" actually contains the section name and the real
1257 * key name separated by a dot, we have to know where the dot is.
1260 if (last_dot == NULL || last_dot == key) {
1261 error("key does not contain a section: %s", key);
1262 return -CONFIG_NO_SECTION_OR_NAME;
1265 if (!last_dot[1]) {
1266 error("key does not contain variable name: %s", key);
1267 return -CONFIG_NO_SECTION_OR_NAME;
1270 baselen = last_dot - key;
1271 if (baselen_)
1272 *baselen_ = baselen;
1275 * Validate the key and while at it, lower case it for matching.
1277 *store_key = xmalloc(strlen(key) + 1);
1279 dot = 0;
1280 for (i = 0; key[i]; i++) {
1281 unsigned char c = key[i];
1282 if (c == '.')
1283 dot = 1;
1284 /* Leave the extended basename untouched.. */
1285 if (!dot || i > baselen) {
1286 if (!iskeychar(c) ||
1287 (i == baselen + 1 && !isalpha(c))) {
1288 error("invalid key: %s", key);
1289 goto out_free_ret_1;
1291 c = tolower(c);
1292 } else if (c == '\n') {
1293 error("invalid key (newline): %s", key);
1294 goto out_free_ret_1;
1296 (*store_key)[i] = c;
1298 (*store_key)[i] = 0;
1300 return 0;
1302 out_free_ret_1:
1303 free(*store_key);
1304 return -CONFIG_INVALID_KEY;
1308 * If value==NULL, unset in (remove from) config,
1309 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1310 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1311 * else all matching key/values (regardless how many) are removed,
1312 * before the new pair is written.
1314 * Returns 0 on success.
1316 * This function does this:
1318 * - it locks the config file by creating ".git/config.lock"
1320 * - it then parses the config using store_aux() as validator to find
1321 * the position on the key/value pair to replace. If it is to be unset,
1322 * it must be found exactly once.
1324 * - the config file is mmap()ed and the part before the match (if any) is
1325 * written to the lock file, then the changed part and the rest.
1327 * - the config file is removed and the lock file rename()d to it.
1330 int git_config_set_multivar_in_file(const char *config_filename,
1331 const char *key, const char *value,
1332 const char *value_regex, int multi_replace)
1334 int fd = -1, in_fd;
1335 int ret;
1336 struct lock_file *lock = NULL;
1337 char *filename_buf = NULL;
1339 /* parse-key returns negative; flip the sign to feed exit(3) */
1340 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1341 if (ret)
1342 goto out_free;
1344 store.multi_replace = multi_replace;
1346 if (!config_filename)
1347 config_filename = filename_buf = git_pathdup("config");
1350 * The lock serves a purpose in addition to locking: the new
1351 * contents of .git/config will be written into it.
1353 lock = xcalloc(sizeof(struct lock_file), 1);
1354 fd = hold_lock_file_for_update(lock, config_filename, 0);
1355 if (fd < 0) {
1356 error("could not lock config file %s: %s", config_filename, strerror(errno));
1357 free(store.key);
1358 ret = CONFIG_NO_LOCK;
1359 goto out_free;
1363 * If .git/config does not exist yet, write a minimal version.
1365 in_fd = open(config_filename, O_RDONLY);
1366 if ( in_fd < 0 ) {
1367 free(store.key);
1369 if ( ENOENT != errno ) {
1370 error("opening %s: %s", config_filename,
1371 strerror(errno));
1372 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1373 goto out_free;
1375 /* if nothing to unset, error out */
1376 if (value == NULL) {
1377 ret = CONFIG_NOTHING_SET;
1378 goto out_free;
1381 store.key = (char *)key;
1382 if (!store_write_section(fd, key) ||
1383 !store_write_pair(fd, key, value))
1384 goto write_err_out;
1385 } else {
1386 struct stat st;
1387 char *contents;
1388 size_t contents_sz, copy_begin, copy_end;
1389 int i, new_line = 0;
1391 if (value_regex == NULL)
1392 store.value_regex = NULL;
1393 else {
1394 if (value_regex[0] == '!') {
1395 store.do_not_match = 1;
1396 value_regex++;
1397 } else
1398 store.do_not_match = 0;
1400 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1401 if (regcomp(store.value_regex, value_regex,
1402 REG_EXTENDED)) {
1403 error("invalid pattern: %s", value_regex);
1404 free(store.value_regex);
1405 ret = CONFIG_INVALID_PATTERN;
1406 goto out_free;
1410 store.offset[0] = 0;
1411 store.state = START;
1412 store.seen = 0;
1415 * After this, store.offset will contain the *end* offset
1416 * of the last match, or remain at 0 if no match was found.
1417 * As a side effect, we make sure to transform only a valid
1418 * existing config file.
1420 if (git_config_from_file(store_aux, config_filename, NULL)) {
1421 error("invalid config file %s", config_filename);
1422 free(store.key);
1423 if (store.value_regex != NULL) {
1424 regfree(store.value_regex);
1425 free(store.value_regex);
1427 ret = CONFIG_INVALID_FILE;
1428 goto out_free;
1431 free(store.key);
1432 if (store.value_regex != NULL) {
1433 regfree(store.value_regex);
1434 free(store.value_regex);
1437 /* if nothing to unset, or too many matches, error out */
1438 if ((store.seen == 0 && value == NULL) ||
1439 (store.seen > 1 && multi_replace == 0)) {
1440 ret = CONFIG_NOTHING_SET;
1441 goto out_free;
1444 fstat(in_fd, &st);
1445 contents_sz = xsize_t(st.st_size);
1446 contents = xmmap(NULL, contents_sz, PROT_READ,
1447 MAP_PRIVATE, in_fd, 0);
1448 close(in_fd);
1450 if (store.seen == 0)
1451 store.seen = 1;
1453 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1454 if (store.offset[i] == 0) {
1455 store.offset[i] = copy_end = contents_sz;
1456 } else if (store.state != KEY_SEEN) {
1457 copy_end = store.offset[i];
1458 } else
1459 copy_end = find_beginning_of_line(
1460 contents, contents_sz,
1461 store.offset[i]-2, &new_line);
1463 if (copy_end > 0 && contents[copy_end-1] != '\n')
1464 new_line = 1;
1466 /* write the first part of the config */
1467 if (copy_end > copy_begin) {
1468 if (write_in_full(fd, contents + copy_begin,
1469 copy_end - copy_begin) <
1470 copy_end - copy_begin)
1471 goto write_err_out;
1472 if (new_line &&
1473 write_str_in_full(fd, "\n") != 1)
1474 goto write_err_out;
1476 copy_begin = store.offset[i];
1479 /* write the pair (value == NULL means unset) */
1480 if (value != NULL) {
1481 if (store.state == START) {
1482 if (!store_write_section(fd, key))
1483 goto write_err_out;
1485 if (!store_write_pair(fd, key, value))
1486 goto write_err_out;
1489 /* write the rest of the config */
1490 if (copy_begin < contents_sz)
1491 if (write_in_full(fd, contents + copy_begin,
1492 contents_sz - copy_begin) <
1493 contents_sz - copy_begin)
1494 goto write_err_out;
1496 munmap(contents, contents_sz);
1499 if (commit_lock_file(lock) < 0) {
1500 error("could not commit config file %s", config_filename);
1501 ret = CONFIG_NO_WRITE;
1502 goto out_free;
1506 * lock is committed, so don't try to roll it back below.
1507 * NOTE: Since lockfile.c keeps a linked list of all created
1508 * lock_file structures, it isn't safe to free(lock). It's
1509 * better to just leave it hanging around.
1511 lock = NULL;
1512 ret = 0;
1514 out_free:
1515 if (lock)
1516 rollback_lock_file(lock);
1517 free(filename_buf);
1518 return ret;
1520 write_err_out:
1521 ret = write_error(lock->filename);
1522 goto out_free;
1526 int git_config_set_multivar(const char *key, const char *value,
1527 const char *value_regex, int multi_replace)
1529 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1530 multi_replace);
1533 static int section_name_match (const char *buf, const char *name)
1535 int i = 0, j = 0, dot = 0;
1536 if (buf[i] != '[')
1537 return 0;
1538 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1539 if (!dot && isspace(buf[i])) {
1540 dot = 1;
1541 if (name[j++] != '.')
1542 break;
1543 for (i++; isspace(buf[i]); i++)
1544 ; /* do nothing */
1545 if (buf[i] != '"')
1546 break;
1547 continue;
1549 if (buf[i] == '\\' && dot)
1550 i++;
1551 else if (buf[i] == '"' && dot) {
1552 for (i++; isspace(buf[i]); i++)
1553 ; /* do_nothing */
1554 break;
1556 if (buf[i] != name[j++])
1557 break;
1559 if (buf[i] == ']' && name[j] == 0) {
1561 * We match, now just find the right length offset by
1562 * gobbling up any whitespace after it, as well
1564 i++;
1565 for (; buf[i] && isspace(buf[i]); i++)
1566 ; /* do nothing */
1567 return i;
1569 return 0;
1572 static int section_name_is_ok(const char *name)
1574 /* Empty section names are bogus. */
1575 if (!*name)
1576 return 0;
1579 * Before a dot, we must be alphanumeric or dash. After the first dot,
1580 * anything goes, so we can stop checking.
1582 for (; *name && *name != '.'; name++)
1583 if (*name != '-' && !isalnum(*name))
1584 return 0;
1585 return 1;
1588 /* if new_name == NULL, the section is removed instead */
1589 int git_config_rename_section_in_file(const char *config_filename,
1590 const char *old_name, const char *new_name)
1592 int ret = 0, remove = 0;
1593 char *filename_buf = NULL;
1594 struct lock_file *lock;
1595 int out_fd;
1596 char buf[1024];
1597 FILE *config_file;
1599 if (new_name && !section_name_is_ok(new_name)) {
1600 ret = error("invalid section name: %s", new_name);
1601 goto out;
1604 if (!config_filename)
1605 config_filename = filename_buf = git_pathdup("config");
1607 lock = xcalloc(sizeof(struct lock_file), 1);
1608 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1609 if (out_fd < 0) {
1610 ret = error("could not lock config file %s", config_filename);
1611 goto out;
1614 if (!(config_file = fopen(config_filename, "rb"))) {
1615 /* no config file means nothing to rename, no error */
1616 goto unlock_and_out;
1619 while (fgets(buf, sizeof(buf), config_file)) {
1620 int i;
1621 int length;
1622 char *output = buf;
1623 for (i = 0; buf[i] && isspace(buf[i]); i++)
1624 ; /* do nothing */
1625 if (buf[i] == '[') {
1626 /* it's a section */
1627 int offset = section_name_match(&buf[i], old_name);
1628 if (offset > 0) {
1629 ret++;
1630 if (new_name == NULL) {
1631 remove = 1;
1632 continue;
1634 store.baselen = strlen(new_name);
1635 if (!store_write_section(out_fd, new_name)) {
1636 ret = write_error(lock->filename);
1637 goto out;
1640 * We wrote out the new section, with
1641 * a newline, now skip the old
1642 * section's length
1644 output += offset + i;
1645 if (strlen(output) > 0) {
1647 * More content means there's
1648 * a declaration to put on the
1649 * next line; indent with a
1650 * tab
1652 output -= 1;
1653 output[0] = '\t';
1656 remove = 0;
1658 if (remove)
1659 continue;
1660 length = strlen(output);
1661 if (write_in_full(out_fd, output, length) != length) {
1662 ret = write_error(lock->filename);
1663 goto out;
1666 fclose(config_file);
1667 unlock_and_out:
1668 if (commit_lock_file(lock) < 0)
1669 ret = error("could not commit config file %s", config_filename);
1670 out:
1671 free(filename_buf);
1672 return ret;
1675 int git_config_rename_section(const char *old_name, const char *new_name)
1677 return git_config_rename_section_in_file(NULL, old_name, new_name);
1681 * Call this to report error for your variable that should not
1682 * get a boolean value (i.e. "[my] var" means "true").
1684 int config_error_nonbool(const char *var)
1686 return error("Missing value for '%s'", var);