bug #50884 [Finder] Fix initial directory is opened twice (mvorisek)

nicolas-grekas · nicolas-grekas · commit 99fa865b1537 · 2023-07-06T08:38:43.000+02:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [Finder] Fix initial directory is opened twice | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #50851 | License | MIT | Doc PR | no The issue was introduced in #8120 which was coded wrongly for several reasons: - `seekable` support is about file/stream content seeking, not about rewind support, non-seekable stream handler can support rewind - it worked by coincidence - the original code involved additional directory open (syscall), which is/was slow - 1st rewind of DirectoryIterator is implicit, ie. it is not needed - again, skipping the rewind worked by coincidence - 2nd+ rewind must fail if it is not supported, the original code silently skipped it The test from #8120 is kept and is passing. I also improved the ftp support detection to make the test stricter. To support rewind for ftp I opened - php/php-src#11597 - but this Symfony PR does not need it. Commits ------- d3f03be [Finder] Fix initial directory is opened twice
diff --git a/src/Symfony/Component/Finder/Iterator/RecursiveDirectoryIterator.php b/src/Symfony/Component/Finder/Iterator/RecursiveDirectoryIterator.php
@@ -29,7 +29,7 @@ class RecursiveDirectoryIterator extends \RecursiveDirectoryIterator
     /**
      * @var bool
      */
-    private $rewindable;
+    private $ignoreFirstRewind = true;
 
     // these 3 properties take part of the performance optimization to avoid redoing the same work in all iterations
     private $rootPath;
@@ -118,7 +118,6 @@ public function getChildren()
                 $children->ignoreUnreadableDirs = $this->ignoreUnreadableDirs;
 
                 // performance optimization to avoid redoing the same work in all children
-                $children->rewindable = &$this->rewindable;
                 $children->rootPath = $this->rootPath;
             }
 
@@ -129,40 +128,30 @@ public function getChildren()
     }
 
     /**
-     * Do nothing for non rewindable stream.
-     *
      * @return void
      */
     #[\ReturnTypeWillChange]
-    public function rewind()
+    public function next()
     {
-        if (false === $this->isRewindable()) {
-            return;
-        }
+        $this->ignoreFirstRewind = false;
 
-        parent::rewind();
+        parent::next();
     }
 
     /**
-     * Checks if the stream is rewindable.
-     *
-     * @return bool
+     * @return void
      */
-    public function isRewindable()
+    #[\ReturnTypeWillChange]
+    public function rewind()
     {
-        if (null !== $this->rewindable) {
-            return $this->rewindable;
-        }
-
-        if (false !== $stream = @opendir($this->getPath())) {
-            $infos = stream_get_meta_data($stream);
-            closedir($stream);
+        // some streams like FTP are not rewindable, ignore the first rewind after creation,
+        // as newly created DirectoryIterator does not need to be rewound
+        if ($this->ignoreFirstRewind) {
+            $this->ignoreFirstRewind = false;
 
-            if ($infos['seekable']) {
-                return $this->rewindable = true;
-            }
+            return;
         }
 
-        return $this->rewindable = false;
+        parent::rewind();
     }
 }
diff --git a/src/Symfony/Component/Finder/Tests/Iterator/RecursiveDirectoryIteratorTest.php b/src/Symfony/Component/Finder/Tests/Iterator/RecursiveDirectoryIteratorTest.php
@@ -15,16 +15,19 @@
 
 class RecursiveDirectoryIteratorTest extends IteratorTestCase
 {
+    protected function setUp(): void
+    {
+        if (!\in_array('ftp', stream_get_wrappers(), true) || !\ini_get('allow_url_fopen')) {
+            $this->markTestSkipped('Unsupported stream "ftp".');
+        }
+    }
+
     /**
      * @group network
      */
     public function testRewindOnFtp()
     {
-        try {
-            $i = new RecursiveDirectoryIterator('ftp://speedtest:speedtest@ftp.otenet.gr/', \RecursiveDirectoryIterator::SKIP_DOTS);
-        } catch (\UnexpectedValueException $e) {
-            $this->markTestSkipped('Unsupported stream "ftp".');
-        }
+        $i = new RecursiveDirectoryIterator('ftp://speedtest:speedtest@ftp.otenet.gr/', \RecursiveDirectoryIterator::SKIP_DOTS);
 
         $i->rewind();
 
@@ -36,11 +39,7 @@ public function testRewindOnFtp()
      */
     public function testSeekOnFtp()
     {
-        try {
-            $i = new RecursiveDirectoryIterator('ftp://speedtest:speedtest@ftp.otenet.gr/', \RecursiveDirectoryIterator::SKIP_DOTS);
-        } catch (\UnexpectedValueException $e) {
-            $this->markTestSkipped('Unsupported stream "ftp".');
-        }
+        $i = new RecursiveDirectoryIterator('ftp://speedtest:speedtest@ftp.otenet.gr/', \RecursiveDirectoryIterator::SKIP_DOTS);
 
         $contains = [
             'ftp://speedtest:speedtest@ftp.otenet.gr'.\DIRECTORY_SEPARATOR.'test100Mb.db',
