Skip to content

[Finder] Fix .gitignore infinite loop #43704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 26, 2021
Merged

[Finder] Fix .gitignore infinite loop #43704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 50 additions & 11 deletions src/Symfony/Component/Finder/Iterator/VcsIgnoredFilterIterator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ final class VcsIgnoredFilterIterator extends \FilterIterator

public function __construct(\Iterator $iterator, string $baseDir)
{
$this->baseDir = $baseDir;
$this->baseDir = $this->normalizePath($baseDir);

parent::__construct($iterator);
}
Expand All @@ -36,35 +36,65 @@ public function accept(): bool
{
$file = $this->current();

$fileRealPath = $file->getRealPath();
if ($file->isDir()) {
$fileRealPath = $this->normalizePath($file->getRealPath());
if ($file->isDir() && !str_ends_with($fileRealPath, '/')) {
$fileRealPath .= '/';
}

$parentDirectory = $fileRealPath;

do {
$parentDirectory = \dirname($parentDirectory);
$relativeFilePath = substr($fileRealPath, \strlen($parentDirectory) + 1);
foreach ($this->parentsDirectoryDownward($fileRealPath) as $parentDirectory) {
$fileRelativePath = substr($fileRealPath, \strlen($parentDirectory) + 1);

$regex = $this->readGitignoreFile("{$parentDirectory}/.gitignore");

if (null !== $regex && preg_match($regex, $relativeFilePath)) {
if (null !== $regex && preg_match($regex, $fileRelativePath)) {
return false;
}
} while ($parentDirectory !== $this->baseDir);

if (0 !== strpos($parentDirectory, $this->baseDir)) {
break;
}
}

return true;
}

/**
* @return list<string>
*/
private function parentsDirectoryDownward(string $fileRealPath): array
{
$parentDirectories = [];

$parentDirectory = $fileRealPath;

while (true) {
$newParentDirectory = \dirname($parentDirectory);

// dirname('/') = '/'
if ($newParentDirectory === $parentDirectory) {
break;
}

$parentDirectory = $newParentDirectory;

if (0 !== strpos($parentDirectory, $this->baseDir)) {
break;
}

$parentDirectories[] = $parentDirectory;
}

return array_reverse($parentDirectories);
}

private function readGitignoreFile(string $path): ?string
{
if (\array_key_exists($path, $this->gitignoreFilesCache)) {
return $this->gitignoreFilesCache[$path];
}

if (!file_exists($path)) {
return null;
return $this->gitignoreFilesCache[$path] = null;
}

if (!is_file($path) || !is_readable($path)) {
Expand All @@ -73,4 +103,13 @@ private function readGitignoreFile(string $path): ?string

return $this->gitignoreFilesCache[$path] = Gitignore::toRegex(file_get_contents($path));
}

private function normalizePath(string $path): string
{
if ('\\' === \DIRECTORY_SEPARATOR) {
return str_replace('\\', '/', $path);
}

return $path;
}
}
16 changes: 10 additions & 6 deletions src/Symfony/Component/Finder/Tests/FinderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,14 +433,18 @@ public function testIgnoreVCSIgnored()
->ignoreVCSIgnored(true)
);

copy(__DIR__.'/Fixtures/gitignore/b.txt', __DIR__.'/Fixtures/gitignore/a.txt');
copy(__DIR__.'/Fixtures/gitignore/dir/a.txt', __DIR__.'/Fixtures/gitignore/dir/b.txt');
copy(__DIR__.'/Fixtures/gitignore/search_root/b.txt', __DIR__.'/Fixtures/gitignore/search_root/a.txt');
copy(__DIR__.'/Fixtures/gitignore/search_root/b.txt', __DIR__.'/Fixtures/gitignore/search_root/c.txt');
copy(__DIR__.'/Fixtures/gitignore/search_root/dir/a.txt', __DIR__.'/Fixtures/gitignore/search_root/dir/b.txt');
copy(__DIR__.'/Fixtures/gitignore/search_root/dir/a.txt', __DIR__.'/Fixtures/gitignore/search_root/dir/c.txt');

$this->assertIterator($this->toAbsoluteFixtures([
'gitignore/b.txt',
'gitignore/dir',
'gitignore/dir/a.txt',
]), $finder->in(__DIR__.'/Fixtures/gitignore')->getIterator());
'gitignore/search_root/b.txt',
'gitignore/search_root/c.txt',
'gitignore/search_root/dir',
'gitignore/search_root/dir/a.txt',
'gitignore/search_root/dir/c.txt',
]), $finder->in(__DIR__.'/Fixtures/gitignore/search_root')->getIterator());
}

public function testIgnoreVCSCanBeDisabledAfterFirstIteration()
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Finder/Tests/Fixtures/gitignore/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
/a.txt
c.txt
1 change: 1 addition & 0 deletions src/Symfony/Component/Finder/Tests/Fixtures/gitignore/search_root/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/a.txt
0 ...ent/Finder/Tests/Fixtures/gitignore/b.txt → ...ests/Fixtures/gitignore/search_root/b.txt
View file
Open in desktop
File renamed without changes.
0 ...r/Tests/Fixtures/gitignore/dir/.gitignore → ...ures/gitignore/search_root/dir/.gitignore
View file
Open in desktop
File renamed without changes.
0 ...Finder/Tests/Fixtures/gitignore/dir/a.txt → .../Fixtures/gitignore/search_root/dir/a.txt
View file
Open in desktop
File renamed without changes.
9 changes: 9 additions & 0 deletions src/Symfony/Component/Finder/Tests/Iterator/VcsIgnoredFilterIteratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,15 @@ public function getAcceptData(): iterable
];
}

public function testAcceptAtRootDirectory()
{
$inner = new InnerNameIterator([__FILE__]);

$iterator = new VcsIgnoredFilterIterator($inner, '/');

$this->assertIterator([__FILE__], $iterator);
}

private function toAbsolute(array $files): array
{
foreach ($files as &$path) {
Expand Down