refs: add expand_ref()
[git.git] / config.c
blobb95ac3a9cd5ca4fef392a2202f0a5722d15b8dde
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 "lockfile.h"
10 #include "exec_cmd.h"
11 #include "strbuf.h"
12 #include "quote.h"
13 #include "hashmap.h"
14 #include "string-list.h"
15 #include "utf8.h"
17 struct config_source {
18 struct config_source *prev;
19 union {
20 FILE *file;
21 struct config_buf {
22 const char *buf;
23 size_t len;
24 size_t pos;
25 } buf;
26 } u;
27 const char *name;
28 const char *path;
29 int die_on_error;
30 int linenr;
31 int eof;
32 struct strbuf value;
33 struct strbuf var;
35 int (*do_fgetc)(struct config_source *c);
36 int (*do_ungetc)(int c, struct config_source *conf);
37 long (*do_ftell)(struct config_source *c);
40 static struct config_source *cf;
42 static int zlib_compression_seen;
45 * Default config_set that contains key-value pairs from the usual set of config
46 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
47 * config file and the global /etc/gitconfig)
49 static struct config_set the_config_set;
51 static int config_file_fgetc(struct config_source *conf)
53 return getc_unlocked(conf->u.file);
56 static int config_file_ungetc(int c, struct config_source *conf)
58 return ungetc(c, conf->u.file);
61 static long config_file_ftell(struct config_source *conf)
63 return ftell(conf->u.file);
67 static int config_buf_fgetc(struct config_source *conf)
69 if (conf->u.buf.pos < conf->u.buf.len)
70 return conf->u.buf.buf[conf->u.buf.pos++];
72 return EOF;
75 static int config_buf_ungetc(int c, struct config_source *conf)
77 if (conf->u.buf.pos > 0) {
78 conf->u.buf.pos--;
79 if (conf->u.buf.buf[conf->u.buf.pos] != c)
80 die("BUG: config_buf can only ungetc the same character");
81 return c;
84 return EOF;
87 static long config_buf_ftell(struct config_source *conf)
89 return conf->u.buf.pos;
92 #define MAX_INCLUDE_DEPTH 10
93 static const char include_depth_advice[] =
94 "exceeded maximum include depth (%d) while including\n"
95 " %s\n"
96 "from\n"
97 " %s\n"
98 "Do you have circular includes?";
99 static int handle_path_include(const char *path, struct config_include_data *inc)
101 int ret = 0;
102 struct strbuf buf = STRBUF_INIT;
103 char *expanded;
105 if (!path)
106 return config_error_nonbool("include.path");
108 expanded = expand_user_path(path);
109 if (!expanded)
110 return error("Could not expand include path '%s'", path);
111 path = expanded;
114 * Use an absolute path as-is, but interpret relative paths
115 * based on the including config file.
117 if (!is_absolute_path(path)) {
118 char *slash;
120 if (!cf || !cf->path)
121 return error("relative config includes must come from files");
123 slash = find_last_dir_sep(cf->path);
124 if (slash)
125 strbuf_add(&buf, cf->path, slash - cf->path + 1);
126 strbuf_addstr(&buf, path);
127 path = buf.buf;
130 if (!access_or_die(path, R_OK, 0)) {
131 if (++inc->depth > MAX_INCLUDE_DEPTH)
132 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
133 cf && cf->name ? cf->name : "the command line");
134 ret = git_config_from_file(git_config_include, path, inc);
135 inc->depth--;
137 strbuf_release(&buf);
138 free(expanded);
139 return ret;
142 int git_config_include(const char *var, const char *value, void *data)
144 struct config_include_data *inc = data;
145 int ret;
148 * Pass along all values, including "include" directives; this makes it
149 * possible to query information on the includes themselves.
151 ret = inc->fn(var, value, inc->data);
152 if (ret < 0)
153 return ret;
155 if (!strcmp(var, "include.path"))
156 ret = handle_path_include(value, inc);
157 return ret;
160 void git_config_push_parameter(const char *text)
162 struct strbuf env = STRBUF_INIT;
163 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
164 if (old) {
165 strbuf_addstr(&env, old);
166 strbuf_addch(&env, ' ');
168 sq_quote_buf(&env, text);
169 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
170 strbuf_release(&env);
173 int git_config_parse_parameter(const char *text,
174 config_fn_t fn, void *data)
176 const char *value;
177 struct strbuf **pair;
179 pair = strbuf_split_str(text, '=', 2);
180 if (!pair[0])
181 return error("bogus config parameter: %s", text);
183 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
184 strbuf_setlen(pair[0], pair[0]->len - 1);
185 value = pair[1] ? pair[1]->buf : "";
186 } else {
187 value = NULL;
190 strbuf_trim(pair[0]);
191 if (!pair[0]->len) {
192 strbuf_list_free(pair);
193 return error("bogus config parameter: %s", text);
195 strbuf_tolower(pair[0]);
196 if (fn(pair[0]->buf, value, data) < 0) {
197 strbuf_list_free(pair);
198 return -1;
200 strbuf_list_free(pair);
201 return 0;
204 int git_config_from_parameters(config_fn_t fn, void *data)
206 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
207 char *envw;
208 const char **argv = NULL;
209 int nr = 0, alloc = 0;
210 int i;
212 if (!env)
213 return 0;
214 /* sq_dequote will write over it */
215 envw = xstrdup(env);
217 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
218 free(envw);
219 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
222 for (i = 0; i < nr; i++) {
223 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
224 free(argv);
225 free(envw);
226 return -1;
230 free(argv);
231 free(envw);
232 return nr > 0;
235 static int get_next_char(void)
237 int c = cf->do_fgetc(cf);
239 if (c == '\r') {
240 /* DOS like systems */
241 c = cf->do_fgetc(cf);
242 if (c != '\n') {
243 if (c != EOF)
244 cf->do_ungetc(c, cf);
245 c = '\r';
248 if (c == '\n')
249 cf->linenr++;
250 if (c == EOF) {
251 cf->eof = 1;
252 cf->linenr++;
253 c = '\n';
255 return c;
258 static char *parse_value(void)
260 int quote = 0, comment = 0, space = 0;
262 strbuf_reset(&cf->value);
263 for (;;) {
264 int c = get_next_char();
265 if (c == '\n') {
266 if (quote) {
267 cf->linenr--;
268 return NULL;
270 return cf->value.buf;
272 if (comment)
273 continue;
274 if (isspace(c) && !quote) {
275 if (cf->value.len)
276 space++;
277 continue;
279 if (!quote) {
280 if (c == ';' || c == '#') {
281 comment = 1;
282 continue;
285 for (; space; space--)
286 strbuf_addch(&cf->value, ' ');
287 if (c == '\\') {
288 c = get_next_char();
289 switch (c) {
290 case '\n':
291 continue;
292 case 't':
293 c = '\t';
294 break;
295 case 'b':
296 c = '\b';
297 break;
298 case 'n':
299 c = '\n';
300 break;
301 /* Some characters escape as themselves */
302 case '\\': case '"':
303 break;
304 /* Reject unknown escape sequences */
305 default:
306 return NULL;
308 strbuf_addch(&cf->value, c);
309 continue;
311 if (c == '"') {
312 quote = 1-quote;
313 continue;
315 strbuf_addch(&cf->value, c);
319 static inline int iskeychar(int c)
321 return isalnum(c) || c == '-';
324 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
326 int c;
327 char *value;
328 int ret;
330 /* Get the full name */
331 for (;;) {
332 c = get_next_char();
333 if (cf->eof)
334 break;
335 if (!iskeychar(c))
336 break;
337 strbuf_addch(name, tolower(c));
340 while (c == ' ' || c == '\t')
341 c = get_next_char();
343 value = NULL;
344 if (c != '\n') {
345 if (c != '=')
346 return -1;
347 value = parse_value();
348 if (!value)
349 return -1;
352 * We already consumed the \n, but we need linenr to point to
353 * the line we just parsed during the call to fn to get
354 * accurate line number in error messages.
356 cf->linenr--;
357 ret = fn(name->buf, value, data);
358 cf->linenr++;
359 return ret;
362 static int get_extended_base_var(struct strbuf *name, int c)
364 do {
365 if (c == '\n')
366 goto error_incomplete_line;
367 c = get_next_char();
368 } while (isspace(c));
370 /* We require the format to be '[base "extension"]' */
371 if (c != '"')
372 return -1;
373 strbuf_addch(name, '.');
375 for (;;) {
376 int c = get_next_char();
377 if (c == '\n')
378 goto error_incomplete_line;
379 if (c == '"')
380 break;
381 if (c == '\\') {
382 c = get_next_char();
383 if (c == '\n')
384 goto error_incomplete_line;
386 strbuf_addch(name, c);
389 /* Final ']' */
390 if (get_next_char() != ']')
391 return -1;
392 return 0;
393 error_incomplete_line:
394 cf->linenr--;
395 return -1;
398 static int get_base_var(struct strbuf *name)
400 for (;;) {
401 int c = get_next_char();
402 if (cf->eof)
403 return -1;
404 if (c == ']')
405 return 0;
406 if (isspace(c))
407 return get_extended_base_var(name, c);
408 if (!iskeychar(c) && c != '.')
409 return -1;
410 strbuf_addch(name, tolower(c));
414 static int git_parse_source(config_fn_t fn, void *data)
416 int comment = 0;
417 int baselen = 0;
418 struct strbuf *var = &cf->var;
420 /* U+FEFF Byte Order Mark in UTF8 */
421 const char *bomptr = utf8_bom;
423 for (;;) {
424 int c = get_next_char();
425 if (bomptr && *bomptr) {
426 /* We are at the file beginning; skip UTF8-encoded BOM
427 * if present. Sane editors won't put this in on their
428 * own, but e.g. Windows Notepad will do it happily. */
429 if (c == (*bomptr & 0377)) {
430 bomptr++;
431 continue;
432 } else {
433 /* Do not tolerate partial BOM. */
434 if (bomptr != utf8_bom)
435 break;
436 /* No BOM at file beginning. Cool. */
437 bomptr = NULL;
440 if (c == '\n') {
441 if (cf->eof)
442 return 0;
443 comment = 0;
444 continue;
446 if (comment || isspace(c))
447 continue;
448 if (c == '#' || c == ';') {
449 comment = 1;
450 continue;
452 if (c == '[') {
453 /* Reset prior to determining a new stem */
454 strbuf_reset(var);
455 if (get_base_var(var) < 0 || var->len < 1)
456 break;
457 strbuf_addch(var, '.');
458 baselen = var->len;
459 continue;
461 if (!isalpha(c))
462 break;
464 * Truncate the var name back to the section header
465 * stem prior to grabbing the suffix part of the name
466 * and the value.
468 strbuf_setlen(var, baselen);
469 strbuf_addch(var, tolower(c));
470 if (get_value(fn, data, var) < 0)
471 break;
473 if (cf->die_on_error)
474 die(_("bad config file line %d in %s"), cf->linenr, cf->name);
475 else
476 return error(_("bad config file line %d in %s"), cf->linenr, cf->name);
479 static int parse_unit_factor(const char *end, uintmax_t *val)
481 if (!*end)
482 return 1;
483 else if (!strcasecmp(end, "k")) {
484 *val *= 1024;
485 return 1;
487 else if (!strcasecmp(end, "m")) {
488 *val *= 1024 * 1024;
489 return 1;
491 else if (!strcasecmp(end, "g")) {
492 *val *= 1024 * 1024 * 1024;
493 return 1;
495 return 0;
498 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
500 if (value && *value) {
501 char *end;
502 intmax_t val;
503 uintmax_t uval;
504 uintmax_t factor = 1;
506 errno = 0;
507 val = strtoimax(value, &end, 0);
508 if (errno == ERANGE)
509 return 0;
510 if (!parse_unit_factor(end, &factor)) {
511 errno = EINVAL;
512 return 0;
514 uval = labs(val);
515 uval *= factor;
516 if (uval > max || labs(val) > uval) {
517 errno = ERANGE;
518 return 0;
520 val *= factor;
521 *ret = val;
522 return 1;
524 errno = EINVAL;
525 return 0;
528 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
530 if (value && *value) {
531 char *end;
532 uintmax_t val;
533 uintmax_t oldval;
535 errno = 0;
536 val = strtoumax(value, &end, 0);
537 if (errno == ERANGE)
538 return 0;
539 oldval = val;
540 if (!parse_unit_factor(end, &val)) {
541 errno = EINVAL;
542 return 0;
544 if (val > max || oldval > val) {
545 errno = ERANGE;
546 return 0;
548 *ret = val;
549 return 1;
551 errno = EINVAL;
552 return 0;
555 static int git_parse_int(const char *value, int *ret)
557 intmax_t tmp;
558 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
559 return 0;
560 *ret = tmp;
561 return 1;
564 static int git_parse_int64(const char *value, int64_t *ret)
566 intmax_t tmp;
567 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
568 return 0;
569 *ret = tmp;
570 return 1;
573 int git_parse_ulong(const char *value, unsigned long *ret)
575 uintmax_t tmp;
576 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
577 return 0;
578 *ret = tmp;
579 return 1;
582 NORETURN
583 static void die_bad_number(const char *name, const char *value)
585 const char *reason = errno == ERANGE ?
586 "out of range" :
587 "invalid unit";
588 if (!value)
589 value = "";
591 if (cf && cf->name)
592 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
593 value, name, cf->name, reason);
594 die(_("bad numeric config value '%s' for '%s': %s"), value, name, reason);
597 int git_config_int(const char *name, const char *value)
599 int ret;
600 if (!git_parse_int(value, &ret))
601 die_bad_number(name, value);
602 return ret;
605 int64_t git_config_int64(const char *name, const char *value)
607 int64_t ret;
608 if (!git_parse_int64(value, &ret))
609 die_bad_number(name, value);
610 return ret;
613 unsigned long git_config_ulong(const char *name, const char *value)
615 unsigned long ret;
616 if (!git_parse_ulong(value, &ret))
617 die_bad_number(name, value);
618 return ret;
621 int git_parse_maybe_bool(const char *value)
623 if (!value)
624 return 1;
625 if (!*value)
626 return 0;
627 if (!strcasecmp(value, "true")
628 || !strcasecmp(value, "yes")
629 || !strcasecmp(value, "on"))
630 return 1;
631 if (!strcasecmp(value, "false")
632 || !strcasecmp(value, "no")
633 || !strcasecmp(value, "off"))
634 return 0;
635 return -1;
638 int git_config_maybe_bool(const char *name, const char *value)
640 int v = git_parse_maybe_bool(value);
641 if (0 <= v)
642 return v;
643 if (git_parse_int(value, &v))
644 return !!v;
645 return -1;
648 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
650 int v = git_parse_maybe_bool(value);
651 if (0 <= v) {
652 *is_bool = 1;
653 return v;
655 *is_bool = 0;
656 return git_config_int(name, value);
659 int git_config_bool(const char *name, const char *value)
661 int discard;
662 return !!git_config_bool_or_int(name, value, &discard);
665 int git_config_string(const char **dest, const char *var, const char *value)
667 if (!value)
668 return config_error_nonbool(var);
669 *dest = xstrdup(value);
670 return 0;
673 int git_config_pathname(const char **dest, const char *var, const char *value)
675 if (!value)
676 return config_error_nonbool(var);
677 *dest = expand_user_path(value);
678 if (!*dest)
679 die(_("failed to expand user dir in: '%s'"), value);
680 return 0;
683 static int git_default_core_config(const char *var, const char *value)
685 /* This needs a better name */
686 if (!strcmp(var, "core.filemode")) {
687 trust_executable_bit = git_config_bool(var, value);
688 return 0;
690 if (!strcmp(var, "core.trustctime")) {
691 trust_ctime = git_config_bool(var, value);
692 return 0;
694 if (!strcmp(var, "core.checkstat")) {
695 if (!strcasecmp(value, "default"))
696 check_stat = 1;
697 else if (!strcasecmp(value, "minimal"))
698 check_stat = 0;
701 if (!strcmp(var, "core.quotepath")) {
702 quote_path_fully = git_config_bool(var, value);
703 return 0;
706 if (!strcmp(var, "core.symlinks")) {
707 has_symlinks = git_config_bool(var, value);
708 return 0;
711 if (!strcmp(var, "core.ignorecase")) {
712 ignore_case = git_config_bool(var, value);
713 return 0;
716 if (!strcmp(var, "core.attributesfile"))
717 return git_config_pathname(&git_attributes_file, var, value);
719 if (!strcmp(var, "core.bare")) {
720 is_bare_repository_cfg = git_config_bool(var, value);
721 return 0;
724 if (!strcmp(var, "core.ignorestat")) {
725 assume_unchanged = git_config_bool(var, value);
726 return 0;
729 if (!strcmp(var, "core.prefersymlinkrefs")) {
730 prefer_symlink_refs = git_config_bool(var, value);
731 return 0;
734 if (!strcmp(var, "core.logallrefupdates")) {
735 log_all_ref_updates = git_config_bool(var, value);
736 return 0;
739 if (!strcmp(var, "core.warnambiguousrefs")) {
740 warn_ambiguous_refs = git_config_bool(var, value);
741 return 0;
744 if (!strcmp(var, "core.abbrev")) {
745 int abbrev = git_config_int(var, value);
746 if (abbrev < minimum_abbrev || abbrev > 40)
747 return -1;
748 default_abbrev = abbrev;
749 return 0;
752 if (!strcmp(var, "core.loosecompression")) {
753 int level = git_config_int(var, value);
754 if (level == -1)
755 level = Z_DEFAULT_COMPRESSION;
756 else if (level < 0 || level > Z_BEST_COMPRESSION)
757 die(_("bad zlib compression level %d"), level);
758 zlib_compression_level = level;
759 zlib_compression_seen = 1;
760 return 0;
763 if (!strcmp(var, "core.compression")) {
764 int level = git_config_int(var, value);
765 if (level == -1)
766 level = Z_DEFAULT_COMPRESSION;
767 else if (level < 0 || level > Z_BEST_COMPRESSION)
768 die(_("bad zlib compression level %d"), level);
769 core_compression_level = level;
770 core_compression_seen = 1;
771 if (!zlib_compression_seen)
772 zlib_compression_level = level;
773 return 0;
776 if (!strcmp(var, "core.packedgitwindowsize")) {
777 int pgsz_x2 = getpagesize() * 2;
778 packed_git_window_size = git_config_ulong(var, value);
780 /* This value must be multiple of (pagesize * 2) */
781 packed_git_window_size /= pgsz_x2;
782 if (packed_git_window_size < 1)
783 packed_git_window_size = 1;
784 packed_git_window_size *= pgsz_x2;
785 return 0;
788 if (!strcmp(var, "core.bigfilethreshold")) {
789 big_file_threshold = git_config_ulong(var, value);
790 return 0;
793 if (!strcmp(var, "core.packedgitlimit")) {
794 packed_git_limit = git_config_ulong(var, value);
795 return 0;
798 if (!strcmp(var, "core.deltabasecachelimit")) {
799 delta_base_cache_limit = git_config_ulong(var, value);
800 return 0;
803 if (!strcmp(var, "core.autocrlf")) {
804 if (value && !strcasecmp(value, "input")) {
805 if (core_eol == EOL_CRLF)
806 return error("core.autocrlf=input conflicts with core.eol=crlf");
807 auto_crlf = AUTO_CRLF_INPUT;
808 return 0;
810 auto_crlf = git_config_bool(var, value);
811 return 0;
814 if (!strcmp(var, "core.safecrlf")) {
815 if (value && !strcasecmp(value, "warn")) {
816 safe_crlf = SAFE_CRLF_WARN;
817 return 0;
819 safe_crlf = git_config_bool(var, value);
820 return 0;
823 if (!strcmp(var, "core.eol")) {
824 if (value && !strcasecmp(value, "lf"))
825 core_eol = EOL_LF;
826 else if (value && !strcasecmp(value, "crlf"))
827 core_eol = EOL_CRLF;
828 else if (value && !strcasecmp(value, "native"))
829 core_eol = EOL_NATIVE;
830 else
831 core_eol = EOL_UNSET;
832 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
833 return error("core.autocrlf=input conflicts with core.eol=crlf");
834 return 0;
837 if (!strcmp(var, "core.notesref")) {
838 notes_ref_name = xstrdup(value);
839 return 0;
842 if (!strcmp(var, "core.pager"))
843 return git_config_string(&pager_program, var, value);
845 if (!strcmp(var, "core.editor"))
846 return git_config_string(&editor_program, var, value);
848 if (!strcmp(var, "core.commentchar")) {
849 if (!value)
850 return config_error_nonbool(var);
851 else if (!strcasecmp(value, "auto"))
852 auto_comment_line_char = 1;
853 else if (value[0] && !value[1]) {
854 comment_line_char = value[0];
855 auto_comment_line_char = 0;
856 } else
857 return error("core.commentChar should only be one character");
858 return 0;
861 if (!strcmp(var, "core.askpass"))
862 return git_config_string(&askpass_program, var, value);
864 if (!strcmp(var, "core.excludesfile"))
865 return git_config_pathname(&excludes_file, var, value);
867 if (!strcmp(var, "core.whitespace")) {
868 if (!value)
869 return config_error_nonbool(var);
870 whitespace_rule_cfg = parse_whitespace_rule(value);
871 return 0;
874 if (!strcmp(var, "core.fsyncobjectfiles")) {
875 fsync_object_files = git_config_bool(var, value);
876 return 0;
879 if (!strcmp(var, "core.preloadindex")) {
880 core_preload_index = git_config_bool(var, value);
881 return 0;
884 if (!strcmp(var, "core.createobject")) {
885 if (!strcmp(value, "rename"))
886 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
887 else if (!strcmp(value, "link"))
888 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
889 else
890 die(_("invalid mode for object creation: %s"), value);
891 return 0;
894 if (!strcmp(var, "core.sparsecheckout")) {
895 core_apply_sparse_checkout = git_config_bool(var, value);
896 return 0;
899 if (!strcmp(var, "core.precomposeunicode")) {
900 precomposed_unicode = git_config_bool(var, value);
901 return 0;
904 if (!strcmp(var, "core.protecthfs")) {
905 protect_hfs = git_config_bool(var, value);
906 return 0;
909 if (!strcmp(var, "core.protectntfs")) {
910 protect_ntfs = git_config_bool(var, value);
911 return 0;
914 /* Add other config variables here and to Documentation/config.txt. */
915 return 0;
918 static int git_default_i18n_config(const char *var, const char *value)
920 if (!strcmp(var, "i18n.commitencoding"))
921 return git_config_string(&git_commit_encoding, var, value);
923 if (!strcmp(var, "i18n.logoutputencoding"))
924 return git_config_string(&git_log_output_encoding, var, value);
926 /* Add other config variables here and to Documentation/config.txt. */
927 return 0;
930 static int git_default_branch_config(const char *var, const char *value)
932 if (!strcmp(var, "branch.autosetupmerge")) {
933 if (value && !strcasecmp(value, "always")) {
934 git_branch_track = BRANCH_TRACK_ALWAYS;
935 return 0;
937 git_branch_track = git_config_bool(var, value);
938 return 0;
940 if (!strcmp(var, "branch.autosetuprebase")) {
941 if (!value)
942 return config_error_nonbool(var);
943 else if (!strcmp(value, "never"))
944 autorebase = AUTOREBASE_NEVER;
945 else if (!strcmp(value, "local"))
946 autorebase = AUTOREBASE_LOCAL;
947 else if (!strcmp(value, "remote"))
948 autorebase = AUTOREBASE_REMOTE;
949 else if (!strcmp(value, "always"))
950 autorebase = AUTOREBASE_ALWAYS;
951 else
952 return error("Malformed value for %s", var);
953 return 0;
956 /* Add other config variables here and to Documentation/config.txt. */
957 return 0;
960 static int git_default_push_config(const char *var, const char *value)
962 if (!strcmp(var, "push.default")) {
963 if (!value)
964 return config_error_nonbool(var);
965 else if (!strcmp(value, "nothing"))
966 push_default = PUSH_DEFAULT_NOTHING;
967 else if (!strcmp(value, "matching"))
968 push_default = PUSH_DEFAULT_MATCHING;
969 else if (!strcmp(value, "simple"))
970 push_default = PUSH_DEFAULT_SIMPLE;
971 else if (!strcmp(value, "upstream"))
972 push_default = PUSH_DEFAULT_UPSTREAM;
973 else if (!strcmp(value, "tracking")) /* deprecated */
974 push_default = PUSH_DEFAULT_UPSTREAM;
975 else if (!strcmp(value, "current"))
976 push_default = PUSH_DEFAULT_CURRENT;
977 else {
978 error("Malformed value for %s: %s", var, value);
979 return error("Must be one of nothing, matching, simple, "
980 "upstream or current.");
982 return 0;
985 /* Add other config variables here and to Documentation/config.txt. */
986 return 0;
989 static int git_default_mailmap_config(const char *var, const char *value)
991 if (!strcmp(var, "mailmap.file"))
992 return git_config_pathname(&git_mailmap_file, var, value);
993 if (!strcmp(var, "mailmap.blob"))
994 return git_config_string(&git_mailmap_blob, var, value);
996 /* Add other config variables here and to Documentation/config.txt. */
997 return 0;
1000 int git_default_config(const char *var, const char *value, void *dummy)
1002 if (starts_with(var, "core."))
1003 return git_default_core_config(var, value);
1005 if (starts_with(var, "user."))
1006 return git_ident_config(var, value, dummy);
1008 if (starts_with(var, "i18n."))
1009 return git_default_i18n_config(var, value);
1011 if (starts_with(var, "branch."))
1012 return git_default_branch_config(var, value);
1014 if (starts_with(var, "push."))
1015 return git_default_push_config(var, value);
1017 if (starts_with(var, "mailmap."))
1018 return git_default_mailmap_config(var, value);
1020 if (starts_with(var, "advice."))
1021 return git_default_advice_config(var, value);
1023 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1024 pager_use_color = git_config_bool(var,value);
1025 return 0;
1028 if (!strcmp(var, "pack.packsizelimit")) {
1029 pack_size_limit_cfg = git_config_ulong(var, value);
1030 return 0;
1032 /* Add other config variables here and to Documentation/config.txt. */
1033 return 0;
1037 * All source specific fields in the union, die_on_error, name and the callbacks
1038 * fgetc, ungetc, ftell of top need to be initialized before calling
1039 * this function.
1041 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1043 int ret;
1045 /* push config-file parsing state stack */
1046 top->prev = cf;
1047 top->linenr = 1;
1048 top->eof = 0;
1049 strbuf_init(&top->value, 1024);
1050 strbuf_init(&top->var, 1024);
1051 cf = top;
1053 ret = git_parse_source(fn, data);
1055 /* pop config-file parsing state stack */
1056 strbuf_release(&top->value);
1057 strbuf_release(&top->var);
1058 cf = top->prev;
1060 return ret;
1063 static int do_config_from_file(config_fn_t fn,
1064 const char *name, const char *path, FILE *f, void *data)
1066 struct config_source top;
1068 top.u.file = f;
1069 top.name = name;
1070 top.path = path;
1071 top.die_on_error = 1;
1072 top.do_fgetc = config_file_fgetc;
1073 top.do_ungetc = config_file_ungetc;
1074 top.do_ftell = config_file_ftell;
1076 return do_config_from(&top, fn, data);
1079 static int git_config_from_stdin(config_fn_t fn, void *data)
1081 return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
1084 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1086 int ret = -1;
1087 FILE *f;
1089 f = fopen(filename, "r");
1090 if (f) {
1091 flockfile(f);
1092 ret = do_config_from_file(fn, filename, filename, f, data);
1093 funlockfile(f);
1094 fclose(f);
1096 return ret;
1099 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1100 size_t len, void *data)
1102 struct config_source top;
1104 top.u.buf.buf = buf;
1105 top.u.buf.len = len;
1106 top.u.buf.pos = 0;
1107 top.name = name;
1108 top.path = NULL;
1109 top.die_on_error = 0;
1110 top.do_fgetc = config_buf_fgetc;
1111 top.do_ungetc = config_buf_ungetc;
1112 top.do_ftell = config_buf_ftell;
1114 return do_config_from(&top, fn, data);
1117 static int git_config_from_blob_sha1(config_fn_t fn,
1118 const char *name,
1119 const unsigned char *sha1,
1120 void *data)
1122 enum object_type type;
1123 char *buf;
1124 unsigned long size;
1125 int ret;
1127 buf = read_sha1_file(sha1, &type, &size);
1128 if (!buf)
1129 return error("unable to load config blob object '%s'", name);
1130 if (type != OBJ_BLOB) {
1131 free(buf);
1132 return error("reference '%s' does not point to a blob", name);
1135 ret = git_config_from_buf(fn, name, buf, size, data);
1136 free(buf);
1138 return ret;
1141 static int git_config_from_blob_ref(config_fn_t fn,
1142 const char *name,
1143 void *data)
1145 unsigned char sha1[20];
1147 if (get_sha1(name, sha1) < 0)
1148 return error("unable to resolve config blob '%s'", name);
1149 return git_config_from_blob_sha1(fn, name, sha1, data);
1152 const char *git_etc_gitconfig(void)
1154 static const char *system_wide;
1155 if (!system_wide)
1156 system_wide = system_path(ETC_GITCONFIG);
1157 return system_wide;
1161 * Parse environment variable 'k' as a boolean (in various
1162 * possible spellings); if missing, use the default value 'def'.
1164 int git_env_bool(const char *k, int def)
1166 const char *v = getenv(k);
1167 return v ? git_config_bool(k, v) : def;
1171 * Parse environment variable 'k' as ulong with possibly a unit
1172 * suffix; if missing, use the default value 'val'.
1174 unsigned long git_env_ulong(const char *k, unsigned long val)
1176 const char *v = getenv(k);
1177 if (v && !git_parse_ulong(v, &val))
1178 die("failed to parse %s", k);
1179 return val;
1182 int git_config_system(void)
1184 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1187 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1189 int ret = 0, found = 0;
1190 char *xdg_config = xdg_config_home("config");
1191 char *user_config = expand_user_path("~/.gitconfig");
1193 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1194 ret += git_config_from_file(fn, git_etc_gitconfig(),
1195 data);
1196 found += 1;
1199 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1200 ret += git_config_from_file(fn, xdg_config, data);
1201 found += 1;
1204 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1205 ret += git_config_from_file(fn, user_config, data);
1206 found += 1;
1209 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1210 ret += git_config_from_file(fn, repo_config, data);
1211 found += 1;
1214 switch (git_config_from_parameters(fn, data)) {
1215 case -1: /* error */
1216 die(_("unable to parse command-line config"));
1217 break;
1218 case 0: /* found nothing */
1219 break;
1220 default: /* found at least one item */
1221 found++;
1222 break;
1225 free(xdg_config);
1226 free(user_config);
1227 return ret == 0 ? found : ret;
1230 int git_config_with_options(config_fn_t fn, void *data,
1231 struct git_config_source *config_source,
1232 int respect_includes)
1234 char *repo_config = NULL;
1235 int ret;
1236 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1238 if (respect_includes) {
1239 inc.fn = fn;
1240 inc.data = data;
1241 fn = git_config_include;
1242 data = &inc;
1246 * If we have a specific filename, use it. Otherwise, follow the
1247 * regular lookup sequence.
1249 if (config_source && config_source->use_stdin)
1250 return git_config_from_stdin(fn, data);
1251 else if (config_source && config_source->file)
1252 return git_config_from_file(fn, config_source->file, data);
1253 else if (config_source && config_source->blob)
1254 return git_config_from_blob_ref(fn, config_source->blob, data);
1256 repo_config = git_pathdup("config");
1257 ret = git_config_early(fn, data, repo_config);
1258 if (repo_config)
1259 free(repo_config);
1260 return ret;
1263 static void git_config_raw(config_fn_t fn, void *data)
1265 if (git_config_with_options(fn, data, NULL, 1) < 0)
1267 * git_config_with_options() normally returns only
1268 * positive values, as most errors are fatal, and
1269 * non-fatal potential errors are guarded by "if"
1270 * statements that are entered only when no error is
1271 * possible.
1273 * If we ever encounter a non-fatal error, it means
1274 * something went really wrong and we should stop
1275 * immediately.
1277 die(_("unknown error occured while reading the configuration files"));
1280 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1282 int i, value_index;
1283 struct string_list *values;
1284 struct config_set_element *entry;
1285 struct configset_list *list = &cs->list;
1286 struct key_value_info *kv_info;
1288 for (i = 0; i < list->nr; i++) {
1289 entry = list->items[i].e;
1290 value_index = list->items[i].value_index;
1291 values = &entry->value_list;
1292 if (fn(entry->key, values->items[value_index].string, data) < 0) {
1293 kv_info = values->items[value_index].util;
1294 git_die_config_linenr(entry->key, kv_info->filename, kv_info->linenr);
1299 static void git_config_check_init(void);
1301 void git_config(config_fn_t fn, void *data)
1303 git_config_check_init();
1304 configset_iter(&the_config_set, fn, data);
1307 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1309 struct config_set_element k;
1310 struct config_set_element *found_entry;
1311 char *normalized_key;
1312 int ret;
1314 * `key` may come from the user, so normalize it before using it
1315 * for querying entries from the hashmap.
1317 ret = git_config_parse_key(key, &normalized_key, NULL);
1319 if (ret)
1320 return NULL;
1322 hashmap_entry_init(&k, strhash(normalized_key));
1323 k.key = normalized_key;
1324 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1325 free(normalized_key);
1326 return found_entry;
1329 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1331 struct config_set_element *e;
1332 struct string_list_item *si;
1333 struct configset_list_item *l_item;
1334 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1336 e = configset_find_element(cs, key);
1338 * Since the keys are being fed by git_config*() callback mechanism, they
1339 * are already normalized. So simply add them without any further munging.
1341 if (!e) {
1342 e = xmalloc(sizeof(*e));
1343 hashmap_entry_init(e, strhash(key));
1344 e->key = xstrdup(key);
1345 string_list_init(&e->value_list, 1);
1346 hashmap_add(&cs->config_hash, e);
1348 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1350 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1351 l_item = &cs->list.items[cs->list.nr++];
1352 l_item->e = e;
1353 l_item->value_index = e->value_list.nr - 1;
1355 if (cf) {
1356 kv_info->filename = strintern(cf->name);
1357 kv_info->linenr = cf->linenr;
1358 } else {
1359 /* for values read from `git_config_from_parameters()` */
1360 kv_info->filename = NULL;
1361 kv_info->linenr = -1;
1363 si->util = kv_info;
1365 return 0;
1368 static int config_set_element_cmp(const struct config_set_element *e1,
1369 const struct config_set_element *e2, const void *unused)
1371 return strcmp(e1->key, e2->key);
1374 void git_configset_init(struct config_set *cs)
1376 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1377 cs->hash_initialized = 1;
1378 cs->list.nr = 0;
1379 cs->list.alloc = 0;
1380 cs->list.items = NULL;
1383 void git_configset_clear(struct config_set *cs)
1385 struct config_set_element *entry;
1386 struct hashmap_iter iter;
1387 if (!cs->hash_initialized)
1388 return;
1390 hashmap_iter_init(&cs->config_hash, &iter);
1391 while ((entry = hashmap_iter_next(&iter))) {
1392 free(entry->key);
1393 string_list_clear(&entry->value_list, 1);
1395 hashmap_free(&cs->config_hash, 1);
1396 cs->hash_initialized = 0;
1397 free(cs->list.items);
1398 cs->list.nr = 0;
1399 cs->list.alloc = 0;
1400 cs->list.items = NULL;
1403 static int config_set_callback(const char *key, const char *value, void *cb)
1405 struct config_set *cs = cb;
1406 configset_add_value(cs, key, value);
1407 return 0;
1410 int git_configset_add_file(struct config_set *cs, const char *filename)
1412 return git_config_from_file(config_set_callback, filename, cs);
1415 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1417 const struct string_list *values = NULL;
1419 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1420 * queried key in the files of the configset, the value returned will be the last
1421 * value in the value list for that key.
1423 values = git_configset_get_value_multi(cs, key);
1425 if (!values)
1426 return 1;
1427 assert(values->nr > 0);
1428 *value = values->items[values->nr - 1].string;
1429 return 0;
1432 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1434 struct config_set_element *e = configset_find_element(cs, key);
1435 return e ? &e->value_list : NULL;
1438 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1440 const char *value;
1441 if (!git_configset_get_value(cs, key, &value))
1442 return git_config_string(dest, key, value);
1443 else
1444 return 1;
1447 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1449 return git_configset_get_string_const(cs, key, (const char **)dest);
1452 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1454 const char *value;
1455 if (!git_configset_get_value(cs, key, &value)) {
1456 *dest = git_config_int(key, value);
1457 return 0;
1458 } else
1459 return 1;
1462 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1464 const char *value;
1465 if (!git_configset_get_value(cs, key, &value)) {
1466 *dest = git_config_ulong(key, value);
1467 return 0;
1468 } else
1469 return 1;
1472 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1474 const char *value;
1475 if (!git_configset_get_value(cs, key, &value)) {
1476 *dest = git_config_bool(key, value);
1477 return 0;
1478 } else
1479 return 1;
1482 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1483 int *is_bool, int *dest)
1485 const char *value;
1486 if (!git_configset_get_value(cs, key, &value)) {
1487 *dest = git_config_bool_or_int(key, value, is_bool);
1488 return 0;
1489 } else
1490 return 1;
1493 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1495 const char *value;
1496 if (!git_configset_get_value(cs, key, &value)) {
1497 *dest = git_config_maybe_bool(key, value);
1498 if (*dest == -1)
1499 return -1;
1500 return 0;
1501 } else
1502 return 1;
1505 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1507 const char *value;
1508 if (!git_configset_get_value(cs, key, &value))
1509 return git_config_pathname(dest, key, value);
1510 else
1511 return 1;
1514 static void git_config_check_init(void)
1516 if (the_config_set.hash_initialized)
1517 return;
1518 git_configset_init(&the_config_set);
1519 git_config_raw(config_set_callback, &the_config_set);
1522 void git_config_clear(void)
1524 if (!the_config_set.hash_initialized)
1525 return;
1526 git_configset_clear(&the_config_set);
1529 int git_config_get_value(const char *key, const char **value)
1531 git_config_check_init();
1532 return git_configset_get_value(&the_config_set, key, value);
1535 const struct string_list *git_config_get_value_multi(const char *key)
1537 git_config_check_init();
1538 return git_configset_get_value_multi(&the_config_set, key);
1541 int git_config_get_string_const(const char *key, const char **dest)
1543 int ret;
1544 git_config_check_init();
1545 ret = git_configset_get_string_const(&the_config_set, key, dest);
1546 if (ret < 0)
1547 git_die_config(key, NULL);
1548 return ret;
1551 int git_config_get_string(const char *key, char **dest)
1553 git_config_check_init();
1554 return git_config_get_string_const(key, (const char **)dest);
1557 int git_config_get_int(const char *key, int *dest)
1559 git_config_check_init();
1560 return git_configset_get_int(&the_config_set, key, dest);
1563 int git_config_get_ulong(const char *key, unsigned long *dest)
1565 git_config_check_init();
1566 return git_configset_get_ulong(&the_config_set, key, dest);
1569 int git_config_get_bool(const char *key, int *dest)
1571 git_config_check_init();
1572 return git_configset_get_bool(&the_config_set, key, dest);
1575 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1577 git_config_check_init();
1578 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1581 int git_config_get_maybe_bool(const char *key, int *dest)
1583 git_config_check_init();
1584 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1587 int git_config_get_pathname(const char *key, const char **dest)
1589 int ret;
1590 git_config_check_init();
1591 ret = git_configset_get_pathname(&the_config_set, key, dest);
1592 if (ret < 0)
1593 git_die_config(key, NULL);
1594 return ret;
1597 int git_config_get_untracked_cache(void)
1599 int val = -1;
1600 const char *v;
1602 /* Hack for test programs like test-dump-untracked-cache */
1603 if (ignore_untracked_cache_config)
1604 return -1;
1606 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
1607 return val;
1609 if (!git_config_get_value("core.untrackedcache", &v)) {
1610 if (!strcasecmp(v, "keep"))
1611 return -1;
1613 error("unknown core.untrackedCache value '%s'; "
1614 "using 'keep' default value", v);
1615 return -1;
1618 return -1; /* default value */
1621 NORETURN
1622 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1624 if (!filename)
1625 die(_("unable to parse '%s' from command-line config"), key);
1626 else
1627 die(_("bad config variable '%s' in file '%s' at line %d"),
1628 key, filename, linenr);
1631 NORETURN __attribute__((format(printf, 2, 3)))
1632 void git_die_config(const char *key, const char *err, ...)
1634 const struct string_list *values;
1635 struct key_value_info *kv_info;
1637 if (err) {
1638 va_list params;
1639 va_start(params, err);
1640 vreportf("error: ", err, params);
1641 va_end(params);
1643 values = git_config_get_value_multi(key);
1644 kv_info = values->items[values->nr - 1].util;
1645 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
1649 * Find all the stuff for git_config_set() below.
1652 static struct {
1653 int baselen;
1654 char *key;
1655 int do_not_match;
1656 regex_t *value_regex;
1657 int multi_replace;
1658 size_t *offset;
1659 unsigned int offset_alloc;
1660 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1661 int seen;
1662 } store;
1664 static int matches(const char *key, const char *value)
1666 if (strcmp(key, store.key))
1667 return 0; /* not ours */
1668 if (!store.value_regex)
1669 return 1; /* always matches */
1670 if (store.value_regex == CONFIG_REGEX_NONE)
1671 return 0; /* never matches */
1673 return store.do_not_match ^
1674 (value && !regexec(store.value_regex, value, 0, NULL, 0));
1677 static int store_aux(const char *key, const char *value, void *cb)
1679 const char *ep;
1680 size_t section_len;
1682 switch (store.state) {
1683 case KEY_SEEN:
1684 if (matches(key, value)) {
1685 if (store.seen == 1 && store.multi_replace == 0) {
1686 warning(_("%s has multiple values"), key);
1689 ALLOC_GROW(store.offset, store.seen + 1,
1690 store.offset_alloc);
1692 store.offset[store.seen] = cf->do_ftell(cf);
1693 store.seen++;
1695 break;
1696 case SECTION_SEEN:
1698 * What we are looking for is in store.key (both
1699 * section and var), and its section part is baselen
1700 * long. We found key (again, both section and var).
1701 * We would want to know if this key is in the same
1702 * section as what we are looking for. We already
1703 * know we are in the same section as what should
1704 * hold store.key.
1706 ep = strrchr(key, '.');
1707 section_len = ep - key;
1709 if ((section_len != store.baselen) ||
1710 memcmp(key, store.key, section_len+1)) {
1711 store.state = SECTION_END_SEEN;
1712 break;
1716 * Do not increment matches: this is no match, but we
1717 * just made sure we are in the desired section.
1719 ALLOC_GROW(store.offset, store.seen + 1,
1720 store.offset_alloc);
1721 store.offset[store.seen] = cf->do_ftell(cf);
1722 /* fallthru */
1723 case SECTION_END_SEEN:
1724 case START:
1725 if (matches(key, value)) {
1726 ALLOC_GROW(store.offset, store.seen + 1,
1727 store.offset_alloc);
1728 store.offset[store.seen] = cf->do_ftell(cf);
1729 store.state = KEY_SEEN;
1730 store.seen++;
1731 } else {
1732 if (strrchr(key, '.') - key == store.baselen &&
1733 !strncmp(key, store.key, store.baselen)) {
1734 store.state = SECTION_SEEN;
1735 ALLOC_GROW(store.offset,
1736 store.seen + 1,
1737 store.offset_alloc);
1738 store.offset[store.seen] = cf->do_ftell(cf);
1742 return 0;
1745 static int write_error(const char *filename)
1747 error("failed to write new configuration file %s", filename);
1749 /* Same error code as "failed to rename". */
1750 return 4;
1753 static int store_write_section(int fd, const char *key)
1755 const char *dot;
1756 int i, success;
1757 struct strbuf sb = STRBUF_INIT;
1759 dot = memchr(key, '.', store.baselen);
1760 if (dot) {
1761 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1762 for (i = dot - key + 1; i < store.baselen; i++) {
1763 if (key[i] == '"' || key[i] == '\\')
1764 strbuf_addch(&sb, '\\');
1765 strbuf_addch(&sb, key[i]);
1767 strbuf_addstr(&sb, "\"]\n");
1768 } else {
1769 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1772 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1773 strbuf_release(&sb);
1775 return success;
1778 static int store_write_pair(int fd, const char *key, const char *value)
1780 int i, success;
1781 int length = strlen(key + store.baselen + 1);
1782 const char *quote = "";
1783 struct strbuf sb = STRBUF_INIT;
1786 * Check to see if the value needs to be surrounded with a dq pair.
1787 * Note that problematic characters are always backslash-quoted; this
1788 * check is about not losing leading or trailing SP and strings that
1789 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1790 * configuration parser.
1792 if (value[0] == ' ')
1793 quote = "\"";
1794 for (i = 0; value[i]; i++)
1795 if (value[i] == ';' || value[i] == '#')
1796 quote = "\"";
1797 if (i && value[i - 1] == ' ')
1798 quote = "\"";
1800 strbuf_addf(&sb, "\t%.*s = %s",
1801 length, key + store.baselen + 1, quote);
1803 for (i = 0; value[i]; i++)
1804 switch (value[i]) {
1805 case '\n':
1806 strbuf_addstr(&sb, "\\n");
1807 break;
1808 case '\t':
1809 strbuf_addstr(&sb, "\\t");
1810 break;
1811 case '"':
1812 case '\\':
1813 strbuf_addch(&sb, '\\');
1814 default:
1815 strbuf_addch(&sb, value[i]);
1816 break;
1818 strbuf_addf(&sb, "%s\n", quote);
1820 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1821 strbuf_release(&sb);
1823 return success;
1826 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1827 size_t offset_, int *found_bracket)
1829 size_t equal_offset = size, bracket_offset = size;
1830 ssize_t offset;
1832 contline:
1833 for (offset = offset_-2; offset > 0
1834 && contents[offset] != '\n'; offset--)
1835 switch (contents[offset]) {
1836 case '=': equal_offset = offset; break;
1837 case ']': bracket_offset = offset; break;
1839 if (offset > 0 && contents[offset-1] == '\\') {
1840 offset_ = offset;
1841 goto contline;
1843 if (bracket_offset < equal_offset) {
1844 *found_bracket = 1;
1845 offset = bracket_offset+1;
1846 } else
1847 offset++;
1849 return offset;
1852 int git_config_set_in_file(const char *config_filename,
1853 const char *key, const char *value)
1855 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1858 int git_config_set(const char *key, const char *value)
1860 return git_config_set_multivar(key, value, NULL, 0);
1864 * Auxiliary function to sanity-check and split the key into the section
1865 * identifier and variable name.
1867 * Returns 0 on success, -1 when there is an invalid character in the key and
1868 * -2 if there is no section name in the key.
1870 * store_key - pointer to char* which will hold a copy of the key with
1871 * lowercase section and variable name
1872 * baselen - pointer to int which will hold the length of the
1873 * section + subsection part, can be NULL
1875 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
1877 int i, dot, baselen;
1878 const char *last_dot = strrchr(key, '.');
1881 * Since "key" actually contains the section name and the real
1882 * key name separated by a dot, we have to know where the dot is.
1885 if (last_dot == NULL || last_dot == key) {
1886 if (!quiet)
1887 error("key does not contain a section: %s", key);
1888 return -CONFIG_NO_SECTION_OR_NAME;
1891 if (!last_dot[1]) {
1892 if (!quiet)
1893 error("key does not contain variable name: %s", key);
1894 return -CONFIG_NO_SECTION_OR_NAME;
1897 baselen = last_dot - key;
1898 if (baselen_)
1899 *baselen_ = baselen;
1902 * Validate the key and while at it, lower case it for matching.
1904 if (store_key)
1905 *store_key = xmalloc(strlen(key) + 1);
1907 dot = 0;
1908 for (i = 0; key[i]; i++) {
1909 unsigned char c = key[i];
1910 if (c == '.')
1911 dot = 1;
1912 /* Leave the extended basename untouched.. */
1913 if (!dot || i > baselen) {
1914 if (!iskeychar(c) ||
1915 (i == baselen + 1 && !isalpha(c))) {
1916 if (!quiet)
1917 error("invalid key: %s", key);
1918 goto out_free_ret_1;
1920 c = tolower(c);
1921 } else if (c == '\n') {
1922 if (!quiet)
1923 error("invalid key (newline): %s", key);
1924 goto out_free_ret_1;
1926 if (store_key)
1927 (*store_key)[i] = c;
1929 if (store_key)
1930 (*store_key)[i] = 0;
1932 return 0;
1934 out_free_ret_1:
1935 if (store_key) {
1936 free(*store_key);
1937 *store_key = NULL;
1939 return -CONFIG_INVALID_KEY;
1942 int git_config_parse_key(const char *key, char **store_key, int *baselen)
1944 return git_config_parse_key_1(key, store_key, baselen, 0);
1947 int git_config_key_is_valid(const char *key)
1949 return !git_config_parse_key_1(key, NULL, NULL, 1);
1953 * If value==NULL, unset in (remove from) config,
1954 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1955 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
1956 * (only add a new one)
1957 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1958 * else all matching key/values (regardless how many) are removed,
1959 * before the new pair is written.
1961 * Returns 0 on success.
1963 * This function does this:
1965 * - it locks the config file by creating ".git/config.lock"
1967 * - it then parses the config using store_aux() as validator to find
1968 * the position on the key/value pair to replace. If it is to be unset,
1969 * it must be found exactly once.
1971 * - the config file is mmap()ed and the part before the match (if any) is
1972 * written to the lock file, then the changed part and the rest.
1974 * - the config file is removed and the lock file rename()d to it.
1977 int git_config_set_multivar_in_file(const char *config_filename,
1978 const char *key, const char *value,
1979 const char *value_regex, int multi_replace)
1981 int fd = -1, in_fd = -1;
1982 int ret;
1983 struct lock_file *lock = NULL;
1984 char *filename_buf = NULL;
1985 char *contents = NULL;
1986 size_t contents_sz;
1988 /* parse-key returns negative; flip the sign to feed exit(3) */
1989 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1990 if (ret)
1991 goto out_free;
1993 store.multi_replace = multi_replace;
1995 if (!config_filename)
1996 config_filename = filename_buf = git_pathdup("config");
1999 * The lock serves a purpose in addition to locking: the new
2000 * contents of .git/config will be written into it.
2002 lock = xcalloc(1, sizeof(struct lock_file));
2003 fd = hold_lock_file_for_update(lock, config_filename, 0);
2004 if (fd < 0) {
2005 error("could not lock config file %s: %s", config_filename, strerror(errno));
2006 free(store.key);
2007 ret = CONFIG_NO_LOCK;
2008 goto out_free;
2012 * If .git/config does not exist yet, write a minimal version.
2014 in_fd = open(config_filename, O_RDONLY);
2015 if ( in_fd < 0 ) {
2016 free(store.key);
2018 if ( ENOENT != errno ) {
2019 error("opening %s: %s", config_filename,
2020 strerror(errno));
2021 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2022 goto out_free;
2024 /* if nothing to unset, error out */
2025 if (value == NULL) {
2026 ret = CONFIG_NOTHING_SET;
2027 goto out_free;
2030 store.key = (char *)key;
2031 if (!store_write_section(fd, key) ||
2032 !store_write_pair(fd, key, value))
2033 goto write_err_out;
2034 } else {
2035 struct stat st;
2036 size_t copy_begin, copy_end;
2037 int i, new_line = 0;
2039 if (value_regex == NULL)
2040 store.value_regex = NULL;
2041 else if (value_regex == CONFIG_REGEX_NONE)
2042 store.value_regex = CONFIG_REGEX_NONE;
2043 else {
2044 if (value_regex[0] == '!') {
2045 store.do_not_match = 1;
2046 value_regex++;
2047 } else
2048 store.do_not_match = 0;
2050 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2051 if (regcomp(store.value_regex, value_regex,
2052 REG_EXTENDED)) {
2053 error("invalid pattern: %s", value_regex);
2054 free(store.value_regex);
2055 ret = CONFIG_INVALID_PATTERN;
2056 goto out_free;
2060 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2061 store.offset[0] = 0;
2062 store.state = START;
2063 store.seen = 0;
2066 * After this, store.offset will contain the *end* offset
2067 * of the last match, or remain at 0 if no match was found.
2068 * As a side effect, we make sure to transform only a valid
2069 * existing config file.
2071 if (git_config_from_file(store_aux, config_filename, NULL)) {
2072 error("invalid config file %s", config_filename);
2073 free(store.key);
2074 if (store.value_regex != NULL &&
2075 store.value_regex != CONFIG_REGEX_NONE) {
2076 regfree(store.value_regex);
2077 free(store.value_regex);
2079 ret = CONFIG_INVALID_FILE;
2080 goto out_free;
2083 free(store.key);
2084 if (store.value_regex != NULL &&
2085 store.value_regex != CONFIG_REGEX_NONE) {
2086 regfree(store.value_regex);
2087 free(store.value_regex);
2090 /* if nothing to unset, or too many matches, error out */
2091 if ((store.seen == 0 && value == NULL) ||
2092 (store.seen > 1 && multi_replace == 0)) {
2093 ret = CONFIG_NOTHING_SET;
2094 goto out_free;
2097 fstat(in_fd, &st);
2098 contents_sz = xsize_t(st.st_size);
2099 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2100 MAP_PRIVATE, in_fd, 0);
2101 if (contents == MAP_FAILED) {
2102 if (errno == ENODEV && S_ISDIR(st.st_mode))
2103 errno = EISDIR;
2104 error("unable to mmap '%s': %s",
2105 config_filename, strerror(errno));
2106 ret = CONFIG_INVALID_FILE;
2107 contents = NULL;
2108 goto out_free;
2110 close(in_fd);
2111 in_fd = -1;
2113 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2114 error("chmod on %s failed: %s",
2115 get_lock_file_path(lock), strerror(errno));
2116 ret = CONFIG_NO_WRITE;
2117 goto out_free;
2120 if (store.seen == 0)
2121 store.seen = 1;
2123 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2124 if (store.offset[i] == 0) {
2125 store.offset[i] = copy_end = contents_sz;
2126 } else if (store.state != KEY_SEEN) {
2127 copy_end = store.offset[i];
2128 } else
2129 copy_end = find_beginning_of_line(
2130 contents, contents_sz,
2131 store.offset[i]-2, &new_line);
2133 if (copy_end > 0 && contents[copy_end-1] != '\n')
2134 new_line = 1;
2136 /* write the first part of the config */
2137 if (copy_end > copy_begin) {
2138 if (write_in_full(fd, contents + copy_begin,
2139 copy_end - copy_begin) <
2140 copy_end - copy_begin)
2141 goto write_err_out;
2142 if (new_line &&
2143 write_str_in_full(fd, "\n") != 1)
2144 goto write_err_out;
2146 copy_begin = store.offset[i];
2149 /* write the pair (value == NULL means unset) */
2150 if (value != NULL) {
2151 if (store.state == START) {
2152 if (!store_write_section(fd, key))
2153 goto write_err_out;
2155 if (!store_write_pair(fd, key, value))
2156 goto write_err_out;
2159 /* write the rest of the config */
2160 if (copy_begin < contents_sz)
2161 if (write_in_full(fd, contents + copy_begin,
2162 contents_sz - copy_begin) <
2163 contents_sz - copy_begin)
2164 goto write_err_out;
2166 munmap(contents, contents_sz);
2167 contents = NULL;
2170 if (commit_lock_file(lock) < 0) {
2171 error("could not write config file %s: %s", config_filename,
2172 strerror(errno));
2173 ret = CONFIG_NO_WRITE;
2174 lock = NULL;
2175 goto out_free;
2179 * lock is committed, so don't try to roll it back below.
2180 * NOTE: Since lockfile.c keeps a linked list of all created
2181 * lock_file structures, it isn't safe to free(lock). It's
2182 * better to just leave it hanging around.
2184 lock = NULL;
2185 ret = 0;
2187 /* Invalidate the config cache */
2188 git_config_clear();
2190 out_free:
2191 if (lock)
2192 rollback_lock_file(lock);
2193 free(filename_buf);
2194 if (contents)
2195 munmap(contents, contents_sz);
2196 if (in_fd >= 0)
2197 close(in_fd);
2198 return ret;
2200 write_err_out:
2201 ret = write_error(get_lock_file_path(lock));
2202 goto out_free;
2206 int git_config_set_multivar(const char *key, const char *value,
2207 const char *value_regex, int multi_replace)
2209 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
2210 multi_replace);
2213 static int section_name_match (const char *buf, const char *name)
2215 int i = 0, j = 0, dot = 0;
2216 if (buf[i] != '[')
2217 return 0;
2218 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2219 if (!dot && isspace(buf[i])) {
2220 dot = 1;
2221 if (name[j++] != '.')
2222 break;
2223 for (i++; isspace(buf[i]); i++)
2224 ; /* do nothing */
2225 if (buf[i] != '"')
2226 break;
2227 continue;
2229 if (buf[i] == '\\' && dot)
2230 i++;
2231 else if (buf[i] == '"' && dot) {
2232 for (i++; isspace(buf[i]); i++)
2233 ; /* do_nothing */
2234 break;
2236 if (buf[i] != name[j++])
2237 break;
2239 if (buf[i] == ']' && name[j] == 0) {
2241 * We match, now just find the right length offset by
2242 * gobbling up any whitespace after it, as well
2244 i++;
2245 for (; buf[i] && isspace(buf[i]); i++)
2246 ; /* do nothing */
2247 return i;
2249 return 0;
2252 static int section_name_is_ok(const char *name)
2254 /* Empty section names are bogus. */
2255 if (!*name)
2256 return 0;
2259 * Before a dot, we must be alphanumeric or dash. After the first dot,
2260 * anything goes, so we can stop checking.
2262 for (; *name && *name != '.'; name++)
2263 if (*name != '-' && !isalnum(*name))
2264 return 0;
2265 return 1;
2268 /* if new_name == NULL, the section is removed instead */
2269 int git_config_rename_section_in_file(const char *config_filename,
2270 const char *old_name, const char *new_name)
2272 int ret = 0, remove = 0;
2273 char *filename_buf = NULL;
2274 struct lock_file *lock;
2275 int out_fd;
2276 char buf[1024];
2277 FILE *config_file;
2278 struct stat st;
2280 if (new_name && !section_name_is_ok(new_name)) {
2281 ret = error("invalid section name: %s", new_name);
2282 goto out;
2285 if (!config_filename)
2286 config_filename = filename_buf = git_pathdup("config");
2288 lock = xcalloc(1, sizeof(struct lock_file));
2289 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2290 if (out_fd < 0) {
2291 ret = error("could not lock config file %s", config_filename);
2292 goto out;
2295 if (!(config_file = fopen(config_filename, "rb"))) {
2296 /* no config file means nothing to rename, no error */
2297 goto unlock_and_out;
2300 fstat(fileno(config_file), &st);
2302 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2303 ret = error("chmod on %s failed: %s",
2304 get_lock_file_path(lock), strerror(errno));
2305 goto out;
2308 while (fgets(buf, sizeof(buf), config_file)) {
2309 int i;
2310 int length;
2311 char *output = buf;
2312 for (i = 0; buf[i] && isspace(buf[i]); i++)
2313 ; /* do nothing */
2314 if (buf[i] == '[') {
2315 /* it's a section */
2316 int offset = section_name_match(&buf[i], old_name);
2317 if (offset > 0) {
2318 ret++;
2319 if (new_name == NULL) {
2320 remove = 1;
2321 continue;
2323 store.baselen = strlen(new_name);
2324 if (!store_write_section(out_fd, new_name)) {
2325 ret = write_error(get_lock_file_path(lock));
2326 goto out;
2329 * We wrote out the new section, with
2330 * a newline, now skip the old
2331 * section's length
2333 output += offset + i;
2334 if (strlen(output) > 0) {
2336 * More content means there's
2337 * a declaration to put on the
2338 * next line; indent with a
2339 * tab
2341 output -= 1;
2342 output[0] = '\t';
2345 remove = 0;
2347 if (remove)
2348 continue;
2349 length = strlen(output);
2350 if (write_in_full(out_fd, output, length) != length) {
2351 ret = write_error(get_lock_file_path(lock));
2352 goto out;
2355 fclose(config_file);
2356 unlock_and_out:
2357 if (commit_lock_file(lock) < 0)
2358 ret = error("could not write config file %s: %s",
2359 config_filename, strerror(errno));
2360 out:
2361 free(filename_buf);
2362 return ret;
2365 int git_config_rename_section(const char *old_name, const char *new_name)
2367 return git_config_rename_section_in_file(NULL, old_name, new_name);
2371 * Call this to report error for your variable that should not
2372 * get a boolean value (i.e. "[my] var" means "true").
2374 #undef config_error_nonbool
2375 int config_error_nonbool(const char *var)
2377 return error("Missing value for '%s'", var);
2380 int parse_config_key(const char *var,
2381 const char *section,
2382 const char **subsection, int *subsection_len,
2383 const char **key)
2385 int section_len = strlen(section);
2386 const char *dot;
2388 /* Does it start with "section." ? */
2389 if (!starts_with(var, section) || var[section_len] != '.')
2390 return -1;
2393 * Find the key; we don't know yet if we have a subsection, but we must
2394 * parse backwards from the end, since the subsection may have dots in
2395 * it, too.
2397 dot = strrchr(var, '.');
2398 *key = dot + 1;
2400 /* Did we have a subsection at all? */
2401 if (dot == var + section_len) {
2402 *subsection = NULL;
2403 *subsection_len = 0;
2405 else {
2406 *subsection = var + section_len + 1;
2407 *subsection_len = dot - *subsection;
2410 return 0;