Stream.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;
 
class ‪Stream implements StreamInterface
{
    protected ‪$resource;
 
    protected ‪$stream;
 
    public function ‪__construct(‪$stream, string $mode = 'r')
    {
        $this->stream = ‪$stream;
        if (is_resource(‪$stream)) {
            $this->resource = ‪$stream;
        } elseif (is_string(‪$stream)) {
            $this->resource = fopen(‪$stream, $mode) ?: null;
        } else {
            throw new \InvalidArgumentException('Invalid stream provided; must be a string stream identifier or resource', 1436717284);
        }
    }
 
    public function ‪__toString(): string
    {
        if (!$this->‪isReadable()) {
            return '';
        }
        try {
            $this->‪rewind();
            return $this->‪getContents();
        } catch (\RuntimeException $e) {
            return '';
        }
    }
 
    public function ‪close(): void
    {
        if (!is_resource($this->resource)) {
            return;
        }
        ‪$resource = $this->‪detach();
        if (‪$resource === null) {
            return;
        }
        fclose(‪$resource);
    }
 
    public function ‪detach()
    {
        ‪$resource = ‪$this->resource;
        $this->resource = null;
        return ‪$resource;
    }
 
    public function ‪getSize(): ?int
    {
        if ($this->resource === null) {
            return null;
        }
        $stats = fstat($this->resource);
        return $stats['size'];
    }
 
    public function ‪tell(): int
    {
        if (!is_resource($this->resource)) {
            throw new \RuntimeException('No resource available; cannot tell position', 1436717285);
        }
        $result = ftell($this->resource);
        if (!is_int($result)) {
            throw new \RuntimeException('Error occurred during tell operation', 1436717286);
        }
        return $result;
    }
 
    public function ‪eof(): bool
    {
        if (!is_resource($this->resource)) {
            return true;
        }
        return feof($this->resource);
    }
 
    public function ‪isSeekable(): bool
    {
        if (!is_resource($this->resource)) {
            return false;
        }
        return (bool)$this->‪getMetadata('seekable');
    }
 
    public function ‪seek(int $offset, int $whence = SEEK_SET): void
    {
        if (!is_resource($this->resource)) {
            throw new \RuntimeException('No resource available; cannot seek position', 1436717287);
        }
 
        if (!$this->‪isSeekable()) {
            throw new \RuntimeException('Stream is not seekable', 1436717288);
        }
        $result = fseek($this->resource, $offset, $whence);
        if ($result !== 0) {
            throw new \RuntimeException('Error seeking within stream', 1436717289);
        }
    }
 
    public function ‪rewind(): void
    {
        $this->‪seek(0);
    }
 
    public function ‪isWritable(): bool
    {
        if (!is_resource($this->resource)) {
            return false;
        }
        $uri = $this->‪getMetadata('uri');
        return is_writable($uri);
    }
 
    public function ‪write(string $string): int
    {
        if (!is_resource($this->resource)) {
            throw new \RuntimeException('No resource available; cannot write', 1436717290);
        }
        $result = fwrite($this->resource, $string);
        if ($result === false) {
            throw new \RuntimeException('Error writing to stream', 1436717291);
        }
        return $result;
    }
 
    public function ‪isReadable(): bool
    {
        if (!is_resource($this->resource)) {
            return false;
        }
        $mode = $this->‪getMetadata('mode');
        return str_contains($mode, 'r') || str_contains($mode, '+');
    }
 
    public function ‪read(int $length): string
    {
        if (!is_resource($this->resource)) {
            throw new \RuntimeException('No resource available; cannot read', 1436717292);
        }
        if (!$this->‪isReadable()) {
            throw new \RuntimeException('Stream is not readable', 1436717293);
        }
        $result = fread($this->resource, $length);
        if ($result === false) {
            throw new \RuntimeException('Error reading stream', 1436717294);
        }
        return $result;
    }
 
    public function ‪getContents(): string
    {
        if (!is_resource($this->resource) || !$this->‪isReadable()) {
            return '';
        }
        $result = stream_get_contents($this->resource);
        if ($result === false) {
            throw new \RuntimeException('Error reading from stream', 1436717295);
        }
        return $result;
    }
 
    public function ‪getMetadata(?string $key = null)
    {
        if (!is_resource($this->resource)) {
            return null;
        }
        $metadata = stream_get_meta_data($this->resource);
        if ($key === null) {
            return $metadata;
        }
        if (!isset($metadata[$key])) {
            return null;
        }
        return $metadata[$key];
    }
 
    public function ‪attach(‪$resource, string $mode = 'r')
    {
        $error = null;
        if (!is_resource(‪$resource) && is_string(‪$resource)) {
            set_error_handler(static function ($e) use (&$error): bool {
                $error = $e;
                return true;
            }, E_WARNING);
            ‪$resource = fopen(‪$resource, $mode);
            restore_error_handler();
        }
        if ($error) {
            throw new \InvalidArgumentException('Invalid stream reference provided', 1436717296);
        }
        if (!is_resource(‪$resource)) {
            throw new \InvalidArgumentException('Invalid stream provided; must be a string stream identifier or resource', 1436717297);
        }
        $this->resource = ‪$resource;
    }
}