Configuration::setPty() - Code Metrics - Inspection of "Merge pull request #953 from vladdnepr/native-ssh-..." - deployphp/deployer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c1a124...a29f3e )

by Anton

created 2017-01-16 08:34 UTC

Configuration::setPty() A

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
ccs	0
cts	3
cp	0
crap	2
rs	10

<?php

/**
 * (c) Anton Medvedev <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Deployer\Server;

use Deployer\Server\Password\PasswordGetterInterface;

/**
 * Server configuration
 */
class Configuration
{
    const AUTH_BY_PASSWORD                      = 0;
    const AUTH_BY_CONFIG                        = 1;
    const AUTH_BY_IDENTITY_FILE                 = 2;
    const AUTH_BY_PEM_FILE                      = 3;
    const AUTH_BY_AGENT                         = 4;
    const AUTH_BY_IDENTITY_FILE_AND_PASSWORD    = 5;

    /**
     * Type of authentication.
     * By default try to connect via password authentication
     *
     * @var int
     */
    private $authenticationMethod = self::AUTH_BY_PASSWORD;

    /**
     * Server name
     *
     * @var string
     */
    private $name;

    /**
     * Server host.
     *
     * @var string
     */
    private $host;

    /**
     * Server port.
     *
     * @var int
     */
    private $port;

    /**
     * User of remote server.
     *
     * @var string
     */
    private $user;

    /**
     * Used for authentication with password.
     *
     * @var string
     */
    private $password;

    /**
     * Used for authentication with config file.
     *
     * @var string
     */
    private $configFile;

    /**
     * Used for authentication with public key.
     *
     * @var string
     */
    private $publicKey;

    /**
     * Used for authentication with public key.
     *
     * @var string
     */
    private $privateKey;

    /**
     * Used for authentication with public key.
     *
     * @var string
     */
    private $passPhrase;

    /**
     * Pem file.
     *
     * @var string
     */
    private $pemFile;

    /**
     * Pty configuration
     *
     * @var mixed
     */
    private $pty = null;


    /**
     * Construct
     *
     * @param string $name
     * @param string $host
     * @param int    $port
     */
    public function __construct($name, $host, $port = 22)
    {
        $this->setName($name);
        $this->setHost($host);
        $this->setPort($port);
    }

    /**
     * Get authentication method
     *
     * @return int
     */
    public function getAuthenticationMethod()
    {
        return $this->authenticationMethod;
    }

    /**
     * Set authentication method
     *
     * @param int $authenticationMethod
     *
     * @return Configuration
     */
    public function setAuthenticationMethod($authenticationMethod)
    {
        $this->authenticationMethod = $authenticationMethod;

        return $this;
    }

    /**
     * Get configuration file
     *
     * @return string
     */
    public function getConfigFile()
    {
        return $this->configFile;
    }

    /**
     * Set configuration file
     *
     * @param string $configFile
     *
     * @return Configuration
     */
    public function setConfigFile($configFile)
    {
        $this->configFile = $this->parseHome($configFile);

        return $this;
    }

    /**
     * Get host for connection
     *
     * @return string
     */
    public function getHost()
    {
        return $this->host;
    }

    /**
     * Set host for connection
     *
     * @param string $host
     *
     * @return Configuration
     */
    public function setHost($host)
    {
        $this->host = $host;

        return $this;
    }

    /**
     * Get password for connection
     *
     * @return string
     */
    public function getPassword()
    {
        return $this->getRealPassword($this->password);
    }

    /**
     * Set password for connection
     *
     * @param string $password
     *
     * @return Configuration
     */
    public function setPassword($password)
    {
        $this->password = $password;

        return $this;
    }

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

    /**
     * Set port for connection
     *
     * @param int $port
     *
     * @return Configuration
     */
    public function setPort($port)
    {
        $this->port = $port;

        return $this;
    }

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

    /**
     * Set public key
     *
     * @param string $path
     *
     * @return Configuration
     */
    public function setPublicKey($path)
    {
        $this->publicKey = $this->parseHome($path);

        return $this;
    }

    /**
     * Get pass phrase
     *
     * @return string
     */
    public function getPassPhrase()
    {
        return $this->getRealPassword($this->passPhrase);
    }

    /**
     * Set pass phrase
     *
     * @param string $passPhrase
     *
     * @return Configuration
     */
    public function setPassPhrase($passPhrase)
    {
        $this->passPhrase = $passPhrase;

        return $this;
    }

    /**
     * Get private key
     *
     * @return string
     */
    public function getPrivateKey()
    {
        return $this->privateKey;
    }

    /**
     * Set private key
     *
     * @param string $path
     *
     * @return Configuration
     */
    public function setPrivateKey($path)
    {
        $this->privateKey = $this->parseHome($path);

        return $this;
    }

    /**
     * Get user
     *
     * @return string
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * Set user
     *
     * @param string $user
     *
     * @return Configuration
     */
    public function setUser($user)
    {
        $this->user = $user;

        return $this;
    }

    /**
     * Get name
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Set name
     *
     * @param string $name
     *
     * @return Configuration
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Get pem file
     *
     * @return string
     */
    public function getPemFile()
    {
        return $this->pemFile;
    }

    /**
     * To auth with pem file use pemFile() method instead of this.
     *
     * @param string $pemFile
     *
     * @return Configuration
     */
    public function setPemFile($pemFile)
    {
        $this->pemFile = $this->parseHome($pemFile);

        return $this;
    }

    /**
     * Parse "~" symbol from path.
     *
     * @param string $path
     *
     * @return string
     */
    private function parseHome($path)
    {
        if (isset($_SERVER['HOME'])) {
            $path = str_replace('~', $_SERVER['HOME'], $path);
        } elseif (isset($_SERVER['HOMEDRIVE'], $_SERVER['HOMEPATH'])) {
            $path = str_replace('~', $_SERVER['HOMEDRIVE'] . $_SERVER['HOMEPATH'], $path);
        }

        return $path;
    }

    /**
     * Get real password
     *
     * @param mixed $password
     *
     * @return string
     */
    private function getRealPassword($password)
    {
        if ($password instanceof PasswordGetterInterface) {
            return $password->getPassword($this->getHost(), $this->getUser());
        }

        return $password;
    }

    /**
     * Set pty
     *
     * @param $pty
     */
    public function setPty($pty)
    {
        $this->pty = $pty;
    }

    /**
     * Get pty option
     *
     * @return mixed
     */
    public function getPty()
    {
        return $this->pty;
    }

    /**
     * Set pty for ssh2 connection. For retro compatibility
     *
     * @param $ssh2Pty
     * @deprecated
     */
    public function setSsh2Pty($ssh2Pty)
    {
        $this->setPty($ssh2Pty);
    }

    /**
     * Get pty option for ssh2 connection. For retro compatibility
     *
     * @deprecated
     * @return mixed
     */
    public function getSsh2Pty()
    {
        return $this->getPty();
    }
}


1		<?php
2
3		/**
4		* (c) Anton Medvedev <[email protected]>
5		*
6		* For the full copyright and license information, please view the LICENSE
7		* file that was distributed with this source code.
8		*/
9
10		namespace Deployer\Server;
11
12		use Deployer\Server\Password\PasswordGetterInterface;
13
14		/**
15		* Server configuration
16		*/
17		class Configuration
18		{
19		const AUTH_BY_PASSWORD = 0;
20		const AUTH_BY_CONFIG = 1;
21		const AUTH_BY_IDENTITY_FILE = 2;
22		const AUTH_BY_PEM_FILE = 3;
23		const AUTH_BY_AGENT = 4;
24		const AUTH_BY_IDENTITY_FILE_AND_PASSWORD = 5;
25
26		/**
27		* Type of authentication.
28		* By default try to connect via password authentication
29		*
30		* @var int
31		*/
32		private $authenticationMethod = self::AUTH_BY_PASSWORD;
33
34		/**
35		* Server name
36		*
37		* @var string
38		*/
39		private $name;
40
41		/**
42		* Server host.
43		*
44		* @var string
45		*/
46		private $host;
47
48		/**
49		* Server port.
50		*
51		* @var int
52		*/
53		private $port;
54
55		/**
56		* User of remote server.
57		*
58		* @var string
59		*/
60		private $user;
61
62		/**
63		* Used for authentication with password.
64		*
65		* @var string
66		*/
67		private $password;
68
69		/**
70		* Used for authentication with config file.
71		*
72		* @var string
73		*/
74		private $configFile;
75
76		/**
77		* Used for authentication with public key.
78		*
79		* @var string
80		*/
81		private $publicKey;
82
83		/**
84		* Used for authentication with public key.
85		*
86		* @var string
87		*/
88		private $privateKey;
89
90		/**
91		* Used for authentication with public key.
92		*
93		* @var string
94		*/
95		private $passPhrase;
96
97		/**
98		* Pem file.
99		*
100		* @var string
101		*/
102		private $pemFile;
103
104		/**
105		* Pty configuration
106		*
107		* @var mixed
108		*/
109		private $pty = null;
110
111
112		/**
113		* Construct
114		*
115		* @param string $name
116		* @param string $host
117		* @param int $port
118		*/
119	23	public function __construct($name, $host, $port = 22)
120		{
121	23	$this->setName($name);
122	23	$this->setHost($host);
123	23	$this->setPort($port);
124	23	}
125
126		/**
127		* Get authentication method
128		*
129		* @return int
130		*/
131	1	public function getAuthenticationMethod()
132		{
133	1	return $this->authenticationMethod;
134		}
135
136		/**
137		* Set authentication method
138		*
139		* @param int $authenticationMethod
140		*
141		* @return Configuration
142		*/
143	2	public function setAuthenticationMethod($authenticationMethod)
144		{
145	2	$this->authenticationMethod = $authenticationMethod;
146
147	2	return $this;
148		}
149
150		/**
151		* Get configuration file
152		*
153		* @return string
154		*/
155	1	public function getConfigFile()
156		{
157	1	return $this->configFile;
158		}
159
160		/**
161		* Set configuration file
162		*
163		* @param string $configFile
164		*
165		* @return Configuration
166		*/
167	1	public function setConfigFile($configFile)
168		{
169	1	$this->configFile = $this->parseHome($configFile);
170
171	1	return $this;
172		}
173
174		/**
175		* Get host for connection
176		*
177		* @return string
178		*/
179	23	public function getHost()
180		{
181	23	return $this->host;
182		}
183
184		/**
185		* Set host for connection
186		*
187		* @param string $host
188		*
189		* @return Configuration
190		*/
191	23	public function setHost($host)
192		{
193	23	$this->host = $host;
194
195	23	return $this;
196		}
197
198		/**
199		* Get password for connection
200		*
201		* @return string
202		*/
203	2	public function getPassword()
204		{
205	2	return $this->getRealPassword($this->password);
206		}
207
208		/**
209		* Set password for connection
210		*
211		* @param string $password
212		*
213		* @return Configuration
214		*/
215	3	public function setPassword($password)
216		{
217	3	$this->password = $password;
218
219	3	return $this;
220		}
221
222		/**
223		* Get port
224		*
225		* @return int
226		*/
227	21	public function getPort()
228		{
229	21	return $this->port;
230		}
231
232		/**
233		* Set port for connection
234		*
235		* @param int $port
236		*
237		* @return Configuration
238		*/
239	23	public function setPort($port)
240		{
241	23	$this->port = $port;
242
243	23	return $this;
244		}
245
246		/**
247		* Get public key
248		*
249		* @return string
250		*/
251	1	public function getPublicKey()
252		{
253	1	return $this->publicKey;
254		}
255
256		/**
257		* Set public key
258		*
259		* @param string $path
260		*
261		* @return Configuration
262		*/
263	2	public function setPublicKey($path)
264		{
265	2	$this->publicKey = $this->parseHome($path);
266
267	2	return $this;
268		}
269
270		/**
271		* Get pass phrase
272		*
273		* @return string
274		*/
275	2	public function getPassPhrase()
276		{
277	2	return $this->getRealPassword($this->passPhrase);
278		}
279
280		/**
281		* Set pass phrase
282		*
283		* @param string $passPhrase
284		*
285		* @return Configuration
286		*/
287	3	public function setPassPhrase($passPhrase)
288		{
289	3	$this->passPhrase = $passPhrase;
290
291	3	return $this;
292		}
293
294		/**
295		* Get private key
296		*
297		* @return string
298		*/
299	1	public function getPrivateKey()
300		{
301	1	return $this->privateKey;
302		}
303
304		/**
305		* Set private key
306		*
307		* @param string $path
308		*
309		* @return Configuration
310		*/
311	2	public function setPrivateKey($path)
312		{
313	2	$this->privateKey = $this->parseHome($path);
314
315	2	return $this;
316		}
317
318		/**
319		* Get user
320		*
321		* @return string
322		*/
323	3	public function getUser()
324		{
325	3	return $this->user;
326		}
327
328		/**
329		* Set user
330		*
331		* @param string $user
332		*
333		* @return Configuration
334		*/
335	4	public function setUser($user)
336		{
337	4	$this->user = $user;
338
339	4	return $this;
340		}
341
342		/**
343		* Get name
344		*
345		* @return string
346		*/
347	21	public function getName()
348		{
349	21	return $this->name;
350		}
351
352		/**
353		* Set name
354		*
355		* @param string $name
356		*
357		* @return Configuration
358		*/
359	23	public function setName($name)
360		{
361	23	$this->name = $name;
362
363	23	return $this;
364		}
365
366		/**
367		* Get pem file
368		*
369		* @return string
370		*/
371	1	public function getPemFile()
372		{
373	1	return $this->pemFile;
374		}
375
376		/**
377		* To auth with pem file use pemFile() method instead of this.
378		*
379		* @param string $pemFile
380		*
381		* @return Configuration
382		*/
383	1	public function setPemFile($pemFile)
384		{
385	1	$this->pemFile = $this->parseHome($pemFile);
386
387	1	return $this;
388		}
389
390		/**
391		* Parse "~" symbol from path.
392		*
393		* @param string $path
394		*
395		* @return string
396		*/
397	2	private function parseHome($path)
398		{
399	2	if (isset($_SERVER['HOME'])) {
400	2	$path = str_replace('~', $_SERVER['HOME'], $path);
401	2	} elseif (isset($_SERVER['HOMEDRIVE'], $_SERVER['HOMEPATH'])) {
402		$path = str_replace('~', $_SERVER['HOMEDRIVE'] . $_SERVER['HOMEPATH'], $path);
403		}
404
405	2	return $path;
406		}
407
408		/**
409		* Get real password
410		*
411		* @param mixed $password
412		*
413		* @return string
414		*/
415	3	private function getRealPassword($password)
416		{
417	3	if ($password instanceof PasswordGetterInterface) {
418	2	return $password->getPassword($this->getHost(), $this->getUser());
419		}
420
421	1	return $password;
422		}
423
424		/**
425		* Set pty
426		*
427		* @param $pty
428		*/
429		public function setPty($pty)
430		{
431		$this->pty = $pty;
432		}
433
434		/**
435		* Get pty option
436		*
437		* @return mixed
438		*/
439		public function getPty()
440		{
441		return $this->pty;
442		}
443
444		/**
445		* Set pty for ssh2 connection. For retro compatibility
446		*
447		* @param $ssh2Pty
448		* @deprecated
449		*/
450		public function setSsh2Pty($ssh2Pty)
451		{
452		$this->setPty($ssh2Pty);
453		}
454
455		/**
456		* Get pty option for ssh2 connection. For retro compatibility
457		*
458		* @deprecated
459		* @return mixed
460		*/
461		public function getSsh2Pty()
462		{
463		return $this->getPty();
464		}
465		}
466

deployphp / deployer

GitHub Access Token became invalid

Push — master ( c1a124...a29f3e )

Configuration::setPty() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like