submodule: Use cat instead of echo to avoid DOS line-endings
[git/dscho.git] / config.c
blob53fd956a8813ba76d83dce56396671421edb2e3c
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;
42 * Use an absolute path as-is, but interpret relative paths
43 * based on the including config file.
45 if (!is_absolute_path(path)) {
46 char *slash;
48 if (!cf || !cf->name)
49 return error("relative config includes must come from files");
51 slash = find_last_dir_sep(cf->name);
52 if (slash)
53 strbuf_add(&buf, cf->name, slash - cf->name + 1);
54 strbuf_addstr(&buf, path);
55 path = buf.buf;
58 if (!access(path, R_OK)) {
59 if (++inc->depth > MAX_INCLUDE_DEPTH)
60 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
61 cf && cf->name ? cf->name : "the command line");
62 ret = git_config_from_file(git_config_include, path, inc);
63 inc->depth--;
65 strbuf_release(&buf);
66 return ret;
69 int git_config_include(const char *var, const char *value, void *data)
71 struct config_include_data *inc = data;
72 const char *type;
73 int ret;
76 * Pass along all values, including "include" directives; this makes it
77 * possible to query information on the includes themselves.
79 ret = inc->fn(var, value, inc->data);
80 if (ret < 0)
81 return ret;
83 type = skip_prefix(var, "include.");
84 if (!type)
85 return ret;
87 if (!strcmp(type, "path"))
88 ret = handle_path_include(value, inc);
89 return ret;
92 static void lowercase(char *p)
94 for (; *p; p++)
95 *p = tolower(*p);
98 void git_config_push_parameter(const char *text)
100 struct strbuf env = STRBUF_INIT;
101 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
102 if (old) {
103 strbuf_addstr(&env, old);
104 strbuf_addch(&env, ' ');
106 sq_quote_buf(&env, text);
107 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
108 strbuf_release(&env);
111 int git_config_parse_parameter(const char *text,
112 config_fn_t fn, void *data)
114 struct strbuf **pair;
115 pair = strbuf_split_str(text, '=', 2);
116 if (!pair[0])
117 return error("bogus config parameter: %s", text);
118 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
119 strbuf_setlen(pair[0], pair[0]->len - 1);
120 strbuf_trim(pair[0]);
121 if (!pair[0]->len) {
122 strbuf_list_free(pair);
123 return error("bogus config parameter: %s", text);
125 lowercase(pair[0]->buf);
126 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
127 strbuf_list_free(pair);
128 return -1;
130 strbuf_list_free(pair);
131 return 0;
134 int git_config_from_parameters(config_fn_t fn, void *data)
136 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
137 char *envw;
138 const char **argv = NULL;
139 int nr = 0, alloc = 0;
140 int i;
142 if (!env)
143 return 0;
144 /* sq_dequote will write over it */
145 envw = xstrdup(env);
147 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
148 free(envw);
149 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
152 for (i = 0; i < nr; i++) {
153 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
154 free(argv);
155 free(envw);
156 return -1;
160 free(argv);
161 free(envw);
162 return nr > 0;
165 static int get_next_char(void)
167 int c;
168 FILE *f;
170 c = '\n';
171 if (cf && ((f = cf->f) != NULL)) {
172 c = fgetc(f);
173 if (c == '\r') {
174 /* DOS like systems */
175 c = fgetc(f);
176 if (c != '\n') {
177 ungetc(c, f);
178 c = '\r';
181 if (c == '\n')
182 cf->linenr++;
183 if (c == EOF) {
184 cf->eof = 1;
185 c = '\n';
188 return c;
191 static char *parse_value(void)
193 int quote = 0, comment = 0, space = 0;
195 strbuf_reset(&cf->value);
196 for (;;) {
197 int c = get_next_char();
198 if (c == '\n') {
199 if (quote) {
200 cf->linenr--;
201 return NULL;
203 return cf->value.buf;
205 if (comment)
206 continue;
207 if (isspace(c) && !quote) {
208 if (cf->value.len)
209 space++;
210 continue;
212 if (!quote) {
213 if (c == ';' || c == '#') {
214 comment = 1;
215 continue;
218 for (; space; space--)
219 strbuf_addch(&cf->value, ' ');
220 if (c == '\\') {
221 c = get_next_char();
222 switch (c) {
223 case '\n':
224 continue;
225 case 't':
226 c = '\t';
227 break;
228 case 'b':
229 c = '\b';
230 break;
231 case 'n':
232 c = '\n';
233 break;
234 /* Some characters escape as themselves */
235 case '\\': case '"':
236 break;
237 /* Reject unknown escape sequences */
238 default:
239 return NULL;
241 strbuf_addch(&cf->value, c);
242 continue;
244 if (c == '"') {
245 quote = 1-quote;
246 continue;
248 strbuf_addch(&cf->value, c);
252 static inline int iskeychar(int c)
254 return isalnum(c) || c == '-';
257 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
259 int c;
260 char *value;
262 /* Get the full name */
263 for (;;) {
264 c = get_next_char();
265 if (cf->eof)
266 break;
267 if (!iskeychar(c))
268 break;
269 name[len++] = tolower(c);
270 if (len >= MAXNAME)
271 return -1;
273 name[len] = 0;
274 while (c == ' ' || c == '\t')
275 c = get_next_char();
277 value = NULL;
278 if (c != '\n') {
279 if (c != '=')
280 return -1;
281 value = parse_value();
282 if (!value)
283 return -1;
285 return fn(name, value, data);
288 static int get_extended_base_var(char *name, int baselen, int c)
290 do {
291 if (c == '\n')
292 goto error_incomplete_line;
293 c = get_next_char();
294 } while (isspace(c));
296 /* We require the format to be '[base "extension"]' */
297 if (c != '"')
298 return -1;
299 name[baselen++] = '.';
301 for (;;) {
302 int c = get_next_char();
303 if (c == '\n')
304 goto error_incomplete_line;
305 if (c == '"')
306 break;
307 if (c == '\\') {
308 c = get_next_char();
309 if (c == '\n')
310 goto error_incomplete_line;
312 name[baselen++] = c;
313 if (baselen > MAXNAME / 2)
314 return -1;
317 /* Final ']' */
318 if (get_next_char() != ']')
319 return -1;
320 return baselen;
321 error_incomplete_line:
322 cf->linenr--;
323 return -1;
326 static int get_base_var(char *name)
328 int baselen = 0;
330 for (;;) {
331 int c = get_next_char();
332 if (cf->eof)
333 return -1;
334 if (c == ']')
335 return baselen;
336 if (isspace(c))
337 return get_extended_base_var(name, baselen, c);
338 if (!iskeychar(c) && c != '.')
339 return -1;
340 if (baselen > MAXNAME / 2)
341 return -1;
342 name[baselen++] = tolower(c);
346 static int git_parse_file(config_fn_t fn, void *data)
348 int comment = 0;
349 int baselen = 0;
350 char *var = cf->var;
352 /* U+FEFF Byte Order Mark in UTF8 */
353 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
354 const unsigned char *bomptr = utf8_bom;
356 for (;;) {
357 int c = get_next_char();
358 if (bomptr && *bomptr) {
359 /* We are at the file beginning; skip UTF8-encoded BOM
360 * if present. Sane editors won't put this in on their
361 * own, but e.g. Windows Notepad will do it happily. */
362 if ((unsigned char) c == *bomptr) {
363 bomptr++;
364 continue;
365 } else {
366 /* Do not tolerate partial BOM. */
367 if (bomptr != utf8_bom)
368 break;
369 /* No BOM at file beginning. Cool. */
370 bomptr = NULL;
373 if (c == '\n') {
374 if (cf->eof)
375 return 0;
376 comment = 0;
377 continue;
379 if (comment || isspace(c))
380 continue;
381 if (c == '#' || c == ';') {
382 comment = 1;
383 continue;
385 if (c == '[') {
386 baselen = get_base_var(var);
387 if (baselen <= 0)
388 break;
389 var[baselen++] = '.';
390 var[baselen] = 0;
391 continue;
393 if (!isalpha(c))
394 break;
395 var[baselen] = tolower(c);
396 if (get_value(fn, data, var, baselen+1) < 0)
397 break;
399 die("bad config file line %d in %s", cf->linenr, cf->name);
402 static int parse_unit_factor(const char *end, uintmax_t *val)
404 if (!*end)
405 return 1;
406 else if (!strcasecmp(end, "k")) {
407 *val *= 1024;
408 return 1;
410 else if (!strcasecmp(end, "m")) {
411 *val *= 1024 * 1024;
412 return 1;
414 else if (!strcasecmp(end, "g")) {
415 *val *= 1024 * 1024 * 1024;
416 return 1;
418 return 0;
421 static int git_parse_long(const char *value, long *ret)
423 if (value && *value) {
424 char *end;
425 intmax_t val;
426 uintmax_t uval;
427 uintmax_t factor = 1;
429 errno = 0;
430 val = strtoimax(value, &end, 0);
431 if (errno == ERANGE)
432 return 0;
433 if (!parse_unit_factor(end, &factor))
434 return 0;
435 uval = abs(val);
436 uval *= factor;
437 if ((uval > maximum_signed_value_of_type(long)) ||
438 (abs(val) > uval))
439 return 0;
440 val *= factor;
441 *ret = val;
442 return 1;
444 return 0;
447 int git_parse_ulong(const char *value, unsigned long *ret)
449 if (value && *value) {
450 char *end;
451 uintmax_t val;
452 uintmax_t oldval;
454 errno = 0;
455 val = strtoumax(value, &end, 0);
456 if (errno == ERANGE)
457 return 0;
458 oldval = val;
459 if (!parse_unit_factor(end, &val))
460 return 0;
461 if ((val > maximum_unsigned_value_of_type(long)) ||
462 (oldval > val))
463 return 0;
464 *ret = val;
465 return 1;
467 return 0;
470 static void die_bad_config(const char *name)
472 if (cf && cf->name)
473 die("bad config value for '%s' in %s", name, cf->name);
474 die("bad config value for '%s'", name);
477 int git_config_int(const char *name, const char *value)
479 long ret = 0;
480 if (!git_parse_long(value, &ret))
481 die_bad_config(name);
482 return ret;
485 unsigned long git_config_ulong(const char *name, const char *value)
487 unsigned long ret;
488 if (!git_parse_ulong(value, &ret))
489 die_bad_config(name);
490 return ret;
493 static int git_config_maybe_bool_text(const char *name, const char *value)
495 if (!value)
496 return 1;
497 if (!*value)
498 return 0;
499 if (!strcasecmp(value, "true")
500 || !strcasecmp(value, "yes")
501 || !strcasecmp(value, "on"))
502 return 1;
503 if (!strcasecmp(value, "false")
504 || !strcasecmp(value, "no")
505 || !strcasecmp(value, "off"))
506 return 0;
507 return -1;
510 int git_config_maybe_bool(const char *name, const char *value)
512 long v = git_config_maybe_bool_text(name, value);
513 if (0 <= v)
514 return v;
515 if (git_parse_long(value, &v))
516 return !!v;
517 return -1;
520 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
522 int v = git_config_maybe_bool_text(name, value);
523 if (0 <= v) {
524 *is_bool = 1;
525 return v;
527 *is_bool = 0;
528 return git_config_int(name, value);
531 int git_config_bool(const char *name, const char *value)
533 int discard;
534 return !!git_config_bool_or_int(name, value, &discard);
537 int git_config_string(const char **dest, const char *var, const char *value)
539 if (!value)
540 return config_error_nonbool(var);
541 *dest = xstrdup(value);
542 return 0;
545 int git_config_pathname(const char **dest, const char *var, const char *value)
547 if (!value)
548 return config_error_nonbool(var);
549 *dest = expand_user_path(value);
550 if (!*dest)
551 die("Failed to expand user dir in: '%s'", value);
552 return 0;
555 static int git_default_core_config(const char *var, const char *value)
557 /* This needs a better name */
558 if (!strcmp(var, "core.filemode")) {
559 trust_executable_bit = git_config_bool(var, value);
560 return 0;
562 if (!strcmp(var, "core.trustctime")) {
563 trust_ctime = git_config_bool(var, value);
564 return 0;
567 if (!strcmp(var, "core.quotepath")) {
568 quote_path_fully = git_config_bool(var, value);
569 return 0;
572 if (!strcmp(var, "core.symlinks")) {
573 has_symlinks = git_config_bool(var, value);
574 return 0;
577 if (!strcmp(var, "core.ignorecase")) {
578 ignore_case = git_config_bool(var, value);
579 return 0;
582 if (!strcmp(var, "core.attributesfile"))
583 return git_config_pathname(&git_attributes_file, var, value);
585 if (!strcmp(var, "core.bare")) {
586 is_bare_repository_cfg = git_config_bool(var, value);
587 return 0;
590 if (!strcmp(var, "core.ignorestat")) {
591 assume_unchanged = git_config_bool(var, value);
592 return 0;
595 if (!strcmp(var, "core.prefersymlinkrefs")) {
596 prefer_symlink_refs = git_config_bool(var, value);
597 return 0;
600 if (!strcmp(var, "core.logallrefupdates")) {
601 log_all_ref_updates = git_config_bool(var, value);
602 return 0;
605 if (!strcmp(var, "core.warnambiguousrefs")) {
606 warn_ambiguous_refs = git_config_bool(var, value);
607 return 0;
610 if (!strcmp(var, "core.abbrev")) {
611 int abbrev = git_config_int(var, value);
612 if (abbrev < minimum_abbrev || abbrev > 40)
613 return -1;
614 default_abbrev = abbrev;
615 return 0;
618 if (!strcmp(var, "core.loosecompression")) {
619 int level = git_config_int(var, value);
620 if (level == -1)
621 level = Z_DEFAULT_COMPRESSION;
622 else if (level < 0 || level > Z_BEST_COMPRESSION)
623 die("bad zlib compression level %d", level);
624 zlib_compression_level = level;
625 zlib_compression_seen = 1;
626 return 0;
629 if (!strcmp(var, "core.compression")) {
630 int level = git_config_int(var, value);
631 if (level == -1)
632 level = Z_DEFAULT_COMPRESSION;
633 else if (level < 0 || level > Z_BEST_COMPRESSION)
634 die("bad zlib compression level %d", level);
635 core_compression_level = level;
636 core_compression_seen = 1;
637 if (!zlib_compression_seen)
638 zlib_compression_level = level;
639 return 0;
642 if (!strcmp(var, "core.packedgitwindowsize")) {
643 int pgsz_x2 = getpagesize() * 2;
644 packed_git_window_size = git_config_ulong(var, value);
646 /* This value must be multiple of (pagesize * 2) */
647 packed_git_window_size /= pgsz_x2;
648 if (packed_git_window_size < 1)
649 packed_git_window_size = 1;
650 packed_git_window_size *= pgsz_x2;
651 return 0;
654 if (!strcmp(var, "core.bigfilethreshold")) {
655 big_file_threshold = git_config_ulong(var, value);
656 return 0;
659 if (!strcmp(var, "core.packedgitlimit")) {
660 packed_git_limit = git_config_ulong(var, value);
661 return 0;
664 if (!strcmp(var, "core.deltabasecachelimit")) {
665 delta_base_cache_limit = git_config_ulong(var, value);
666 return 0;
669 if (!strcmp(var, "core.logpackaccess"))
670 return git_config_string(&log_pack_access, var, value);
672 if (!strcmp(var, "core.autocrlf")) {
673 if (value && !strcasecmp(value, "input")) {
674 if (core_eol == EOL_CRLF)
675 return error("core.autocrlf=input conflicts with core.eol=crlf");
676 auto_crlf = AUTO_CRLF_INPUT;
677 return 0;
679 auto_crlf = git_config_bool(var, value);
680 return 0;
683 if (!strcmp(var, "core.safecrlf")) {
684 if (value && !strcasecmp(value, "warn")) {
685 safe_crlf = SAFE_CRLF_WARN;
686 return 0;
688 safe_crlf = git_config_bool(var, value);
689 return 0;
692 if (!strcmp(var, "core.eol")) {
693 if (value && !strcasecmp(value, "lf"))
694 core_eol = EOL_LF;
695 else if (value && !strcasecmp(value, "crlf"))
696 core_eol = EOL_CRLF;
697 else if (value && !strcasecmp(value, "native"))
698 core_eol = EOL_NATIVE;
699 else
700 core_eol = EOL_UNSET;
701 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
702 return error("core.autocrlf=input conflicts with core.eol=crlf");
703 return 0;
706 if (!strcmp(var, "core.notesref")) {
707 notes_ref_name = xstrdup(value);
708 return 0;
711 if (!strcmp(var, "core.pager"))
712 return git_config_string(&pager_program, var, value);
714 if (!strcmp(var, "core.editor"))
715 return git_config_string(&editor_program, var, value);
717 if (!strcmp(var, "core.askpass"))
718 return git_config_string(&askpass_program, var, value);
720 if (!strcmp(var, "core.excludesfile"))
721 return git_config_pathname(&excludes_file, var, value);
723 if (!strcmp(var, "core.whitespace")) {
724 if (!value)
725 return config_error_nonbool(var);
726 whitespace_rule_cfg = parse_whitespace_rule(value);
727 return 0;
730 if (!strcmp(var, "core.fsyncobjectfiles")) {
731 fsync_object_files = git_config_bool(var, value);
732 return 0;
735 if (!strcmp(var, "core.preloadindex")) {
736 core_preload_index = git_config_bool(var, value);
737 return 0;
740 if (!strcmp(var, "core.createobject")) {
741 if (!strcmp(value, "rename"))
742 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
743 else if (!strcmp(value, "link"))
744 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
745 else
746 die("Invalid mode for object creation: %s", value);
747 return 0;
750 if (!strcmp(var, "core.sparsecheckout")) {
751 core_apply_sparse_checkout = git_config_bool(var, value);
752 return 0;
755 if (!strcmp(var, "core.hidedotfiles")) {
756 if (value && !strcasecmp(value, "dotgitonly")) {
757 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
758 return 0;
760 hide_dotfiles = git_config_bool(var, value);
761 return 0;
764 /* Add other config variables here and to Documentation/config.txt. */
765 return 0;
768 static int git_default_user_config(const char *var, const char *value)
770 if (!strcmp(var, "user.name")) {
771 if (!value)
772 return config_error_nonbool(var);
773 strlcpy(git_default_name, value, sizeof(git_default_name));
774 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
775 return 0;
778 if (!strcmp(var, "user.email")) {
779 if (!value)
780 return config_error_nonbool(var);
781 strlcpy(git_default_email, value, sizeof(git_default_email));
782 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
783 return 0;
786 /* Add other config variables here and to Documentation/config.txt. */
787 return 0;
790 static int git_default_i18n_config(const char *var, const char *value)
792 if (!strcmp(var, "i18n.commitencoding"))
793 return git_config_string(&git_commit_encoding, var, value);
795 if (!strcmp(var, "i18n.logoutputencoding"))
796 return git_config_string(&git_log_output_encoding, var, value);
798 /* Add other config variables here and to Documentation/config.txt. */
799 return 0;
802 static int git_default_branch_config(const char *var, const char *value)
804 if (!strcmp(var, "branch.autosetupmerge")) {
805 if (value && !strcasecmp(value, "always")) {
806 git_branch_track = BRANCH_TRACK_ALWAYS;
807 return 0;
809 git_branch_track = git_config_bool(var, value);
810 return 0;
812 if (!strcmp(var, "branch.autosetuprebase")) {
813 if (!value)
814 return config_error_nonbool(var);
815 else if (!strcmp(value, "never"))
816 autorebase = AUTOREBASE_NEVER;
817 else if (!strcmp(value, "local"))
818 autorebase = AUTOREBASE_LOCAL;
819 else if (!strcmp(value, "remote"))
820 autorebase = AUTOREBASE_REMOTE;
821 else if (!strcmp(value, "always"))
822 autorebase = AUTOREBASE_ALWAYS;
823 else
824 return error("Malformed value for %s", var);
825 return 0;
828 /* Add other config variables here and to Documentation/config.txt. */
829 return 0;
832 static int git_default_push_config(const char *var, const char *value)
834 if (!strcmp(var, "push.default")) {
835 if (!value)
836 return config_error_nonbool(var);
837 else if (!strcmp(value, "nothing"))
838 push_default = PUSH_DEFAULT_NOTHING;
839 else if (!strcmp(value, "matching"))
840 push_default = PUSH_DEFAULT_MATCHING;
841 else if (!strcmp(value, "upstream"))
842 push_default = PUSH_DEFAULT_UPSTREAM;
843 else if (!strcmp(value, "tracking")) /* deprecated */
844 push_default = PUSH_DEFAULT_UPSTREAM;
845 else if (!strcmp(value, "current"))
846 push_default = PUSH_DEFAULT_CURRENT;
847 else {
848 error("Malformed value for %s: %s", var, value);
849 return error("Must be one of nothing, matching, "
850 "tracking or current.");
852 return 0;
855 /* Add other config variables here and to Documentation/config.txt. */
856 return 0;
859 static int git_default_mailmap_config(const char *var, const char *value)
861 if (!strcmp(var, "mailmap.file"))
862 return git_config_string(&git_mailmap_file, var, value);
864 /* Add other config variables here and to Documentation/config.txt. */
865 return 0;
868 int git_default_config(const char *var, const char *value, void *dummy)
870 if (!prefixcmp(var, "core."))
871 return git_default_core_config(var, value);
873 if (!prefixcmp(var, "user."))
874 return git_default_user_config(var, value);
876 if (!prefixcmp(var, "i18n."))
877 return git_default_i18n_config(var, value);
879 if (!prefixcmp(var, "branch."))
880 return git_default_branch_config(var, value);
882 if (!prefixcmp(var, "push."))
883 return git_default_push_config(var, value);
885 if (!prefixcmp(var, "mailmap."))
886 return git_default_mailmap_config(var, value);
888 if (!prefixcmp(var, "advice."))
889 return git_default_advice_config(var, value);
891 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
892 pager_use_color = git_config_bool(var,value);
893 return 0;
896 if (!strcmp(var, "pack.packsizelimit")) {
897 pack_size_limit_cfg = git_config_ulong(var, value);
898 return 0;
900 /* Add other config variables here and to Documentation/config.txt. */
901 return 0;
904 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
906 int ret;
907 FILE *f = fopen(filename, "r");
909 ret = -1;
910 if (f) {
911 config_file top;
913 /* push config-file parsing state stack */
914 top.prev = cf;
915 top.f = f;
916 top.name = filename;
917 top.linenr = 1;
918 top.eof = 0;
919 strbuf_init(&top.value, 1024);
920 cf = &top;
922 ret = git_parse_file(fn, data);
924 /* pop config-file parsing state stack */
925 strbuf_release(&top.value);
926 cf = top.prev;
928 fclose(f);
930 return ret;
933 const char *git_etc_gitconfig(void)
935 static const char *system_wide;
936 if (!system_wide)
937 system_wide = system_path(ETC_GITCONFIG);
938 return system_wide;
941 int git_env_bool(const char *k, int def)
943 const char *v = getenv(k);
944 return v ? git_config_bool(k, v) : def;
947 int git_config_system(void)
949 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
952 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
954 int ret = 0, found = 0;
955 const char *home = NULL;
957 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
958 ret += git_config_from_file(fn, git_etc_gitconfig(),
959 data);
960 found += 1;
963 home = get_home_directory();
964 if (home) {
965 char buf[PATH_MAX];
966 char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
967 if (!access(user_config, R_OK)) {
968 ret += git_config_from_file(fn, user_config, data);
969 found += 1;
973 if (repo_config && !access(repo_config, R_OK)) {
974 ret += git_config_from_file(fn, repo_config, data);
975 found += 1;
978 switch (git_config_from_parameters(fn, data)) {
979 case -1: /* error */
980 die("unable to parse command-line config");
981 break;
982 case 0: /* found nothing */
983 break;
984 default: /* found at least one item */
985 found++;
986 break;
989 return ret == 0 ? found : ret;
992 int git_config_with_options(config_fn_t fn, void *data,
993 const char *filename, int respect_includes)
995 char *repo_config = NULL;
996 int ret;
997 struct config_include_data inc = CONFIG_INCLUDE_INIT;
999 if (respect_includes) {
1000 inc.fn = fn;
1001 inc.data = data;
1002 fn = git_config_include;
1003 data = &inc;
1007 * If we have a specific filename, use it. Otherwise, follow the
1008 * regular lookup sequence.
1010 if (filename)
1011 return git_config_from_file(fn, filename, data);
1013 repo_config = git_pathdup("config");
1014 ret = git_config_early(fn, data, repo_config);
1015 if (repo_config)
1016 free(repo_config);
1017 return ret;
1020 int git_config(config_fn_t fn, void *data)
1022 return git_config_with_options(fn, data, NULL, 1);
1026 * Find all the stuff for git_config_set() below.
1029 #define MAX_MATCHES 512
1031 static struct {
1032 int baselen;
1033 char *key;
1034 int do_not_match;
1035 regex_t *value_regex;
1036 int multi_replace;
1037 size_t offset[MAX_MATCHES];
1038 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1039 int seen;
1040 } store;
1042 static int matches(const char *key, const char *value)
1044 return !strcmp(key, store.key) &&
1045 (store.value_regex == NULL ||
1046 (store.do_not_match ^
1047 !regexec(store.value_regex, value, 0, NULL, 0)));
1050 static int store_aux(const char *key, const char *value, void *cb)
1052 const char *ep;
1053 size_t section_len;
1054 FILE *f = cf->f;
1056 switch (store.state) {
1057 case KEY_SEEN:
1058 if (matches(key, value)) {
1059 if (store.seen == 1 && store.multi_replace == 0) {
1060 warning("%s has multiple values", key);
1061 } else if (store.seen >= MAX_MATCHES) {
1062 error("too many matches for %s", key);
1063 return 1;
1066 store.offset[store.seen] = ftell(f);
1067 store.seen++;
1069 break;
1070 case SECTION_SEEN:
1072 * What we are looking for is in store.key (both
1073 * section and var), and its section part is baselen
1074 * long. We found key (again, both section and var).
1075 * We would want to know if this key is in the same
1076 * section as what we are looking for. We already
1077 * know we are in the same section as what should
1078 * hold store.key.
1080 ep = strrchr(key, '.');
1081 section_len = ep - key;
1083 if ((section_len != store.baselen) ||
1084 memcmp(key, store.key, section_len+1)) {
1085 store.state = SECTION_END_SEEN;
1086 break;
1090 * Do not increment matches: this is no match, but we
1091 * just made sure we are in the desired section.
1093 store.offset[store.seen] = ftell(f);
1094 /* fallthru */
1095 case SECTION_END_SEEN:
1096 case START:
1097 if (matches(key, value)) {
1098 store.offset[store.seen] = ftell(f);
1099 store.state = KEY_SEEN;
1100 store.seen++;
1101 } else {
1102 if (strrchr(key, '.') - key == store.baselen &&
1103 !strncmp(key, store.key, store.baselen)) {
1104 store.state = SECTION_SEEN;
1105 store.offset[store.seen] = ftell(f);
1109 return 0;
1112 static int write_error(const char *filename)
1114 error("failed to write new configuration file %s", filename);
1116 /* Same error code as "failed to rename". */
1117 return 4;
1120 static int store_write_section(int fd, const char *key)
1122 const char *dot;
1123 int i, success;
1124 struct strbuf sb = STRBUF_INIT;
1126 dot = memchr(key, '.', store.baselen);
1127 if (dot) {
1128 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1129 for (i = dot - key + 1; i < store.baselen; i++) {
1130 if (key[i] == '"' || key[i] == '\\')
1131 strbuf_addch(&sb, '\\');
1132 strbuf_addch(&sb, key[i]);
1134 strbuf_addstr(&sb, "\"]\n");
1135 } else {
1136 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1139 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1140 strbuf_release(&sb);
1142 return success;
1145 static int store_write_pair(int fd, const char *key, const char *value)
1147 int i, success;
1148 int length = strlen(key + store.baselen + 1);
1149 const char *quote = "";
1150 struct strbuf sb = STRBUF_INIT;
1153 * Check to see if the value needs to be surrounded with a dq pair.
1154 * Note that problematic characters are always backslash-quoted; this
1155 * check is about not losing leading or trailing SP and strings that
1156 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1157 * configuration parser.
1159 if (value[0] == ' ')
1160 quote = "\"";
1161 for (i = 0; value[i]; i++)
1162 if (value[i] == ';' || value[i] == '#')
1163 quote = "\"";
1164 if (i && value[i - 1] == ' ')
1165 quote = "\"";
1167 strbuf_addf(&sb, "\t%.*s = %s",
1168 length, key + store.baselen + 1, quote);
1170 for (i = 0; value[i]; i++)
1171 switch (value[i]) {
1172 case '\n':
1173 strbuf_addstr(&sb, "\\n");
1174 break;
1175 case '\t':
1176 strbuf_addstr(&sb, "\\t");
1177 break;
1178 case '"':
1179 case '\\':
1180 strbuf_addch(&sb, '\\');
1181 default:
1182 strbuf_addch(&sb, value[i]);
1183 break;
1185 strbuf_addf(&sb, "%s\n", quote);
1187 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1188 strbuf_release(&sb);
1190 return success;
1193 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1194 size_t offset_, int *found_bracket)
1196 size_t equal_offset = size, bracket_offset = size;
1197 ssize_t offset;
1199 contline:
1200 for (offset = offset_-2; offset > 0
1201 && contents[offset] != '\n'; offset--)
1202 switch (contents[offset]) {
1203 case '=': equal_offset = offset; break;
1204 case ']': bracket_offset = offset; break;
1206 if (offset > 0 && contents[offset-1] == '\\') {
1207 offset_ = offset;
1208 goto contline;
1210 if (bracket_offset < equal_offset) {
1211 *found_bracket = 1;
1212 offset = bracket_offset+1;
1213 } else
1214 offset++;
1216 return offset;
1219 int git_config_set_in_file(const char *config_filename,
1220 const char *key, const char *value)
1222 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1225 int git_config_set(const char *key, const char *value)
1227 return git_config_set_multivar(key, value, NULL, 0);
1231 * Auxiliary function to sanity-check and split the key into the section
1232 * identifier and variable name.
1234 * Returns 0 on success, -1 when there is an invalid character in the key and
1235 * -2 if there is no section name in the key.
1237 * store_key - pointer to char* which will hold a copy of the key with
1238 * lowercase section and variable name
1239 * baselen - pointer to int which will hold the length of the
1240 * section + subsection part, can be NULL
1242 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1244 int i, dot, baselen;
1245 const char *last_dot = strrchr(key, '.');
1248 * Since "key" actually contains the section name and the real
1249 * key name separated by a dot, we have to know where the dot is.
1252 if (last_dot == NULL || last_dot == key) {
1253 error("key does not contain a section: %s", key);
1254 return -CONFIG_NO_SECTION_OR_NAME;
1257 if (!last_dot[1]) {
1258 error("key does not contain variable name: %s", key);
1259 return -CONFIG_NO_SECTION_OR_NAME;
1262 baselen = last_dot - key;
1263 if (baselen_)
1264 *baselen_ = baselen;
1267 * Validate the key and while at it, lower case it for matching.
1269 *store_key = xmalloc(strlen(key) + 1);
1271 dot = 0;
1272 for (i = 0; key[i]; i++) {
1273 unsigned char c = key[i];
1274 if (c == '.')
1275 dot = 1;
1276 /* Leave the extended basename untouched.. */
1277 if (!dot || i > baselen) {
1278 if (!iskeychar(c) ||
1279 (i == baselen + 1 && !isalpha(c))) {
1280 error("invalid key: %s", key);
1281 goto out_free_ret_1;
1283 c = tolower(c);
1284 } else if (c == '\n') {
1285 error("invalid key (newline): %s", key);
1286 goto out_free_ret_1;
1288 (*store_key)[i] = c;
1290 (*store_key)[i] = 0;
1292 return 0;
1294 out_free_ret_1:
1295 free(*store_key);
1296 return -CONFIG_INVALID_KEY;
1300 * If value==NULL, unset in (remove from) config,
1301 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1302 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1303 * else all matching key/values (regardless how many) are removed,
1304 * before the new pair is written.
1306 * Returns 0 on success.
1308 * This function does this:
1310 * - it locks the config file by creating ".git/config.lock"
1312 * - it then parses the config using store_aux() as validator to find
1313 * the position on the key/value pair to replace. If it is to be unset,
1314 * it must be found exactly once.
1316 * - the config file is mmap()ed and the part before the match (if any) is
1317 * written to the lock file, then the changed part and the rest.
1319 * - the config file is removed and the lock file rename()d to it.
1322 int git_config_set_multivar_in_file(const char *config_filename,
1323 const char *key, const char *value,
1324 const char *value_regex, int multi_replace)
1326 int fd = -1, in_fd;
1327 int ret;
1328 struct lock_file *lock = NULL;
1329 char *filename_buf = NULL;
1331 /* parse-key returns negative; flip the sign to feed exit(3) */
1332 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1333 if (ret)
1334 goto out_free;
1336 store.multi_replace = multi_replace;
1338 if (!config_filename)
1339 config_filename = filename_buf = git_pathdup("config");
1342 * The lock serves a purpose in addition to locking: the new
1343 * contents of .git/config will be written into it.
1345 lock = xcalloc(sizeof(struct lock_file), 1);
1346 fd = hold_lock_file_for_update(lock, config_filename, 0);
1347 if (fd < 0) {
1348 error("could not lock config file %s: %s", config_filename, strerror(errno));
1349 free(store.key);
1350 ret = CONFIG_NO_LOCK;
1351 goto out_free;
1355 * If .git/config does not exist yet, write a minimal version.
1357 in_fd = open(config_filename, O_RDONLY);
1358 if ( in_fd < 0 ) {
1359 free(store.key);
1361 if ( ENOENT != errno ) {
1362 error("opening %s: %s", config_filename,
1363 strerror(errno));
1364 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1365 goto out_free;
1367 /* if nothing to unset, error out */
1368 if (value == NULL) {
1369 ret = CONFIG_NOTHING_SET;
1370 goto out_free;
1373 store.key = (char *)key;
1374 if (!store_write_section(fd, key) ||
1375 !store_write_pair(fd, key, value))
1376 goto write_err_out;
1377 } else {
1378 struct stat st;
1379 char *contents;
1380 size_t contents_sz, copy_begin, copy_end;
1381 int i, new_line = 0;
1383 if (value_regex == NULL)
1384 store.value_regex = NULL;
1385 else {
1386 if (value_regex[0] == '!') {
1387 store.do_not_match = 1;
1388 value_regex++;
1389 } else
1390 store.do_not_match = 0;
1392 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1393 if (regcomp(store.value_regex, value_regex,
1394 REG_EXTENDED)) {
1395 error("invalid pattern: %s", value_regex);
1396 free(store.value_regex);
1397 ret = CONFIG_INVALID_PATTERN;
1398 goto out_free;
1402 store.offset[0] = 0;
1403 store.state = START;
1404 store.seen = 0;
1407 * After this, store.offset will contain the *end* offset
1408 * of the last match, or remain at 0 if no match was found.
1409 * As a side effect, we make sure to transform only a valid
1410 * existing config file.
1412 if (git_config_from_file(store_aux, config_filename, NULL)) {
1413 error("invalid config file %s", config_filename);
1414 free(store.key);
1415 if (store.value_regex != NULL) {
1416 regfree(store.value_regex);
1417 free(store.value_regex);
1419 ret = CONFIG_INVALID_FILE;
1420 goto out_free;
1423 free(store.key);
1424 if (store.value_regex != NULL) {
1425 regfree(store.value_regex);
1426 free(store.value_regex);
1429 /* if nothing to unset, or too many matches, error out */
1430 if ((store.seen == 0 && value == NULL) ||
1431 (store.seen > 1 && multi_replace == 0)) {
1432 ret = CONFIG_NOTHING_SET;
1433 goto out_free;
1436 fstat(in_fd, &st);
1437 contents_sz = xsize_t(st.st_size);
1438 contents = xmmap(NULL, contents_sz, PROT_READ,
1439 MAP_PRIVATE, in_fd, 0);
1440 close(in_fd);
1442 if (store.seen == 0)
1443 store.seen = 1;
1445 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1446 if (store.offset[i] == 0) {
1447 store.offset[i] = copy_end = contents_sz;
1448 } else if (store.state != KEY_SEEN) {
1449 copy_end = store.offset[i];
1450 } else
1451 copy_end = find_beginning_of_line(
1452 contents, contents_sz,
1453 store.offset[i]-2, &new_line);
1455 if (copy_end > 0 && contents[copy_end-1] != '\n')
1456 new_line = 1;
1458 /* write the first part of the config */
1459 if (copy_end > copy_begin) {
1460 if (write_in_full(fd, contents + copy_begin,
1461 copy_end - copy_begin) <
1462 copy_end - copy_begin)
1463 goto write_err_out;
1464 if (new_line &&
1465 write_str_in_full(fd, "\n") != 1)
1466 goto write_err_out;
1468 copy_begin = store.offset[i];
1471 /* write the pair (value == NULL means unset) */
1472 if (value != NULL) {
1473 if (store.state == START) {
1474 if (!store_write_section(fd, key))
1475 goto write_err_out;
1477 if (!store_write_pair(fd, key, value))
1478 goto write_err_out;
1481 /* write the rest of the config */
1482 if (copy_begin < contents_sz)
1483 if (write_in_full(fd, contents + copy_begin,
1484 contents_sz - copy_begin) <
1485 contents_sz - copy_begin)
1486 goto write_err_out;
1488 munmap(contents, contents_sz);
1491 if (commit_lock_file(lock) < 0) {
1492 error("could not commit config file %s", config_filename);
1493 ret = CONFIG_NO_WRITE;
1494 goto out_free;
1498 * lock is committed, so don't try to roll it back below.
1499 * NOTE: Since lockfile.c keeps a linked list of all created
1500 * lock_file structures, it isn't safe to free(lock). It's
1501 * better to just leave it hanging around.
1503 lock = NULL;
1504 ret = 0;
1506 out_free:
1507 if (lock)
1508 rollback_lock_file(lock);
1509 free(filename_buf);
1510 return ret;
1512 write_err_out:
1513 ret = write_error(lock->filename);
1514 goto out_free;
1518 int git_config_set_multivar(const char *key, const char *value,
1519 const char *value_regex, int multi_replace)
1521 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1522 multi_replace);
1525 static int section_name_match (const char *buf, const char *name)
1527 int i = 0, j = 0, dot = 0;
1528 if (buf[i] != '[')
1529 return 0;
1530 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1531 if (!dot && isspace(buf[i])) {
1532 dot = 1;
1533 if (name[j++] != '.')
1534 break;
1535 for (i++; isspace(buf[i]); i++)
1536 ; /* do nothing */
1537 if (buf[i] != '"')
1538 break;
1539 continue;
1541 if (buf[i] == '\\' && dot)
1542 i++;
1543 else if (buf[i] == '"' && dot) {
1544 for (i++; isspace(buf[i]); i++)
1545 ; /* do_nothing */
1546 break;
1548 if (buf[i] != name[j++])
1549 break;
1551 if (buf[i] == ']' && name[j] == 0) {
1553 * We match, now just find the right length offset by
1554 * gobbling up any whitespace after it, as well
1556 i++;
1557 for (; buf[i] && isspace(buf[i]); i++)
1558 ; /* do nothing */
1559 return i;
1561 return 0;
1564 /* if new_name == NULL, the section is removed instead */
1565 int git_config_rename_section_in_file(const char *config_filename,
1566 const char *old_name, const char *new_name)
1568 int ret = 0, remove = 0;
1569 char *filename_buf = NULL;
1570 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1571 int out_fd;
1572 char buf[1024];
1573 FILE *config_file;
1575 if (!config_filename)
1576 config_filename = filename_buf = git_pathdup("config");
1578 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1579 if (out_fd < 0) {
1580 ret = error("could not lock config file %s", config_filename);
1581 goto out;
1584 if (!(config_file = fopen(config_filename, "rb"))) {
1585 /* no config file means nothing to rename, no error */
1586 goto unlock_and_out;
1589 while (fgets(buf, sizeof(buf), config_file)) {
1590 int i;
1591 int length;
1592 char *output = buf;
1593 for (i = 0; buf[i] && isspace(buf[i]); i++)
1594 ; /* do nothing */
1595 if (buf[i] == '[') {
1596 /* it's a section */
1597 int offset = section_name_match(&buf[i], old_name);
1598 if (offset > 0) {
1599 ret++;
1600 if (new_name == NULL) {
1601 remove = 1;
1602 continue;
1604 store.baselen = strlen(new_name);
1605 if (!store_write_section(out_fd, new_name)) {
1606 ret = write_error(lock->filename);
1607 goto out;
1610 * We wrote out the new section, with
1611 * a newline, now skip the old
1612 * section's length
1614 output += offset + i;
1615 if (strlen(output) > 0) {
1617 * More content means there's
1618 * a declaration to put on the
1619 * next line; indent with a
1620 * tab
1622 output -= 1;
1623 output[0] = '\t';
1626 remove = 0;
1628 if (remove)
1629 continue;
1630 length = strlen(output);
1631 if (write_in_full(out_fd, output, length) != length) {
1632 ret = write_error(lock->filename);
1633 goto out;
1636 fclose(config_file);
1637 unlock_and_out:
1638 if (commit_lock_file(lock) < 0)
1639 ret = error("could not commit config file %s", config_filename);
1640 out:
1641 free(filename_buf);
1642 return ret;
1645 int git_config_rename_section(const char *old_name, const char *new_name)
1647 return git_config_rename_section_in_file(NULL, old_name, new_name);
1651 * Call this to report error for your variable that should not
1652 * get a boolean value (i.e. "[my] var" means "true").
1654 int config_error_nonbool(const char *var)
1656 return error("Missing value for '%s'", var);