builtin/apply.c: use xstrdup_or_null instead of null_strdup
[git.git] / config.c
blob039647d247e0ac1e3a523800bbb90c86d89354de
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "exec_cmd.h"
10 #include "strbuf.h"
11 #include "quote.h"
12 #include "hashmap.h"
13 #include "string-list.h"
15 struct config_source {
16 struct config_source *prev;
17 union {
18 FILE *file;
19 struct config_buf {
20 const char *buf;
21 size_t len;
22 size_t pos;
23 } buf;
24 } u;
25 const char *name;
26 const char *path;
27 int die_on_error;
28 int linenr;
29 int eof;
30 struct strbuf value;
31 struct strbuf var;
33 int (*do_fgetc)(struct config_source *c);
34 int (*do_ungetc)(int c, struct config_source *conf);
35 long (*do_ftell)(struct config_source *c);
38 static struct config_source *cf;
40 static int zlib_compression_seen;
43 * Default config_set that contains key-value pairs from the usual set of config
44 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
45 * config file and the global /etc/gitconfig)
47 static struct config_set the_config_set;
49 static int config_file_fgetc(struct config_source *conf)
51 return fgetc(conf->u.file);
54 static int config_file_ungetc(int c, struct config_source *conf)
56 return ungetc(c, conf->u.file);
59 static long config_file_ftell(struct config_source *conf)
61 return ftell(conf->u.file);
65 static int config_buf_fgetc(struct config_source *conf)
67 if (conf->u.buf.pos < conf->u.buf.len)
68 return conf->u.buf.buf[conf->u.buf.pos++];
70 return EOF;
73 static int config_buf_ungetc(int c, struct config_source *conf)
75 if (conf->u.buf.pos > 0)
76 return conf->u.buf.buf[--conf->u.buf.pos];
78 return EOF;
81 static long config_buf_ftell(struct config_source *conf)
83 return conf->u.buf.pos;
86 #define MAX_INCLUDE_DEPTH 10
87 static const char include_depth_advice[] =
88 "exceeded maximum include depth (%d) while including\n"
89 " %s\n"
90 "from\n"
91 " %s\n"
92 "Do you have circular includes?";
93 static int handle_path_include(const char *path, struct config_include_data *inc)
95 int ret = 0;
96 struct strbuf buf = STRBUF_INIT;
97 char *expanded;
99 if (!path)
100 return config_error_nonbool("include.path");
102 expanded = expand_user_path(path);
103 if (!expanded)
104 return error("Could not expand include path '%s'", path);
105 path = expanded;
108 * Use an absolute path as-is, but interpret relative paths
109 * based on the including config file.
111 if (!is_absolute_path(path)) {
112 char *slash;
114 if (!cf || !cf->path)
115 return error("relative config includes must come from files");
117 slash = find_last_dir_sep(cf->path);
118 if (slash)
119 strbuf_add(&buf, cf->path, slash - cf->path + 1);
120 strbuf_addstr(&buf, path);
121 path = buf.buf;
124 if (!access_or_die(path, R_OK, 0)) {
125 if (++inc->depth > MAX_INCLUDE_DEPTH)
126 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
127 cf && cf->name ? cf->name : "the command line");
128 ret = git_config_from_file(git_config_include, path, inc);
129 inc->depth--;
131 strbuf_release(&buf);
132 free(expanded);
133 return ret;
136 int git_config_include(const char *var, const char *value, void *data)
138 struct config_include_data *inc = data;
139 int ret;
142 * Pass along all values, including "include" directives; this makes it
143 * possible to query information on the includes themselves.
145 ret = inc->fn(var, value, inc->data);
146 if (ret < 0)
147 return ret;
149 if (!strcmp(var, "include.path"))
150 ret = handle_path_include(value, inc);
151 return ret;
154 void git_config_push_parameter(const char *text)
156 struct strbuf env = STRBUF_INIT;
157 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
158 if (old) {
159 strbuf_addstr(&env, old);
160 strbuf_addch(&env, ' ');
162 sq_quote_buf(&env, text);
163 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
164 strbuf_release(&env);
167 int git_config_parse_parameter(const char *text,
168 config_fn_t fn, void *data)
170 const char *value;
171 struct strbuf **pair;
173 pair = strbuf_split_str(text, '=', 2);
174 if (!pair[0])
175 return error("bogus config parameter: %s", text);
177 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
178 strbuf_setlen(pair[0], pair[0]->len - 1);
179 value = pair[1] ? pair[1]->buf : "";
180 } else {
181 value = NULL;
184 strbuf_trim(pair[0]);
185 if (!pair[0]->len) {
186 strbuf_list_free(pair);
187 return error("bogus config parameter: %s", text);
189 strbuf_tolower(pair[0]);
190 if (fn(pair[0]->buf, value, data) < 0) {
191 strbuf_list_free(pair);
192 return -1;
194 strbuf_list_free(pair);
195 return 0;
198 int git_config_from_parameters(config_fn_t fn, void *data)
200 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
201 char *envw;
202 const char **argv = NULL;
203 int nr = 0, alloc = 0;
204 int i;
206 if (!env)
207 return 0;
208 /* sq_dequote will write over it */
209 envw = xstrdup(env);
211 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
212 free(envw);
213 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
216 for (i = 0; i < nr; i++) {
217 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
218 free(argv);
219 free(envw);
220 return -1;
224 free(argv);
225 free(envw);
226 return nr > 0;
229 static int get_next_char(void)
231 int c = cf->do_fgetc(cf);
233 if (c == '\r') {
234 /* DOS like systems */
235 c = cf->do_fgetc(cf);
236 if (c != '\n') {
237 cf->do_ungetc(c, cf);
238 c = '\r';
241 if (c == '\n')
242 cf->linenr++;
243 if (c == EOF) {
244 cf->eof = 1;
245 cf->linenr++;
246 c = '\n';
248 return c;
251 static char *parse_value(void)
253 int quote = 0, comment = 0, space = 0;
255 strbuf_reset(&cf->value);
256 for (;;) {
257 int c = get_next_char();
258 if (c == '\n') {
259 if (quote) {
260 cf->linenr--;
261 return NULL;
263 return cf->value.buf;
265 if (comment)
266 continue;
267 if (isspace(c) && !quote) {
268 if (cf->value.len)
269 space++;
270 continue;
272 if (!quote) {
273 if (c == ';' || c == '#') {
274 comment = 1;
275 continue;
278 for (; space; space--)
279 strbuf_addch(&cf->value, ' ');
280 if (c == '\\') {
281 c = get_next_char();
282 switch (c) {
283 case '\n':
284 continue;
285 case 't':
286 c = '\t';
287 break;
288 case 'b':
289 c = '\b';
290 break;
291 case 'n':
292 c = '\n';
293 break;
294 /* Some characters escape as themselves */
295 case '\\': case '"':
296 break;
297 /* Reject unknown escape sequences */
298 default:
299 return NULL;
301 strbuf_addch(&cf->value, c);
302 continue;
304 if (c == '"') {
305 quote = 1-quote;
306 continue;
308 strbuf_addch(&cf->value, c);
312 static inline int iskeychar(int c)
314 return isalnum(c) || c == '-';
317 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
319 int c;
320 char *value;
321 int ret;
323 /* Get the full name */
324 for (;;) {
325 c = get_next_char();
326 if (cf->eof)
327 break;
328 if (!iskeychar(c))
329 break;
330 strbuf_addch(name, tolower(c));
333 while (c == ' ' || c == '\t')
334 c = get_next_char();
336 value = NULL;
337 if (c != '\n') {
338 if (c != '=')
339 return -1;
340 value = parse_value();
341 if (!value)
342 return -1;
345 * We already consumed the \n, but we need linenr to point to
346 * the line we just parsed during the call to fn to get
347 * accurate line number in error messages.
349 cf->linenr--;
350 ret = fn(name->buf, value, data);
351 cf->linenr++;
352 return ret;
355 static int get_extended_base_var(struct strbuf *name, int c)
357 do {
358 if (c == '\n')
359 goto error_incomplete_line;
360 c = get_next_char();
361 } while (isspace(c));
363 /* We require the format to be '[base "extension"]' */
364 if (c != '"')
365 return -1;
366 strbuf_addch(name, '.');
368 for (;;) {
369 int c = get_next_char();
370 if (c == '\n')
371 goto error_incomplete_line;
372 if (c == '"')
373 break;
374 if (c == '\\') {
375 c = get_next_char();
376 if (c == '\n')
377 goto error_incomplete_line;
379 strbuf_addch(name, c);
382 /* Final ']' */
383 if (get_next_char() != ']')
384 return -1;
385 return 0;
386 error_incomplete_line:
387 cf->linenr--;
388 return -1;
391 static int get_base_var(struct strbuf *name)
393 for (;;) {
394 int c = get_next_char();
395 if (cf->eof)
396 return -1;
397 if (c == ']')
398 return 0;
399 if (isspace(c))
400 return get_extended_base_var(name, c);
401 if (!iskeychar(c) && c != '.')
402 return -1;
403 strbuf_addch(name, tolower(c));
407 static int git_parse_source(config_fn_t fn, void *data)
409 int comment = 0;
410 int baselen = 0;
411 struct strbuf *var = &cf->var;
413 /* U+FEFF Byte Order Mark in UTF8 */
414 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
415 const unsigned char *bomptr = utf8_bom;
417 for (;;) {
418 int c = get_next_char();
419 if (bomptr && *bomptr) {
420 /* We are at the file beginning; skip UTF8-encoded BOM
421 * if present. Sane editors won't put this in on their
422 * own, but e.g. Windows Notepad will do it happily. */
423 if ((unsigned char) c == *bomptr) {
424 bomptr++;
425 continue;
426 } else {
427 /* Do not tolerate partial BOM. */
428 if (bomptr != utf8_bom)
429 break;
430 /* No BOM at file beginning. Cool. */
431 bomptr = NULL;
434 if (c == '\n') {
435 if (cf->eof)
436 return 0;
437 comment = 0;
438 continue;
440 if (comment || isspace(c))
441 continue;
442 if (c == '#' || c == ';') {
443 comment = 1;
444 continue;
446 if (c == '[') {
447 /* Reset prior to determining a new stem */
448 strbuf_reset(var);
449 if (get_base_var(var) < 0 || var->len < 1)
450 break;
451 strbuf_addch(var, '.');
452 baselen = var->len;
453 continue;
455 if (!isalpha(c))
456 break;
458 * Truncate the var name back to the section header
459 * stem prior to grabbing the suffix part of the name
460 * and the value.
462 strbuf_setlen(var, baselen);
463 strbuf_addch(var, tolower(c));
464 if (get_value(fn, data, var) < 0)
465 break;
467 if (cf->die_on_error)
468 die(_("bad config file line %d in %s"), cf->linenr, cf->name);
469 else
470 return error(_("bad config file line %d in %s"), cf->linenr, cf->name);
473 static int parse_unit_factor(const char *end, uintmax_t *val)
475 if (!*end)
476 return 1;
477 else if (!strcasecmp(end, "k")) {
478 *val *= 1024;
479 return 1;
481 else if (!strcasecmp(end, "m")) {
482 *val *= 1024 * 1024;
483 return 1;
485 else if (!strcasecmp(end, "g")) {
486 *val *= 1024 * 1024 * 1024;
487 return 1;
489 return 0;
492 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
494 if (value && *value) {
495 char *end;
496 intmax_t val;
497 uintmax_t uval;
498 uintmax_t factor = 1;
500 errno = 0;
501 val = strtoimax(value, &end, 0);
502 if (errno == ERANGE)
503 return 0;
504 if (!parse_unit_factor(end, &factor)) {
505 errno = EINVAL;
506 return 0;
508 uval = abs(val);
509 uval *= factor;
510 if (uval > max || abs(val) > uval) {
511 errno = ERANGE;
512 return 0;
514 val *= factor;
515 *ret = val;
516 return 1;
518 errno = EINVAL;
519 return 0;
522 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
524 if (value && *value) {
525 char *end;
526 uintmax_t val;
527 uintmax_t oldval;
529 errno = 0;
530 val = strtoumax(value, &end, 0);
531 if (errno == ERANGE)
532 return 0;
533 oldval = val;
534 if (!parse_unit_factor(end, &val)) {
535 errno = EINVAL;
536 return 0;
538 if (val > max || oldval > val) {
539 errno = ERANGE;
540 return 0;
542 *ret = val;
543 return 1;
545 errno = EINVAL;
546 return 0;
549 static int git_parse_int(const char *value, int *ret)
551 intmax_t tmp;
552 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
553 return 0;
554 *ret = tmp;
555 return 1;
558 static int git_parse_int64(const char *value, int64_t *ret)
560 intmax_t tmp;
561 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
562 return 0;
563 *ret = tmp;
564 return 1;
567 int git_parse_ulong(const char *value, unsigned long *ret)
569 uintmax_t tmp;
570 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
571 return 0;
572 *ret = tmp;
573 return 1;
576 NORETURN
577 static void die_bad_number(const char *name, const char *value)
579 const char *reason = errno == ERANGE ?
580 "out of range" :
581 "invalid unit";
582 if (!value)
583 value = "";
585 if (cf && cf->name)
586 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
587 value, name, cf->name, reason);
588 die(_("bad numeric config value '%s' for '%s': %s"), value, name, reason);
591 int git_config_int(const char *name, const char *value)
593 int ret;
594 if (!git_parse_int(value, &ret))
595 die_bad_number(name, value);
596 return ret;
599 int64_t git_config_int64(const char *name, const char *value)
601 int64_t ret;
602 if (!git_parse_int64(value, &ret))
603 die_bad_number(name, value);
604 return ret;
607 unsigned long git_config_ulong(const char *name, const char *value)
609 unsigned long ret;
610 if (!git_parse_ulong(value, &ret))
611 die_bad_number(name, value);
612 return ret;
615 static int git_config_maybe_bool_text(const char *name, const char *value)
617 if (!value)
618 return 1;
619 if (!*value)
620 return 0;
621 if (!strcasecmp(value, "true")
622 || !strcasecmp(value, "yes")
623 || !strcasecmp(value, "on"))
624 return 1;
625 if (!strcasecmp(value, "false")
626 || !strcasecmp(value, "no")
627 || !strcasecmp(value, "off"))
628 return 0;
629 return -1;
632 int git_config_maybe_bool(const char *name, const char *value)
634 int v = git_config_maybe_bool_text(name, value);
635 if (0 <= v)
636 return v;
637 if (git_parse_int(value, &v))
638 return !!v;
639 return -1;
642 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
644 int v = git_config_maybe_bool_text(name, value);
645 if (0 <= v) {
646 *is_bool = 1;
647 return v;
649 *is_bool = 0;
650 return git_config_int(name, value);
653 int git_config_bool(const char *name, const char *value)
655 int discard;
656 return !!git_config_bool_or_int(name, value, &discard);
659 int git_config_string(const char **dest, const char *var, const char *value)
661 if (!value)
662 return config_error_nonbool(var);
663 *dest = xstrdup(value);
664 return 0;
667 int git_config_pathname(const char **dest, const char *var, const char *value)
669 if (!value)
670 return config_error_nonbool(var);
671 *dest = expand_user_path(value);
672 if (!*dest)
673 die(_("failed to expand user dir in: '%s'"), value);
674 return 0;
677 static int git_default_core_config(const char *var, const char *value)
679 /* This needs a better name */
680 if (!strcmp(var, "core.filemode")) {
681 trust_executable_bit = git_config_bool(var, value);
682 return 0;
684 if (!strcmp(var, "core.trustctime")) {
685 trust_ctime = git_config_bool(var, value);
686 return 0;
688 if (!strcmp(var, "core.checkstat")) {
689 if (!strcasecmp(value, "default"))
690 check_stat = 1;
691 else if (!strcasecmp(value, "minimal"))
692 check_stat = 0;
695 if (!strcmp(var, "core.quotepath")) {
696 quote_path_fully = git_config_bool(var, value);
697 return 0;
700 if (!strcmp(var, "core.symlinks")) {
701 has_symlinks = git_config_bool(var, value);
702 return 0;
705 if (!strcmp(var, "core.ignorecase")) {
706 ignore_case = git_config_bool(var, value);
707 return 0;
710 if (!strcmp(var, "core.attributesfile"))
711 return git_config_pathname(&git_attributes_file, var, value);
713 if (!strcmp(var, "core.bare")) {
714 is_bare_repository_cfg = git_config_bool(var, value);
715 return 0;
718 if (!strcmp(var, "core.ignorestat")) {
719 assume_unchanged = git_config_bool(var, value);
720 return 0;
723 if (!strcmp(var, "core.prefersymlinkrefs")) {
724 prefer_symlink_refs = git_config_bool(var, value);
725 return 0;
728 if (!strcmp(var, "core.logallrefupdates")) {
729 log_all_ref_updates = git_config_bool(var, value);
730 return 0;
733 if (!strcmp(var, "core.warnambiguousrefs")) {
734 warn_ambiguous_refs = git_config_bool(var, value);
735 return 0;
738 if (!strcmp(var, "core.abbrev")) {
739 int abbrev = git_config_int(var, value);
740 if (abbrev < minimum_abbrev || abbrev > 40)
741 return -1;
742 default_abbrev = abbrev;
743 return 0;
746 if (!strcmp(var, "core.loosecompression")) {
747 int level = git_config_int(var, value);
748 if (level == -1)
749 level = Z_DEFAULT_COMPRESSION;
750 else if (level < 0 || level > Z_BEST_COMPRESSION)
751 die(_("bad zlib compression level %d"), level);
752 zlib_compression_level = level;
753 zlib_compression_seen = 1;
754 return 0;
757 if (!strcmp(var, "core.compression")) {
758 int level = git_config_int(var, value);
759 if (level == -1)
760 level = Z_DEFAULT_COMPRESSION;
761 else if (level < 0 || level > Z_BEST_COMPRESSION)
762 die(_("bad zlib compression level %d"), level);
763 core_compression_level = level;
764 core_compression_seen = 1;
765 if (!zlib_compression_seen)
766 zlib_compression_level = level;
767 return 0;
770 if (!strcmp(var, "core.packedgitwindowsize")) {
771 int pgsz_x2 = getpagesize() * 2;
772 packed_git_window_size = git_config_ulong(var, value);
774 /* This value must be multiple of (pagesize * 2) */
775 packed_git_window_size /= pgsz_x2;
776 if (packed_git_window_size < 1)
777 packed_git_window_size = 1;
778 packed_git_window_size *= pgsz_x2;
779 return 0;
782 if (!strcmp(var, "core.bigfilethreshold")) {
783 big_file_threshold = git_config_ulong(var, value);
784 return 0;
787 if (!strcmp(var, "core.packedgitlimit")) {
788 packed_git_limit = git_config_ulong(var, value);
789 return 0;
792 if (!strcmp(var, "core.deltabasecachelimit")) {
793 delta_base_cache_limit = git_config_ulong(var, value);
794 return 0;
797 if (!strcmp(var, "core.autocrlf")) {
798 if (value && !strcasecmp(value, "input")) {
799 if (core_eol == EOL_CRLF)
800 return error("core.autocrlf=input conflicts with core.eol=crlf");
801 auto_crlf = AUTO_CRLF_INPUT;
802 return 0;
804 auto_crlf = git_config_bool(var, value);
805 return 0;
808 if (!strcmp(var, "core.safecrlf")) {
809 if (value && !strcasecmp(value, "warn")) {
810 safe_crlf = SAFE_CRLF_WARN;
811 return 0;
813 safe_crlf = git_config_bool(var, value);
814 return 0;
817 if (!strcmp(var, "core.eol")) {
818 if (value && !strcasecmp(value, "lf"))
819 core_eol = EOL_LF;
820 else if (value && !strcasecmp(value, "crlf"))
821 core_eol = EOL_CRLF;
822 else if (value && !strcasecmp(value, "native"))
823 core_eol = EOL_NATIVE;
824 else
825 core_eol = EOL_UNSET;
826 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
827 return error("core.autocrlf=input conflicts with core.eol=crlf");
828 return 0;
831 if (!strcmp(var, "core.notesref")) {
832 notes_ref_name = xstrdup(value);
833 return 0;
836 if (!strcmp(var, "core.pager"))
837 return git_config_string(&pager_program, var, value);
839 if (!strcmp(var, "core.editor"))
840 return git_config_string(&editor_program, var, value);
842 if (!strcmp(var, "core.commentchar")) {
843 if (!value)
844 return config_error_nonbool(var);
845 else if (!strcasecmp(value, "auto"))
846 auto_comment_line_char = 1;
847 else if (value[0] && !value[1]) {
848 comment_line_char = value[0];
849 auto_comment_line_char = 0;
850 } else
851 return error("core.commentChar should only be one character");
852 return 0;
855 if (!strcmp(var, "core.askpass"))
856 return git_config_string(&askpass_program, var, value);
858 if (!strcmp(var, "core.excludesfile"))
859 return git_config_pathname(&excludes_file, var, value);
861 if (!strcmp(var, "core.whitespace")) {
862 if (!value)
863 return config_error_nonbool(var);
864 whitespace_rule_cfg = parse_whitespace_rule(value);
865 return 0;
868 if (!strcmp(var, "core.fsyncobjectfiles")) {
869 fsync_object_files = git_config_bool(var, value);
870 return 0;
873 if (!strcmp(var, "core.preloadindex")) {
874 core_preload_index = git_config_bool(var, value);
875 return 0;
878 if (!strcmp(var, "core.createobject")) {
879 if (!strcmp(value, "rename"))
880 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
881 else if (!strcmp(value, "link"))
882 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
883 else
884 die(_("invalid mode for object creation: %s"), value);
885 return 0;
888 if (!strcmp(var, "core.sparsecheckout")) {
889 core_apply_sparse_checkout = git_config_bool(var, value);
890 return 0;
893 if (!strcmp(var, "core.precomposeunicode")) {
894 precomposed_unicode = git_config_bool(var, value);
895 return 0;
898 /* Add other config variables here and to Documentation/config.txt. */
899 return 0;
902 static int git_default_i18n_config(const char *var, const char *value)
904 if (!strcmp(var, "i18n.commitencoding"))
905 return git_config_string(&git_commit_encoding, var, value);
907 if (!strcmp(var, "i18n.logoutputencoding"))
908 return git_config_string(&git_log_output_encoding, var, value);
910 /* Add other config variables here and to Documentation/config.txt. */
911 return 0;
914 static int git_default_branch_config(const char *var, const char *value)
916 if (!strcmp(var, "branch.autosetupmerge")) {
917 if (value && !strcasecmp(value, "always")) {
918 git_branch_track = BRANCH_TRACK_ALWAYS;
919 return 0;
921 git_branch_track = git_config_bool(var, value);
922 return 0;
924 if (!strcmp(var, "branch.autosetuprebase")) {
925 if (!value)
926 return config_error_nonbool(var);
927 else if (!strcmp(value, "never"))
928 autorebase = AUTOREBASE_NEVER;
929 else if (!strcmp(value, "local"))
930 autorebase = AUTOREBASE_LOCAL;
931 else if (!strcmp(value, "remote"))
932 autorebase = AUTOREBASE_REMOTE;
933 else if (!strcmp(value, "always"))
934 autorebase = AUTOREBASE_ALWAYS;
935 else
936 return error("Malformed value for %s", var);
937 return 0;
940 /* Add other config variables here and to Documentation/config.txt. */
941 return 0;
944 static int git_default_push_config(const char *var, const char *value)
946 if (!strcmp(var, "push.default")) {
947 if (!value)
948 return config_error_nonbool(var);
949 else if (!strcmp(value, "nothing"))
950 push_default = PUSH_DEFAULT_NOTHING;
951 else if (!strcmp(value, "matching"))
952 push_default = PUSH_DEFAULT_MATCHING;
953 else if (!strcmp(value, "simple"))
954 push_default = PUSH_DEFAULT_SIMPLE;
955 else if (!strcmp(value, "upstream"))
956 push_default = PUSH_DEFAULT_UPSTREAM;
957 else if (!strcmp(value, "tracking")) /* deprecated */
958 push_default = PUSH_DEFAULT_UPSTREAM;
959 else if (!strcmp(value, "current"))
960 push_default = PUSH_DEFAULT_CURRENT;
961 else {
962 error("Malformed value for %s: %s", var, value);
963 return error("Must be one of nothing, matching, simple, "
964 "upstream or current.");
966 return 0;
969 /* Add other config variables here and to Documentation/config.txt. */
970 return 0;
973 static int git_default_mailmap_config(const char *var, const char *value)
975 if (!strcmp(var, "mailmap.file"))
976 return git_config_pathname(&git_mailmap_file, var, value);
977 if (!strcmp(var, "mailmap.blob"))
978 return git_config_string(&git_mailmap_blob, var, value);
980 /* Add other config variables here and to Documentation/config.txt. */
981 return 0;
984 int git_default_config(const char *var, const char *value, void *dummy)
986 if (starts_with(var, "core."))
987 return git_default_core_config(var, value);
989 if (starts_with(var, "user."))
990 return git_ident_config(var, value, dummy);
992 if (starts_with(var, "i18n."))
993 return git_default_i18n_config(var, value);
995 if (starts_with(var, "branch."))
996 return git_default_branch_config(var, value);
998 if (starts_with(var, "push."))
999 return git_default_push_config(var, value);
1001 if (starts_with(var, "mailmap."))
1002 return git_default_mailmap_config(var, value);
1004 if (starts_with(var, "advice."))
1005 return git_default_advice_config(var, value);
1007 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1008 pager_use_color = git_config_bool(var,value);
1009 return 0;
1012 if (!strcmp(var, "pack.packsizelimit")) {
1013 pack_size_limit_cfg = git_config_ulong(var, value);
1014 return 0;
1016 /* Add other config variables here and to Documentation/config.txt. */
1017 return 0;
1021 * All source specific fields in the union, die_on_error, name and the callbacks
1022 * fgetc, ungetc, ftell of top need to be initialized before calling
1023 * this function.
1025 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1027 int ret;
1029 /* push config-file parsing state stack */
1030 top->prev = cf;
1031 top->linenr = 1;
1032 top->eof = 0;
1033 strbuf_init(&top->value, 1024);
1034 strbuf_init(&top->var, 1024);
1035 cf = top;
1037 ret = git_parse_source(fn, data);
1039 /* pop config-file parsing state stack */
1040 strbuf_release(&top->value);
1041 strbuf_release(&top->var);
1042 cf = top->prev;
1044 return ret;
1047 static int do_config_from_file(config_fn_t fn,
1048 const char *name, const char *path, FILE *f, void *data)
1050 struct config_source top;
1052 top.u.file = f;
1053 top.name = name;
1054 top.path = path;
1055 top.die_on_error = 1;
1056 top.do_fgetc = config_file_fgetc;
1057 top.do_ungetc = config_file_ungetc;
1058 top.do_ftell = config_file_ftell;
1060 return do_config_from(&top, fn, data);
1063 static int git_config_from_stdin(config_fn_t fn, void *data)
1065 return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
1068 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1070 int ret = -1;
1071 FILE *f;
1073 f = fopen(filename, "r");
1074 if (f) {
1075 ret = do_config_from_file(fn, filename, filename, f, data);
1076 fclose(f);
1078 return ret;
1081 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1082 size_t len, void *data)
1084 struct config_source top;
1086 top.u.buf.buf = buf;
1087 top.u.buf.len = len;
1088 top.u.buf.pos = 0;
1089 top.name = name;
1090 top.path = NULL;
1091 top.die_on_error = 0;
1092 top.do_fgetc = config_buf_fgetc;
1093 top.do_ungetc = config_buf_ungetc;
1094 top.do_ftell = config_buf_ftell;
1096 return do_config_from(&top, fn, data);
1099 static int git_config_from_blob_sha1(config_fn_t fn,
1100 const char *name,
1101 const unsigned char *sha1,
1102 void *data)
1104 enum object_type type;
1105 char *buf;
1106 unsigned long size;
1107 int ret;
1109 buf = read_sha1_file(sha1, &type, &size);
1110 if (!buf)
1111 return error("unable to load config blob object '%s'", name);
1112 if (type != OBJ_BLOB) {
1113 free(buf);
1114 return error("reference '%s' does not point to a blob", name);
1117 ret = git_config_from_buf(fn, name, buf, size, data);
1118 free(buf);
1120 return ret;
1123 static int git_config_from_blob_ref(config_fn_t fn,
1124 const char *name,
1125 void *data)
1127 unsigned char sha1[20];
1129 if (get_sha1(name, sha1) < 0)
1130 return error("unable to resolve config blob '%s'", name);
1131 return git_config_from_blob_sha1(fn, name, sha1, data);
1134 const char *git_etc_gitconfig(void)
1136 static const char *system_wide;
1137 if (!system_wide)
1138 system_wide = system_path(ETC_GITCONFIG);
1139 return system_wide;
1143 * Parse environment variable 'k' as a boolean (in various
1144 * possible spellings); if missing, use the default value 'def'.
1146 int git_env_bool(const char *k, int def)
1148 const char *v = getenv(k);
1149 return v ? git_config_bool(k, v) : def;
1153 * Parse environment variable 'k' as ulong with possibly a unit
1154 * suffix; if missing, use the default value 'val'.
1156 unsigned long git_env_ulong(const char *k, unsigned long val)
1158 const char *v = getenv(k);
1159 if (v && !git_parse_ulong(v, &val))
1160 die("failed to parse %s", k);
1161 return val;
1164 int git_config_system(void)
1166 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1169 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1171 int ret = 0, found = 0;
1172 char *xdg_config = NULL;
1173 char *user_config = NULL;
1175 home_config_paths(&user_config, &xdg_config, "config");
1177 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1178 ret += git_config_from_file(fn, git_etc_gitconfig(),
1179 data);
1180 found += 1;
1183 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1184 ret += git_config_from_file(fn, xdg_config, data);
1185 found += 1;
1188 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1189 ret += git_config_from_file(fn, user_config, data);
1190 found += 1;
1193 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1194 ret += git_config_from_file(fn, repo_config, data);
1195 found += 1;
1198 switch (git_config_from_parameters(fn, data)) {
1199 case -1: /* error */
1200 die(_("unable to parse command-line config"));
1201 break;
1202 case 0: /* found nothing */
1203 break;
1204 default: /* found at least one item */
1205 found++;
1206 break;
1209 free(xdg_config);
1210 free(user_config);
1211 return ret == 0 ? found : ret;
1214 int git_config_with_options(config_fn_t fn, void *data,
1215 struct git_config_source *config_source,
1216 int respect_includes)
1218 char *repo_config = NULL;
1219 int ret;
1220 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1222 if (respect_includes) {
1223 inc.fn = fn;
1224 inc.data = data;
1225 fn = git_config_include;
1226 data = &inc;
1230 * If we have a specific filename, use it. Otherwise, follow the
1231 * regular lookup sequence.
1233 if (config_source && config_source->use_stdin)
1234 return git_config_from_stdin(fn, data);
1235 else if (config_source && config_source->file)
1236 return git_config_from_file(fn, config_source->file, data);
1237 else if (config_source && config_source->blob)
1238 return git_config_from_blob_ref(fn, config_source->blob, data);
1240 repo_config = git_pathdup("config");
1241 ret = git_config_early(fn, data, repo_config);
1242 if (repo_config)
1243 free(repo_config);
1244 return ret;
1247 static void git_config_raw(config_fn_t fn, void *data)
1249 if (git_config_with_options(fn, data, NULL, 1) < 0)
1251 * git_config_with_options() normally returns only
1252 * positive values, as most errors are fatal, and
1253 * non-fatal potential errors are guarded by "if"
1254 * statements that are entered only when no error is
1255 * possible.
1257 * If we ever encounter a non-fatal error, it means
1258 * something went really wrong and we should stop
1259 * immediately.
1261 die(_("unknown error occured while reading the configuration files"));
1264 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1266 int i, value_index;
1267 struct string_list *values;
1268 struct config_set_element *entry;
1269 struct configset_list *list = &cs->list;
1270 struct key_value_info *kv_info;
1272 for (i = 0; i < list->nr; i++) {
1273 entry = list->items[i].e;
1274 value_index = list->items[i].value_index;
1275 values = &entry->value_list;
1276 if (fn(entry->key, values->items[value_index].string, data) < 0) {
1277 kv_info = values->items[value_index].util;
1278 git_die_config_linenr(entry->key, kv_info->filename, kv_info->linenr);
1283 static void git_config_check_init(void);
1285 void git_config(config_fn_t fn, void *data)
1287 git_config_check_init();
1288 configset_iter(&the_config_set, fn, data);
1291 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1293 struct config_set_element k;
1294 struct config_set_element *found_entry;
1295 char *normalized_key;
1296 int ret;
1298 * `key` may come from the user, so normalize it before using it
1299 * for querying entries from the hashmap.
1301 ret = git_config_parse_key(key, &normalized_key, NULL);
1303 if (ret)
1304 return NULL;
1306 hashmap_entry_init(&k, strhash(normalized_key));
1307 k.key = normalized_key;
1308 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1309 free(normalized_key);
1310 return found_entry;
1313 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1315 struct config_set_element *e;
1316 struct string_list_item *si;
1317 struct configset_list_item *l_item;
1318 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1320 e = configset_find_element(cs, key);
1322 * Since the keys are being fed by git_config*() callback mechanism, they
1323 * are already normalized. So simply add them without any further munging.
1325 if (!e) {
1326 e = xmalloc(sizeof(*e));
1327 hashmap_entry_init(e, strhash(key));
1328 e->key = xstrdup(key);
1329 string_list_init(&e->value_list, 1);
1330 hashmap_add(&cs->config_hash, e);
1332 si = string_list_append_nodup(&e->value_list, value ? xstrdup(value) : NULL);
1334 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1335 l_item = &cs->list.items[cs->list.nr++];
1336 l_item->e = e;
1337 l_item->value_index = e->value_list.nr - 1;
1339 if (cf) {
1340 kv_info->filename = strintern(cf->name);
1341 kv_info->linenr = cf->linenr;
1342 } else {
1343 /* for values read from `git_config_from_parameters()` */
1344 kv_info->filename = NULL;
1345 kv_info->linenr = -1;
1347 si->util = kv_info;
1349 return 0;
1352 static int config_set_element_cmp(const struct config_set_element *e1,
1353 const struct config_set_element *e2, const void *unused)
1355 return strcmp(e1->key, e2->key);
1358 void git_configset_init(struct config_set *cs)
1360 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1361 cs->hash_initialized = 1;
1362 cs->list.nr = 0;
1363 cs->list.alloc = 0;
1364 cs->list.items = NULL;
1367 void git_configset_clear(struct config_set *cs)
1369 struct config_set_element *entry;
1370 struct hashmap_iter iter;
1371 if (!cs->hash_initialized)
1372 return;
1374 hashmap_iter_init(&cs->config_hash, &iter);
1375 while ((entry = hashmap_iter_next(&iter))) {
1376 free(entry->key);
1377 string_list_clear(&entry->value_list, 1);
1379 hashmap_free(&cs->config_hash, 1);
1380 cs->hash_initialized = 0;
1381 free(cs->list.items);
1382 cs->list.nr = 0;
1383 cs->list.alloc = 0;
1384 cs->list.items = NULL;
1387 static int config_set_callback(const char *key, const char *value, void *cb)
1389 struct config_set *cs = cb;
1390 configset_add_value(cs, key, value);
1391 return 0;
1394 int git_configset_add_file(struct config_set *cs, const char *filename)
1396 return git_config_from_file(config_set_callback, filename, cs);
1399 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1401 const struct string_list *values = NULL;
1403 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1404 * queried key in the files of the configset, the value returned will be the last
1405 * value in the value list for that key.
1407 values = git_configset_get_value_multi(cs, key);
1409 if (!values)
1410 return 1;
1411 assert(values->nr > 0);
1412 *value = values->items[values->nr - 1].string;
1413 return 0;
1416 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1418 struct config_set_element *e = configset_find_element(cs, key);
1419 return e ? &e->value_list : NULL;
1422 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1424 const char *value;
1425 if (!git_configset_get_value(cs, key, &value))
1426 return git_config_string(dest, key, value);
1427 else
1428 return 1;
1431 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1433 return git_configset_get_string_const(cs, key, (const char **)dest);
1436 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1438 const char *value;
1439 if (!git_configset_get_value(cs, key, &value)) {
1440 *dest = git_config_int(key, value);
1441 return 0;
1442 } else
1443 return 1;
1446 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1448 const char *value;
1449 if (!git_configset_get_value(cs, key, &value)) {
1450 *dest = git_config_ulong(key, value);
1451 return 0;
1452 } else
1453 return 1;
1456 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1458 const char *value;
1459 if (!git_configset_get_value(cs, key, &value)) {
1460 *dest = git_config_bool(key, value);
1461 return 0;
1462 } else
1463 return 1;
1466 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1467 int *is_bool, int *dest)
1469 const char *value;
1470 if (!git_configset_get_value(cs, key, &value)) {
1471 *dest = git_config_bool_or_int(key, value, is_bool);
1472 return 0;
1473 } else
1474 return 1;
1477 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1479 const char *value;
1480 if (!git_configset_get_value(cs, key, &value)) {
1481 *dest = git_config_maybe_bool(key, value);
1482 if (*dest == -1)
1483 return -1;
1484 return 0;
1485 } else
1486 return 1;
1489 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1491 const char *value;
1492 if (!git_configset_get_value(cs, key, &value))
1493 return git_config_pathname(dest, key, value);
1494 else
1495 return 1;
1498 static void git_config_check_init(void)
1500 if (the_config_set.hash_initialized)
1501 return;
1502 git_configset_init(&the_config_set);
1503 git_config_raw(config_set_callback, &the_config_set);
1506 void git_config_clear(void)
1508 if (!the_config_set.hash_initialized)
1509 return;
1510 git_configset_clear(&the_config_set);
1513 int git_config_get_value(const char *key, const char **value)
1515 git_config_check_init();
1516 return git_configset_get_value(&the_config_set, key, value);
1519 const struct string_list *git_config_get_value_multi(const char *key)
1521 git_config_check_init();
1522 return git_configset_get_value_multi(&the_config_set, key);
1525 int git_config_get_string_const(const char *key, const char **dest)
1527 int ret;
1528 git_config_check_init();
1529 ret = git_configset_get_string_const(&the_config_set, key, dest);
1530 if (ret < 0)
1531 git_die_config(key, NULL);
1532 return ret;
1535 int git_config_get_string(const char *key, char **dest)
1537 git_config_check_init();
1538 return git_config_get_string_const(key, (const char **)dest);
1541 int git_config_get_int(const char *key, int *dest)
1543 git_config_check_init();
1544 return git_configset_get_int(&the_config_set, key, dest);
1547 int git_config_get_ulong(const char *key, unsigned long *dest)
1549 git_config_check_init();
1550 return git_configset_get_ulong(&the_config_set, key, dest);
1553 int git_config_get_bool(const char *key, int *dest)
1555 git_config_check_init();
1556 return git_configset_get_bool(&the_config_set, key, dest);
1559 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1561 git_config_check_init();
1562 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1565 int git_config_get_maybe_bool(const char *key, int *dest)
1567 git_config_check_init();
1568 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1571 int git_config_get_pathname(const char *key, const char **dest)
1573 int ret;
1574 git_config_check_init();
1575 ret = git_configset_get_pathname(&the_config_set, key, dest);
1576 if (ret < 0)
1577 git_die_config(key, NULL);
1578 return ret;
1581 NORETURN
1582 void git_die_config_linenr(const char *key, const char *filename, int linenr)
1584 if (!filename)
1585 die(_("unable to parse '%s' from command-line config"), key);
1586 else
1587 die(_("bad config variable '%s' in file '%s' at line %d"),
1588 key, filename, linenr);
1591 NORETURN __attribute__((format(printf, 2, 3)))
1592 void git_die_config(const char *key, const char *err, ...)
1594 const struct string_list *values;
1595 struct key_value_info *kv_info;
1597 if (err) {
1598 va_list params;
1599 va_start(params, err);
1600 vreportf("error: ", err, params);
1601 va_end(params);
1603 values = git_config_get_value_multi(key);
1604 kv_info = values->items[values->nr - 1].util;
1605 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
1609 * Find all the stuff for git_config_set() below.
1612 static struct {
1613 int baselen;
1614 char *key;
1615 int do_not_match;
1616 regex_t *value_regex;
1617 int multi_replace;
1618 size_t *offset;
1619 unsigned int offset_alloc;
1620 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1621 int seen;
1622 } store;
1624 static int matches(const char *key, const char *value)
1626 if (strcmp(key, store.key))
1627 return 0; /* not ours */
1628 if (!store.value_regex)
1629 return 1; /* always matches */
1630 if (store.value_regex == CONFIG_REGEX_NONE)
1631 return 0; /* never matches */
1633 return store.do_not_match ^
1634 (value && !regexec(store.value_regex, value, 0, NULL, 0));
1637 static int store_aux(const char *key, const char *value, void *cb)
1639 const char *ep;
1640 size_t section_len;
1642 switch (store.state) {
1643 case KEY_SEEN:
1644 if (matches(key, value)) {
1645 if (store.seen == 1 && store.multi_replace == 0) {
1646 warning(_("%s has multiple values"), key);
1649 ALLOC_GROW(store.offset, store.seen + 1,
1650 store.offset_alloc);
1652 store.offset[store.seen] = cf->do_ftell(cf);
1653 store.seen++;
1655 break;
1656 case SECTION_SEEN:
1658 * What we are looking for is in store.key (both
1659 * section and var), and its section part is baselen
1660 * long. We found key (again, both section and var).
1661 * We would want to know if this key is in the same
1662 * section as what we are looking for. We already
1663 * know we are in the same section as what should
1664 * hold store.key.
1666 ep = strrchr(key, '.');
1667 section_len = ep - key;
1669 if ((section_len != store.baselen) ||
1670 memcmp(key, store.key, section_len+1)) {
1671 store.state = SECTION_END_SEEN;
1672 break;
1676 * Do not increment matches: this is no match, but we
1677 * just made sure we are in the desired section.
1679 ALLOC_GROW(store.offset, store.seen + 1,
1680 store.offset_alloc);
1681 store.offset[store.seen] = cf->do_ftell(cf);
1682 /* fallthru */
1683 case SECTION_END_SEEN:
1684 case START:
1685 if (matches(key, value)) {
1686 ALLOC_GROW(store.offset, store.seen + 1,
1687 store.offset_alloc);
1688 store.offset[store.seen] = cf->do_ftell(cf);
1689 store.state = KEY_SEEN;
1690 store.seen++;
1691 } else {
1692 if (strrchr(key, '.') - key == store.baselen &&
1693 !strncmp(key, store.key, store.baselen)) {
1694 store.state = SECTION_SEEN;
1695 ALLOC_GROW(store.offset,
1696 store.seen + 1,
1697 store.offset_alloc);
1698 store.offset[store.seen] = cf->do_ftell(cf);
1702 return 0;
1705 static int write_error(const char *filename)
1707 error("failed to write new configuration file %s", filename);
1709 /* Same error code as "failed to rename". */
1710 return 4;
1713 static int store_write_section(int fd, const char *key)
1715 const char *dot;
1716 int i, success;
1717 struct strbuf sb = STRBUF_INIT;
1719 dot = memchr(key, '.', store.baselen);
1720 if (dot) {
1721 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1722 for (i = dot - key + 1; i < store.baselen; i++) {
1723 if (key[i] == '"' || key[i] == '\\')
1724 strbuf_addch(&sb, '\\');
1725 strbuf_addch(&sb, key[i]);
1727 strbuf_addstr(&sb, "\"]\n");
1728 } else {
1729 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1732 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1733 strbuf_release(&sb);
1735 return success;
1738 static int store_write_pair(int fd, const char *key, const char *value)
1740 int i, success;
1741 int length = strlen(key + store.baselen + 1);
1742 const char *quote = "";
1743 struct strbuf sb = STRBUF_INIT;
1746 * Check to see if the value needs to be surrounded with a dq pair.
1747 * Note that problematic characters are always backslash-quoted; this
1748 * check is about not losing leading or trailing SP and strings that
1749 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1750 * configuration parser.
1752 if (value[0] == ' ')
1753 quote = "\"";
1754 for (i = 0; value[i]; i++)
1755 if (value[i] == ';' || value[i] == '#')
1756 quote = "\"";
1757 if (i && value[i - 1] == ' ')
1758 quote = "\"";
1760 strbuf_addf(&sb, "\t%.*s = %s",
1761 length, key + store.baselen + 1, quote);
1763 for (i = 0; value[i]; i++)
1764 switch (value[i]) {
1765 case '\n':
1766 strbuf_addstr(&sb, "\\n");
1767 break;
1768 case '\t':
1769 strbuf_addstr(&sb, "\\t");
1770 break;
1771 case '"':
1772 case '\\':
1773 strbuf_addch(&sb, '\\');
1774 default:
1775 strbuf_addch(&sb, value[i]);
1776 break;
1778 strbuf_addf(&sb, "%s\n", quote);
1780 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1781 strbuf_release(&sb);
1783 return success;
1786 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1787 size_t offset_, int *found_bracket)
1789 size_t equal_offset = size, bracket_offset = size;
1790 ssize_t offset;
1792 contline:
1793 for (offset = offset_-2; offset > 0
1794 && contents[offset] != '\n'; offset--)
1795 switch (contents[offset]) {
1796 case '=': equal_offset = offset; break;
1797 case ']': bracket_offset = offset; break;
1799 if (offset > 0 && contents[offset-1] == '\\') {
1800 offset_ = offset;
1801 goto contline;
1803 if (bracket_offset < equal_offset) {
1804 *found_bracket = 1;
1805 offset = bracket_offset+1;
1806 } else
1807 offset++;
1809 return offset;
1812 int git_config_set_in_file(const char *config_filename,
1813 const char *key, const char *value)
1815 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1818 int git_config_set(const char *key, const char *value)
1820 return git_config_set_multivar(key, value, NULL, 0);
1824 * Auxiliary function to sanity-check and split the key into the section
1825 * identifier and variable name.
1827 * Returns 0 on success, -1 when there is an invalid character in the key and
1828 * -2 if there is no section name in the key.
1830 * store_key - pointer to char* which will hold a copy of the key with
1831 * lowercase section and variable name
1832 * baselen - pointer to int which will hold the length of the
1833 * section + subsection part, can be NULL
1835 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1837 int i, dot, baselen;
1838 const char *last_dot = strrchr(key, '.');
1841 * Since "key" actually contains the section name and the real
1842 * key name separated by a dot, we have to know where the dot is.
1845 if (last_dot == NULL || last_dot == key) {
1846 error("key does not contain a section: %s", key);
1847 return -CONFIG_NO_SECTION_OR_NAME;
1850 if (!last_dot[1]) {
1851 error("key does not contain variable name: %s", key);
1852 return -CONFIG_NO_SECTION_OR_NAME;
1855 baselen = last_dot - key;
1856 if (baselen_)
1857 *baselen_ = baselen;
1860 * Validate the key and while at it, lower case it for matching.
1862 *store_key = xmalloc(strlen(key) + 1);
1864 dot = 0;
1865 for (i = 0; key[i]; i++) {
1866 unsigned char c = key[i];
1867 if (c == '.')
1868 dot = 1;
1869 /* Leave the extended basename untouched.. */
1870 if (!dot || i > baselen) {
1871 if (!iskeychar(c) ||
1872 (i == baselen + 1 && !isalpha(c))) {
1873 error("invalid key: %s", key);
1874 goto out_free_ret_1;
1876 c = tolower(c);
1877 } else if (c == '\n') {
1878 error("invalid key (newline): %s", key);
1879 goto out_free_ret_1;
1881 (*store_key)[i] = c;
1883 (*store_key)[i] = 0;
1885 return 0;
1887 out_free_ret_1:
1888 free(*store_key);
1889 *store_key = NULL;
1890 return -CONFIG_INVALID_KEY;
1894 * If value==NULL, unset in (remove from) config,
1895 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1896 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
1897 * (only add a new one)
1898 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1899 * else all matching key/values (regardless how many) are removed,
1900 * before the new pair is written.
1902 * Returns 0 on success.
1904 * This function does this:
1906 * - it locks the config file by creating ".git/config.lock"
1908 * - it then parses the config using store_aux() as validator to find
1909 * the position on the key/value pair to replace. If it is to be unset,
1910 * it must be found exactly once.
1912 * - the config file is mmap()ed and the part before the match (if any) is
1913 * written to the lock file, then the changed part and the rest.
1915 * - the config file is removed and the lock file rename()d to it.
1918 int git_config_set_multivar_in_file(const char *config_filename,
1919 const char *key, const char *value,
1920 const char *value_regex, int multi_replace)
1922 int fd = -1, in_fd;
1923 int ret;
1924 struct lock_file *lock = NULL;
1925 char *filename_buf = NULL;
1927 /* parse-key returns negative; flip the sign to feed exit(3) */
1928 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1929 if (ret)
1930 goto out_free;
1932 store.multi_replace = multi_replace;
1934 if (!config_filename)
1935 config_filename = filename_buf = git_pathdup("config");
1938 * The lock serves a purpose in addition to locking: the new
1939 * contents of .git/config will be written into it.
1941 lock = xcalloc(1, sizeof(struct lock_file));
1942 fd = hold_lock_file_for_update(lock, config_filename, 0);
1943 if (fd < 0) {
1944 error("could not lock config file %s: %s", config_filename, strerror(errno));
1945 free(store.key);
1946 ret = CONFIG_NO_LOCK;
1947 goto out_free;
1951 * If .git/config does not exist yet, write a minimal version.
1953 in_fd = open(config_filename, O_RDONLY);
1954 if ( in_fd < 0 ) {
1955 free(store.key);
1957 if ( ENOENT != errno ) {
1958 error("opening %s: %s", config_filename,
1959 strerror(errno));
1960 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1961 goto out_free;
1963 /* if nothing to unset, error out */
1964 if (value == NULL) {
1965 ret = CONFIG_NOTHING_SET;
1966 goto out_free;
1969 store.key = (char *)key;
1970 if (!store_write_section(fd, key) ||
1971 !store_write_pair(fd, key, value))
1972 goto write_err_out;
1973 } else {
1974 struct stat st;
1975 char *contents;
1976 size_t contents_sz, copy_begin, copy_end;
1977 int i, new_line = 0;
1979 if (value_regex == NULL)
1980 store.value_regex = NULL;
1981 else if (value_regex == CONFIG_REGEX_NONE)
1982 store.value_regex = CONFIG_REGEX_NONE;
1983 else {
1984 if (value_regex[0] == '!') {
1985 store.do_not_match = 1;
1986 value_regex++;
1987 } else
1988 store.do_not_match = 0;
1990 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1991 if (regcomp(store.value_regex, value_regex,
1992 REG_EXTENDED)) {
1993 error("invalid pattern: %s", value_regex);
1994 free(store.value_regex);
1995 ret = CONFIG_INVALID_PATTERN;
1996 goto out_free;
2000 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2001 store.offset[0] = 0;
2002 store.state = START;
2003 store.seen = 0;
2006 * After this, store.offset will contain the *end* offset
2007 * of the last match, or remain at 0 if no match was found.
2008 * As a side effect, we make sure to transform only a valid
2009 * existing config file.
2011 if (git_config_from_file(store_aux, config_filename, NULL)) {
2012 error("invalid config file %s", config_filename);
2013 free(store.key);
2014 if (store.value_regex != NULL &&
2015 store.value_regex != CONFIG_REGEX_NONE) {
2016 regfree(store.value_regex);
2017 free(store.value_regex);
2019 ret = CONFIG_INVALID_FILE;
2020 goto out_free;
2023 free(store.key);
2024 if (store.value_regex != NULL &&
2025 store.value_regex != CONFIG_REGEX_NONE) {
2026 regfree(store.value_regex);
2027 free(store.value_regex);
2030 /* if nothing to unset, or too many matches, error out */
2031 if ((store.seen == 0 && value == NULL) ||
2032 (store.seen > 1 && multi_replace == 0)) {
2033 ret = CONFIG_NOTHING_SET;
2034 goto out_free;
2037 fstat(in_fd, &st);
2038 contents_sz = xsize_t(st.st_size);
2039 contents = xmmap(NULL, contents_sz, PROT_READ,
2040 MAP_PRIVATE, in_fd, 0);
2041 close(in_fd);
2043 if (chmod(lock->filename, st.st_mode & 07777) < 0) {
2044 error("chmod on %s failed: %s",
2045 lock->filename, strerror(errno));
2046 ret = CONFIG_NO_WRITE;
2047 goto out_free;
2050 if (store.seen == 0)
2051 store.seen = 1;
2053 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2054 if (store.offset[i] == 0) {
2055 store.offset[i] = copy_end = contents_sz;
2056 } else if (store.state != KEY_SEEN) {
2057 copy_end = store.offset[i];
2058 } else
2059 copy_end = find_beginning_of_line(
2060 contents, contents_sz,
2061 store.offset[i]-2, &new_line);
2063 if (copy_end > 0 && contents[copy_end-1] != '\n')
2064 new_line = 1;
2066 /* write the first part of the config */
2067 if (copy_end > copy_begin) {
2068 if (write_in_full(fd, contents + copy_begin,
2069 copy_end - copy_begin) <
2070 copy_end - copy_begin)
2071 goto write_err_out;
2072 if (new_line &&
2073 write_str_in_full(fd, "\n") != 1)
2074 goto write_err_out;
2076 copy_begin = store.offset[i];
2079 /* write the pair (value == NULL means unset) */
2080 if (value != NULL) {
2081 if (store.state == START) {
2082 if (!store_write_section(fd, key))
2083 goto write_err_out;
2085 if (!store_write_pair(fd, key, value))
2086 goto write_err_out;
2089 /* write the rest of the config */
2090 if (copy_begin < contents_sz)
2091 if (write_in_full(fd, contents + copy_begin,
2092 contents_sz - copy_begin) <
2093 contents_sz - copy_begin)
2094 goto write_err_out;
2096 munmap(contents, contents_sz);
2099 if (commit_lock_file(lock) < 0) {
2100 error("could not commit config file %s", config_filename);
2101 ret = CONFIG_NO_WRITE;
2102 goto out_free;
2106 * lock is committed, so don't try to roll it back below.
2107 * NOTE: Since lockfile.c keeps a linked list of all created
2108 * lock_file structures, it isn't safe to free(lock). It's
2109 * better to just leave it hanging around.
2111 lock = NULL;
2112 ret = 0;
2114 /* Invalidate the config cache */
2115 git_config_clear();
2117 out_free:
2118 if (lock)
2119 rollback_lock_file(lock);
2120 free(filename_buf);
2121 return ret;
2123 write_err_out:
2124 ret = write_error(lock->filename);
2125 goto out_free;
2129 int git_config_set_multivar(const char *key, const char *value,
2130 const char *value_regex, int multi_replace)
2132 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
2133 multi_replace);
2136 static int section_name_match (const char *buf, const char *name)
2138 int i = 0, j = 0, dot = 0;
2139 if (buf[i] != '[')
2140 return 0;
2141 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2142 if (!dot && isspace(buf[i])) {
2143 dot = 1;
2144 if (name[j++] != '.')
2145 break;
2146 for (i++; isspace(buf[i]); i++)
2147 ; /* do nothing */
2148 if (buf[i] != '"')
2149 break;
2150 continue;
2152 if (buf[i] == '\\' && dot)
2153 i++;
2154 else if (buf[i] == '"' && dot) {
2155 for (i++; isspace(buf[i]); i++)
2156 ; /* do_nothing */
2157 break;
2159 if (buf[i] != name[j++])
2160 break;
2162 if (buf[i] == ']' && name[j] == 0) {
2164 * We match, now just find the right length offset by
2165 * gobbling up any whitespace after it, as well
2167 i++;
2168 for (; buf[i] && isspace(buf[i]); i++)
2169 ; /* do nothing */
2170 return i;
2172 return 0;
2175 static int section_name_is_ok(const char *name)
2177 /* Empty section names are bogus. */
2178 if (!*name)
2179 return 0;
2182 * Before a dot, we must be alphanumeric or dash. After the first dot,
2183 * anything goes, so we can stop checking.
2185 for (; *name && *name != '.'; name++)
2186 if (*name != '-' && !isalnum(*name))
2187 return 0;
2188 return 1;
2191 /* if new_name == NULL, the section is removed instead */
2192 int git_config_rename_section_in_file(const char *config_filename,
2193 const char *old_name, const char *new_name)
2195 int ret = 0, remove = 0;
2196 char *filename_buf = NULL;
2197 struct lock_file *lock;
2198 int out_fd;
2199 char buf[1024];
2200 FILE *config_file;
2201 struct stat st;
2203 if (new_name && !section_name_is_ok(new_name)) {
2204 ret = error("invalid section name: %s", new_name);
2205 goto out;
2208 if (!config_filename)
2209 config_filename = filename_buf = git_pathdup("config");
2211 lock = xcalloc(1, sizeof(struct lock_file));
2212 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2213 if (out_fd < 0) {
2214 ret = error("could not lock config file %s", config_filename);
2215 goto out;
2218 if (!(config_file = fopen(config_filename, "rb"))) {
2219 /* no config file means nothing to rename, no error */
2220 goto unlock_and_out;
2223 fstat(fileno(config_file), &st);
2225 if (chmod(lock->filename, st.st_mode & 07777) < 0) {
2226 ret = error("chmod on %s failed: %s",
2227 lock->filename, strerror(errno));
2228 goto out;
2231 while (fgets(buf, sizeof(buf), config_file)) {
2232 int i;
2233 int length;
2234 char *output = buf;
2235 for (i = 0; buf[i] && isspace(buf[i]); i++)
2236 ; /* do nothing */
2237 if (buf[i] == '[') {
2238 /* it's a section */
2239 int offset = section_name_match(&buf[i], old_name);
2240 if (offset > 0) {
2241 ret++;
2242 if (new_name == NULL) {
2243 remove = 1;
2244 continue;
2246 store.baselen = strlen(new_name);
2247 if (!store_write_section(out_fd, new_name)) {
2248 ret = write_error(lock->filename);
2249 goto out;
2252 * We wrote out the new section, with
2253 * a newline, now skip the old
2254 * section's length
2256 output += offset + i;
2257 if (strlen(output) > 0) {
2259 * More content means there's
2260 * a declaration to put on the
2261 * next line; indent with a
2262 * tab
2264 output -= 1;
2265 output[0] = '\t';
2268 remove = 0;
2270 if (remove)
2271 continue;
2272 length = strlen(output);
2273 if (write_in_full(out_fd, output, length) != length) {
2274 ret = write_error(lock->filename);
2275 goto out;
2278 fclose(config_file);
2279 unlock_and_out:
2280 if (commit_lock_file(lock) < 0)
2281 ret = error("could not commit config file %s", config_filename);
2282 out:
2283 free(filename_buf);
2284 return ret;
2287 int git_config_rename_section(const char *old_name, const char *new_name)
2289 return git_config_rename_section_in_file(NULL, old_name, new_name);
2293 * Call this to report error for your variable that should not
2294 * get a boolean value (i.e. "[my] var" means "true").
2296 #undef config_error_nonbool
2297 int config_error_nonbool(const char *var)
2299 return error("Missing value for '%s'", var);
2302 int parse_config_key(const char *var,
2303 const char *section,
2304 const char **subsection, int *subsection_len,
2305 const char **key)
2307 int section_len = strlen(section);
2308 const char *dot;
2310 /* Does it start with "section." ? */
2311 if (!starts_with(var, section) || var[section_len] != '.')
2312 return -1;
2315 * Find the key; we don't know yet if we have a subsection, but we must
2316 * parse backwards from the end, since the subsection may have dots in
2317 * it, too.
2319 dot = strrchr(var, '.');
2320 *key = dot + 1;
2322 /* Did we have a subsection at all? */
2323 if (dot == var + section_len) {
2324 *subsection = NULL;
2325 *subsection_len = 0;
2327 else {
2328 *subsection = var + section_len + 1;
2329 *subsection_len = dot - *subsection;
2332 return 0;