Shell - Code Metrics - Inspection of "Updated socket streams" - dazzle-php/ssh - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 51850a...8e4886 )

by Kamil

created 2017-07-23 20:19 UTC

Shell B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	373
Duplicated Lines	25.47 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

90.3%

Importance

Changes

Metric	Value
wmc	42
lcom	1
cbo	9
dl	95
loc	373
ccs	121
cts	134
cp	0.903
rs	8.295
c	0
b	0
f	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	19	19	1
A	__destruct()	0	4	1
A	getName()	0	4	1
A	connect()	19	19	4
A	disconnect()	17	17	4
A	isConnected()	0	4	2
A	pause()	13	13	3
A	resume()	12	12	3
A	isPaused()	0	4	1
A	open()	0	22	2
A	handleHeartbeat()	0	9	2
A	handleDisconnect()	0	5	1
A	createConnection()	0	4	1
A	removeResource()	15	15	3
D	handleRead()	0	85	13

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Shell often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Shell, and based on these observations, apply Extract Interface, too.

<?php

namespace Dazzle\SSH\Driver;

use Dazzle\Event\BaseEventEmitterTrait;
use Dazzle\Loop\Timer\TimerInterface;
use Dazzle\Loop\LoopAwareTrait;
use Dazzle\SSH\Driver\Shell\ShellResource;
use Dazzle\SSH\SSH2;
use Dazzle\SSH\SSH2DriverInterface;
use Dazzle\SSH\SSH2Interface;
use Dazzle\SSH\SSH2ResourceInterface;
use Dazzle\Throwable\Exception\Logic\ResourceUndefinedException;
use Dazzle\Throwable\Exception\Runtime\ExecutionException;
use Dazzle\Throwable\Exception\Runtime\ReadException;

class Shell implements SSH2DriverInterface
{
    use BaseEventEmitterTrait;
    use LoopAwareTrait;

    /**
     * @var int
     */
    const BUFFER_SIZE = 4096;

    /**
     * @var SSH2Interface
     */
    protected $ssh2;

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

    /**
     * @var float
     */
    protected $interval;

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

    /**
     * @var ShellResource[]|SSH2ResourceInterface[]
     */
    protected $resources;

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

    /**
     * @var TimerInterface|null
     */
    private $timer;

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

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

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

    /**
     * @param SSH2Interface $ssh2
     * @param resource $conn
     * @param float $interval
     */
    public function __construct(SSH2Interface $ssh2, $conn, $interval = 1e-1)

    {
        $this->ssh2 = $ssh2;
        $this->conn = $conn;
        $this->interval = $interval;

        $this->loop = $ssh2->getLoop();

        $this->resource = null;
        $this->resources = [];
        $this->paused = true;

        $this->timer = null;
        $this->resourcesCounter = 0;
        $this->buffer = '';
        $this->prefix = '';

        $this->resume();
    }

    /**
     *
     */
    public function __destruct()
    {
        $this->disconnect();
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getName()
    {
        return SSH2::DRIVER_SHELL;
    }

    /**
     * @override
     * @inheritDoc
     */
    public function connect()

    {
        if ($this->resource !== null)
        {
            return;
        }

        $shell = $this->createConnection($this->conn);

        if (!$shell || !is_resource($shell))
        {
            $this->emit('error', [ $this, new ExecutionException('SSH2:Shell could not be connected.') ]);
            return;
        }

        $this->resource = $shell;

        $this->emit('connect', [ $this ]);
    }

    /**
     * @override
     * @inheritDoc
     */
    public function disconnect()

    {
        if ($this->resource === null || !is_resource($this->resource))
        {
            return;
        }

        $this->pause();

        foreach ($this->resources as $resource)
        {
            $resource->close();
        }

        $this->handleDisconnect();
        $this->emit('disconnect', [ $this ]);
    }

    /**
     * @override
     * @inheritDoc
     */
    public function isConnected()
    {
        return $this->resource !== null && is_resource($this->resource);
    }

    /**
     * @override
     * @inheritDoc
     */
    public function pause()

    {
        if (!$this->paused)
        {
            $this->paused = true;

            if ($this->timer !== null)
            {
                $this->timer->cancel();
                $this->timer = null;
            }
        }
    }

    /**
     * @override
     * @inheritDoc
     */
    public function resume()

    {
        if ($this->paused)
        {
            $this->paused = false;

            if ($this->timer === null)
            {
                $this->timer = $this->loop->addPeriodicTimer($this->interval, [ $this, 'handleHeartbeat' ]);
            }
        }
    }

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

    /**
     * @override
     * @inheritDoc
     */
    public function open($resource = null, $flags = 'r')
    {
        if (!$this->isConnected())
        {
            throw new ResourceUndefinedException('Tried to open resource before establishing SSH2 connection!');
        }

        $resource = new ShellResource($this, $this->resource);
        $resource->on('open', function(SSH2ResourceInterface $resource) {
            $this->emit('resource:open', [ $this, $resource ]);
        });
        $resource->on('close', function(SSH2ResourceInterface $resource) {
            $this->removeResource($resource->getId());
            $this->emit('resource:close', [ $this, $resource ]);
        });

        $this->resources[$resource->getId()] = $resource;
        $this->resourcesCounter++;
        $this->resume();

        return $resource;
    }

    /**
     * Handle data.
     *
     * @internal
     */
    public function handleHeartbeat()
    {
        if (fwrite($this->resource, "\n") === 0)
        {
            return $this->ssh2->disconnect();
        }

        $this->handleRead();
    }

    /**
     * Handle incoming data.
     *
     * @internal
     */
    protected function handleRead()
    {
        if ($this->paused)
        {
            return;
        }

        $data = @fread($this->resource, static::BUFFER_SIZE);

        if ($data === false || $data === '')
        {
            return;
        }

        $this->buffer .= $data;

        while ($this->buffer !== '')
        {
            if ($this->prefix !== '' && !isset($this->resources[$this->prefix]))
            {
                $this->prefix = '';
            }

            if ($this->prefix === '')
            {
                if (!preg_match('/([a-zA-Z0-9]{32})\r?\n(.*)/s', $this->buffer, $matches))
                {
                    return;
                }

                $this->prefix = $matches[1];
                $this->buffer = $matches[2];
            }

            $resource = $this->resources[$this->prefix];
            $data = '';
            $status = -1;
            $successSuffix = $resource->getSuccessSuffix();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            $failureSuffix = $resource->getFailureSuffix();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

            $this->buffer = preg_replace_callback(
                sprintf('/(.*)(%s|%s):(\d*)\r?\n/s', $successSuffix, $failureSuffix),
                function($matches) use($resource, &$data, &$status) {
                    $data   = $matches[1];
                    $status = (int) $matches[3];
                    return '';
                },
                $this->buffer
            );

            if ($status === -1)
            {
                $data = $this->buffer;
                $this->buffer = '';
            }
            else
            {
                $this->removeResource($this->prefix);
                $this->prefix = '';
            }

            $parts = str_split($data, $resource->getBufferSize());
            unset($data);

            foreach ($parts as &$part)
            {
                $resource->emit('data', [ $resource, $part ]);
            }
            unset($parts);
            unset($part);

            if ($status === 0)
            {
                $resource->emit('end', [ $resource ]);
                $resource->close();
            }
            else if ($status > 0)
            {
                $resource->emit('error', [ $resource, new ReadException($status) ]);
                $resource->close();
            }
        }

        $this->handleRead();
    }

    /**
     *
     */
    protected function handleDisconnect()
    {
        @fclose($this->resource);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        $this->resource = null;
    }

    /**
     * @param resource $conn
     * @return resource
     */
    protected function createConnection($conn)
    {
        return @ssh2_shell($conn);
    }

    /**
     * Remove resource from known collection.
     *
     * @param string $prefix
     */
    private function removeResource($prefix)

    {
        if (!isset($this->resources[$prefix]))
        {
            return;
        }

        unset($this->resources[$prefix]);
        $this->resourcesCounter--;

        if ($this->resourcesCounter === 0)
        {
            $this->pause();
        }
    }
}


Push — master ( 51850a...8e4886 )

Shell B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

1			<?php
2
3			namespace Dazzle\SSH\Driver;
4
5			use Dazzle\Event\BaseEventEmitterTrait;
6			use Dazzle\Loop\Timer\TimerInterface;
7			use Dazzle\Loop\LoopAwareTrait;
8			use Dazzle\SSH\Driver\Shell\ShellResource;
9			use Dazzle\SSH\SSH2;
10			use Dazzle\SSH\SSH2DriverInterface;
11			use Dazzle\SSH\SSH2Interface;
12			use Dazzle\SSH\SSH2ResourceInterface;
13			use Dazzle\Throwable\Exception\Logic\ResourceUndefinedException;
14			use Dazzle\Throwable\Exception\Runtime\ExecutionException;
15			use Dazzle\Throwable\Exception\Runtime\ReadException;
16
17			class Shell implements SSH2DriverInterface
18			{
19			use BaseEventEmitterTrait;
20			use LoopAwareTrait;
21
22			/**
23			* @var int
24			*/
25			const BUFFER_SIZE = 4096;
26
27			/**
28			* @var SSH2Interface
29			*/
30			protected $ssh2;
31
32			/**
33			* @var resource
34			*/
35			protected $conn;
36
37			/**
38			* @var float
39			*/
40			protected $interval;
41
42			/**
43			* @var resource
44			*/
45			protected $resource;
46
47			/**
48			* @var ShellResource[]\|SSH2ResourceInterface[]
49			*/
50			protected $resources;
51
52			/**
53			* @var bool
54			*/
55			protected $paused;
56
57			/**
58			* @var TimerInterface\|null
59			*/
60			private $timer;
61
62			/**
63			* @var int
64			*/
65			private $resourcesCounter;
66
67			/**
68			* @var string
69			*/
70			private $buffer;
71
72			/**
73			* @var string
74			*/
75			private $prefix;
76
77			/**
78			* @param SSH2Interface $ssh2
79			* @param resource $conn
80			* @param float $interval
81			*/
82	23	View Code Duplication	public function __construct(SSH2Interface $ssh2, $conn, $interval = 1e-1)
			0 ignored issues – show Duplication introduced 2017-06-24 22:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
83			{
84	23		$this->ssh2 = $ssh2;
85	23		$this->conn = $conn;
86	23		$this->interval = $interval;
87
88	23		$this->loop = $ssh2->getLoop();
89
90	23		$this->resource = null;
91	23		$this->resources = [];
92	23		$this->paused = true;
93
94	23		$this->timer = null;
95	23		$this->resourcesCounter = 0;
96	23		$this->buffer = '';
97	23		$this->prefix = '';
98
99	23		$this->resume();
100	23		}
101
102			/**
103			*
104			*/
105	13		public function __destruct()
106			{
107	13		$this->disconnect();
108	13		}
109
110			/**
111			* @override
112			* @inheritDoc
113			*/
114	3		public function getName()
115			{
116	3		return SSH2::DRIVER_SHELL;
117			}
118
119			/**
120			* @override
121			* @inheritDoc
122			*/
123	6	View Code Duplication	public function connect()
			0 ignored issues – show Duplication introduced 2017-06-24 22:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
124			{
125	6		if ($this->resource !== null)
126			{
127	1		return;
128			}
129
130	5		$shell = $this->createConnection($this->conn);
131
132	5		if (!$shell \|\| !is_resource($shell))
133			{
134	2		$this->emit('error', [ $this, new ExecutionException('SSH2:Shell could not be connected.') ]);
135	2		return;
136			}
137
138	3		$this->resource = $shell;
139
140	3		$this->emit('connect', [ $this ]);
141	3		}
142
143			/**
144			* @override
145			* @inheritDoc
146			*/
147	18	View Code Duplication	public function disconnect()
			0 ignored issues – show Duplication introduced 2017-06-24 22:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
148			{
149	18		if ($this->resource === null \|\| !is_resource($this->resource))
150			{
151	15		return;
152			}
153
154	5		$this->pause();
155
156	5		foreach ($this->resources as $resource)
157			{
158	1		$resource->close();
159			}
160
161	5		$this->handleDisconnect();
162	5		$this->emit('disconnect', [ $this ]);
163	5		}
164
165			/**
166			* @override
167			* @inheritDoc
168			*/
169	5		public function isConnected()
170			{
171	5		return $this->resource !== null && is_resource($this->resource);
172			}
173
174			/**
175			* @override
176			* @inheritDoc
177			*/
178	5	View Code Duplication	public function pause()
			0 ignored issues – show Duplication introduced 2017-06-24 22:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
179			{
180	5		if (!$this->paused)
181			{
182	4		$this->paused = true;
183
184	4		if ($this->timer !== null)
185			{
186	4		$this->timer->cancel();
187	4		$this->timer = null;
188			}
189			}
190	5		}
191
192			/**
193			* @override
194			* @inheritDoc
195			*/
196	23	View Code Duplication	public function resume()
			0 ignored issues – show Duplication introduced 2017-06-24 22:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
197			{
198	23		if ($this->paused)
199			{
200	23		$this->paused = false;
201
202	23		if ($this->timer === null)
203			{
204	23		$this->timer = $this->loop->addPeriodicTimer($this->interval, [ $this, 'handleHeartbeat' ]);
205			}
206			}
207	23		}
208
209			/**
210			* @override
211			* @inheritDoc
212			*/
213	6		public function isPaused()
214			{
215	6		return $this->paused;
216			}
217
218			/**
219			* @override
220			* @inheritDoc
221			*/
222	2		public function open($resource = null, $flags = 'r')
223			{
224	2		if (!$this->isConnected())
225			{
226			throw new ResourceUndefinedException('Tried to open resource before establishing SSH2 connection!');
227			}
228
229	2		$resource = new ShellResource($this, $this->resource);
230			$resource->on('open', function(SSH2ResourceInterface $resource) {
231			$this->emit('resource:open', [ $this, $resource ]);
232	2		});
233			$resource->on('close', function(SSH2ResourceInterface $resource) {
234	2		$this->removeResource($resource->getId());
235	2		$this->emit('resource:close', [ $this, $resource ]);
236	2		});
237
238	2		$this->resources[$resource->getId()] = $resource;
239	2		$this->resourcesCounter++;
240	2		$this->resume();
241
242	2		return $resource;
243			}
244
245			/**
246			* Handle data.
247			*
248			* @internal
249			*/
250	2		public function handleHeartbeat()
251			{
252	2		if (fwrite($this->resource, "\n") === 0)
253			{
254			return $this->ssh2->disconnect();
255			}
256
257	2		$this->handleRead();
258	2		}
259
260			/**
261			* Handle incoming data.
262			*
263			* @internal
264			*/
265	2		protected function handleRead()
266			{
267	2		if ($this->paused)
268			{
269			return;
270			}
271
272	2		$data = @fread($this->resource, static::BUFFER_SIZE);
273
274	2		if ($data === false \|\| $data === '')
275			{
276			return;
277			}
278
279	2		$this->buffer .= $data;
280
281	2		while ($this->buffer !== '')
282			{
283	2		if ($this->prefix !== '' && !isset($this->resources[$this->prefix]))
284			{
285			$this->prefix = '';
286			}
287
288	2		if ($this->prefix === '')
289			{
290	2		if (!preg_match('/([a-zA-Z0-9]{32})\r?\n(.*)/s', $this->buffer, $matches))
291			{
292	2		return;
293			}
294
295	2		$this->prefix = $matches[1];
296	2		$this->buffer = $matches[2];
297			}
298
299	2		$resource = $this->resources[$this->prefix];
300	2		$data = '';
301	2		$status = -1;
302	2		$successSuffix = $resource->getSuccessSuffix();
			0 ignored issues – show Bug introduced 2017-06-24 22:28 UTC by Report Bug Copy Issue Report The method `getSuccessSuffix` does only exist in `Dazzle\SSH\Driver\Shell\ShellResource`, but not in `Dazzle\SSH\SSH2ResourceInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
303	2		$failureSuffix = $resource->getFailureSuffix();
			0 ignored issues – show Bug introduced 2017-06-24 22:28 UTC by Report Bug Copy Issue Report The method `getFailureSuffix` does only exist in `Dazzle\SSH\Driver\Shell\ShellResource`, but not in `Dazzle\SSH\SSH2ResourceInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
304
305	2		$this->buffer = preg_replace_callback(
306	2		sprintf('/(.)(%s\|%s):(\d)\r?\n/s', $successSuffix, $failureSuffix),
307	2		function($matches) use($resource, &$data, &$status) {
308	2		$data = $matches[1];
309	2		$status = (int) $matches[3];
310	2		return '';
311	2		},
312	2		$this->buffer
313			);
314
315	2		if ($status === -1)
316			{
317			$data = $this->buffer;
318			$this->buffer = '';
319			}
320			else
321			{
322	2		$this->removeResource($this->prefix);
323	2		$this->prefix = '';
324			}
325
326	2		$parts = str_split($data, $resource->getBufferSize());
327	2		unset($data);
328
329	2		foreach ($parts as &$part)
330			{
331	2		$resource->emit('data', [ $resource, $part ]);
332			}
333	2		unset($parts);
334	2		unset($part);
335
336	2		if ($status === 0)
337			{
338	2		$resource->emit('end', [ $resource ]);
339	2		$resource->close();
340			}
341			else if ($status > 0)
342			{
343			$resource->emit('error', [ $resource, new ReadException($status) ]);
344			$resource->close();
345			}
346			}
347
348			$this->handleRead();
349			}
350
351			/**
352			*
353			*/
354	3		protected function handleDisconnect()
355			{
356	3		@fclose($this->resource);
			0 ignored issues – show Security Best Practice introduced 2017-06-24 22:28 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
357	3		$this->resource = null;
358	3		}
359
360			/**
361			* @param resource $conn
362			* @return resource
363			*/
364	2		protected function createConnection($conn)
365			{
366	2		return @ssh2_shell($conn);
367			}
368
369			/**
370			* Remove resource from known collection.
371			*
372			* @param string $prefix
373			*/
374	2	View Code Duplication	private function removeResource($prefix)
			0 ignored issues – show Duplication introduced 2017-06-24 22:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
375			{
376	2		if (!isset($this->resources[$prefix]))
377			{
378	2		return;
379			}
380
381	2		unset($this->resources[$prefix]);
382	2		$this->resourcesCounter--;
383
384	2		if ($this->resourcesCounter === 0)
385			{
386	2		$this->pause();
387			}
388	2		}
389			}
390

dazzle-php / ssh

Push — master ( 51850a...8e4886 )

Shell B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like