httpsoft / http-message

src/UploadedFile.php

<?php

declare(strict_types=1);

namespace HttpSoft\Message;

use InvalidArgumentException;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface;
use RuntimeException;

use function array_key_exists;
use function array_keys;
use function dirname;
use function fclose;
use function fopen;
use function fwrite;
use function gettype;
use function get_class;
use function implode;
use function is_dir;
use function is_object;
use function is_resource;
use function is_string;
use function is_writable;
use function move_uploaded_file;
use function rename;
use function sprintf;
use function strpos;

use const PHP_SAPI;
use const UPLOAD_ERR_OK;
use const UPLOAD_ERR_INI_SIZE;
use const UPLOAD_ERR_FORM_SIZE;
use const UPLOAD_ERR_PARTIAL;
use const UPLOAD_ERR_NO_FILE;
use const UPLOAD_ERR_NO_TMP_DIR;
use const UPLOAD_ERR_CANT_WRITE;
use const UPLOAD_ERR_EXTENSION;

final class UploadedFile implements UploadedFileInterface
{
    /**
     * @const array
     * @link https://www.php.net/manual/en/features.file-upload.errors.php
     */
    private const ERRORS = [
        UPLOAD_ERR_OK => 'There is no error, the file uploaded with success.',
        UPLOAD_ERR_INI_SIZE => 'The uploaded file exceeds the upload_max_filesize directive in php.ini.',
        UPLOAD_ERR_FORM_SIZE => 'The uploaded file exceeds the MAX_FILE_SIZE directive'
            . ' that was specified in the HTML form.',
        UPLOAD_ERR_PARTIAL => 'The uploaded file was only partially uploaded.',
        UPLOAD_ERR_NO_FILE => 'No file was uploaded.',
        UPLOAD_ERR_NO_TMP_DIR => 'Missing a temporary folder.',
        UPLOAD_ERR_CANT_WRITE => 'Failed to write file to disk.',
        UPLOAD_ERR_EXTENSION => 'A PHP extension stopped the file upload.',
    ];

    /**
     * @var StreamInterface|null
     */
    private ?StreamInterface $stream = null;

    /**
     * @var string|null
     */
    private ?string $file = null;

    /**
     * @var int
     */
    private int $size;

    /**
     * @var int
     */
    private int $error;

    /**
     * @var string|null
     */
    private ?string $clientFilename;

    /**
     * @var string|null
     */
    private ?string $clientMediaType;

    /**
     * @var bool
     */
    private bool $isMoved = false;

    /**
     * @param StreamInterface|string|resource $streamOrFile The file to upload. Must be one of the following:
     * - an instance of `StreamInterface`;
     * - a string stream identifier (e.g., 'php://temp') or a file path;
     * - a valid stream resource.
     * @param int $size The size of the uploaded file.
     * @param int $error The error code.
     * @param string|null $clientFilename Client filename.
     * @param string|null $clientMediaType Client media type.
     * @psalm-suppress DocblockTypeContradiction
     * @psalm-suppress RedundantConditionGivenDocblockType
     */
    public function __construct(
        $streamOrFile,
        int $size,
        int $error,
        ?string $clientFilename = null,
        ?string $clientMediaType = null
    ) {
        if (!array_key_exists($error, self::ERRORS)) {
            throw new InvalidArgumentException(sprintf(
                '"%s" is not valid error status for "UploadedFile". It must be one of "UPLOAD_ERR_*" constants:  "%s".',
                $error,
                implode('", "', array_keys(self::ERRORS))
            ));
        }

        $this->size = $size;
        $this->error = $error;
        $this->clientFilename = $clientFilename;
        $this->clientMediaType = $clientMediaType;

        if ($error !== UPLOAD_ERR_OK) {
            return;
        }

        if (is_string($streamOrFile)) {
            $this->file = $streamOrFile;
            return;
        }

        if (is_resource($streamOrFile)) {
            $this->stream = new Stream($streamOrFile);
            return;
        }

        if ($streamOrFile instanceof StreamInterface) {

$streamOrFile is always a sub-type of Psr\Http\Message\StreamInterface.

            $this->stream = $streamOrFile;
            return;
        }

        throw new InvalidArgumentException(sprintf(
            '"%s" is not valid stream or file provided for "UploadedFile".',
            (is_object($streamOrFile) ? get_class($streamOrFile) : gettype($streamOrFile))
        ));
    }

    /**
     * {@inheritdoc}
     *
     * @psalm-suppress PossiblyNullArgument
     */
    public function getStream(): StreamInterface
    {
        if ($this->error !== UPLOAD_ERR_OK) {
            throw new RuntimeException(self::ERRORS[$this->error]);
        }

        if ($this->isMoved) {
            throw new RuntimeException('The stream is not available because it has been moved.');
        }

        if ($this->stream === null) {
            $this->stream = new Stream($this->file, 'r+');
        }

        return $this->stream;

The expression return $this->stream could return the type null which is incompatible with the type-hinted return Psr\Http\Message\StreamInterface. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     *
     * @psalm-suppress NoValue, RedundantCondition, TypeDoesNotContainType
     */
    public function moveTo($targetPath): void
    {
        if ($this->error !== UPLOAD_ERR_OK) {
            throw new RuntimeException(self::ERRORS[$this->error]);
        }

        if ($this->isMoved) {
            throw new RuntimeException('The file cannot be moved because it has already been moved.');
        }

        if (!is_string($targetPath)) {
            throw new InvalidArgumentException(sprintf(
                '"%s" is not valid target path for move. It must be a string type.',
                (is_object($targetPath) ? get_class($targetPath) : gettype($targetPath))
            ));
        }

        if (empty($targetPath)) {
            throw new InvalidArgumentException('Target path is not valid for move. It must be a non-empty string.');
        }

        $targetDirectory = dirname($targetPath);

        if (!is_dir($targetDirectory) || !is_writable($targetDirectory)) {
            throw new RuntimeException(sprintf(
                'The target directory "%s" does not exist or is not writable.',
                $targetDirectory
            ));
        }

        $this->moveOrWriteFile($targetPath);
        $this->isMoved = true;
    }

    /**
     * {@inheritdoc}
     */
    public function getSize(): ?int
    {
        return $this->size;
    }

    /**
     * {@inheritdoc}
     */
    public function getError(): int
    {
        return $this->error;
    }

    /**
     * {@inheritdoc}
     */
    public function getClientFilename(): ?string
    {
        return $this->clientFilename;
    }

    /**
     * {@inheritdoc}
     */
    public function getClientMediaType(): ?string
    {
        return $this->clientMediaType;
    }

    /**
     * Moves if used in an SAPI environment where $_FILES is populated, when writing
     * files via is_uploaded_file() and move_uploaded_file() or writes If SAPI is not used.
     *
     * @param string $targetPath
     * @psalm-suppress PossiblyNullReference
     */
    private function moveOrWriteFile(string $targetPath): void
    {
        if ($this->file !== null) {
            $isCliEnv = (!PHP_SAPI || strpos(PHP_SAPI, 'cli') === 0 || strpos(PHP_SAPI, 'phpdbg') === 0);

            if (!($isCliEnv ? rename($this->file, $targetPath) : move_uploaded_file($this->file, $targetPath))) {
                throw new RuntimeException(sprintf('Uploaded file could not be moved to "%s".', $targetPath));
            }

            return;
        }

        if (!$file = fopen($targetPath, 'wb+')) {
            throw new RuntimeException(sprintf('Unable to write to "%s".', $targetPath));
        }

        $this->stream->rewind();

The method rewind() does not exist on null.

        while (!$this->stream->eof()) {
            fwrite($file, $this->stream->read(512000));
        }

        fclose($file);
    }
}