SSH::getCommand() - Code Metrics - Inspection of "Added options to SSH." - albertofem/rsync-lib - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#21)

unknown

created 2016-12-16 19:36 UTC

SSH::getCommand() C

↳ Parent: SSH

Complexity

Conditions	8
Paths	34

Size

Total Lines	34
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	34
rs	5.3846
c	0
b	0
f	0
cc	8
eloc	17
nc	34
nop	1

<?php

/*
 * This file is part of rsync-lib
 *
 * (c) Alberto Fernández <[email protected]>
 *
 * For the full copyright and license information, please read
 * the LICENSE file that was distributed with this source code.
 */

namespace AFM\Rsync;

/**
 * Abstract SSH connection command. Note that if you
 * don't specify a public key, you will be prompted for
 * the remote server password
 *
 * @author Alberto <[email protected]>
 */
class SSH extends AbstractProtocol
{
    /**
     * @var string
     */
    protected $executable = "ssh";

    /**
     * @var string
     */
    protected $host;

    /**
     * @var int
     */
    protected $port = 22;

    /**
     * @var string
     */
    protected $username;

    /**
     * @var null
     */
    protected $publicKey = null;

    /**
     * @var string
     */
    protected $strictHostKeyCheking = null;

    /**
     * @var string
     */
    protected $userKnownHostsFile = null;

    /**
     * Injects and validates config
     *
     * @param array $options
     */
    public function __construct(array $options = array())
    {
        $this->setOption($options, 'executable', 'setExecutable');
        $this->setOption($options, 'host', 'setHost');
        $this->setOption($options, 'port', 'setPort');
        $this->setOption($options, 'username', 'setUsername');
        $this->setOption($options, 'public_key', 'setPublicKey');
        $this->setOption($options, 'strict_host_key_checking', 'setStrictHostKeyChecking');
        $this->setOption($options, 'user_known_hosts_file', 'setUserKnownHostFile');
    }

    /**
     * @param $host
     */
    public function setHost($host)
    {
        $this->host = $host;
    }

    /**
     * @return mixed
     */
    public function getHost()
    {
        return $this->host;
    }

    /**
     * @param $port
     *
     * @throws \InvalidArgumentException If the port is not numeric
     */
    public function setPort($port)
    {
        if (!is_int($port)) {
            throw new \InvalidArgumentException("SSH port must be an integer");
        }

        $this->port = $port;
    }

    /**
     * @return int
     */
    public function getPort()
    {
        return $this->port;
    }

    /**
     * @param $publicKey
     * @throws \InvalidArgumentException
     */
    public function setPublicKey($publicKey)
    {
        if (!is_readable($publicKey)) {
            throw new \InvalidArgumentException("SSH public key '" . $publicKey . "' is not readable");
        }

        $this->publicKey = $publicKey;
    }

    /**
     * @return null
     */
    public function getPublicKey()
    {
        return $this->publicKey;
    }

    /**
     * @param $username
     */
    public function setUsername($username)
    {
        $this->username = $username;
    }

    /**
     * @return mixed
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * @param $string
     * @throws \InvalidArgumentException
     */
    public function setStrictHostKeyChecking($strictHostKeyCheking)
    {
        //dd($strictHostKeyCheking);
        if ($strictHostKeyCheking !== 'yes' && $strictHostKeyCheking !== 'no') {
            throw new \InvalidArgumentException("StrictHostKeyCheking must be set to 'yes' or 'no'");
        }
        $this->strictHostKeyCheking = "StrictHostKeyChecking={$strictHostKeyCheking}";
    }

    /**
     * @return $string

     */
    public function getStrictHostKeyChecking($strictHostKeyCheking)

    {
        return $this->strictHostKeyCheking;
    }

    /**
     * @param $string
     */
    public function setUserKnownHostFile($userKnownHostsFile)
    {
        $this->userKnownHostsFile = "UserKnownHostsFile={$userKnownHostsFile}";
    }

    /**
     * @return $string

     */
    public function getUserKnownHostFile($userKnownHostFile)

    {
        return $this->userKnownHostFile;

    }

    /**
     * Gets commands for this SSH connection
     *
     * @param bool $hostConnection
     *
     * @return string
     *
     * @throws \InvalidArgumentException If you don't specify a SSH username or host
     */
    public function getCommand($hostConnection = true)
    {
        if (is_null($this->username)) {
            throw new \InvalidArgumentException("You must specify a SSH username");
        }

        if (is_null($this->host)) {
            throw new \InvalidArgumentException("You must specify a SSH host to connect");
        }

        $command = new Command($this->executable);

        if ($this->port != 22) {
            $command->addArgument("p", $this->port);
        }

        if (!is_null($this->publicKey)) {
            $command->addArgument("i", $this->publicKey);
        }

        if (!is_null($this->strictHostKeyCheking)) {
            $command->addArgument("o", $this->strictHostKeyCheking);
        }

        if (!is_null($this->userKnownHostsFile)) {
            $command->addArgument("o", $this->userKnownHostsFile);
        }

        if ($hostConnection) {
            $command->addParameter($this->getHostConnection());
        }

        return $command;
    }

    /**
     * Gets only connection options, without user@host string
     *
     * @return string
     */
    public function getConnectionOptions()
    {
        return (string) $this->getCommand(false);
    }

    /**
     * Gets only host connection, without the rest
     * of options
     *
     * @return string
     */
    public function getHostConnection()
    {
        return $this->username . "@" . $this->host;
    }

    /**
     * @param $executable
     */
    public function setExecutable($executable)
    {
        $this->executable = $executable;
    }

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


1			<?php
2
3			/*
4			* This file is part of rsync-lib
5			*
6			* (c) Alberto Fernández <[email protected]>
7			*
8			* For the full copyright and license information, please read
9			* the LICENSE file that was distributed with this source code.
10			*/
11
12			namespace AFM\Rsync;
13
14			/**
15			* Abstract SSH connection command. Note that if you
16			* don't specify a public key, you will be prompted for
17			* the remote server password
18			*
19			* @author Alberto <[email protected]>
20			*/
21			class SSH extends AbstractProtocol
22			{
23			/**
24			* @var string
25			*/
26			protected $executable = "ssh";
27
28			/**
29			* @var string
30			*/
31			protected $host;
32
33			/**
34			* @var int
35			*/
36			protected $port = 22;
37
38			/**
39			* @var string
40			*/
41			protected $username;
42
43			/**
44			* @var null
45			*/
46			protected $publicKey = null;
47
48			/**
49			* @var string
50			*/
51			protected $strictHostKeyCheking = null;
52
53			/**
54			* @var string
55			*/
56			protected $userKnownHostsFile = null;
57
58			/**
59			* Injects and validates config
60			*
61			* @param array $options
62			*/
63			public function __construct(array $options = array())
64			{
65			$this->setOption($options, 'executable', 'setExecutable');
66			$this->setOption($options, 'host', 'setHost');
67			$this->setOption($options, 'port', 'setPort');
68			$this->setOption($options, 'username', 'setUsername');
69			$this->setOption($options, 'public_key', 'setPublicKey');
70			$this->setOption($options, 'strict_host_key_checking', 'setStrictHostKeyChecking');
71			$this->setOption($options, 'user_known_hosts_file', 'setUserKnownHostFile');
72			}
73
74			/**
75			* @param $host
76			*/
77			public function setHost($host)
78			{
79			$this->host = $host;
80			}
81
82			/**
83			* @return mixed
84			*/
85			public function getHost()
86			{
87			return $this->host;
88			}
89
90			/**
91			* @param $port
92			*
93			* @throws \InvalidArgumentException If the port is not numeric
94			*/
95			public function setPort($port)
96			{
97			if (!is_int($port)) {
98			throw new \InvalidArgumentException("SSH port must be an integer");
99			}
100
101			$this->port = $port;
102			}
103
104			/**
105			* @return int
106			*/
107			public function getPort()
108			{
109			return $this->port;
110			}
111
112			/**
113			* @param $publicKey
114			* @throws \InvalidArgumentException
115			*/
116			public function setPublicKey($publicKey)
117			{
118			if (!is_readable($publicKey)) {
119			throw new \InvalidArgumentException("SSH public key '" . $publicKey . "' is not readable");
120			}
121
122			$this->publicKey = $publicKey;
123			}
124
125			/**
126			* @return null
127			*/
128			public function getPublicKey()
129			{
130			return $this->publicKey;
131			}
132
133			/**
134			* @param $username
135			*/
136			public function setUsername($username)
137			{
138			$this->username = $username;
139			}
140
141			/**
142			* @return mixed
143			*/
144			public function getUsername()
145			{
146			return $this->username;
147			}
148
149			/**
150			* @param $string
151			* @throws \InvalidArgumentException
152			*/
153			public function setStrictHostKeyChecking($strictHostKeyCheking)
154			{
155			//dd($strictHostKeyCheking);
156			if ($strictHostKeyCheking !== 'yes' && $strictHostKeyCheking !== 'no') {
157			throw new \InvalidArgumentException("StrictHostKeyCheking must be set to 'yes' or 'no'");
158			}
159			$this->strictHostKeyCheking = "StrictHostKeyChecking={$strictHostKeyCheking}";
160			}
161
162			/**
163			* @return $string
			0 ignored issues – show Documentation introduced 2016-12-16 19:37 UTC by Report Bug Copy Issue Report The doc-type `$string` could not be parsed: Unknown type name "$string" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
164			*/
165			public function getStrictHostKeyChecking($strictHostKeyCheking)
			0 ignored issues – show Unused Code introduced 2016-12-16 19:37 UTC by Report Bug Copy Issue Report The parameter `$strictHostKeyCheking` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
166			{
167			return $this->strictHostKeyCheking;
168			}
169
170			/**
171			* @param $string
172			*/
173			public function setUserKnownHostFile($userKnownHostsFile)
174			{
175			$this->userKnownHostsFile = "UserKnownHostsFile={$userKnownHostsFile}";
176			}
177
178			/**
179			* @return $string
			0 ignored issues – show Documentation introduced 2016-12-16 19:37 UTC by Report Bug Copy Issue Report The doc-type `$string` could not be parsed: Unknown type name "$string" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
180			*/
181			public function getUserKnownHostFile($userKnownHostFile)
			0 ignored issues – show Unused Code introduced 2016-12-16 19:37 UTC by Report Bug Copy Issue Report The parameter `$userKnownHostFile` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
182			{
183			return $this->userKnownHostFile;
			0 ignored issues – show Bug introduced 2016-12-16 19:37 UTC by Report Bug Copy Issue Report The property `userKnownHostFile` does not seem to exist. Did you mean `userKnownHostsFile`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
184			}
185
186			/**
187			* Gets commands for this SSH connection
188			*
189			* @param bool $hostConnection
190			*
191			* @return string
192			*
193			* @throws \InvalidArgumentException If you don't specify a SSH username or host
194			*/
195			public function getCommand($hostConnection = true)
196			{
197			if (is_null($this->username)) {
198			throw new \InvalidArgumentException("You must specify a SSH username");
199			}
200
201			if (is_null($this->host)) {
202			throw new \InvalidArgumentException("You must specify a SSH host to connect");
203			}
204
205			$command = new Command($this->executable);
206
207			if ($this->port != 22) {
208			$command->addArgument("p", $this->port);
209			}
210
211			if (!is_null($this->publicKey)) {
212			$command->addArgument("i", $this->publicKey);
213			}
214
215			if (!is_null($this->strictHostKeyCheking)) {
216			$command->addArgument("o", $this->strictHostKeyCheking);
217			}
218
219			if (!is_null($this->userKnownHostsFile)) {
220			$command->addArgument("o", $this->userKnownHostsFile);
221			}
222
223			if ($hostConnection) {
224			$command->addParameter($this->getHostConnection());
225			}
226
227			return $command;
228			}
229
230			/**
231			* Gets only connection options, without user@host string
232			*
233			* @return string
234			*/
235			public function getConnectionOptions()
236			{
237			return (string) $this->getCommand(false);
238			}
239
240			/**
241			* Gets only host connection, without the rest
242			* of options
243			*
244			* @return string
245			*/
246			public function getHostConnection()
247			{
248			return $this->username . "@" . $this->host;
249			}
250
251			/**
252			* @param $executable
253			*/
254			public function setExecutable($executable)
255			{
256			$this->executable = $executable;
257			}
258
259			/**
260			* @return string
261			*/
262			public function getExecutable()
263			{
264			return $this->executable;
265			}
266			}
267

albertofem / rsync-lib

GitHub Access Token became invalid

Pull Request — master (#21)

SSH::getCommand() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like