config.c 31.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_text.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
	assert(cfg && path);

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
	assert(cfg && backend);
320

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

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

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

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

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

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

Vicent Martí committed
339
	return 0;
340 341
}

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

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

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

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

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

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

		return error;
411 412 413 414 415 416

	} while(1);

	return GIT_ITEROVER;
}

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

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

	return error;
}

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

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

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

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

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

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

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

	*out = (git_config_iterator *) iter;

	return 0;
}

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

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

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

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

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

	*out = (git_config_iterator *) iter;

	return 0;
}

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

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

517 518
	assert(backend && cb);

519 520
	if (regexp && git_regexp_compile(&regex, regexp, 0) < 0)
		return -1;
521

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

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

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

	if (regexp != NULL)
540
		git_regexp_dispose(&regex);
541

542
	iter->free(iter);
543

544
	return error;
545 546
}

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

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

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

567 568 569 570 571 572
	git_config_iterator_free(iter);

	if (error == GIT_ITEROVER)
		error = 0;

	return error;
573 574
}

575
/**************
576
 * Setters
577
 **************/
578

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

	*out = NULL;

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

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

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

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

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

624
	return backend->del(backend, name);
625 626
}

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

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

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

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

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

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

657
	error = backend->set(backend, name, value);
658 659

	if (!error && GIT_REFCOUNT_OWNER(cfg) != NULL)
660
		git_repository__configmap_lookup_cache_clear(GIT_REFCOUNT_OWNER(cfg));
661 662

	return error;
663 664
}

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

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

692
	git_config_entry_free(ce);
693 694 695
	return error;
}

696 697 698
/***********
 * Getters
 ***********/
699 700 701

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

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

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

	*out = NULL;

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

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

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

	return res;
}

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

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

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

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

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

	return ret;
789 790
}

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

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

799 800 801 802
	ret = git_config_parse_int64(out, entry->value);
	git_config_entry_free(entry);

	return ret;
803 804
}

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

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

813 814 815 816
	ret = git_config_parse_int32(out, entry->value);
	git_config_entry_free(entry);

	return ret;
817 818
}

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

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

827 828 829 830 831 832 833 834 835
	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;
836
	backend_internal *internal;
837

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

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

	return 1;
847 848
}

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

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

857 858 859 860
	 error = git_config_parse_path(out, entry->value);
	 git_config_entry_free(entry);

	 return error;
861 862
}

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

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

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

	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;

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

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

900
	return ret;
901 902
}

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

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

	return ret;
914 915
}

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

922
	get_entry(&entry, cfg, key, false, GET_NO_ERRORS);
923

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

927
	git_config_entry_free(entry);
928
	return val;
929 930
}

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

937
	get_entry(&entry, cfg, key, false, GET_NO_ERRORS);
938

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

942
	git_config_entry_free(entry);
943
	return (int)val;
944 945
}

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

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

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

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

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

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

	return err;
975 976
}

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

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

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

994 995
		if (!iter->have_regex)
			return 0;
996

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

1001
	return error;
1002
}
1003

1004
static void multivar_iter_free(git_config_iterator *_iter)
1005 1006 1007
{
	multivar_iter *iter = (multivar_iter *) _iter;

1008
	iter->iter->free(iter->iter);
1009

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

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

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

1025
	iter = git__calloc(1, sizeof(multivar_iter));
1026
	GIT_ERROR_CHECK_ALLOC(iter);
1027

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

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

		iter->have_regex = 1;
1036 1037
	}

1038
	iter->iter = inner;
1039
	iter->parent.free = multivar_iter_free;
1040
	iter->parent.next = multivar_iter_next;
1041

1042 1043 1044
	*out = (git_config_iterator *) iter;

	return 0;
1045 1046 1047 1048 1049 1050

on_error:

	inner->free(inner);
	git__free(iter);
	return error;
1051 1052
}

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

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

1060
	return backend->set_multivar(backend, name, regexp, value);
1061 1062
}

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

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

1070
	return backend->del_multivar(backend, name, regexp);
1071 1072
}

1073 1074 1075 1076 1077 1078 1079
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)
{
1080 1081 1082
	if (iter == NULL)
		return;

1083 1084 1085
	iter->free(iter);
}

1086
int git_config_find_global(git_buf *path)
1087
{
1088 1089 1090 1091 1092
	int error;

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

1093
	return git_sysdir_find_global_file(path, GIT_CONFIG_FILENAME_GLOBAL);
1094 1095
}

1096
int git_config_find_xdg(git_buf *path)
1097
{
1098 1099 1100 1101 1102
	int error;

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

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 1109 1110 1111 1112
	int error;

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

1113
	return git_sysdir_find_system_file(path, GIT_CONFIG_FILENAME_SYSTEM);
1114 1115
}

1116 1117
int git_config_find_programdata(git_buf *path)
{
1118 1119
	int ret;

1120 1121 1122
	if ((ret = git_buf_sanitize(path)) < 0)
		return ret;

1123 1124 1125 1126 1127 1128
	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);
1129 1130
}

1131 1132 1133 1134 1135
int git_config__global_location(git_buf *buf)
{
	const git_buf *paths;
	const char *sep, *start;

1136
	if (git_sysdir_get(&paths, GIT_SYSDIR_GLOBAL) < 0)
1137 1138 1139
		return -1;

	/* no paths, so give up */
1140
	if (!paths || !git_buf_len(paths))
1141 1142
		return -1;

1143 1144 1145 1146 1147 1148
	/* 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;
	}
1149

1150
	if (git_buf_set(buf, start, (size_t)(sep - start)) < 0)
1151 1152 1153 1154 1155
		return -1;

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

1156
int git_config_open_default(git_config **out)
1157 1158 1159 1160 1161
{
	int error;
	git_config *cfg = NULL;
	git_buf buf = GIT_BUF_INIT;

1162 1163
	if ((error = git_config_new(&cfg)) < 0)
		return error;
1164

1165
	if (!git_config_find_global(&buf) || !git_config__global_location(&buf)) {
1166
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1167
			GIT_CONFIG_LEVEL_GLOBAL, NULL, 0);
1168
	}
1169

1170
	if (!error && !git_config_find_xdg(&buf))
1171
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1172
			GIT_CONFIG_LEVEL_XDG, NULL, 0);
1173

1174
	if (!error && !git_config_find_system(&buf))
1175
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1176
			GIT_CONFIG_LEVEL_SYSTEM, NULL, 0);
1177

1178 1179
	if (!error && !git_config_find_programdata(&buf))
		error = git_config_add_file_ondisk(cfg, buf.ptr,
1180
			GIT_CONFIG_LEVEL_PROGRAMDATA, NULL, 0);
1181

1182
	git_buf_dispose(&buf);
1183

1184
	if (error) {
1185 1186 1187 1188 1189 1190 1191 1192
		git_config_free(cfg);
		cfg = NULL;
	}

	*out = cfg;

	return error;
}
1193

1194
int git_config_lock(git_transaction **out, git_config *cfg)
1195
{
1196
	int error;
1197
	git_config_backend *backend;
1198
	backend_internal *internal;
1199

1200 1201
	assert(cfg);

1202
	internal = git_vector_get(&cfg->backends, 0);
1203
	if (!internal || !internal->backend) {
1204
		git_error_set(GIT_ERROR_CONFIG, "cannot lock; the config has no backends");
1205 1206
		return -1;
	}
1207
	backend = internal->backend;
1208

1209
	if ((error = backend->lock(backend)) < 0)
1210 1211 1212
		return error;

	return git_transaction_config_new(out, cfg);
1213 1214 1215 1216
}

int git_config_unlock(git_config *cfg, int commit)
{
1217
	git_config_backend *backend;
1218
	backend_internal *internal;
1219

1220 1221
	assert(cfg);

1222
	internal = git_vector_get(&cfg->backends, 0);
1223
	if (!internal || !internal->backend) {
1224
		git_error_set(GIT_ERROR_CONFIG, "cannot lock; the config has no backends");
1225 1226 1227
		return -1;
	}

1228
	backend = internal->backend;
1229

1230
	return backend->unlock(backend, commit);
1231 1232
}

1233 1234 1235
/***********
 * Parsers
 ***********/
1236

1237 1238
int git_config_lookup_map_value(
	int *out,
1239
	const git_configmap *maps,
1240 1241 1242 1243 1244 1245
	size_t map_n,
	const char *value)
{
	size_t i;

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

1248 1249 1250
		switch (m->type) {
		case GIT_CONFIGMAP_FALSE:
		case GIT_CONFIGMAP_TRUE: {
1251 1252
			int bool_val;

1253
			if (git_config_parse_bool(&bool_val, value) == 0 &&
1254
				bool_val == (int)m->type) {
1255 1256 1257 1258 1259 1260
				*out = m->map_value;
				return 0;
			}
			break;
		}

1261
		case GIT_CONFIGMAP_INT32:
1262 1263 1264 1265
			if (git_config_parse_int32(out, value) == 0)
				return 0;
			break;

1266
		case GIT_CONFIGMAP_STRING:
1267
			if (value && strcasecmp(value, m->str_match) == 0) {
1268 1269 1270 1271 1272 1273 1274
				*out = m->map_value;
				return 0;
			}
			break;
		}
	}

1275
	git_error_set(GIT_ERROR_CONFIG, "failed to map '%s'", value);
1276 1277 1278
	return -1;
}

1279 1280
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)
1281 1282 1283 1284
{
	size_t i;

	for (i = 0; i < map_n; i++) {
1285
		const git_configmap *m = &maps[i];
1286 1287 1288 1289

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

1290
		*type_out = m->type;
1291 1292 1293 1294
		*str_out = m->str_match;
		return 0;
	}

1295
	git_error_set(GIT_ERROR_CONFIG, "invalid enum value");
1296 1297 1298
	return GIT_ENOTFOUND;
}

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

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

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

1318
	if (!value || git__strntol64(&num, value, strlen(value), &num_end, 0) < 0)
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 1350 1351
		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:
1352
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as an integer", value ? value : "(null)");
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
	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:
1372
	git_error_set(GIT_ERROR_CONFIG, "failed to parse '%s' as a 32-bit integer", value ? value : "(null)");
1373 1374
	return -1;
}
1375

1376 1377
int git_config_parse_path(git_buf *out, const char *value)
{
1378 1379
	int error;

1380 1381
	assert(out && value);

1382 1383
	if ((error = git_buf_sanitize(out)) < 0)
		return error;
1384 1385 1386

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

1391
		return git_sysdir_expand_global_file(out, value[1] ? &value[2] : NULL);
1392 1393 1394 1395 1396
	}

	return git_buf_sets(out, value);
}

1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
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;
}


1421 1422 1423 1424 1425 1426 1427 1428
/* 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);
1429
	GIT_ERROR_CHECK_ALLOC(name);
1430 1431 1432 1433 1434 1435 1436 1437

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

1456
struct rename_data {
1457
	git_config *config;
1458 1459
	git_buf *name;
	size_t old_len;
1460 1461 1462 1463 1464 1465
};

static int rename_config_entries_cb(
	const git_config_entry *entry,
	void *payload)
{
1466
	int error = 0;
1467
	struct rename_data *data = (struct rename_data *)payload;
1468
	size_t base_len = git_buf_len(data->name);
1469

1470 1471 1472
	if (base_len > 0 &&
		!(error = git_buf_puts(data->name, entry->name + data->old_len)))
	{
1473
		error = git_config_set_string(
1474
			data->config, git_buf_cstr(data->name), entry->value);
1475

1476
		git_buf_truncate(data->name, base_len);
1477 1478
	}

1479 1480 1481
	if (!error)
		error = git_config_delete_entry(data->config, entry->name);

1482
	return error;
1483 1484 1485 1486 1487 1488 1489 1490
}

int git_config_rename_section(
	git_repository *repo,
	const char *old_section_name,
	const char *new_section_name)
{
	git_config *config;
1491 1492
	git_buf pattern = GIT_BUF_INIT, replace = GIT_BUF_INIT;
	int error = 0;
1493 1494
	struct rename_data data;

1495 1496 1497 1498 1499 1500
	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)
1501 1502
		goto cleanup;

1503 1504 1505 1506 1507
	data.config  = config;
	data.name    = &replace;
	data.old_len = strlen(old_section_name) + 1;

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

1510
	if (new_section_name != NULL &&
1511
	    (error = normalize_section(replace.ptr, strchr(replace.ptr, '.'))) < 0)
1512
	{
1513 1514
		git_error_set(
			GIT_ERROR_CONFIG, "invalid config section '%s'", new_section_name);
1515
		goto cleanup;
1516 1517
	}

1518 1519 1520
	error = git_config_foreach_match(
		config, git_buf_cstr(&pattern), rename_config_entries_cb, &data);

1521
cleanup:
1522 1523
	git_buf_dispose(&pattern);
	git_buf_dispose(&replace);
1524

1525 1526
	return error;
}
1527

1528
int git_config_init_backend(git_config_backend *backend, unsigned int version)
1529
{
1530 1531 1532
	GIT_INIT_STRUCTURE_FROM_TEMPLATE(
		backend, version, git_config_backend, GIT_CONFIG_BACKEND_INIT);
	return 0;
1533
}