Skip to content
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

fix: UploadedFile::move() may return incorrect value #5302

Merged
merged 5 commits into from
Nov 23, 2021
Merged

fix: UploadedFile::move() may return incorrect value #5302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
27d216b
fix: UploadedFile::hasMoved() may return incorrect value
kenjis Nov 10, 2021
955100e
refactor: use ??
kenjis Nov 21, 2021
5bf3492
test: add expectExceptionMessage()
kenjis Nov 21, 2021
3a7722c
test: refactor: remove unneeded variable
kenjis Nov 21, 2021
c0a8005
test: refactor: separate arrange, act, assert code
kenjis Nov 21, 2021
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
15 changes: 10 additions & 5 deletions system/HTTP/Files/UploadedFile.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,20 +141,25 @@ public function move(string $targetPath, ?string $name = null, bool $overwrite =
$destination = $overwrite ? $targetPath . $name : $this->getDestination($targetPath . $name);

try {
move_uploaded_file($this->path, $destination);
$this->hasMoved = move_uploaded_file($this->path, $destination);
} catch (Exception $e) {
kenjis marked this conversation as resolved.
Show resolved Hide resolved
$error = error_get_last();
$message = isset($error['message']) ? strip_tags($error['message']) : '';
$message = strip_tags($error['message'] ?? '');

throw HTTPException::forMoveFailed(basename($this->path), $targetPath, $message);
}

if ($this->hasMoved === false) {
$message = 'move_uploaded_file() returned false';

throw HTTPException::forMoveFailed(basename($this->path), $targetPath, $message);
}

@chmod($targetPath, 0777 & ~umask());

// Success, so store our new information
$this->path = $targetPath;
$this->name = basename($destination);
$this->hasMoved = true;
$this->path = $targetPath;
$this->name = basename($destination);

return true;
}
Expand Down
82 changes: 60 additions & 22 deletions tests/system/HTTP/Files/FileMovingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ protected function setUp(): void
}

$_FILES = [];

// Set the mock's return value to true
move_uploaded_file('', '', true);
}

protected function tearDown(): void
Expand All @@ -52,8 +55,7 @@ protected function tearDown(): void
public function testMove()
{
$finalFilename = 'fileA';

$_FILES = [
$_FILES = [
'userfile1' => [
'name' => $finalFilename . '.txt',
'type' => 'text/plain',
Expand All @@ -76,7 +78,6 @@ public function testMove()
$this->assertTrue($collection->hasFile('userfile2'));

$destination = $this->destination;

// Create the destination if not exists
if (! is_dir($destination)) {
mkdir($destination, 0777, true);
Expand All @@ -94,8 +95,7 @@ public function testMove()
public function testMoveOverwriting()
{
$finalFilename = 'file_with_delimiters_underscore';

$_FILES = [
$_FILES = [
'userfile1' => [
'name' => $finalFilename . '.txt',
'type' => 'text/plain',
Expand Down Expand Up @@ -126,7 +126,6 @@ public function testMoveOverwriting()
$this->assertTrue($collection->hasFile('userfile3'));

$destination = $this->destination;

// Create the destination if not exists
if (! is_dir($destination)) {
mkdir($destination, 0777, true);
Expand All @@ -146,8 +145,7 @@ public function testMoveOverwriting()
public function testMoved()
{
$finalFilename = 'fileA';

$_FILES = [
$_FILES = [
'userfile1' => [
'name' => $finalFilename . '.txt',
'type' => 'text/plain',
Expand All @@ -162,7 +160,6 @@ public function testMoved()
$this->assertTrue($collection->hasFile('userfile1'));

$destination = $this->destination;

// Create the destination if not exists
if (! is_dir($destination)) {
mkdir($destination, 0777, true);
Expand All @@ -172,15 +169,16 @@ public function testMoved()

$this->assertInstanceOf(UploadedFile::class, $file);
$this->assertFalse($file->hasMoved());

$file->move($destination, $file->getName(), false);

$this->assertTrue($file->hasMoved());
}

public function testStore()
{
$finalFilename = 'fileA';

$_FILES = [
$_FILES = [
'userfile1' => [
'name' => $finalFilename . '.txt',
'type' => 'text/plain',
Expand All @@ -195,7 +193,6 @@ public function testStore()
$this->assertTrue($collection->hasFile('userfile1'));

$destination = $this->destination;

// Create the destination if not exists
if (! is_dir($destination)) {
mkdir($destination, 0777, true);
Expand All @@ -204,15 +201,16 @@ public function testStore()
$file = $collection->getFile('userfile1');

$this->assertInstanceOf(UploadedFile::class, $file);

$path = $file->store($destination, $file->getName());

$this->assertSame($destination . '/fileA.txt', $path);
}

public function testAlreadyMoved()
{
$finalFilename = 'fileA';

$_FILES = [
$_FILES = [
'userfile1' => [
'name' => $finalFilename . '.txt',
'type' => 'text/plain',
Expand All @@ -227,7 +225,6 @@ public function testAlreadyMoved()
$this->assertTrue($collection->hasFile('userfile1'));

$destination = $this->destination;

// Create the destination if not exists
if (! is_dir($destination)) {
mkdir($destination, 0777, true);
Expand All @@ -254,15 +251,15 @@ public function testInvalidFile()
];

$destination = $this->destination;

$collection = new FileCollection();
$file = $collection->getFile('userfile');
$collection = new FileCollection();

$this->expectException(HTTPException::class);

$file = $collection->getFile('userfile');
$file->move($destination, $file->getName(), false);
}

public function testFailedMove()
public function testFailedMoveBecauseOfWarning()
{
$_FILES = [
'userfile' => [
Expand All @@ -275,16 +272,47 @@ public function testFailedMove()
];

$destination = $this->destination;

// Create the destination and make it read only
if (! is_dir($destination)) {
mkdir($destination, 0400, true);
}

$collection = new FileCollection();
$file = $collection->getFile('userfile');

$this->expectException(HTTPException::class);

$file = $collection->getFile('userfile');
$file->move($destination, $file->getName(), false);
}

public function testFailedMoveBecauseOfFalseReturned()
{
$_FILES = [
'userfile1' => [
'name' => 'fileA.txt',
'type' => 'text/plain',
'size' => 124,
'tmp_name' => '/tmp/fileA.txt',
'error' => 0,
],
];

$collection = new FileCollection();

$this->assertTrue($collection->hasFile('userfile1'));

$destination = $this->destination;
// Create the destination if not exists
if (! is_dir($destination)) {
mkdir($destination, 0777, true);
}
// Set the mock's return value to false
move_uploaded_file('', '', false);

$this->expectException(HTTPException::class);
paulbalandan marked this conversation as resolved.
Show resolved Hide resolved
$this->expectExceptionMessage('move_uploaded_file() returned false');

$file = $collection->getFile('userfile1');
$file->move($destination, $file->getName(), false);
}
}
Expand All @@ -311,10 +339,20 @@ function is_uploaded_file($filename)
* This overwrite is for testing the move operation.
*/

function move_uploaded_file($filename, $destination)
function move_uploaded_file($filename, $destination, ?bool $setReturnValue = null)
{
static $return = true;

if ($setReturnValue !== null) {
$return = $setReturnValue;

return true;
}

copy($filename, $destination);
unlink($filename);

return $return;
}

function rrmdir($src)
Expand Down