]> git.ipfire.org Git - thirdparty/git.git/blame - config.c
config: move a few helper functions up
[thirdparty/git.git] / config.c
CommitLineData
10bea152
JS
1/*
2 * GIT - The information manager from hell
3 *
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
6 *
7 */
17712991 8#include "cache.h"
697cc8ef 9#include "lockfile.h"
7f0e39fa 10#include "exec_cmd.h"
572e4f6a 11#include "strbuf.h"
2b64fc89 12#include "quote.h"
3c8687a7
TA
13#include "hashmap.h"
14#include "string-list.h"
599446dc 15#include "utf8.h"
17712991 16
4d8dd149
HV
17struct config_source {
18 struct config_source *prev;
19 union {
20 FILE *file;
1bc88819
HV
21 struct config_buf {
22 const char *buf;
23 size_t len;
24 size_t pos;
25 } buf;
4d8dd149 26 } u;
1b8132d9 27 enum config_origin_type origin_type;
924aaf3e 28 const char *name;
d14d4244 29 const char *path;
b2dc0945 30 int die_on_error;
924aaf3e
RJ
31 int linenr;
32 int eof;
33 struct strbuf value;
0971e992 34 struct strbuf var;
924aaf3e 35
49d6cfa5
JK
36 int (*do_fgetc)(struct config_source *c);
37 int (*do_ungetc)(int c, struct config_source *conf);
38 long (*do_ftell)(struct config_source *c);
4d8dd149
HV
39};
40
0d44a2da
JK
41/*
42 * These variables record the "current" config source, which
43 * can be accessed by parsing callbacks.
44 *
45 * The "cf" variable will be non-NULL only when we are actually parsing a real
46 * config source (file, blob, cmdline, etc).
47 *
48 * The "current_config_kvi" variable will be non-NULL only when we are feeding
49 * cached config from a configset into a callback.
50 *
51 * They should generally never be non-NULL at the same time. If they are both
52 * NULL, then we aren't parsing anything (and depending on the function looking
53 * at the variables, it's either a bug for it to be called in the first place,
54 * or it's a function which can be reused for non-config purposes, and should
55 * fall back to some sane behavior).
56 */
4d8dd149 57static struct config_source *cf;
0d44a2da 58static struct key_value_info *current_config_kvi;
924aaf3e 59
9acc5911
JK
60/*
61 * Similar to the variables above, this gives access to the "scope" of the
62 * current value (repo, global, etc). For cached values, it can be found via
63 * the current_config_kvi as above. During parsing, the current value can be
64 * found in this variable. It's not part of "cf" because it transcends a single
65 * file (i.e., a file included from .git/config is still in "repo" scope).
66 */
67static enum config_scope current_parsing_scope;
924aaf3e 68
960ccca6
DH
69static int zlib_compression_seen;
70
3c8687a7
TA
71/*
72 * Default config_set that contains key-value pairs from the usual set of config
73 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
74 * config file and the global /etc/gitconfig)
75 */
76static struct config_set the_config_set;
77
4d8dd149
HV
78static int config_file_fgetc(struct config_source *conf)
79{
260d408e 80 return getc_unlocked(conf->u.file);
4d8dd149
HV
81}
82
83static int config_file_ungetc(int c, struct config_source *conf)
84{
85 return ungetc(c, conf->u.file);
86}
87
88static long config_file_ftell(struct config_source *conf)
89{
90 return ftell(conf->u.file);
91}
92
1bc88819
HV
93
94static int config_buf_fgetc(struct config_source *conf)
95{
96 if (conf->u.buf.pos < conf->u.buf.len)
97 return conf->u.buf.buf[conf->u.buf.pos++];
98
99 return EOF;
100}
101
102static int config_buf_ungetc(int c, struct config_source *conf)
103{
1d0655c1
JK
104 if (conf->u.buf.pos > 0) {
105 conf->u.buf.pos--;
106 if (conf->u.buf.buf[conf->u.buf.pos] != c)
107 die("BUG: config_buf can only ungetc the same character");
108 return c;
109 }
1bc88819
HV
110
111 return EOF;
112}
113
114static long config_buf_ftell(struct config_source *conf)
115{
116 return conf->u.buf.pos;
117}
118
9b25a0b5
JK
119#define MAX_INCLUDE_DEPTH 10
120static const char include_depth_advice[] =
121"exceeded maximum include depth (%d) while including\n"
122" %s\n"
123"from\n"
124" %s\n"
125"Do you have circular includes?";
126static int handle_path_include(const char *path, struct config_include_data *inc)
127{
128 int ret = 0;
129 struct strbuf buf = STRBUF_INIT;
67beb600 130 char *expanded;
4c0a89fc 131
67beb600
JK
132 if (!path)
133 return config_error_nonbool("include.path");
134
135 expanded = expand_user_path(path);
4c0a89fc 136 if (!expanded)
8c3ca351 137 return error("could not expand include path '%s'", path);
4c0a89fc 138 path = expanded;
9b25a0b5
JK
139
140 /*
141 * Use an absolute path as-is, but interpret relative paths
142 * based on the including config file.
143 */
144 if (!is_absolute_path(path)) {
145 char *slash;
146
d14d4244 147 if (!cf || !cf->path)
9b25a0b5
JK
148 return error("relative config includes must come from files");
149
d14d4244 150 slash = find_last_dir_sep(cf->path);
9b25a0b5 151 if (slash)
d14d4244 152 strbuf_add(&buf, cf->path, slash - cf->path + 1);
9b25a0b5
JK
153 strbuf_addstr(&buf, path);
154 path = buf.buf;
155 }
156
4698c8fe 157 if (!access_or_die(path, R_OK, 0)) {
9b25a0b5
JK
158 if (++inc->depth > MAX_INCLUDE_DEPTH)
159 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
3258258f
JK
160 !cf ? "<unknown>" :
161 cf->name ? cf->name :
162 "the command line");
9b25a0b5
JK
163 ret = git_config_from_file(git_config_include, path, inc);
164 inc->depth--;
165 }
166 strbuf_release(&buf);
4c0a89fc 167 free(expanded);
9b25a0b5
JK
168 return ret;
169}
170
171int git_config_include(const char *var, const char *value, void *data)
172{
173 struct config_include_data *inc = data;
9b25a0b5
JK
174 int ret;
175
176 /*
177 * Pass along all values, including "include" directives; this makes it
178 * possible to query information on the includes themselves.
179 */
180 ret = inc->fn(var, value, inc->data);
181 if (ret < 0)
182 return ret;
183
37007c3a 184 if (!strcmp(var, "include.path"))
9b25a0b5
JK
185 ret = handle_path_include(value, inc);
186 return ret;
187}
188
2b64fc89
JK
189void git_config_push_parameter(const char *text)
190{
191 struct strbuf env = STRBUF_INIT;
192 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
d1f88498 193 if (old && *old) {
2b64fc89
JK
194 strbuf_addstr(&env, old);
195 strbuf_addch(&env, ' ');
196 }
197 sq_quote_buf(&env, text);
198 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
199 strbuf_release(&env);
200}
201
ee98df3f
JH
202static inline int iskeychar(int c)
203{
204 return isalnum(c) || c == '-';
205}
206
207/*
208 * Auxiliary function to sanity-check and split the key into the section
209 * identifier and variable name.
210 *
211 * Returns 0 on success, -1 when there is an invalid character in the key and
212 * -2 if there is no section name in the key.
213 *
214 * store_key - pointer to char* which will hold a copy of the key with
215 * lowercase section and variable name
216 * baselen - pointer to int which will hold the length of the
217 * section + subsection part, can be NULL
218 */
219static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
220{
221 int i, dot, baselen;
222 const char *last_dot = strrchr(key, '.');
223
224 /*
225 * Since "key" actually contains the section name and the real
226 * key name separated by a dot, we have to know where the dot is.
227 */
228
229 if (last_dot == NULL || last_dot == key) {
230 if (!quiet)
231 error("key does not contain a section: %s", key);
232 return -CONFIG_NO_SECTION_OR_NAME;
233 }
234
235 if (!last_dot[1]) {
236 if (!quiet)
237 error("key does not contain variable name: %s", key);
238 return -CONFIG_NO_SECTION_OR_NAME;
239 }
240
241 baselen = last_dot - key;
242 if (baselen_)
243 *baselen_ = baselen;
244
245 /*
246 * Validate the key and while at it, lower case it for matching.
247 */
248 if (store_key)
249 *store_key = xmallocz(strlen(key));
250
251 dot = 0;
252 for (i = 0; key[i]; i++) {
253 unsigned char c = key[i];
254 if (c == '.')
255 dot = 1;
256 /* Leave the extended basename untouched.. */
257 if (!dot || i > baselen) {
258 if (!iskeychar(c) ||
259 (i == baselen + 1 && !isalpha(c))) {
260 if (!quiet)
261 error("invalid key: %s", key);
262 goto out_free_ret_1;
263 }
264 c = tolower(c);
265 } else if (c == '\n') {
266 if (!quiet)
267 error("invalid key (newline): %s", key);
268 goto out_free_ret_1;
269 }
270 if (store_key)
271 (*store_key)[i] = c;
272 }
273
274 return 0;
275
276out_free_ret_1:
277 if (store_key) {
278 free(*store_key);
279 *store_key = NULL;
280 }
281 return -CONFIG_INVALID_KEY;
282}
283
284int git_config_parse_key(const char *key, char **store_key, int *baselen)
285{
286 return git_config_parse_key_1(key, store_key, baselen, 0);
287}
288
289int git_config_key_is_valid(const char *key)
290{
291 return !git_config_parse_key_1(key, NULL, NULL, 1);
292}
293
2496844b
JK
294int git_config_parse_parameter(const char *text,
295 config_fn_t fn, void *data)
8b1fa778 296{
a789ca70 297 const char *value;
572e4f6a 298 struct strbuf **pair;
a789ca70 299
f77bccae 300 pair = strbuf_split_str(text, '=', 2);
c5d6350b
JK
301 if (!pair[0])
302 return error("bogus config parameter: %s", text);
a789ca70
JH
303
304 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
572e4f6a 305 strbuf_setlen(pair[0], pair[0]->len - 1);
a789ca70
JH
306 value = pair[1] ? pair[1]->buf : "";
307 } else {
308 value = NULL;
309 }
310
572e4f6a
AR
311 strbuf_trim(pair[0]);
312 if (!pair[0]->len) {
313 strbuf_list_free(pair);
06eb708f 314 return error("bogus config parameter: %s", text);
8b1fa778 315 }
ffb20ce1 316 strbuf_tolower(pair[0]);
a789ca70 317 if (fn(pair[0]->buf, value, data) < 0) {
06eb708f
JK
318 strbuf_list_free(pair);
319 return -1;
572e4f6a
AR
320 }
321 strbuf_list_free(pair);
8b1fa778
AR
322 return 0;
323}
324
06eb708f
JK
325int git_config_from_parameters(config_fn_t fn, void *data)
326{
2b64fc89 327 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
a77d6db6 328 int ret = 0;
2b64fc89
JK
329 char *envw;
330 const char **argv = NULL;
331 int nr = 0, alloc = 0;
332 int i;
3258258f 333 struct config_source source;
2b64fc89
JK
334
335 if (!env)
336 return 0;
3258258f
JK
337
338 memset(&source, 0, sizeof(source));
339 source.prev = cf;
1b8132d9 340 source.origin_type = CONFIG_ORIGIN_CMDLINE;
3258258f
JK
341 cf = &source;
342
2b64fc89
JK
343 /* sq_dequote will write over it */
344 envw = xstrdup(env);
345
346 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
a77d6db6
JK
347 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
348 goto out;
2b64fc89
JK
349 }
350
351 for (i = 0; i < nr; i++) {
06eb708f 352 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
a77d6db6
JK
353 ret = -1;
354 goto out;
2b64fc89
JK
355 }
356 }
357
a77d6db6 358out:
2b64fc89
JK
359 free(argv);
360 free(envw);
3258258f 361 cf = source.prev;
a77d6db6 362 return ret;
2b64fc89
JK
363}
364
17712991
LT
365static int get_next_char(void)
366{
49d6cfa5 367 int c = cf->do_fgetc(cf);
17712991 368
dbb9a812
HV
369 if (c == '\r') {
370 /* DOS like systems */
49d6cfa5 371 c = cf->do_fgetc(cf);
dbb9a812 372 if (c != '\n') {
5e0be134
JK
373 if (c != EOF)
374 cf->do_ungetc(c, cf);
dbb9a812 375 c = '\r';
17712991
LT
376 }
377 }
dbb9a812
HV
378 if (c == '\n')
379 cf->linenr++;
380 if (c == EOF) {
381 cf->eof = 1;
b3b3f60b 382 cf->linenr++;
dbb9a812
HV
383 c = '\n';
384 }
17712991
LT
385 return c;
386}
387
388static char *parse_value(void)
389{
e96c19c5 390 int quote = 0, comment = 0, space = 0;
17712991 391
924aaf3e 392 strbuf_reset(&cf->value);
17712991
LT
393 for (;;) {
394 int c = get_next_char();
17712991 395 if (c == '\n') {
4b340593
MS
396 if (quote) {
397 cf->linenr--;
17712991 398 return NULL;
4b340593 399 }
924aaf3e 400 return cf->value.buf;
17712991
LT
401 }
402 if (comment)
403 continue;
404 if (isspace(c) && !quote) {
924aaf3e 405 if (cf->value.len)
ebdaae37 406 space++;
17712991
LT
407 continue;
408 }
7ebdba61
JS
409 if (!quote) {
410 if (c == ';' || c == '#') {
411 comment = 1;
412 continue;
413 }
414 }
ebdaae37 415 for (; space; space--)
924aaf3e 416 strbuf_addch(&cf->value, ' ');
17712991
LT
417 if (c == '\\') {
418 c = get_next_char();
419 switch (c) {
420 case '\n':
421 continue;
422 case 't':
423 c = '\t';
424 break;
425 case 'b':
426 c = '\b';
427 break;
428 case 'n':
429 c = '\n';
430 break;
5cbb401d
LT
431 /* Some characters escape as themselves */
432 case '\\': case '"':
433 break;
434 /* Reject unknown escape sequences */
435 default:
436 return NULL;
17712991 437 }
924aaf3e 438 strbuf_addch(&cf->value, c);
17712991
LT
439 continue;
440 }
441 if (c == '"') {
442 quote = 1-quote;
443 continue;
444 }
924aaf3e 445 strbuf_addch(&cf->value, c);
17712991
LT
446 }
447}
448
0971e992 449static int get_value(config_fn_t fn, void *data, struct strbuf *name)
17712991
LT
450{
451 int c;
452 char *value;
b3b3f60b 453 int ret;
17712991
LT
454
455 /* Get the full name */
456 for (;;) {
457 c = get_next_char();
924aaf3e 458 if (cf->eof)
17712991 459 break;
38c5afa8 460 if (!iskeychar(c))
17712991 461 break;
0971e992 462 strbuf_addch(name, tolower(c));
17712991 463 }
0971e992 464
17712991
LT
465 while (c == ' ' || c == '\t')
466 c = get_next_char();
467
468 value = NULL;
469 if (c != '\n') {
470 if (c != '=')
471 return -1;
472 value = parse_value();
473 if (!value)
474 return -1;
475 }
b3b3f60b
MM
476 /*
477 * We already consumed the \n, but we need linenr to point to
478 * the line we just parsed during the call to fn to get
479 * accurate line number in error messages.
480 */
481 cf->linenr--;
482 ret = fn(name->buf, value, data);
483 cf->linenr++;
484 return ret;
17712991
LT
485}
486
0971e992 487static int get_extended_base_var(struct strbuf *name, int c)
d14f7764
LT
488{
489 do {
490 if (c == '\n')
4b340593 491 goto error_incomplete_line;
d14f7764
LT
492 c = get_next_char();
493 } while (isspace(c));
494
495 /* We require the format to be '[base "extension"]' */
496 if (c != '"')
497 return -1;
0971e992 498 strbuf_addch(name, '.');
d14f7764
LT
499
500 for (;;) {
501 int c = get_next_char();
502 if (c == '\n')
4b340593 503 goto error_incomplete_line;
d14f7764
LT
504 if (c == '"')
505 break;
506 if (c == '\\') {
507 c = get_next_char();
508 if (c == '\n')
4b340593 509 goto error_incomplete_line;
d14f7764 510 }
0971e992 511 strbuf_addch(name, c);
d14f7764
LT
512 }
513
514 /* Final ']' */
515 if (get_next_char() != ']')
516 return -1;
0971e992 517 return 0;
4b340593
MS
518error_incomplete_line:
519 cf->linenr--;
520 return -1;
d14f7764
LT
521}
522
0971e992 523static int get_base_var(struct strbuf *name)
17712991 524{
17712991
LT
525 for (;;) {
526 int c = get_next_char();
924aaf3e 527 if (cf->eof)
17712991
LT
528 return -1;
529 if (c == ']')
0971e992 530 return 0;
d14f7764 531 if (isspace(c))
0971e992 532 return get_extended_base_var(name, c);
38c5afa8 533 if (!iskeychar(c) && c != '.')
17712991 534 return -1;
0971e992 535 strbuf_addch(name, tolower(c));
17712991
LT
536 }
537}
538
4d8dd149 539static int git_parse_source(config_fn_t fn, void *data)
17712991
LT
540{
541 int comment = 0;
542 int baselen = 0;
0971e992 543 struct strbuf *var = &cf->var;
1b8132d9
VA
544 int error_return = 0;
545 char *error_msg = NULL;
17712991 546
de056402 547 /* U+FEFF Byte Order Mark in UTF8 */
599446dc 548 const char *bomptr = utf8_bom;
de056402 549
17712991
LT
550 for (;;) {
551 int c = get_next_char();
de056402
PB
552 if (bomptr && *bomptr) {
553 /* We are at the file beginning; skip UTF8-encoded BOM
554 * if present. Sane editors won't put this in on their
555 * own, but e.g. Windows Notepad will do it happily. */
599446dc 556 if (c == (*bomptr & 0377)) {
de056402
PB
557 bomptr++;
558 continue;
559 } else {
560 /* Do not tolerate partial BOM. */
561 if (bomptr != utf8_bom)
562 break;
563 /* No BOM at file beginning. Cool. */
564 bomptr = NULL;
565 }
566 }
17712991 567 if (c == '\n') {
924aaf3e 568 if (cf->eof)
17712991
LT
569 return 0;
570 comment = 0;
571 continue;
572 }
573 if (comment || isspace(c))
574 continue;
575 if (c == '#' || c == ';') {
576 comment = 1;
577 continue;
578 }
579 if (c == '[') {
0971e992
BW
580 /* Reset prior to determining a new stem */
581 strbuf_reset(var);
582 if (get_base_var(var) < 0 || var->len < 1)
17712991 583 break;
0971e992
BW
584 strbuf_addch(var, '.');
585 baselen = var->len;
17712991
LT
586 continue;
587 }
588 if (!isalpha(c))
589 break;
0971e992
BW
590 /*
591 * Truncate the var name back to the section header
592 * stem prior to grabbing the suffix part of the name
593 * and the value.
594 */
595 strbuf_setlen(var, baselen);
596 strbuf_addch(var, tolower(c));
597 if (get_value(fn, data, var) < 0)
17712991
LT
598 break;
599 }
1b8132d9
VA
600
601 switch (cf->origin_type) {
602 case CONFIG_ORIGIN_BLOB:
603 error_msg = xstrfmt(_("bad config line %d in blob %s"),
604 cf->linenr, cf->name);
605 break;
606 case CONFIG_ORIGIN_FILE:
607 error_msg = xstrfmt(_("bad config line %d in file %s"),
608 cf->linenr, cf->name);
609 break;
610 case CONFIG_ORIGIN_STDIN:
611 error_msg = xstrfmt(_("bad config line %d in standard input"),
612 cf->linenr);
613 break;
614 case CONFIG_ORIGIN_SUBMODULE_BLOB:
615 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
616 cf->linenr, cf->name);
617 break;
618 case CONFIG_ORIGIN_CMDLINE:
619 error_msg = xstrfmt(_("bad config line %d in command line %s"),
620 cf->linenr, cf->name);
621 break;
622 default:
623 error_msg = xstrfmt(_("bad config line %d in %s"),
624 cf->linenr, cf->name);
625 }
626
b2dc0945 627 if (cf->die_on_error)
1b8132d9 628 die("%s", error_msg);
b2dc0945 629 else
1b8132d9
VA
630 error_return = error("%s", error_msg);
631
632 free(error_msg);
633 return error_return;
17712991
LT
634}
635
ebaa1bd4 636static int parse_unit_factor(const char *end, uintmax_t *val)
0b87b6e0
BD
637{
638 if (!*end)
639 return 1;
c8deb5a1
SP
640 else if (!strcasecmp(end, "k")) {
641 *val *= 1024;
642 return 1;
643 }
644 else if (!strcasecmp(end, "m")) {
645 *val *= 1024 * 1024;
646 return 1;
647 }
648 else if (!strcasecmp(end, "g")) {
649 *val *= 1024 * 1024 * 1024;
650 return 1;
651 }
652 return 0;
0b87b6e0
BD
653}
654
7192777d 655static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
0b87b6e0
BD
656{
657 if (value && *value) {
658 char *end;
ebaa1bd4
NA
659 intmax_t val;
660 uintmax_t uval;
661 uintmax_t factor = 1;
662
663 errno = 0;
664 val = strtoimax(value, &end, 0);
665 if (errno == ERANGE)
666 return 0;
33fdd77e
JK
667 if (!parse_unit_factor(end, &factor)) {
668 errno = EINVAL;
c8deb5a1 669 return 0;
33fdd77e 670 }
83915ba5 671 uval = labs(val);
ebaa1bd4 672 uval *= factor;
83915ba5 673 if (uval > max || labs(val) > uval) {
33fdd77e 674 errno = ERANGE;
ebaa1bd4 675 return 0;
33fdd77e 676 }
ebaa1bd4
NA
677 val *= factor;
678 *ret = val;
0b87b6e0
BD
679 return 1;
680 }
33fdd77e 681 errno = EINVAL;
0b87b6e0
BD
682 return 0;
683}
684
0b4dc661 685static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
17712991
LT
686{
687 if (value && *value) {
688 char *end;
ebaa1bd4
NA
689 uintmax_t val;
690 uintmax_t oldval;
691
692 errno = 0;
693 val = strtoumax(value, &end, 0);
694 if (errno == ERANGE)
695 return 0;
696 oldval = val;
33fdd77e
JK
697 if (!parse_unit_factor(end, &val)) {
698 errno = EINVAL;
c8deb5a1 699 return 0;
33fdd77e
JK
700 }
701 if (val > max || oldval > val) {
702 errno = ERANGE;
ebaa1bd4 703 return 0;
33fdd77e 704 }
c8deb5a1 705 *ret = val;
0b87b6e0 706 return 1;
17712991 707 }
33fdd77e 708 errno = EINVAL;
0b87b6e0
BD
709 return 0;
710}
711
42d194e9 712static int git_parse_int(const char *value, int *ret)
c1867cea 713{
7192777d 714 intmax_t tmp;
42d194e9 715 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
7192777d
JK
716 return 0;
717 *ret = tmp;
718 return 1;
719}
720
00160242
JK
721static int git_parse_int64(const char *value, int64_t *ret)
722{
723 intmax_t tmp;
724 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
725 return 0;
726 *ret = tmp;
727 return 1;
728}
729
7192777d
JK
730int git_parse_ulong(const char *value, unsigned long *ret)
731{
732 uintmax_t tmp;
733 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
734 return 0;
735 *ret = tmp;
736 return 1;
737}
738
06bdc23b 739NORETURN
2f666581 740static void die_bad_number(const char *name, const char *value)
c1867cea 741{
078fe305
JNA
742 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
743
2f666581
JK
744 if (!value)
745 value = "";
746
1b8132d9 747 if (!(cf && cf->name))
078fe305
JNA
748 die(_("bad numeric config value '%s' for '%s': %s"),
749 value, name, error_type);
1b8132d9
VA
750
751 switch (cf->origin_type) {
752 case CONFIG_ORIGIN_BLOB:
078fe305
JNA
753 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
754 value, name, cf->name, error_type);
1b8132d9 755 case CONFIG_ORIGIN_FILE:
078fe305
JNA
756 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
757 value, name, cf->name, error_type);
1b8132d9 758 case CONFIG_ORIGIN_STDIN:
078fe305
JNA
759 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
760 value, name, error_type);
1b8132d9 761 case CONFIG_ORIGIN_SUBMODULE_BLOB:
078fe305
JNA
762 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
763 value, name, cf->name, error_type);
1b8132d9 764 case CONFIG_ORIGIN_CMDLINE:
078fe305
JNA
765 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
766 value, name, cf->name, error_type);
1b8132d9 767 default:
078fe305
JNA
768 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
769 value, name, cf->name, error_type);
1b8132d9 770 }
c1867cea
JK
771}
772
0b87b6e0
BD
773int git_config_int(const char *name, const char *value)
774{
42d194e9
JK
775 int ret;
776 if (!git_parse_int(value, &ret))
2f666581 777 die_bad_number(name, value);
0b87b6e0
BD
778 return ret;
779}
780
00160242
JK
781int64_t git_config_int64(const char *name, const char *value)
782{
783 int64_t ret;
784 if (!git_parse_int64(value, &ret))
785 die_bad_number(name, value);
0b87b6e0
BD
786 return ret;
787}
788
789unsigned long git_config_ulong(const char *name, const char *value)
790{
791 unsigned long ret;
792 if (!git_parse_ulong(value, &ret))
2f666581 793 die_bad_number(name, value);
0b87b6e0 794 return ret;
17712991
LT
795}
796
9a549d43 797int git_parse_maybe_bool(const char *value)
17712991
LT
798{
799 if (!value)
800 return 1;
801 if (!*value)
802 return 0;
8420ccd8
JH
803 if (!strcasecmp(value, "true")
804 || !strcasecmp(value, "yes")
805 || !strcasecmp(value, "on"))
17712991 806 return 1;
8420ccd8
JH
807 if (!strcasecmp(value, "false")
808 || !strcasecmp(value, "no")
809 || !strcasecmp(value, "off"))
17712991 810 return 0;
8420ccd8
JH
811 return -1;
812}
813
b2be2f6a
JK
814int git_config_maybe_bool(const char *name, const char *value)
815{
9a549d43 816 int v = git_parse_maybe_bool(value);
b2be2f6a
JK
817 if (0 <= v)
818 return v;
42d194e9 819 if (git_parse_int(value, &v))
db6195ef 820 return !!v;
b2be2f6a
JK
821 return -1;
822}
823
8420ccd8
JH
824int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
825{
9a549d43 826 int v = git_parse_maybe_bool(value);
8420ccd8
JH
827 if (0 <= v) {
828 *is_bool = 1;
829 return v;
830 }
a53f2ec6 831 *is_bool = 0;
c35b0b58 832 return git_config_int(name, value);
17712991
LT
833}
834
a53f2ec6
JH
835int git_config_bool(const char *name, const char *value)
836{
837 int discard;
c35b0b58 838 return !!git_config_bool_or_int(name, value, &discard);
a53f2ec6
JH
839}
840
ea5105a5
CC
841int git_config_string(const char **dest, const char *var, const char *value)
842{
843 if (!value)
844 return config_error_nonbool(var);
845 *dest = xstrdup(value);
846 return 0;
847}
848
395de250
MM
849int git_config_pathname(const char **dest, const char *var, const char *value)
850{
851 if (!value)
852 return config_error_nonbool(var);
853 *dest = expand_user_path(value);
854 if (!*dest)
8262aaa2 855 die(_("failed to expand user dir in: '%s'"), value);
395de250
MM
856 return 0;
857}
858
806e2ad7 859static int git_default_core_config(const char *var, const char *value)
17712991
LT
860{
861 /* This needs a better name */
862 if (!strcmp(var, "core.filemode")) {
863 trust_executable_bit = git_config_bool(var, value);
864 return 0;
865 }
1ce4790b
AR
866 if (!strcmp(var, "core.trustctime")) {
867 trust_ctime = git_config_bool(var, value);
868 return 0;
869 }
c1b5d738 870 if (!strcmp(var, "core.checkstat")) {
c08e4d5b
RR
871 if (!strcasecmp(value, "default"))
872 check_stat = 1;
873 else if (!strcasecmp(value, "minimal"))
874 check_stat = 0;
875 }
17712991 876
9378c161
JH
877 if (!strcmp(var, "core.quotepath")) {
878 quote_path_fully = git_config_bool(var, value);
879 return 0;
880 }
881
78a8d641
JS
882 if (!strcmp(var, "core.symlinks")) {
883 has_symlinks = git_config_bool(var, value);
884 return 0;
885 }
886
0a9b88b7
LT
887 if (!strcmp(var, "core.ignorecase")) {
888 ignore_case = git_config_bool(var, value);
889 return 0;
890 }
891
64589a03
JH
892 if (!strcmp(var, "core.attributesfile"))
893 return git_config_pathname(&git_attributes_file, var, value);
894
867ad08a
ÆAB
895 if (!strcmp(var, "core.hookspath"))
896 return git_config_pathname(&git_hooks_path, var, value);
897
7d1864ce
JH
898 if (!strcmp(var, "core.bare")) {
899 is_bare_repository_cfg = git_config_bool(var, value);
900 return 0;
901 }
902
5f73076c
JH
903 if (!strcmp(var, "core.ignorestat")) {
904 assume_unchanged = git_config_bool(var, value);
905 return 0;
906 }
907
e388c738
JH
908 if (!strcmp(var, "core.prefersymlinkrefs")) {
909 prefer_symlink_refs = git_config_bool(var, value);
f8348be3
JS
910 return 0;
911 }
912
6de08ae6
SP
913 if (!strcmp(var, "core.logallrefupdates")) {
914 log_all_ref_updates = git_config_bool(var, value);
915 return 0;
916 }
917
2f8acdb3
JH
918 if (!strcmp(var, "core.warnambiguousrefs")) {
919 warn_ambiguous_refs = git_config_bool(var, value);
920 return 0;
921 }
922
a71f09fe 923 if (!strcmp(var, "core.abbrev")) {
dce96489
LT
924 int abbrev = git_config_int(var, value);
925 if (abbrev < minimum_abbrev || abbrev > 40)
926 return -1;
927 default_abbrev = abbrev;
928 return 0;
929 }
930
960ccca6 931 if (!strcmp(var, "core.loosecompression")) {
12f6c308
JBH
932 int level = git_config_int(var, value);
933 if (level == -1)
934 level = Z_DEFAULT_COMPRESSION;
935 else if (level < 0 || level > Z_BEST_COMPRESSION)
8262aaa2 936 die(_("bad zlib compression level %d"), level);
12f6c308 937 zlib_compression_level = level;
960ccca6
DH
938 zlib_compression_seen = 1;
939 return 0;
940 }
941
942 if (!strcmp(var, "core.compression")) {
943 int level = git_config_int(var, value);
944 if (level == -1)
945 level = Z_DEFAULT_COMPRESSION;
946 else if (level < 0 || level > Z_BEST_COMPRESSION)
8262aaa2 947 die(_("bad zlib compression level %d"), level);
960ccca6
DH
948 core_compression_level = level;
949 core_compression_seen = 1;
950 if (!zlib_compression_seen)
951 zlib_compression_level = level;
12f6c308
JBH
952 return 0;
953 }
954
60bb8b14 955 if (!strcmp(var, "core.packedgitwindowsize")) {
5faaf246 956 int pgsz_x2 = getpagesize() * 2;
ebaa1bd4 957 packed_git_window_size = git_config_ulong(var, value);
5faaf246
JH
958
959 /* This value must be multiple of (pagesize * 2) */
960 packed_git_window_size /= pgsz_x2;
961 if (packed_git_window_size < 1)
962 packed_git_window_size = 1;
963 packed_git_window_size *= pgsz_x2;
60bb8b14
SP
964 return 0;
965 }
966
15366280 967 if (!strcmp(var, "core.bigfilethreshold")) {
ebaa1bd4 968 big_file_threshold = git_config_ulong(var, value);
15366280
JH
969 return 0;
970 }
971
77ccc5bb 972 if (!strcmp(var, "core.packedgitlimit")) {
ebaa1bd4 973 packed_git_limit = git_config_ulong(var, value);
77ccc5bb
SP
974 return 0;
975 }
976
18bdec11 977 if (!strcmp(var, "core.deltabasecachelimit")) {
ebaa1bd4 978 delta_base_cache_limit = git_config_ulong(var, value);
18bdec11
SP
979 return 0;
980 }
981
6c510bee 982 if (!strcmp(var, "core.autocrlf")) {
d7f46334 983 if (value && !strcasecmp(value, "input")) {
fd6cce9e 984 auto_crlf = AUTO_CRLF_INPUT;
d7f46334
LT
985 return 0;
986 }
6c510bee
LT
987 auto_crlf = git_config_bool(var, value);
988 return 0;
989 }
990
21e5ad50
SP
991 if (!strcmp(var, "core.safecrlf")) {
992 if (value && !strcasecmp(value, "warn")) {
993 safe_crlf = SAFE_CRLF_WARN;
994 return 0;
995 }
996 safe_crlf = git_config_bool(var, value);
997 return 0;
998 }
999
942e7747
EB
1000 if (!strcmp(var, "core.eol")) {
1001 if (value && !strcasecmp(value, "lf"))
ec70f52f 1002 core_eol = EOL_LF;
942e7747 1003 else if (value && !strcasecmp(value, "crlf"))
ec70f52f 1004 core_eol = EOL_CRLF;
942e7747 1005 else if (value && !strcasecmp(value, "native"))
ec70f52f 1006 core_eol = EOL_NATIVE;
942e7747 1007 else
ec70f52f 1008 core_eol = EOL_UNSET;
942e7747
EB
1009 return 0;
1010 }
1011
a97a7468
JS
1012 if (!strcmp(var, "core.notesref")) {
1013 notes_ref_name = xstrdup(value);
1014 return 0;
1015 }
1016
806e2ad7
LT
1017 if (!strcmp(var, "core.pager"))
1018 return git_config_string(&pager_program, var, value);
1019
1020 if (!strcmp(var, "core.editor"))
1021 return git_config_string(&editor_program, var, value);
1022
eff80a9f 1023 if (!strcmp(var, "core.commentchar")) {
649409b7
JK
1024 if (!value)
1025 return config_error_nonbool(var);
ad524f83 1026 else if (!strcasecmp(value, "auto"))
84c9dc2c 1027 auto_comment_line_char = 1;
ad524f83 1028 else if (value[0] && !value[1]) {
649409b7 1029 comment_line_char = value[0];
84c9dc2c 1030 auto_comment_line_char = 0;
50b54fd7
NTND
1031 } else
1032 return error("core.commentChar should only be one character");
1033 return 0;
eff80a9f
JH
1034 }
1035
d3e7da89
AK
1036 if (!strcmp(var, "core.askpass"))
1037 return git_config_string(&askpass_program, var, value);
1038
806e2ad7 1039 if (!strcmp(var, "core.excludesfile"))
395de250 1040 return git_config_pathname(&excludes_file, var, value);
806e2ad7
LT
1041
1042 if (!strcmp(var, "core.whitespace")) {
1043 if (!value)
1044 return config_error_nonbool(var);
1045 whitespace_rule_cfg = parse_whitespace_rule(value);
1046 return 0;
1047 }
1048
aafe9fba
LT
1049 if (!strcmp(var, "core.fsyncobjectfiles")) {
1050 fsync_object_files = git_config_bool(var, value);
1051 return 0;
1052 }
1053
671c9b7e
LT
1054 if (!strcmp(var, "core.preloadindex")) {
1055 core_preload_index = git_config_bool(var, value);
1056 return 0;
1057 }
1058
348df166
JS
1059 if (!strcmp(var, "core.createobject")) {
1060 if (!strcmp(value, "rename"))
1061 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1062 else if (!strcmp(value, "link"))
1063 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1064 else
8262aaa2 1065 die(_("invalid mode for object creation: %s"), value);
be66a6c4
JS
1066 return 0;
1067 }
1068
08aefc9e
NTND
1069 if (!strcmp(var, "core.sparsecheckout")) {
1070 core_apply_sparse_checkout = git_config_bool(var, value);
1071 return 0;
1072 }
1073
76759c7d
TB
1074 if (!strcmp(var, "core.precomposeunicode")) {
1075 precomposed_unicode = git_config_bool(var, value);
1076 return 0;
1077 }
1078
a42643aa
JK
1079 if (!strcmp(var, "core.protecthfs")) {
1080 protect_hfs = git_config_bool(var, value);
1081 return 0;
1082 }
1083
2b4c6efc
JS
1084 if (!strcmp(var, "core.protectntfs")) {
1085 protect_ntfs = git_config_bool(var, value);
1086 return 0;
76759c7d
TB
1087 }
1088
f30afdab
JS
1089 if (!strcmp(var, "core.hidedotfiles")) {
1090 if (value && !strcasecmp(value, "dotgitonly"))
1091 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1092 else
1093 hide_dotfiles = git_config_bool(var, value);
1094 return 0;
1095 }
1096
806e2ad7
LT
1097 /* Add other config variables here and to Documentation/config.txt. */
1098 return 0;
1099}
1100
1141f492 1101static int git_default_i18n_config(const char *var, const char *value)
d1364529 1102{
ea5105a5
CC
1103 if (!strcmp(var, "i18n.commitencoding"))
1104 return git_config_string(&git_commit_encoding, var, value);
d2c11a38 1105
ea5105a5
CC
1106 if (!strcmp(var, "i18n.logoutputencoding"))
1107 return git_config_string(&git_log_output_encoding, var, value);
d2c11a38 1108
1141f492
LT
1109 /* Add other config variables here and to Documentation/config.txt. */
1110 return 0;
1111}
039bc64e 1112
1141f492
LT
1113static int git_default_branch_config(const char *var, const char *value)
1114{
9ed36cfa
JS
1115 if (!strcmp(var, "branch.autosetupmerge")) {
1116 if (value && !strcasecmp(value, "always")) {
1117 git_branch_track = BRANCH_TRACK_ALWAYS;
1118 return 0;
1119 }
1120 git_branch_track = git_config_bool(var, value);
1121 return 0;
1122 }
c998ae9b
DS
1123 if (!strcmp(var, "branch.autosetuprebase")) {
1124 if (!value)
1125 return config_error_nonbool(var);
1126 else if (!strcmp(value, "never"))
1127 autorebase = AUTOREBASE_NEVER;
1128 else if (!strcmp(value, "local"))
1129 autorebase = AUTOREBASE_LOCAL;
1130 else if (!strcmp(value, "remote"))
1131 autorebase = AUTOREBASE_REMOTE;
1132 else if (!strcmp(value, "always"))
1133 autorebase = AUTOREBASE_ALWAYS;
1134 else
8c3ca351 1135 return error("malformed value for %s", var);
c998ae9b
DS
1136 return 0;
1137 }
a9cc857a 1138
1ab661dd 1139 /* Add other config variables here and to Documentation/config.txt. */
17712991
LT
1140 return 0;
1141}
1142
52153747
FAG
1143static int git_default_push_config(const char *var, const char *value)
1144{
1145 if (!strcmp(var, "push.default")) {
1146 if (!value)
1147 return config_error_nonbool(var);
1148 else if (!strcmp(value, "nothing"))
1149 push_default = PUSH_DEFAULT_NOTHING;
1150 else if (!strcmp(value, "matching"))
1151 push_default = PUSH_DEFAULT_MATCHING;
b55e6775
MM
1152 else if (!strcmp(value, "simple"))
1153 push_default = PUSH_DEFAULT_SIMPLE;
53c40311
JH
1154 else if (!strcmp(value, "upstream"))
1155 push_default = PUSH_DEFAULT_UPSTREAM;
1156 else if (!strcmp(value, "tracking")) /* deprecated */
1157 push_default = PUSH_DEFAULT_UPSTREAM;
52153747
FAG
1158 else if (!strcmp(value, "current"))
1159 push_default = PUSH_DEFAULT_CURRENT;
1160 else {
8c3ca351 1161 error("malformed value for %s: %s", var, value);
b55e6775
MM
1162 return error("Must be one of nothing, matching, simple, "
1163 "upstream or current.");
52153747
FAG
1164 }
1165 return 0;
1166 }
1167
1168 /* Add other config variables here and to Documentation/config.txt. */
1169 return 0;
1170}
1171
d551a488
MSO
1172static int git_default_mailmap_config(const char *var, const char *value)
1173{
1174 if (!strcmp(var, "mailmap.file"))
9352fd57 1175 return git_config_pathname(&git_mailmap_file, var, value);
08610900
JK
1176 if (!strcmp(var, "mailmap.blob"))
1177 return git_config_string(&git_mailmap_blob, var, value);
d551a488
MSO
1178
1179 /* Add other config variables here and to Documentation/config.txt. */
1180 return 0;
1181}
1182
1141f492
LT
1183int git_default_config(const char *var, const char *value, void *dummy)
1184{
59556548 1185 if (starts_with(var, "core."))
1141f492
LT
1186 return git_default_core_config(var, value);
1187
59556548 1188 if (starts_with(var, "user."))
9597921b 1189 return git_ident_config(var, value, dummy);
1141f492 1190
59556548 1191 if (starts_with(var, "i18n."))
1141f492
LT
1192 return git_default_i18n_config(var, value);
1193
59556548 1194 if (starts_with(var, "branch."))
1141f492
LT
1195 return git_default_branch_config(var, value);
1196
59556548 1197 if (starts_with(var, "push."))
52153747
FAG
1198 return git_default_push_config(var, value);
1199
59556548 1200 if (starts_with(var, "mailmap."))
d551a488
MSO
1201 return git_default_mailmap_config(var, value);
1202
59556548 1203 if (starts_with(var, "advice."))
75194438
JK
1204 return git_default_advice_config(var, value);
1205
1141f492
LT
1206 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1207 pager_use_color = git_config_bool(var,value);
1208 return 0;
1209 }
1210
568508e7
JH
1211 if (!strcmp(var, "pack.packsizelimit")) {
1212 pack_size_limit_cfg = git_config_ulong(var, value);
1213 return 0;
1214 }
1141f492
LT
1215 /* Add other config variables here and to Documentation/config.txt. */
1216 return 0;
1217}
1218
ca4b5de2 1219/*
b2dc0945 1220 * All source specific fields in the union, die_on_error, name and the callbacks
4d8dd149 1221 * fgetc, ungetc, ftell of top need to be initialized before calling
ca4b5de2
HV
1222 * this function.
1223 */
4d8dd149 1224static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
ca4b5de2
HV
1225{
1226 int ret;
1227
1228 /* push config-file parsing state stack */
1229 top->prev = cf;
1230 top->linenr = 1;
1231 top->eof = 0;
1232 strbuf_init(&top->value, 1024);
1233 strbuf_init(&top->var, 1024);
1234 cf = top;
1235
4d8dd149 1236 ret = git_parse_source(fn, data);
ca4b5de2
HV
1237
1238 /* pop config-file parsing state stack */
1239 strbuf_release(&top->value);
1240 strbuf_release(&top->var);
1241 cf = top->prev;
1242
1243 return ret;
1244}
1245
3caec73b 1246static int do_config_from_file(config_fn_t fn,
1b8132d9
VA
1247 const enum config_origin_type origin_type,
1248 const char *name, const char *path, FILE *f,
473166b9 1249 void *data)
17712991 1250{
3caec73b 1251 struct config_source top;
17712991 1252
3caec73b 1253 top.u.file = f;
473166b9 1254 top.origin_type = origin_type;
3caec73b
KS
1255 top.name = name;
1256 top.path = path;
1257 top.die_on_error = 1;
1258 top.do_fgetc = config_file_fgetc;
1259 top.do_ungetc = config_file_ungetc;
1260 top.do_ftell = config_file_ftell;
924aaf3e 1261
3caec73b
KS
1262 return do_config_from(&top, fn, data);
1263}
924aaf3e 1264
3caec73b
KS
1265static int git_config_from_stdin(config_fn_t fn, void *data)
1266{
1b8132d9 1267 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
3caec73b
KS
1268}
1269
1270int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1271{
1272 int ret = -1;
1273 FILE *f;
924aaf3e 1274
3caec73b
KS
1275 f = fopen(filename, "r");
1276 if (f) {
260d408e 1277 flockfile(f);
1b8132d9 1278 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
260d408e 1279 funlockfile(f);
17712991
LT
1280 fclose(f);
1281 }
1282 return ret;
1283}
10bea152 1284
1b8132d9 1285int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
473166b9 1286 const char *name, const char *buf, size_t len, void *data)
1bc88819
HV
1287{
1288 struct config_source top;
1289
1290 top.u.buf.buf = buf;
1291 top.u.buf.len = len;
1292 top.u.buf.pos = 0;
473166b9 1293 top.origin_type = origin_type;
1bc88819 1294 top.name = name;
d14d4244 1295 top.path = NULL;
b2dc0945 1296 top.die_on_error = 0;
49d6cfa5
JK
1297 top.do_fgetc = config_buf_fgetc;
1298 top.do_ungetc = config_buf_ungetc;
1299 top.do_ftell = config_buf_ftell;
1bc88819
HV
1300
1301 return do_config_from(&top, fn, data);
1302}
1303
1304static int git_config_from_blob_sha1(config_fn_t fn,
1305 const char *name,
1306 const unsigned char *sha1,
1307 void *data)
1308{
1309 enum object_type type;
1310 char *buf;
1311 unsigned long size;
1312 int ret;
1313
1314 buf = read_sha1_file(sha1, &type, &size);
1315 if (!buf)
1316 return error("unable to load config blob object '%s'", name);
1317 if (type != OBJ_BLOB) {
1318 free(buf);
1319 return error("reference '%s' does not point to a blob", name);
1320 }
1321
1b8132d9 1322 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1bc88819
HV
1323 free(buf);
1324
1325 return ret;
1326}
1327
1328static int git_config_from_blob_ref(config_fn_t fn,
1329 const char *name,
1330 void *data)
1331{
1332 unsigned char sha1[20];
1333
1334 if (get_sha1(name, sha1) < 0)
1335 return error("unable to resolve config blob '%s'", name);
1336 return git_config_from_blob_sha1(fn, name, sha1, data);
1337}
1338
506b17b1
JS
1339const char *git_etc_gitconfig(void)
1340{
7f0e39fa 1341 static const char *system_wide;
2de9de5e
SP
1342 if (!system_wide)
1343 system_wide = system_path(ETC_GITCONFIG);
7f0e39fa 1344 return system_wide;
506b17b1
JS
1345}
1346
23b0c478
SP
1347/*
1348 * Parse environment variable 'k' as a boolean (in various
1349 * possible spellings); if missing, use the default value 'def'.
1350 */
0ef37164 1351int git_env_bool(const char *k, int def)
ab88c363
JK
1352{
1353 const char *v = getenv(k);
1354 return v ? git_config_bool(k, v) : def;
1355}
1356
23b0c478
SP
1357/*
1358 * Parse environment variable 'k' as ulong with possibly a unit
1359 * suffix; if missing, use the default value 'val'.
1360 */
1361unsigned long git_env_ulong(const char *k, unsigned long val)
1362{
1363 const char *v = getenv(k);
1364 if (v && !git_parse_ulong(v, &val))
1365 die("failed to parse %s", k);
1366 return val;
1367}
1368
ab88c363
JK
1369int git_config_system(void)
1370{
1371 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1372}
1373
80181868 1374static int do_git_config_sequence(config_fn_t fn, void *data)
4f629539 1375{
c72ee44b 1376 int ret = 0;
509adc33
PT
1377 char *xdg_config = xdg_config_home("config");
1378 char *user_config = expand_user_path("~/.gitconfig");
80181868 1379 char *repo_config = git_pathdup("config");
5f1a63e0 1380
9acc5911 1381 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
c72ee44b 1382 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
dc871831
DB
1383 ret += git_config_from_file(fn, git_etc_gitconfig(),
1384 data);
5f1a63e0 1385
9acc5911 1386 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
c72ee44b 1387 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
21cf3227 1388 ret += git_config_from_file(fn, xdg_config, data);
21cf3227 1389
c72ee44b 1390 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
21cf3227 1391 ret += git_config_from_file(fn, user_config, data);
5f1a63e0 1392
9acc5911 1393 current_parsing_scope = CONFIG_SCOPE_REPO;
c72ee44b 1394 if (repo_config && !access_or_die(repo_config, R_OK, 0))
aa387407 1395 ret += git_config_from_file(fn, repo_config, data);
8b1fa778 1396
9acc5911 1397 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
c72ee44b 1398 if (git_config_from_parameters(fn, data) < 0)
8262aaa2 1399 die(_("unable to parse command-line config"));
8b1fa778 1400
9acc5911 1401 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
21cf3227
HKNN
1402 free(xdg_config);
1403 free(user_config);
80181868 1404 free(repo_config);
c72ee44b 1405 return ret;
4f629539
JH
1406}
1407
c9b5e2a5 1408int git_config_with_options(config_fn_t fn, void *data,
c8985ce0 1409 struct git_config_source *config_source,
1bc88819 1410 int respect_includes)
dbdf5854 1411{
9b25a0b5
JK
1412 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1413
1414 if (respect_includes) {
1415 inc.fn = fn;
1416 inc.data = data;
1417 fn = git_config_include;
1418 data = &inc;
1419 }
dbdf5854 1420
c9b5e2a5
JK
1421 /*
1422 * If we have a specific filename, use it. Otherwise, follow the
1423 * regular lookup sequence.
1424 */
3caec73b
KS
1425 if (config_source && config_source->use_stdin)
1426 return git_config_from_stdin(fn, data);
1427 else if (config_source && config_source->file)
c8985ce0
KS
1428 return git_config_from_file(fn, config_source->file, data);
1429 else if (config_source && config_source->blob)
1430 return git_config_from_blob_ref(fn, config_source->blob, data);
c9b5e2a5 1431
80181868 1432 return do_git_config_sequence(fn, data);
dbdf5854
NTND
1433}
1434
155ef25f 1435static void git_config_raw(config_fn_t fn, void *data)
c9b5e2a5 1436{
aace4385
TA
1437 if (git_config_with_options(fn, data, NULL, 1) < 0)
1438 /*
1439 * git_config_with_options() normally returns only
c72ee44b 1440 * zero, as most errors are fatal, and
aace4385
TA
1441 * non-fatal potential errors are guarded by "if"
1442 * statements that are entered only when no error is
1443 * possible.
1444 *
1445 * If we ever encounter a non-fatal error, it means
1446 * something went really wrong and we should stop
1447 * immediately.
1448 */
3a39f61e 1449 die(_("unknown error occurred while reading the configuration files"));
c9b5e2a5
JK
1450}
1451
155ef25f 1452static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
c9b5e2a5 1453{
155ef25f
TA
1454 int i, value_index;
1455 struct string_list *values;
1456 struct config_set_element *entry;
1457 struct configset_list *list = &cs->list;
155ef25f
TA
1458
1459 for (i = 0; i < list->nr; i++) {
1460 entry = list->items[i].e;
1461 value_index = list->items[i].value_index;
1462 values = &entry->value_list;
0d44a2da
JK
1463
1464 current_config_kvi = values->items[value_index].util;
1465
1466 if (fn(entry->key, values->items[value_index].string, data) < 0)
1467 git_die_config_linenr(entry->key,
1468 current_config_kvi->filename,
1469 current_config_kvi->linenr);
1470
1471 current_config_kvi = NULL;
155ef25f
TA
1472 }
1473}
1474
1475static void git_config_check_init(void);
1476
1477void git_config(config_fn_t fn, void *data)
1478{
1479 git_config_check_init();
1480 configset_iter(&the_config_set, fn, data);
c9b5e2a5
JK
1481}
1482
3c8687a7
TA
1483static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1484{
1485 struct config_set_element k;
1486 struct config_set_element *found_entry;
1487 char *normalized_key;
3c8687a7
TA
1488 /*
1489 * `key` may come from the user, so normalize it before using it
1490 * for querying entries from the hashmap.
1491 */
270cd9ea 1492 if (git_config_parse_key(key, &normalized_key, NULL))
3c8687a7
TA
1493 return NULL;
1494
1495 hashmap_entry_init(&k, strhash(normalized_key));
1496 k.key = normalized_key;
1497 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1498 free(normalized_key);
1499 return found_entry;
1500}
1501
1502static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1503{
1504 struct config_set_element *e;
3df8fd62 1505 struct string_list_item *si;
155ef25f 1506 struct configset_list_item *l_item;
3df8fd62
TA
1507 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1508
3c8687a7
TA
1509 e = configset_find_element(cs, key);
1510 /*
1511 * Since the keys are being fed by git_config*() callback mechanism, they
1512 * are already normalized. So simply add them without any further munging.
1513 */
1514 if (!e) {
1515 e = xmalloc(sizeof(*e));
1516 hashmap_entry_init(e, strhash(key));
1517 e->key = xstrdup(key);
1518 string_list_init(&e->value_list, 1);
1519 hashmap_add(&cs->config_hash, e);
1520 }
8c53f071 1521 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
155ef25f
TA
1522
1523 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1524 l_item = &cs->list.items[cs->list.nr++];
1525 l_item->e = e;
1526 l_item->value_index = e->value_list.nr - 1;
1527
3258258f
JK
1528 if (!cf)
1529 die("BUG: configset_add_value has no source");
1530 if (cf->name) {
3df8fd62
TA
1531 kv_info->filename = strintern(cf->name);
1532 kv_info->linenr = cf->linenr;
1b8132d9 1533 kv_info->origin_type = cf->origin_type;
3df8fd62
TA
1534 } else {
1535 /* for values read from `git_config_from_parameters()` */
1536 kv_info->filename = NULL;
1537 kv_info->linenr = -1;
1b8132d9 1538 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
3df8fd62 1539 }
9acc5911 1540 kv_info->scope = current_parsing_scope;
3df8fd62 1541 si->util = kv_info;
3c8687a7
TA
1542
1543 return 0;
1544}
1545
1546static int config_set_element_cmp(const struct config_set_element *e1,
1547 const struct config_set_element *e2, const void *unused)
1548{
1549 return strcmp(e1->key, e2->key);
1550}
1551
1552void git_configset_init(struct config_set *cs)
1553{
1554 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1555 cs->hash_initialized = 1;
155ef25f
TA
1556 cs->list.nr = 0;
1557 cs->list.alloc = 0;
1558 cs->list.items = NULL;
3c8687a7
TA
1559}
1560
1561void git_configset_clear(struct config_set *cs)
1562{
1563 struct config_set_element *entry;
1564 struct hashmap_iter iter;
1565 if (!cs->hash_initialized)
1566 return;
1567
1568 hashmap_iter_init(&cs->config_hash, &iter);
1569 while ((entry = hashmap_iter_next(&iter))) {
1570 free(entry->key);
3df8fd62 1571 string_list_clear(&entry->value_list, 1);
3c8687a7
TA
1572 }
1573 hashmap_free(&cs->config_hash, 1);
1574 cs->hash_initialized = 0;
155ef25f
TA
1575 free(cs->list.items);
1576 cs->list.nr = 0;
1577 cs->list.alloc = 0;
1578 cs->list.items = NULL;
3c8687a7
TA
1579}
1580
1581static int config_set_callback(const char *key, const char *value, void *cb)
1582{
1583 struct config_set *cs = cb;
1584 configset_add_value(cs, key, value);
1585 return 0;
1586}
1587
1588int git_configset_add_file(struct config_set *cs, const char *filename)
1589{
1590 return git_config_from_file(config_set_callback, filename, cs);
1591}
1592
1593int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1594{
1595 const struct string_list *values = NULL;
1596 /*
1597 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1598 * queried key in the files of the configset, the value returned will be the last
1599 * value in the value list for that key.
1600 */
1601 values = git_configset_get_value_multi(cs, key);
1602
1603 if (!values)
1604 return 1;
1605 assert(values->nr > 0);
1606 *value = values->items[values->nr - 1].string;
1607 return 0;
1608}
1609
1610const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1611{
1612 struct config_set_element *e = configset_find_element(cs, key);
1613 return e ? &e->value_list : NULL;
1614}
1615
1616int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1617{
1618 const char *value;
1619 if (!git_configset_get_value(cs, key, &value))
1620 return git_config_string(dest, key, value);
1621 else
1622 return 1;
1623}
1624
1625int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1626{
1627 return git_configset_get_string_const(cs, key, (const char **)dest);
1628}
1629
1630int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1631{
1632 const char *value;
1633 if (!git_configset_get_value(cs, key, &value)) {
1634 *dest = git_config_int(key, value);
1635 return 0;
1636 } else
1637 return 1;
1638}
1639
1640int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1641{
1642 const char *value;
1643 if (!git_configset_get_value(cs, key, &value)) {
1644 *dest = git_config_ulong(key, value);
1645 return 0;
1646 } else
1647 return 1;
1648}
1649
1650int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1651{
1652 const char *value;
1653 if (!git_configset_get_value(cs, key, &value)) {
1654 *dest = git_config_bool(key, value);
1655 return 0;
1656 } else
1657 return 1;
1658}
1659
1660int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1661 int *is_bool, int *dest)
1662{
1663 const char *value;
1664 if (!git_configset_get_value(cs, key, &value)) {
1665 *dest = git_config_bool_or_int(key, value, is_bool);
1666 return 0;
1667 } else
1668 return 1;
1669}
1670
1671int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1672{
1673 const char *value;
1674 if (!git_configset_get_value(cs, key, &value)) {
1675 *dest = git_config_maybe_bool(key, value);
1676 if (*dest == -1)
1677 return -1;
1678 return 0;
1679 } else
1680 return 1;
1681}
1682
1683int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1684{
1685 const char *value;
1686 if (!git_configset_get_value(cs, key, &value))
1687 return git_config_pathname(dest, key, value);
1688 else
1689 return 1;
1690}
1691
1692static void git_config_check_init(void)
1693{
1694 if (the_config_set.hash_initialized)
1695 return;
1696 git_configset_init(&the_config_set);
155ef25f 1697 git_config_raw(config_set_callback, &the_config_set);
3c8687a7
TA
1698}
1699
1700void git_config_clear(void)
1701{
1702 if (!the_config_set.hash_initialized)
1703 return;
1704 git_configset_clear(&the_config_set);
1705}
1706
1707int git_config_get_value(const char *key, const char **value)
1708{
1709 git_config_check_init();
1710 return git_configset_get_value(&the_config_set, key, value);
1711}
1712
1713const struct string_list *git_config_get_value_multi(const char *key)
1714{
1715 git_config_check_init();
1716 return git_configset_get_value_multi(&the_config_set, key);
1717}
1718
1719int git_config_get_string_const(const char *key, const char **dest)
1720{
5a80e97c 1721 int ret;
3c8687a7 1722 git_config_check_init();
5a80e97c
TA
1723 ret = git_configset_get_string_const(&the_config_set, key, dest);
1724 if (ret < 0)
1725 git_die_config(key, NULL);
1726 return ret;
3c8687a7
TA
1727}
1728
1729int git_config_get_string(const char *key, char **dest)
1730{
1731 git_config_check_init();
1732 return git_config_get_string_const(key, (const char **)dest);
1733}
1734
1735int git_config_get_int(const char *key, int *dest)
1736{
1737 git_config_check_init();
1738 return git_configset_get_int(&the_config_set, key, dest);
1739}
1740
1741int git_config_get_ulong(const char *key, unsigned long *dest)
1742{
1743 git_config_check_init();
1744 return git_configset_get_ulong(&the_config_set, key, dest);
1745}
1746
1747int git_config_get_bool(const char *key, int *dest)
1748{
1749 git_config_check_init();
1750 return git_configset_get_bool(&the_config_set, key, dest);
1751}
1752
1753int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1754{
1755 git_config_check_init();
1756 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1757}
1758
1759int git_config_get_maybe_bool(const char *key, int *dest)
1760{
1761 git_config_check_init();
1762 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1763}
1764
1765int git_config_get_pathname(const char *key, const char **dest)
1766{
5a80e97c 1767 int ret;
3c8687a7 1768 git_config_check_init();
5a80e97c
TA
1769 ret = git_configset_get_pathname(&the_config_set, key, dest);
1770 if (ret < 0)
1771 git_die_config(key, NULL);
1772 return ret;
1773}
1774
435ec090
CC
1775int git_config_get_untracked_cache(void)
1776{
1777 int val = -1;
1778 const char *v;
1779
dae6c322
CC
1780 /* Hack for test programs like test-dump-untracked-cache */
1781 if (ignore_untracked_cache_config)
1782 return -1;
1783
435ec090
CC
1784 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
1785 return val;
1786
1787 if (!git_config_get_value("core.untrackedcache", &v)) {
1788 if (!strcasecmp(v, "keep"))
1789 return -1;
1790
1791 error("unknown core.untrackedCache value '%s'; "
1792 "using 'keep' default value", v);
1793 return -1;
1794 }
1795
1796 return -1; /* default value */
1797}
1798
5a80e97c
TA
1799NORETURN
1800void git_die_config_linenr(const char *key, const char *filename, int linenr)
1801{
1802 if (!filename)
1803 die(_("unable to parse '%s' from command-line config"), key);
1804 else
1805 die(_("bad config variable '%s' in file '%s' at line %d"),
1806 key, filename, linenr);
1807}
1808
1809NORETURN __attribute__((format(printf, 2, 3)))
1810void git_die_config(const char *key, const char *err, ...)
1811{
1812 const struct string_list *values;
1813 struct key_value_info *kv_info;
1814
1815 if (err) {
1816 va_list params;
1817 va_start(params, err);
1818 vreportf("error: ", err, params);
1819 va_end(params);
1820 }
1821 values = git_config_get_value_multi(key);
1822 kv_info = values->items[values->nr - 1].util;
1823 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
3c8687a7
TA
1824}
1825
10bea152
JS
1826/*
1827 * Find all the stuff for git_config_set() below.
1828 */
4ddba79d 1829
10bea152
JS
1830static struct {
1831 int baselen;
4b25d091 1832 char *key;
f98d863d 1833 int do_not_match;
4b25d091 1834 regex_t *value_regex;
4ddba79d 1835 int multi_replace;
83786fa4
TR
1836 size_t *offset;
1837 unsigned int offset_alloc;
10bea152
JS
1838 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1839 int seen;
1840} store;
1841
4b25d091 1842static int matches(const char *key, const char *value)
f98d863d 1843{
c1063be2
JK
1844 if (strcmp(key, store.key))
1845 return 0; /* not ours */
1846 if (!store.value_regex)
1847 return 1; /* always matches */
1848 if (store.value_regex == CONFIG_REGEX_NONE)
1849 return 0; /* never matches */
1850
1851 return store.do_not_match ^
1852 (value && !regexec(store.value_regex, value, 0, NULL, 0));
f98d863d
JS
1853}
1854
4b25d091 1855static int store_aux(const char *key, const char *value, void *cb)
10bea152 1856{
ae9ee41d
JH
1857 const char *ep;
1858 size_t section_len;
1859
10bea152
JS
1860 switch (store.state) {
1861 case KEY_SEEN:
f98d863d 1862 if (matches(key, value)) {
4ddba79d 1863 if (store.seen == 1 && store.multi_replace == 0) {
8262aaa2 1864 warning(_("%s has multiple values"), key);
10bea152 1865 }
4ddba79d 1866
83786fa4
TR
1867 ALLOC_GROW(store.offset, store.seen + 1,
1868 store.offset_alloc);
1869
49d6cfa5 1870 store.offset[store.seen] = cf->do_ftell(cf);
10bea152
JS
1871 store.seen++;
1872 }
1873 break;
1874 case SECTION_SEEN:
ae9ee41d
JH
1875 /*
1876 * What we are looking for is in store.key (both
1877 * section and var), and its section part is baselen
1878 * long. We found key (again, both section and var).
1879 * We would want to know if this key is in the same
1880 * section as what we are looking for. We already
1881 * know we are in the same section as what should
1882 * hold store.key.
1883 */
1884 ep = strrchr(key, '.');
1885 section_len = ep - key;
1886
1887 if ((section_len != store.baselen) ||
1888 memcmp(key, store.key, section_len+1)) {
10bea152
JS
1889 store.state = SECTION_END_SEEN;
1890 break;
ae9ee41d
JH
1891 }
1892
1893 /*
1894 * Do not increment matches: this is no match, but we
1895 * just made sure we are in the desired section.
1896 */
83786fa4
TR
1897 ALLOC_GROW(store.offset, store.seen + 1,
1898 store.offset_alloc);
49d6cfa5 1899 store.offset[store.seen] = cf->do_ftell(cf);
10bea152
JS
1900 /* fallthru */
1901 case SECTION_END_SEEN:
1902 case START:
f98d863d 1903 if (matches(key, value)) {
83786fa4
TR
1904 ALLOC_GROW(store.offset, store.seen + 1,
1905 store.offset_alloc);
49d6cfa5 1906 store.offset[store.seen] = cf->do_ftell(cf);
10bea152
JS
1907 store.state = KEY_SEEN;
1908 store.seen++;
d14f7764
LT
1909 } else {
1910 if (strrchr(key, '.') - key == store.baselen &&
bdf0ef08 1911 !strncmp(key, store.key, store.baselen)) {
93ddef3e 1912 store.state = SECTION_SEEN;
83786fa4
TR
1913 ALLOC_GROW(store.offset,
1914 store.seen + 1,
1915 store.offset_alloc);
49d6cfa5 1916 store.offset[store.seen] = cf->do_ftell(cf);
d14f7764 1917 }
bdf0ef08 1918 }
10bea152
JS
1919 }
1920 return 0;
1921}
1922
64c0d71c 1923static int write_error(const char *filename)
480c9e52 1924{
64c0d71c 1925 error("failed to write new configuration file %s", filename);
480c9e52
AW
1926
1927 /* Same error code as "failed to rename". */
1928 return 4;
1929}
1930
4b25d091 1931static int store_write_section(int fd, const char *key)
10bea152 1932{
cb891a59
KH
1933 const char *dot;
1934 int i, success;
f285a2d7 1935 struct strbuf sb = STRBUF_INIT;
d14f7764 1936
cb891a59 1937 dot = memchr(key, '.', store.baselen);
d14f7764 1938 if (dot) {
cb891a59
KH
1939 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1940 for (i = dot - key + 1; i < store.baselen; i++) {
e5c349ba 1941 if (key[i] == '"' || key[i] == '\\')
cb891a59
KH
1942 strbuf_addch(&sb, '\\');
1943 strbuf_addch(&sb, key[i]);
d14f7764 1944 }
cb891a59
KH
1945 strbuf_addstr(&sb, "\"]\n");
1946 } else {
1947 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
d14f7764
LT
1948 }
1949
cb891a59
KH
1950 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1951 strbuf_release(&sb);
480c9e52 1952
cb891a59 1953 return success;
10bea152
JS
1954}
1955
4b25d091 1956static int store_write_pair(int fd, const char *key, const char *value)
10bea152 1957{
cb891a59
KH
1958 int i, success;
1959 int length = strlen(key + store.baselen + 1);
1960 const char *quote = "";
f285a2d7 1961 struct strbuf sb = STRBUF_INIT;
cdd4fb15 1962
6281f394
JM
1963 /*
1964 * Check to see if the value needs to be surrounded with a dq pair.
1965 * Note that problematic characters are always backslash-quoted; this
1966 * check is about not losing leading or trailing SP and strings that
1967 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1968 * configuration parser.
1969 */
cdd4fb15 1970 if (value[0] == ' ')
cb891a59 1971 quote = "\"";
cdd4fb15
BG
1972 for (i = 0; value[i]; i++)
1973 if (value[i] == ';' || value[i] == '#')
cb891a59
KH
1974 quote = "\"";
1975 if (i && value[i - 1] == ' ')
1976 quote = "\"";
1977
cb891a59
KH
1978 strbuf_addf(&sb, "\t%.*s = %s",
1979 length, key + store.baselen + 1, quote);
10bea152 1980
10bea152
JS
1981 for (i = 0; value[i]; i++)
1982 switch (value[i]) {
480c9e52 1983 case '\n':
cb891a59 1984 strbuf_addstr(&sb, "\\n");
480c9e52
AW
1985 break;
1986 case '\t':
cb891a59 1987 strbuf_addstr(&sb, "\\t");
480c9e52
AW
1988 break;
1989 case '"':
1990 case '\\':
cb891a59 1991 strbuf_addch(&sb, '\\');
480c9e52 1992 default:
cb891a59 1993 strbuf_addch(&sb, value[i]);
480c9e52
AW
1994 break;
1995 }
cb891a59
KH
1996 strbuf_addf(&sb, "%s\n", quote);
1997
1998 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1999 strbuf_release(&sb);
2000
2001 return success;
10bea152
JS
2002}
2003
4b25d091
FC
2004static ssize_t find_beginning_of_line(const char *contents, size_t size,
2005 size_t offset_, int *found_bracket)
4ddba79d 2006{
dc49cd76
SP
2007 size_t equal_offset = size, bracket_offset = size;
2008 ssize_t offset;
4ddba79d 2009
7a31cc0f 2010contline:
a6080a0a 2011 for (offset = offset_-2; offset > 0
4ddba79d
JS
2012 && contents[offset] != '\n'; offset--)
2013 switch (contents[offset]) {
2014 case '=': equal_offset = offset; break;
2015 case ']': bracket_offset = offset; break;
2016 }
7a31cc0f
FL
2017 if (offset > 0 && contents[offset-1] == '\\') {
2018 offset_ = offset;
2019 goto contline;
2020 }
4ddba79d
JS
2021 if (bracket_offset < equal_offset) {
2022 *found_bracket = 1;
2023 offset = bracket_offset+1;
2024 } else
2025 offset++;
2026
2027 return offset;
2028}
2029
30598ad0
PS
2030int git_config_set_in_file_gently(const char *config_filename,
2031 const char *key, const char *value)
5ec31182 2032{
30598ad0 2033 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
5ec31182
RR
2034}
2035
3d180648
PS
2036void git_config_set_in_file(const char *config_filename,
2037 const char *key, const char *value)
10bea152 2038{
3d180648 2039 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
b4c8aba6
PS
2040}
2041
30598ad0 2042int git_config_set_gently(const char *key, const char *value)
10bea152 2043{
30598ad0 2044 return git_config_set_multivar_gently(key, value, NULL, 0);
10bea152
JS
2045}
2046
3d180648 2047void git_config_set(const char *key, const char *value)
b4c8aba6 2048{
3d180648 2049 git_config_set_multivar(key, value, NULL, 0);
10bea152
JS
2050}
2051
2052/*
2053 * If value==NULL, unset in (remove from) config,
2054 * if value_regex!=NULL, disregard key/value pairs where value does not match.
c1063be2
JK
2055 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2056 * (only add a new one)
4ddba79d
JS
2057 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2058 * else all matching key/values (regardless how many) are removed,
2059 * before the new pair is written.
10bea152
JS
2060 *
2061 * Returns 0 on success.
2062 *
2063 * This function does this:
2064 *
2065 * - it locks the config file by creating ".git/config.lock"
2066 *
2067 * - it then parses the config using store_aux() as validator to find
2068 * the position on the key/value pair to replace. If it is to be unset,
2069 * it must be found exactly once.
2070 *
2071 * - the config file is mmap()ed and the part before the match (if any) is
2072 * written to the lock file, then the changed part and the rest.
2073 *
2074 * - the config file is removed and the lock file rename()d to it.
2075 *
2076 */
30598ad0
PS
2077int git_config_set_multivar_in_file_gently(const char *config_filename,
2078 const char *key, const char *value,
2079 const char *value_regex,
2080 int multi_replace)
10bea152 2081{
54d160ec 2082 int fd = -1, in_fd = -1;
dafc88b1 2083 int ret;
6cbf973c 2084 struct lock_file *lock = NULL;
0a5f5759 2085 char *filename_buf = NULL;
3a1b3126
JK
2086 char *contents = NULL;
2087 size_t contents_sz;
4ddba79d 2088
b09c53a3
LP
2089 /* parse-key returns negative; flip the sign to feed exit(3) */
2090 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2091 if (ret)
dafc88b1 2092 goto out_free;
b17e659d
JS
2093
2094 store.multi_replace = multi_replace;
10bea152 2095
0a5f5759
JK
2096 if (!config_filename)
2097 config_filename = filename_buf = git_pathdup("config");
10bea152
JS
2098
2099 /*
6cbf973c 2100 * The lock serves a purpose in addition to locking: the new
10bea152
JS
2101 * contents of .git/config will be written into it.
2102 */
f1064f6b 2103 lock = xcalloc(1, sizeof(struct lock_file));
6cbf973c
BS
2104 fd = hold_lock_file_for_update(lock, config_filename, 0);
2105 if (fd < 0) {
f0658ec9 2106 error_errno("could not lock config file %s", config_filename);
10bea152 2107 free(store.key);
7a397419 2108 ret = CONFIG_NO_LOCK;
dafc88b1 2109 goto out_free;
10bea152
JS
2110 }
2111
2112 /*
2113 * If .git/config does not exist yet, write a minimal version.
2114 */
88fb958b
AR
2115 in_fd = open(config_filename, O_RDONLY);
2116 if ( in_fd < 0 ) {
10bea152
JS
2117 free(store.key);
2118
88fb958b 2119 if ( ENOENT != errno ) {
f0658ec9 2120 error_errno("opening %s", config_filename);
7a397419 2121 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
dafc88b1 2122 goto out_free;
88fb958b 2123 }
10bea152
JS
2124 /* if nothing to unset, error out */
2125 if (value == NULL) {
7a397419 2126 ret = CONFIG_NOTHING_SET;
dafc88b1 2127 goto out_free;
10bea152
JS
2128 }
2129
4b25d091 2130 store.key = (char *)key;
480c9e52 2131 if (!store_write_section(fd, key) ||
93c1e079
JH
2132 !store_write_pair(fd, key, value))
2133 goto write_err_out;
2134 } else {
88fb958b 2135 struct stat st;
3a1b3126 2136 size_t copy_begin, copy_end;
dc49cd76 2137 int i, new_line = 0;
10bea152
JS
2138
2139 if (value_regex == NULL)
2140 store.value_regex = NULL;
c1063be2
JK
2141 else if (value_regex == CONFIG_REGEX_NONE)
2142 store.value_regex = CONFIG_REGEX_NONE;
10bea152 2143 else {
f98d863d
JS
2144 if (value_regex[0] == '!') {
2145 store.do_not_match = 1;
2146 value_regex++;
2147 } else
2148 store.do_not_match = 0;
2149
2d7320d0 2150 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
10bea152
JS
2151 if (regcomp(store.value_regex, value_regex,
2152 REG_EXTENDED)) {
64c0d71c 2153 error("invalid pattern: %s", value_regex);
10bea152 2154 free(store.value_regex);
7a397419 2155 ret = CONFIG_INVALID_PATTERN;
dafc88b1 2156 goto out_free;
10bea152
JS
2157 }
2158 }
2159
83786fa4 2160 ALLOC_GROW(store.offset, 1, store.offset_alloc);
4ddba79d 2161 store.offset[0] = 0;
10bea152
JS
2162 store.state = START;
2163 store.seen = 0;
2164
2165 /*
2166 * After this, store.offset will contain the *end* offset
2167 * of the last match, or remain at 0 if no match was found.
2168 * As a side effect, we make sure to transform only a valid
2169 * existing config file.
2170 */
ef90d6d4 2171 if (git_config_from_file(store_aux, config_filename, NULL)) {
64c0d71c 2172 error("invalid config file %s", config_filename);
10bea152 2173 free(store.key);
c1063be2
JK
2174 if (store.value_regex != NULL &&
2175 store.value_regex != CONFIG_REGEX_NONE) {
10bea152
JS
2176 regfree(store.value_regex);
2177 free(store.value_regex);
2178 }
7a397419 2179 ret = CONFIG_INVALID_FILE;
dafc88b1 2180 goto out_free;
10bea152
JS
2181 }
2182
2183 free(store.key);
c1063be2
JK
2184 if (store.value_regex != NULL &&
2185 store.value_regex != CONFIG_REGEX_NONE) {
10bea152
JS
2186 regfree(store.value_regex);
2187 free(store.value_regex);
2188 }
2189
4ddba79d
JS
2190 /* if nothing to unset, or too many matches, error out */
2191 if ((store.seen == 0 && value == NULL) ||
2192 (store.seen > 1 && multi_replace == 0)) {
7a397419 2193 ret = CONFIG_NOTHING_SET;
dafc88b1 2194 goto out_free;
10bea152
JS
2195 }
2196
88fb958b 2197 fstat(in_fd, &st);
dc49cd76 2198 contents_sz = xsize_t(st.st_size);
1570856b
JK
2199 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2200 MAP_PRIVATE, in_fd, 0);
2201 if (contents == MAP_FAILED) {
0e8771f1
JK
2202 if (errno == ENODEV && S_ISDIR(st.st_mode))
2203 errno = EISDIR;
f0658ec9 2204 error_errno("unable to mmap '%s'", config_filename);
1570856b
JK
2205 ret = CONFIG_INVALID_FILE;
2206 contents = NULL;
2207 goto out_free;
2208 }
10bea152 2209 close(in_fd);
54d160ec 2210 in_fd = -1;
10bea152 2211
b4fb09e4 2212 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
f0658ec9 2213 error_errno("chmod on %s failed", get_lock_file_path(lock));
daa22c6f
EW
2214 ret = CONFIG_NO_WRITE;
2215 goto out_free;
2216 }
2217
4ddba79d
JS
2218 if (store.seen == 0)
2219 store.seen = 1;
2220
2221 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2222 if (store.offset[i] == 0) {
dc49cd76 2223 store.offset[i] = copy_end = contents_sz;
4ddba79d
JS
2224 } else if (store.state != KEY_SEEN) {
2225 copy_end = store.offset[i];
10bea152 2226 } else
4ddba79d 2227 copy_end = find_beginning_of_line(
dc49cd76 2228 contents, contents_sz,
4ddba79d
JS
2229 store.offset[i]-2, &new_line);
2230
02e5ba4a
JK
2231 if (copy_end > 0 && contents[copy_end-1] != '\n')
2232 new_line = 1;
2233
4ddba79d
JS
2234 /* write the first part of the config */
2235 if (copy_end > copy_begin) {
93c1e079
JH
2236 if (write_in_full(fd, contents + copy_begin,
2237 copy_end - copy_begin) <
2238 copy_end - copy_begin)
2239 goto write_err_out;
2240 if (new_line &&
2b7ca830 2241 write_str_in_full(fd, "\n") != 1)
93c1e079 2242 goto write_err_out;
4ddba79d
JS
2243 }
2244 copy_begin = store.offset[i];
10bea152
JS
2245 }
2246
10bea152
JS
2247 /* write the pair (value == NULL means unset) */
2248 if (value != NULL) {
93c1e079
JH
2249 if (store.state == START) {
2250 if (!store_write_section(fd, key))
2251 goto write_err_out;
480c9e52 2252 }
93c1e079
JH
2253 if (!store_write_pair(fd, key, value))
2254 goto write_err_out;
10bea152
JS
2255 }
2256
2257 /* write the rest of the config */
dc49cd76 2258 if (copy_begin < contents_sz)
93c1e079 2259 if (write_in_full(fd, contents + copy_begin,
dc49cd76
SP
2260 contents_sz - copy_begin) <
2261 contents_sz - copy_begin)
93c1e079 2262 goto write_err_out;
7a64592c
KB
2263
2264 munmap(contents, contents_sz);
2265 contents = NULL;
10bea152
JS
2266 }
2267
4ed7cd3a 2268 if (commit_lock_file(lock) < 0) {
f0658ec9 2269 error_errno("could not write config file %s", config_filename);
7a397419 2270 ret = CONFIG_NO_WRITE;
e831855e 2271 lock = NULL;
dafc88b1 2272 goto out_free;
10bea152
JS
2273 }
2274
6cbf973c
BS
2275 /*
2276 * lock is committed, so don't try to roll it back below.
2277 * NOTE: Since lockfile.c keeps a linked list of all created
2278 * lock_file structures, it isn't safe to free(lock). It's
2279 * better to just leave it hanging around.
2280 */
2281 lock = NULL;
dafc88b1
SH
2282 ret = 0;
2283
3c8687a7
TA
2284 /* Invalidate the config cache */
2285 git_config_clear();
2286
dafc88b1 2287out_free:
6cbf973c
BS
2288 if (lock)
2289 rollback_lock_file(lock);
0a5f5759 2290 free(filename_buf);
3a1b3126
JK
2291 if (contents)
2292 munmap(contents, contents_sz);
54d160ec
SS
2293 if (in_fd >= 0)
2294 close(in_fd);
dafc88b1 2295 return ret;
93c1e079
JH
2296
2297write_err_out:
b4fb09e4 2298 ret = write_error(get_lock_file_path(lock));
93c1e079
JH
2299 goto out_free;
2300
10bea152
JS
2301}
2302
3d180648
PS
2303void git_config_set_multivar_in_file(const char *config_filename,
2304 const char *key, const char *value,
2305 const char *value_regex, int multi_replace)
b4c8aba6 2306{
1cae428e
JK
2307 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2308 value_regex, multi_replace))
2309 return;
2310 if (value)
8c3ca351 2311 die(_("could not set '%s' to '%s'"), key, value);
1cae428e
JK
2312 else
2313 die(_("could not unset '%s'"), key);
b4c8aba6
PS
2314}
2315
30598ad0
PS
2316int git_config_set_multivar_gently(const char *key, const char *value,
2317 const char *value_regex, int multi_replace)
5ec31182 2318{
30598ad0
PS
2319 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2320 multi_replace);
5ec31182
RR
2321}
2322
3d180648
PS
2323void git_config_set_multivar(const char *key, const char *value,
2324 const char *value_regex, int multi_replace)
5ec31182 2325{
3d180648
PS
2326 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2327 multi_replace);
5ec31182
RR
2328}
2329
118f8b24
PB
2330static int section_name_match (const char *buf, const char *name)
2331{
2332 int i = 0, j = 0, dot = 0;
a4c0d463
AV
2333 if (buf[i] != '[')
2334 return 0;
2335 for (i = 1; buf[i] && buf[i] != ']'; i++) {
118f8b24
PB
2336 if (!dot && isspace(buf[i])) {
2337 dot = 1;
2338 if (name[j++] != '.')
2339 break;
2340 for (i++; isspace(buf[i]); i++)
2341 ; /* do nothing */
2342 if (buf[i] != '"')
2343 break;
2344 continue;
2345 }
2346 if (buf[i] == '\\' && dot)
2347 i++;
2348 else if (buf[i] == '"' && dot) {
2349 for (i++; isspace(buf[i]); i++)
2350 ; /* do_nothing */
2351 break;
2352 }
2353 if (buf[i] != name[j++])
2354 break;
2355 }
a4c0d463
AV
2356 if (buf[i] == ']' && name[j] == 0) {
2357 /*
2358 * We match, now just find the right length offset by
2359 * gobbling up any whitespace after it, as well
2360 */
2361 i++;
2362 for (; buf[i] && isspace(buf[i]); i++)
2363 ; /* do nothing */
2364 return i;
2365 }
2366 return 0;
118f8b24
PB
2367}
2368
94a35b1a
JK
2369static int section_name_is_ok(const char *name)
2370{
2371 /* Empty section names are bogus. */
2372 if (!*name)
2373 return 0;
2374
2375 /*
2376 * Before a dot, we must be alphanumeric or dash. After the first dot,
2377 * anything goes, so we can stop checking.
2378 */
2379 for (; *name && *name != '.'; name++)
2380 if (*name != '-' && !isalnum(*name))
2381 return 0;
2382 return 1;
2383}
2384
118f8b24 2385/* if new_name == NULL, the section is removed instead */
42bd39b5
JK
2386int git_config_rename_section_in_file(const char *config_filename,
2387 const char *old_name, const char *new_name)
0667fcfb 2388{
118f8b24 2389 int ret = 0, remove = 0;
42bd39b5 2390 char *filename_buf = NULL;
94a35b1a 2391 struct lock_file *lock;
0667fcfb
JS
2392 int out_fd;
2393 char buf[1024];
924aaf3e 2394 FILE *config_file;
daa22c6f 2395 struct stat st;
0667fcfb 2396
94a35b1a
JK
2397 if (new_name && !section_name_is_ok(new_name)) {
2398 ret = error("invalid section name: %s", new_name);
2399 goto out;
2400 }
2401
42bd39b5
JK
2402 if (!config_filename)
2403 config_filename = filename_buf = git_pathdup("config");
2404
f1064f6b 2405 lock = xcalloc(1, sizeof(struct lock_file));
0667fcfb 2406 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
fc1905bb 2407 if (out_fd < 0) {
64c0d71c 2408 ret = error("could not lock config file %s", config_filename);
fc1905bb
JH
2409 goto out;
2410 }
0667fcfb 2411
fc1905bb 2412 if (!(config_file = fopen(config_filename, "rb"))) {
01ebb9dc
GB
2413 /* no config file means nothing to rename, no error */
2414 goto unlock_and_out;
fc1905bb 2415 }
0667fcfb 2416
daa22c6f
EW
2417 fstat(fileno(config_file), &st);
2418
b4fb09e4 2419 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
f0658ec9
NTND
2420 ret = error_errno("chmod on %s failed",
2421 get_lock_file_path(lock));
daa22c6f
EW
2422 goto out;
2423 }
2424
0667fcfb
JS
2425 while (fgets(buf, sizeof(buf), config_file)) {
2426 int i;
480c9e52 2427 int length;
9a5abfc7 2428 char *output = buf;
0667fcfb
JS
2429 for (i = 0; buf[i] && isspace(buf[i]); i++)
2430 ; /* do nothing */
2431 if (buf[i] == '[') {
2432 /* it's a section */
a4c0d463
AV
2433 int offset = section_name_match(&buf[i], old_name);
2434 if (offset > 0) {
118f8b24
PB
2435 ret++;
2436 if (new_name == NULL) {
2437 remove = 1;
0667fcfb
JS
2438 continue;
2439 }
0667fcfb 2440 store.baselen = strlen(new_name);
480c9e52 2441 if (!store_write_section(out_fd, new_name)) {
b4fb09e4 2442 ret = write_error(get_lock_file_path(lock));
480c9e52
AW
2443 goto out;
2444 }
9a5abfc7
AV
2445 /*
2446 * We wrote out the new section, with
2447 * a newline, now skip the old
2448 * section's length
2449 */
2450 output += offset + i;
2451 if (strlen(output) > 0) {
2452 /*
2453 * More content means there's
2454 * a declaration to put on the
2455 * next line; indent with a
2456 * tab
2457 */
2458 output -= 1;
2459 output[0] = '\t';
2460 }
0667fcfb 2461 }
118f8b24 2462 remove = 0;
0667fcfb 2463 }
118f8b24
PB
2464 if (remove)
2465 continue;
9a5abfc7
AV
2466 length = strlen(output);
2467 if (write_in_full(out_fd, output, length) != length) {
b4fb09e4 2468 ret = write_error(get_lock_file_path(lock));
480c9e52
AW
2469 goto out;
2470 }
0667fcfb 2471 }
fc1905bb 2472 fclose(config_file);
8b590075 2473unlock_and_out:
4ed7cd3a 2474 if (commit_lock_file(lock) < 0)
f0658ec9
NTND
2475 ret = error_errno("could not write config file %s",
2476 config_filename);
8b590075 2477out:
42bd39b5 2478 free(filename_buf);
0667fcfb
JS
2479 return ret;
2480}
40ea4ed9 2481
42bd39b5
JK
2482int git_config_rename_section(const char *old_name, const char *new_name)
2483{
4a7bb5ba 2484 return git_config_rename_section_in_file(NULL, old_name, new_name);
42bd39b5
JK
2485}
2486
40ea4ed9
JH
2487/*
2488 * Call this to report error for your variable that should not
2489 * get a boolean value (i.e. "[my] var" means "true").
2490 */
a469a101 2491#undef config_error_nonbool
40ea4ed9
JH
2492int config_error_nonbool(const char *var)
2493{
8c3ca351 2494 return error("missing value for '%s'", var);
40ea4ed9 2495}
1b86bbb0
JK
2496
2497int parse_config_key(const char *var,
2498 const char *section,
2499 const char **subsection, int *subsection_len,
2500 const char **key)
2501{
2502 int section_len = strlen(section);
2503 const char *dot;
2504
2505 /* Does it start with "section." ? */
59556548 2506 if (!starts_with(var, section) || var[section_len] != '.')
1b86bbb0
JK
2507 return -1;
2508
2509 /*
2510 * Find the key; we don't know yet if we have a subsection, but we must
2511 * parse backwards from the end, since the subsection may have dots in
2512 * it, too.
2513 */
2514 dot = strrchr(var, '.');
2515 *key = dot + 1;
2516
2517 /* Did we have a subsection at all? */
2518 if (dot == var + section_len) {
2519 *subsection = NULL;
2520 *subsection_len = 0;
2521 }
2522 else {
2523 *subsection = var + section_len + 1;
2524 *subsection_len = dot - *subsection;
2525 }
2526
2527 return 0;
2528}
473166b9
LS
2529
2530const char *current_config_origin_type(void)
2531{
1b8132d9 2532 int type;
0d44a2da
JK
2533 if (current_config_kvi)
2534 type = current_config_kvi->origin_type;
2535 else if(cf)
2536 type = cf->origin_type;
2537 else
3258258f 2538 die("BUG: current_config_origin_type called outside config callback");
1b8132d9
VA
2539
2540 switch (type) {
2541 case CONFIG_ORIGIN_BLOB:
2542 return "blob";
2543 case CONFIG_ORIGIN_FILE:
2544 return "file";
2545 case CONFIG_ORIGIN_STDIN:
2546 return "standard input";
2547 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2548 return "submodule-blob";
2549 case CONFIG_ORIGIN_CMDLINE:
2550 return "command line";
2551 default:
2552 die("BUG: unknown config origin type");
2553 }
473166b9
LS
2554}
2555
2556const char *current_config_name(void)
2557{
0d44a2da
JK
2558 const char *name;
2559 if (current_config_kvi)
2560 name = current_config_kvi->filename;
2561 else if (cf)
2562 name = cf->name;
2563 else
3258258f 2564 die("BUG: current_config_name called outside config callback");
0d44a2da 2565 return name ? name : "";
473166b9 2566}
9acc5911
JK
2567
2568enum config_scope current_config_scope(void)
2569{
2570 if (current_config_kvi)
2571 return current_config_kvi->scope;
2572 else
2573 return current_parsing_scope;
473166b9 2574}