ignore.c 13.2 KB
Newer Older
1
#include "git2/ignore.h"
2
#include "common.h"
3
#include "ignore.h"
4
#include "attrcache.h"
5
#include "path.h"
6
#include "config.h"
7
#include "fnmatch.h"
8 9 10

#define GIT_IGNORE_INTERNAL		"[internal]exclude"

11 12
#define GIT_IGNORE_DEFAULT_RULES ".\n..\n.git\n"

13
/**
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
 * A negative ignore pattern can match a positive one without
 * wildcards if its pattern equals the tail of the positive
 * pattern. Thus
 *
 * foo/bar
 * !bar
 *
 * would result in foo/bar being unignored again.
 */
static int does_negate_pattern(git_attr_fnmatch *rule, git_attr_fnmatch *neg)
{
	char *p;

	if ((rule->flags & GIT_ATTR_FNMATCH_NEGATIVE) == 0
		&& (neg->flags & GIT_ATTR_FNMATCH_NEGATIVE) != 0) {
		/*
		 * no chance of matching if rule is shorter than
		 * the negated one
		 */
		if (rule->length < neg->length)
			return false;

		/*
		 * shift pattern so its tail aligns with the
		 * negated pattern
		 */
		p = rule->pattern + rule->length - neg->length;
		if (strcmp(p, neg->pattern) == 0)
			return true;
	}

	return false;
}

/**
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
 * A negative ignore can only unignore a file which is given explicitly before, thus
 *
 *    foo
 *    !foo/bar
 *
 * does not unignore 'foo/bar' as it's not in the list. However
 *
 *    foo/<star>
 *    !foo/bar
 *
 * does unignore 'foo/bar', as it is contained within the 'foo/<star>' rule.
 */
static int does_negate_rule(int *out, git_vector *rules, git_attr_fnmatch *match)
{
	int error = 0;
	size_t i;
	git_attr_fnmatch *rule;
	char *path;
	git_buf buf = GIT_BUF_INIT;

69 70
	*out = 0;

71 72 73 74 75 76 77 78 79 80
	/* path of the file relative to the workdir, so we match the rules in subdirs */
	if (match->containing_dir) {
		git_buf_puts(&buf, match->containing_dir);
	}
	if (git_buf_puts(&buf, match->pattern) < 0)
		return -1;

	path = git_buf_detach(&buf);

	git_vector_foreach(rules, i, rule) {
81 82
		if (!(rule->flags & GIT_ATTR_FNMATCH_HASWILD)) {
			if (does_negate_pattern(rule, match)) {
83
				error = 0;
84 85 86 87 88 89
				*out = 1;
				goto out;
			}
			else
				continue;
		}
90 91

	/*
92 93 94 95
	 * When dealing with a directory, we add '/<star>' so
	 * p_fnmatch() honours FNM_PATHNAME. Checking for LEADINGDIR
	 * alone isn't enough as that's also set for nagations, so we
	 * need to check that NEGATIVE is off.
96 97 98 99 100
	 */
		git_buf_clear(&buf);
		if (rule->containing_dir) {
			git_buf_puts(&buf, rule->containing_dir);
		}
101 102 103 104 105

		error = git_buf_puts(&buf, rule->pattern);

		if ((rule->flags & (GIT_ATTR_FNMATCH_LEADINGDIR | GIT_ATTR_FNMATCH_NEGATIVE)) == GIT_ATTR_FNMATCH_LEADINGDIR)
			error = git_buf_PUTS(&buf, "/*");
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130

		if (error < 0)
			goto out;

		if ((error = p_fnmatch(git_buf_cstr(&buf), path, FNM_PATHNAME)) < 0) {
			giterr_set(GITERR_INVALID, "error matching pattern");
			goto out;
		}

		/* if we found a match, we want to keep this rule */
		if (error != FNM_NOMATCH) {
			*out = 1;
			error = 0;
			goto out;
		}
	}

	error = 0;

out:
	git__free(path);
	git_buf_free(&buf);
	return error;
}

131
static int parse_ignore_file(
132
	git_repository *repo, git_attr_file *attrs, const char *data)
133
{
134
	int error = 0;
135
	int ignore_case = false;
136 137
	const char *scan = data, *context = NULL;
	git_attr_fnmatch *match = NULL;
138

139
	if (git_repository__cvar(&ignore_case, repo, GIT_CVAR_IGNORECASE) < 0)
140
		giterr_clear();
141

142
	/* if subdir file path, convert context for file paths */
143 144 145 146
	if (attrs->entry &&
		git_path_root(attrs->entry->path) < 0 &&
		!git__suffixcmp(attrs->entry->path, "/" GIT_IGNORE_FILE))
		context = attrs->entry->path;
147

148
	if (git_mutex_lock(&attrs->lock) < 0) {
149
		giterr_set(GITERR_OS, "Failed to lock ignore file");
150 151 152
		return -1;
	}

153
	while (!error && *scan) {
154 155
		int valid_rule = 1;

156 157 158
		if (!match && !(match = git__calloc(1, sizeof(*match)))) {
			error = -1;
			break;
159 160
		}

161
		match->flags = GIT_ATTR_FNMATCH_ALLOWSPACE | GIT_ATTR_FNMATCH_ALLOWNEG;
162

163
		if (!(error = git_attr_fnmatch__parse(
164
			match, &attrs->pool, context, &scan)))
165
		{
166 167 168 169 170
			match->flags |= GIT_ATTR_FNMATCH_IGNORE;

			if (ignore_case)
				match->flags |= GIT_ATTR_FNMATCH_ICASE;

171
			scan = git__next_line(scan);
172 173 174 175 176 177 178

			/* if a negative match doesn't actually do anything, throw it away */
			if (match->flags & GIT_ATTR_FNMATCH_NEGATIVE)
				error = does_negate_rule(&valid_rule, &attrs->rules, match);

			if (!error && valid_rule)
				error = git_vector_insert(&attrs->rules, match);
179 180
		}

181
		if (error != 0 || !valid_rule) {
182 183 184
			match->pattern = NULL;

			if (error == GIT_ENOTFOUND)
185
				error = 0;
186 187 188 189 190
		} else {
			match = NULL; /* vector now "owns" the match */
		}
	}

191
	git_mutex_unlock(&attrs->lock);
192
	git__free(match);
193 194 195 196

	return error;
}

197 198 199 200 201 202 203 204 205
static int push_ignore_file(
	git_ignores *ignores,
	git_vector *which_list,
	const char *base,
	const char *filename)
{
	int error = 0;
	git_attr_file *file = NULL;

206
	error = git_attr_cache__get(
207
		&file, ignores->repo, NULL, GIT_ATTR_FILE__FROM_FILE,
208
		base, filename, parse_ignore_file);
209 210 211 212 213 214 215
	if (error < 0)
		return error;

	if (file != NULL) {
		if ((error = git_vector_insert(which_list, file)) < 0)
			git_attr_file__free(file);
	}
216 217 218

	return error;
}
219

220
static int push_one_ignore(void *payload, const char *path)
221
{
222
	git_ignores *ign = payload;
223
	ign->depth++;
224
	return push_ignore_file(ign, &ign->ign_path, path, GIT_IGNORE_FILE);
225 226
}

227
static int get_internal_ignores(git_attr_file **out, git_repository *repo)
228 229 230
{
	int error;

231 232 233 234
	if ((error = git_attr_cache__init(repo)) < 0)
		return error;

	error = git_attr_cache__get(
235
		out, repo, NULL, GIT_ATTR_FILE__IN_MEMORY, NULL, GIT_IGNORE_INTERNAL, NULL);
236

237 238
	/* if internal rules list is empty, insert default rules */
	if (!error && !(*out)->rules.length)
239
		error = parse_ignore_file(repo, *out, GIT_IGNORE_DEFAULT_RULES);
240 241 242 243

	return error;
}

244 245 246 247
int git_ignore__for_path(
	git_repository *repo,
	const char *path,
	git_ignores *ignores)
248
{
249
	int error = 0;
250
	const char *workdir = git_repository_workdir(repo);
251

252
	assert(ignores && path);
253

254
	memset(ignores, 0, sizeof(*ignores));
255 256
	ignores->repo = repo;

257 258 259
	/* Read the ignore_case flag */
	if ((error = git_repository__cvar(
			&ignores->ignore_case, repo, GIT_CVAR_IGNORECASE)) < 0)
260 261
		goto cleanup;

262
	if ((error = git_attr_cache__init(repo)) < 0)
263 264
		goto cleanup;

265 266 267 268
	/* given a unrooted path in a non-bare repo, resolve it */
	if (workdir && git_path_root(path) < 0)
		error = git_path_find_dir(&ignores->dir, path, workdir);
	else
269
		error = git_buf_joinpath(&ignores->dir, path, "");
270
	if (error < 0)
271 272
		goto cleanup;

273 274 275
	if (workdir && !git__prefixcmp(ignores->dir.ptr, workdir))
		ignores->dir_root = strlen(workdir);

276
	/* set up internals */
277
	if ((error = get_internal_ignores(&ignores->ign_internal, repo)) < 0)
278 279 280
		goto cleanup;

	/* load .gitignore up the path */
281 282
	if (workdir != NULL) {
		error = git_path_walk_up(
283
			&ignores->dir, workdir, push_one_ignore, ignores);
284 285 286
		if (error < 0)
			goto cleanup;
	}
287 288

	/* load .git/info/exclude */
289 290
	error = push_ignore_file(
		ignores, &ignores->ign_global,
291
		git_repository_path(repo), GIT_IGNORE_FILE_INREPO);
292
	if (error < 0)
293 294 295
		goto cleanup;

	/* load core.excludesfile */
296
	if (git_repository_attr_cache(repo)->cfg_excl_file != NULL)
297 298
		error = push_ignore_file(
			ignores, &ignores->ign_global, NULL,
299
			git_repository_attr_cache(repo)->cfg_excl_file);
300 301

cleanup:
302
	if (error < 0)
303
		git_ignore__free(ignores);
304

305 306 307 308 309
	return error;
}

int git_ignore__push_dir(git_ignores *ign, const char *dir)
{
310 311
	if (git_buf_joinpath(&ign->dir, ign->dir.ptr, dir) < 0)
		return -1;
312

313 314
	ign->depth++;

315
	return push_ignore_file(
316
		ign, &ign->ign_path, ign->dir.ptr, GIT_IGNORE_FILE);
317 318
}

319 320 321 322
int git_ignore__pop_dir(git_ignores *ign)
{
	if (ign->ign_path.length > 0) {
		git_attr_file *file = git_vector_last(&ign->ign_path);
323
		const char *start = file->entry->path, *end;
324

325 326
		/* - ign->dir looks something like "/home/user/a/b/" (or "a/b/c/d/")
		 * - file->path looks something like "a/b/.gitignore
327
		 *
328 329 330
		 * We are popping the last directory off ign->dir.  We also want
		 * to remove the file from the vector if the popped directory
		 * matches the ignore path.  We need to test if the "a/b" part of
331 332 333
		 * the file key matches the path we are about to pop.
		 */

334 335
		if ((end = strrchr(start, '/')) != NULL) {
			size_t dirlen = (end - start) + 1;
336 337
			const char *relpath = ign->dir.ptr + ign->dir_root;
			size_t pathlen = ign->dir.size - ign->dir_root;
338

339
			if (pathlen == dirlen && !memcmp(relpath, start, dirlen)) {
340 341 342
				git_vector_pop(&ign->ign_path);
				git_attr_file__free(file);
			}
343
		}
344
	}
345

346
	if (--ign->depth > 0) {
347
		git_buf_rtruncate_at_char(&ign->dir, '/');
348
		git_path_to_dir(&ign->dir);
349
	}
350

351
	return 0;
352 353
}

354
void git_ignore__free(git_ignores *ignores)
355
{
356 357 358
	unsigned int i;
	git_attr_file *file;

359
	git_attr_file__free(ignores->ign_internal);
360 361 362 363 364

	git_vector_foreach(&ignores->ign_path, i, file) {
		git_attr_file__free(file);
		ignores->ign_path.contents[i] = NULL;
	}
365
	git_vector_free(&ignores->ign_path);
366 367 368 369 370

	git_vector_foreach(&ignores->ign_global, i, file) {
		git_attr_file__free(file);
		ignores->ign_global.contents[i] = NULL;
	}
371
	git_vector_free(&ignores->ign_global);
372

373 374 375
	git_buf_free(&ignores->dir);
}

376
static bool ignore_lookup_in_rules(
377
	int *ignored, git_attr_file *file, git_attr_path *path)
378
{
379
	size_t j;
380 381
	git_attr_fnmatch *match;

382
	git_vector_rforeach(&file->rules, j, match) {
383
		if (git_attr_fnmatch__match(match, path)) {
384 385
			*ignored = ((match->flags & GIT_ATTR_FNMATCH_NEGATIVE) == 0) ?
				GIT_IGNORE_TRUE : GIT_IGNORE_FALSE;
386
			return true;
387 388 389
		}
	}

390
	return false;
391 392
}

393
int git_ignore__lookup(
394
	int *out, git_ignores *ignores, const char *pathname, git_dir_flag dir_flag)
395
{
396
	unsigned int i;
397 398 399
	git_attr_file *file;
	git_attr_path path;

400 401
	*out = GIT_IGNORE_NOTFOUND;

402
	if (git_attr_path__init(
403
		&path, pathname, git_repository_workdir(ignores->repo), dir_flag) < 0)
404
		return -1;
405

406
	/* first process builtins - success means path was found */
407
	if (ignore_lookup_in_rules(out, ignores->ign_internal, &path))
408
		goto cleanup;
409

410 411
	/* next process files in the path */
	git_vector_foreach(&ignores->ign_path, i, file) {
412
		if (ignore_lookup_in_rules(out, file, &path))
413
			goto cleanup;
414 415
	}

416 417
	/* last process global ignores */
	git_vector_foreach(&ignores->ign_global, i, file) {
418
		if (ignore_lookup_in_rules(out, file, &path))
419
			goto cleanup;
420 421
	}

422 423
cleanup:
	git_attr_path__free(&path);
424
	return 0;
425
}
426

427
int git_ignore_add_rule(git_repository *repo, const char *rules)
428 429
{
	int error;
430
	git_attr_file *ign_internal = NULL;
431

432 433 434 435 436
	if ((error = get_internal_ignores(&ign_internal, repo)) < 0)
		return error;

	error = parse_ignore_file(repo, ign_internal, rules);
	git_attr_file__free(ign_internal);
437 438 439 440

	return error;
}

441
int git_ignore_clear_internal_rules(git_repository *repo)
442 443 444 445
{
	int error;
	git_attr_file *ign_internal;

446 447
	if ((error = get_internal_ignores(&ign_internal, repo)) < 0)
		return error;
448

449 450 451
	if (!(error = git_attr_file__clear_rules(ign_internal, true)))
		error = parse_ignore_file(
			repo, ign_internal, GIT_IGNORE_DEFAULT_RULES);
452

453
	git_attr_file__free(ign_internal);
454 455
	return error;
}
456 457 458 459

int git_ignore_path_is_ignored(
	int *ignored,
	git_repository *repo,
460
	const char *pathname)
461 462
{
	int error;
463 464
	const char *workdir;
	git_attr_path path;
465
	git_ignores ignores;
466 467
	unsigned int i;
	git_attr_file *file;
468

469 470 471 472
	assert(ignored && pathname);

	workdir = repo ? git_repository_workdir(repo) : NULL;

473 474
	memset(&path, 0, sizeof(path));
	memset(&ignores, 0, sizeof(ignores));
475

476
	if ((error = git_attr_path__init(&path, pathname, workdir, GIT_DIR_FLAG_UNKNOWN)) < 0 ||
477 478
		(error = git_ignore__for_path(repo, path.path, &ignores)) < 0)
		goto cleanup;
479

480 481
	while (1) {
		/* first process builtins - success means path was found */
482
		if (ignore_lookup_in_rules(ignored, ignores.ign_internal, &path))
483 484 485 486
			goto cleanup;

		/* next process files in the path */
		git_vector_foreach(&ignores.ign_path, i, file) {
487
			if (ignore_lookup_in_rules(ignored, file, &path))
488 489 490 491 492
				goto cleanup;
		}

		/* last process global ignores */
		git_vector_foreach(&ignores.ign_global, i, file) {
493
			if (ignore_lookup_in_rules(ignored, file, &path))
494 495 496
				goto cleanup;
		}

497 498
		/* move up one directory */
		if (path.basename == path.path)
499
			break;
500 501 502 503 504 505 506 507
		path.basename[-1] = '\0';
		while (path.basename > path.path && *path.basename != '/')
			path.basename--;
		if (path.basename > path.path)
			path.basename++;
		path.is_dir = 1;

		if ((error = git_ignore__pop_dir(&ignores)) < 0)
508
			break;
509 510 511 512 513 514
	}

	*ignored = 0;

cleanup:
	git_attr_path__free(&path);
515 516 517 518
	git_ignore__free(&ignores);
	return error;
}

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 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
int git_ignore__check_pathspec_for_exact_ignores(
	git_repository *repo,
	git_vector *vspec,
	bool no_fnmatch)
{
	int error = 0;
	size_t i;
	git_attr_fnmatch *match;
	int ignored;
	git_buf path = GIT_BUF_INIT;
	const char *wd, *filename;
	git_index *idx;

	if ((error = git_repository__ensure_not_bare(
			repo, "validate pathspec")) < 0 ||
		(error = git_repository_index(&idx, repo)) < 0)
		return error;

	wd = git_repository_workdir(repo);

	git_vector_foreach(vspec, i, match) {
		/* skip wildcard matches (if they are being used) */
		if ((match->flags & GIT_ATTR_FNMATCH_HASWILD) != 0 &&
			!no_fnmatch)
			continue;

		filename = match->pattern;

		/* if file is already in the index, it's fine */
		if (git_index_get_bypath(idx, filename, 0) != NULL)
			continue;

		if ((error = git_buf_joinpath(&path, wd, filename)) < 0)
			break;

		/* is there a file on disk that matches this exactly? */
		if (!git_path_isfile(path.ptr))
			continue;

		/* is that file ignored? */
		if ((error = git_ignore_path_is_ignored(&ignored, repo, filename)) < 0)
			break;

		if (ignored) {
			giterr_set(GITERR_INVALID, "pathspec contains ignored file '%s'",
				filename);
			error = GIT_EINVALIDSPEC;
			break;
		}
	}

	git_index_free(idx);
	git_buf_free(&path);

	return error;
}