Skip to content

Commit

Permalink
[Filesystem] removed getPath() on Exceptions and cleaned up CS and er…
Browse files Browse the repository at this point in the history 
…ror messages
  • Loading branch information
@fabpot
fabpot committed Sep 27, 2013
1 parent 785080a commit c2e43d0
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 88 deletions.
1 change: 0 additions & 1 deletion src/Symfony/Component/Filesystem/Exception/ExceptionInterface.php
View file
Expand Up @@ -20,5 +20,4 @@
*/
interface ExceptionInterface
{

}
15 changes: 9 additions & 6 deletions src/Symfony/Component/Filesystem/Exception/FileNotFoundException.php
View file
Expand Up @@ -14,18 +14,21 @@
/**
* Exception class thrown when a file couldn't be found
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Christian Gärtner <christiangaertner.film@googlemail.com>
*/
class FileNotFoundException extends IOException
{
public function __construct($path, $message = null, $code = 0, \Exception $previous = null)
public function __construct($message = null, $code = 0, \Exception $previous = null, $path = null)
{
if ($message === null) {
$message = sprintf('File "%s" could not be found', $path);
if (null === $message) {
if (null === $path) {
$message = 'File could not be found.';
} else {
$message = sprintf('File "%s" could not be found.', $path);
}
}

$this->setPath($path);

parent::__construct($message, $code, $previous);
parent::__construct($message, $code, $previous, $path);
}
}
10 changes: 4 additions & 6 deletions src/Symfony/Component/Filesystem/Exception/IOException.php
View file
Expand Up @@ -16,21 +16,19 @@
*
* @author Romain Neutron <imprec@gmail.com>
* @author Christian Gärtner <christiangaertner.film@googlemail.com>
* @author Fabien Potencier <fabien@symfony.com>
*
* @api
*/
class IOException extends \RuntimeException implements IOExceptionInterface
{

private $path;

/**
* Set the path associated with this IOException
* @param string $path The path
*/
public function setPath($path)
public function __construct($message, $code = 0, \Exception $previous = null, $path = null)
{
$this->path = $path;

parent::__construct($message, $code, $previous);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Filesystem/Exception/IOExceptionInterface.php
View file
Expand Up @@ -20,7 +20,7 @@ interface IOExceptionInterface extends ExceptionInterface
{
/**
* Returns the associated path for the exception
*
*
* @return string The path.
*/
public function getPath();
Expand Down
79 changes: 21 additions & 58 deletions src/Symfony/Component/Filesystem/Filesystem.php
View file
Expand Up @@ -38,7 +38,7 @@ class Filesystem
public function copy($originFile, $targetFile, $override = false)
{
if (stream_is_local($originFile) && !is_file($originFile)) {
throw new FileNotFoundException($originFile, sprintf('Failed to copy %s because file does not exist', $originFile));
throw new FileNotFoundException(sprintf('Failed to copy "%s" because file does not exist.', $originFile), 0, null, $originFile);
}

$this->mkdir(dirname($targetFile));
Expand All @@ -59,9 +59,7 @@ public function copy($originFile, $targetFile, $override = false)
unset($source, $target);

if (!is_file($targetFile)) {
$e = new IOException(sprintf('Failed to copy %s to %s', $originFile, $targetFile));
$e->setPath($originFile);
throw $e;
throw new IOException(sprintf('Failed to copy "%s" to "%s".', $originFile, $targetFile), 0, null, $originFile);
}
}
}
Expand All @@ -82,9 +80,7 @@ public function mkdir($dirs, $mode = 0777)
}

if (true !== @mkdir($dir, $mode, true)) {
$e = new IOException(sprintf('Failed to create %s', $dir));
$e->setPath($dir);
throw $e;
throw new IOException(sprintf('Failed to create "%s".', $dir), 0, null, $dir);
}
}
}
Expand Down Expand Up @@ -121,9 +117,7 @@ public function touch($files, $time = null, $atime = null)
foreach ($this->toIterator($files) as $file) {
$touch = $time ? @touch($file, $time, $atime) : @touch($file);
if (true !== $touch) {
$e = new IOException(sprintf('Failed to touch %s', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Failed to touch "%s".', $file), 0, null, $file);
}
}
}
Expand All @@ -148,23 +142,17 @@ public function remove($files)
$this->remove(new \FilesystemIterator($file));

if (true !== @rmdir($file)) {
$e = new IOException(sprintf('Failed to remove directory %s', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Failed to remove directory "%s".', $file), 0, null, $file);
}
} else {
// https://bugs.php.net/bug.php?id=52176
if (defined('PHP_WINDOWS_VERSION_MAJOR') && is_dir($file)) {
if (true !== @rmdir($file)) {
$e = new IOException(sprintf('Failed to remove file %s', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Failed to remove file "%s".', $file), 0, null, $file);
}
} else {
if (true !== @unlink($file)) {
$e = new IOException(sprintf('Failed to remove file %s', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Failed to remove file "%s".', $file), 0, null, $file);
}
}
}
Expand All @@ -188,9 +176,7 @@ public function chmod($files, $mode, $umask = 0000, $recursive = false)
$this->chmod(new \FilesystemIterator($file), $mode, $umask, true);
}
if (true !== @chmod($file, $mode & ~$umask)) {
$e = new IOException(sprintf('Failed to chmod file %s', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Failed to chmod file "%s".', $file), 0, null, $file);
}
}
}
Expand All @@ -212,15 +198,11 @@ public function chown($files, $user, $recursive = false)
}
if (is_link($file) && function_exists('lchown')) {
if (true !== @lchown($file, $user)) {
$e = new IOException(sprintf('Failed to chown file %s', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Failed to chown file "%s".', $file), 0, null, $file);
}
} else {
if (true !== @chown($file, $user)) {
$e = new IOException(sprintf('Failed to chown file %s', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Failed to chown file "%s".', $file), 0, null, $file);
}
}
}
Expand All @@ -243,15 +225,11 @@ public function chgrp($files, $group, $recursive = false)
}
if (is_link($file) && function_exists('lchgrp')) {
if (true !== @lchgrp($file, $group)) {
$e = new IOException(sprintf('Failed to chgrp file %s', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Failed to chgrp file "%s".', $file), 0, null, $file);
}
} else {
if (true !== @chgrp($file, $group)) {
$e = new IOException(sprintf('Failed to chgrp file %s', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Failed to chgrp file "%s".', $file), 0, null, $file);
}
}
}
Expand All @@ -271,15 +249,11 @@ public function rename($origin, $target, $overwrite = false)
{
// we check that target does not exist
if (!$overwrite && is_readable($target)) {
$e = new IOException(sprintf('Cannot rename because the target "%s" already exists.', $target));
$e->setPath($target);
throw $e;
throw new IOException(sprintf('Cannot rename because the target "%s" already exists.', $target), 0, null, $target);
}

if (true !== @rename($origin, $target)) {
$e = new IOException(sprintf('Cannot rename "%s" to "%s".', $origin, $target));
$e->setPath($target);
throw $e;
throw new IOException(sprintf('Cannot rename "%s" to "%s".', $origin, $target), 0, null, $target);
}
}

Expand Down Expand Up @@ -316,14 +290,11 @@ public function symlink($originDir, $targetDir, $copyOnWindows = false)
$report = error_get_last();
if (is_array($report)) {
if (defined('PHP_WINDOWS_VERSION_MAJOR') && false !== strpos($report['message'], 'error code(1314)')) {
$e = new IOException('Unable to create symlink due to error code 1314: \'A required privilege is not held by the client\'. Do you have the required Administrator-rights?');
$e->setPath(null);
throw $e;
throw new IOException('Unable to create symlink due to error code 1314: \'A required privilege is not held by the client\'. Do you have the required Administrator-rights?');
}
}
$e = new IOException(sprintf('Failed to create symbolic link from %s to %s', $originDir, $targetDir));
$e->setPath($targetDir);
throw $e;

throw new IOException(sprintf('Failed to create symbolic link from "%s" to "%s".', $originDir, $targetDir), 0, null, $targetDir);
}
}
}
Expand Down Expand Up @@ -421,9 +392,7 @@ public function mirror($originDir, $targetDir, \Traversable $iterator = null, $o
} elseif (is_dir($file)) {
$this->mkdir($target);
} else {
$e = new IOException(sprintf('Unable to guess "%s" file type.', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Unable to guess "%s" file type.', $file), 0, null, $file);
}
} else {
if (is_link($file)) {
Expand All @@ -433,9 +402,7 @@ public function mirror($originDir, $targetDir, \Traversable $iterator = null, $o
} elseif (is_file($file)) {
$this->copy($file, $target, isset($options['override']) ? $options['override'] : false);
} else {
$e = new IOException(sprintf('Unable to guess "%s" file type.', $file));
$e->setPath($file);
throw $e;
throw new IOException(sprintf('Unable to guess "%s" file type.', $file), 0, null, $file);
}
}
}
Expand Down Expand Up @@ -478,17 +445,13 @@ public function dumpFile($filename, $content, $mode = 0666)
if (!is_dir($dir)) {
$this->mkdir($dir);
} elseif (!is_writable($dir)) {
$e = new IOException(sprintf('Unable to write to the "%s" directory.', $dir));
$e->setPath($dir);
throw $e;
throw new IOException(sprintf('Unable to write to the "%s" directory.', $dir), 0, null, $dir);
}

$tmpFile = tempnam($dir, basename($filename));

if (false === @file_put_contents($tmpFile, $content)) {
$e = new IOException(sprintf('Failed to write file "%s".', $filename));
$e->setPath($filename);
throw $e;
throw new IOException(sprintf('Failed to write file "%s".', $filename), 0, null, $filename);
}

$this->rename($tmpFile, $filename, true);
Expand Down
27 changes: 11 additions & 16 deletions src/Symfony/Component/Filesystem/Tests/ExceptionTest.php
View file
Expand Up @@ -19,33 +19,28 @@
*/
class ExceptionTest extends \PHPUnit_Framework_TestCase
{
public function testSetPath()
{
$e = new IOException();
$e->setPath('/foo');
$reflection = new \ReflectionProperty($e, 'path');
$reflection->setAccessible(true);

$this->assertEquals('/foo', $reflection->getValue($e), 'The path should get stored in the "path" property');
}

public function testGetPath()
{
$e = new IOException();
$e->setPath('/foo');
$e = new IOException('', 0, null, '/foo');
$this->assertEquals('/foo', $e->getPath(), 'The pass should be returned.');
}

public function testGeneratedMessage()
{
$e = new FileNotFoundException('/foo');
$e = new FileNotFoundException(null, 0, null, '/foo');
$this->assertEquals('/foo', $e->getPath());
$this->assertEquals('File "/foo" could not be found', $e->getMessage(), 'A message should be generated.');
$this->assertEquals('File "/foo" could not be found.', $e->getMessage(), 'A message should be generated.');
}

public function testGeneratedMessageWithoutPath()
{
$e = new FileNotFoundException();
$this->assertEquals('File could not be found.', $e->getMessage(), 'A message should be generated.');
}

public function testCustomMessage()
{
$e = new FileNotFoundException('/foo', 'bar');
$e = new FileNotFoundException('bar', 0, null, '/foo');
$this->assertEquals('bar', $e->getMessage(), 'A custom message should be possible still.');
}
}
}

0 comments on commit c2e43d0

Please sign in to comment.