ignore.c 13.1 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 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

	/*
	 * If we're dealing with a directory (which we know via the
	 * strchr() check) we want to use 'dirname/<star>' as the
	 * pattern so p_fnmatch() honours FNM_PATHNAME
	 */
		git_buf_clear(&buf);
		if (rule->containing_dir) {
			git_buf_puts(&buf, rule->containing_dir);
		}
		if (!strchr(rule->pattern, '*'))
			error = git_buf_printf(&buf, "%s/*", rule->pattern);
		else
			error = git_buf_puts(&buf, rule->pattern);

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

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

137
	if (git_repository__cvar(&ignore_case, repo, GIT_CVAR_IGNORECASE) < 0)
138
		giterr_clear();
139

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

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

151
	while (!error && *scan) {
152 153
		int valid_rule = 1;

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

159
		match->flags = GIT_ATTR_FNMATCH_ALLOWSPACE | GIT_ATTR_FNMATCH_ALLOWNEG;
160

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

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

169
			scan = git__next_line(scan);
170 171 172 173 174 175 176

			/* 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);
177 178
		}

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

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

189
	git_mutex_unlock(&attrs->lock);
190
	git__free(match);
191 192 193 194

	return error;
}

195 196 197 198 199 200 201 202 203
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;

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

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

	return error;
}
217

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

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

229 230 231 232
	if ((error = git_attr_cache__init(repo)) < 0)
		return error;

	error = git_attr_cache__get(
233
		out, repo, NULL, GIT_ATTR_FILE__IN_MEMORY, NULL, GIT_IGNORE_INTERNAL, NULL);
234

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

	return error;
}

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

250
	assert(ignores && path);
251

252
	memset(ignores, 0, sizeof(*ignores));
253 254
	ignores->repo = repo;

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

260
	if ((error = git_attr_cache__init(repo)) < 0)
261 262
		goto cleanup;

263 264 265 266
	/* 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
267
		error = git_buf_joinpath(&ignores->dir, path, "");
268
	if (error < 0)
269 270
		goto cleanup;

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

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

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

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

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

cleanup:
300
	if (error < 0)
301
		git_ignore__free(ignores);
302

303 304 305 306 307
	return error;
}

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

311 312
	ign->depth++;

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

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

323 324
		/* - ign->dir looks something like "/home/user/a/b/" (or "a/b/c/d/")
		 * - file->path looks something like "a/b/.gitignore
325
		 *
326 327 328
		 * 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
329 330 331
		 * the file key matches the path we are about to pop.
		 */

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

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

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

349
	return 0;
350 351
}

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

357
	git_attr_file__free(ignores->ign_internal);
358 359 360 361 362

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

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

371 372 373
	git_buf_free(&ignores->dir);
}

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

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

388
	return false;
389 390
}

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

398 399
	*out = GIT_IGNORE_NOTFOUND;

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

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

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

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

420 421
cleanup:
	git_attr_path__free(&path);
422
	return 0;
423
}
424

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

430 431 432 433 434
	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);
435 436 437 438

	return error;
}

439
int git_ignore_clear_internal_rules(git_repository *repo)
440 441 442 443
{
	int error;
	git_attr_file *ign_internal;

444 445
	if ((error = get_internal_ignores(&ign_internal, repo)) < 0)
		return error;
446

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

451
	git_attr_file__free(ign_internal);
452 453
	return error;
}
454 455 456 457

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

467 468 469 470
	assert(ignored && pathname);

	workdir = repo ? git_repository_workdir(repo) : NULL;

471 472
	memset(&path, 0, sizeof(path));
	memset(&ignores, 0, sizeof(ignores));
473

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

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

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

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

495 496
		/* move up one directory */
		if (path.basename == path.path)
497
			break;
498 499 500 501 502 503 504 505
		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)
506
			break;
507 508 509 510 511 512
	}

	*ignored = 0;

cleanup:
	git_attr_path__free(&path);
513 514 515 516
	git_ignore__free(&ignores);
	return error;
}

517 518 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
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;
}