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

Completed

Pull Request — master (#22)

unknown

created 2016-12-16 20:02 UTC

SSH::getUserKnownHostFile() A

↳ Parent: SSH

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
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;

	/**
	 * 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}";
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * @return $string

     */
    public function getStrictHostKeyChecking($strictHostKeyCheking)

    {
        return $this->strictHostKeyCheking;
    }

    /**
     * @param $string
     */
    public function setUserKnownHostFile($userKnownHostsFile)
    {
        if (!is_string($userKnownHostsFile))
            throw new \InvalidArgumentException("UserKnownHostsFile should be set to a directory");

        $this->userKnownHostsFile = "UserKnownHostsFile={$userKnownHostsFile}";
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * @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			* Injects and validates config
50			*
51			* @param array $options
52			*/
53			public function __construct(Array $options = array())
54			{
55			$this->setOption($options, 'executable', 'setExecutable');
56			$this->setOption($options, 'host', 'setHost');
57			$this->setOption($options, 'port', 'setPort');
58			$this->setOption($options, 'username', 'setUsername');
59			$this->setOption($options, 'public_key', 'setPublicKey');
60			$this->setOption($options, 'strict_host_key_checking', 'setStrictHostKeyChecking');
61			$this->setOption($options, 'user_known_hosts_file', 'setUserKnownHostFile');
62			}
63
64			/**
65			* @param $host
66			*/
67			public function setHost($host)
68			{
69			$this->host = $host;
70			}
71
72			/**
73			* @return mixed
74			*/
75			public function getHost()
76			{
77			return $this->host;
78			}
79
80			/**
81			* @param $port
82			*
83			* @throws \InvalidArgumentException If the port is not numeric
84			*/
85			public function setPort($port)
86			{
87			if(!is_int($port))
88			throw new \InvalidArgumentException("SSH port must be an integer");
89
90			$this->port = $port;
91			}
92
93			/**
94			* @return int
95			*/
96			public function getPort()
97			{
98			return $this->port;
99			}
100
101			/**
102			* @param $publicKey
103			* @throws \InvalidArgumentException
104			*/
105			public function setPublicKey($publicKey)
106			{
107			if(!is_readable($publicKey))
108			throw new \InvalidArgumentException("SSH public key '" .$publicKey. "' is not readable");
109
110			$this->publicKey = $publicKey;
111			}
112
113			/**
114			* @return null
115			*/
116			public function getPublicKey()
117			{
118			return $this->publicKey;
119			}
120
121			/**
122			* @param $username
123			*/
124			public function setUsername($username)
125			{
126			$this->username = $username;
127			}
128
129			/**
130			* @return mixed
131			*/
132			public function getUsername()
133			{
134			return $this->username;
135			}
136
137			/**
138			* @param $string
139			* @throws \InvalidArgumentException
140			*/
141			public function setStrictHostKeyChecking($strictHostKeyCheking)
142			{
143			//dd($strictHostKeyCheking);
144			if ($strictHostKeyCheking !== 'yes' && $strictHostKeyCheking !== 'no')
145			throw new \InvalidArgumentException("StrictHostKeyCheking must be set to 'yes' or 'no'");
146
147			$this->strictHostKeyCheking = "StrictHostKeyChecking={$strictHostKeyCheking}";
			0 ignored issues – show Bug introduced 2016-12-16 20:03 UTC by Report Bug Copy Issue Report The property `strictHostKeyCheking` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
148			}
149
150			/**
151			* @return $string
			0 ignored issues – show Documentation introduced 2016-12-16 20:03 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...
152			*/
153			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...
154			{
155			return $this->strictHostKeyCheking;
156			}
157
158			/**
159			* @param $string
160			*/
161			public function setUserKnownHostFile($userKnownHostsFile)
162			{
163			if (!is_string($userKnownHostsFile))
164			throw new \InvalidArgumentException("UserKnownHostsFile should be set to a directory");
165
166			$this->userKnownHostsFile = "UserKnownHostsFile={$userKnownHostsFile}";
			0 ignored issues – show Bug introduced 2016-12-16 20:03 UTC by Report Bug Copy Issue Report The property `userKnownHostsFile` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
167			}
168
169			/**
170			* @return $string
			0 ignored issues – show Documentation introduced 2016-12-16 20:03 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...
171			*/
172			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...
173			{
174			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...
175			}
176
177			/**
178			* Gets commands for this SSH connection
179			*
180			* @param bool $hostConnection
181			*
182			* @return string
183			*
184			* @throws \InvalidArgumentException If you don't specify a SSH username or host
185			*/
186			public function getCommand($hostConnection = true)
187			{
188			if(is_null($this->username))
189			throw new \InvalidArgumentException("You must specify a SSH username");
190
191			if(is_null($this->host))
192			throw new \InvalidArgumentException("You must specify a SSH host to connect");
193
194			$command = new Command($this->executable);
195
196			if($this->port != 22)
197			$command->addArgument("p", $this->port);
198
199			if(!is_null($this->publicKey))
200			$command->addArgument("i", $this->publicKey);
201
202			if (!is_null($this->strictHostKeyCheking))
203			$command->addArgument("o", $this->strictHostKeyCheking);
204
205			if (!is_null($this->userKnownHostsFile))
206			$command->addArgument("o", $this->userKnownHostsFile);
207
208			if($hostConnection)
209			$command->addParameter($this->getHostConnection());
210
211			return $command;
212			}
213
214			/**
215			* Gets only connection options, without user@host string
216			*
217			* @return string
218			*/
219			public function getConnectionOptions()
220			{
221			return (string) $this->getCommand(false);
222			}
223
224			/**
225			* Gets only host connection, without the rest
226			* of options
227			*
228			* @return string
229			*/
230			public function getHostConnection()
231			{
232			return $this->username . "@" . $this->host;
233			}
234
235			/**
236			* @param $executable
237			*/
238			public function setExecutable($executable)
239			{
240			$this->executable = $executable;
241			}
242
243			/**
244			* @return string
245			*/
246			public function getExecutable()
247			{
248			return $this->executable;
249			}
250			}
251

albertofem / rsync-lib

GitHub Access Token became invalid

Pull Request — master (#22)

SSH::getUserKnownHostFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like