symfony · pierredup · Feb 9, 2018 · Nov 26, 2019 · Mar 26, 2020 · Mar 26, 2020
diff --git a/src/Symfony/Component/Filesystem/CHANGELOG.md b/src/Symfony/Component/Filesystem/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.1.0
+-----
+
+ * added `watch()` method to watch filesystem for changes
+
 5.0.0
 -----
 

diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -14,6 +14,8 @@
 use Symfony\Component\Filesystem\Exception\FileNotFoundException;
 use Symfony\Component\Filesystem\Exception\InvalidArgumentException;
 use Symfony\Component\Filesystem\Exception\IOException;
+use Symfony\Component\Filesystem\Watcher\FileChangeWatcher;
+use Symfony\Component\Filesystem\Watcher\INotifyWatcher;
 
 /**
  * Provides basic utility to manipulate the file system.
@@ -695,6 +697,26 @@ public function appendToFile(string $filename, $content)
         }
     }
 
+    /**
+     * Watches a file or directory for any changes, and calls $callback when any changes are detected.
+     *
+     * @param mixed    $path     The path to watch for changes. Can be a path to a file or directory, iterator or array with paths
+     * @param callable $callback The callback to execute when a change is detected
+     * @param float    $timeout  The idle timeout in milliseconds after which the process will be aborted if there are no changes detected
+     *
+     * @throws \InvalidArgumentException|IOException
+     */
+    public function watch($path, callable $callback, float $timeout = null)
+    {
+        if (\extension_loaded('inotify')) {
+            $watcher = new INotifyWatcher();
+        } else {
+            $watcher = new FileChangeWatcher();
+        }
+
+        $watcher->watch($path, $callback, $timeout);
+    }
+
     private function toIterable($files): iterable
     {
         return \is_array($files) || $files instanceof \Traversable ? $files : [$files];

diff --git a/src/Symfony/Component/Filesystem/Tests/Fixtures/ChangeFileResource.php b/src/Symfony/Component/Filesystem/Tests/Fixtures/ChangeFileResource.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Filesystem\Tests\Fixtures;
+
+use Symfony\Component\Filesystem\Watcher\FileChangeEvent;
+use Symfony\Component\Filesystem\Watcher\Resource\ResourceInterface;
+
+/**
+ * @author Pierre du Plessis <pdples@gmail.com>
+ */
+final class ChangeFileResource implements ResourceInterface
+{
+    private $path;
+
+    public function __construct(string $path)
+    {
+        $this->path = $path;
+    }
+
+    public function detectChanges(): array
+    {
+        return [new FileChangeEvent($this->path, FileChangeEvent::FILE_CHANGED)];
+    }
+}
diff --git a/src/Symfony/Component/Filesystem/Tests/Watcher/FileSystemWatchTest.php b/src/Symfony/Component/Filesystem/Tests/Watcher/FileSystemWatchTest.php
@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Filesystem\Tests\Watcher;
+
+use Symfony\Component\Filesystem\Tests\FilesystemTestCase;
+use Symfony\Component\Filesystem\Tests\Fixtures\ChangeFileResource;
+use Symfony\Component\Filesystem\Watcher\FileChangeEvent;
+use Symfony\Component\Filesystem\Watcher\FileChangeWatcher;
+use Symfony\Component\Filesystem\Watcher\Resource\DirectoryResource;
+use Symfony\Component\Filesystem\Watcher\Resource\ResourceInterface;
+
+class FileSystemWatchTest extends FilesystemTestCase
+{
+    public function testWatch()
+    {
+        $workspace = $this->workspace;
+
+        $locator = new class($workspace) {
+            private $workspace;
+
+            public function __construct($workspace)
+            {
+                $this->workspace = $workspace;
+            }
+
+            public function locate($path): ?ResourceInterface
+            {
+                return new ChangeFileResource($this->workspace.'/foobar.txt');
+            }
+        };
+
+        $watcher = new FileChangeWatcher();
+        $watcher->locator = $locator;
+
+        $count = 0;
+        $watcher->watch($this->workspace, function ($file, $code) use (&$count) {
+            $this->assertSame($this->workspace.'/foobar.txt', $file);
+            $this->assertSame(FileChangeEvent::FILE_CHANGED, $code);
+            ++$count;
+
+            if (2 === $count) {
+                return false;
+            }
+        });
+
+        $this->assertSame(2, $count);
+    }
+
+    public function testWatchTimeout()
+    {
+        $locator = new class() {
+            public function locate($path): ?ResourceInterface
+            {
+                return new DirectoryResource($path);
+            }
+        };
+
+        $watcher = new FileChangeWatcher();
+        $ref = new \ReflectionProperty($watcher, 'locator');
+        $ref->setAccessible(true);
+        $ref->setValue($watcher, $locator);
+
+        $start = microtime(true);
+        $watcher->watch($this->workspace, static function ($file, $code) {
+        }, 500);
+
+        $this->assertGreaterThan(0.5, microtime(true) - $start);
+    }
+}
diff --git a/src/Symfony/Component/Filesystem/Tests/Watcher/Resource/ArrayResourceTest.php b/src/Symfony/Component/Filesystem/Tests/Watcher/Resource/ArrayResourceTest.php
@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Filesystem\Tests\Watcher\Resource;
+
+use Symfony\Component\Filesystem\Tests\FilesystemTestCase;
+use Symfony\Component\Filesystem\Watcher\FileChangeEvent;
+use Symfony\Component\Filesystem\Watcher\Resource\ArrayResource;
+use Symfony\Component\Filesystem\Watcher\Resource\FileResource;
+
+class ArrayResourceTest extends FilesystemTestCase
+{
+    public function testFileChange()
+    {
+        $file = $this->workspace.'/foo.txt';
+        touch($file);
+
+        $resource = new ArrayResource([new FileResource($file)]);
+
+        $this->assertSame([], $resource->detectChanges());
+
+        touch($file, time() + 1);
+
+        $this->assertEquals([new FileChangeEvent($file, FileChangeEvent::FILE_CHANGED)], $resource->detectChanges());
+        $this->assertSame([], $resource->detectChanges());
+    }
+}
diff --git a/src/Symfony/Component/Filesystem/Tests/Watcher/Resource/DirectoryResourceTest.php b/src/Symfony/Component/Filesystem/Tests/Watcher/Resource/DirectoryResourceTest.php
@@ -0,0 +1,70 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Filesystem\Tests\Watcher\Resource;
+
+use Symfony\Component\Filesystem\Tests\FilesystemTestCase;
+use Symfony\Component\Filesystem\Watcher\FileChangeEvent;
+use Symfony\Component\Filesystem\Watcher\Resource\DirectoryResource;
+
+class DirectoryResourceTest extends FilesystemTestCase
+{
+    public function testCreateFile()
+    {
+        $dir = $this->workspace.\DIRECTORY_SEPARATOR.'foo';
+        mkdir($dir);
+
+        $resource = new DirectoryResource($dir);
+
+        $this->assertSame([], $resource->detectChanges());
+
+        touch($dir.'/foo.txt');
+
+        $this->assertEquals([new FileChangeEvent($dir.\DIRECTORY_SEPARATOR.'foo.txt', FileChangeEvent::FILE_CREATED)], $resource->detectChanges());
+        $this->assertSame([], $resource->detectChanges());
+    }
+
+    public function testDeleteFile()
+    {
+        $dir = $this->workspace.\DIRECTORY_SEPARATOR.'foo';
+        mkdir($dir);
+
+        touch($dir.'/foo.txt');
+        touch($dir.'/bar.txt');
+
+        $resource = new DirectoryResource($dir);
+
+        $this->assertSame([], $resource->detectChanges());
+
+        unlink($dir.'/foo.txt');
+
+        $this->assertEquals([new FileChangeEvent($dir.\DIRECTORY_SEPARATOR.'foo.txt', FileChangeEvent::FILE_DELETED)], $resource->detectChanges());
+        $this->assertSame([], $resource->detectChanges());
+    }
+
+    public function testFileChanges()
+    {
+        $dir = $this->workspace.\DIRECTORY_SEPARATOR.'foo';
+        mkdir($dir);
+
+        touch($dir.'/foo.txt');
+        touch($dir.'/bar.txt');
+
+        $resource = new DirectoryResource($dir);
+
+        $this->assertSame([], $resource->detectChanges());
+
+        touch($dir.'/foo.txt', time() + 1);
+
+        $this->assertEquals([new FileChangeEvent($dir.\DIRECTORY_SEPARATOR.'foo.txt', FileChangeEvent::FILE_CHANGED)], $resource->detectChanges());
+        $this->assertSame([], $resource->detectChanges());
+    }
+}
diff --git a/src/Symfony/Component/Filesystem/Tests/Watcher/Resource/FileResourceTest.php b/src/Symfony/Component/Filesystem/Tests/Watcher/Resource/FileResourceTest.php
@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Filesystem\Tests\Watcher\Resource;
+
+use Symfony\Component\Filesystem\Tests\FilesystemTestCase;
+use Symfony\Component\Filesystem\Watcher\FileChangeEvent;
+use Symfony\Component\Filesystem\Watcher\Resource\FileResource;
+
+class FileResourceTest extends FilesystemTestCase
+{
+    public function testFileChanges()
+    {
+        $file = $this->workspace.'/foo.txt';
+        touch($file);
+
+        $resource = new FileResource($file);
+
+        $this->assertSame([], $resource->detectChanges());
+
+        touch($file, time() + 1);
+
+        $this->assertEquals([new FileChangeEvent($file, FileChangeEvent::FILE_CHANGED)], $resource->detectChanges());
+        $this->assertSame([], $resource->detectChanges());
+    }
+}
diff --git a/src/Symfony/Component/Filesystem/Tests/Watcher/Resource/Locator/FileResourceLocatorTest.php b/src/Symfony/Component/Filesystem/Tests/Watcher/Resource/Locator/FileResourceLocatorTest.php
@@ -0,0 +1,96 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Filesystem\Tests\Watcher\Resource\Locator;
+
+use Symfony\Component\Filesystem\Tests\FilesystemTestCase;
+use Symfony\Component\Filesystem\Watcher\Resource\ArrayResource;
+use Symfony\Component\Filesystem\Watcher\Resource\DirectoryResource;
+use Symfony\Component\Filesystem\Watcher\Resource\FileResource;
+use Symfony\Component\Filesystem\Watcher\Resource\Locator\FileResourceLocator;
+
+class FileResourceLocatorTest extends FilesystemTestCase
+{
+    public function testLocateIterator()
+    {
+        $locator = new FileResourceLocator();
+
+        $path = new \ArrayIterator([$this->createFile('foo.txt')]);
+
+        $this->assertEquals(new ArrayResource([new FileResource($this->workspace.\DIRECTORY_SEPARATOR.'foo.txt')]), $locator->locate($path));
+    }
+
+    public function testLocateSplFileInfo()
+    {
+        $locator = new FileResourceLocator();
+
+        $path = new \SplFileInfo($this->createFile('foo.txt'));
+
+        $this->assertEquals(new FileResource($this->workspace.\DIRECTORY_SEPARATOR.'foo.txt'), $locator->locate($path));
+    }
+
+    public function testFilePath()
+    {
+        $locator = new FileResourceLocator();
+
+        $path = $this->createFile('foo.txt');
+
+        $this->assertEquals(new FileResource($this->workspace.\DIRECTORY_SEPARATOR.'foo.txt'), $locator->locate($path));
+    }
+
+    public function testGlob()
+    {
+        $locator = new FileResourceLocator();
+
+        $this->createFile('bar.txt');
+        $this->createFile('foo.txt');
+
+        $this->assertEquals(
+            new ArrayResource([new FileResource($this->workspace.\DIRECTORY_SEPARATOR.'bar.txt'), new FileResource($this->workspace.\DIRECTORY_SEPARATOR.'foo.txt')]),
+            $locator->locate($this->workspace.\DIRECTORY_SEPARATOR.'*.txt')
+        );
+    }
+
+    public function testArray()
+    {
+        $locator = new FileResourceLocator();
+
+        $path = [$this->createFile('foo.txt')];
+
+        $this->assertEquals(new ArrayResource([new FileResource($this->workspace.\DIRECTORY_SEPARATOR.'foo.txt')]), $locator->locate($path));
+    }
+
+    public function testDirectory()
+    {
+        $locator = new FileResourceLocator();
+
+        $dir = $this->createDirecty('foobar');
+
+        $this->assertEquals(new DirectoryResource($this->workspace.\DIRECTORY_SEPARATOR.'foobar'), $locator->locate($dir));
+    }
+
+    private function createFile(string $file)
+    {
+        $fullPath = $this->workspace.\DIRECTORY_SEPARATOR.$file;
+        touch($fullPath);
+
+        return $fullPath;
+    }
+
+    private function createDirecty(string $dir)
+    {
+        $fullPath = $this->workspace.\DIRECTORY_SEPARATOR.$dir;
+
+        mkdir($fullPath, 0777, true);
+
+        return $fullPath;
+    }
+}