Skip to content

[FileSystem] Windows fix #16987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 18, 2016
Merged

[FileSystem] Windows fix #16987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions src/Symfony/Component/Filesystem/Filesystem.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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($file) > 258) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe better use && here? Any reason why AND needed?

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;
}
Expand Down Expand Up @@ -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;
}

Expand All @@ -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']));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually, this kind of changes are considered as new features, to me moved to a PR on the master branch IMO

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not really, we do improve exception messages in patch releases.

}
}
}
Expand Down Expand Up @@ -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)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not use file_exists here ? Is is_readable really required?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well your question would be best addressed to fabpot, since he put this in at 17 Feb 2010. But my guess is that file_exists would work just as well here

throw new IOException(sprintf('Cannot rename because the target "%s" already exist.', $target));
}

Expand All @@ -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($filename) > 258) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe better use && here? Any reason why AND needed?

throw new IOException(sprintf('Could not check if file is readable because path length exceeds 258 characters for file "%s"', $filename));
}

return is_readable($filename);
}

/**
* Creates a symbolic link or copy a directory.
*
Expand Down
29 changes: 29 additions & 0 deletions src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
class FilesystemTest extends \PHPUnit_Framework_TestCase
{
private $umask;
private $longPathNamesWindows = array();

/**
* @var string
Expand Down Expand Up @@ -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);
}
Expand Down Expand Up @@ -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\\';

$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;
Expand Down