checkout: generalize die_if_checked_out() branch name argument
[alt-git.git] / config.c
blob15a298357796ffa80f7fb2258e55cf95be0b8895
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"
16 struct config_source {
17 struct config_source *prev;
18 union {
19 FILE *file;
20 struct config_buf {
21 const char *buf;
22 size_t len;
23 size_t pos;
24 } buf;
25 } u;
26 const char *name;
27 const char *path;
28 int die_on_error;
29 int linenr;
30 int eof;
31 struct strbuf value;
32 struct strbuf var;
34 int (*do_fgetc)(struct config_source *c);
35 int (*do_ungetc)(int c, struct config_source *conf);
36 long (*do_ftell)(struct config_source *c);
39 static struct config_source *cf;
41 static int zlib_compression_seen;
44 * Default config_set that contains key-value pairs from the usual set of config
45 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
46 * config file and the global /etc/gitconfig)
48 static struct config_set the_config_set;
50 static int config_file_fgetc(struct config_source *conf)
52 return fgetc(conf->u.file);
55 static int config_file_ungetc(int c, struct config_source *conf)
57 return ungetc(c, conf->u.file);
60 static long config_file_ftell(struct config_source *conf)
62 return ftell(conf->u.file);
66 static int config_buf_fgetc(struct config_source *conf)
68 if (conf->u.buf.pos < conf->u.buf.len)
69 return conf->u.buf.buf[conf->u.buf.pos++];
71 return EOF;
74 static int config_buf_ungetc(int c, struct config_source *conf)
76 if (conf->u.buf.pos > 0)
77 return conf->u.buf.buf[--conf->u.buf.pos];
79 return EOF;
82 static long config_buf_ftell(struct config_source *conf)
84 return conf->u.buf.pos;
87 #define MAX_INCLUDE_DEPTH 10
88 static const char include_depth_advice[] =
89 "exceeded maximum include depth (%d) while including\n"
90 " %s\n"
91 "from\n"
92 " %s\n"
93 "Do you have circular includes?";
94 static int handle_path_include(const char *path, struct config_include_data *inc)
96 int ret = 0;
97 struct strbuf buf = STRBUF_INIT;
98 char *expanded;
100 if (!path)
101 return config_error_nonbool("include.path");
103 expanded = expand_user_path(path);
104 if (!expanded)
105 return error("Could not expand include path '%s'", path);
106 path = expanded;
109 * Use an absolute path as-is, but interpret relative paths
110 * based on the including config file.
112 if (!is_absolute_path(path)) {
113 char *slash;
115 if (!cf || !cf->path)
116 return error("relative config includes must come from files");
118 slash = find_last_dir_sep(cf->path);
119 if (slash)
120 strbuf_add(&buf, cf->path, slash - cf->path + 1);
121 strbuf_addstr(&buf, path);
122 path = buf.buf;
125 if (!access_or_die(path, R_OK, 0)) {
126 if (++inc->depth > MAX_INCLUDE_DEPTH)
127 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
128 cf && cf->name ? cf->name : "the command line");
129 ret = git_config_from_file(git_config_include, path, inc);
130 inc->depth--;
132 strbuf_release(&buf);
133 free(expanded);
134 return ret;
137 int git_config_include(const char *var, const char *value, void *data)
139 struct config_include_data *inc = data;
140 int ret;
143 * Pass along all values, including "include" directives; this makes it
144 * possible to query information on the includes themselves.
146 ret = inc->fn(var, value, inc->data);
147 if (ret < 0)
148 return ret;
150 if (!strcmp(var, "include.path"))
151 ret = handle_path_include(value, inc);
152 return ret;
155 void git_config_push_parameter(const char *text)
157 struct strbuf env = STRBUF_INIT;
158 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
159 if (old) {
160 strbuf_addstr(&env, old);
161 strbuf_addch(&env, ' ');
163 sq_quote_buf(&env, text);
164 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
165 strbuf_release(&env);
168 int git_config_parse_parameter(const char *text,
169 config_fn_t fn, void *data)
171 const char *value;
172 struct strbuf **pair;
174 pair = strbuf_split_str(text, '=', 2);
175 if (!pair[0])
176 return error("bogus config parameter: %s", text);
178 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
179 strbuf_setlen(pair[0], pair[0]->len - 1);
180 value = pair[1] ? pair[1]->buf : "";
181 } else {
182 value = NULL;
185 strbuf_trim(pair[0]);
186 if (!pair[0]->len) {
187 strbuf_list_free(pair);
188 return error("bogus config parameter: %s", text);
190 strbuf_tolower(pair[0]);
191 if (fn(pair[0]->buf, value, data) < 0) {
192 strbuf_list_free(pair);
193 return -1;
195 strbuf_list_free(pair);
196 return 0;
199 int git_config_from_parameters(config_fn_t fn, void *data)
201 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
202 char *envw;
203 const char **argv = NULL;
204 int nr = 0, alloc = 0;
205 int i;
207 if (!env)
208 return 0;
209 /* sq_dequote will write over it */
210 envw = xstrdup(env);
212 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
213 free(envw);
214 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
217 for (i = 0; i < nr; i++) {
218 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
219 free(argv);
220 free(envw);
221 return -1;
225 free(argv);
226 free(envw);
227 return nr > 0;
230 static int get_next_char(void)
232 int c = cf->do_fgetc(cf);
234 if (c == '\r') {
235 /* DOS like systems */
236 c = cf->do_fgetc(cf);
237 if (c != '\n') {
238 cf->do_ungetc(c, cf);
239 c = '\r';
242 if (c == '\n')
243 cf->linenr++;
244 if (c == EOF) {
245 cf->eof = 1;
246 cf->linenr++;
247 c = '\n';
249 return c;
252 static char *parse_value(void)
254 int quote = 0, comment = 0, space = 0;
256 strbuf_reset(&cf->value);
257 for (;;) {
258 int c = get_next_char();
259 if (c == '\n') {
260 if (quote) {
261 cf->linenr--;
262 return NULL;
264 return cf->value.buf;
266 if (comment)
267 continue;
268 if (isspace(c) && !quote) {
269 if (cf->value.len)
270 space++;
271 continue;
273 if (!quote) {
274 if (c == ';' || c == '#') {
275 comment = 1;
276 continue;
279 for (; space; space--)
280 strbuf_addch(&cf->value, ' ');
281 if (c == '\\') {
282 c = get_next_char();
283 switch (c) {
284 case '\n':
285 continue;
286 case 't':
287 c = '\t';
288 break;
289 case 'b':
290 c = '\b';
291 break;
292 case 'n':
293 c = '\n';
294 break;
295 /* Some characters escape as themselves */
296 case '\\': case '"':
297 break;
298 /* Reject unknown escape sequences */
299 default:
300 return NULL;
302 strbuf_addch(&cf->value, c);
303 continue;
305 if (c == '"') {
306 quote = 1-quote;
307 continue;
309 strbuf_addch(&cf->value, c);
313 static inline int iskeychar(int c)
315 return isalnum(c) || c == '-';
318 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
320 int c;
321 char *value;
322 int ret;
324 /* Get the full name */
325 for (;;) {
326 c = get_next_char();
327 if (cf->eof)
328 break;
329 if (!iskeychar(c))
330 break;
331 strbuf_addch(name, tolower(c));
334 while (c == ' ' || c == '\t')
335 c = get_next_char();
337 value = NULL;
338 if (c != '\n') {
339 if (c != '=')
340 return -1;
341 value = parse_value();
342 if (!value)
343 return -1;
346 * We already consumed the \n, but we need linenr to point to
347 * the line we just parsed during the call to fn to get
348 * accurate line number in error messages.
350 cf->linenr--;
351 ret = fn(name->buf, value, data);
352 cf->linenr++;
353 return ret;
356 static int get_extended_base_var(struct strbuf *name, int c)
358 do {
359 if (c == '\n')
360 goto error_incomplete_line;
361 c = get_next_char();
362 } while (isspace(c));
364 /* We require the format to be '[base "extension"]' */
365 if (c != '"')
366 return -1;
367 strbuf_addch(name, '.');
369 for (;;) {
370 int c = get_next_char();
371 if (c == '\n')
372 goto error_incomplete_line;
373 if (c == '"')
374 break;
375 if (c == '\\') {
376 c = get_next_char();
377 if (c == '\n')
378 goto error_incomplete_line;
380 strbuf_addch(name, c);
383 /* Final ']' */
384 if (get_next_char() != ']')
385 return -1;
386 return 0;
387 error_incomplete_line:
388 cf->linenr--;
389 return -1;
392 static int get_base_var(struct strbuf *name)
394 for (;;) {
395 int c = get_next_char();
396 if (cf->eof)
397 return -1;
398 if (c == ']')
399 return 0;
400 if (isspace(c))
401 return get_extended_base_var(name, c);
402 if (!iskeychar(c) && c != '.')
403 return -1;
404 strbuf_addch(name, tolower(c));
408 static int git_parse_source(config_fn_t fn, void *data)
410 int comment = 0;
411 int baselen = 0;
412 struct strbuf *var = &cf->var;
414 /* U+FEFF Byte Order Mark in UTF8 */
415 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
416 const unsigned char *bomptr = utf8_bom;
418 for (;;) {
419 int c = get_next_char();
420 if (bomptr && *bomptr) {
421 /* We are at the file beginning; skip UTF8-encoded BOM
422 * if present. Sane editors won't put this in on their
423 * own, but e.g. Windows Notepad will do it happily. */
424 if ((unsigned char) c == *bomptr) {
425 bomptr++;
426 continue;
427 } else {
428 /* Do not tolerate partial BOM. */
429 if (bomptr != utf8_bom)
430 break;
431 /* No BOM at file beginning. Cool. */
432 bomptr = NULL;
435 if (c == '\n') {
436 if (cf->eof)
437 return 0;
438 comment = 0;
439 continue;
441 if (comment || isspace(c))
442 continue;
443 if (c == '#' || c == ';') {
444 comment = 1;
445 continue;
447 if (c == '[') {
448 /* Reset prior to determining a new stem */
449 strbuf_reset(var);
450 if (get_base_var(var) < 0 || var->len < 1)
451 break;
452 strbuf_addch(var, '.');
453 baselen = var->len;
454 continue;
456 if (!isalpha(c))
457 break;
459 * Truncate the var name back to the section header
460 * stem prior to grabbing the suffix part of the name
461 * and the value.
463 strbuf_setlen(var, baselen);
464 strbuf_addch(var, tolower(c));
465 if (get_value(fn, data, var) < 0)
466 break;
468 if (cf->die_on_error)
469 die(_("bad config file line %d in %s"), cf->linenr, cf->name);
470 else
471 return error(_("bad config file line %d in %s"), cf->linenr, cf->name);
474 static int parse_unit_factor(const char *end, uintmax_t *val)
476 if (!*end)
477 return 1;
478 else if (!strcasecmp(end, "k")) {
479 *val *= 1024;
480 return 1;
482 else if (!strcasecmp(end, "m")) {
483 *val *= 1024 * 1024;
484 return 1;
486 else if (!strcasecmp(end, "g")) {
487 *val *= 1024 * 1024 * 1024;
488 return 1;
490 return 0;
493 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
495 if (value && *value) {
496 char *end;
497 intmax_t val;
498 uintmax_t uval;
499 uintmax_t factor = 1;
501 errno = 0;
502 val = strtoimax(value, &end, 0);
503 if (errno == ERANGE)
504 return 0;
505 if (!parse_unit_factor(end, &factor)) {
506 errno = EINVAL;
507 return 0;
509 uval = abs(val);
510 uval *= factor;
511 if (uval > max || abs(val) > uval) {
512 errno = ERANGE;
513 return 0;
515 val *= factor;
516 *ret = val;
517 return 1;
519 errno = EINVAL;
520 return 0;
523 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
525 if (value && *value) {
526 char *end;
527 uintmax_t val;
528 uintmax_t oldval;
530 errno = 0;
531 val = strtoumax(value, &end, 0);
532 if (errno == ERANGE)
533 return 0;
534 oldval = val;
535 if (!parse_unit_factor(end, &val)) {
536 errno = EINVAL;
537 return 0;
539 if (val > max || oldval > val) {
540 errno = ERANGE;
541 return 0;
543 *ret = val;
544 return 1;
546 errno = EINVAL;
547 return 0;
550 static int git_parse_int(const char *value, int *ret)
552 intmax_t tmp;
553 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
554 return 0;
555 *ret = tmp;
556 return 1;
559 static int git_parse_int64(const char *value, int64_t *ret)
561 intmax_t tmp;
562 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
563 return 0;
564 *ret = tmp;
565 return 1;
568 int git_parse_ulong(const char *value, unsigned long *ret)
570 uintmax_t tmp;
571 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
572 return 0;
573 *ret = tmp;
574 return 1;
577 NORETURN
578 static void die_bad_number(const char *name, const char *value)
580 const char *reason = errno == ERANGE ?
581 "out of range" :
582 "invalid unit";
583 if (!value)
584 value = "";
586 if (cf && cf->name)
587 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
588 value, name, cf->name, reason);
589 die(_("bad numeric config value '%s' for '%s': %s"), value, name, reason);
592 int git_config_int(const char *name, const char *value)
594 int ret;
595 if (!git_parse_int(value, &ret))
596 die_bad_number(name, value);
597 return ret;
600 int64_t git_config_int64(const char *name, const char *value)
602 int64_t ret;
603 if (!git_parse_int64(value, &ret))
604 die_bad_number(name, value);
605 return ret;
608 unsigned long git_config_ulong(const char *name, const char *value)
610 unsigned long ret;
611 if (!git_parse_ulong(value, &ret))
612 die_bad_number(name, value);
613 return ret;
616 static int git_config_maybe_bool_text(const char *name, const char *value)
618 if (!value)
619 return 1;
620 if (!*value)
621 return 0;
622 if (!strcasecmp(value, "true")
623 || !strcasecmp(value, "yes")
624 || !strcasecmp(value, "on"))
625 return 1;
626 if (!strcasecmp(value, "false")
627 || !strcasecmp(value, "no")
628 || !strcasecmp(value, "off"))
629 return 0;
630 return -1;
633 int git_config_maybe_bool(const char *name, const char *value)
635 int v = git_config_maybe_bool_text(name, value);
636 if (0 <= v)
637 return v;
638 if (git_parse_int(value, &v))
639 return !!v;
640 return -1;
643 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
645 int v = git_config_maybe_bool_text(name, value);
646 if (0 <= v) {
647 *is_bool = 1;
648 return v;
650 *is_bool = 0;
651 return git_config_int(name, value);
654 int git_config_bool(const char *name, const char *value)
656 int discard;
657 return !!git_config_bool_or_int(name, value, &discard);
660 int git_config_string(const char **dest, const char *var, const char *value)
662 if (!value)
663 return config_error_nonbool(var);
664 *dest = xstrdup(value);
665 return 0;
668 int git_config_pathname(const char **dest, const char *var, const char *value)
670 if (!value)
671 return config_error_nonbool(var);
672 *dest = expand_user_path(value);
673 if (!*dest)
674 die(_("failed to expand user dir in: '%s'"), value);
675 return 0;
678 static int git_default_core_config(const char *var, const char *value)
680 /* This needs a better name */
681 if (!strcmp(var, "core.filemode")) {
682 trust_executable_bit = git_config_bool(var, value);
683 return 0;
685 if (!strcmp(var, "core.trustctime")) {
686 trust_ctime = git_config_bool(var, value);
687 return 0;
689 if (!strcmp(var, "core.checkstat")) {
690 if (!strcasecmp(value, "default"))
691 check_stat = 1;
692 else if (!strcasecmp(value, "minimal"))
693 check_stat = 0;
696 if (!strcmp(var, "core.quotepath")) {
697 quote_path_fully = git_config_bool(var, value);
698 return 0;
701 if (!strcmp(var, "core.symlinks")) {
702 has_symlinks = git_config_bool(var, value);
703 return 0;
706 if (!strcmp(var, "core.ignorecase")) {
707 ignore_case = git_config_bool(var, value);
708 return 0;
711 if (!strcmp(var, "core.attributesfile"))
712 return git_config_pathname(&git_attributes_file, var, value);
714 if (!strcmp(var, "core.bare")) {
715 is_bare_repository_cfg = git_config_bool(var, value);
716 return 0;
719 if (!strcmp(var, "core.ignorestat")) {
720 assume_unchanged = git_config_bool(var, value);
721 return 0;
724 if (!strcmp(var, "core.prefersymlinkrefs")) {
725 prefer_symlink_refs = git_config_bool(var, value);
726 return 0;
729 if (!strcmp(var, "core.logallrefupdates")) {
730 log_all_ref_updates = git_config_bool(var, value);
731 return 0;
734 if (!strcmp(var, "core.warnambiguousrefs")) {
735 warn_ambiguous_refs = git_config_bool(var, value);
736 return 0;
739 if (!strcmp(var, "core.abbrev")) {
740 int abbrev = git_config_int(var, value);
741 if (abbrev < minimum_abbrev || abbrev > 40)
742 return -1;
743 default_abbrev = abbrev;
744 return 0;
747 if (!strcmp(var, "core.loosecompression")) {
748 int level = git_config_int(var, value);
749 if (level == -1)
750 level = Z_DEFAULT_COMPRESSION;
751 else if (level < 0 || level > Z_BEST_COMPRESSION)
752 die(_("bad zlib compression level %d"), level);
753 zlib_compression_level = level;
754 zlib_compression_seen = 1;
755 return 0;
758 if (!strcmp(var, "core.compression")) {
759 int level = git_config_int(var, value);
760 if (level == -1)
761 level = Z_DEFAULT_COMPRESSION;
762 else if (level < 0 || level > Z_BEST_COMPRESSION)
763 die(_("bad zlib compression level %d"), level);
764 core_compression_level = level;
765 core_compression_seen = 1;
766 if (!zlib_compression_seen)
767 zlib_compression_level = level;
768 return 0;
771 if (!strcmp(var, "core.packedgitwindowsize")) {
772 int pgsz_x2 = getpagesize() * 2;
773 packed_git_window_size = git_config_ulong(var, value);
775 /* This value must be multiple of (pagesize * 2) */
776 packed_git_window_size /= pgsz_x2;
777 if (packed_git_window_size < 1)
778 packed_git_window_size = 1;
779 packed_git_window_size *= pgsz_x2;
780 return 0;
783 if (!strcmp(var, "core.bigfilethreshold")) {
784 big_file_threshold = git_config_ulong(var, value);
785 return 0;
788 if (!strcmp(var, "core.packedgitlimit")) {
789 packed_git_limit = git_config_ulong(var, value);
790 return 0;
793 if (!strcmp(var, "core.deltabasecachelimit")) {
794 delta_base_cache_limit = git_config_ulong(var, value);
795 return 0;
798 if (!strcmp(var, "core.autocrlf")) {
799 if (value && !strcasecmp(value, "input")) {
800 if (core_eol == EOL_CRLF)
801 return error("core.autocrlf=input conflicts with core.eol=crlf");
802 auto_crlf = AUTO_CRLF_INPUT;
803 return 0;
805 auto_crlf = git_config_bool(var, value);
806 return 0;
809 if (!strcmp(var, "core.safecrlf")) {
810 if (value && !strcasecmp(value, "warn")) {
811 safe_crlf = SAFE_CRLF_WARN;
812 return 0;
814 safe_crlf = git_config_bool(var, value);
815 return 0;
818 if (!strcmp(var, "core.eol")) {
819 if (value && !strcasecmp(value, "lf"))
820 core_eol = EOL_LF;
821 else if (value && !strcasecmp(value, "crlf"))
822 core_eol = EOL_CRLF;
823 else if (value && !strcasecmp(value, "native"))
824 core_eol = EOL_NATIVE;
825 else
826 core_eol = EOL_UNSET;
827 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
828 return error("core.autocrlf=input conflicts with core.eol=crlf");
829 return 0;
832 if (!strcmp(var, "core.notesref")) {
833 notes_ref_name = xstrdup(value);
834 return 0;
837 if (!strcmp(var, "core.pager"))
838 return git_config_string(&pager_program, var, value);
840 if (!strcmp(var, "core.editor"))
841 return git_config_string(&editor_program, var, value);
843 if (!strcmp(var, "core.commentchar")) {
844 if (!value)
845 return config_error_nonbool(var);
846 else if (!strcasecmp(value, "auto"))
847 auto_comment_line_char = 1;
848 else if (value[0] && !value[1]) {
849 comment_line_char = value[0];
850 auto_comment_line_char = 0;
851 } else
852 return error("core.commentChar should only be one character");
853 return 0;
856 if (!strcmp(var, "core.askpass"))
857 return git_config_string(&askpass_program, var, value);
859 if (!strcmp(var, "core.excludesfile"))
860 return git_config_pathname(&excludes_file, var, value);
862 if (!strcmp(var, "core.whitespace")) {
863 if (!value)
864 return config_error_nonbool(var);
865 whitespace_rule_cfg = parse_whitespace_rule(value);
866 return 0;
869 if (!strcmp(var, "core.fsyncobjectfiles")) {
870 fsync_object_files = git_config_bool(var, value);
871 return 0;
874 if (!strcmp(var, "core.preloadindex")) {
875 core_preload_index = git_config_bool(var, value);
876 return 0;
879 if (!strcmp(var, "core.createobject")) {
880 if (!strcmp(value, "rename"))
881 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
882 else if (!strcmp(value, "link"))
883 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
884 else
885 die(_("invalid mode for object creation: %s"), value);
886 return 0;
889 if (!strcmp(var, "core.sparsecheckout")) {
890 core_apply_sparse_checkout = git_config_bool(var, value);
891 return 0;
894 if (!strcmp(var, "core.precomposeunicode")) {
895 precomposed_unicode = git_config_bool(var, value);
896 return 0;
899 /* Add other config variables here and to Documentation/config.txt. */
900 return 0;
903 static int git_default_i18n_config(const char *var, const char *value)
905 if (!strcmp(var, "i18n.commitencoding"))
906 return git_config_string(&git_commit_encoding, var, value);
908 if (!strcmp(var, "i18n.logoutputencoding"))
909 return git_config_string(&git_log_output_encoding, var, value);
911 /* Add other config variables here and to Documentation/config.txt. */
912 return 0;
915 static int git_default_branch_config(const char *var, const char *value)
917 if (!strcmp(var, "branch.autosetupmerge")) {
918 if (value && !strcasecmp(value, "always")) {
919 git_branch_track = BRANCH_TRACK_ALWAYS;
920 return 0;
922 git_branch_track = git_config_bool(var, value);
923 return 0;
925 if (!strcmp(var, "branch.autosetuprebase")) {
926 if (!value)
927 return config_error_nonbool(var);
928 else if (!strcmp(value, "never"))
929 autorebase = AUTOREBASE_NEVER;
930 else if (!strcmp(value, "local"))
931 autorebase = AUTOREBASE_LOCAL;
932 else if (!strcmp(value, "remote"))
933 autorebase = AUTOREBASE_REMOTE;
934 else if (!strcmp(value, "always"))
935 autorebase = AUTOREBASE_ALWAYS;
936 else
937 return error("Malformed value for %s", var);
938 return 0;
941 /* Add other config variables here and to Documentation/config.txt. */
942 return 0;
945 static int git_default_push_config(const char *var, const char *value)
947 if (!strcmp(var, "push.default")) {
948 if (!value)
949 return config_error_nonbool(var);
950 else if (!strcmp(value, "nothing"))
951 push_default = PUSH_DEFAULT_NOTHING;
952 else if (!strcmp(value, "matching"))
953 push_default = PUSH_DEFAULT_MATCHING;
954 else if (!strcmp(value, "simple"))
955 push_default = PUSH_DEFAULT_SIMPLE;
956 else if (!strcmp(value, "upstream"))
957 push_default = PUSH_DEFAULT_UPSTREAM;
958 else if (!strcmp(value, "tracking")) /* deprecated */
959 push_default = PUSH_DEFAULT_UPSTREAM;
960 else if (!strcmp(value, "current"))
961 push_default = PUSH_DEFAULT_CURRENT;
962 else {
963 error("Malformed value for %s: %s", var, value);
964 return error("Must be one of nothing, matching, simple, "
965 "upstream or current.");
967 return 0;
970 /* Add other config variables here and to Documentation/config.txt. */
971 return 0;
974 static int git_default_mailmap_config(const char *var, const char *value)
976 if (!strcmp(var, "mailmap.file"))
977 return git_config_pathname(&git_mailmap_file, var, value);
978 if (!strcmp(var, "mailmap.blob"))
979 return git_config_string(&git_mailmap_blob, var, value);
981 /* Add other config variables here and to Documentation/config.txt. */
982 return 0;
985 int git_default_config(const char *var, const char *value, void *dummy)
987 if (starts_with(var, "core."))
988 return git_default_core_config(var, value);
990 if (starts_with(var, "user."))
991 return git_ident_config(var, value, dummy);
993 if (starts_with(var, "i18n."))
994 return git_default_i18n_config(var, value);
996 if (starts_with(var, "branch."))
997 return git_default_branch_config(var, value);
999 if (starts_with(var, "push."))
1000 return git_default_push_config(var, value);
1002 if (starts_with(var, "mailmap."))
1003 return git_default_mailmap_config(var, value);
1005 if (starts_with(var, "advice."))
1006 return git_default_advice_config(var, value);
1008 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1009 pager_use_color = git_config_bool(var,value);
1010 return 0;
1013 if (!strcmp(var, "pack.packsizelimit")) {
1014 pack_size_limit_cfg = git_config_ulong(var, value);
1015 return 0;
1017 /* Add other config variables here and to Documentation/config.txt. */
1018 return 0;
1022 * All source specific fields in the union, die_on_error, name and the callbacks
1023 * fgetc, ungetc, ftell of top need to be initialized before calling
1024 * this function.
1026 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1028 int ret;
1030 /* push config-file parsing state stack */
1031 top->prev = cf;
1032 top->linenr = 1;
1033 top->eof = 0;
1034 strbuf_init(&top->value, 1024);
1035 strbuf_init(&top->var, 1024);
1036 cf = top;
1038 ret = git_parse_source(fn, data);
1040 /* pop config-file parsing state stack */
1041 strbuf_release(&top->value);
1042 strbuf_release(&top->var);
1043 cf = top->prev;
1045 return ret;
1048 static int do_config_from_file(config_fn_t fn,
1049 const char *name, const char *path, FILE *f, void *data)
1051 struct config_source top;
1053 top.u.file = f;
1054 top.name = name;
1055 top.path = path;
1056 top.die_on_error = 1;
1057 top.do_fgetc = config_file_fgetc;
1058 top.do_ungetc = config_file_ungetc;
1059 top.do_ftell = config_file_ftell;
1061 return do_config_from(&top, fn, data);
1064 static int git_config_from_stdin(config_fn_t fn, void *data)
1066 return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
1069 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1071 int ret = -1;
1072 FILE *f;
1074 f = fopen(filename, "r");
1075 if (f) {
1076 ret = do_config_from_file(fn, filename, filename, f, data);
1077 fclose(f);
1079 return ret;
1082 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1083 size_t len, void *data)
1085 struct config_source top;
1087 top.u.buf.buf = buf;
1088 top.u.buf.len = len;
1089 top.u.buf.pos = 0;
1090 top.name = name;
1091 top.path = NULL;
1092 top.die_on_error = 0;
1093 top.do_fgetc = config_buf_fgetc;
1094 top.do_ungetc = config_buf_ungetc;
1095 top.do_ftell = config_buf_ftell;
1097 return do_config_from(&top, fn, data);
1100 static int git_config_from_blob_sha1(config_fn_t fn,
1101 const char *name,
1102 const unsigned char *sha1,
1103 void *data)
1105 enum object_type type;
1106 char *buf;
1107 unsigned long size;
1108 int ret;
1110 buf = read_sha1_file(sha1, &type, &size);
1111 if (!buf)
1112 return error("unable to load config blob object '%s'", name);
1113 if (type != OBJ_BLOB) {
1114 free(buf);
1115 return error("reference '%s' does not point to a blob", name);
1118 ret = git_config_from_buf(fn, name, buf, size, data);
1119 free(buf);
1121 return ret;
1124 static int git_config_from_blob_ref(config_fn_t fn,
1125 const char *name,
1126 void *data)
1128 unsigned char sha1[20];
1130 if (get_sha1(name, sha1) < 0)
1131 return error("unable to resolve config blob '%s'", name);
1132 return git_config_from_blob_sha1(fn, name, sha1, data);
1135 const char *git_etc_gitconfig(void)
1137 static const char *system_wide;
1138 if (!system_wide)
1139 system_wide = system_path(ETC_GITCONFIG);
1140 return system_wide;
1144 * Parse environment variable 'k' as a boolean (in various
1145 * possible spellings); if missing, use the default value 'def'.
1147 int git_env_bool(const char *k, int def)
1149 const char *v = getenv(k);
1150 return v ? git_config_bool(k, v) : def;
1154 * Parse environment variable 'k' as ulong with possibly a unit
1155 * suffix; if missing, use the default value 'val'.
1157 unsigned long git_env_ulong(const char *k, unsigned long val)
1159 const char *v = getenv(k);
1160 if (v && !git_parse_ulong(v, &val))
1161 die("failed to parse %s", k);
1162 return val;
1165 int git_config_system(void)
1167 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1170 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1172 int ret = 0, found = 0;
1173 char *xdg_config = NULL;
1174 char *user_config = NULL;
1176 home_config_paths(&user_config, &xdg_config, "config");
1178 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1179 ret += git_config_from_file(fn, git_etc_gitconfig(),
1180 data);
1181 found += 1;
1184 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1185 ret += git_config_from_file(fn, xdg_config, data);
1186 found += 1;
1189 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1190 ret += git_config_from_file(fn, user_config, data);
1191 found += 1;
1194 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1195 ret += git_config_from_file(fn, repo_config, data);
1196 found += 1;
1199 switch (git_config_from_parameters(fn, data)) {
1200 case -1: /* error */
1201 die(_("unable to parse command-line config"));
1202 break;
1203 case 0: /* found nothing */
1204 break;
1205 default: /* found at least one item */
1206 found++;
1207 break;
1210 free(xdg_config);
1211 free(user_config);
1212 return ret == 0 ? found : ret;
1215 int git_config_with_options(config_fn_t fn, void *data,
1216 struct git_config_source *config_source,
1217 int respect_includes)
1219 char *repo_config = NULL;
1220 int ret;
1221 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1223 if (respect_includes) {
1224 inc.fn = fn;
1225 inc.data = data;
1226 fn = git_config_include;
1227 data = &inc;
1231 * If we have a specific filename, use it. Otherwise, follow the
1232 * regular lookup sequence.
1234 if (config_source && config_source->use_stdin)
1235 return git_config_from_stdin(fn, data);
1236 else if (config_source && config_source->file)
1237 return git_config_from_file(fn, config_source->file, data);
1238 else if (config_source && config_source->blob)
1239 return git_config_from_blob_ref(fn, config_source->blob, data);
1241 repo_config = git_pathdup("config");
1242 ret = git_config_early(fn, data, repo_config);
1243 if (repo_config)
1244 free(repo_config);
1245 return ret;
1248 static void git_config_raw(config_fn_t fn, void *data)
1250 if (git_config_with_options(fn, data, NULL, 1) < 0)
1252 * git_config_with_options() normally returns only
1253 * positive values, as most errors are fatal, and
1254 * non-fatal potential errors are guarded by "if"
1255 * statements that are entered only when no error is
1256 * possible.
1258 * If we ever encounter a non-fatal error, it means
1259 * something went really wrong and we should stop
1260 * immediately.
1262 die(_("unknown error occured while reading the configuration files"));
1265 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1267 int i, value_index;
1268 struct string_list *values;
1269 struct config_set_element *entry;
1270 struct configset_list *list = &cs->list;
1271 struct key_value_info *kv_info;
1273 for (i = 0; i < list->nr; i++) {
1274 entry = list->items[i].e;
1275 value_index = list->items[i].value_index;
1276 values = &entry->value_list;
1277 if (fn(entry->key, values->items[value_index].string, data) < 0) {
1278 kv_info = values->items[value_index].util;
1279 git_die_config_linenr(entry->key, kv_info->filename, kv_info->linenr);
1284 static void git_config_check_init(void);
1286 void git_config(config_fn_t fn, void *data)
1288 git_config_check_init();
1289 configset_iter(&the_config_set, fn, data);
1292 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1294 struct config_set_element k;
1295 struct config_set_element *found_entry;
1296 char *normalized_key;
1297 int ret;
1299 * `key` may come from the user, so normalize it before using it
1300 * for querying entries from the hashmap.
1302 ret = git_config_parse_key(key, &normalized_key, NULL);
1304 if (ret)
1305 return NULL;
1307 hashmap_entry_init(&k, strhash(normalized_key));
1308 k.key = normalized_key;
1309 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1310 free(normalized_key);
1311 return found_entry;
1314 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1316 struct config_set_element *e;
1317 struct string_list_item *si;
1318 struct configset_list_item *l_item;
1319 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1321 e = configset_find_element(cs, key);
1323 * Since the keys are being fed by git_config*() callback mechanism, they
1324 * are already normalized. So simply add them without any further munging.
1326 if (!e) {
1327 e = xmalloc(sizeof(*e));
1328 hashmap_entry_init(e, strhash(key));
1329 e->key = xstrdup(key);
1330 string_list_init(&e->value_list, 1);
1331 hashmap_add(&cs->config_hash, e);
1333 si = string_list_append_nodup(&e->value_list, value ? xstrdup(value) : NULL);
1335 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1336 l_item = &cs->list.items[cs->list.nr++];
1337 l_item->e = e;
1338 l_item->value_index = e->value_list.nr - 1;
1340 if (cf) {
1341 kv_info->filename = strintern(cf->name);
1342 kv_info->linenr = cf->linenr;
1343 } else {
1344 /* for values read from `git_config_from_parameters()` */
1345 kv_info->filename = NULL;
1346 kv_info->linenr = -1;
1348 si->util = kv_info;
1350 return 0;
1353 static int config_set_element_cmp(const struct config_set_element *e1,
1354 const struct config_set_element *e2, const void *unused)
1356 return strcmp(e1->key, e2->key);
1359 void git_configset_init(struct config_set *cs)
1361 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1362 cs->hash_initialized = 1;
1363 cs->list.nr = 0;
1364 cs->list.alloc = 0;
1365 cs->list.items = NULL;
1368 void git_configset_clear(struct config_set *cs)
1370 struct config_set_element *entry;
1371 struct hashmap_iter iter;
1372 if (!cs->hash_initialized)
1373 return;
1375 hashmap_iter_init(&cs->config_hash, &iter);
1376 while ((entry = hashmap_iter_next(&iter))) {
1377 free(entry->key);
1378 string_list_clear(&entry->value_list, 1);
1380 hashmap_free(&cs->config_hash, 1);
1381 cs->hash_initialized = 0;
1382 free(cs->list.items);
1383 cs->list.nr = 0;
1384 cs->list.alloc = 0;
1385 cs->list.items = NULL;
1388 static int config_set_callback(const char *key, const char *value, void *cb)
1390 struct config_set *cs = cb;
1391 configset_add_value(cs, key, value);
1392 return 0;
1395 int git_configset_add_file(struct config_set *cs, const char *filename)
1397 return git_config_from_file(config_set_callback, filename, cs);
1400 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1402 const struct string_list *values = NULL;
1404 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1405 * queried key in the files of the configset, the value returned will be the last
1406 * value in the value list for that key.
1408 values = git_configset_get_value_multi(cs, key);
1410 if (!values)
1411 return 1;
1412 assert(values->nr > 0);
1413 *value = values->items[values->nr - 1].string;
1414 return 0;
1417 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1419 struct config_set_element *e = configset_find_element(cs, key);
1420 return e ? &e->value_list : NULL;
1423 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1425 const char *value;
1426 if (!git_configset_get_value(cs, key, &value))
1427 return git_config_string(dest, key, value);
1428 else
1429 return 1;
1432 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1434 return git_configset_get_string_const(cs, key, (const char **)dest);
1437 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1439 const char *value;
1440 if (!git_configset_get_value(cs, key, &value)) {
1441 *dest = git_config_int(key, value);
1442 return 0;
1443 } else
1444 return 1;
1447 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1449 const char *value;
1450 if (!git_configset_get_value(cs, key, &value)) {
1451 *dest = git_config_ulong(key, value);
1452 return 0;
1453 } else
1454 return 1;
1457 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1459 const char *value;
1460 if (!git_configset_get_value(cs, key, &value)) {
1461 *dest = git_config_bool(key, value);
1462 return 0;
1463 } else
1464 return 1;
1467 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1468 int *is_bool, int *dest)
1470 const char *value;
1471 if (!git_configset_get_value(cs, key, &value)) {
1472 *dest = git_config_bool_or_int(key, value, is_bool);
1473 return 0;
1474 } else
1475 return 1;
1478 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1480 const char *value;
1481 if (!git_configset_get_value(cs, key, &value)) {
1482 *dest = git_config_maybe_bool(key, value);
1483 if (*dest == -1)
1484 return -1;
1485 return 0;
1486 } else
1487 return 1;
1490 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1492 const char *value;
1493 if (!git_configset_get_value(cs, key, &value))
1494 return git_config_pathname(dest, key, value);
1495 else
1496 return 1;
1499 static void git_config_check_init(void)
1501 if (the_config_set.hash_initialized)
1502 return;
1503 git_configset_init(&the_config_set);
1504 git_config_raw(config_set_callback, &the_config_set);
1507 void git_config_clear(void)
1509 if (!the_config_set.hash_initialized)
1510 return;
1511 git_configset_clear(&the_config_set);
1514 int git_config_get_value(const char *key, const char **value)
1516 git_config_check_init();
1517 return git_configset_get_value(&the_config_set, key, value);
1520 const struct string_list *git_config_get_value_multi(const char *key)
1522 git_config_check_init();
1523 return git_configset_get_value_multi(&the_config_set, key);
1526 int git_config_get_string_const(const char *key, const char **dest)
1528 int ret;
1529 git_config_check_init();
1530 ret = git_configset_get_string_const(&the_config_set, key, dest);
1531 if (ret < 0)
1532 git_die_config(key, NULL);
1533 return ret;
1536 int git_config_get_string(const char *key, char **dest)
1538 git_config_check_init();
1539 return git_config_get_string_const(key, (const char **)dest);
1542 int git_config_get_int(const char *key, int *dest)
1544 git_config_check_init();
1545 return git_configset_get_int(&the_config_set, key, dest);
1548 int git_config_get_ulong(const char *key, unsigned long *dest)
1550 git_config_check_init();
1551 return git_configset_get_ulong(&the_config_set, key, dest);
1554 int git_config_get_bool(const char *key, int *dest)
1556 git_config_check_init();
1557 return git_configset_get_bool(&the_config_set, key, dest);
1560 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1562 git_config_check_init();
1563 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1566 int git_config_get_maybe_bool(const char *key, int *dest)
1568 git_config_check_init();
1569 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1572 int git_config_get_pathname(const char *key, const char **dest)
1574 int ret;
1575 git_config_check_init();
1576 ret = git_configset_get_pathname(&the_config_set, key, dest);
1577 if (ret < 0)
1578 git_die_config(key, NULL);
1579 return ret;
1582 NORETURN
1583 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1585 if (!filename)
1586 die(_("unable to parse '%s' from command-line config"), key);
1587 else
1588 die(_("bad config variable '%s' in file '%s' at line %d"),
1589 key, filename, linenr);
1592 NORETURN __attribute__((format(printf, 2, 3)))
1593 void git_die_config(const char *key, const char *err, ...)
1595 const struct string_list *values;
1596 struct key_value_info *kv_info;
1598 if (err) {
1599 va_list params;
1600 va_start(params, err);
1601 vreportf("error: ", err, params);
1602 va_end(params);
1604 values = git_config_get_value_multi(key);
1605 kv_info = values->items[values->nr - 1].util;
1606 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
1610 * Find all the stuff for git_config_set() below.
1613 static struct {
1614 int baselen;
1615 char *key;
1616 int do_not_match;
1617 regex_t *value_regex;
1618 int multi_replace;
1619 size_t *offset;
1620 unsigned int offset_alloc;
1621 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1622 int seen;
1623 } store;
1625 static int matches(const char *key, const char *value)
1627 if (strcmp(key, store.key))
1628 return 0; /* not ours */
1629 if (!store.value_regex)
1630 return 1; /* always matches */
1631 if (store.value_regex == CONFIG_REGEX_NONE)
1632 return 0; /* never matches */
1634 return store.do_not_match ^
1635 (value && !regexec(store.value_regex, value, 0, NULL, 0));
1638 static int store_aux(const char *key, const char *value, void *cb)
1640 const char *ep;
1641 size_t section_len;
1643 switch (store.state) {
1644 case KEY_SEEN:
1645 if (matches(key, value)) {
1646 if (store.seen == 1 && store.multi_replace == 0) {
1647 warning(_("%s has multiple values"), key);
1650 ALLOC_GROW(store.offset, store.seen + 1,
1651 store.offset_alloc);
1653 store.offset[store.seen] = cf->do_ftell(cf);
1654 store.seen++;
1656 break;
1657 case SECTION_SEEN:
1659 * What we are looking for is in store.key (both
1660 * section and var), and its section part is baselen
1661 * long. We found key (again, both section and var).
1662 * We would want to know if this key is in the same
1663 * section as what we are looking for. We already
1664 * know we are in the same section as what should
1665 * hold store.key.
1667 ep = strrchr(key, '.');
1668 section_len = ep - key;
1670 if ((section_len != store.baselen) ||
1671 memcmp(key, store.key, section_len+1)) {
1672 store.state = SECTION_END_SEEN;
1673 break;
1677 * Do not increment matches: this is no match, but we
1678 * just made sure we are in the desired section.
1680 ALLOC_GROW(store.offset, store.seen + 1,
1681 store.offset_alloc);
1682 store.offset[store.seen] = cf->do_ftell(cf);
1683 /* fallthru */
1684 case SECTION_END_SEEN:
1685 case START:
1686 if (matches(key, value)) {
1687 ALLOC_GROW(store.offset, store.seen + 1,
1688 store.offset_alloc);
1689 store.offset[store.seen] = cf->do_ftell(cf);
1690 store.state = KEY_SEEN;
1691 store.seen++;
1692 } else {
1693 if (strrchr(key, '.') - key == store.baselen &&
1694 !strncmp(key, store.key, store.baselen)) {
1695 store.state = SECTION_SEEN;
1696 ALLOC_GROW(store.offset,
1697 store.seen + 1,
1698 store.offset_alloc);
1699 store.offset[store.seen] = cf->do_ftell(cf);
1703 return 0;
1706 static int write_error(const char *filename)
1708 error("failed to write new configuration file %s", filename);
1710 /* Same error code as "failed to rename". */
1711 return 4;
1714 static int store_write_section(int fd, const char *key)
1716 const char *dot;
1717 int i, success;
1718 struct strbuf sb = STRBUF_INIT;
1720 dot = memchr(key, '.', store.baselen);
1721 if (dot) {
1722 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1723 for (i = dot - key + 1; i < store.baselen; i++) {
1724 if (key[i] == '"' || key[i] == '\\')
1725 strbuf_addch(&sb, '\\');
1726 strbuf_addch(&sb, key[i]);
1728 strbuf_addstr(&sb, "\"]\n");
1729 } else {
1730 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1733 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1734 strbuf_release(&sb);
1736 return success;
1739 static int store_write_pair(int fd, const char *key, const char *value)
1741 int i, success;
1742 int length = strlen(key + store.baselen + 1);
1743 const char *quote = "";
1744 struct strbuf sb = STRBUF_INIT;
1747 * Check to see if the value needs to be surrounded with a dq pair.
1748 * Note that problematic characters are always backslash-quoted; this
1749 * check is about not losing leading or trailing SP and strings that
1750 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1751 * configuration parser.
1753 if (value[0] == ' ')
1754 quote = "\"";
1755 for (i = 0; value[i]; i++)
1756 if (value[i] == ';' || value[i] == '#')
1757 quote = "\"";
1758 if (i && value[i - 1] == ' ')
1759 quote = "\"";
1761 strbuf_addf(&sb, "\t%.*s = %s",
1762 length, key + store.baselen + 1, quote);
1764 for (i = 0; value[i]; i++)
1765 switch (value[i]) {
1766 case '\n':
1767 strbuf_addstr(&sb, "\\n");
1768 break;
1769 case '\t':
1770 strbuf_addstr(&sb, "\\t");
1771 break;
1772 case '"':
1773 case '\\':
1774 strbuf_addch(&sb, '\\');
1775 default:
1776 strbuf_addch(&sb, value[i]);
1777 break;
1779 strbuf_addf(&sb, "%s\n", quote);
1781 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1782 strbuf_release(&sb);
1784 return success;
1787 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1788 size_t offset_, int *found_bracket)
1790 size_t equal_offset = size, bracket_offset = size;
1791 ssize_t offset;
1793 contline:
1794 for (offset = offset_-2; offset > 0
1795 && contents[offset] != '\n'; offset--)
1796 switch (contents[offset]) {
1797 case '=': equal_offset = offset; break;
1798 case ']': bracket_offset = offset; break;
1800 if (offset > 0 && contents[offset-1] == '\\') {
1801 offset_ = offset;
1802 goto contline;
1804 if (bracket_offset < equal_offset) {
1805 *found_bracket = 1;
1806 offset = bracket_offset+1;
1807 } else
1808 offset++;
1810 return offset;
1813 int git_config_set_in_file(const char *config_filename,
1814 const char *key, const char *value)
1816 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1819 int git_config_set(const char *key, const char *value)
1821 return git_config_set_multivar(key, value, NULL, 0);
1825 * Auxiliary function to sanity-check and split the key into the section
1826 * identifier and variable name.
1828 * Returns 0 on success, -1 when there is an invalid character in the key and
1829 * -2 if there is no section name in the key.
1831 * store_key - pointer to char* which will hold a copy of the key with
1832 * lowercase section and variable name
1833 * baselen - pointer to int which will hold the length of the
1834 * section + subsection part, can be NULL
1836 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1838 int i, dot, baselen;
1839 const char *last_dot = strrchr(key, '.');
1842 * Since "key" actually contains the section name and the real
1843 * key name separated by a dot, we have to know where the dot is.
1846 if (last_dot == NULL || last_dot == key) {
1847 error("key does not contain a section: %s", key);
1848 return -CONFIG_NO_SECTION_OR_NAME;
1851 if (!last_dot[1]) {
1852 error("key does not contain variable name: %s", key);
1853 return -CONFIG_NO_SECTION_OR_NAME;
1856 baselen = last_dot - key;
1857 if (baselen_)
1858 *baselen_ = baselen;
1861 * Validate the key and while at it, lower case it for matching.
1863 *store_key = xmalloc(strlen(key) + 1);
1865 dot = 0;
1866 for (i = 0; key[i]; i++) {
1867 unsigned char c = key[i];
1868 if (c == '.')
1869 dot = 1;
1870 /* Leave the extended basename untouched.. */
1871 if (!dot || i > baselen) {
1872 if (!iskeychar(c) ||
1873 (i == baselen + 1 && !isalpha(c))) {
1874 error("invalid key: %s", key);
1875 goto out_free_ret_1;
1877 c = tolower(c);
1878 } else if (c == '\n') {
1879 error("invalid key (newline): %s", key);
1880 goto out_free_ret_1;
1882 (*store_key)[i] = c;
1884 (*store_key)[i] = 0;
1886 return 0;
1888 out_free_ret_1:
1889 free(*store_key);
1890 *store_key = NULL;
1891 return -CONFIG_INVALID_KEY;
1895 * If value==NULL, unset in (remove from) config,
1896 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1897 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
1898 * (only add a new one)
1899 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1900 * else all matching key/values (regardless how many) are removed,
1901 * before the new pair is written.
1903 * Returns 0 on success.
1905 * This function does this:
1907 * - it locks the config file by creating ".git/config.lock"
1909 * - it then parses the config using store_aux() as validator to find
1910 * the position on the key/value pair to replace. If it is to be unset,
1911 * it must be found exactly once.
1913 * - the config file is mmap()ed and the part before the match (if any) is
1914 * written to the lock file, then the changed part and the rest.
1916 * - the config file is removed and the lock file rename()d to it.
1919 int git_config_set_multivar_in_file(const char *config_filename,
1920 const char *key, const char *value,
1921 const char *value_regex, int multi_replace)
1923 int fd = -1, in_fd;
1924 int ret;
1925 struct lock_file *lock = NULL;
1926 char *filename_buf = NULL;
1928 /* parse-key returns negative; flip the sign to feed exit(3) */
1929 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1930 if (ret)
1931 goto out_free;
1933 store.multi_replace = multi_replace;
1935 if (!config_filename)
1936 config_filename = filename_buf = git_pathdup("config");
1939 * The lock serves a purpose in addition to locking: the new
1940 * contents of .git/config will be written into it.
1942 lock = xcalloc(1, sizeof(struct lock_file));
1943 fd = hold_lock_file_for_update(lock, config_filename, 0);
1944 if (fd < 0) {
1945 error("could not lock config file %s: %s", config_filename, strerror(errno));
1946 free(store.key);
1947 ret = CONFIG_NO_LOCK;
1948 goto out_free;
1952 * If .git/config does not exist yet, write a minimal version.
1954 in_fd = open(config_filename, O_RDONLY);
1955 if ( in_fd < 0 ) {
1956 free(store.key);
1958 if ( ENOENT != errno ) {
1959 error("opening %s: %s", config_filename,
1960 strerror(errno));
1961 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1962 goto out_free;
1964 /* if nothing to unset, error out */
1965 if (value == NULL) {
1966 ret = CONFIG_NOTHING_SET;
1967 goto out_free;
1970 store.key = (char *)key;
1971 if (!store_write_section(fd, key) ||
1972 !store_write_pair(fd, key, value))
1973 goto write_err_out;
1974 } else {
1975 struct stat st;
1976 char *contents;
1977 size_t contents_sz, copy_begin, copy_end;
1978 int i, new_line = 0;
1980 if (value_regex == NULL)
1981 store.value_regex = NULL;
1982 else if (value_regex == CONFIG_REGEX_NONE)
1983 store.value_regex = CONFIG_REGEX_NONE;
1984 else {
1985 if (value_regex[0] == '!') {
1986 store.do_not_match = 1;
1987 value_regex++;
1988 } else
1989 store.do_not_match = 0;
1991 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1992 if (regcomp(store.value_regex, value_regex,
1993 REG_EXTENDED)) {
1994 error("invalid pattern: %s", value_regex);
1995 free(store.value_regex);
1996 ret = CONFIG_INVALID_PATTERN;
1997 goto out_free;
2001 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2002 store.offset[0] = 0;
2003 store.state = START;
2004 store.seen = 0;
2007 * After this, store.offset will contain the *end* offset
2008 * of the last match, or remain at 0 if no match was found.
2009 * As a side effect, we make sure to transform only a valid
2010 * existing config file.
2012 if (git_config_from_file(store_aux, config_filename, NULL)) {
2013 error("invalid config file %s", config_filename);
2014 free(store.key);
2015 if (store.value_regex != NULL &&
2016 store.value_regex != CONFIG_REGEX_NONE) {
2017 regfree(store.value_regex);
2018 free(store.value_regex);
2020 ret = CONFIG_INVALID_FILE;
2021 goto out_free;
2024 free(store.key);
2025 if (store.value_regex != NULL &&
2026 store.value_regex != CONFIG_REGEX_NONE) {
2027 regfree(store.value_regex);
2028 free(store.value_regex);
2031 /* if nothing to unset, or too many matches, error out */
2032 if ((store.seen == 0 && value == NULL) ||
2033 (store.seen > 1 && multi_replace == 0)) {
2034 ret = CONFIG_NOTHING_SET;
2035 goto out_free;
2038 fstat(in_fd, &st);
2039 contents_sz = xsize_t(st.st_size);
2040 contents = xmmap(NULL, contents_sz, PROT_READ,
2041 MAP_PRIVATE, in_fd, 0);
2042 close(in_fd);
2044 if (chmod(lock->filename.buf, st.st_mode & 07777) < 0) {
2045 error("chmod on %s failed: %s",
2046 lock->filename.buf, strerror(errno));
2047 ret = CONFIG_NO_WRITE;
2048 goto out_free;
2051 if (store.seen == 0)
2052 store.seen = 1;
2054 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2055 if (store.offset[i] == 0) {
2056 store.offset[i] = copy_end = contents_sz;
2057 } else if (store.state != KEY_SEEN) {
2058 copy_end = store.offset[i];
2059 } else
2060 copy_end = find_beginning_of_line(
2061 contents, contents_sz,
2062 store.offset[i]-2, &new_line);
2064 if (copy_end > 0 && contents[copy_end-1] != '\n')
2065 new_line = 1;
2067 /* write the first part of the config */
2068 if (copy_end > copy_begin) {
2069 if (write_in_full(fd, contents + copy_begin,
2070 copy_end - copy_begin) <
2071 copy_end - copy_begin)
2072 goto write_err_out;
2073 if (new_line &&
2074 write_str_in_full(fd, "\n") != 1)
2075 goto write_err_out;
2077 copy_begin = store.offset[i];
2080 /* write the pair (value == NULL means unset) */
2081 if (value != NULL) {
2082 if (store.state == START) {
2083 if (!store_write_section(fd, key))
2084 goto write_err_out;
2086 if (!store_write_pair(fd, key, value))
2087 goto write_err_out;
2090 /* write the rest of the config */
2091 if (copy_begin < contents_sz)
2092 if (write_in_full(fd, contents + copy_begin,
2093 contents_sz - copy_begin) <
2094 contents_sz - copy_begin)
2095 goto write_err_out;
2097 munmap(contents, contents_sz);
2100 if (commit_lock_file(lock) < 0) {
2101 error("could not commit config file %s", config_filename);
2102 ret = CONFIG_NO_WRITE;
2103 lock = NULL;
2104 goto out_free;
2108 * lock is committed, so don't try to roll it back below.
2109 * NOTE: Since lockfile.c keeps a linked list of all created
2110 * lock_file structures, it isn't safe to free(lock). It's
2111 * better to just leave it hanging around.
2113 lock = NULL;
2114 ret = 0;
2116 /* Invalidate the config cache */
2117 git_config_clear();
2119 out_free:
2120 if (lock)
2121 rollback_lock_file(lock);
2122 free(filename_buf);
2123 return ret;
2125 write_err_out:
2126 ret = write_error(lock->filename.buf);
2127 goto out_free;
2131 int git_config_set_multivar(const char *key, const char *value,
2132 const char *value_regex, int multi_replace)
2134 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
2135 multi_replace);
2138 static int section_name_match (const char *buf, const char *name)
2140 int i = 0, j = 0, dot = 0;
2141 if (buf[i] != '[')
2142 return 0;
2143 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2144 if (!dot && isspace(buf[i])) {
2145 dot = 1;
2146 if (name[j++] != '.')
2147 break;
2148 for (i++; isspace(buf[i]); i++)
2149 ; /* do nothing */
2150 if (buf[i] != '"')
2151 break;
2152 continue;
2154 if (buf[i] == '\\' && dot)
2155 i++;
2156 else if (buf[i] == '"' && dot) {
2157 for (i++; isspace(buf[i]); i++)
2158 ; /* do_nothing */
2159 break;
2161 if (buf[i] != name[j++])
2162 break;
2164 if (buf[i] == ']' && name[j] == 0) {
2166 * We match, now just find the right length offset by
2167 * gobbling up any whitespace after it, as well
2169 i++;
2170 for (; buf[i] && isspace(buf[i]); i++)
2171 ; /* do nothing */
2172 return i;
2174 return 0;
2177 static int section_name_is_ok(const char *name)
2179 /* Empty section names are bogus. */
2180 if (!*name)
2181 return 0;
2184 * Before a dot, we must be alphanumeric or dash. After the first dot,
2185 * anything goes, so we can stop checking.
2187 for (; *name && *name != '.'; name++)
2188 if (*name != '-' && !isalnum(*name))
2189 return 0;
2190 return 1;
2193 /* if new_name == NULL, the section is removed instead */
2194 int git_config_rename_section_in_file(const char *config_filename,
2195 const char *old_name, const char *new_name)
2197 int ret = 0, remove = 0;
2198 char *filename_buf = NULL;
2199 struct lock_file *lock;
2200 int out_fd;
2201 char buf[1024];
2202 FILE *config_file;
2203 struct stat st;
2205 if (new_name && !section_name_is_ok(new_name)) {
2206 ret = error("invalid section name: %s", new_name);
2207 goto out;
2210 if (!config_filename)
2211 config_filename = filename_buf = git_pathdup("config");
2213 lock = xcalloc(1, sizeof(struct lock_file));
2214 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2215 if (out_fd < 0) {
2216 ret = error("could not lock config file %s", config_filename);
2217 goto out;
2220 if (!(config_file = fopen(config_filename, "rb"))) {
2221 /* no config file means nothing to rename, no error */
2222 goto unlock_and_out;
2225 fstat(fileno(config_file), &st);
2227 if (chmod(lock->filename.buf, st.st_mode & 07777) < 0) {
2228 ret = error("chmod on %s failed: %s",
2229 lock->filename.buf, strerror(errno));
2230 goto out;
2233 while (fgets(buf, sizeof(buf), config_file)) {
2234 int i;
2235 int length;
2236 char *output = buf;
2237 for (i = 0; buf[i] && isspace(buf[i]); i++)
2238 ; /* do nothing */
2239 if (buf[i] == '[') {
2240 /* it's a section */
2241 int offset = section_name_match(&buf[i], old_name);
2242 if (offset > 0) {
2243 ret++;
2244 if (new_name == NULL) {
2245 remove = 1;
2246 continue;
2248 store.baselen = strlen(new_name);
2249 if (!store_write_section(out_fd, new_name)) {
2250 ret = write_error(lock->filename.buf);
2251 goto out;
2254 * We wrote out the new section, with
2255 * a newline, now skip the old
2256 * section's length
2258 output += offset + i;
2259 if (strlen(output) > 0) {
2261 * More content means there's
2262 * a declaration to put on the
2263 * next line; indent with a
2264 * tab
2266 output -= 1;
2267 output[0] = '\t';
2270 remove = 0;
2272 if (remove)
2273 continue;
2274 length = strlen(output);
2275 if (write_in_full(out_fd, output, length) != length) {
2276 ret = write_error(lock->filename.buf);
2277 goto out;
2280 fclose(config_file);
2281 unlock_and_out:
2282 if (commit_lock_file(lock) < 0)
2283 ret = error("could not commit config file %s", config_filename);
2284 out:
2285 free(filename_buf);
2286 return ret;
2289 int git_config_rename_section(const char *old_name, const char *new_name)
2291 return git_config_rename_section_in_file(NULL, old_name, new_name);
2295 * Call this to report error for your variable that should not
2296 * get a boolean value (i.e. "[my] var" means "true").
2298 #undef config_error_nonbool
2299 int config_error_nonbool(const char *var)
2301 return error("Missing value for '%s'", var);
2304 int parse_config_key(const char *var,
2305 const char *section,
2306 const char **subsection, int *subsection_len,
2307 const char **key)
2309 int section_len = strlen(section);
2310 const char *dot;
2312 /* Does it start with "section." ? */
2313 if (!starts_with(var, section) || var[section_len] != '.')
2314 return -1;
2317 * Find the key; we don't know yet if we have a subsection, but we must
2318 * parse backwards from the end, since the subsection may have dots in
2319 * it, too.
2321 dot = strrchr(var, '.');
2322 *key = dot + 1;
2324 /* Did we have a subsection at all? */
2325 if (dot == var + section_len) {
2326 *subsection = NULL;
2327 *subsection_len = 0;
2329 else {
2330 *subsection = var + section_len + 1;
2331 *subsection_len = dot - *subsection;
2334 return 0;