config.c 31.1 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 "sysdir.h"
11
#include "git2/config.h"
12
#include "git2/sys/config.h"
13
#include "vector.h"
14
#include "buf_text.h"
15
#include "config_backend.h"
16
#include "transaction.h"
17 18 19
#if GIT_WIN32
# include <windows.h>
#endif
20 21 22

#include <ctype.h>

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

	entry->free(entry);
}

31
typedef struct {
32 33
	git_refcount rc;

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

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

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

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

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

57
	git_vector_free(&cfg->backends);
58

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

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

	GIT_REFCOUNT_DEC(cfg, config_free);
}

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

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

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

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

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

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

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

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

109 110
	assert(cfg && path);

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

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

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

Vicent Martí committed
129
	return 0;
130 131
}

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

137 138 139
	*out = NULL;

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

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

	return error;
148 149
}

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

	*out = NULL;

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

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

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

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

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

	return error;
}

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

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

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

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

	return 0;
}

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

	GIT_UNUSED(new_raw);

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

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

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

	if (pos == -1)
		return;

242
	internal = git_vector_get(&cfg->backends, pos);
243

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

247
	GIT_REFCOUNT_DEC(internal, backend_internal_free);
248 249 250 251
}

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

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

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

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

	GIT_REFCOUNT_INC(internal);

	return 0;
}

274 275 276 277 278 279 280 281
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);
}

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

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

317
	assert(cfg && backend);
318

319
	GIT_ERROR_CHECK_VERSION(backend, GIT_CONFIG_BACKEND_VERSION, "git_config_backend");
320

321
	if ((result = backend->open(backend, level, repo)) < 0)
Vicent Martí committed
322
		return result;
323

324
	internal = git__malloc(sizeof(backend_internal));
325
	GIT_ERROR_CHECK_ALLOC(internal);
326

327
	memset(internal, 0x0, sizeof(backend_internal));
328

329
	internal->backend = backend;
330
	internal->level = level;
331

332
	if ((result = git_config__add_internal(cfg, internal, level, force)) < 0) {
333
		git__free(internal);
334
		return result;
335
	}
336

Vicent Martí committed
337
	return 0;
338 339
}

340 341 342 343
/*
 * Loop over all the variables
 */

344 345 346 347
typedef struct {
	git_config_iterator parent;
	git_config_iterator *current;
	const git_config *cfg;
348
	regex_t regex;
349 350 351 352 353
	size_t i;
} all_iter;

static int find_next_backend(size_t *out, const git_config *cfg, size_t i)
{
354
	backend_internal *internal;
355 356

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

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

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

		return error;
409 410 411 412 413 414

	} while(1);

	return GIT_ITEROVER;
}

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
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 */
		if (regexec(&iter->regex, (*entry)->name, 0, NULL, 0) != 0)
			continue;

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

	return error;
}

436 437 438 439 440 441 442 443 444 445
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);
}

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

	regfree(&iter->regex);
	all_iter_free(_iter);
}

454 455 456 457 458
int git_config_iterator_new(git_config_iterator **out, const git_config *cfg)
{
	all_iter *iter;

	iter = git__calloc(1, sizeof(all_iter));
459
	GIT_ERROR_CHECK_ALLOC(iter);
460 461 462 463

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

464
	iter->i = cfg->backends.length;
465 466 467 468 469 470 471
	iter->cfg = cfg;

	*out = (git_config_iterator *) iter;

	return 0;
}

472 473 474 475 476
int git_config_iterator_glob_new(git_config_iterator **out, const git_config *cfg, const char *regexp)
{
	all_iter *iter;
	int result;

477 478 479
	if (regexp == NULL)
		return git_config_iterator_new(out, cfg);

480
	iter = git__calloc(1, sizeof(all_iter));
481
	GIT_ERROR_CHECK_ALLOC(iter);
482

483
	if ((result = p_regcomp(&iter->regex, regexp, REG_EXTENDED)) != 0) {
484
		git_error_set_regex(&iter->regex, result);
485
		git__free(iter);
486
		return -1;
487 488
	}

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

	*out = (git_config_iterator *) iter;

	return 0;
}

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

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

516 517
	assert(backend && cb);

518
	if (regexp != NULL) {
519
		if ((error = p_regcomp(&regex, regexp, REG_EXTENDED)) != 0) {
520
			git_error_set_regex(&regex, error);
521 522 523 524 525
			regfree(&regex);
			return -1;
		}
	}

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

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

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

	if (regexp != NULL)
		regfree(&regex);

546
	iter->free(iter);
547

548
	return error;
549 550
}

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

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

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

571 572 573 574 575 576
	git_config_iterator_free(iter);

	if (error == GIT_ITEROVER)
		error = 0;

	return error;
577 578
}

579
/**************
580
 * Setters
581
 **************/
582

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

	*out = NULL;

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

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

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

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

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

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

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

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

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

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

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

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

661
	error = backend->set(backend, name, value);
662 663 664 665 666

	if (!error && GIT_REFCOUNT_OWNER(cfg) != NULL)
		git_repository__cvar_cache_clear(GIT_REFCOUNT_OWNER(cfg));

	return error;
667 668
}

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

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

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

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

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

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

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

	*out = NULL;

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

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

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

	return res;
}

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

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

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

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

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

	return ret;
793 794
}

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

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

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

	return ret;
807 808
}

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

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

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

	return ret;
821 822
}

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

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

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

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

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

	return 1;
851 852
}

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

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

861 862 863 864
	 error = git_config_parse_path(out, entry->value);
	 git_config_entry_free(entry);

	 return error;
865 866
}

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

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

	ret = get_entry(&entry, cfg, name, true, GET_ALL_ERRORS);
879
	*out = !ret ? (entry->value ? entry->value : "") : NULL;
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902

	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;

	git_buf_sanitize(out);

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

903
	return ret;
904 905
}

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

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

	return ret;
917 918
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return err;
978 979
}

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

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

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

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

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

1004
	return error;
1005
}
1006

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

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

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

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

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

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

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

	if (regexp != NULL) {
1035
		error = p_regcomp(&iter->regex, regexp, REG_EXTENDED);
1036
		if (error != 0) {
1037
			git_error_set_regex(&iter->regex, error);
1038 1039 1040 1041 1042 1043
			error = -1;
			regfree(&iter->regex);
			goto on_error;
		}

		iter->have_regex = 1;
1044 1045
	}

1046
	iter->iter = inner;
1047
	iter->parent.free = multivar_iter_free;
1048
	iter->parent.next = multivar_iter_next;
1049

1050 1051 1052
	*out = (git_config_iterator *) iter;

	return 0;
1053 1054 1055 1056 1057 1058

on_error:

	inner->free(inner);
	git__free(iter);
	return error;
1059 1060
}

1061 1062
int git_config_set_multivar(git_config *cfg, const char *name, const char *regexp, const char *value)
{
1063
	git_config_backend *backend;
1064

1065
	if (get_backend_for_use(&backend, cfg, name, BACKEND_USE_DELETE) < 0)
1066
		return GIT_ENOTFOUND;
1067

1068
	return backend->set_multivar(backend, name, regexp, value);
1069 1070
}

1071 1072
int git_config_delete_multivar(git_config *cfg, const char *name, const char *regexp)
{
1073
	git_config_backend *backend;
1074

1075
	if (get_backend_for_use(&backend, cfg, name, BACKEND_USE_DELETE) < 0)
1076
		return GIT_ENOTFOUND;
1077

1078
	return backend->del_multivar(backend, name, regexp);
1079 1080
}

1081 1082 1083 1084 1085 1086 1087
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)
{
1088 1089 1090
	if (iter == NULL)
		return;

1091 1092 1093
	iter->free(iter);
}

1094
int git_config_find_global(git_buf *path)
1095
{
1096
	git_buf_sanitize(path);
1097
	return git_sysdir_find_global_file(path, GIT_CONFIG_FILENAME_GLOBAL);
1098 1099
}

1100
int git_config_find_xdg(git_buf *path)
1101
{
1102
	git_buf_sanitize(path);
1103
	return git_sysdir_find_xdg_file(path, GIT_CONFIG_FILENAME_XDG);
1104 1105
}

1106
int git_config_find_system(git_buf *path)
1107
{
1108
	git_buf_sanitize(path);
1109
	return git_sysdir_find_system_file(path, GIT_CONFIG_FILENAME_SYSTEM);
1110 1111
}

1112 1113
int git_config_find_programdata(git_buf *path)
{
1114 1115
	int ret;

1116
	git_buf_sanitize(path);
1117 1118 1119 1120 1121 1122
	ret = git_sysdir_find_programdata_file(path,
					       GIT_CONFIG_FILENAME_PROGRAMDATA);
	if (ret != GIT_OK)
		return ret;

	return git_path_validate_system_file_ownership(path->ptr);
1123 1124
}

1125 1126 1127 1128 1129
int git_config__global_location(git_buf *buf)
{
	const git_buf *paths;
	const char *sep, *start;

1130
	if (git_sysdir_get(&paths, GIT_SYSDIR_GLOBAL) < 0)
1131 1132 1133
		return -1;

	/* no paths, so give up */
1134
	if (!paths || !git_buf_len(paths))
1135 1136
		return -1;

1137 1138 1139 1140 1141 1142
	/* 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;
	}
1143

1144
	if (git_buf_set(buf, start, (size_t)(sep - start)) < 0)
1145 1146 1147 1148 1149
		return -1;

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

1150
int git_config_open_default(git_config **out)
1151 1152 1153 1154 1155
{
	int error;
	git_config *cfg = NULL;
	git_buf buf = GIT_BUF_INIT;

1156 1157
	if ((error = git_config_new(&cfg)) < 0)
		return error;
1158

1159
	if (!git_config_find_global(&buf) || !git_config__global_location(&buf)) {
1160
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1161
			GIT_CONFIG_LEVEL_GLOBAL, NULL, 0);
1162
	}
1163

1164
	if (!error && !git_config_find_xdg(&buf))
1165
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1166
			GIT_CONFIG_LEVEL_XDG, NULL, 0);
1167

1168
	if (!error && !git_config_find_system(&buf))
1169
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1170
			GIT_CONFIG_LEVEL_SYSTEM, NULL, 0);
1171

1172 1173
	if (!error && !git_config_find_programdata(&buf))
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1174
			GIT_CONFIG_LEVEL_PROGRAMDATA, NULL, 0);
1175

1176
	git_buf_dispose(&buf);
1177

1178
	if (error) {
1179 1180 1181 1182 1183 1184 1185 1186
		git_config_free(cfg);
		cfg = NULL;
	}

	*out = cfg;

	return error;
}
1187

1188
int git_config_lock(git_transaction **out, git_config *cfg)
1189
{
1190
	int error;
1191
	git_config_backend *backend;
1192
	backend_internal *internal;
1193

1194 1195
	assert(cfg);

1196
	internal = git_vector_get(&cfg->backends, 0);
1197
	if (!internal || !internal->backend) {
1198
		git_error_set(GIT_ERROR_CONFIG, "cannot lock; the config has no backends");
1199 1200
		return -1;
	}
1201
	backend = internal->backend;
1202

1203
	if ((error = backend->lock(backend)) < 0)
1204 1205 1206
		return error;

	return git_transaction_config_new(out, cfg);
1207 1208 1209 1210
}

int git_config_unlock(git_config *cfg, int commit)
{
1211
	git_config_backend *backend;
1212
	backend_internal *internal;
1213

1214 1215
	assert(cfg);

1216
	internal = git_vector_get(&cfg->backends, 0);
1217
	if (!internal || !internal->backend) {
1218
		git_error_set(GIT_ERROR_CONFIG, "cannot lock; the config has no backends");
1219 1220 1221
		return -1;
	}

1222
	backend = internal->backend;
1223

1224
	return backend->unlock(backend, commit);
1225 1226
}

1227 1228 1229
/***********
 * Parsers
 ***********/
1230

1231 1232
int git_config_lookup_map_value(
	int *out,
Ben Straub committed
1233
	const git_cvar_map *maps,
1234 1235 1236 1237 1238 1239 1240 1241 1242
	size_t map_n,
	const char *value)
{
	size_t i;

	if (!value)
		goto fail_parse;

	for (i = 0; i < map_n; ++i) {
Ben Straub committed
1243
		const git_cvar_map *m = maps + i;
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272

		switch (m->cvar_type) {
		case GIT_CVAR_FALSE:
		case GIT_CVAR_TRUE: {
			int bool_val;

			if (git__parse_bool(&bool_val, value) == 0 &&
				bool_val == (int)m->cvar_type) {
				*out = m->map_value;
				return 0;
			}
			break;
		}

		case GIT_CVAR_INT32:
			if (git_config_parse_int32(out, value) == 0)
				return 0;
			break;

		case GIT_CVAR_STRING:
			if (strcasecmp(value, m->str_match) == 0) {
				*out = m->map_value;
				return 0;
			}
			break;
		}
	}

fail_parse:
1273
	git_error_set(GIT_ERROR_CONFIG, "failed to map '%s'", value);
1274 1275 1276
	return -1;
}

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
int git_config_lookup_map_enum(git_cvar_t *type_out, const char **str_out,
			       const git_cvar_map *maps, size_t map_n, int enum_val)
{
	size_t i;

	for (i = 0; i < map_n; i++) {
		const git_cvar_map *m = &maps[i];

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

		*type_out = m->cvar_type;
		*str_out = m->str_match;
		return 0;
	}

1293
	git_error_set(GIT_ERROR_CONFIG, "invalid enum value");
1294 1295 1296
	return GIT_ENOTFOUND;
}

1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
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;
	}

1307
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as a boolean value", value);
1308 1309 1310 1311 1312 1313 1314 1315
	return -1;
}

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

1316
	if (!value || git__strntol64(&num, value, strlen(value), &num_end, 0) < 0)
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
		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:
1350
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as an integer", value ? value : "(null)");
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
	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:
1370
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as a 32-bit integer", value ? value : "(null)");
1371 1372
	return -1;
}
1373

1374 1375 1376 1377 1378 1379 1380 1381
int git_config_parse_path(git_buf *out, const char *value)
{
	assert(out && value);

	git_buf_sanitize(out);

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

1386
		return git_sysdir_expand_global_file(out, value[1] ? &value[2] : NULL);
1387 1388 1389 1390 1391
	}

	return git_buf_sets(out, value);
}

1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
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;
}


1416 1417 1418 1419 1420 1421 1422 1423
/* 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;

	assert(in && out);

	name = git__strdup(in);
1424
	GIT_ERROR_CHECK_ALLOC(name);
1425 1426 1427 1428 1429 1430 1431 1432

	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 */
1433 1434
	if (normalize_section(name, fdot) < 0 ||
	    normalize_section(ldot + 1, NULL) < 0)
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
		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);
1447
	git_error_set(GIT_ERROR_CONFIG, "invalid config item name '%s'", in);
1448 1449 1450
	return GIT_EINVALIDSPEC;
}

1451
struct rename_data {
1452
	git_config *config;
1453 1454
	git_buf *name;
	size_t old_len;
1455 1456 1457 1458 1459 1460
};

static int rename_config_entries_cb(
	const git_config_entry *entry,
	void *payload)
{
1461
	int error = 0;
1462
	struct rename_data *data = (struct rename_data *)payload;
1463
	size_t base_len = git_buf_len(data->name);
1464

1465 1466 1467
	if (base_len > 0 &&
		!(error = git_buf_puts(data->name, entry->name + data->old_len)))
	{
1468
		error = git_config_set_string(
1469
			data->config, git_buf_cstr(data->name), entry->value);
1470

1471
		git_buf_truncate(data->name, base_len);
1472 1473
	}

1474 1475 1476
	if (!error)
		error = git_config_delete_entry(data->config, entry->name);

1477
	return error;
1478 1479 1480 1481 1482 1483 1484 1485
}

int git_config_rename_section(
	git_repository *repo,
	const char *old_section_name,
	const char *new_section_name)
{
	git_config *config;
1486 1487
	git_buf pattern = GIT_BUF_INIT, replace = GIT_BUF_INIT;
	int error = 0;
1488 1489
	struct rename_data data;

1490 1491 1492 1493 1494 1495
	git_buf_text_puts_escape_regex(&pattern, old_section_name);

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

	if ((error = git_repository_config__weakptr(&config, repo)) < 0)
1496 1497
		goto cleanup;

1498 1499 1500 1501 1502
	data.config  = config;
	data.name    = &replace;
	data.old_len = strlen(old_section_name) + 1;

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

1505
	if (new_section_name != NULL &&
1506
	    (error = normalize_section(replace.ptr, strchr(replace.ptr, '.'))) < 0)
1507
	{
1508 1509
		git_error_set(
			GIT_ERROR_CONFIG, "invalid config section '%s'", new_section_name);
1510
		goto cleanup;
1511 1512
	}

1513 1514 1515
	error = git_config_foreach_match(
		config, git_buf_cstr(&pattern), rename_config_entries_cb, &data);

1516
cleanup:
1517 1518
	git_buf_dispose(&pattern);
	git_buf_dispose(&replace);
1519

1520 1521
	return error;
}
1522

1523
int git_config_init_backend(git_config_backend *backend, unsigned int version)
1524
{
1525 1526 1527
	GIT_INIT_STRUCTURE_FROM_TEMPLATE(
		backend, version, git_config_backend, GIT_CONFIG_BACKEND_INIT);
	return 0;
1528
}