CpanelChangePasswordDriver::ChangePassword() - Code Metrics - Inspection of "Fix incorrect mailto format #1521" - RainLoop/rainloop-webmail - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 71718d...90a3d2 )

by Rain

created 2017-10-06 18:52 UTC

CpanelChangePasswordDriver::ChangePassword() D

↳ Parent: CpanelChangePasswordDriver

Complexity

Conditions	18
Paths	208

Size

Total Lines	84
Code Lines	47

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	18
eloc	47
nc	208
nop	3
dl	0
loc	84
rs	4.4039
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

class CpanelChangePasswordDriver implements \RainLoop\Providers\ChangePassword\ChangePasswordInterface
namespace YourVendor;

class YourClass { }
{
	/**
	 * @var string
	 */
	private $sHost = '';

	/**
	 * @var int
	 */
	private $iPost = 2087;

	/**
	 * @var bool
	 */
	private $bSsl = true;

	/**
	 * @var string
	 */
	private $sUser = '';

	/**
	 * @var string
	 */
	private $sPassword = '';

	/**
	 * @var string
	 */
	private $sAllowedEmails = '';

	/**
	 * @var \MailSo\Log\Logger
	 */
	private $oLogger = null;

	/**
	 * @param string $sHost
	 * @param int $iPost
	 * @param bool $bSsl
	 * @param string $sUser
	 * @param string $sPassword
	 *
	 * @return \CpanelChangePasswordDriver
	 */
	public function SetConfig($sHost, $iPost, $bSsl, $sUser, $sPassword)
	{
		$this->sHost = $sHost;
		$this->iPost = $iPost;
		$this->bSsl = !!$bSsl;
		$this->sUser = $sUser;
		$this->sPassword = $sPassword;

		return $this;
	}

	/**
	 * @param string $sAllowedEmails
	 *
	 * @return \CpanelChangePasswordDriver
	 */
	public function SetAllowedEmails($sAllowedEmails)
	{
		$this->sAllowedEmails = $sAllowedEmails;
		return $this;
	}

	/**
	 * @param \MailSo\Log\Logger $oLogger
	 *
	 * @return \CpanelChangePasswordDriver
	 */
	public function SetLogger($oLogger)
	{
		if ($oLogger instanceof \MailSo\Log\Logger)
if ($x instanceof DoesNotExist) {
    // Do something.
}
		{
			$this->oLogger = $oLogger;
		}

		return $this;
	}

	/**
	 * @param \RainLoop\Model\Account $oAccount
	 *
	 * @return bool
	 */
	public function PasswordChangePossibility($oAccount)
	{
		return $oAccount && $oAccount->Email() &&
			\RainLoop\Plugins\Helper::ValidateWildcardValues($oAccount->Email(), $this->sAllowedEmails);
	}

	/**
	 * @param \RainLoop\Model\Account $oAccount
	 * @param string $sPrevPassword
	 * @param string $sNewPassword
	 *
	 * @return bool
	 */
	public function ChangePassword(\RainLoop\Account $oAccount, $sPrevPassword, $sNewPassword)
	{
		if ($this->oLogger)
		{
			$this->oLogger->Write('Try to change password for '.$oAccount->Email());
		}

		if (!\class_exists('xmlapi'))
		{
			include_once __DIR__.'/xmlapi.php';
		}

		$bResult = false;
		if (!empty($this->sHost) && 0 < $this->iPost &&
			0 < \strlen($this->sUser) && 0 < \strlen($this->sPassword) &&
			$oAccount && \class_exists('xmlapi'))
		{
			$sEmail = $oAccount->Email();
			$sEmailUser = \MailSo\Base\Utils::GetAccountNameFromEmail($sEmail);
			$sEmailDomain = \MailSo\Base\Utils::GetDomainFromEmail($sEmail);

			$sHost = $this->sHost;
			$sHost = \str_replace('{user:domain}', $sEmailDomain, $sHost);

			$sUser = $this->sUser;
			$sUser = \str_replace('{user:email}', $sEmail, $sUser);
			$sUser = \str_replace('{user:login}', $sEmailUser, $sUser);

			$sPassword = $this->sPassword;
			$sPassword = \str_replace('{user:password}', $oAccount->Password(), $sPassword);

			try
			{
				$oXmlApi = new \xmlapi($sHost);
				$oXmlApi->set_port($this->iPost);
				$oXmlApi->set_protocol($this->bSsl ? 'https' : 'http');
				$oXmlApi->set_debug(false);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				$oXmlApi->set_output('json');
//				$oXmlApi->set_http_client('fopen');

				$oXmlApi->set_http_client('curl');
				$oXmlApi->password_auth($sUser, $sPassword);

				$aArgs = array(
					'email' => $sEmailUser,
					'domain' => $sEmailDomain,
					'password' => $sNewPassword
				);

				$sResult = $oXmlApi->api2_query($sUser, 'Email', 'passwdpop', $aArgs);
				if ($sResult)
				{
					if ($this->oLogger)
					{
						$this->oLogger->Write('CPANEL: '.$sResult, \MailSo\Log\Enumerations\Type::INFO);
					}

					$aResult = @\json_decode($sResult, true);
					$bResult = isset($aResult['cpanelresult']['data'][0]['result']) &&
						!!$aResult['cpanelresult']['data'][0]['result'];
				}

				if (!$bResult && $this->oLogger)
				{
					$this->oLogger->Write('CPANEL: '.$sResult, \MailSo\Log\Enumerations\Type::ERROR);
				}
			}
			catch (\Exception $oException)
			{
				if ($this->oLogger)
				{
					$this->oLogger->WriteException($oException);
				}
			}
		}
		else
		{
			if ($this->oLogger)
			{
				$this->oLogger->Write('CPANEL: Incorrent configuration data', \MailSo\Log\Enumerations\Type::ERROR);
			}
		}

		return $bResult;
	}
}

1			<?php
2
3			class CpanelChangePasswordDriver implements \RainLoop\Providers\ChangePassword\ChangePasswordInterface
			0 ignored issues – show Coding Style Compatibility introduced 2017-10-06 18:56 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
4			{
5			/**
6			* @var string
7			*/
8			private $sHost = '';
9
10			/**
11			* @var int
12			*/
13			private $iPost = 2087;
14
15			/**
16			* @var bool
17			*/
18			private $bSsl = true;
19
20			/**
21			* @var string
22			*/
23			private $sUser = '';
24
25			/**
26			* @var string
27			*/
28			private $sPassword = '';
29
30			/**
31			* @var string
32			*/
33			private $sAllowedEmails = '';
34
35			/**
36			* @var \MailSo\Log\Logger
37			*/
38			private $oLogger = null;
39
40			/**
41			* @param string $sHost
42			* @param int $iPost
43			* @param bool $bSsl
44			* @param string $sUser
45			* @param string $sPassword
46			*
47			* @return \CpanelChangePasswordDriver
48			*/
49			public function SetConfig($sHost, $iPost, $bSsl, $sUser, $sPassword)
50			{
51			$this->sHost = $sHost;
52			$this->iPost = $iPost;
53			$this->bSsl = !!$bSsl;
54			$this->sUser = $sUser;
55			$this->sPassword = $sPassword;
56
57			return $this;
58			}
59
60			/**
61			* @param string $sAllowedEmails
62			*
63			* @return \CpanelChangePasswordDriver
64			*/
65			public function SetAllowedEmails($sAllowedEmails)
66			{
67			$this->sAllowedEmails = $sAllowedEmails;
68			return $this;
69			}
70
71			/**
72			* @param \MailSo\Log\Logger $oLogger
73			*
74			* @return \CpanelChangePasswordDriver
75			*/
76			public function SetLogger($oLogger)
77			{
78			if ($oLogger instanceof \MailSo\Log\Logger)
			0 ignored issues – show Bug introduced 2017-10-06 18:56 UTC by Report Bug Copy Issue Report The class `MailSo\Log\Logger` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
79			{
80			$this->oLogger = $oLogger;
81			}
82
83			return $this;
84			}
85
86			/**
87			* @param \RainLoop\Model\Account $oAccount
88			*
89			* @return bool
90			*/
91			public function PasswordChangePossibility($oAccount)
92			{
93			return $oAccount && $oAccount->Email() &&
94			\RainLoop\Plugins\Helper::ValidateWildcardValues($oAccount->Email(), $this->sAllowedEmails);
95			}
96
97			/**
98			* @param \RainLoop\Model\Account $oAccount
99			* @param string $sPrevPassword
100			* @param string $sNewPassword
101			*
102			* @return bool
103			*/
104			public function ChangePassword(\RainLoop\Account $oAccount, $sPrevPassword, $sNewPassword)
105			{
106			if ($this->oLogger)
107			{
108			$this->oLogger->Write('Try to change password for '.$oAccount->Email());
109			}
110
111			if (!\class_exists('xmlapi'))
112			{
113			include_once __DIR__.'/xmlapi.php';
114			}
115
116			$bResult = false;
117			if (!empty($this->sHost) && 0 < $this->iPost &&
118			0 < \strlen($this->sUser) && 0 < \strlen($this->sPassword) &&
119			$oAccount && \class_exists('xmlapi'))
120			{
121			$sEmail = $oAccount->Email();
122			$sEmailUser = \MailSo\Base\Utils::GetAccountNameFromEmail($sEmail);
123			$sEmailDomain = \MailSo\Base\Utils::GetDomainFromEmail($sEmail);
124
125			$sHost = $this->sHost;
126			$sHost = \str_replace('{user:domain}', $sEmailDomain, $sHost);
127
128			$sUser = $this->sUser;
129			$sUser = \str_replace('{user:email}', $sEmail, $sUser);
130			$sUser = \str_replace('{user:login}', $sEmailUser, $sUser);
131
132			$sPassword = $this->sPassword;
133			$sPassword = \str_replace('{user:password}', $oAccount->Password(), $sPassword);
134
135			try
136			{
137			$oXmlApi = new \xmlapi($sHost);
138			$oXmlApi->set_port($this->iPost);
139			$oXmlApi->set_protocol($this->bSsl ? 'https' : 'http');
140			$oXmlApi->set_debug(false);
			0 ignored issues – show Documentation introduced 2017-10-06 18:56 UTC by Report Bug Copy Issue Report `false` is of type `boolean`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
141			$oXmlApi->set_output('json');
142			// $oXmlApi->set_http_client('fopen');
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-10-06 18:56 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
143			$oXmlApi->set_http_client('curl');
144			$oXmlApi->password_auth($sUser, $sPassword);
145
146			$aArgs = array(
147			'email' => $sEmailUser,
148			'domain' => $sEmailDomain,
149			'password' => $sNewPassword
150			);
151
152			$sResult = $oXmlApi->api2_query($sUser, 'Email', 'passwdpop', $aArgs);
153			if ($sResult)
154			{
155			if ($this->oLogger)
156			{
157			$this->oLogger->Write('CPANEL: '.$sResult, \MailSo\Log\Enumerations\Type::INFO);
158			}
159
160			$aResult = @\json_decode($sResult, true);
161			$bResult = isset($aResult['cpanelresult']['data'][0]['result']) &&
162			!!$aResult['cpanelresult']['data'][0]['result'];
163			}
164
165			if (!$bResult && $this->oLogger)
166			{
167			$this->oLogger->Write('CPANEL: '.$sResult, \MailSo\Log\Enumerations\Type::ERROR);
168			}
169			}
170			catch (\Exception $oException)
171			{
172			if ($this->oLogger)
173			{
174			$this->oLogger->WriteException($oException);
175			}
176			}
177			}
178			else
179			{
180			if ($this->oLogger)
181			{
182			$this->oLogger->Write('CPANEL: Incorrent configuration data', \MailSo\Log\Enumerations\Type::ERROR);
183			}
184			}
185
186			return $bResult;
187			}
188			}

RainLoop / rainloop-webmail

Push — master ( 71718d...90a3d2 )

CpanelChangePasswordDriver::ChangePassword() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like