FilteredStream.php

<?php
 
namespace Http\Message\Encoding;
 
use Clue\StreamFilter as Filter;
use Http\Message\Decorator\StreamDecorator;
use Psr\Http\Message\StreamInterface;
 
abstract class FilteredStream implements StreamInterface
{
    const BUFFER_SIZE = 8192;
 
    use StreamDecorator {
        rewind as private doRewind;
        seek as private doSeek;
    }
 
    protected $readFilterCallback;
 
    protected $readFilter;
 
    protected $writeFilterCallback;
 
    protected $writeFilter;
 
    protected $buffer = '';
 
    public function __construct(StreamInterface $stream, $readFilterOptions = null, $writeFilterOptions = null)
    {
        if (null !== $readFilterOptions) {
            $this->readFilterCallback = Filter\fun($this->readFilter(), $readFilterOptions);
        } else {
            $this->readFilterCallback = Filter\fun($this->readFilter());
        }
 
        if (null !== $writeFilterOptions) {
            $this->writeFilterCallback = Filter\fun($this->writeFilter(), $writeFilterOptions);
 
            @trigger_error('The $writeFilterOptions argument is deprecated since version 1.5 and will be removed in 2.0.', E_USER_DEPRECATED);
        } else {
            $this->writeFilterCallback = Filter\fun($this->writeFilter());
        }
 
        $this->stream = $stream;
    }
 
    public function read($length)
    {
        if (strlen($this->buffer) >= $length) {
            $read = substr($this->buffer, 0, $length);
            $this->buffer = substr($this->buffer, $length);
 
            return $read;
        }
 
        if ($this->stream->eof()) {
            $buffer = $this->buffer;
            $this->buffer = '';
 
            return $buffer;
        }
 
        $read = $this->buffer;
        $this->buffer = '';
        $this->fill();
 
        return $read.$this->read($length - strlen($read));
    }
 
    public function eof()
    {
        return $this->stream->eof() && '' === $this->buffer;
    }
 
    protected function fill()
    {
        $readFilterCallback = $this->readFilterCallback;
        $this->buffer .= $readFilterCallback($this->stream->read(self::BUFFER_SIZE));
 
        if ($this->stream->eof()) {
            $this->buffer .= $readFilterCallback();
        }
    }
 
    public function getContents()
    {
        $buffer = '';
 
        while (!$this->eof()) {
            $buf = $this->read(self::BUFFER_SIZE);
            // Using a loose equality here to match on '' and false.
            if (null == $buf) {
                break;
            }
 
            $buffer .= $buf;
        }
 
        return $buffer;
    }
 
    public function getSize()
    {
        return null;
    }
 
    public function __toString()
    {
        return $this->getContents();
    }
 
    public function isSeekable()
    {
        return false;
    }
 
    public function rewind()
    {
        @trigger_error('Filtered streams are not seekable. This method will start raising an exception in the next major version', E_USER_DEPRECATED);
        $this->doRewind();
    }
 
    public function seek($offset, $whence = SEEK_SET)
    {
        @trigger_error('Filtered streams are not seekable. This method will start raising an exception in the next major version', E_USER_DEPRECATED);
        $this->doSeek($offset, $whence);
    }
 
    public function getReadFilter()
    {
        @trigger_error('The '.__CLASS__.'::'.__METHOD__.' method is deprecated since version 1.5 and will be removed in 2.0.', E_USER_DEPRECATED);
 
        return $this->readFilter();
    }
 
    abstract protected function readFilter();
 
    public function getWriteFilter()
    {
        @trigger_error('The '.__CLASS__.'::'.__METHOD__.' method is deprecated since version 1.5 and will be removed in 2.0.', E_USER_DEPRECATED);
 
        return $this->writeFilter();
    }
 
    abstract protected function writeFilter();
}