Update FileSystem

flip111 · flip111 · commit 41a16e208f7d · 2015-12-12T18:43:29.000+01:00
* Fixes edge case on windows where PHP does not generate a PHP Warning but instead returns a wrong result https://bugs.php.net/bug.php?id=71103 * Improved error reporting on `unlink` used in `remove()`
diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -100,6 +100,10 @@ public function mkdir($dirs, $mode = 0777)
     public function exists($files)
     {
         foreach ($this->toIterator($files) as $file) {
+            if ('\\' === DIRECTORY_SEPARATOR AND strlen((string) $file) > 258) {
+                throw new IOException(sprintf('Could not check if file exist because path length exceeds 258 characters for file "%s"', $file));
+            }
+
             if (!file_exists($file)) {
                 return false;
             }
@@ -139,7 +143,7 @@ public function remove($files)
         $files = iterator_to_array($this->toIterator($files));
         $files = array_reverse($files);
         foreach ($files as $file) {
-            if (!file_exists($file) && !is_link($file)) {
+            if (!$this->exists($file) && !is_link($file)) {
                 continue;
             }
 
@@ -157,7 +161,8 @@ public function remove($files)
                     }
                 } else {
                     if (true !== @unlink($file)) {
-                        throw new IOException(sprintf('Failed to remove file %s', $file));
+                        $error = error_get_last();
+                        throw new IOException(sprintf('Failed to remove file "%s": %s.', $file, $error['message']));
                     }
                 }
             }
@@ -253,7 +258,7 @@ public function chgrp($files, $group, $recursive = false)
     public function rename($origin, $target, $overwrite = false)
     {
         // we check that target does not exist
-        if (!$overwrite && is_readable($target)) {
+        if (!$overwrite && $this->isReadable($target)) {
             throw new IOException(sprintf('Cannot rename because the target "%s" already exist.', $target));
         }
 
@@ -262,6 +267,22 @@ public function rename($origin, $target, $overwrite = false)
         }
     }
 
+    /**
+     * Tells whether a file exists and is readable.
+     *
+     * @param string $filename Path to the file.
+     *
+     * @throws IOException When windows path is longer than 258 characters
+     */
+    private function isReadable($filename)
+    {
+        if ('\\' === DIRECTORY_SEPARATOR AND strlen((string) $filename) > 258) {
+            throw new IOException(sprintf('Could not check if file is readable because path length exceeds 258 characters for file "%s"', $filename), 0, null, $filename);
+        }
+
+        return is_readable($filename);
+    }
+
     /**
      * Creates a symbolic link or copy a directory.
      *
diff --git a/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php b/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
@@ -19,6 +19,7 @@
 class FilesystemTest extends \PHPUnit_Framework_TestCase
 {
     private $umask;
+    private $longPathNamesWindows = array();
 
     /**
      * @var string
@@ -56,6 +57,12 @@ protected function setUp()
 
     protected function tearDown()
     {
+        if (!empty($this->longPathNamesWindows)) {
+            foreach ($this->longPathNamesWindows as $path) {
+                exec('DEL '.$path);
+            }
+        }
+
         $this->filesystem->remove($this->workspace);
         umask($this->umask);
     }
@@ -354,6 +361,28 @@ public function testFilesExists()
         $this->assertTrue($this->filesystem->exists($basePath.'folder'));
     }
 
+    /**
+     * @expectedException \Symfony\Component\Filesystem\Exception\IOException
+     */
+    public function testFilesExistsFails()
+    {
+        if ('\\' !== DIRECTORY_SEPARATOR) {
+            $this->markTestSkipped('Test covers edge case on Windows only.');
+        }
+
+        $basePath = $this->workspace.DIRECTORY_SEPARATOR.'directory'.DIRECTORY_SEPARATOR;
+
+        $oldPath = getcwd();
+        mkdir($basePath);
+        chdir($basePath);
+        $file = str_repeat('T', 259 - strlen($basePath));
+        $path = $basePath.$file;
+        exec('TYPE NUL >>'.$file); // equivalent of touch, we can not use the php touch() here because it suffers from the same limitation
+        $this->longPathNamesWindows[] = $path; // save this so we can clean up later
+        chdir($oldPath);
+        $this->filesystem->exists($path);
+    }
+
     public function testFilesExistsTraversableObjectOfFilesAndDirectories()
     {
         $basePath = $this->workspace.DIRECTORY_SEPARATOR;

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,10 @@ public function mkdir($dirs, $mode = 0777)`
`100`	`100`	`public function exists($files)`
`101`	`101`	`{`
`102`	`102`	`foreach ($this->toIterator($files) as $file) {`
	`103`	`+ if ('\\' === DIRECTORY_SEPARATOR AND strlen((string) $file) > 258) {`
	`104`	`+ throw new IOException(sprintf('Could not check if file exist because path length exceeds 258 characters for file "%s"', $file));`
	`105`	`+ }`
	`106`	`+`
`103`	`107`	`if (!file_exists($file)) {`
`104`	`108`	`return false;`
`105`	`109`	`}`
`@@ -139,7 +143,7 @@ public function remove($files)`
`139`	`143`	`$files = iterator_to_array($this->toIterator($files));`
`140`	`144`	`$files = array_reverse($files);`
`141`	`145`	`foreach ($files as $file) {`
`142`		`- if (!file_exists($file) && !is_link($file)) {`
	`146`	`+ if (!$this->exists($file) && !is_link($file)) {`
`143`	`147`	`continue;`
`144`	`148`	`}`
`145`	`149`
`@@ -157,7 +161,8 @@ public function remove($files)`
`157`	`161`	`}`
`158`	`162`	`} else {`
`159`	`163`	`if (true !== @unlink($file)) {`
`160`		`- throw new IOException(sprintf('Failed to remove file %s', $file));`
	`164`	`+ $error = error_get_last();`
	`165`	`+ throw new IOException(sprintf('Failed to remove file "%s": %s.', $file, $error['message']));`
`161`	`166`	`}`
`162`	`167`	`}`
`163`	`168`	`}`
`@@ -253,7 +258,7 @@ public function chgrp($files, $group, $recursive = false)`
`253`	`258`	`public function rename($origin, $target, $overwrite = false)`
`254`	`259`	`{`
`255`	`260`	`// we check that target does not exist`
`256`		`- if (!$overwrite && is_readable($target)) {`
	`261`	`+ if (!$overwrite && $this->isReadable($target)) {`
`257`	`262`	`throw new IOException(sprintf('Cannot rename because the target "%s" already exist.', $target));`
`258`	`263`	`}`
`259`	`264`
`@@ -262,6 +267,22 @@ public function rename($origin, $target, $overwrite = false)`
`262`	`267`	`}`
`263`	`268`	`}`
`264`	`269`
	`270`	`+ /**`
	`271`	`+ * Tells whether a file exists and is readable.`
	`272`	`+ *`
	`273`	`+ * @param string $filename Path to the file.`
	`274`	`+ *`
	`275`	`+ * @throws IOException When windows path is longer than 258 characters`
	`276`	`+ */`
	`277`	`+ private function isReadable($filename)`
	`278`	`+ {`
	`279`	`+ if ('\\' === DIRECTORY_SEPARATOR AND strlen((string) $filename) > 258) {`
	`280`	`+ throw new IOException(sprintf('Could not check if file is readable because path length exceeds 258 characters for file "%s"', $filename), 0, null, $filename);`
	`281`	`+ }`
	`282`	`+`
	`283`	`+ return is_readable($filename);`
	`284`	`+ }`
	`285`	`+`
`265`	`286`	`/**`
`266`	`287`	`* Creates a symbolic link or copy a directory.`
`267`	`288`	`*`