Http: Review message classes

- Move `Stream` methods `copyToString()` and `copyToStream()` to
  `HttpUtil`, renaming them to `getStreamContents()` and `copyStream()`

Author: lkrms

src/Toolkit/Curler/CurlerFile.php

@@ -4,7 +4,6 @@
 
 use Salient\Http\Message\StreamPart;
 use Salient\Utility\File;
-use InvalidArgumentException;
 
 /**
  * A file to upload to an HTTP endpoint
@@ -24,22 +23,15 @@ public function __construct(
         string $filename,
         ?string $uploadFilename = null,
         ?string $mediaType = null,
-        ?string $fallbackFilename = null,
+        ?string $asciiFilename = null,
         ?string $name = null
     ) {
-        if (!is_file($filename)) {
-            throw new InvalidArgumentException(sprintf(
-                'File not found: %s',
-                $filename,
-            ));
-        }
-
         parent::__construct(
             File::open($filename, 'r'),
             $name,
             $uploadFilename ?? basename($filename),
-            self::getFileMediaType($filename, $mediaType),
-            $fallbackFilename,
+            self::filterFileMediaType($mediaType, $filename),
+            $asciiFilename,
         );
     }
 }

src/Toolkit/Http/HttpUtil.php

@@ -3,6 +3,7 @@
 namespace Salient\Http;
 
 use Psr\Http\Message\RequestInterface as PsrRequestInterface;
+use Psr\Http\Message\StreamInterface as PsrStreamInterface;
 use Psr\Http\Message\UriInterface as PsrUriInterface;
 use Salient\Contract\Core\DateFormatterInterface;
 use Salient\Contract\Http\Message\MultipartStreamInterface;
@@ -302,4 +303,39 @@ public static function getNameValueGenerator(iterable $items): Generator
             yield $item['name'] => $item['value'];
         }
     }
+
+    /**
+     * Get the contents of a stream
+     */
+    public static function getStreamContents(PsrStreamInterface $from): string
+    {
+        $buffer = '';
+        while (!$from->eof()) {
+            $data = $from->read(1048576);
+            if ($data === '') {
+                break;
+            }
+            $buffer .= $data;
+        }
+        return $buffer;
+    }
+
+    /**
+     * Copy the contents of one stream to another
+     */
+    public static function copyStream(PsrStreamInterface $from, PsrStreamInterface $to): void
+    {
+        $buffer = '';
+        while (!$from->eof()) {
+            $data = $from->read(8192);
+            if ($data === '') {
+                break;
+            }
+            $buffer .= $data;
+            $buffer = substr($buffer, $to->write($buffer));
+        }
+        while ($buffer !== '') {
+            $buffer = substr($buffer, $to->write($buffer));
+        }
+    }
 }

src/Toolkit/Http/Message/AbstractMessage.php

@@ -10,7 +10,6 @@
 use Salient\Core\Concern\ImmutableTrait;
 use Salient\Http\HasInnerHeadersTrait;
 use Salient\Http\Headers;
-use Salient\Utility\Exception\InvalidArgumentTypeException;
 use Salient\Utility\Arr;
 use Salient\Utility\Regex;
 use InvalidArgumentException;
@@ -24,6 +23,7 @@
  */
 abstract class AbstractMessage implements MessageInterface
 {
+    use HasBody;
     use HasInnerHeadersTrait;
     use ImmutableTrait;
 
@@ -96,31 +96,6 @@ private function filterHeaders($headers): HeadersInterface
             : new Headers($headers ?? []);
     }
 
-    /**
-     * @param PsrStreamInterface|resource|string|null $body
-     */
-    private function filterBody($body): PsrStreamInterface
-    {
-        if ($body instanceof PsrStreamInterface) {
-            return $body;
-        }
-
-        if (is_string($body) || $body === null) {
-            return Stream::fromString((string) $body);
-        }
-
-        try {
-            return new Stream($body);
-        } catch (InvalidArgumentException $ex) {
-            throw new InvalidArgumentTypeException(
-                1,
-                'body',
-                PsrStreamInterface::class . '|resource|string|null',
-                $body,
-            );
-        }
-    }
-
     /**
      * @inheritDoc
      */

src/Toolkit/Http/Message/HasBody.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+namespace Salient\Http\Message;
+
+use Psr\Http\Message\StreamInterface as PsrStreamInterface;
+use Salient\Utility\Exception\InvalidArgumentTypeException;
+use InvalidArgumentException;
+
+/**
+ * @internal
+ */
+trait HasBody
+{
+    /**
+     * @param PsrStreamInterface|resource|string|null $body
+     */
+    private function filterBody($body): PsrStreamInterface
+    {
+        if ($body instanceof PsrStreamInterface) {
+            return $body;
+        }
+
+        if (is_string($body) || $body === null) {
+            return Stream::fromString((string) $body);
+        }
+
+        try {
+            return new Stream($body);
+        } catch (InvalidArgumentException $ex) {
+            throw new InvalidArgumentTypeException(
+                1,
+                'body',
+                PsrStreamInterface::class . '|resource|string|null',
+                $body,
+            );
+        }
+    }
+}

src/Toolkit/Http/Message/MessageFactory.php

@@ -18,7 +18,7 @@
 use Salient\Utility\File;
 
 /**
- * A PSR-17 HTTP message factory
+ * @api
  */
 class MessageFactory implements
     PsrRequestFactoryInterface,
@@ -47,6 +47,8 @@ public function createResponse(
     }
 
     /**
+     * @inheritDoc
+     *
      * @param mixed[] $serverParams
      */
     public function createServerRequest(
@@ -98,7 +100,7 @@ public function createUploadedFile(
             $size,
             $error,
             $clientFilename,
-            $clientMediaType
+            $clientMediaType,
         );
     }
 

src/Toolkit/Http/Message/MultipartStream.php

@@ -190,7 +190,7 @@ public function getContents(): string
     {
         $this->assertIsOpen();
 
-        return Stream::copyToString($this);
+        return HttpUtil::getStreamContents($this);
     }
 
     /**

src/Toolkit/Http/Message/Request.php

@@ -4,17 +4,17 @@
 
 use Psr\Http\Message\MessageInterface as PsrMessageInterface;
 use Psr\Http\Message\RequestInterface as PsrRequestInterface;
-use Salient\Core\Concern\ImmutableTrait;
 
 /**
- * A PSR-7 request (outgoing, client-side)
+ * @api
  *
  * @extends AbstractRequest<PsrRequestInterface>
  */
 class Request extends AbstractRequest
 {
-    use ImmutableTrait;
-
+    /**
+     * @api
+     */
     final public function __construct(
         string $method,
         $uri,

src/Toolkit/Http/Message/Response.php

@@ -11,14 +11,17 @@
 use InvalidArgumentException;
 
 /**
- * A PSR-7 response
+ * @api
  *
  * @extends AbstractMessage<PsrResponseInterface>
  */
 class Response extends AbstractMessage implements ResponseInterface
 {
     use ImmutableTrait;
 
+    /**
+     * @var array<int,string>
+     */
     protected const STATUS_CODE = [
         100 => 'Continue',
         101 => 'Switching Protocols',
@@ -86,6 +89,9 @@ class Response extends AbstractMessage implements ResponseInterface
     protected int $StatusCode;
     protected ?string $ReasonPhrase;
 
+    /**
+     * @api
+     */
     final public function __construct(
         int $code = 200,
         $body = null,
@@ -141,6 +147,34 @@ public function withStatus(int $code, string $reasonPhrase = ''): PsrResponseInt
             ->with('ReasonPhrase', $this->filterReasonPhrase($code, $reasonPhrase));
     }
 
+    private function filterStatusCode(int $code): int
+    {
+        if ($code < 100 || $code > 599) {
+            throw new InvalidArgumentException(
+                sprintf('Invalid HTTP status code: %d', $code),
+            );
+        }
+        return $code;
+    }
+
+    private function filterReasonPhrase(int $code, ?string $reasonPhrase): ?string
+    {
+        return Str::coalesce($reasonPhrase, null)
+            ?? static::STATUS_CODE[$code]
+            ?? null;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getStartLine(): string
+    {
+        return Arr::implode(' ', [
+            sprintf('HTTP/%s %d', $this->ProtocolVersion, $this->StatusCode),
+            $this->ReasonPhrase,
+        ]);
+    }
+
     /**
      * @return array{status:int,statusText:string,httpVersion:string,cookies:array<array{name:string,value:string,path?:string,domain?:string,expires?:string,httpOnly?:bool,secure?:bool}>,headers:array<array{name:string,value:string}>,content:array{size:int,mimeType:string,text:string},redirectURL:string,headersSize:int,bodySize:int}
      */
@@ -165,32 +199,4 @@ public function jsonSerialize(): array
             'redirectURL' => count($location) === 1 ? $location[0] : '',
         ] + $response;
     }
-
-    /**
-     * @inheritDoc
-     */
-    protected function getStartLine(): string
-    {
-        return Arr::implode(' ', [
-            sprintf('HTTP/%s %d', $this->ProtocolVersion, $this->StatusCode),
-            $this->ReasonPhrase,
-        ]);
-    }
-
-    private function filterStatusCode(int $code): int
-    {
-        if ($code < 100 || $code > 599) {
-            throw new InvalidArgumentException(
-                sprintf('Invalid HTTP status code: %d', $code)
-            );
-        }
-        return $code;
-    }
-
-    private function filterReasonPhrase(int $code, ?string $reasonPhrase): ?string
-    {
-        return Str::coalesce($reasonPhrase, null)
-            ?? static::STATUS_CODE[$code]
-            ?? null;
-    }
 }