Dazzle\SSH\Driver\Shell\ShellResource

Complexity

Total Complexity

38

Size/Duplication

Total Lines	393
Duplicated Lines	2.29 %

Coupling/Cohesion

Components	2
Dependencies	4

Test Coverage

Coverage

41.82%

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	1
A	getId()	0	4	1
A	getPrefix()	0	4	1
A	getSuccessSuffix()	0	4	1
A	getFailureSuffix()	0	4	1
A	setLoop()	0	4	1
A	getLoop()	0	4	1
A	pause()	0	7	2
A	resume()	0	7	2
A	isPaused()	0	4	1
A	getResource()	0	4	1
A	getResourceId()	0	4	1
A	getMetadata()	0	4	1
A	getStreamType()	0	4	1
A	getWrapperType()	0	4	1
A	isOpen()	0	4	1
A	isSeekable()	0	4	1
A	tell()	0	4	1
A	seek()	0	4	1
A	rewind()	0	4	1
A	close()	0	15	2
A	isReadable()	0	4	1
A	setBufferSize()	0	4	1
A	getBufferSize()	0	4	1
B	read()	9	34	6
A	isWritable()	0	4	1
B	write()	0	32	3
A	throwAndEmitException()	0	5	1

<?php

namespace Dazzle\SSH\Driver\Shell;

use Dazzle\Event\BaseEventEmitterTrait;
use Dazzle\Loop\LoopInterface;
use Dazzle\SSH\SSH2DriverInterface;
use Dazzle\SSH\SSH2ResourceInterface;
use Dazzle\Throwable\Exception\Runtime\ReadException;
use Dazzle\Throwable\Exception\Runtime\WriteException;
use Error;
use Exception;

class ShellResource implements SSH2ResourceInterface
{
    use BaseEventEmitterTrait;

    /**
     * @var SSH2DriverInterface
     */
    protected $driver;

    /**
     * @var resource
     */
    protected $resource;

    /**
     * @var bool
     */
    private $paused;

    /**
     * @var bool
     */
    private $closing;

    /**
     * @var bool
     */
    private $readable;

    /**
     * @var bool
     */
    private $writable;

    /**
     * @var int
     */
    private $bufferSize;

    /**
     * @var string
     */
    private $prefix;

    /**
     * @var string
     */
    private $successSuffix;

    /**
     * @var string
     */
    private $failureSuffix;

    /**
     * @param SSH2DriverInterface $driver
     * @param resource $resource
     */
    public function __construct(SSH2DriverInterface $driver, $resource)
    {
        $this->driver = $driver;
        $this->resource = $resource;

        $this->paused = true;
        $this->closing = false;
        $this->readable = true;
        $this->writable = true;

        $this->bufferSize = 4096;

        $this->prefix        = md5(microtime());
        $this->successSuffix = md5(microtime());
        $this->failureSuffix = md5(microtime());
    }

    /**
     * @return string
     */
    public function getId()
    {
        return $this->prefix;
    }

    /**
     * @return string
     */
    public function getPrefix()
    {
        return $this->prefix;
    }

    /**
     * @return string
     */
    public function getSuccessSuffix()
    {
        return $this->successSuffix;
    }

    /**
     * @return string
     */
    public function getFailureSuffix()
    {
        return $this->failureSuffix;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function setLoop(LoopInterface $loop = null)
    {
        $this->driver->setLoop($loop);
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getLoop()
    {
        return $this->driver->getLoop();
    }

    /**
     * @override
     * @inheritDoc
     */
    public function pause()
    {
        if (!$this->paused)
        {
            $this->paused = true;
        }
    }

    /**
     * @override
     * @inheritDoc
     */
    public function resume()
    {
        if ($this->paused)
        {
            $this->paused = false;
        }
    }

    /**
     * @override
     * @inheritDoc
     */
    public function isPaused()
    {
        return $this->paused;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getResource()
    {
        return $this->resource;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getResourceId()
    {
        return (int) $this->resource;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getMetadata()
    {
        return stream_get_meta_data($this->resource);
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getStreamType()
    {
        return $this->getMetadata()['stream_type'];
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getWrapperType()
    {
        return $this->getMetadata()['wrapper_type'];
    }

    /**
     * @override
     * @inheritDoc
     */
    public function isOpen()
    {
        return !$this->closing;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function isSeekable()
    {
        return $this->getMetadata()['seekable'];
    }

    /**
     * @override
     * @inheritDoc
     */
    public function tell()
    {
        throw new ReadException('Cannot tell offset of this kind of stream.');
    }

    /**
     * @override
     * @inheritDoc
     */
    public function seek($offset, $whence = SEEK_SET)
    {
        throw new WriteException('Cannot seek on this kind of stream.');
    }

    /**
     * @override
     * @inheritDoc
     */
    public function rewind()
    {
        throw new WriteException('Cannot rewind this kind of stream.');
    }

    /**
     * @override
     * @inheritDoc
     */
    public function close()
    {
        if ($this->closing)
        {
            return;
        }

        $this->closing = true;
        $this->readable = false;
        $this->writable = false;

        $this->emit('close', [ $this ]);
        $this->pause();
        $this->emit('done', [ $this ]);
    }

    /**
     * @override
     * @inheritDoc
     */
    public function isReadable()
    {
        return $this->readable;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function setBufferSize($bufferSize)
    {
        $this->bufferSize = $bufferSize;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getBufferSize()
    {
        return $this->bufferSize;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function read($length = null)
    {
        if (!$this->readable)
        {
            return $this->throwAndEmitException(
                new ReadException('Stream is no longer readable.')
            );
        }

        if ($length === null)
        {
            $length = $this->bufferSize;
        }

        $ret = fread($this->resource, $length);

        if ($ret === false)
        {
            return $this->throwAndEmitException(
                new ReadException('Cannot read stream.')
            );
        }
        else if ($ret !== '')

This code seems to be duplicated across your project.

        {
            $this->emit('data', [ $this, $ret ]);

            if (strlen($ret) < $length)
            {
                $this->emit('end', [ $this ]);
            }
        }

        return $ret;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function isWritable()
    {
        return $this->writable;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function write($text = '')
    {
        if (!$this->writable)
        {
            return $this->throwAndEmitException(
                new WriteException('Stream is no longer writable.')
            );
        }

        $command = sprintf(
            "echo %s && %s && echo %s || echo %s\n",
            $this->prefix,
            $text,
            $this->successSuffix . ':$?',
            $this->failureSuffix . ':$?'
        );

        $sent = fwrite($this->resource, $command);

        if ($sent === false)
        {
            return $this->throwAndEmitException(
                new WriteException('Error occurred while writing to the stream resource.')
            );
        }

        $this->writable = false; // this is single-use stream only!
        $this->emit('drain', [ $this ]);
        $this->emit('finish', [ $this ]);

        return true;
    }

    /**
     * Emit error event and the throws it too.
     *
     * @param Error|Exception $ex
     * @return null
     * @throws Error|Exception
     */
    protected function throwAndEmitException($ex)
    {
        $this->emit('error', [ $this, $ex ]);
        throw $ex;
    }
}