UploadedFile.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Http;
 
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface;
use ‪TYPO3\CMS\Core\Resource\Exception\UploadSizeException;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪UploadedFile implements UploadedFileInterface
{
    protected ?string ‪$file = null;
    protected ?StreamInterface ‪$stream = null;
    protected ?string ‪$clientFilename;
    protected ?string ‪$clientMediaType;
    protected int ‪$error;
    protected bool ‪$moved = false;
    protected int ‪$size;
 
    public function ‪__construct($input, int ‪$size, int $errorStatus, ?string ‪$clientFilename = null, ?string ‪$clientMediaType = null)
    {
        if (is_string($input)) {
            $this->file = $input;
        }
 
        if (is_resource($input)) {
            $this->stream = new ‪Stream($input);
        } elseif ($input instanceof StreamInterface) {
            $this->stream = $input;
        }
 
        if (!$this->file && !$this->stream) {
            throw new \InvalidArgumentException('The input given was not a valid stream or file.', 1436717301);
        }
 
        $this->size = ‪$size;
 
        if ($errorStatus < 0 || $errorStatus > 8) {
            throw new \InvalidArgumentException('Invalid error status for an uploaded file. See UPLOAD_ERR_* constant in PHP.', 1436717303);
        }
        $this->error = $errorStatus;
 
        if (‪$clientFilename !== null) {
            ‪$clientFilename = \Normalizer::normalize(‪$clientFilename);
        }
        $this->clientFilename = is_string(‪$clientFilename) ? ‪$clientFilename : null;
        $this->clientMediaType = ‪$clientMediaType;
    }
 
    public function ‪getStream(): StreamInterface
    {
        if ($this->moved) {
            throw new \RuntimeException('Cannot retrieve stream as it was moved.', 1436717306);
        }
 
        if ($this->stream instanceof StreamInterface) {
            return ‪$this->stream;
        }
 
        $this->stream = new ‪Stream((string)$this->file);
        return ‪$this->stream;
    }
 
    public function ‪moveTo(string $targetPath): void
    {
        if (empty($targetPath)) {
            throw new \InvalidArgumentException('Invalid path while moving an uploaded file.', 1436717307);
        }
 
        if ($this->moved) {
            throw new \RuntimeException('Cannot move uploaded file, as it was already moved.', 1436717308);
        }
 
        // Check if the target path is inside the allowed paths of TYPO3, and make it absolute.
        $targetPath = GeneralUtility::getFileAbsFileName($targetPath);
        if (empty($targetPath)) {
            throw new \RuntimeException('Cannot move uploaded file, as the target path is empty or invalid.', 1436717309);
        }
 
        // Max upload size (kb) for files.
        $maxUploadFileSize = GeneralUtility::getMaxUploadFileSize() * 1024;
        if ($this->size > 0 && $maxUploadFileSize > 0 && $this->size >= $maxUploadFileSize) {
            unlink($this->file);
            throw new ‪UploadSizeException('The uploaded file exceeds the size-limit of ' . $maxUploadFileSize . ' bytes', 1647338094);
        }
 
        if (!empty($this->file) && is_uploaded_file($this->file)) {
            if (GeneralUtility::upload_copy_move($this->file, $targetPath) === false) {
                throw new \RuntimeException('An error occurred while moving uploaded file', 1436717310);
            }
        } elseif ($this->stream) {
            $handle = fopen($targetPath, 'wb+');
            if ($handle === false) {
                throw new \RuntimeException('Unable to write to target path.', 1436717311);
            }
 
            $this->stream->rewind();
            while (!$this->stream->eof()) {
                fwrite($handle, $this->stream->read(4096));
            }
 
            fclose($handle);
        }
 
        $this->moved = true;
    }
 
    public function ‪getSize(): ?int
    {
        return ‪$this->size;
    }
 
    public function ‪getError(): int
    {
        return ‪$this->error;
    }
 
    public function ‪getClientFilename(): ?string
    {
        return ‪$this->clientFilename;
    }
 
    public function ‪getTemporaryFileName(): ?string
    {
        if ($this->moved) {
            throw new \RuntimeException('Cannot return temporary file name, as it was already moved.', 1436717337);
        }
        return ‪$this->file;
    }
 
    public function ‪getClientMediaType(): ?string
    {
        return ‪$this->clientMediaType;
    }
}