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

#include "common.h"
#include "fileops.h"
#include "hash.h"
#include "filter.h"
12
#include "repository.h"
13
#include "global.h"
14
#include "git2/sys/filter.h"
15
#include "git2/config.h"
16
#include "blob.h"
17
#include "attr_file.h"
18
#include "array.h"
19

20 21 22 23 24
struct git_filter_source {
	git_repository *repo;
	const char     *path;
	git_oid         oid;  /* zero if unknown (which is likely) */
	uint16_t        filemode; /* zero if unknown */
25
	git_filter_mode_t mode;
26 27
};

28 29 30 31 32 33 34 35 36 37 38 39 40 41
typedef struct {
	git_filter *filter;
	void *payload;
} git_filter_entry;

struct git_filter_list {
	git_array_t(git_filter_entry) filters;
	git_filter_source source;
	char path[GIT_FLEX_ARRAY];
};

typedef struct {
	const char *filter_name;
	git_filter *filter;
42
	int priority;
43
	int initialized;
44 45 46
	size_t nattrs, nmatches;
	char *attrdata;
	const char *attrs[GIT_FLEX_ARRAY];
47 48
} git_filter_def;

49 50 51 52 53 54 55
static int filter_def_priority_cmp(const void *a, const void *b)
{
	int pa = ((const git_filter_def *)a)->priority;
	int pb = ((const git_filter_def *)b)->priority;
	return (pa < pb) ? -1 : (pa > pb) ? 1 : 0;
}

56 57
struct filter_registry {
	git_vector filters;
58 59
};

60 61 62 63 64 65 66 67 68 69 70 71
static struct filter_registry *git__filter_registry = NULL;

static void filter_registry_shutdown(void)
{
	struct filter_registry *reg = NULL;
	size_t pos;
	git_filter_def *fdef;

	if ((reg = git__swap(git__filter_registry, NULL)) == NULL)
		return;

	git_vector_foreach(&reg->filters, pos, fdef) {
72
		if (fdef->filter && fdef->filter->shutdown) {
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
			fdef->filter->shutdown(fdef->filter);
			fdef->initialized = false;
		}

		git__free(fdef->attrdata);
		git__free(fdef);
	}

	git_vector_free(&reg->filters);
	git__free(reg);
}

static int filter_registry_initialize(void)
{
	int error = 0;
	struct filter_registry *reg;

	if (git__filter_registry)
		return 0;

	reg = git__calloc(1, sizeof(struct filter_registry));
	GITERR_CHECK_ALLOC(reg);

	if ((error = git_vector_init(
			&reg->filters, 2, filter_def_priority_cmp)) < 0)
		goto cleanup;

	reg = git__compare_and_swap(&git__filter_registry, NULL, reg);
	if (reg != NULL)
		goto cleanup;

	git__on_shutdown(filter_registry_shutdown);

Russell Belfer committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
	/* try to register both default filters */
	{
		git_filter *crlf = git_crlf_filter_new();
		git_filter *ident = git_ident_filter_new();

		if (crlf && git_filter_register(
				GIT_FILTER_CRLF, crlf, GIT_FILTER_CRLF_PRIORITY) < 0)
			crlf = NULL;
		if (ident && git_filter_register(
				GIT_FILTER_IDENT, ident, GIT_FILTER_IDENT_PRIORITY) < 0)
			ident = NULL;

		if (!crlf || !ident)
			return -1;
	}

	return 0;
123 124 125 126 127 128 129

cleanup:
	git_vector_free(&reg->filters);
	git__free(reg);
	return error;
}

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
static int filter_def_scan_attrs(
	git_buf *attrs, size_t *nattr, size_t *nmatch, const char *attr_str)
{
	const char *start, *scan = attr_str;
	int has_eq;

	*nattr = *nmatch = 0;

	if (!scan)
		return 0;

	while (*scan) {
		while (git__isspace(*scan)) scan++;

		for (start = scan, has_eq = 0; *scan && !git__isspace(*scan); ++scan) {
			if (*scan == '=')
				has_eq = 1;
		}

		if (scan > start) {
			(*nattr)++;
Russell Belfer committed
151
			if (has_eq || *start == '-' || *start == '+' || *start == '!')
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
				(*nmatch)++;

			if (has_eq)
				git_buf_putc(attrs, '=');
			git_buf_put(attrs, start, scan - start);
			git_buf_putc(attrs, '\0');
		}
	}

	return 0;
}

static void filter_def_set_attrs(git_filter_def *fdef)
{
	char *scan = fdef->attrdata;
	size_t i;

	for (i = 0; i < fdef->nattrs; ++i) {
		const char *name, *value;

		switch (*scan) {
		case '=':
			name = scan + 1;
			for (scan++; *scan != '='; scan++) /* find '=' */;
			*scan++ = '\0';
			value = scan;
			break;
		case '-':
			name = scan + 1; value = git_attr__false; break;
		case '+':
			name = scan + 1; value = git_attr__true;  break;
		case '!':
			name = scan + 1; value = git_attr__unset; break;
		default:
			name = scan;     value = NULL; break;
		}

		fdef->attrs[i] = name;
		fdef->attrs[i + fdef->nattrs] = value;

		scan += strlen(scan) + 1;
	}
}

196 197 198 199
static int filter_def_name_key_check(const void *key, const void *fdef)
{
	const char *name =
		fdef ? ((const git_filter_def *)fdef)->filter_name : NULL;
200 201 202 203 204 205 206
	return name ? git__strcmp(key, name) : -1;
}

static int filter_def_filter_key_check(const void *key, const void *fdef)
{
	const void *filter = fdef ? ((const git_filter_def *)fdef)->filter : NULL;
	return (key == filter) ? 0 : -1;
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
}

static int filter_registry_find(size_t *pos, const char *name)
{
	return git_vector_search2(
		pos, &git__filter_registry->filters, filter_def_name_key_check, name);
}

static git_filter_def *filter_registry_lookup(size_t *pos, const char *name)
{
	git_filter_def *fdef = NULL;

	if (!filter_registry_find(pos, name))
		fdef = git_vector_get(&git__filter_registry->filters, *pos);

	return fdef;
}

225 226 227 228 229 230 231
int git_filter_register(
	const char *name, git_filter *filter, int priority)
{
	git_filter_def *fdef;
	size_t nattr = 0, nmatch = 0;
	git_buf attrs = GIT_BUF_INIT;

232 233 234 235
	if (filter_registry_initialize() < 0)
		return -1;

	if (!filter_registry_find(NULL, name)) {
236 237
		giterr_set(
			GITERR_FILTER, "Attempt to reregister existing filter '%s'", name);
Russell Belfer committed
238
		return GIT_EEXISTS;
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
	}

	if (filter_def_scan_attrs(&attrs, &nattr, &nmatch, filter->attributes) < 0)
		return -1;

	fdef = git__calloc(
		sizeof(git_filter_def) + 2 * nattr * sizeof(char *), 1);
	GITERR_CHECK_ALLOC(fdef);

	fdef->filter_name = name;
	fdef->filter      = filter;
	fdef->priority    = priority;
	fdef->nattrs      = nattr;
	fdef->nmatches    = nmatch;
	fdef->attrdata    = git_buf_detach(&attrs);

	filter_def_set_attrs(fdef);

257
	if (git_vector_insert(&git__filter_registry->filters, fdef) < 0) {
258 259 260 261 262
		git__free(fdef->attrdata);
		git__free(fdef);
		return -1;
	}

263
	git_vector_sort(&git__filter_registry->filters);
264 265 266
	return 0;
}

267 268 269 270 271 272
int git_filter_unregister(const char *name)
{
	size_t pos;
	git_filter_def *fdef;

	/* cannot unregister default filters */
Russell Belfer committed
273
	if (!strcmp(GIT_FILTER_CRLF, name) || !strcmp(GIT_FILTER_IDENT, name)) {
274 275 276 277
		giterr_set(GITERR_FILTER, "Cannot unregister filter '%s'", name);
		return -1;
	}

278
	if ((fdef = filter_registry_lookup(&pos, name)) == NULL) {
279 280 281 282
		giterr_set(GITERR_FILTER, "Cannot find filter '%s' to unregister", name);
		return GIT_ENOTFOUND;
	}

283
	(void)git_vector_remove(&git__filter_registry->filters, pos);
284

285
	if (fdef->initialized && fdef->filter && fdef->filter->shutdown) {
286
		fdef->filter->shutdown(fdef->filter);
287 288
		fdef->initialized = false;
	}
289 290 291 292 293 294 295

	git__free(fdef->attrdata);
	git__free(fdef);

	return 0;
}

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
static int filter_initialize(git_filter_def *fdef)
{
	int error = 0;

	if (!fdef->initialized &&
		fdef->filter &&
		fdef->filter->initialize &&
		(error = fdef->filter->initialize(fdef->filter)) < 0)
	{
		/* auto-unregister if initialize fails */
		git_filter_unregister(fdef->filter_name);
		return error;
	}

	fdef->initialized = true;
	return 0;
}

314 315 316
git_filter *git_filter_lookup(const char *name)
{
	size_t pos;
317 318 319 320
	git_filter_def *fdef;

	if (filter_registry_initialize() < 0)
		return NULL;
321

322
	if ((fdef = filter_registry_lookup(&pos, name)) == NULL)
323 324 325 326 327 328
		return NULL;

	if (!fdef->initialized && filter_initialize(fdef) < 0)
		return NULL;

	return fdef->filter;
329 330
}

Russell Belfer committed
331 332 333 334 335
void git_filter_free(git_filter *filter)
{
	git__free(filter);
}

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
git_repository *git_filter_source_repo(const git_filter_source *src)
{
	return src->repo;
}

const char *git_filter_source_path(const git_filter_source *src)
{
	return src->path;
}

uint16_t git_filter_source_filemode(const git_filter_source *src)
{
	return src->filemode;
}

const git_oid *git_filter_source_id(const git_filter_source *src)
{
	return git_oid_iszero(&src->oid) ? NULL : &src->oid;
}

356 357 358 359 360
git_filter_mode_t git_filter_source_mode(const git_filter_source *src)
{
	return src->mode;
}

361
static int filter_list_new(
362
	git_filter_list **out, const git_filter_source *src)
363
{
364 365 366 367 368 369 370 371 372 373
	git_filter_list *fl = NULL;
	size_t pathlen = src->path ? strlen(src->path) : 0;

	fl = git__calloc(1, sizeof(git_filter_list) + pathlen + 1);
	GITERR_CHECK_ALLOC(fl);

	if (src->path)
		memcpy(fl->path, src->path, pathlen);
	fl->source.repo = src->repo;
	fl->source.path = fl->path;
374
	fl->source.mode = src->mode;
375 376 377 378 379

	*out = fl;
	return 0;
}

380 381 382 383 384 385 386 387 388 389 390 391 392 393
static int filter_list_check_attributes(
	const char ***out, git_filter_def *fdef, const git_filter_source *src)
{
	int error;
	size_t i;
	const char **strs = git__calloc(fdef->nattrs, sizeof(const char *));
	GITERR_CHECK_ALLOC(strs);

	error = git_attr_get_many(
		strs, src->repo, 0, src->path, fdef->nattrs, fdef->attrs);

	/* if no values were found but no matches are needed, it's okay! */
	if (error == GIT_ENOTFOUND && !fdef->nmatches) {
		giterr_clear();
Russell Belfer committed
394
		git__free((void *)strs);
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
		return 0;
	}

	for (i = 0; !error && i < fdef->nattrs; ++i) {
		const char *want = fdef->attrs[fdef->nattrs + i];
		git_attr_t want_type, found_type;

		if (!want)
			continue;

		want_type  = git_attr_value(want);
		found_type = git_attr_value(strs[i]);

		if (want_type != found_type ||
			(want_type == GIT_ATTR_VALUE_T && strcmp(want, strs[i])))
			error = GIT_ENOTFOUND;
	}

	if (error)
Russell Belfer committed
414
		git__free((void *)strs);
415 416 417 418 419 420
	else
		*out = strs;

	return error;
}

421 422 423 424 425 426 427 428 429 430
int git_filter_list_new(
	git_filter_list **out, git_repository *repo, git_filter_mode_t mode)
{
	git_filter_source src = { 0 };
	src.repo = repo;
	src.path = NULL;
	src.mode = mode;
	return filter_list_new(out, &src);
}

431 432 433
int git_filter_list_load(
	git_filter_list **filters,
	git_repository *repo,
Russell Belfer committed
434
	git_blob *blob, /* can be NULL */
435 436 437 438 439 440 441
	const char *path,
	git_filter_mode_t mode)
{
	int error = 0;
	git_filter_list *fl = NULL;
	git_filter_source src = { 0 };
	git_filter_entry *fe;
442 443
	size_t idx;
	git_filter_def *fdef;
444

445
	if (filter_registry_initialize() < 0)
446 447 448 449
		return -1;

	src.repo = repo;
	src.path = path;
450
	src.mode = mode;
Russell Belfer committed
451 452
	if (blob)
		git_oid_cpy(&src.oid, git_blob_id(blob));
453

454
	git_vector_foreach(&git__filter_registry->filters, idx, fdef) {
455
		const char **values = NULL;
456 457 458 459
		void *payload = NULL;

		if (!fdef || !fdef->filter)
			continue;
460

461 462 463 464 465 466 467 468 469
		if (fdef->nattrs > 0) {
			error = filter_list_check_attributes(&values, fdef, &src);
			if (error == GIT_ENOTFOUND) {
				error = 0;
				continue;
			} else if (error < 0)
				break;
		}

470 471 472
		if (!fdef->initialized && (error = filter_initialize(fdef)) < 0)
			break;

473
		if (fdef->filter->check)
474
			error = fdef->filter->check(
475
				fdef->filter, &payload, &src, values);
476

Russell Belfer committed
477
		git__free((void *)values);
478

Russell Belfer committed
479
		if (error == GIT_PASSTHROUGH)
480 481 482 483
			error = 0;
		else if (error < 0)
			break;
		else {
484
			if (!fl && (error = filter_list_new(&fl, &src)) < 0)
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
				return error;

			fe = git_array_alloc(fl->filters);
			GITERR_CHECK_ALLOC(fe);
			fe->filter  = fdef->filter;
			fe->payload = payload;
		}
	}

	if (error && fl != NULL) {
		git_array_clear(fl->filters);
		git__free(fl);
		fl = NULL;
	}

	*filters = fl;
	return error;
}

void git_filter_list_free(git_filter_list *fl)
{
	uint32_t i;

	if (!fl)
		return;

	for (i = 0; i < git_array_size(fl->filters); ++i) {
		git_filter_entry *fe = git_array_get(fl->filters, i);
		if (fe->filter->cleanup)
			fe->filter->cleanup(fe->filter, fe->payload);
515 516
	}

517 518
	git_array_clear(fl->filters);
	git__free(fl);
519 520
}

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
int git_filter_list_push(
	git_filter_list *fl, git_filter *filter, void *payload)
{
	int error = 0;
	size_t pos;
	git_filter_def *fdef;
	git_filter_entry *fe;

	assert(fl && filter);

	if (git_vector_search2(
			&pos, &git__filter_registry->filters,
			filter_def_filter_key_check, filter) < 0) {
		giterr_set(GITERR_FILTER, "Cannot use an unregistered filter");
		return -1;
	}

	fdef = git_vector_get(&git__filter_registry->filters, pos);

	if (!fdef->initialized && (error = filter_initialize(fdef)) < 0)
		return error;

	fe = git_array_alloc(fl->filters);
	GITERR_CHECK_ALLOC(fe);
	fe->filter  = filter;
	fe->payload = payload;

	return 0;
}

Russell Belfer committed
551 552 553 554 555
size_t git_filter_list_length(const git_filter_list *fl)
{
	return fl ? git_array_size(fl->filters) : 0;
}

556
static int filter_list_out_buffer_from_raw(
557
	git_buf *out, const void *ptr, size_t size)
558
{
559 560 561 562 563 564 565 566 567 568
	if (git_buf_is_allocated(out))
		git_buf_free(out);

	if (!size) {
		git_buf_init(out, 0);
	} else {
		out->ptr   = (char *)ptr;
		out->asize = 0;
		out->size  = size;
	}
569 570 571 572 573

	return 0;
}

int git_filter_list_apply_to_data(
574
	git_buf *tgt, git_filter_list *fl, git_buf *src)
575
{
576 577
	int error = 0;
	uint32_t i;
578
	git_buf *dbuffer[2], local = GIT_BUF_INIT;
579
	unsigned int si = 0;
580

581 582
	if (!fl)
		return filter_list_out_buffer_from_raw(tgt, src->ptr, src->size);
583

584 585
	dbuffer[0] = src;
	dbuffer[1] = tgt;
586

587
	/* if `src` buffer is reallocable, then use it, otherwise copy it */
588 589
	if (!git_buf_is_allocated(src)) {
		if (git_buf_set(&local, src->ptr, src->size) < 0)
590 591 592
			return -1;
		dbuffer[0] = &local;
	}
593

594
	for (i = 0; i < git_array_size(fl->filters); ++i) {
595
		unsigned int di = 1 - si;
596
		uint32_t fidx = (fl->source.mode == GIT_FILTER_TO_WORKTREE) ?
597 598
			i : git_array_size(fl->filters) - 1 - i;
		git_filter_entry *fe = git_array_get(fl->filters, fidx);
599

600
		dbuffer[di]->size = 0;
601

602
		/* Apply the filter from dbuffer[src] to the other buffer;
603 604 605 606 607
		 * if the filtering is canceled by the user mid-filter,
		 * we skip to the next filter without changing the source
		 * of the double buffering (so that the text goes through
		 * cleanly).
		 */
608

609 610
		error = fe->filter->apply(
			fe->filter, &fe->payload, dbuffer[di], dbuffer[si], &fl->source);
611

Russell Belfer committed
612 613
		if (error == GIT_PASSTHROUGH) {
			/* PASSTHROUGH means filter decided not to process the buffer */
614
			error = 0;
Russell Belfer committed
615 616
		} else if (!error) {
			git_buf_shorten(dbuffer[di], 0); /* force NUL termination */
617
			si = di; /* swap buffers */
Russell Belfer committed
618
		} else {
619 620
			tgt->size = 0;
			return error;
621
		}
622 623 624
	}

	/* Ensure that the output ends up in dbuffer[1] (i.e. the dest) */
625 626
	if (si != 1)
		git_buf_swap(dbuffer[0], dbuffer[1]);
627

628
	git_buf_free(&local); /* don't leak if we allocated locally */
629

630
	return 0;
631
}
632 633

int git_filter_list_apply_to_file(
634
	git_buf *out,
635 636 637 638 639 640 641 642 643 644 645
	git_filter_list *filters,
	git_repository *repo,
	const char *path)
{
	int error;
	const char *base = repo ? git_repository_workdir(repo) : NULL;
	git_buf abspath = GIT_BUF_INIT, raw = GIT_BUF_INIT;

	if (!(error = git_path_join_unrooted(&abspath, path, base, NULL)) &&
		!(error = git_futils_readbuffer(&raw, abspath.ptr)))
	{
646
		error = git_filter_list_apply_to_data(out, filters, &raw);
647

648
		git_buf_free(&raw);
649 650 651 652 653 654 655
	}

	git_buf_free(&abspath);
	return error;
}

int git_filter_list_apply_to_blob(
656
	git_buf *out,
657 658 659
	git_filter_list *filters,
	git_blob *blob)
{
660 661 662 663 664 665 666 667 668 669 670
	git_buf in = GIT_BUF_INIT;
	git_off_t rawsize = git_blob_rawsize(blob);

	if (!git__is_sizet(rawsize)) {
		giterr_set(GITERR_OS, "Blob is too large to filter");
		return -1;
	}

	in.ptr   = (char *)git_blob_rawcontent(blob);
	in.asize = 0;
	in.size  = (size_t)rawsize;
671

Russell Belfer committed
672 673 674
	if (filters)
		git_oid_cpy(&filters->source.oid, git_blob_id(blob));

675 676
	return git_filter_list_apply_to_data(out, filters, &in);
}