392 lines
11 KiB
PHP
392 lines
11 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
declare(strict_types=1);
|
||
|
|
|
||
|
|
namespace Nyholm\Psr7;
|
||
|
|
|
||
|
|
use Psr\Http\Message\StreamInterface;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @author Michael Dowling and contributors to guzzlehttp/psr7
|
||
|
|
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
|
||
|
|
* @author Martijn van der Ven <martijn@vanderven.se>
|
||
|
|
*
|
||
|
|
* @final This class should never be extended. See https://github.com/Nyholm/psr7/blob/master/doc/final.md
|
||
|
|
*/
|
||
|
|
class Stream implements StreamInterface
|
||
|
|
{
|
||
|
|
use StreamTrait;
|
||
|
|
|
||
|
|
/** @var resource|null A resource reference */
|
||
|
|
private $stream;
|
||
|
|
|
||
|
|
/** @var bool */
|
||
|
|
private $seekable;
|
||
|
|
|
||
|
|
/** @var bool */
|
||
|
|
private $readable;
|
||
|
|
|
||
|
|
/** @var bool */
|
||
|
|
private $writable;
|
||
|
|
|
||
|
|
/** @var array|mixed|void|bool|null */
|
||
|
|
private $uri;
|
||
|
|
|
||
|
|
/** @var int|null */
|
||
|
|
private $size;
|
||
|
|
|
||
|
|
/** @var array Hash of readable and writable stream types */
|
||
|
|
private const READ_WRITE_HASH = [
|
||
|
|
'read' => [
|
||
|
|
'r' => true, 'w+' => true, 'r+' => true, 'x+' => true, 'c+' => true,
|
||
|
|
'rb' => true, 'w+b' => true, 'r+b' => true, 'x+b' => true,
|
||
|
|
'c+b' => true, 'rt' => true, 'w+t' => true, 'r+t' => true,
|
||
|
|
'x+t' => true, 'c+t' => true, 'a+' => true,
|
||
|
|
],
|
||
|
|
'write' => [
|
||
|
|
'w' => true, 'w+' => true, 'rw' => true, 'r+' => true, 'x+' => true,
|
||
|
|
'c+' => true, 'wb' => true, 'w+b' => true, 'r+b' => true,
|
||
|
|
'x+b' => true, 'c+b' => true, 'w+t' => true, 'r+t' => true,
|
||
|
|
'x+t' => true, 'c+t' => true, 'a' => true, 'a+' => true,
|
||
|
|
],
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param resource $body
|
||
|
|
*/
|
||
|
|
public function __construct($body)
|
||
|
|
{
|
||
|
|
if (!\is_resource($body)) {
|
||
|
|
throw new \InvalidArgumentException('First argument to Stream::__construct() must be resource');
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->stream = $body;
|
||
|
|
$meta = \stream_get_meta_data($this->stream);
|
||
|
|
$this->seekable = $meta['seekable'] && 0 === \fseek($this->stream, 0, \SEEK_CUR);
|
||
|
|
$this->readable = isset(self::READ_WRITE_HASH['read'][$meta['mode']]);
|
||
|
|
$this->writable = isset(self::READ_WRITE_HASH['write'][$meta['mode']]);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a new PSR-7 stream.
|
||
|
|
*
|
||
|
|
* @param string|resource|StreamInterface $body
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
*/
|
||
|
|
public static function create($body = ''): StreamInterface
|
||
|
|
{
|
||
|
|
if ($body instanceof StreamInterface) {
|
||
|
|
return $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (\is_string($body)) {
|
||
|
|
if (200000 <= \strlen($body)) {
|
||
|
|
$body = self::openZvalStream($body);
|
||
|
|
} else {
|
||
|
|
$resource = \fopen('php://memory', 'r+');
|
||
|
|
\fwrite($resource, $body);
|
||
|
|
\fseek($resource, 0);
|
||
|
|
$body = $resource;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!\is_resource($body)) {
|
||
|
|
throw new \InvalidArgumentException('First argument to Stream::create() must be a string, resource or StreamInterface');
|
||
|
|
}
|
||
|
|
|
||
|
|
return new self($body);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Closes the stream when the destructed.
|
||
|
|
*/
|
||
|
|
public function __destruct()
|
||
|
|
{
|
||
|
|
$this->close();
|
||
|
|
}
|
||
|
|
|
||
|
|
public function close(): void
|
||
|
|
{
|
||
|
|
if (isset($this->stream)) {
|
||
|
|
if (\is_resource($this->stream)) {
|
||
|
|
\fclose($this->stream);
|
||
|
|
}
|
||
|
|
$this->detach();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public function detach()
|
||
|
|
{
|
||
|
|
if (!isset($this->stream)) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
$result = $this->stream;
|
||
|
|
unset($this->stream);
|
||
|
|
$this->size = $this->uri = null;
|
||
|
|
$this->readable = $this->writable = $this->seekable = false;
|
||
|
|
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
private function getUri()
|
||
|
|
{
|
||
|
|
if (false !== $this->uri) {
|
||
|
|
$this->uri = $this->getMetadata('uri') ?? false;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->uri;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getSize(): ?int
|
||
|
|
{
|
||
|
|
if (null !== $this->size) {
|
||
|
|
return $this->size;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!isset($this->stream)) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Clear the stat cache if the stream has a URI
|
||
|
|
if ($uri = $this->getUri()) {
|
||
|
|
\clearstatcache(true, $uri);
|
||
|
|
}
|
||
|
|
|
||
|
|
$stats = \fstat($this->stream);
|
||
|
|
if (isset($stats['size'])) {
|
||
|
|
$this->size = $stats['size'];
|
||
|
|
|
||
|
|
return $this->size;
|
||
|
|
}
|
||
|
|
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function tell(): int
|
||
|
|
{
|
||
|
|
if (!isset($this->stream)) {
|
||
|
|
throw new \RuntimeException('Stream is detached');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (false === $result = @\ftell($this->stream)) {
|
||
|
|
throw new \RuntimeException('Unable to determine stream position: ' . (\error_get_last()['message'] ?? ''));
|
||
|
|
}
|
||
|
|
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function eof(): bool
|
||
|
|
{
|
||
|
|
return !isset($this->stream) || \feof($this->stream);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function isSeekable(): bool
|
||
|
|
{
|
||
|
|
return $this->seekable;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function seek($offset, $whence = \SEEK_SET): void
|
||
|
|
{
|
||
|
|
if (!isset($this->stream)) {
|
||
|
|
throw new \RuntimeException('Stream is detached');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$this->seekable) {
|
||
|
|
throw new \RuntimeException('Stream is not seekable');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (-1 === \fseek($this->stream, $offset, $whence)) {
|
||
|
|
throw new \RuntimeException('Unable to seek to stream position "' . $offset . '" with whence ' . \var_export($whence, true));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public function rewind(): void
|
||
|
|
{
|
||
|
|
$this->seek(0);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function isWritable(): bool
|
||
|
|
{
|
||
|
|
return $this->writable;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function write($string): int
|
||
|
|
{
|
||
|
|
if (!isset($this->stream)) {
|
||
|
|
throw new \RuntimeException('Stream is detached');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$this->writable) {
|
||
|
|
throw new \RuntimeException('Cannot write to a non-writable stream');
|
||
|
|
}
|
||
|
|
|
||
|
|
// We can't know the size after writing anything
|
||
|
|
$this->size = null;
|
||
|
|
|
||
|
|
if (false === $result = @\fwrite($this->stream, $string)) {
|
||
|
|
throw new \RuntimeException('Unable to write to stream: ' . (\error_get_last()['message'] ?? ''));
|
||
|
|
}
|
||
|
|
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function isReadable(): bool
|
||
|
|
{
|
||
|
|
return $this->readable;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function read($length): string
|
||
|
|
{
|
||
|
|
if (!isset($this->stream)) {
|
||
|
|
throw new \RuntimeException('Stream is detached');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$this->readable) {
|
||
|
|
throw new \RuntimeException('Cannot read from non-readable stream');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (false === $result = @\fread($this->stream, $length)) {
|
||
|
|
throw new \RuntimeException('Unable to read from stream: ' . (\error_get_last()['message'] ?? ''));
|
||
|
|
}
|
||
|
|
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getContents(): string
|
||
|
|
{
|
||
|
|
if (!isset($this->stream)) {
|
||
|
|
throw new \RuntimeException('Stream is detached');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (false === $contents = @\stream_get_contents($this->stream)) {
|
||
|
|
throw new \RuntimeException('Unable to read stream contents: ' . (\error_get_last()['message'] ?? ''));
|
||
|
|
}
|
||
|
|
|
||
|
|
return $contents;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function getMetadata($key = null)
|
||
|
|
{
|
||
|
|
if (null !== $key && !\is_string($key)) {
|
||
|
|
throw new \InvalidArgumentException('Metadata key must be a string');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!isset($this->stream)) {
|
||
|
|
return $key ? null : [];
|
||
|
|
}
|
||
|
|
|
||
|
|
$meta = \stream_get_meta_data($this->stream);
|
||
|
|
|
||
|
|
if (null === $key) {
|
||
|
|
return $meta;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $meta[$key] ?? null;
|
||
|
|
}
|
||
|
|
|
||
|
|
private static function openZvalStream(string $body)
|
||
|
|
{
|
||
|
|
static $wrapper;
|
||
|
|
|
||
|
|
$wrapper ?? \stream_wrapper_register('Nyholm-Psr7-Zval', $wrapper = \get_class(new class() {
|
||
|
|
public $context;
|
||
|
|
|
||
|
|
private $data;
|
||
|
|
private $position = 0;
|
||
|
|
|
||
|
|
public function stream_open(): bool
|
||
|
|
{
|
||
|
|
$this->data = \stream_context_get_options($this->context)['Nyholm-Psr7-Zval']['data'];
|
||
|
|
\stream_context_set_option($this->context, 'Nyholm-Psr7-Zval', 'data', null);
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function stream_read(int $count): string
|
||
|
|
{
|
||
|
|
$result = \substr($this->data, $this->position, $count);
|
||
|
|
$this->position += \strlen($result);
|
||
|
|
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function stream_write(string $data): int
|
||
|
|
{
|
||
|
|
$this->data = \substr_replace($this->data, $data, $this->position, \strlen($data));
|
||
|
|
$this->position += \strlen($data);
|
||
|
|
|
||
|
|
return \strlen($data);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function stream_tell(): int
|
||
|
|
{
|
||
|
|
return $this->position;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function stream_eof(): bool
|
||
|
|
{
|
||
|
|
return \strlen($this->data) <= $this->position;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function stream_stat(): array
|
||
|
|
{
|
||
|
|
return [
|
||
|
|
'mode' => 33206, // POSIX_S_IFREG | 0666
|
||
|
|
'nlink' => 1,
|
||
|
|
'rdev' => -1,
|
||
|
|
'size' => \strlen($this->data),
|
||
|
|
'blksize' => -1,
|
||
|
|
'blocks' => -1,
|
||
|
|
];
|
||
|
|
}
|
||
|
|
|
||
|
|
public function stream_seek(int $offset, int $whence): bool
|
||
|
|
{
|
||
|
|
if (\SEEK_SET === $whence && (0 <= $offset && \strlen($this->data) >= $offset)) {
|
||
|
|
$this->position = $offset;
|
||
|
|
} elseif (\SEEK_CUR === $whence && 0 <= $offset) {
|
||
|
|
$this->position += $offset;
|
||
|
|
} elseif (\SEEK_END === $whence && (0 > $offset && 0 <= $offset = \strlen($this->data) + $offset)) {
|
||
|
|
$this->position = $offset;
|
||
|
|
} else {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function stream_set_option(): bool
|
||
|
|
{
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function stream_truncate(int $new_size): bool
|
||
|
|
{
|
||
|
|
if ($new_size) {
|
||
|
|
$this->data = \substr($this->data, 0, $new_size);
|
||
|
|
$this->position = \min($this->position, $new_size);
|
||
|
|
} else {
|
||
|
|
$this->data = '';
|
||
|
|
$this->position = 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}));
|
||
|
|
|
||
|
|
$context = \stream_context_create(['Nyholm-Psr7-Zval' => ['data' => $body]]);
|
||
|
|
|
||
|
|
if (!$stream = @\fopen('Nyholm-Psr7-Zval://', 'r+', false, $context)) {
|
||
|
|
\stream_wrapper_register('Nyholm-Psr7-Zval', $wrapper);
|
||
|
|
$stream = \fopen('Nyholm-Psr7-Zval://', 'r+', false, $context);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $stream;
|
||
|
|
}
|
||
|
|
}
|