[Filesystem] Made sure Filesystem::dumpFile() overwrites an existing file.

jakzal · jakzal · commit 4f4ec76ba457 · 2013-04-24T09:04:45.000+01:00
diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -224,16 +224,17 @@ public function chgrp($files, $group, $recursive = false)
     /**
      * Renames a file.
      *
-     * @param string $origin The origin filename
-     * @param string $target The new filename
+     * @param string  $origin    The origin filename
+     * @param string  $target    The new filename
+     * @param Boolean $overwrite Whether to overwrite the target if it already exists
      *
      * @throws IOException When target file already exists
      * @throws IOException When origin cannot be renamed
      */
-    public function rename($origin, $target)
+    public function rename($origin, $target, $overwrite = false)
     {
         // we check that target does not exist
-        if (is_readable($target)) {
+        if (!$overwrite && is_readable($target)) {
             throw new IOException(sprintf('Cannot rename because the target "%s" already exist.', $target));
         }
 
@@ -452,7 +453,7 @@ public function dumpFile($filename, $content, $mode = 0666)
             throw new IOException(sprintf('Failed to write file "%s".', $filename));
         }
 
-        $this->rename($tmpFile, $filename);
+        $this->rename($tmpFile, $filename, true);
         $this->chmod($filename, $mode);
     }
 }
diff --git a/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php b/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
@@ -639,6 +639,20 @@ public function testRenameThrowsExceptionIfTargetAlreadyExists()
         $this->filesystem->rename($file, $newPath);
     }
 
+    public function testRenameOverwritesTheTargetIfItAlreadyExists()
+    {
+        $file = $this->workspace.DIRECTORY_SEPARATOR.'file';
+        $newPath = $this->workspace.DIRECTORY_SEPARATOR.'new_file';
+
+        touch($file);
+        touch($newPath);
+
+        $this->filesystem->rename($file, $newPath, true);
+
+        $this->assertFileNotExists($file);
+        $this->assertFileExists($newPath);
+    }
+
     /**
      * @expectedException \Symfony\Component\Filesystem\Exception\IOException
      */
@@ -894,6 +908,17 @@ public function testDumpFile()
         $this->assertEquals(753, $this->getFilePermissions($filename));
     }
 
+    public function testDumpFileOverwritesAnExistingFile()
+    {
+        $filename = $this->workspace.DIRECTORY_SEPARATOR.'foo.txt';
+        file_put_contents($filename, 'FOO BAR');
+
+        $this->filesystem->dumpFile($filename, 'bar');
+
+        $this->assertFileExists($filename);
+        $this->assertSame('bar', file_get_contents($filename));
+    }
+
     /**
      * Returns file permissions as three digits (i.e. 755)
      *

Original file line number	Diff line number	Diff line change
`@@ -224,16 +224,17 @@ public function chgrp($files, $group, $recursive = false)`
`224`	`224`	`/**`
`225`	`225`	`* Renames a file.`
`226`	`226`	`*`
`227`		`- * @param string $origin The origin filename`
`228`		`- * @param string $target The new filename`
	`227`	`+ * @param string $origin The origin filename`
	`228`	`+ * @param string $target The new filename`
	`229`	`+ * @param Boolean $overwrite Whether to overwrite the target if it already exists`
`229`	`230`	`*`
`230`	`231`	`* @throws IOException When target file already exists`
`231`	`232`	`* @throws IOException When origin cannot be renamed`
`232`	`233`	`*/`
`233`		`- public function rename($origin, $target)`
	`234`	`+ public function rename($origin, $target, $overwrite = false)`
`234`	`235`	`{`
`235`	`236`	`// we check that target does not exist`
`236`		`- if (is_readable($target)) {`
	`237`	`+ if (!$overwrite && is_readable($target)) {`
`237`	`238`	`throw new IOException(sprintf('Cannot rename because the target "%s" already exist.', $target));`
`238`	`239`	`}`
`239`	`240`
`@@ -452,7 +453,7 @@ public function dumpFile($filename, $content, $mode = 0666)`
`452`	`453`	`throw new IOException(sprintf('Failed to write file "%s".', $filename));`
`453`	`454`	`}`
`454`	`455`
`455`		`- $this->rename($tmpFile, $filename);`
	`456`	`+ $this->rename($tmpFile, $filename, true);`
`456`	`457`	`$this->chmod($filename, $mode);`
`457`	`458`	`}`
`458`	`459`	`}`