Shell::write() - Code Metrics - degagne/libssh2 - Measure and Improve Code Quality continuously with Scrutinizer

Shell::write() A
last analyzed 2018-01-25 04:14 UTC

↳ Parent: Shell

Complexity

Conditions	4
Paths	6

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	16
rs	9.2
cc	4
eloc	10
nc	6
nop	2

<?php
namespace LibSSH2\Sessions;

use LibSSH2\Authentication\Authentication;
use LibSSH2\Configuration;
use LibSSH2\Connection;

/**
 * Shell class.
 *
 * Shell interface.
 *
 * @package LibSSH2\Sessions
 */
class Shell extends Connection
{

    /**
     * SSH interactive shell resource.
     *
     * @var resource
     */
    private $stream;
    private $command;


    /**
     * Constructor.
     *
     * @param  object $configuration  Configuration class object
     * @param  object $authentication Authentication class object
     * @return void
     */
    public function __construct(Configuration $configuration, Authentication $authentication)
    {
        parent::__construct($configuration, $authentication);

        $this->shell();
    }
	
    /**
     * Destructor.
     *
     * @return void
     */
    public function __destruct()
    {
        fclose($this->stream);
    }

    /**
     * Returns SSH interactive shell.
     *
     * @return resouce SSH interactive shell
filter:
    dependency_paths: ["lib/*"]
     */
    final public function shell()
    {
        if (($this->stream = @ssh2_shell($this->connection)) === false)

        {
            throw new \RuntimeException($this->get_error_message());
        }
        sleep(1);
        return $this;

    }

    /**
     * Retrieves shell command output.
     *
     * @return void
     */
    final public function output()
    {
        $stdout = [];
        while (!preg_match('/RETURN_CODE:\[([0-9]+)\]/', implode(PHP_EOL, $stdout), $retval))
        {
            $buffer = fgets($this->stream);
            if (!empty($buffer))
            {
                $stdout[] = trim($buffer);
                //print $buffer;
            }
        }
        $stdout = preg_replace('/RETURN_CODE:\[([0-9]+)\]/', '', $stdout);
        $this->set_output(implode(PHP_EOL, $stdout));
        $this->set_exitstatus($retval[1]);
    }

    /**
     * Execute remote command via SSH (shell).
     *
     * @param  string   $command  command being executed
     * @param  instance $terminal Terminal instance
     * @return object
     */
    final public function write($command, $returncode = FALSE)
    {
        $command = ($returncode == FALSE) ? $command : $command.'; echo "RETURN_CODE:[$?]";';
        $write_count = 0;
        $string_len = strlen($command.PHP_EOL);
        while ($write_count < $string_len)
        {
            $fwrite_count = fwrite($this->stream, substr($command.PHP_EOL, $write_count), 1024);
            if ($fwrite_count === FALSE)
            {
                throw new \RuntimeException('failed to write command to stream');
            }
            $write_count += $fwrite_count;
        }
        sleep(1);
        return $this;
    }
	
}


1			<?php
2			namespace LibSSH2\Sessions;
3
4			use LibSSH2\Authentication\Authentication;
5			use LibSSH2\Configuration;
6			use LibSSH2\Connection;
7
8			/**
9			* Shell class.
10			*
11			* Shell interface.
12			*
13			* @package LibSSH2\Sessions
14			*/
15			class Shell extends Connection
16			{
17
18			/**
19			* SSH interactive shell resource.
20			*
21			* @var resource
22			*/
23			private $stream;
24			private $command;
			0 ignored issues – show introduced 2018-01-23 20:34 UTC by Report Bug Copy Issue Report The private property `$command` is not used, and could be removed. Loading history...
25
26			/**
27			* Constructor.
28			*
29			* @param object $configuration Configuration class object
30			* @param object $authentication Authentication class object
31			* @return void
32			*/
33			public function __construct(Configuration $configuration, Authentication $authentication)
34			{
35			parent::__construct($configuration, $authentication);
36
37			$this->shell();
38			}
39
40			/**
41			* Destructor.
42			*
43			* @return void
44			*/
45			public function __destruct()
46			{
47			fclose($this->stream);
48			}
49
50			/**
51			* Returns SSH interactive shell.
52			*
53			* @return resouce SSH interactive shell
			0 ignored issues – show Bug introduced 2018-01-23 20:34 UTC by Report Bug Copy Issue Report The type `LibSSH2\Sessions\resouce` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
54			*/
55			final public function shell()
56			{
57			if (($this->stream = @ssh2_shell($this->connection)) === false)
			0 ignored issues – show introduced 2018-01-23 20:34 UTC by Report Bug Copy Issue Report The condition `$this->stream = @ssh2_sh...->connection) === false` can never be `true`. Loading history...
58			{
59			throw new \RuntimeException($this->get_error_message());
60			}
61			sleep(1);
62			return $this;
			0 ignored issues – show Bug Best Practice introduced 2018-01-23 20:34 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `LibSSH2\Sessions\Shell` which is incompatible with the documented return type `LibSSH2\Sessions\resouce`. Loading history...
63			}
64
65			/**
66			* Retrieves shell command output.
67			*
68			* @return void
69			*/
70			final public function output()
71			{
72			$stdout = [];
73			while (!preg_match('/RETURN_CODE:\[([0-9]+)\]/', implode(PHP_EOL, $stdout), $retval))
74			{
75			$buffer = fgets($this->stream);
76			if (!empty($buffer))
77			{
78			$stdout[] = trim($buffer);
79			//print $buffer;
80			}
81			}
82			$stdout = preg_replace('/RETURN_CODE:\[([0-9]+)\]/', '', $stdout);
83			$this->set_output(implode(PHP_EOL, $stdout));
84			$this->set_exitstatus($retval[1]);
85			}
86
87			/**
88			* Execute remote command via SSH (shell).
89			*
90			* @param string $command command being executed
91			* @param instance $terminal Terminal instance
92			* @return object
93			*/
94			final public function write($command, $returncode = FALSE)
95			{
96			$command = ($returncode == FALSE) ? $command : $command.'; echo "RETURN_CODE:[$?]";';
97			$write_count = 0;
98			$string_len = strlen($command.PHP_EOL);
99			while ($write_count < $string_len)
100			{
101			$fwrite_count = fwrite($this->stream, substr($command.PHP_EOL, $write_count), 1024);
102			if ($fwrite_count === FALSE)
103			{
104			throw new \RuntimeException('failed to write command to stream');
105			}
106			$write_count += $fwrite_count;
107			}
108			sleep(1);
109			return $this;
110			}
111
112			}
113

degagne / libssh2

Shell::write() A last analyzed 2018-01-25 04:14 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Shell::write() A
last analyzed 2018-01-25 04:14 UTC