allow UploadedFiles to use streams that are not based on files

Author: KurtThiemann

src/Psr7/Message/UploadedFile.php

@@ -6,11 +6,11 @@
 use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UploadedFileInterface;
 use RuntimeException;
+use Throwable;
 
 class UploadedFile implements UploadedFileInterface
 {
     protected bool $moved = false;
-    protected string $filePath;
 
     /**
      * @param StreamInterface $stream
@@ -27,11 +27,6 @@ public function __construct(
         protected ?string         $clientMediaType = null
     )
     {
-        $file = $this->stream->getMetadata('uri');
-        if ($file === null) {
-            throw new InvalidArgumentException('Stream uri not available');
-        }
-        $this->filePath = $file;
     }
 
     /**
@@ -50,9 +45,36 @@ public function moveTo(string $targetPath): void
         if ($this->moved) {
             throw new RuntimeException('Uploaded file already moved');
         }
-        if (!@rename($this->filePath, $targetPath)) {
-            throw new RuntimeException('Uploaded file could not be moved');
+
+        $filePath = $this->stream->getMetadata('uri');
+        if ($filePath !== null) {
+            if (!@rename($filePath, $targetPath)) {
+                throw new RuntimeException('Uploaded file could not be moved');
+            }
+            $this->moved = true;
+            return;
         }
+
+        if ($this->stream->tell() !== 0) {
+            if (!$this->stream->isSeekable()) {
+                throw new RuntimeException('Stream needs to be rewound, but is not seekable');
+            }
+            $this->stream->rewind();
+        }
+
+        $target = fopen($targetPath, 'wb');
+        if ($target === false) {
+            throw new RuntimeException('Target path could not be opened');
+        }
+
+        try {
+            while (!$this->stream->eof()) {
+                fwrite($target, $this->stream->read(4096));
+            }
+        } finally {
+            fclose($target);
+        }
+
         $this->moved = true;
     }
 

tests/UploadedFileTest.php

@@ -3,6 +3,7 @@
 namespace Tests;
 
 use Aternos\CurlPsr\Psr17\Psr17Factory;
+use Aternos\CurlPsr\Psr7\Stream\StringStream;
 use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\StreamInterface;
@@ -66,11 +67,50 @@ public function testThrowWhenMovedToInvalidTarget(): void
         $uploadedFile->moveTo($target);
     }
 
-    public function testThrowIfStreamIsNotAFile(): void
+    public function testWriteStreamContentIfStreamIsNotAFile(): void
     {
         $stream = $this->factory->createStream('test');
-        $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Stream uri not available');
-        $this->factory->createUploadedFile($stream, $stream->getSize(), UPLOAD_ERR_OK, "file.txt", "text/plain");
+        $upload = $this->factory->createUploadedFile($stream, $stream->getSize(), UPLOAD_ERR_OK, "file.txt", "text/plain");
+
+        $this->target = tempnam(sys_get_temp_dir(), 'test');
+        $upload->moveTo($this->target);
+
+        $this->assertFileExists($this->target);
+        $this->assertEquals('test', file_get_contents($this->target));
+    }
+
+    public function testThrowIfWriteTargetCannotBeOpened(): void
+    {
+        $stream = $this->factory->createStream('test');
+        $upload = $this->factory->createUploadedFile($stream, $stream->getSize(), UPLOAD_ERR_OK, "file.txt", "text/plain");
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Target path could not be opened');
+        $upload->moveTo(sys_get_temp_dir() . "/non-existing-dir/file.txt");
+    }
+
+    public function testRewindStreamIfNecessary(): void
+    {
+        $stream = $this->factory->createStream('test');
+        $stream->read(1);
+        $upload = $this->factory->createUploadedFile($stream, $stream->getSize(), UPLOAD_ERR_OK, "file.txt", "text/plain");
+
+        $this->target = tempnam(sys_get_temp_dir(), 'test');
+        $upload->moveTo($this->target);
+
+        $this->assertFileExists($this->target);
+        $this->assertEquals('test', file_get_contents($this->target));
+    }
+
+    public function testThrowIfStreamNeedsRewindButIsNotSeekable(): void
+    {
+        $stream = new StringStream('test', false);
+        $stream->read(1);
+        $upload = $this->factory->createUploadedFile($stream, $stream->getSize(), UPLOAD_ERR_OK, "file.txt", "text/plain");
+        $this->target = tempnam(sys_get_temp_dir(), 'test');
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Stream needs to be rewound, but is not seekable');
+        $upload->moveTo($this->target);
     }
 }