config.c 31.5 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3
 *
Vicent Marti committed
4 5
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
6 7 8
 */

#include "config.h"
9

10
#include "git2/config.h"
11
#include "git2/sys/config.h"
12

13
#include "config_backend.h"
14 15
#include "regexp.h"
#include "sysdir.h"
16
#include "transaction.h"
17
#include "vector.h"
18 19 20
#if GIT_WIN32
# include <windows.h>
#endif
21 22 23

#include <ctype.h>

24 25 26 27 28 29 30 31
void git_config_entry_free(git_config_entry *entry)
{
	if (!entry)
		return;

	entry->free(entry);
}

32
typedef struct {
33 34
	git_refcount rc;

35
	git_config_backend *backend;
36
	git_config_level_t level;
37
} backend_internal;
38

39
static void backend_internal_free(backend_internal *internal)
40
{
41
	git_config_backend *backend;
42

43 44
	backend = internal->backend;
	backend->free(backend);
45 46 47
	git__free(internal);
}

48
static void config_free(git_config *cfg)
49
{
50
	size_t i;
51
	backend_internal *internal;
52

53 54
	for (i = 0; i < cfg->backends.length; ++i) {
		internal = git_vector_get(&cfg->backends, i);
55
		GIT_REFCOUNT_DEC(internal, backend_internal_free);
56
	}
57

58
	git_vector_free(&cfg->backends);
59

60
	git__memzero(cfg, sizeof(*cfg));
61
	git__free(cfg);
62 63
}

64 65 66 67 68 69 70 71
void git_config_free(git_config *cfg)
{
	if (cfg == NULL)
		return;

	GIT_REFCOUNT_DEC(cfg, config_free);
}

72
static int config_backend_cmp(const void *a, const void *b)
73
{
74 75
	const backend_internal *bk_a = (const backend_internal *)(a);
	const backend_internal *bk_b = (const backend_internal *)(b);
76

77
	return bk_b->level - bk_a->level;
78 79
}

80
int git_config_new(git_config **out)
81 82 83 84
{
	git_config *cfg;

	cfg = git__malloc(sizeof(git_config));
85
	GIT_ERROR_CHECK_ALLOC(cfg);
86 87 88

	memset(cfg, 0x0, sizeof(git_config));

89
	if (git_vector_init(&cfg->backends, 3, config_backend_cmp) < 0) {
90
		git__free(cfg);
Vicent Martí committed
91
		return -1;
92
	}
93

94
	*out = cfg;
95
	GIT_REFCOUNT_INC(cfg);
Vicent Martí committed
96
	return 0;
97
}
98

99 100 101
int git_config_add_file_ondisk(
	git_config *cfg,
	const char *path,
102
	git_config_level_t level,
103
	const git_repository *repo,
104
	int force)
105
{
Ben Straub committed
106
	git_config_backend *file = NULL;
107
	struct stat st;
108
	int res;
109

110 111
	GIT_ASSERT_ARG(cfg);
	GIT_ASSERT_ARG(path);
112

113
	res = p_stat(path, &st);
114
	if (res < 0 && errno != ENOENT && errno != ENOTDIR) {
115
		git_error_set(GIT_ERROR_CONFIG, "failed to stat '%s'", path);
116
		return -1;
117 118
	}

119
	if (git_config_backend_from_file(&file, path) < 0)
Vicent Martí committed
120
		return -1;
121

122
	if ((res = git_config_add_backend(cfg, file, level, repo, force)) < 0) {
Vicent Marti committed
123 124 125 126 127
		/*
		 * free manually; the file is not owned by the config
		 * instance yet and will not be freed on cleanup
		 */
		file->free(file);
128
		return res;
129 130
	}

Vicent Martí committed
131
	return 0;
132 133
}

134
int git_config_open_ondisk(git_config **out, const char *path)
135
{
136 137
	int error;
	git_config *config;
138

139 140 141
	*out = NULL;

	if (git_config_new(&config) < 0)
Vicent Martí committed
142
		return -1;
143

144
	if ((error = git_config_add_file_ondisk(config, path, GIT_CONFIG_LEVEL_LOCAL, NULL, 0)) < 0)
145 146 147 148 149
		git_config_free(config);
	else
		*out = config;

	return error;
150 151
}

152 153
int git_config_snapshot(git_config **out, git_config *in)
{
154
	int error = 0;
155
	size_t i;
156
	backend_internal *internal;
157 158 159 160 161 162 163
	git_config *config;

	*out = NULL;

	if (git_config_new(&config) < 0)
		return -1;

164
	git_vector_foreach(&in->backends, i, internal) {
165 166
		git_config_backend *b;

167
		if ((error = internal->backend->snapshot(&b, internal->backend)) < 0)
168
			break;
169

170
		if ((error = git_config_add_backend(config, b, internal->level, NULL, 0)) < 0) {
171
			b->free(b);
172
			break;
173 174 175
		}
	}

176 177 178 179
	if (error < 0)
		git_config_free(config);
	else
		*out = config;
180 181 182 183

	return error;
}

184 185
static int find_backend_by_level(
	backend_internal **out,
Ben Straub committed
186
	const git_config *cfg,
187
	git_config_level_t level)
188 189
{
	int pos = -1;
190
	backend_internal *internal;
191
	size_t i;
192

193 194
	/* when passing GIT_CONFIG_HIGHEST_LEVEL, the idea is to get the config backend
	 * which has the highest level. As config backends are stored in a vector
195
	 * sorted by decreasing order of level, getting the backend at position 0
196 197 198 199 200
	 * will do the job.
	 */
	if (level == GIT_CONFIG_HIGHEST_LEVEL) {
		pos = 0;
	} else {
201
		git_vector_foreach(&cfg->backends, i, internal) {
202
			if (internal->level == level)
Russell Belfer committed
203
				pos = (int)i;
204 205 206 207
		}
	}

	if (pos == -1) {
208
		git_error_set(GIT_ERROR_CONFIG,
209
			"no configuration exists for the given level '%i'", (int)level);
210 211 212
		return GIT_ENOTFOUND;
	}

213
	*out = git_vector_get(&cfg->backends, pos);
214 215 216 217 218 219

	return 0;
}

static int duplicate_level(void **old_raw, void *new_raw)
{
220
	backend_internal **old = (backend_internal **)old_raw;
221 222 223

	GIT_UNUSED(new_raw);

224
	git_error_set(GIT_ERROR_CONFIG, "there already exists a configuration for the given level (%i)", (int)(*old)->level);
225 226 227
	return GIT_EEXISTS;
}

228
static void try_remove_existing_backend(
229
	git_config *cfg,
230
	git_config_level_t level)
231 232
{
	int pos = -1;
233
	backend_internal *internal;
234
	size_t i;
235

236
	git_vector_foreach(&cfg->backends, i, internal) {
237
		if (internal->level == level)
Russell Belfer committed
238
			pos = (int)i;
239 240 241 242 243
	}

	if (pos == -1)
		return;

244
	internal = git_vector_get(&cfg->backends, pos);
245

246
	if (git_vector_remove(&cfg->backends, pos) < 0)
247 248
		return;

249
	GIT_REFCOUNT_DEC(internal, backend_internal_free);
250 251 252 253
}

static int git_config__add_internal(
	git_config *cfg,
254
	backend_internal *internal,
255
	git_config_level_t level,
256 257 258 259
	int force)
{
	int result;

260
	/* delete existing config backend for level if it exists */
261
	if (force)
262
		try_remove_existing_backend(cfg, level);
263

264
	if ((result = git_vector_insert_sorted(&cfg->backends,
265 266 267
			internal, &duplicate_level)) < 0)
		return result;

268
	git_vector_sort(&cfg->backends);
269
	internal->backend->cfg = cfg;
270 271 272 273 274 275

	GIT_REFCOUNT_INC(internal);

	return 0;
}

276 277 278 279 280 281 282 283
int git_config_open_global(git_config **cfg_out, git_config *cfg)
{
	if (!git_config_open_level(cfg_out, cfg, GIT_CONFIG_LEVEL_XDG))
		return 0;

	return git_config_open_level(cfg_out, cfg, GIT_CONFIG_LEVEL_GLOBAL);
}

284
int git_config_open_level(
Linquize committed
285 286
	git_config **cfg_out,
	const git_config *cfg_parent,
287
	git_config_level_t level)
288 289
{
	git_config *cfg;
290
	backend_internal *internal;
291 292
	int res;

293
	if ((res = find_backend_by_level(&internal, cfg_parent, level)) < 0)
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
		return res;

	if ((res = git_config_new(&cfg)) < 0)
		return res;

	if ((res = git_config__add_internal(cfg, internal, level, true)) < 0) {
		git_config_free(cfg);
		return res;
	}

	*cfg_out = cfg;

	return 0;
}

Ben Straub committed
309
int git_config_add_backend(
310
	git_config *cfg,
311
	git_config_backend *backend,
312
	git_config_level_t level,
313
	const git_repository *repo,
314
	int force)
315
{
316
	backend_internal *internal;
Vicent Martí committed
317
	int result;
318

319 320
	GIT_ASSERT_ARG(cfg);
	GIT_ASSERT_ARG(backend);
321

322
	GIT_ERROR_CHECK_VERSION(backend, GIT_CONFIG_BACKEND_VERSION, "git_config_backend");
323

324
	if ((result = backend->open(backend, level, repo)) < 0)
Vicent Martí committed
325
		return result;
326

327
	internal = git__malloc(sizeof(backend_internal));
328
	GIT_ERROR_CHECK_ALLOC(internal);
329

330
	memset(internal, 0x0, sizeof(backend_internal));
331

332
	internal->backend = backend;
333
	internal->level = level;
334

335
	if ((result = git_config__add_internal(cfg, internal, level, force)) < 0) {
336
		git__free(internal);
337
		return result;
338
	}
339

Vicent Martí committed
340
	return 0;
341 342
}

343 344 345 346
/*
 * Loop over all the variables
 */

347 348 349 350
typedef struct {
	git_config_iterator parent;
	git_config_iterator *current;
	const git_config *cfg;
351
	git_regexp regex;
352 353 354 355 356
	size_t i;
} all_iter;

static int find_next_backend(size_t *out, const git_config *cfg, size_t i)
{
357
	backend_internal *internal;
358 359

	for (; i > 0; --i) {
360
		internal = git_vector_get(&cfg->backends, i - 1);
361
		if (!internal || !internal->backend)
362 363 364 365 366 367 368 369 370 371 372 373
			continue;

		*out = i;
		return 0;
	}

	return -1;
}

static int all_iter_next(git_config_entry **entry, git_config_iterator *_iter)
{
	all_iter *iter = (all_iter *) _iter;
374
	backend_internal *internal;
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
	git_config_backend *backend;
	size_t i;
	int error = 0;

	if (iter->current != NULL &&
	    (error = iter->current->next(entry, iter->current)) == 0) {
		return 0;
	}

	if (error < 0 && error != GIT_ITEROVER)
		return error;

	do {
		if (find_next_backend(&i, iter->cfg, iter->i) < 0)
			return GIT_ITEROVER;

391
		internal = git_vector_get(&iter->cfg->backends, i - 1);
392
		backend = internal->backend;
393 394 395 396 397 398 399 400 401 402 403 404 405
		iter->i = i - 1;

		if (iter->current)
			iter->current->free(iter->current);

		iter->current = NULL;
		error = backend->iterator(&iter->current, backend);
		if (error == GIT_ENOTFOUND)
			continue;

		if (error < 0)
			return error;

406 407 408 409 410 411
		error = iter->current->next(entry, iter->current);
		/* If this backend is empty, then keep going */
		if (error == GIT_ITEROVER)
			continue;

		return error;
412 413 414 415 416 417

	} while(1);

	return GIT_ITEROVER;
}

418 419 420 421 422 423 424 425 426 427 428
static int all_iter_glob_next(git_config_entry **entry, git_config_iterator *_iter)
{
	int error;
	all_iter *iter = (all_iter *) _iter;

	/*
	 * We use the "normal" function to grab the next one across
	 * backends and then apply the regex
	 */
	while ((error = all_iter_next(entry, _iter)) == 0) {
		/* skip non-matching keys if regexp was provided */
429
		if (git_regexp_match(&iter->regex, (*entry)->name) != 0)
430 431 432 433 434 435 436 437 438
			continue;

		/* and simply return if we like the entry's name */
		return 0;
	}

	return error;
}

439 440 441 442 443 444 445 446 447 448
static void all_iter_free(git_config_iterator *_iter)
{
	all_iter *iter = (all_iter *) _iter;

	if (iter->current)
		iter->current->free(iter->current);

	git__free(iter);
}

449 450 451 452
static void all_iter_glob_free(git_config_iterator *_iter)
{
	all_iter *iter = (all_iter *) _iter;

453
	git_regexp_dispose(&iter->regex);
454 455 456
	all_iter_free(_iter);
}

457 458 459 460 461
int git_config_iterator_new(git_config_iterator **out, const git_config *cfg)
{
	all_iter *iter;

	iter = git__calloc(1, sizeof(all_iter));
462
	GIT_ERROR_CHECK_ALLOC(iter);
463 464 465 466

	iter->parent.free = all_iter_free;
	iter->parent.next = all_iter_next;

467
	iter->i = cfg->backends.length;
468 469 470 471 472 473 474
	iter->cfg = cfg;

	*out = (git_config_iterator *) iter;

	return 0;
}

475 476 477 478 479
int git_config_iterator_glob_new(git_config_iterator **out, const git_config *cfg, const char *regexp)
{
	all_iter *iter;
	int result;

480 481 482
	if (regexp == NULL)
		return git_config_iterator_new(out, cfg);

483
	iter = git__calloc(1, sizeof(all_iter));
484
	GIT_ERROR_CHECK_ALLOC(iter);
485

486
	if ((result = git_regexp_compile(&iter->regex, regexp, 0)) < 0) {
487
		git__free(iter);
488
		return -1;
489 490
	}

491 492
	iter->parent.next = all_iter_glob_next;
	iter->parent.free = all_iter_glob_free;
493
	iter->i = cfg->backends.length;
494 495 496 497 498 499 500
	iter->cfg = cfg;

	*out = (git_config_iterator *) iter;

	return 0;
}

501
int git_config_foreach(
Ben Straub committed
502
	const git_config *cfg, git_config_foreach_cb cb, void *payload)
503
{
Ben Straub committed
504
	return git_config_foreach_match(cfg, NULL, cb, payload);
505 506
}

507 508 509
int git_config_backend_foreach_match(
	git_config_backend *backend,
	const char *regexp,
510 511
	git_config_foreach_cb cb,
	void *payload)
512
{
513
	git_config_entry *entry;
514
	git_config_iterator *iter;
515
	git_regexp regex;
516
	int error = 0;
517

518 519
	GIT_ASSERT_ARG(backend);
	GIT_ASSERT_ARG(cb);
520

521 522
	if (regexp && git_regexp_compile(&regex, regexp, 0) < 0)
		return -1;
523

524
	if ((error = backend->iterator(&iter, backend)) < 0) {
525 526 527
		iter = NULL;
		return -1;
	}
528

529
	while (!(iter->next(&entry, iter) < 0)) {
530
		/* skip non-matching keys if regexp was provided */
531
		if (regexp && git_regexp_match(&regex, entry->name) != 0)
532 533 534
			continue;

		/* abort iterator on non-zero return value */
535
		if ((error = cb(entry, payload)) != 0) {
536
			git_error_set_after_callback(error);
537
			break;
538
		}
539 540 541
	}

	if (regexp != NULL)
542
		git_regexp_dispose(&regex);
543

544
	iter->free(iter);
545

546
	return error;
547 548
}

549
int git_config_foreach_match(
Ben Straub committed
550
	const git_config *cfg,
551
	const char *regexp,
Ben Straub committed
552 553
	git_config_foreach_cb cb,
	void *payload)
554
{
555 556 557
	int error;
	git_config_iterator *iter;
	git_config_entry *entry;
558

559 560 561
	if ((error = git_config_iterator_glob_new(&iter, cfg, regexp)) < 0)
		return error;

562 563
	while (!(error = git_config_next(&entry, iter))) {
		if ((error = cb(entry, payload)) != 0) {
564
			git_error_set_after_callback(error);
565 566 567
			break;
		}
	}
568

569 570 571 572 573 574
	git_config_iterator_free(iter);

	if (error == GIT_ITEROVER)
		error = 0;

	return error;
575 576
}

577
/**************
578
 * Setters
579
 **************/
580

581 582 583 584 585 586 587 588 589 590 591 592
typedef enum {
	BACKEND_USE_SET,
	BACKEND_USE_DELETE
} backend_use;

static const char *uses[] = {
    "set",
    "delete"
};

static int get_backend_for_use(git_config_backend **out,
	git_config *cfg, const char *name, backend_use use)
593
{
594
	size_t i;
595
	backend_internal *backend;
596 597 598

	*out = NULL;

599
	if (git_vector_length(&cfg->backends) == 0) {
600
		git_error_set(GIT_ERROR_CONFIG,
601
			"cannot %s value for '%s' when no config backends exist",
602 603 604 605
			uses[use], name);
		return GIT_ENOTFOUND;
	}

606 607 608
	git_vector_foreach(&cfg->backends, i, backend) {
		if (!backend->backend->readonly) {
			*out = backend->backend;
609 610 611 612
			return 0;
		}
	}

613
	git_error_set(GIT_ERROR_CONFIG,
614
		"cannot %s value for '%s' when all config backends are readonly",
615
		uses[use], name);
616 617 618
	return GIT_ENOTFOUND;
}

619 620
int git_config_delete_entry(git_config *cfg, const char *name)
{
621
	git_config_backend *backend;
622

623
	if (get_backend_for_use(&backend, cfg, name, BACKEND_USE_DELETE) < 0)
624
		return GIT_ENOTFOUND;
625

626
	return backend->del(backend, name);
627 628
}

629
int git_config_set_int64(git_config *cfg, const char *name, int64_t value)
630
{
Vicent Marti committed
631
	char str_value[32]; /* All numbers should fit in here */
632
	p_snprintf(str_value, sizeof(str_value), "%" PRId64, value);
Vicent Marti committed
633
	return git_config_set_string(cfg, name, str_value);
634
}
635

636
int git_config_set_int32(git_config *cfg, const char *name, int32_t value)
637
{
638
	return git_config_set_int64(cfg, name, (int64_t)value);
639 640
}

641 642
int git_config_set_bool(git_config *cfg, const char *name, int value)
{
Vicent Marti committed
643
	return git_config_set_string(cfg, name, value ? "true" : "false");
644
}
645

646 647
int git_config_set_string(git_config *cfg, const char *name, const char *value)
{
648
	int error;
649
	git_config_backend *backend;
650

651
	if (!value) {
652
		git_error_set(GIT_ERROR_CONFIG, "the value to set cannot be NULL");
653 654 655
		return -1;
	}

656
	if (get_backend_for_use(&backend, cfg, name, BACKEND_USE_SET) < 0)
657
		return GIT_ENOTFOUND;
658

659
	error = backend->set(backend, name, value);
660 661

	if (!error && GIT_REFCOUNT_OWNER(cfg) != NULL)
662
		git_repository__configmap_lookup_cache_clear(GIT_REFCOUNT_OWNER(cfg));
663 664

	return error;
665 666
}

667 668 669 670 671 672 673 674
int git_config__update_entry(
	git_config *config,
	const char *key,
	const char *value,
	bool overwrite_existing,
	bool only_if_existing)
{
	int error = 0;
675
	git_config_entry *ce = NULL;
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693

	if ((error = git_config__lookup_entry(&ce, config, key, false)) < 0)
		return error;

	if (!ce && only_if_existing) /* entry doesn't exist */
		return 0;
	if (ce && !overwrite_existing) /* entry would be overwritten */
		return 0;
	if (value && ce && ce->value && !strcmp(ce->value, value)) /* no change */
		return 0;
	if (!value && (!ce || !ce->value)) /* asked to delete absent entry */
		return 0;

	if (!value)
		error = git_config_delete_entry(config, key);
	else
		error = git_config_set_string(config, key, value);

694
	git_config_entry_free(ce);
695 696 697
	return error;
}

698 699 700
/***********
 * Getters
 ***********/
701 702 703

static int config_error_notfound(const char *name)
{
704
	git_error_set(GIT_ERROR_CONFIG, "config value '%s' was not found", name);
705 706 707 708 709 710 711 712 713 714
	return GIT_ENOTFOUND;
}

enum {
	GET_ALL_ERRORS = 0,
	GET_NO_MISSING = 1,
	GET_NO_ERRORS  = 2
};

static int get_entry(
715
	git_config_entry **out,
716 717 718 719 720 721 722 723 724
	const git_config *cfg,
	const char *name,
	bool normalize_name,
	int want_errors)
{
	int res = GIT_ENOTFOUND;
	const char *key = name;
	char *normalized = NULL;
	size_t i;
725
	backend_internal *internal;
726 727 728 729 730 731 732 733 734

	*out = NULL;

	if (normalize_name) {
		if ((res = git_config__normalize_name(name, &normalized)) < 0)
			goto cleanup;
		key = normalized;
	}

735
	res = GIT_ENOTFOUND;
736
	git_vector_foreach(&cfg->backends, i, internal) {
737
		if (!internal || !internal->backend)
738 739
			continue;

740
		res = internal->backend->get(internal->backend, key, out);
741 742 743 744 745 746 747 748 749 750
		if (res != GIT_ENOTFOUND)
			break;
	}

	git__free(normalized);

cleanup:
	if (res == GIT_ENOTFOUND)
		res = (want_errors > GET_ALL_ERRORS) ? 0 : config_error_notfound(name);
	else if (res && (want_errors == GET_NO_ERRORS)) {
751
		git_error_clear();
752 753 754 755 756 757 758
		res = 0;
	}

	return res;
}

int git_config_get_entry(
759
	git_config_entry **out, const git_config *cfg, const char *name)
760 761 762 763 764
{
	return get_entry(out, cfg, name, true, GET_ALL_ERRORS);
}

int git_config__lookup_entry(
765
	git_config_entry **out,
766 767 768 769 770 771 772 773
	const git_config *cfg,
	const char *key,
	bool no_errors)
{
	return get_entry(
		out, cfg, key, false, no_errors ? GET_NO_ERRORS : GET_NO_MISSING);
}

774 775
int git_config_get_mapped(
	int *out,
Ben Straub committed
776
	const git_config *cfg,
777
	const char *name,
778
	const git_configmap *maps,
779
	size_t map_n)
780
{
781
	git_config_entry *entry;
782
	int ret;
783

784
	if ((ret = get_entry(&entry, cfg, name, true, GET_ALL_ERRORS)) < 0)
785
		return ret;
786

787 788 789 790
	ret = git_config_lookup_map_value(out, maps, map_n, entry->value);
	git_config_entry_free(entry);

	return ret;
791 792
}

Ben Straub committed
793
int git_config_get_int64(int64_t *out, const git_config *cfg, const char *name)
794
{
795
	git_config_entry *entry;
796
	int ret;
797

798
	if ((ret = get_entry(&entry, cfg, name, true, GET_ALL_ERRORS)) < 0)
Vicent Martí committed
799
		return ret;
800

801 802 803 804
	ret = git_config_parse_int64(out, entry->value);
	git_config_entry_free(entry);

	return ret;
805 806
}

Ben Straub committed
807
int git_config_get_int32(int32_t *out, const git_config *cfg, const char *name)
808
{
809
	git_config_entry *entry;
Vicent Martí committed
810
	int ret;
811

812
	if ((ret = get_entry(&entry, cfg, name, true, GET_ALL_ERRORS)) < 0)
Vicent Martí committed
813
		return ret;
814

815 816 817 818
	ret = git_config_parse_int32(out, entry->value);
	git_config_entry_free(entry);

	return ret;
819 820
}

821
int git_config_get_bool(int *out, const git_config *cfg, const char *name)
822
{
823
	git_config_entry *entry;
824
	int ret;
825

826 827
	if ((ret = get_entry(&entry, cfg, name, true, GET_ALL_ERRORS)) < 0)
		return ret;
828

829 830 831 832 833 834 835 836 837
	ret = git_config_parse_bool(out, entry->value);
	git_config_entry_free(entry);

	return ret;
}

static int is_readonly(const git_config *cfg)
{
	size_t i;
838
	backend_internal *internal;
839

840
	git_vector_foreach(&cfg->backends, i, internal) {
841
		if (!internal || !internal->backend)
842 843
			continue;

844
		if (!internal->backend->readonly)
845 846 847 848
			return 0;
	}

	return 1;
849 850
}

851 852
int git_config_get_path(git_buf *out, const git_config *cfg, const char *name)
{
853
	git_config_entry *entry;
854 855 856 857 858
	int error;

	if ((error = get_entry(&entry, cfg, name, true, GET_ALL_ERRORS)) < 0)
		return error;

859 860 861 862
	 error = git_config_parse_path(out, entry->value);
	 git_config_entry_free(entry);

	 return error;
863 864
}

865 866
int git_config_get_string(
	const char **out, const git_config *cfg, const char *name)
867
{
868 869 870 871
	git_config_entry *entry;
	int ret;

	if (!is_readonly(cfg)) {
872
		git_error_set(GIT_ERROR_CONFIG, "get_string called on a live config object");
873 874 875 876
		return -1;
	}

	ret = get_entry(&entry, cfg, name, true, GET_ALL_ERRORS);
877
	*out = !ret ? (entry->value ? entry->value : "") : NULL;
878 879 880 881 882 883 884 885 886 887 888 889 890

	git_config_entry_free(entry);

	return ret;
}

int git_config_get_string_buf(
	git_buf *out, const git_config *cfg, const char *name)
{
	git_config_entry *entry;
	int ret;
	const char *str;

891 892
	if ((ret = git_buf_sanitize(out)) < 0)
		return ret;
893 894 895 896 897 898 899 900 901

	ret  = get_entry(&entry, cfg, name, true, GET_ALL_ERRORS);
	str = !ret ? (entry->value ? entry->value : "") : NULL;

	if (str)
		ret = git_buf_puts(out, str);

	git_config_entry_free(entry);

902
	return ret;
903 904
}

905
char *git_config__get_string_force(
906
	const git_config *cfg, const char *key, const char *fallback_value)
907
{
908 909 910
	git_config_entry *entry;
	char *ret;

911
	get_entry(&entry, cfg, key, false, GET_NO_ERRORS);
912 913 914 915
	ret = (entry && entry->value) ? git__strdup(entry->value) : fallback_value ? git__strdup(fallback_value) : NULL;
	git_config_entry_free(entry);

	return ret;
916 917
}

918 919
int git_config__get_bool_force(
	const git_config *cfg, const char *key, int fallback_value)
920
{
921
	int val = fallback_value;
922
	git_config_entry *entry;
923

924
	get_entry(&entry, cfg, key, false, GET_NO_ERRORS);
925

926
	if (entry && git_config_parse_bool(&val, entry->value) < 0)
927
		git_error_clear();
928

929
	git_config_entry_free(entry);
930
	return val;
931 932
}

933 934
int git_config__get_int_force(
	const git_config *cfg, const char *key, int fallback_value)
935
{
936
	int32_t val = (int32_t)fallback_value;
937
	git_config_entry *entry;
Vicent Martí committed
938

939
	get_entry(&entry, cfg, key, false, GET_NO_ERRORS);
940

941
	if (entry && git_config_parse_int32(&val, entry->value) < 0)
942
		git_error_clear();
943

944
	git_config_entry_free(entry);
945
	return (int)val;
946 947
}

948
int git_config_get_multivar_foreach(
949 950
	const git_config *cfg, const char *name, const char *regexp,
	git_config_foreach_cb cb, void *payload)
951
{
952 953 954
	int err, found;
	git_config_iterator *iter;
	git_config_entry *entry;
955

956
	if ((err = git_config_multivar_iterator_new(&iter, cfg, name, regexp)) < 0)
957
		return err;
958

959 960 961
	found = 0;
	while ((err = iter->next(&entry, iter)) == 0) {
		found = 1;
962

963
		if ((err = cb(entry, payload)) != 0) {
964
			git_error_set_after_callback(err);
965
			break;
966
		}
967 968
	}

969
	iter->free(iter);
970 971 972 973 974 975 976
	if (err == GIT_ITEROVER)
		err = 0;

	if (found == 0 && err == 0)
		err = config_error_notfound(name);

	return err;
977 978
}

979
typedef struct {
980
	git_config_iterator parent;
981
	git_config_iterator *iter;
982
	char *name;
983
	git_regexp regex;
984
	int have_regex;
985 986
} multivar_iter;

987
static int multivar_iter_next(git_config_entry **entry, git_config_iterator *_iter)
988 989
{
	multivar_iter *iter = (multivar_iter *) _iter;
990
	int error = 0;
991

992 993
	while ((error = iter->iter->next(entry, iter->iter)) == 0) {
		if (git__strcmp(iter->name, (*entry)->name))
994 995
			continue;

996 997
		if (!iter->have_regex)
			return 0;
998

999
		if (git_regexp_match(&iter->regex, (*entry)->value) == 0)
1000 1001
			return 0;
	}
1002

1003
	return error;
1004
}
1005

1006
static void multivar_iter_free(git_config_iterator *_iter)
1007 1008 1009
{
	multivar_iter *iter = (multivar_iter *) _iter;

1010
	iter->iter->free(iter->iter);
1011

1012
	git__free(iter->name);
1013
	if (iter->have_regex)
1014
		git_regexp_dispose(&iter->regex);
1015 1016 1017
	git__free(iter);
}

1018
int git_config_multivar_iterator_new(git_config_iterator **out, const git_config *cfg, const char *name, const char *regexp)
1019
{
1020 1021 1022 1023 1024 1025
	multivar_iter *iter = NULL;
	git_config_iterator *inner = NULL;
	int error;

	if ((error = git_config_iterator_new(&inner, cfg)) < 0)
		return error;
1026

1027
	iter = git__calloc(1, sizeof(multivar_iter));
1028
	GIT_ERROR_CHECK_ALLOC(iter);
1029

1030 1031
	if ((error = git_config__normalize_name(name, &iter->name)) < 0)
		goto on_error;
1032 1033

	if (regexp != NULL) {
1034
		if ((error = git_regexp_compile(&iter->regex, regexp, 0)) < 0)
1035 1036 1037
			goto on_error;

		iter->have_regex = 1;
1038 1039
	}

1040
	iter->iter = inner;
1041
	iter->parent.free = multivar_iter_free;
1042
	iter->parent.next = multivar_iter_next;
1043

1044 1045 1046
	*out = (git_config_iterator *) iter;

	return 0;
1047 1048 1049 1050 1051 1052

on_error:

	inner->free(inner);
	git__free(iter);
	return error;
1053 1054
}

1055 1056
int git_config_set_multivar(git_config *cfg, const char *name, const char *regexp, const char *value)
{
1057
	git_config_backend *backend;
1058

1059
	if (get_backend_for_use(&backend, cfg, name, BACKEND_USE_DELETE) < 0)
1060
		return GIT_ENOTFOUND;
1061

1062
	return backend->set_multivar(backend, name, regexp, value);
1063 1064
}

1065 1066
int git_config_delete_multivar(git_config *cfg, const char *name, const char *regexp)
{
1067
	git_config_backend *backend;
1068

1069
	if (get_backend_for_use(&backend, cfg, name, BACKEND_USE_DELETE) < 0)
1070
		return GIT_ENOTFOUND;
1071

1072
	return backend->del_multivar(backend, name, regexp);
1073 1074
}

1075 1076 1077 1078 1079 1080 1081
int git_config_next(git_config_entry **entry, git_config_iterator *iter)
{
	return iter->next(entry, iter);
}

void git_config_iterator_free(git_config_iterator *iter)
{
1082 1083 1084
	if (iter == NULL)
		return;

1085 1086 1087
	iter->free(iter);
}

1088
int git_config_find_global(git_buf *path)
1089
{
1090 1091 1092 1093 1094
	int error;

	if ((error = git_buf_sanitize(path)) < 0)
		return error;

1095
	return git_sysdir_find_global_file(path, GIT_CONFIG_FILENAME_GLOBAL);
1096 1097
}

1098
int git_config_find_xdg(git_buf *path)
1099
{
1100 1101 1102 1103 1104
	int error;

	if ((error = git_buf_sanitize(path)) < 0)
		return error;

1105
	return git_sysdir_find_xdg_file(path, GIT_CONFIG_FILENAME_XDG);
1106 1107
}

1108
int git_config_find_system(git_buf *path)
1109
{
1110 1111 1112 1113 1114
	int error;

	if ((error = git_buf_sanitize(path)) < 0)
		return error;

1115
	return git_sysdir_find_system_file(path, GIT_CONFIG_FILENAME_SYSTEM);
1116 1117
}

1118 1119
int git_config_find_programdata(git_buf *path)
{
1120 1121 1122
	git_path_owner_t owner_level =
		GIT_PATH_OWNER_CURRENT_USER |
		GIT_PATH_OWNER_ADMINISTRATOR;
1123
	bool is_safe;
1124
	int ret;
1125

1126 1127 1128
	if ((ret = git_buf_sanitize(path)) < 0 ||
	    (ret = git_sysdir_find_programdata_file(path,
	       GIT_CONFIG_FILENAME_PROGRAMDATA)) < 0 ||
1129
	    (ret = git_path_owner_is(&is_safe, path->ptr, owner_level)) < 0)
1130 1131
		return ret;

1132 1133 1134 1135
	if (!is_safe) {
		git_error_set(GIT_ERROR_CONFIG, "programdata path has invalid ownership");
		return -1;
	}
1136

1137
	return 0;
1138 1139
}

1140 1141 1142 1143 1144
int git_config__global_location(git_buf *buf)
{
	const git_buf *paths;
	const char *sep, *start;

1145
	if (git_sysdir_get(&paths, GIT_SYSDIR_GLOBAL) < 0)
1146 1147 1148
		return -1;

	/* no paths, so give up */
1149
	if (!paths || !git_buf_len(paths))
1150 1151
		return -1;

1152 1153 1154 1155 1156 1157
	/* find unescaped separator or end of string */
	for (sep = start = git_buf_cstr(paths); *sep; ++sep) {
		if (*sep == GIT_PATH_LIST_SEPARATOR &&
			(sep <= start || sep[-1] != '\\'))
			break;
	}
1158

1159
	if (git_buf_set(buf, start, (size_t)(sep - start)) < 0)
1160 1161 1162 1163 1164
		return -1;

	return git_buf_joinpath(buf, buf->ptr, GIT_CONFIG_FILENAME_GLOBAL);
}

1165
int git_config_open_default(git_config **out)
1166 1167 1168 1169 1170
{
	int error;
	git_config *cfg = NULL;
	git_buf buf = GIT_BUF_INIT;

1171 1172
	if ((error = git_config_new(&cfg)) < 0)
		return error;
1173

1174
	if (!git_config_find_global(&buf) || !git_config__global_location(&buf)) {
1175
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1176
			GIT_CONFIG_LEVEL_GLOBAL, NULL, 0);
1177
	}
1178

1179
	if (!error && !git_config_find_xdg(&buf))
1180
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1181
			GIT_CONFIG_LEVEL_XDG, NULL, 0);
1182

1183
	if (!error && !git_config_find_system(&buf))
1184
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1185
			GIT_CONFIG_LEVEL_SYSTEM, NULL, 0);
1186

1187 1188
	if (!error && !git_config_find_programdata(&buf))
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1189
			GIT_CONFIG_LEVEL_PROGRAMDATA, NULL, 0);
1190

1191
	git_buf_dispose(&buf);
1192

1193
	if (error) {
1194 1195 1196 1197 1198 1199 1200 1201
		git_config_free(cfg);
		cfg = NULL;
	}

	*out = cfg;

	return error;
}
1202

1203
int git_config_lock(git_transaction **out, git_config *cfg)
1204
{
1205
	int error;
1206
	git_config_backend *backend;
1207
	backend_internal *internal;
1208

1209
	GIT_ASSERT_ARG(cfg);
1210

1211
	internal = git_vector_get(&cfg->backends, 0);
1212
	if (!internal || !internal->backend) {
1213
		git_error_set(GIT_ERROR_CONFIG, "cannot lock; the config has no backends");
1214 1215
		return -1;
	}
1216
	backend = internal->backend;
1217

1218
	if ((error = backend->lock(backend)) < 0)
1219 1220 1221
		return error;

	return git_transaction_config_new(out, cfg);
1222 1223 1224 1225
}

int git_config_unlock(git_config *cfg, int commit)
{
1226
	git_config_backend *backend;
1227
	backend_internal *internal;
1228

1229
	GIT_ASSERT_ARG(cfg);
1230

1231
	internal = git_vector_get(&cfg->backends, 0);
1232
	if (!internal || !internal->backend) {
1233
		git_error_set(GIT_ERROR_CONFIG, "cannot lock; the config has no backends");
1234 1235 1236
		return -1;
	}

1237
	backend = internal->backend;
1238

1239
	return backend->unlock(backend, commit);
1240 1241
}

1242 1243 1244
/***********
 * Parsers
 ***********/
1245

1246 1247
int git_config_lookup_map_value(
	int *out,
1248
	const git_configmap *maps,
1249 1250 1251 1252 1253 1254
	size_t map_n,
	const char *value)
{
	size_t i;

	for (i = 0; i < map_n; ++i) {
1255
		const git_configmap *m = maps + i;
1256

1257 1258 1259
		switch (m->type) {
		case GIT_CONFIGMAP_FALSE:
		case GIT_CONFIGMAP_TRUE: {
1260 1261
			int bool_val;

1262
			if (git_config_parse_bool(&bool_val, value) == 0 &&
1263
				bool_val == (int)m->type) {
1264 1265 1266 1267 1268 1269
				*out = m->map_value;
				return 0;
			}
			break;
		}

1270
		case GIT_CONFIGMAP_INT32:
1271 1272 1273 1274
			if (git_config_parse_int32(out, value) == 0)
				return 0;
			break;

1275
		case GIT_CONFIGMAP_STRING:
1276
			if (value && strcasecmp(value, m->str_match) == 0) {
1277 1278 1279 1280 1281 1282 1283
				*out = m->map_value;
				return 0;
			}
			break;
		}
	}

1284
	git_error_set(GIT_ERROR_CONFIG, "failed to map '%s'", value);
1285 1286 1287
	return -1;
}

1288 1289
int git_config_lookup_map_enum(git_configmap_t *type_out, const char **str_out,
			       const git_configmap *maps, size_t map_n, int enum_val)
1290 1291 1292 1293
{
	size_t i;

	for (i = 0; i < map_n; i++) {
1294
		const git_configmap *m = &maps[i];
1295 1296 1297 1298

		if (m->map_value != enum_val)
			continue;

1299
		*type_out = m->type;
1300 1301 1302 1303
		*str_out = m->str_match;
		return 0;
	}

1304
	git_error_set(GIT_ERROR_CONFIG, "invalid enum value");
1305 1306 1307
	return GIT_ENOTFOUND;
}

1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
int git_config_parse_bool(int *out, const char *value)
{
	if (git__parse_bool(out, value) == 0)
		return 0;

	if (git_config_parse_int32(out, value) == 0) {
		*out = !!(*out);
		return 0;
	}

1318
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as a boolean value", value);
1319 1320 1321 1322 1323 1324 1325 1326
	return -1;
}

int git_config_parse_int64(int64_t *out, const char *value)
{
	const char *num_end;
	int64_t num;

1327
	if (!value || git__strntol64(&num, value, strlen(value), &num_end, 0) < 0)
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
		goto fail_parse;

	switch (*num_end) {
	case 'g':
	case 'G':
		num *= 1024;
		/* fallthrough */

	case 'm':
	case 'M':
		num *= 1024;
		/* fallthrough */

	case 'k':
	case 'K':
		num *= 1024;

		/* check that that there are no more characters after the
		 * given modifier suffix */
		if (num_end[1] != '\0')
			return -1;

		/* fallthrough */

	case '\0':
		*out = num;
		return 0;

	default:
		goto fail_parse;
	}

fail_parse:
1361
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as an integer", value ? value : "(null)");
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
	return -1;
}

int git_config_parse_int32(int32_t *out, const char *value)
{
	int64_t tmp;
	int32_t truncate;

	if (git_config_parse_int64(&tmp, value) < 0)
		goto fail_parse;

	truncate = tmp & 0xFFFFFFFF;
	if (truncate != tmp)
		goto fail_parse;

	*out = truncate;
	return 0;

fail_parse:
1381
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as a 32-bit integer", value ? value : "(null)");
1382 1383
	return -1;
}
1384

1385 1386
int git_config_parse_path(git_buf *out, const char *value)
{
1387 1388
	int error;

1389 1390
	GIT_ASSERT_ARG(out);
	GIT_ASSERT_ARG(value);
1391

1392 1393
	if ((error = git_buf_sanitize(out)) < 0)
		return error;
1394 1395 1396

	if (value[0] == '~') {
		if (value[1] != '\0' && value[1] != '/') {
1397
			git_error_set(GIT_ERROR_CONFIG, "retrieving a homedir by name is not supported");
1398 1399 1400
			return -1;
		}

1401
		return git_sysdir_expand_global_file(out, value[1] ? &value[2] : NULL);
1402 1403 1404 1405 1406
	}

	return git_buf_sets(out, value);
}

1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
static int normalize_section(char *start, char *end)
{
	char *scan;

	if (start == end)
		return GIT_EINVALIDSPEC;

	/* Validate and downcase range */
	for (scan = start; *scan; ++scan) {
		if (end && scan >= end)
			break;
		if (isalnum(*scan))
			*scan = (char)git__tolower(*scan);
		else if (*scan != '-' || scan == start)
			return GIT_EINVALIDSPEC;
	}

	if (scan == start)
		return GIT_EINVALIDSPEC;

	return 0;
}


1431 1432 1433 1434 1435
/* Take something the user gave us and make it nice for our hash function */
int git_config__normalize_name(const char *in, char **out)
{
	char *name, *fdot, *ldot;

1436 1437
	GIT_ASSERT_ARG(in);
	GIT_ASSERT_ARG(out);
1438 1439

	name = git__strdup(in);
1440
	GIT_ERROR_CHECK_ALLOC(name);
1441 1442 1443 1444 1445 1446 1447 1448

	fdot = strchr(name, '.');
	ldot = strrchr(name, '.');

	if (fdot == NULL || fdot == name || ldot == NULL || !ldot[1])
		goto invalid;

	/* Validate and downcase up to first dot and after last dot */
1449 1450
	if (normalize_section(name, fdot) < 0 ||
	    normalize_section(ldot + 1, NULL) < 0)
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
		goto invalid;

	/* If there is a middle range, make sure it doesn't have newlines */
	while (fdot < ldot)
		if (*fdot++ == '\n')
			goto invalid;

	*out = name;
	return 0;

invalid:
	git__free(name);
1463
	git_error_set(GIT_ERROR_CONFIG, "invalid config item name '%s'", in);
1464 1465 1466
	return GIT_EINVALIDSPEC;
}

1467
struct rename_data {
1468
	git_config *config;
1469 1470
	git_buf *name;
	size_t old_len;
1471 1472 1473 1474 1475 1476
};

static int rename_config_entries_cb(
	const git_config_entry *entry,
	void *payload)
{
1477
	int error = 0;
1478
	struct rename_data *data = (struct rename_data *)payload;
1479
	size_t base_len = git_buf_len(data->name);
1480

1481 1482 1483
	if (base_len > 0 &&
		!(error = git_buf_puts(data->name, entry->name + data->old_len)))
	{
1484
		error = git_config_set_string(
1485
			data->config, git_buf_cstr(data->name), entry->value);
1486

1487
		git_buf_truncate(data->name, base_len);
1488 1489
	}

1490 1491 1492
	if (!error)
		error = git_config_delete_entry(data->config, entry->name);

1493
	return error;
1494 1495 1496 1497 1498 1499 1500 1501
}

int git_config_rename_section(
	git_repository *repo,
	const char *old_section_name,
	const char *new_section_name)
{
	git_config *config;
1502 1503
	git_buf pattern = GIT_BUF_INIT, replace = GIT_BUF_INIT;
	int error = 0;
1504 1505
	struct rename_data data;

1506
	git_buf_puts_escape_regex(&pattern, old_section_name);
1507 1508 1509 1510 1511

	if ((error = git_buf_puts(&pattern, "\\..+")) < 0)
		goto cleanup;

	if ((error = git_repository_config__weakptr(&config, repo)) < 0)
1512 1513
		goto cleanup;

1514 1515 1516 1517 1518
	data.config  = config;
	data.name    = &replace;
	data.old_len = strlen(old_section_name) + 1;

	if ((error = git_buf_join(&replace, '.', new_section_name, "")) < 0)
1519 1520
		goto cleanup;

1521
	if (new_section_name != NULL &&
1522
	    (error = normalize_section(replace.ptr, strchr(replace.ptr, '.'))) < 0)
1523
	{
1524 1525
		git_error_set(
			GIT_ERROR_CONFIG, "invalid config section '%s'", new_section_name);
1526
		goto cleanup;
1527 1528
	}

1529 1530 1531
	error = git_config_foreach_match(
		config, git_buf_cstr(&pattern), rename_config_entries_cb, &data);

1532
cleanup:
1533 1534
	git_buf_dispose(&pattern);
	git_buf_dispose(&replace);
1535

1536 1537
	return error;
}
1538

1539
int git_config_init_backend(git_config_backend *backend, unsigned int version)
1540
{
1541 1542 1543
	GIT_INIT_STRUCTURE_FROM_TEMPLATE(
		backend, version, git_config_backend, GIT_CONFIG_BACKEND_INIT);
	return 0;
1544
}