Windows resource: handle dashes in the Git version gracefully
[git/dscho.git] / config.c
blob5ea36a7cd7fd3450501d6314e4ae054d7f91988d
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_or_warn(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.precomposeunicode")) {
762 precomposed_unicode = git_config_bool(var, value);
763 return 0;
766 if (!strcmp(var, "core.hidedotfiles")) {
767 if (value && !strcasecmp(value, "dotgitonly")) {
768 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
769 return 0;
771 hide_dotfiles = git_config_bool(var, value);
772 return 0;
775 /* Add other config variables here and to Documentation/config.txt. */
776 return 0;
779 static int git_default_i18n_config(const char *var, const char *value)
781 if (!strcmp(var, "i18n.commitencoding"))
782 return git_config_string(&git_commit_encoding, var, value);
784 if (!strcmp(var, "i18n.logoutputencoding"))
785 return git_config_string(&git_log_output_encoding, var, value);
787 /* Add other config variables here and to Documentation/config.txt. */
788 return 0;
791 static int git_default_branch_config(const char *var, const char *value)
793 if (!strcmp(var, "branch.autosetupmerge")) {
794 if (value && !strcasecmp(value, "always")) {
795 git_branch_track = BRANCH_TRACK_ALWAYS;
796 return 0;
798 git_branch_track = git_config_bool(var, value);
799 return 0;
801 if (!strcmp(var, "branch.autosetuprebase")) {
802 if (!value)
803 return config_error_nonbool(var);
804 else if (!strcmp(value, "never"))
805 autorebase = AUTOREBASE_NEVER;
806 else if (!strcmp(value, "local"))
807 autorebase = AUTOREBASE_LOCAL;
808 else if (!strcmp(value, "remote"))
809 autorebase = AUTOREBASE_REMOTE;
810 else if (!strcmp(value, "always"))
811 autorebase = AUTOREBASE_ALWAYS;
812 else
813 return error("Malformed value for %s", var);
814 return 0;
817 /* Add other config variables here and to Documentation/config.txt. */
818 return 0;
821 static int git_default_push_config(const char *var, const char *value)
823 if (!strcmp(var, "push.default")) {
824 if (!value)
825 return config_error_nonbool(var);
826 else if (!strcmp(value, "nothing"))
827 push_default = PUSH_DEFAULT_NOTHING;
828 else if (!strcmp(value, "matching"))
829 push_default = PUSH_DEFAULT_MATCHING;
830 else if (!strcmp(value, "simple"))
831 push_default = PUSH_DEFAULT_SIMPLE;
832 else if (!strcmp(value, "upstream"))
833 push_default = PUSH_DEFAULT_UPSTREAM;
834 else if (!strcmp(value, "tracking")) /* deprecated */
835 push_default = PUSH_DEFAULT_UPSTREAM;
836 else if (!strcmp(value, "current"))
837 push_default = PUSH_DEFAULT_CURRENT;
838 else {
839 error("Malformed value for %s: %s", var, value);
840 return error("Must be one of nothing, matching, simple, "
841 "upstream or current.");
843 return 0;
846 /* Add other config variables here and to Documentation/config.txt. */
847 return 0;
850 static int git_default_mailmap_config(const char *var, const char *value)
852 if (!strcmp(var, "mailmap.file"))
853 return git_config_string(&git_mailmap_file, var, value);
855 /* Add other config variables here and to Documentation/config.txt. */
856 return 0;
859 int git_default_config(const char *var, const char *value, void *dummy)
861 if (!prefixcmp(var, "core."))
862 return git_default_core_config(var, value);
864 if (!prefixcmp(var, "user."))
865 return git_ident_config(var, value, dummy);
867 if (!prefixcmp(var, "i18n."))
868 return git_default_i18n_config(var, value);
870 if (!prefixcmp(var, "branch."))
871 return git_default_branch_config(var, value);
873 if (!prefixcmp(var, "push."))
874 return git_default_push_config(var, value);
876 if (!prefixcmp(var, "mailmap."))
877 return git_default_mailmap_config(var, value);
879 if (!prefixcmp(var, "advice."))
880 return git_default_advice_config(var, value);
882 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
883 pager_use_color = git_config_bool(var,value);
884 return 0;
887 if (!strcmp(var, "pack.packsizelimit")) {
888 pack_size_limit_cfg = git_config_ulong(var, value);
889 return 0;
891 /* Add other config variables here and to Documentation/config.txt. */
892 return 0;
895 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
897 int ret;
898 FILE *f = fopen(filename, "r");
900 ret = -1;
901 if (f) {
902 config_file top;
904 /* push config-file parsing state stack */
905 top.prev = cf;
906 top.f = f;
907 top.name = filename;
908 top.linenr = 1;
909 top.eof = 0;
910 strbuf_init(&top.value, 1024);
911 cf = &top;
913 ret = git_parse_file(fn, data);
915 /* pop config-file parsing state stack */
916 strbuf_release(&top.value);
917 cf = top.prev;
919 fclose(f);
921 return ret;
924 const char *git_etc_gitconfig(void)
926 static const char *system_wide;
927 if (!system_wide)
928 system_wide = system_path(ETC_GITCONFIG);
929 return system_wide;
932 int git_env_bool(const char *k, int def)
934 const char *v = getenv(k);
935 return v ? git_config_bool(k, v) : def;
938 int git_config_system(void)
940 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
943 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
945 int ret = 0, found = 0;
946 char *xdg_config = NULL;
947 char *user_config = NULL;
949 home_config_paths(&user_config, &xdg_config, "config");
951 if (git_config_system() && !access_or_warn(git_etc_gitconfig(), R_OK)) {
952 ret += git_config_from_file(fn, git_etc_gitconfig(),
953 data);
954 found += 1;
957 if (xdg_config && !access_or_warn(xdg_config, R_OK)) {
958 ret += git_config_from_file(fn, xdg_config, data);
959 found += 1;
962 if (user_config && !access_or_warn(user_config, R_OK)) {
963 ret += git_config_from_file(fn, user_config, data);
964 found += 1;
967 if (repo_config && !access_or_warn(repo_config, R_OK)) {
968 ret += git_config_from_file(fn, repo_config, data);
969 found += 1;
972 switch (git_config_from_parameters(fn, data)) {
973 case -1: /* error */
974 die("unable to parse command-line config");
975 break;
976 case 0: /* found nothing */
977 break;
978 default: /* found at least one item */
979 found++;
980 break;
983 free(xdg_config);
984 free(user_config);
985 return ret == 0 ? found : ret;
988 int git_config_with_options(config_fn_t fn, void *data,
989 const char *filename, int respect_includes)
991 char *repo_config = NULL;
992 int ret;
993 struct config_include_data inc = CONFIG_INCLUDE_INIT;
995 if (respect_includes) {
996 inc.fn = fn;
997 inc.data = data;
998 fn = git_config_include;
999 data = &inc;
1003 * If we have a specific filename, use it. Otherwise, follow the
1004 * regular lookup sequence.
1006 if (filename)
1007 return git_config_from_file(fn, filename, data);
1009 repo_config = git_pathdup("config");
1010 ret = git_config_early(fn, data, repo_config);
1011 if (repo_config)
1012 free(repo_config);
1013 return ret;
1016 int git_config(config_fn_t fn, void *data)
1018 return git_config_with_options(fn, data, NULL, 1);
1022 * Find all the stuff for git_config_set() below.
1025 #define MAX_MATCHES 512
1027 static struct {
1028 int baselen;
1029 char *key;
1030 int do_not_match;
1031 regex_t *value_regex;
1032 int multi_replace;
1033 size_t offset[MAX_MATCHES];
1034 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1035 int seen;
1036 } store;
1038 static int matches(const char *key, const char *value)
1040 return !strcmp(key, store.key) &&
1041 (store.value_regex == NULL ||
1042 (store.do_not_match ^
1043 !regexec(store.value_regex, value, 0, NULL, 0)));
1046 static int store_aux(const char *key, const char *value, void *cb)
1048 const char *ep;
1049 size_t section_len;
1050 FILE *f = cf->f;
1052 switch (store.state) {
1053 case KEY_SEEN:
1054 if (matches(key, value)) {
1055 if (store.seen == 1 && store.multi_replace == 0) {
1056 warning("%s has multiple values", key);
1057 } else if (store.seen >= MAX_MATCHES) {
1058 error("too many matches for %s", key);
1059 return 1;
1062 store.offset[store.seen] = ftell(f);
1063 store.seen++;
1065 break;
1066 case SECTION_SEEN:
1068 * What we are looking for is in store.key (both
1069 * section and var), and its section part is baselen
1070 * long. We found key (again, both section and var).
1071 * We would want to know if this key is in the same
1072 * section as what we are looking for. We already
1073 * know we are in the same section as what should
1074 * hold store.key.
1076 ep = strrchr(key, '.');
1077 section_len = ep - key;
1079 if ((section_len != store.baselen) ||
1080 memcmp(key, store.key, section_len+1)) {
1081 store.state = SECTION_END_SEEN;
1082 break;
1086 * Do not increment matches: this is no match, but we
1087 * just made sure we are in the desired section.
1089 store.offset[store.seen] = ftell(f);
1090 /* fallthru */
1091 case SECTION_END_SEEN:
1092 case START:
1093 if (matches(key, value)) {
1094 store.offset[store.seen] = ftell(f);
1095 store.state = KEY_SEEN;
1096 store.seen++;
1097 } else {
1098 if (strrchr(key, '.') - key == store.baselen &&
1099 !strncmp(key, store.key, store.baselen)) {
1100 store.state = SECTION_SEEN;
1101 store.offset[store.seen] = ftell(f);
1105 return 0;
1108 static int write_error(const char *filename)
1110 error("failed to write new configuration file %s", filename);
1112 /* Same error code as "failed to rename". */
1113 return 4;
1116 static int store_write_section(int fd, const char *key)
1118 const char *dot;
1119 int i, success;
1120 struct strbuf sb = STRBUF_INIT;
1122 dot = memchr(key, '.', store.baselen);
1123 if (dot) {
1124 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1125 for (i = dot - key + 1; i < store.baselen; i++) {
1126 if (key[i] == '"' || key[i] == '\\')
1127 strbuf_addch(&sb, '\\');
1128 strbuf_addch(&sb, key[i]);
1130 strbuf_addstr(&sb, "\"]\n");
1131 } else {
1132 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1135 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1136 strbuf_release(&sb);
1138 return success;
1141 static int store_write_pair(int fd, const char *key, const char *value)
1143 int i, success;
1144 int length = strlen(key + store.baselen + 1);
1145 const char *quote = "";
1146 struct strbuf sb = STRBUF_INIT;
1149 * Check to see if the value needs to be surrounded with a dq pair.
1150 * Note that problematic characters are always backslash-quoted; this
1151 * check is about not losing leading or trailing SP and strings that
1152 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1153 * configuration parser.
1155 if (value[0] == ' ')
1156 quote = "\"";
1157 for (i = 0; value[i]; i++)
1158 if (value[i] == ';' || value[i] == '#')
1159 quote = "\"";
1160 if (i && value[i - 1] == ' ')
1161 quote = "\"";
1163 strbuf_addf(&sb, "\t%.*s = %s",
1164 length, key + store.baselen + 1, quote);
1166 for (i = 0; value[i]; i++)
1167 switch (value[i]) {
1168 case '\n':
1169 strbuf_addstr(&sb, "\\n");
1170 break;
1171 case '\t':
1172 strbuf_addstr(&sb, "\\t");
1173 break;
1174 case '"':
1175 case '\\':
1176 strbuf_addch(&sb, '\\');
1177 default:
1178 strbuf_addch(&sb, value[i]);
1179 break;
1181 strbuf_addf(&sb, "%s\n", quote);
1183 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1184 strbuf_release(&sb);
1186 return success;
1189 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1190 size_t offset_, int *found_bracket)
1192 size_t equal_offset = size, bracket_offset = size;
1193 ssize_t offset;
1195 contline:
1196 for (offset = offset_-2; offset > 0
1197 && contents[offset] != '\n'; offset--)
1198 switch (contents[offset]) {
1199 case '=': equal_offset = offset; break;
1200 case ']': bracket_offset = offset; break;
1202 if (offset > 0 && contents[offset-1] == '\\') {
1203 offset_ = offset;
1204 goto contline;
1206 if (bracket_offset < equal_offset) {
1207 *found_bracket = 1;
1208 offset = bracket_offset+1;
1209 } else
1210 offset++;
1212 return offset;
1215 int git_config_set_in_file(const char *config_filename,
1216 const char *key, const char *value)
1218 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1221 int git_config_set(const char *key, const char *value)
1223 return git_config_set_multivar(key, value, NULL, 0);
1227 * Auxiliary function to sanity-check and split the key into the section
1228 * identifier and variable name.
1230 * Returns 0 on success, -1 when there is an invalid character in the key and
1231 * -2 if there is no section name in the key.
1233 * store_key - pointer to char* which will hold a copy of the key with
1234 * lowercase section and variable name
1235 * baselen - pointer to int which will hold the length of the
1236 * section + subsection part, can be NULL
1238 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1240 int i, dot, baselen;
1241 const char *last_dot = strrchr(key, '.');
1244 * Since "key" actually contains the section name and the real
1245 * key name separated by a dot, we have to know where the dot is.
1248 if (last_dot == NULL || last_dot == key) {
1249 error("key does not contain a section: %s", key);
1250 return -CONFIG_NO_SECTION_OR_NAME;
1253 if (!last_dot[1]) {
1254 error("key does not contain variable name: %s", key);
1255 return -CONFIG_NO_SECTION_OR_NAME;
1258 baselen = last_dot - key;
1259 if (baselen_)
1260 *baselen_ = baselen;
1263 * Validate the key and while at it, lower case it for matching.
1265 *store_key = xmalloc(strlen(key) + 1);
1267 dot = 0;
1268 for (i = 0; key[i]; i++) {
1269 unsigned char c = key[i];
1270 if (c == '.')
1271 dot = 1;
1272 /* Leave the extended basename untouched.. */
1273 if (!dot || i > baselen) {
1274 if (!iskeychar(c) ||
1275 (i == baselen + 1 && !isalpha(c))) {
1276 error("invalid key: %s", key);
1277 goto out_free_ret_1;
1279 c = tolower(c);
1280 } else if (c == '\n') {
1281 error("invalid key (newline): %s", key);
1282 goto out_free_ret_1;
1284 (*store_key)[i] = c;
1286 (*store_key)[i] = 0;
1288 return 0;
1290 out_free_ret_1:
1291 free(*store_key);
1292 return -CONFIG_INVALID_KEY;
1296 * If value==NULL, unset in (remove from) config,
1297 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1298 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1299 * else all matching key/values (regardless how many) are removed,
1300 * before the new pair is written.
1302 * Returns 0 on success.
1304 * This function does this:
1306 * - it locks the config file by creating ".git/config.lock"
1308 * - it then parses the config using store_aux() as validator to find
1309 * the position on the key/value pair to replace. If it is to be unset,
1310 * it must be found exactly once.
1312 * - the config file is mmap()ed and the part before the match (if any) is
1313 * written to the lock file, then the changed part and the rest.
1315 * - the config file is removed and the lock file rename()d to it.
1318 int git_config_set_multivar_in_file(const char *config_filename,
1319 const char *key, const char *value,
1320 const char *value_regex, int multi_replace)
1322 int fd = -1, in_fd;
1323 int ret;
1324 struct lock_file *lock = NULL;
1325 char *filename_buf = NULL;
1327 /* parse-key returns negative; flip the sign to feed exit(3) */
1328 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1329 if (ret)
1330 goto out_free;
1332 store.multi_replace = multi_replace;
1334 if (!config_filename)
1335 config_filename = filename_buf = git_pathdup("config");
1338 * The lock serves a purpose in addition to locking: the new
1339 * contents of .git/config will be written into it.
1341 lock = xcalloc(sizeof(struct lock_file), 1);
1342 fd = hold_lock_file_for_update(lock, config_filename, 0);
1343 if (fd < 0) {
1344 error("could not lock config file %s: %s", config_filename, strerror(errno));
1345 free(store.key);
1346 ret = CONFIG_NO_LOCK;
1347 goto out_free;
1351 * If .git/config does not exist yet, write a minimal version.
1353 in_fd = open(config_filename, O_RDONLY);
1354 if ( in_fd < 0 ) {
1355 free(store.key);
1357 if ( ENOENT != errno ) {
1358 error("opening %s: %s", config_filename,
1359 strerror(errno));
1360 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1361 goto out_free;
1363 /* if nothing to unset, error out */
1364 if (value == NULL) {
1365 ret = CONFIG_NOTHING_SET;
1366 goto out_free;
1369 store.key = (char *)key;
1370 if (!store_write_section(fd, key) ||
1371 !store_write_pair(fd, key, value))
1372 goto write_err_out;
1373 } else {
1374 struct stat st;
1375 char *contents;
1376 size_t contents_sz, copy_begin, copy_end;
1377 int i, new_line = 0;
1379 if (value_regex == NULL)
1380 store.value_regex = NULL;
1381 else {
1382 if (value_regex[0] == '!') {
1383 store.do_not_match = 1;
1384 value_regex++;
1385 } else
1386 store.do_not_match = 0;
1388 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1389 if (regcomp(store.value_regex, value_regex,
1390 REG_EXTENDED)) {
1391 error("invalid pattern: %s", value_regex);
1392 free(store.value_regex);
1393 ret = CONFIG_INVALID_PATTERN;
1394 goto out_free;
1398 store.offset[0] = 0;
1399 store.state = START;
1400 store.seen = 0;
1403 * After this, store.offset will contain the *end* offset
1404 * of the last match, or remain at 0 if no match was found.
1405 * As a side effect, we make sure to transform only a valid
1406 * existing config file.
1408 if (git_config_from_file(store_aux, config_filename, NULL)) {
1409 error("invalid config file %s", config_filename);
1410 free(store.key);
1411 if (store.value_regex != NULL) {
1412 regfree(store.value_regex);
1413 free(store.value_regex);
1415 ret = CONFIG_INVALID_FILE;
1416 goto out_free;
1419 free(store.key);
1420 if (store.value_regex != NULL) {
1421 regfree(store.value_regex);
1422 free(store.value_regex);
1425 /* if nothing to unset, or too many matches, error out */
1426 if ((store.seen == 0 && value == NULL) ||
1427 (store.seen > 1 && multi_replace == 0)) {
1428 ret = CONFIG_NOTHING_SET;
1429 goto out_free;
1432 fstat(in_fd, &st);
1433 contents_sz = xsize_t(st.st_size);
1434 contents = xmmap(NULL, contents_sz, PROT_READ,
1435 MAP_PRIVATE, in_fd, 0);
1436 close(in_fd);
1438 if (store.seen == 0)
1439 store.seen = 1;
1441 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1442 if (store.offset[i] == 0) {
1443 store.offset[i] = copy_end = contents_sz;
1444 } else if (store.state != KEY_SEEN) {
1445 copy_end = store.offset[i];
1446 } else
1447 copy_end = find_beginning_of_line(
1448 contents, contents_sz,
1449 store.offset[i]-2, &new_line);
1451 if (copy_end > 0 && contents[copy_end-1] != '\n')
1452 new_line = 1;
1454 /* write the first part of the config */
1455 if (copy_end > copy_begin) {
1456 if (write_in_full(fd, contents + copy_begin,
1457 copy_end - copy_begin) <
1458 copy_end - copy_begin)
1459 goto write_err_out;
1460 if (new_line &&
1461 write_str_in_full(fd, "\n") != 1)
1462 goto write_err_out;
1464 copy_begin = store.offset[i];
1467 /* write the pair (value == NULL means unset) */
1468 if (value != NULL) {
1469 if (store.state == START) {
1470 if (!store_write_section(fd, key))
1471 goto write_err_out;
1473 if (!store_write_pair(fd, key, value))
1474 goto write_err_out;
1477 /* write the rest of the config */
1478 if (copy_begin < contents_sz)
1479 if (write_in_full(fd, contents + copy_begin,
1480 contents_sz - copy_begin) <
1481 contents_sz - copy_begin)
1482 goto write_err_out;
1484 munmap(contents, contents_sz);
1487 if (commit_lock_file(lock) < 0) {
1488 error("could not commit config file %s", config_filename);
1489 ret = CONFIG_NO_WRITE;
1490 goto out_free;
1494 * lock is committed, so don't try to roll it back below.
1495 * NOTE: Since lockfile.c keeps a linked list of all created
1496 * lock_file structures, it isn't safe to free(lock). It's
1497 * better to just leave it hanging around.
1499 lock = NULL;
1500 ret = 0;
1502 out_free:
1503 if (lock)
1504 rollback_lock_file(lock);
1505 free(filename_buf);
1506 return ret;
1508 write_err_out:
1509 ret = write_error(lock->filename);
1510 goto out_free;
1514 int git_config_set_multivar(const char *key, const char *value,
1515 const char *value_regex, int multi_replace)
1517 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1518 multi_replace);
1521 static int section_name_match (const char *buf, const char *name)
1523 int i = 0, j = 0, dot = 0;
1524 if (buf[i] != '[')
1525 return 0;
1526 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1527 if (!dot && isspace(buf[i])) {
1528 dot = 1;
1529 if (name[j++] != '.')
1530 break;
1531 for (i++; isspace(buf[i]); i++)
1532 ; /* do nothing */
1533 if (buf[i] != '"')
1534 break;
1535 continue;
1537 if (buf[i] == '\\' && dot)
1538 i++;
1539 else if (buf[i] == '"' && dot) {
1540 for (i++; isspace(buf[i]); i++)
1541 ; /* do_nothing */
1542 break;
1544 if (buf[i] != name[j++])
1545 break;
1547 if (buf[i] == ']' && name[j] == 0) {
1549 * We match, now just find the right length offset by
1550 * gobbling up any whitespace after it, as well
1552 i++;
1553 for (; buf[i] && isspace(buf[i]); i++)
1554 ; /* do nothing */
1555 return i;
1557 return 0;
1560 static int section_name_is_ok(const char *name)
1562 /* Empty section names are bogus. */
1563 if (!*name)
1564 return 0;
1567 * Before a dot, we must be alphanumeric or dash. After the first dot,
1568 * anything goes, so we can stop checking.
1570 for (; *name && *name != '.'; name++)
1571 if (*name != '-' && !isalnum(*name))
1572 return 0;
1573 return 1;
1576 /* if new_name == NULL, the section is removed instead */
1577 int git_config_rename_section_in_file(const char *config_filename,
1578 const char *old_name, const char *new_name)
1580 int ret = 0, remove = 0;
1581 char *filename_buf = NULL;
1582 struct lock_file *lock;
1583 int out_fd;
1584 char buf[1024];
1585 FILE *config_file;
1587 if (new_name && !section_name_is_ok(new_name)) {
1588 ret = error("invalid section name: %s", new_name);
1589 goto out;
1592 if (!config_filename)
1593 config_filename = filename_buf = git_pathdup("config");
1595 lock = xcalloc(sizeof(struct lock_file), 1);
1596 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1597 if (out_fd < 0) {
1598 ret = error("could not lock config file %s", config_filename);
1599 goto out;
1602 if (!(config_file = fopen(config_filename, "rb"))) {
1603 /* no config file means nothing to rename, no error */
1604 goto unlock_and_out;
1607 while (fgets(buf, sizeof(buf), config_file)) {
1608 int i;
1609 int length;
1610 char *output = buf;
1611 for (i = 0; buf[i] && isspace(buf[i]); i++)
1612 ; /* do nothing */
1613 if (buf[i] == '[') {
1614 /* it's a section */
1615 int offset = section_name_match(&buf[i], old_name);
1616 if (offset > 0) {
1617 ret++;
1618 if (new_name == NULL) {
1619 remove = 1;
1620 continue;
1622 store.baselen = strlen(new_name);
1623 if (!store_write_section(out_fd, new_name)) {
1624 ret = write_error(lock->filename);
1625 goto out;
1628 * We wrote out the new section, with
1629 * a newline, now skip the old
1630 * section's length
1632 output += offset + i;
1633 if (strlen(output) > 0) {
1635 * More content means there's
1636 * a declaration to put on the
1637 * next line; indent with a
1638 * tab
1640 output -= 1;
1641 output[0] = '\t';
1644 remove = 0;
1646 if (remove)
1647 continue;
1648 length = strlen(output);
1649 if (write_in_full(out_fd, output, length) != length) {
1650 ret = write_error(lock->filename);
1651 goto out;
1654 fclose(config_file);
1655 unlock_and_out:
1656 if (commit_lock_file(lock) < 0)
1657 ret = error("could not commit config file %s", config_filename);
1658 out:
1659 free(filename_buf);
1660 return ret;
1663 int git_config_rename_section(const char *old_name, const char *new_name)
1665 return git_config_rename_section_in_file(NULL, old_name, new_name);
1669 * Call this to report error for your variable that should not
1670 * get a boolean value (i.e. "[my] var" means "true").
1672 int config_error_nonbool(const char *var)
1674 return error("Missing value for '%s'", var);