Skip to content

Commit

Permalink
Merge pull request #1456 from jim-parry/testing4/http
Browse files Browse the repository at this point in the history 
Beef up HTTP URI & Response testing
  • Loading branch information
@jim-parry
jim-parry authored Nov 11, 2018
2 parents 53f17e8 + 1f4aefd commit a0cdb73
Show file tree
Hide file tree
Showing 6 changed files with 519 additions and 219 deletions.
129 changes: 64 additions & 65 deletions system/HTTP/Files/UploadedFile.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @package CodeIgniter
* @author CodeIgniter Dev Team
* @copyright 2014-2018 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @package CodeIgniter
* @author CodeIgniter Dev Team
* @copyright 2014-2018 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @filesource
*/
use CodeIgniter\Files\File;
Expand Down Expand Up @@ -83,14 +83,14 @@ class UploadedFile extends File implements UploadedFileInterface
* The error constant of the upload
* (one of PHP's UPLOADERRXXX constants)
*
* @var int
* @var integer
*/
protected $error;

/**
* Whether the file has been moved already or not.
*
* @var bool
* @var boolean
*/
protected $hasMoved = false;

Expand All @@ -99,20 +99,20 @@ class UploadedFile extends File implements UploadedFileInterface
/**
* Accepts the file information as would be filled in from the $_FILES array.
*
* @param string $path The temporary location of the uploaded file.
* @param string $originalName The client-provided filename.
* @param string $mimeType The type of file as provided by PHP
* @param int $size The size of the file, in bytes
* @param int $error The error constant of the upload (one of PHP's UPLOADERRXXX constants)
* @param string $path The temporary location of the uploaded file.
* @param string $originalName The client-provided filename.
* @param string $mimeType The type of file as provided by PHP
* @param integer $size The size of the file, in bytes
* @param integer $error The error constant of the upload (one of PHP's UPLOADERRXXX constants)
*/
public function __construct(string $path, string $originalName, string $mimeType = null, int $size = null, int $error = null)
{
$this->path = $path;
$this->name = $originalName;
$this->originalName = $originalName;
$this->originalMimeType = $mimeType;
$this->size = $size;
$this->error = $error;
$this->path = $path;
$this->name = $originalName;
$this->originalName = $originalName;
$this->originalMimeType = $mimeType;
$this->size = $size;
$this->error = $error;

parent::__construct($path, false);
}
Expand Down Expand Up @@ -141,12 +141,12 @@ public function __construct(string $path, string $originalName, string $mimeType
* @see http://php.net/is_uploaded_file
* @see http://php.net/move_uploaded_file
*
* @param string $targetPath Path to which to move the uploaded file.
* @param string $name the name to rename the file to.
* @param bool $overwrite State for indicating whether to overwrite the previously generated file with the same
* name or not.
* @param string $targetPath Path to which to move the uploaded file.
* @param string $name the name to rename the file to.
* @param boolean $overwrite State for indicating whether to overwrite the previously generated file with the same
* name or not.
*
* @return bool
* @return boolean
*
* @throws \InvalidArgumentException if the $path specified is invalid.
* @throws \RuntimeException on any error during the move operation.
Expand All @@ -161,13 +161,13 @@ public function move(string $targetPath, string $name = null, bool $overwrite =
throw HTTPException::forAlreadyMoved();
}

if ( ! $this->isValid())
if (! $this->isValid())
{
throw HTTPException::forInvalidFile();
}

$targetPath = rtrim($targetPath, '/') . '/';
$name = is_null($name) ? $this->getName() : $name;
$targetPath = rtrim($targetPath, '/') . '/';
$name = is_null($name) ? $this->getName() : $name;
$destination = $overwrite ? $targetPath . $name : $this->getDestination($targetPath . $name);

try
Expand All @@ -183,9 +183,9 @@ public function move(string $targetPath, string $name = null, bool $overwrite =
@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);
$this->hasMoved = true;

return true;
}
Expand All @@ -200,11 +200,11 @@ public function move(string $targetPath, string $name = null, bool $overwrite =
*/
protected function setPath($path)
{
if ( ! is_dir($path))
if (! is_dir($path))
{
mkdir($path, 0777, true);
//create the index.html file
if ( ! file_exists($path . 'index.html'))
if (! file_exists($path . 'index.html'))
{
$file = fopen($path . 'index.html', 'x+');
fclose($file);
Expand All @@ -220,7 +220,7 @@ protected function setPath($path)
* the move() method will not work and certain properties, like
* the tempName, will no longer be available.
*
* @return bool
* @return boolean
*/
public function hasMoved(): bool
{
Expand All @@ -240,8 +240,8 @@ public function hasMoved(): bool
* Implementations SHOULD return the value stored in the "error" key of
* the file in the $_FILES array.
*
* @see http://php.net/manual/en/features.file-upload.errors.php
* @return int One of PHP's UPLOAD_ERR_XXX constants.
* @see http://php.net/manual/en/features.file-upload.errors.php
* @return integer One of PHP's UPLOAD_ERR_XXX constants.
*/
public function getError(): int
{
Expand All @@ -265,14 +265,14 @@ public function getError(): int
public function getErrorString()
{
static $errors = [
UPLOAD_ERR_OK => 'The file uploaded with success.',
UPLOAD_ERR_INI_SIZE => 'The file "%s" exceeds your upload_max_filesize ini directive.',
UPLOAD_ERR_FORM_SIZE => 'The file "%s" exceeds the upload limit defined in your form.',
UPLOAD_ERR_PARTIAL => 'The file "%s" was only partially uploaded.',
UPLOAD_ERR_NO_FILE => 'No file was uploaded.',
UPLOAD_ERR_CANT_WRITE => 'The file "%s" could not be written on disk.',
UPLOAD_ERR_NO_TMP_DIR => 'File could not be uploaded: missing temporary directory.',
UPLOAD_ERR_EXTENSION => 'File upload was stopped by a PHP extension.',
UPLOAD_ERR_OK => 'The file uploaded with success.',
UPLOAD_ERR_INI_SIZE => 'The file "%s" exceeds your upload_max_filesize ini directive.',
UPLOAD_ERR_FORM_SIZE => 'The file "%s" exceeds the upload limit defined in your form.',
UPLOAD_ERR_PARTIAL => 'The file "%s" was only partially uploaded.',
UPLOAD_ERR_NO_FILE => 'No file was uploaded.',
UPLOAD_ERR_CANT_WRITE => 'The file "%s" could not be written on disk.',
UPLOAD_ERR_NO_TMP_DIR => 'File could not be uploaded: missing temporary directory.',
UPLOAD_ERR_EXTENSION => 'File upload was stopped by a PHP extension.',
];

$error = is_null($this->error) ? UPLOAD_ERR_OK : $this->error;
Expand Down Expand Up @@ -343,14 +343,14 @@ public function getTempName(): string
* Is simply an alias for guessExtension for a safer method
* than simply relying on the provided extension.
* Additionaly it will return clientExtension in case if there are
* other extensions withe the same mime type.
* other extensions withe the same mime type.
*/
public function getExtension() : string
public function getExtension(): string
{
return $this->guessExtension();
}

public function guessExtension() : ?string
public function guessExtension(): ?string
{
return \Config\Mimes::guessExtensionFromType($this->getMimeType(), $this->getClientExtension());
}
Expand All @@ -375,32 +375,31 @@ public function getClientExtension(): string
* Returns whether the file was uploaded successfully, based on whether
* it was uploaded via HTTP and has no errors.
*
* @return bool
* @return boolean
*/
public function isValid(): bool
{
return is_uploaded_file($this->path) && $this->error === UPLOAD_ERR_OK;
}

/**
* Save the uploaded file to a new location.
*
* By default, upload files are saved in writable/uploads directory. The YYYYMMDD folder
* and random file name will be created.
*
* @param string $folderName the folder name to writable/uploads directory.
* @param string $fileName the name to rename the file to.
* @return string file full path
*/
public function store($folderName = null, $fileName = null) : string
{
$folderName = $folderName ?? date('Ymd');
$fileName = $fileName ?? $this->getRandomName();

// Move the uploaded file to a new location.
if ($this->move(WRITEPATH . 'uploads/' . $folderName, $fileName)) {
return $folderName . DIRECTORY_SEPARATOR . $this->name;
}
* Save the uploaded file to a new location.
*
* By default, upload files are saved in writable/uploads directory. The YYYYMMDD folder
* and random file name will be created.
*
* @param string $folderName the folder name to writable/uploads directory.
* @param string $fileName the name to rename the file to.
* @return string file full path
*/
public function store($folderName = null, $fileName = null): string
{
$folderName = $folderName ?? date('Ymd');
$fileName = $fileName ?? $this->getRandomName();

// Move the uploaded file to a new location.
return ($this->move(WRITEPATH . 'uploads/' . $folderName, $fileName)) ?
$folderName . DIRECTORY_SEPARATOR . $this->name : null;
}

//--------------------------------------------------------------------
Expand Down
Loading

0 comments on commit a0cdb73

Please sign in to comment.