123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211 |
- <?php
- declare(strict_types=1);
- namespace GuzzleHttp\Psr7;
- use InvalidArgumentException;
- use Psr\Http\Message\StreamInterface;
- use Psr\Http\Message\UploadedFileInterface;
- use RuntimeException;
- class UploadedFile implements UploadedFileInterface
- {
- private const ERRORS = [
- UPLOAD_ERR_OK,
- UPLOAD_ERR_INI_SIZE,
- UPLOAD_ERR_FORM_SIZE,
- UPLOAD_ERR_PARTIAL,
- UPLOAD_ERR_NO_FILE,
- UPLOAD_ERR_NO_TMP_DIR,
- UPLOAD_ERR_CANT_WRITE,
- UPLOAD_ERR_EXTENSION,
- ];
- /**
- * @var string|null
- */
- private $clientFilename;
- /**
- * @var string|null
- */
- private $clientMediaType;
- /**
- * @var int
- */
- private $error;
- /**
- * @var string|null
- */
- private $file;
- /**
- * @var bool
- */
- private $moved = false;
- /**
- * @var int|null
- */
- private $size;
- /**
- * @var StreamInterface|null
- */
- private $stream;
- /**
- * @param StreamInterface|string|resource $streamOrFile
- */
- public function __construct(
- $streamOrFile,
- ?int $size,
- int $errorStatus,
- string $clientFilename = null,
- string $clientMediaType = null
- ) {
- $this->setError($errorStatus);
- $this->size = $size;
- $this->clientFilename = $clientFilename;
- $this->clientMediaType = $clientMediaType;
- if ($this->isOk()) {
- $this->setStreamOrFile($streamOrFile);
- }
- }
- /**
- * Depending on the value set file or stream variable
- *
- * @param StreamInterface|string|resource $streamOrFile
- *
- * @throws InvalidArgumentException
- */
- private function setStreamOrFile($streamOrFile): void
- {
- if (is_string($streamOrFile)) {
- $this->file = $streamOrFile;
- } elseif (is_resource($streamOrFile)) {
- $this->stream = new Stream($streamOrFile);
- } elseif ($streamOrFile instanceof StreamInterface) {
- $this->stream = $streamOrFile;
- } else {
- throw new InvalidArgumentException(
- 'Invalid stream or file provided for UploadedFile'
- );
- }
- }
- /**
- * @throws InvalidArgumentException
- */
- private function setError(int $error): void
- {
- if (false === in_array($error, UploadedFile::ERRORS, true)) {
- throw new InvalidArgumentException(
- 'Invalid error status for UploadedFile'
- );
- }
- $this->error = $error;
- }
- private static function isStringNotEmpty($param): bool
- {
- return is_string($param) && false === empty($param);
- }
- /**
- * Return true if there is no upload error
- */
- private function isOk(): bool
- {
- return $this->error === UPLOAD_ERR_OK;
- }
- public function isMoved(): bool
- {
- return $this->moved;
- }
- /**
- * @throws RuntimeException if is moved or not ok
- */
- private function validateActive(): void
- {
- if (false === $this->isOk()) {
- throw new RuntimeException('Cannot retrieve stream due to upload error');
- }
- if ($this->isMoved()) {
- throw new RuntimeException('Cannot retrieve stream after it has already been moved');
- }
- }
- public function getStream(): StreamInterface
- {
- $this->validateActive();
- if ($this->stream instanceof StreamInterface) {
- return $this->stream;
- }
- /** @var string $file */
- $file = $this->file;
- return new LazyOpenStream($file, 'r+');
- }
- public function moveTo($targetPath): void
- {
- $this->validateActive();
- if (false === self::isStringNotEmpty($targetPath)) {
- throw new InvalidArgumentException(
- 'Invalid path provided for move operation; must be a non-empty string'
- );
- }
- if ($this->file) {
- $this->moved = PHP_SAPI === 'cli'
- ? rename($this->file, $targetPath)
- : move_uploaded_file($this->file, $targetPath);
- } else {
- Utils::copyToStream(
- $this->getStream(),
- new LazyOpenStream($targetPath, 'w')
- );
- $this->moved = true;
- }
- if (false === $this->moved) {
- throw new RuntimeException(
- sprintf('Uploaded file could not be moved to %s', $targetPath)
- );
- }
- }
- public function getSize(): ?int
- {
- return $this->size;
- }
- public function getError(): int
- {
- return $this->error;
- }
- public function getClientFilename(): ?string
- {
- return $this->clientFilename;
- }
- public function getClientMediaType(): ?string
- {
- return $this->clientMediaType;
- }
- }
|