config.c 32.2 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 "buf.h"
14
#include "config_backend.h"
15 16
#include "regexp.h"
#include "sysdir.h"
17
#include "transaction.h"
18
#include "vector.h"
19 20 21
#if GIT_WIN32
# include <windows.h>
#endif
22 23 24

#include <ctype.h>

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

	entry->free(entry);
}

33
typedef struct {
34 35
	git_refcount rc;

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

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

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

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

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

59
	git_vector_free(&cfg->backends);
60

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

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

	GIT_REFCOUNT_DEC(cfg, config_free);
}

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

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

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

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

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

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

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

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

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

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

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

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

Vicent Martí committed
132
	return 0;
133 134
}

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

140 141 142
	*out = NULL;

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

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

	return error;
151 152
}

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

	*out = NULL;

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

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

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

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

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

	return error;
}

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

194 195
	/* 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
196
	 * sorted by decreasing order of level, getting the backend at position 0
197 198 199 200 201
	 * will do the job.
	 */
	if (level == GIT_CONFIG_HIGHEST_LEVEL) {
		pos = 0;
	} else {
202
		git_vector_foreach(&cfg->backends, i, internal) {
203
			if (internal->level == level)
Russell Belfer committed
204
				pos = (int)i;
205 206 207 208
		}
	}

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

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

	return 0;
}

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

	GIT_UNUSED(new_raw);

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

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

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

	if (pos == -1)
		return;

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

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

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

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

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

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

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

	GIT_REFCOUNT_INC(internal);

	return 0;
}

277 278 279 280 281 282 283 284
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);
}

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

294
	if ((res = find_backend_by_level(&internal, cfg_parent, level)) < 0)
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
		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
310
int git_config_add_backend(
311
	git_config *cfg,
312
	git_config_backend *backend,
313
	git_config_level_t level,
314
	const git_repository *repo,
315
	int force)
316
{
317
	backend_internal *internal;
Vicent Martí committed
318
	int result;
319

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

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

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

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

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

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

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

Vicent Martí committed
341
	return 0;
342 343
}

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

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

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

	for (; i > 0; --i) {
361
		internal = git_vector_get(&cfg->backends, i - 1);
362
		if (!internal || !internal->backend)
363 364 365 366 367 368 369 370 371 372 373 374
			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;
375
	backend_internal *internal;
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
	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;

392
		internal = git_vector_get(&iter->cfg->backends, i - 1);
393
		backend = internal->backend;
394 395 396 397 398 399 400 401 402 403 404 405 406
		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;

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

		return error;
413 414 415 416 417 418

	} while(1);

	return GIT_ITEROVER;
}

419 420 421 422 423 424 425 426 427 428 429
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 */
430
		if (git_regexp_match(&iter->regex, (*entry)->name) != 0)
431 432 433 434 435 436 437 438 439
			continue;

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

	return error;
}

440 441 442 443 444 445 446 447 448 449
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);
}

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

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

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

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

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

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

	*out = (git_config_iterator *) iter;

	return 0;
}

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

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

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

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

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

	*out = (git_config_iterator *) iter;

	return 0;
}

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

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

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

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

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

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

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

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

545
	iter->free(iter);
546

547
	return error;
548 549
}

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

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

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

570 571 572 573 574 575
	git_config_iterator_free(iter);

	if (error == GIT_ITEROVER)
		error = 0;

	return error;
576 577
}

578
/**************
579
 * Setters
580
 **************/
581

582 583 584 585 586 587 588 589 590 591 592 593
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)
594
{
595
	size_t i;
596
	backend_internal *backend;
597 598 599

	*out = NULL;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return error;
666 667
}

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

	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);

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

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

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

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

static int get_entry(
716
	git_config_entry **out,
717 718 719 720 721 722 723 724 725
	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;
726
	backend_internal *internal;
727 728 729 730 731 732 733 734 735

	*out = NULL;

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

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

741
		res = internal->backend->get(internal->backend, key, out);
742 743 744 745 746 747 748 749 750 751
		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)) {
752
		git_error_clear();
753 754 755 756 757 758 759
		res = 0;
	}

	return res;
}

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

int git_config__lookup_entry(
766
	git_config_entry **out,
767 768 769 770 771 772 773 774
	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);
}

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

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

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

	return ret;
792 793
}

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

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

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

	return ret;
806 807
}

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

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

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

	return ret;
820 821
}

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

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

830 831 832 833 834 835 836 837 838
	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;
839
	backend_internal *internal;
840

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

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

	return 1;
850 851
}

852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
static int git_config__parse_path(git_str *out, const char *value)
{
	GIT_ASSERT_ARG(out);
	GIT_ASSERT_ARG(value);

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

		return git_sysdir_expand_global_file(out, value[1] ? &value[2] : NULL);
	}

	return git_str_sets(out, value);
}

int git_config_parse_path(git_buf *out, const char *value)
{
	GIT_BUF_WRAP_PRIVATE(out, git_config__parse_path, value);
}

int git_config_get_path(
	git_buf *out,
	const git_config *cfg,
	const char *name)
{
	GIT_BUF_WRAP_PRIVATE(out, git_config__get_path, cfg, name);
}

int git_config__get_path(
	git_str *out,
	const git_config *cfg,
	const char *name)
886
{
887
	git_config_entry *entry;
888 889 890 891 892
	int error;

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

893
	 error = git_config__parse_path(out, entry->value);
894 895 896
	 git_config_entry_free(entry);

	 return error;
897 898
}

899 900
int git_config_get_string(
	const char **out, const git_config *cfg, const char *name)
901
{
902 903 904 905
	git_config_entry *entry;
	int ret;

	if (!is_readonly(cfg)) {
906
		git_error_set(GIT_ERROR_CONFIG, "get_string called on a live config object");
907 908 909 910
		return -1;
	}

	ret = get_entry(&entry, cfg, name, true, GET_ALL_ERRORS);
911
	*out = !ret ? (entry->value ? entry->value : "") : NULL;
912 913 914 915 916 917 918 919 920

	git_config_entry_free(entry);

	return ret;
}

int git_config_get_string_buf(
	git_buf *out, const git_config *cfg, const char *name)
{
921 922 923 924 925 926
	GIT_BUF_WRAP_PRIVATE(out, git_config__get_string_buf, cfg, name);
}

int git_config__get_string_buf(
	git_str *out, const git_config *cfg, const char *name)
{
927 928 929 930
	git_config_entry *entry;
	int ret;
	const char *str;

931 932
	GIT_ASSERT_ARG(out);
	GIT_ASSERT_ARG(cfg);
933 934 935 936 937

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

	if (str)
938
		ret = git_str_puts(out, str);
939 940 941

	git_config_entry_free(entry);

942
	return ret;
943 944
}

945
char *git_config__get_string_force(
946
	const git_config *cfg, const char *key, const char *fallback_value)
947
{
948 949 950
	git_config_entry *entry;
	char *ret;

951
	get_entry(&entry, cfg, key, false, GET_NO_ERRORS);
952 953 954 955
	ret = (entry && entry->value) ? git__strdup(entry->value) : fallback_value ? git__strdup(fallback_value) : NULL;
	git_config_entry_free(entry);

	return ret;
956 957
}

958 959
int git_config__get_bool_force(
	const git_config *cfg, const char *key, int fallback_value)
960
{
961
	int val = fallback_value;
962
	git_config_entry *entry;
963

964
	get_entry(&entry, cfg, key, false, GET_NO_ERRORS);
965

966
	if (entry && git_config_parse_bool(&val, entry->value) < 0)
967
		git_error_clear();
968

969
	git_config_entry_free(entry);
970
	return val;
971 972
}

973 974
int git_config__get_int_force(
	const git_config *cfg, const char *key, int fallback_value)
975
{
976
	int32_t val = (int32_t)fallback_value;
977
	git_config_entry *entry;
Vicent Martí committed
978

979
	get_entry(&entry, cfg, key, false, GET_NO_ERRORS);
980

981
	if (entry && git_config_parse_int32(&val, entry->value) < 0)
982
		git_error_clear();
983

984
	git_config_entry_free(entry);
985
	return (int)val;
986 987
}

988
int git_config_get_multivar_foreach(
989 990
	const git_config *cfg, const char *name, const char *regexp,
	git_config_foreach_cb cb, void *payload)
991
{
992 993 994
	int err, found;
	git_config_iterator *iter;
	git_config_entry *entry;
995

996
	if ((err = git_config_multivar_iterator_new(&iter, cfg, name, regexp)) < 0)
997
		return err;
998

999 1000 1001
	found = 0;
	while ((err = iter->next(&entry, iter)) == 0) {
		found = 1;
1002

1003
		if ((err = cb(entry, payload)) != 0) {
1004
			git_error_set_after_callback(err);
1005
			break;
1006
		}
1007 1008
	}

1009
	iter->free(iter);
1010 1011 1012 1013 1014 1015 1016
	if (err == GIT_ITEROVER)
		err = 0;

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

	return err;
1017 1018
}

1019
typedef struct {
1020
	git_config_iterator parent;
1021
	git_config_iterator *iter;
1022
	char *name;
1023
	git_regexp regex;
1024
	int have_regex;
1025 1026
} multivar_iter;

1027
static int multivar_iter_next(git_config_entry **entry, git_config_iterator *_iter)
1028 1029
{
	multivar_iter *iter = (multivar_iter *) _iter;
1030
	int error = 0;
1031

1032 1033
	while ((error = iter->iter->next(entry, iter->iter)) == 0) {
		if (git__strcmp(iter->name, (*entry)->name))
1034 1035
			continue;

1036 1037
		if (!iter->have_regex)
			return 0;
1038

1039
		if (git_regexp_match(&iter->regex, (*entry)->value) == 0)
1040 1041
			return 0;
	}
1042

1043
	return error;
1044
}
1045

1046
static void multivar_iter_free(git_config_iterator *_iter)
1047 1048 1049
{
	multivar_iter *iter = (multivar_iter *) _iter;

1050
	iter->iter->free(iter->iter);
1051

1052
	git__free(iter->name);
1053
	if (iter->have_regex)
1054
		git_regexp_dispose(&iter->regex);
1055 1056 1057
	git__free(iter);
}

1058
int git_config_multivar_iterator_new(git_config_iterator **out, const git_config *cfg, const char *name, const char *regexp)
1059
{
1060 1061 1062 1063 1064 1065
	multivar_iter *iter = NULL;
	git_config_iterator *inner = NULL;
	int error;

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

1067
	iter = git__calloc(1, sizeof(multivar_iter));
1068
	GIT_ERROR_CHECK_ALLOC(iter);
1069

1070 1071
	if ((error = git_config__normalize_name(name, &iter->name)) < 0)
		goto on_error;
1072 1073

	if (regexp != NULL) {
1074
		if ((error = git_regexp_compile(&iter->regex, regexp, 0)) < 0)
1075 1076 1077
			goto on_error;

		iter->have_regex = 1;
1078 1079
	}

1080
	iter->iter = inner;
1081
	iter->parent.free = multivar_iter_free;
1082
	iter->parent.next = multivar_iter_next;
1083

1084 1085 1086
	*out = (git_config_iterator *) iter;

	return 0;
1087 1088 1089 1090 1091 1092

on_error:

	inner->free(inner);
	git__free(iter);
	return error;
1093 1094
}

1095 1096
int git_config_set_multivar(git_config *cfg, const char *name, const char *regexp, const char *value)
{
1097
	git_config_backend *backend;
1098

1099
	if (get_backend_for_use(&backend, cfg, name, BACKEND_USE_DELETE) < 0)
1100
		return GIT_ENOTFOUND;
1101

1102
	return backend->set_multivar(backend, name, regexp, value);
1103 1104
}

1105 1106
int git_config_delete_multivar(git_config *cfg, const char *name, const char *regexp)
{
1107
	git_config_backend *backend;
1108

1109
	if (get_backend_for_use(&backend, cfg, name, BACKEND_USE_DELETE) < 0)
1110
		return GIT_ENOTFOUND;
1111

1112
	return backend->del_multivar(backend, name, regexp);
1113 1114
}

1115 1116 1117 1118 1119 1120 1121
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)
{
1122 1123 1124
	if (iter == NULL)
		return;

1125 1126 1127
	iter->free(iter);
}

1128
int git_config_find_global(git_buf *path)
1129
{
1130 1131
	GIT_BUF_WRAP_PRIVATE(path, git_sysdir_find_global_file, GIT_CONFIG_FILENAME_GLOBAL);
}
1132

1133 1134
int git_config__find_global(git_str *path)
{
1135
	return git_sysdir_find_global_file(path, GIT_CONFIG_FILENAME_GLOBAL);
1136 1137
}

1138
int git_config_find_xdg(git_buf *path)
1139
{
1140
	GIT_BUF_WRAP_PRIVATE(path, git_sysdir_find_xdg_file, GIT_CONFIG_FILENAME_XDG);
1141
}
1142

1143 1144
int git_config__find_xdg(git_str *path)
{
1145
	return git_sysdir_find_xdg_file(path, GIT_CONFIG_FILENAME_XDG);
1146 1147
}

1148
int git_config_find_system(git_buf *path)
1149
{
1150
	GIT_BUF_WRAP_PRIVATE(path, git_sysdir_find_system_file, GIT_CONFIG_FILENAME_SYSTEM);
1151
}
1152

1153 1154
int git_config__find_system(git_str *path)
{
1155
	return git_sysdir_find_system_file(path, GIT_CONFIG_FILENAME_SYSTEM);
1156 1157
}

1158 1159
int git_config_find_programdata(git_buf *path)
{
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
	git_str str = GIT_STR_INIT;
	int error;

	if ((error = git_buf_tostr(&str, path)) == 0 &&
	    (error = git_config__find_programdata(&str)) == 0)
		error = git_buf_fromstr(path, &str);

	git_str_dispose(&str);
	return error;
}

int git_config__find_programdata(git_str *path)
{
1173 1174 1175
	git_fs_path_owner_t owner_level =
		GIT_FS_PATH_OWNER_CURRENT_USER |
		GIT_FS_PATH_OWNER_ADMINISTRATOR;
1176
	bool is_safe;
1177

1178
	if (git_sysdir_find_programdata_file(path, GIT_CONFIG_FILENAME_PROGRAMDATA) < 0 ||
1179
	    git_fs_path_owner_is(&is_safe, path->ptr, owner_level) < 0)
1180
		return -1;
1181

1182 1183 1184 1185
	if (!is_safe) {
		git_error_set(GIT_ERROR_CONFIG, "programdata path has invalid ownership");
		return -1;
	}
1186

1187
	return 0;
1188 1189
}

1190
int git_config__global_location(git_str *buf)
1191
{
1192
	const git_str *paths;
1193 1194
	const char *sep, *start;

1195
	if (git_sysdir_get(&paths, GIT_SYSDIR_GLOBAL) < 0)
1196 1197 1198
		return -1;

	/* no paths, so give up */
1199
	if (!paths || !git_str_len(paths))
1200 1201
		return -1;

1202
	/* find unescaped separator or end of string */
1203
	for (sep = start = git_str_cstr(paths); *sep; ++sep) {
1204 1205 1206 1207
		if (*sep == GIT_PATH_LIST_SEPARATOR &&
			(sep <= start || sep[-1] != '\\'))
			break;
	}
1208

1209
	if (git_str_set(buf, start, (size_t)(sep - start)) < 0)
1210 1211
		return -1;

1212
	return git_str_joinpath(buf, buf->ptr, GIT_CONFIG_FILENAME_GLOBAL);
1213 1214
}

1215
int git_config_open_default(git_config **out)
1216 1217 1218
{
	int error;
	git_config *cfg = NULL;
1219
	git_str buf = GIT_STR_INIT;
1220

1221 1222
	if ((error = git_config_new(&cfg)) < 0)
		return error;
1223

1224 1225
	if (!git_config__find_global(&buf) ||
	    !git_config__global_location(&buf)) {
1226
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1227
			GIT_CONFIG_LEVEL_GLOBAL, NULL, 0);
1228
	}
1229

1230
	if (!error && !git_config__find_xdg(&buf))
1231
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1232
			GIT_CONFIG_LEVEL_XDG, NULL, 0);
1233

1234
	if (!error && !git_config__find_system(&buf))
1235
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1236
			GIT_CONFIG_LEVEL_SYSTEM, NULL, 0);
1237

1238
	if (!error && !git_config__find_programdata(&buf))
1239
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1240
			GIT_CONFIG_LEVEL_PROGRAMDATA, NULL, 0);
1241

1242
	git_str_dispose(&buf);
1243

1244
	if (error) {
1245 1246 1247 1248 1249 1250 1251 1252
		git_config_free(cfg);
		cfg = NULL;
	}

	*out = cfg;

	return error;
}
1253

1254
int git_config_lock(git_transaction **out, git_config *cfg)
1255
{
1256
	int error;
1257
	git_config_backend *backend;
1258
	backend_internal *internal;
1259

1260
	GIT_ASSERT_ARG(cfg);
1261

1262
	internal = git_vector_get(&cfg->backends, 0);
1263
	if (!internal || !internal->backend) {
1264
		git_error_set(GIT_ERROR_CONFIG, "cannot lock; the config has no backends");
1265 1266
		return -1;
	}
1267
	backend = internal->backend;
1268

1269
	if ((error = backend->lock(backend)) < 0)
1270 1271 1272
		return error;

	return git_transaction_config_new(out, cfg);
1273 1274 1275 1276
}

int git_config_unlock(git_config *cfg, int commit)
{
1277
	git_config_backend *backend;
1278
	backend_internal *internal;
1279

1280
	GIT_ASSERT_ARG(cfg);
1281

1282
	internal = git_vector_get(&cfg->backends, 0);
1283
	if (!internal || !internal->backend) {
1284
		git_error_set(GIT_ERROR_CONFIG, "cannot lock; the config has no backends");
1285 1286 1287
		return -1;
	}

1288
	backend = internal->backend;
1289

1290
	return backend->unlock(backend, commit);
1291 1292
}

1293 1294 1295
/***********
 * Parsers
 ***********/
1296

1297 1298
int git_config_lookup_map_value(
	int *out,
1299
	const git_configmap *maps,
1300 1301 1302 1303 1304 1305
	size_t map_n,
	const char *value)
{
	size_t i;

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

1308 1309 1310
		switch (m->type) {
		case GIT_CONFIGMAP_FALSE:
		case GIT_CONFIGMAP_TRUE: {
1311 1312
			int bool_val;

1313
			if (git_config_parse_bool(&bool_val, value) == 0 &&
1314
				bool_val == (int)m->type) {
1315 1316 1317 1318 1319 1320
				*out = m->map_value;
				return 0;
			}
			break;
		}

1321
		case GIT_CONFIGMAP_INT32:
1322 1323 1324 1325
			if (git_config_parse_int32(out, value) == 0)
				return 0;
			break;

1326
		case GIT_CONFIGMAP_STRING:
1327
			if (value && strcasecmp(value, m->str_match) == 0) {
1328 1329 1330 1331 1332 1333 1334
				*out = m->map_value;
				return 0;
			}
			break;
		}
	}

1335
	git_error_set(GIT_ERROR_CONFIG, "failed to map '%s'", value);
1336 1337 1338
	return -1;
}

1339 1340
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)
1341 1342 1343 1344
{
	size_t i;

	for (i = 0; i < map_n; i++) {
1345
		const git_configmap *m = &maps[i];
1346 1347 1348 1349

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

1350
		*type_out = m->type;
1351 1352 1353 1354
		*str_out = m->str_match;
		return 0;
	}

1355
	git_error_set(GIT_ERROR_CONFIG, "invalid enum value");
1356 1357 1358
	return GIT_ENOTFOUND;
}

1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
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;
	}

1369
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as a boolean value", value);
1370 1371 1372 1373 1374 1375 1376 1377
	return -1;
}

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

1378
	if (!value || git__strntol64(&num, value, strlen(value), &num_end, 0) < 0)
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
		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:
1412
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as an integer", value ? value : "(null)");
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
	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:
1432
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as a 32-bit integer", value ? value : "(null)");
1433 1434
	return -1;
}
1435

1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
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;
}


1460 1461 1462 1463 1464
/* 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;

1465 1466
	GIT_ASSERT_ARG(in);
	GIT_ASSERT_ARG(out);
1467 1468

	name = git__strdup(in);
1469
	GIT_ERROR_CHECK_ALLOC(name);
1470 1471 1472 1473 1474 1475 1476 1477

	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 */
1478 1479
	if (normalize_section(name, fdot) < 0 ||
	    normalize_section(ldot + 1, NULL) < 0)
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
		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);
1492
	git_error_set(GIT_ERROR_CONFIG, "invalid config item name '%s'", in);
1493 1494 1495
	return GIT_EINVALIDSPEC;
}

1496
struct rename_data {
1497
	git_config *config;
1498
	git_str *name;
1499
	size_t old_len;
1500 1501 1502 1503 1504 1505
};

static int rename_config_entries_cb(
	const git_config_entry *entry,
	void *payload)
{
1506
	int error = 0;
1507
	struct rename_data *data = (struct rename_data *)payload;
1508
	size_t base_len = git_str_len(data->name);
1509

1510
	if (base_len > 0 &&
1511
		!(error = git_str_puts(data->name, entry->name + data->old_len)))
1512
	{
1513
		error = git_config_set_string(
1514
			data->config, git_str_cstr(data->name), entry->value);
1515

1516
		git_str_truncate(data->name, base_len);
1517 1518
	}

1519 1520 1521
	if (!error)
		error = git_config_delete_entry(data->config, entry->name);

1522
	return error;
1523 1524 1525 1526 1527 1528 1529 1530
}

int git_config_rename_section(
	git_repository *repo,
	const char *old_section_name,
	const char *new_section_name)
{
	git_config *config;
1531
	git_str pattern = GIT_STR_INIT, replace = GIT_STR_INIT;
1532
	int error = 0;
1533 1534
	struct rename_data data;

1535
	git_str_puts_escape_regex(&pattern, old_section_name);
1536

1537
	if ((error = git_str_puts(&pattern, "\\..+")) < 0)
1538 1539 1540
		goto cleanup;

	if ((error = git_repository_config__weakptr(&config, repo)) < 0)
1541 1542
		goto cleanup;

1543 1544 1545 1546
	data.config  = config;
	data.name    = &replace;
	data.old_len = strlen(old_section_name) + 1;

1547
	if ((error = git_str_join(&replace, '.', new_section_name, "")) < 0)
1548 1549
		goto cleanup;

1550
	if (new_section_name != NULL &&
1551
	    (error = normalize_section(replace.ptr, strchr(replace.ptr, '.'))) < 0)
1552
	{
1553 1554
		git_error_set(
			GIT_ERROR_CONFIG, "invalid config section '%s'", new_section_name);
1555
		goto cleanup;
1556 1557
	}

1558
	error = git_config_foreach_match(
1559
		config, git_str_cstr(&pattern), rename_config_entries_cb, &data);
1560

1561
cleanup:
1562 1563
	git_str_dispose(&pattern);
	git_str_dispose(&replace);
1564

1565 1566
	return error;
}
1567

1568
int git_config_init_backend(git_config_backend *backend, unsigned int version)
1569
{
1570 1571 1572
	GIT_INIT_STRUCTURE_FROM_TEMPLATE(
		backend, version, git_config_backend, GIT_CONFIG_BACKEND_INIT);
	return 0;
1573
}