Merge branch 'jc/commit-unedited-template' into maint
[git/git-svn.git] / config.c
blob68d32940f3f8f1512fa36702beb98c2457ca5d46
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 /* Add other config variables here and to Documentation/config.txt. */
756 return 0;
759 static int git_default_user_config(const char *var, const char *value)
761 if (!strcmp(var, "user.name")) {
762 if (!value)
763 return config_error_nonbool(var);
764 strlcpy(git_default_name, value, sizeof(git_default_name));
765 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
766 return 0;
769 if (!strcmp(var, "user.email")) {
770 if (!value)
771 return config_error_nonbool(var);
772 strlcpy(git_default_email, value, sizeof(git_default_email));
773 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
774 return 0;
777 /* Add other config variables here and to Documentation/config.txt. */
778 return 0;
781 static int git_default_i18n_config(const char *var, const char *value)
783 if (!strcmp(var, "i18n.commitencoding"))
784 return git_config_string(&git_commit_encoding, var, value);
786 if (!strcmp(var, "i18n.logoutputencoding"))
787 return git_config_string(&git_log_output_encoding, var, value);
789 /* Add other config variables here and to Documentation/config.txt. */
790 return 0;
793 static int git_default_branch_config(const char *var, const char *value)
795 if (!strcmp(var, "branch.autosetupmerge")) {
796 if (value && !strcasecmp(value, "always")) {
797 git_branch_track = BRANCH_TRACK_ALWAYS;
798 return 0;
800 git_branch_track = git_config_bool(var, value);
801 return 0;
803 if (!strcmp(var, "branch.autosetuprebase")) {
804 if (!value)
805 return config_error_nonbool(var);
806 else if (!strcmp(value, "never"))
807 autorebase = AUTOREBASE_NEVER;
808 else if (!strcmp(value, "local"))
809 autorebase = AUTOREBASE_LOCAL;
810 else if (!strcmp(value, "remote"))
811 autorebase = AUTOREBASE_REMOTE;
812 else if (!strcmp(value, "always"))
813 autorebase = AUTOREBASE_ALWAYS;
814 else
815 return error("Malformed value for %s", var);
816 return 0;
819 /* Add other config variables here and to Documentation/config.txt. */
820 return 0;
823 static int git_default_push_config(const char *var, const char *value)
825 if (!strcmp(var, "push.default")) {
826 if (!value)
827 return config_error_nonbool(var);
828 else if (!strcmp(value, "nothing"))
829 push_default = PUSH_DEFAULT_NOTHING;
830 else if (!strcmp(value, "matching"))
831 push_default = PUSH_DEFAULT_MATCHING;
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, "
841 "tracking 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_default_user_config(var, value);
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 const char *home = NULL;
948 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
949 ret += git_config_from_file(fn, git_etc_gitconfig(),
950 data);
951 found += 1;
954 home = getenv("HOME");
955 if (home) {
956 char buf[PATH_MAX];
957 char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
958 if (!access(user_config, R_OK)) {
959 ret += git_config_from_file(fn, user_config, data);
960 found += 1;
964 if (repo_config && !access(repo_config, R_OK)) {
965 ret += git_config_from_file(fn, repo_config, data);
966 found += 1;
969 switch (git_config_from_parameters(fn, data)) {
970 case -1: /* error */
971 die("unable to parse command-line config");
972 break;
973 case 0: /* found nothing */
974 break;
975 default: /* found at least one item */
976 found++;
977 break;
980 return ret == 0 ? found : ret;
983 int git_config_with_options(config_fn_t fn, void *data,
984 const char *filename, int respect_includes)
986 char *repo_config = NULL;
987 int ret;
988 struct config_include_data inc = CONFIG_INCLUDE_INIT;
990 if (respect_includes) {
991 inc.fn = fn;
992 inc.data = data;
993 fn = git_config_include;
994 data = &inc;
998 * If we have a specific filename, use it. Otherwise, follow the
999 * regular lookup sequence.
1001 if (filename)
1002 return git_config_from_file(fn, filename, data);
1004 repo_config = git_pathdup("config");
1005 ret = git_config_early(fn, data, repo_config);
1006 if (repo_config)
1007 free(repo_config);
1008 return ret;
1011 int git_config(config_fn_t fn, void *data)
1013 return git_config_with_options(fn, data, NULL, 1);
1017 * Find all the stuff for git_config_set() below.
1020 #define MAX_MATCHES 512
1022 static struct {
1023 int baselen;
1024 char *key;
1025 int do_not_match;
1026 regex_t *value_regex;
1027 int multi_replace;
1028 size_t offset[MAX_MATCHES];
1029 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1030 int seen;
1031 } store;
1033 static int matches(const char *key, const char *value)
1035 return !strcmp(key, store.key) &&
1036 (store.value_regex == NULL ||
1037 (store.do_not_match ^
1038 !regexec(store.value_regex, value, 0, NULL, 0)));
1041 static int store_aux(const char *key, const char *value, void *cb)
1043 const char *ep;
1044 size_t section_len;
1045 FILE *f = cf->f;
1047 switch (store.state) {
1048 case KEY_SEEN:
1049 if (matches(key, value)) {
1050 if (store.seen == 1 && store.multi_replace == 0) {
1051 warning("%s has multiple values", key);
1052 } else if (store.seen >= MAX_MATCHES) {
1053 error("too many matches for %s", key);
1054 return 1;
1057 store.offset[store.seen] = ftell(f);
1058 store.seen++;
1060 break;
1061 case SECTION_SEEN:
1063 * What we are looking for is in store.key (both
1064 * section and var), and its section part is baselen
1065 * long. We found key (again, both section and var).
1066 * We would want to know if this key is in the same
1067 * section as what we are looking for. We already
1068 * know we are in the same section as what should
1069 * hold store.key.
1071 ep = strrchr(key, '.');
1072 section_len = ep - key;
1074 if ((section_len != store.baselen) ||
1075 memcmp(key, store.key, section_len+1)) {
1076 store.state = SECTION_END_SEEN;
1077 break;
1081 * Do not increment matches: this is no match, but we
1082 * just made sure we are in the desired section.
1084 store.offset[store.seen] = ftell(f);
1085 /* fallthru */
1086 case SECTION_END_SEEN:
1087 case START:
1088 if (matches(key, value)) {
1089 store.offset[store.seen] = ftell(f);
1090 store.state = KEY_SEEN;
1091 store.seen++;
1092 } else {
1093 if (strrchr(key, '.') - key == store.baselen &&
1094 !strncmp(key, store.key, store.baselen)) {
1095 store.state = SECTION_SEEN;
1096 store.offset[store.seen] = ftell(f);
1100 return 0;
1103 static int write_error(const char *filename)
1105 error("failed to write new configuration file %s", filename);
1107 /* Same error code as "failed to rename". */
1108 return 4;
1111 static int store_write_section(int fd, const char *key)
1113 const char *dot;
1114 int i, success;
1115 struct strbuf sb = STRBUF_INIT;
1117 dot = memchr(key, '.', store.baselen);
1118 if (dot) {
1119 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1120 for (i = dot - key + 1; i < store.baselen; i++) {
1121 if (key[i] == '"' || key[i] == '\\')
1122 strbuf_addch(&sb, '\\');
1123 strbuf_addch(&sb, key[i]);
1125 strbuf_addstr(&sb, "\"]\n");
1126 } else {
1127 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1130 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1131 strbuf_release(&sb);
1133 return success;
1136 static int store_write_pair(int fd, const char *key, const char *value)
1138 int i, success;
1139 int length = strlen(key + store.baselen + 1);
1140 const char *quote = "";
1141 struct strbuf sb = STRBUF_INIT;
1144 * Check to see if the value needs to be surrounded with a dq pair.
1145 * Note that problematic characters are always backslash-quoted; this
1146 * check is about not losing leading or trailing SP and strings that
1147 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1148 * configuration parser.
1150 if (value[0] == ' ')
1151 quote = "\"";
1152 for (i = 0; value[i]; i++)
1153 if (value[i] == ';' || value[i] == '#')
1154 quote = "\"";
1155 if (i && value[i - 1] == ' ')
1156 quote = "\"";
1158 strbuf_addf(&sb, "\t%.*s = %s",
1159 length, key + store.baselen + 1, quote);
1161 for (i = 0; value[i]; i++)
1162 switch (value[i]) {
1163 case '\n':
1164 strbuf_addstr(&sb, "\\n");
1165 break;
1166 case '\t':
1167 strbuf_addstr(&sb, "\\t");
1168 break;
1169 case '"':
1170 case '\\':
1171 strbuf_addch(&sb, '\\');
1172 default:
1173 strbuf_addch(&sb, value[i]);
1174 break;
1176 strbuf_addf(&sb, "%s\n", quote);
1178 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1179 strbuf_release(&sb);
1181 return success;
1184 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1185 size_t offset_, int *found_bracket)
1187 size_t equal_offset = size, bracket_offset = size;
1188 ssize_t offset;
1190 contline:
1191 for (offset = offset_-2; offset > 0
1192 && contents[offset] != '\n'; offset--)
1193 switch (contents[offset]) {
1194 case '=': equal_offset = offset; break;
1195 case ']': bracket_offset = offset; break;
1197 if (offset > 0 && contents[offset-1] == '\\') {
1198 offset_ = offset;
1199 goto contline;
1201 if (bracket_offset < equal_offset) {
1202 *found_bracket = 1;
1203 offset = bracket_offset+1;
1204 } else
1205 offset++;
1207 return offset;
1210 int git_config_set_in_file(const char *config_filename,
1211 const char *key, const char *value)
1213 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1216 int git_config_set(const char *key, const char *value)
1218 return git_config_set_multivar(key, value, NULL, 0);
1222 * Auxiliary function to sanity-check and split the key into the section
1223 * identifier and variable name.
1225 * Returns 0 on success, -1 when there is an invalid character in the key and
1226 * -2 if there is no section name in the key.
1228 * store_key - pointer to char* which will hold a copy of the key with
1229 * lowercase section and variable name
1230 * baselen - pointer to int which will hold the length of the
1231 * section + subsection part, can be NULL
1233 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1235 int i, dot, baselen;
1236 const char *last_dot = strrchr(key, '.');
1239 * Since "key" actually contains the section name and the real
1240 * key name separated by a dot, we have to know where the dot is.
1243 if (last_dot == NULL || last_dot == key) {
1244 error("key does not contain a section: %s", key);
1245 return -CONFIG_NO_SECTION_OR_NAME;
1248 if (!last_dot[1]) {
1249 error("key does not contain variable name: %s", key);
1250 return -CONFIG_NO_SECTION_OR_NAME;
1253 baselen = last_dot - key;
1254 if (baselen_)
1255 *baselen_ = baselen;
1258 * Validate the key and while at it, lower case it for matching.
1260 *store_key = xmalloc(strlen(key) + 1);
1262 dot = 0;
1263 for (i = 0; key[i]; i++) {
1264 unsigned char c = key[i];
1265 if (c == '.')
1266 dot = 1;
1267 /* Leave the extended basename untouched.. */
1268 if (!dot || i > baselen) {
1269 if (!iskeychar(c) ||
1270 (i == baselen + 1 && !isalpha(c))) {
1271 error("invalid key: %s", key);
1272 goto out_free_ret_1;
1274 c = tolower(c);
1275 } else if (c == '\n') {
1276 error("invalid key (newline): %s", key);
1277 goto out_free_ret_1;
1279 (*store_key)[i] = c;
1281 (*store_key)[i] = 0;
1283 return 0;
1285 out_free_ret_1:
1286 free(*store_key);
1287 return -CONFIG_INVALID_KEY;
1291 * If value==NULL, unset in (remove from) config,
1292 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1293 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1294 * else all matching key/values (regardless how many) are removed,
1295 * before the new pair is written.
1297 * Returns 0 on success.
1299 * This function does this:
1301 * - it locks the config file by creating ".git/config.lock"
1303 * - it then parses the config using store_aux() as validator to find
1304 * the position on the key/value pair to replace. If it is to be unset,
1305 * it must be found exactly once.
1307 * - the config file is mmap()ed and the part before the match (if any) is
1308 * written to the lock file, then the changed part and the rest.
1310 * - the config file is removed and the lock file rename()d to it.
1313 int git_config_set_multivar_in_file(const char *config_filename,
1314 const char *key, const char *value,
1315 const char *value_regex, int multi_replace)
1317 int fd = -1, in_fd;
1318 int ret;
1319 struct lock_file *lock = NULL;
1320 char *filename_buf = NULL;
1322 /* parse-key returns negative; flip the sign to feed exit(3) */
1323 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1324 if (ret)
1325 goto out_free;
1327 store.multi_replace = multi_replace;
1329 if (!config_filename)
1330 config_filename = filename_buf = git_pathdup("config");
1333 * The lock serves a purpose in addition to locking: the new
1334 * contents of .git/config will be written into it.
1336 lock = xcalloc(sizeof(struct lock_file), 1);
1337 fd = hold_lock_file_for_update(lock, config_filename, 0);
1338 if (fd < 0) {
1339 error("could not lock config file %s: %s", config_filename, strerror(errno));
1340 free(store.key);
1341 ret = CONFIG_NO_LOCK;
1342 goto out_free;
1346 * If .git/config does not exist yet, write a minimal version.
1348 in_fd = open(config_filename, O_RDONLY);
1349 if ( in_fd < 0 ) {
1350 free(store.key);
1352 if ( ENOENT != errno ) {
1353 error("opening %s: %s", config_filename,
1354 strerror(errno));
1355 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1356 goto out_free;
1358 /* if nothing to unset, error out */
1359 if (value == NULL) {
1360 ret = CONFIG_NOTHING_SET;
1361 goto out_free;
1364 store.key = (char *)key;
1365 if (!store_write_section(fd, key) ||
1366 !store_write_pair(fd, key, value))
1367 goto write_err_out;
1368 } else {
1369 struct stat st;
1370 char *contents;
1371 size_t contents_sz, copy_begin, copy_end;
1372 int i, new_line = 0;
1374 if (value_regex == NULL)
1375 store.value_regex = NULL;
1376 else {
1377 if (value_regex[0] == '!') {
1378 store.do_not_match = 1;
1379 value_regex++;
1380 } else
1381 store.do_not_match = 0;
1383 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1384 if (regcomp(store.value_regex, value_regex,
1385 REG_EXTENDED)) {
1386 error("invalid pattern: %s", value_regex);
1387 free(store.value_regex);
1388 ret = CONFIG_INVALID_PATTERN;
1389 goto out_free;
1393 store.offset[0] = 0;
1394 store.state = START;
1395 store.seen = 0;
1398 * After this, store.offset will contain the *end* offset
1399 * of the last match, or remain at 0 if no match was found.
1400 * As a side effect, we make sure to transform only a valid
1401 * existing config file.
1403 if (git_config_from_file(store_aux, config_filename, NULL)) {
1404 error("invalid config file %s", config_filename);
1405 free(store.key);
1406 if (store.value_regex != NULL) {
1407 regfree(store.value_regex);
1408 free(store.value_regex);
1410 ret = CONFIG_INVALID_FILE;
1411 goto out_free;
1414 free(store.key);
1415 if (store.value_regex != NULL) {
1416 regfree(store.value_regex);
1417 free(store.value_regex);
1420 /* if nothing to unset, or too many matches, error out */
1421 if ((store.seen == 0 && value == NULL) ||
1422 (store.seen > 1 && multi_replace == 0)) {
1423 ret = CONFIG_NOTHING_SET;
1424 goto out_free;
1427 fstat(in_fd, &st);
1428 contents_sz = xsize_t(st.st_size);
1429 contents = xmmap(NULL, contents_sz, PROT_READ,
1430 MAP_PRIVATE, in_fd, 0);
1431 close(in_fd);
1433 if (store.seen == 0)
1434 store.seen = 1;
1436 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1437 if (store.offset[i] == 0) {
1438 store.offset[i] = copy_end = contents_sz;
1439 } else if (store.state != KEY_SEEN) {
1440 copy_end = store.offset[i];
1441 } else
1442 copy_end = find_beginning_of_line(
1443 contents, contents_sz,
1444 store.offset[i]-2, &new_line);
1446 if (copy_end > 0 && contents[copy_end-1] != '\n')
1447 new_line = 1;
1449 /* write the first part of the config */
1450 if (copy_end > copy_begin) {
1451 if (write_in_full(fd, contents + copy_begin,
1452 copy_end - copy_begin) <
1453 copy_end - copy_begin)
1454 goto write_err_out;
1455 if (new_line &&
1456 write_str_in_full(fd, "\n") != 1)
1457 goto write_err_out;
1459 copy_begin = store.offset[i];
1462 /* write the pair (value == NULL means unset) */
1463 if (value != NULL) {
1464 if (store.state == START) {
1465 if (!store_write_section(fd, key))
1466 goto write_err_out;
1468 if (!store_write_pair(fd, key, value))
1469 goto write_err_out;
1472 /* write the rest of the config */
1473 if (copy_begin < contents_sz)
1474 if (write_in_full(fd, contents + copy_begin,
1475 contents_sz - copy_begin) <
1476 contents_sz - copy_begin)
1477 goto write_err_out;
1479 munmap(contents, contents_sz);
1482 if (commit_lock_file(lock) < 0) {
1483 error("could not commit config file %s", config_filename);
1484 ret = CONFIG_NO_WRITE;
1485 goto out_free;
1489 * lock is committed, so don't try to roll it back below.
1490 * NOTE: Since lockfile.c keeps a linked list of all created
1491 * lock_file structures, it isn't safe to free(lock). It's
1492 * better to just leave it hanging around.
1494 lock = NULL;
1495 ret = 0;
1497 out_free:
1498 if (lock)
1499 rollback_lock_file(lock);
1500 free(filename_buf);
1501 return ret;
1503 write_err_out:
1504 ret = write_error(lock->filename);
1505 goto out_free;
1509 int git_config_set_multivar(const char *key, const char *value,
1510 const char *value_regex, int multi_replace)
1512 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1513 multi_replace);
1516 static int section_name_match (const char *buf, const char *name)
1518 int i = 0, j = 0, dot = 0;
1519 if (buf[i] != '[')
1520 return 0;
1521 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1522 if (!dot && isspace(buf[i])) {
1523 dot = 1;
1524 if (name[j++] != '.')
1525 break;
1526 for (i++; isspace(buf[i]); i++)
1527 ; /* do nothing */
1528 if (buf[i] != '"')
1529 break;
1530 continue;
1532 if (buf[i] == '\\' && dot)
1533 i++;
1534 else if (buf[i] == '"' && dot) {
1535 for (i++; isspace(buf[i]); i++)
1536 ; /* do_nothing */
1537 break;
1539 if (buf[i] != name[j++])
1540 break;
1542 if (buf[i] == ']' && name[j] == 0) {
1544 * We match, now just find the right length offset by
1545 * gobbling up any whitespace after it, as well
1547 i++;
1548 for (; buf[i] && isspace(buf[i]); i++)
1549 ; /* do nothing */
1550 return i;
1552 return 0;
1555 /* if new_name == NULL, the section is removed instead */
1556 int git_config_rename_section_in_file(const char *config_filename,
1557 const char *old_name, const char *new_name)
1559 int ret = 0, remove = 0;
1560 char *filename_buf = NULL;
1561 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1562 int out_fd;
1563 char buf[1024];
1564 FILE *config_file;
1566 if (!config_filename)
1567 config_filename = filename_buf = git_pathdup("config");
1569 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1570 if (out_fd < 0) {
1571 ret = error("could not lock config file %s", config_filename);
1572 goto out;
1575 if (!(config_file = fopen(config_filename, "rb"))) {
1576 /* no config file means nothing to rename, no error */
1577 goto unlock_and_out;
1580 while (fgets(buf, sizeof(buf), config_file)) {
1581 int i;
1582 int length;
1583 char *output = buf;
1584 for (i = 0; buf[i] && isspace(buf[i]); i++)
1585 ; /* do nothing */
1586 if (buf[i] == '[') {
1587 /* it's a section */
1588 int offset = section_name_match(&buf[i], old_name);
1589 if (offset > 0) {
1590 ret++;
1591 if (new_name == NULL) {
1592 remove = 1;
1593 continue;
1595 store.baselen = strlen(new_name);
1596 if (!store_write_section(out_fd, new_name)) {
1597 ret = write_error(lock->filename);
1598 goto out;
1601 * We wrote out the new section, with
1602 * a newline, now skip the old
1603 * section's length
1605 output += offset + i;
1606 if (strlen(output) > 0) {
1608 * More content means there's
1609 * a declaration to put on the
1610 * next line; indent with a
1611 * tab
1613 output -= 1;
1614 output[0] = '\t';
1617 remove = 0;
1619 if (remove)
1620 continue;
1621 length = strlen(output);
1622 if (write_in_full(out_fd, output, length) != length) {
1623 ret = write_error(lock->filename);
1624 goto out;
1627 fclose(config_file);
1628 unlock_and_out:
1629 if (commit_lock_file(lock) < 0)
1630 ret = error("could not commit config file %s", config_filename);
1631 out:
1632 free(filename_buf);
1633 return ret;
1636 int git_config_rename_section(const char *old_name, const char *new_name)
1638 return git_config_rename_section_in_file(NULL, old_name, new_name);
1642 * Call this to report error for your variable that should not
1643 * get a boolean value (i.e. "[my] var" means "true").
1645 int config_error_nonbool(const char *var)
1647 return error("Missing value for '%s'", var);