UploadFile::getStream() - Code Metrics - o2system/kernel - Measure and Improve Code Quality continuously with Scrutinizer

UploadFile::getStream() A
last analyzed 2019-10-02 16:44 UTC

↳ Parent: UploadFile
Complexity

Conditions	4
Paths	4
Size

Total Lines	17
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	4
eloc	9
c	1
b	0
f	0
nc	4
nop	0
dl	0
loc	17
rs	9.9666
<?php
/**
 * This file is part of the O2System Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Kernel\Http\Message;


use O2System\Psr\Http\Message\StreamInterface;
use O2System\Psr\Http\Message\UploadedFileInterface;
use O2System\Spl\Exceptions\Logic\BadFunctionCall\BadPhpExtensionCallException;

class UploadFile implements UploadedFileInterface
{
    /**
     * UploadFile::$name
     *
     * @var string
     */
    protected $name;

    /**
     * UploadFile::$type
     *
     * @var string
     */
    protected $type;

    /**
     * UploadFile::$tmpName
     *
     * @var string
     */
    protected $tmpName;

    /**
     * UploadFile::$size
     *
     * @var int
     */
    protected $size;

    /**
     * UploadFile::$error
     *
     * @var mixed
     */
    protected $error;

    /**
     * UploadFIle::$isMoved
     *
     * @var bool
     */
    protected $isMoved = false;

    /**
     * Uploader File Stream
     *
     * @var Stream
     */
    protected $stream;

    // ------------------------------------------------------------------------

    /**
     * UploadFile::__construct
     *
     * @param array $uploadedFile
     *
     * @throws \O2System\Spl\Exceptions\Logic\BadFunctionCall\BadPhpExtensionCallException
     */
    public function __construct(array $uploadedFile)
    {
        if ( ! class_exists('finfo')) {
            throw new BadPhpExtensionCallException('E_HEADER_BADPHPEXTENSIONCALLEXCEPTION', 1);
        }

        $this->name = $uploadedFile[ 'name' ];
        $this->type = $uploadedFile[ 'type' ];
        $this->tmpName = $uploadedFile[ 'tmp_name' ];
        $this->size = $uploadedFile[ 'size' ];
        $this->error = $uploadedFile[ 'error' ];
    }

    // ------------------------------------------------------------------------

    /**
     * UploadedFileInterface::getStream
     *
     * Retrieve a stream representing the uploaded file.
     *
     * This method MUST return a StreamInterface instance, representing the
     * uploaded file. The purpose of this method is to allow utilizing native PHP
     * stream functionality to manipulate the file upload, such as
     * stream_copy_to_stream() (though the result will need to be decorated in a
     * native PHP stream wrapper to work with such functions).
     *
     * If the moveTo() method has been called previously, this method MUST raise
     * an exception.
     *
     * @return StreamInterface Stream representation of the uploaded file.
     * @throws \RuntimeException in cases when no stream is available.
     * @throws \RuntimeException in cases when no stream can be created.
     */
    public function getStream()
    {
        if ($this->isMoved) {
            throw new \RuntimeException('File Has Been Already Moved');
        }

        if ($this->stream === null) {
            $context = fopen($this->tmpName, 'r');

            if (is_resource($context)) {
                $this->stream = new Stream();
            } else {
                throw new \RuntimeException('Cannot create stream context');
            }
        }

        return $this->stream;
    }

    // ------------------------------------------------------------------------

    /**
     * UploadedFileInterface::moveTo
     *
     * Move the uploaded file to a new location.
     *
     * Use this method as an alternative to move_uploaded_file(). This method is
     * guaranteed to work in both SAPI and non-SAPI environments.
     * Implementations must determine which environment they are in, and use the
     * appropriate method (move_uploaded_file(), rename(), or a stream
     * operation) to perform the operation.
     *
     * $targetPath may be an absolute path, or a relative path. If it is a
     * relative path, resolution should be the same as used by PHP's rename()
     * function.
     *
     * The original file or stream MUST be removed on completion.
     *
     * If this method is called more than once, any subsequent calls MUST raise
     * an exception.
     *
     * When used in an SAPI environment where $_FILES is populated, when writing
     * files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be
     * used to ensure permissions and upload status are verified correctly.
     *
     * If you wish to move to a stream, use getStream(), as SAPI operations
     * cannot guarantee writing to stream destinations.
     *
     * @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.
     *
     * @throws \InvalidArgumentException if the $targetPath specified is invalid.
     * @throws \RuntimeException on any errors during the move operation.
     * @throws \RuntimeException on the second or subsequent call to the method.
     */
    public function moveTo($targetPath)
    {
        if ($this->isMoved) {
            throw new \RuntimeException('Uploaded File Has Been Moved');
        }

        if ( ! is_writable(dirname($targetPath))) {
            @mkdir(dirname($targetPath), 0777, true);
            /** @scrutinizer ignore-unhandled */ @mkdir(dirname($targetPath), 0777, true);
        }

        if (strpos($targetPath, '://') !== false) {
            if ( ! copy($this->tmpName, $targetPath)) {
                throw new \RuntimeException(sprintf('Cant Move Uploaded File %1 to %2', $this->tmpName, $targetPath));
            }

            if ( ! unlink($this->tmpName)) {
                throw new \RuntimeException('Failed To Remove Uploaded Temp File');
            }
        } else {
            if ( ! is_uploaded_file($this->tmpName)) {
                throw new \RuntimeException('File Is Not Valid Uploaded File');
            }

            if ( ! move_uploaded_file($this->tmpName, $targetPath)) {
                throw new \RuntimeException(sprintf('Cant Move Uploaded File %1 to %2', $this->tmpName, $targetPath));
            }
        }

        $this->isMoved = true;
    }

    // ------------------------------------------------------------------------

    /**
     * UploadedFileInterface::getSize
     *
     * Retrieve the file size.
     *
     * Implementations SHOULD return the value stored in the "size" key of
     * the file in the $_FILES array if available, as PHP calculates this based
     * on the actual size transmitted.
     *
     * @return int|null The file size in bytes or null if unknown.
     */
    public function getSize()
    {
        return $this->size;
    }

    // ------------------------------------------------------------------------

    /**
     * UploadedFileInterface::getError
     *
     * Retrieve the error associated with the uploaded file.
     *
     * The return value MUST be one of PHP's UPLOAD_ERR_XXX constants.
     *
     * If the file was uploaded successfully, this method MUST return
     * UPLOAD_ERR_OK.
     *
     * 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.error.php
     * @return int One of PHP's UPLOAD_ERR_XXX constants.
     */
    public function getError()
    {
        return $this->error;
    }

    // ------------------------------------------------------------------------

    /**
     * UploadedFileInterface::getClientFilename
     *
     * Retrieve the filename sent by the client.
     *
     * Do not trust the value returned by this method. A client could send
     * a malicious filename with the intention to corrupt or hack your
     * application.
     *
     * Implementations SHOULD return the value stored in the "name" key of
     * the file in the $_FILES array.
     *
     * @return string|null The filename sent by the client or null if none
     *     was provided.
     */
    public function getClientFilename()
    {
        return $this->name;
    }

    // ------------------------------------------------------------------------

    /**
     * UploadedFileInterface::getClientMediaType
     *
     * Retrieve the media type sent by the client.
     *
     * Do not trust the value returned by this method. A client could send
     * a malicious media type with the intention to corrupt or hack your
     * application.
     *
     * Implementations SHOULD return the value stored in the "type" key of
     * the file in the $_FILES array.
     *
     * @return string|null The media type sent by the client or null if none
     *     was provided.
     */
    public function getClientMediaType()
    {
        return $this->type;
    }

    // --------------------------------------------------------------------------------------

    /**
     * UploadFile::getFileMime
     *
     * Get file mime type
     *
     * @return string
     */
    public function getFileMime()
    {
        $mime = finfo_file(finfo_open(FILEINFO_MIME_TYPE), $this->tmpName);

        return $mime;
    }

    // --------------------------------------------------------------------------------------

    /**
     * UploadFile::getExtension
     *
     * Get uploaded file extension
     *
     * @return string
     */
    public function getExtension()
    {
        return pathinfo($this->name, PATHINFO_EXTENSION);
    }

    // ------------------------------------------------------------------------

    /**
     * UploadFile::getFileTemp
     *
     * @return mixed|string
     */
    public function getFileTemp()
    {
        return $this->tmpName;
    }

}
o2system / kernel

GitHub Access Token became invalid

UploadFile::getStream() A last analyzed 2019-10-02 16:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

UploadFile::getStream() A
last analyzed 2019-10-02 16:44 UTC
