Configure::configureSms() - Code Metrics - Inspection of "Add XMPP Gateway" - nextcloud/twofactor_gateway - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#552)

unknown
created 2023-03-13 18:19 UTC
Configure::configureSms() F

↳ Parent: Configure
Complexity

Conditions	20
Paths	20
Size

Total Lines	318
Code Lines	223
Duplication

Lines	0
Ratio	0 %
Importance

Changes	6
Bugs	2	Features	1
Metric	Value
eloc	223
c	6
b	2
f	1
dl	0
loc	318
rs	3.3333
cc	20
nc	20
nop	2
How to fix Long Method Complexity

<?php

declare(strict_types=1);

/**
 * @author Christoph Wurst <[email protected]>
 *
 * Nextcloud - Two-factor Gateway
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\TwoFactorGateway\Command;

use OCA\TwoFactorGateway\Service\Gateway\IGateway;
use OCA\TwoFactorGateway\Service\Gateway\Signal\Gateway as SignalGateway;
use OCA\TwoFactorGateway\Service\Gateway\Signal\GatewayConfig as SignalConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Gateway as SMSGateway;
use OCA\TwoFactorGateway\Service\Gateway\SMS\GatewayConfig as SMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\ClickSendConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\ClockworkSMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\EcallSMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\PlaySMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\SMSGlobalConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\Sms77IoConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\OvhConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\WebSmsConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\SipGateConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\PuzzelSMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\HuaweiE3531Config;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\SpryngSMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\ClickatellCentralConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\ClickatellPortalConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\VoipbusterConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\SerwerSMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\Telegram\Gateway as TelegramGateway;
use OCA\TwoFactorGateway\Service\Gateway\Telegram\GatewayConfig as TelegramConfig;
use OCA\TwoFactorGateway\Service\Gateway\XMPP\Gateway as XMPPGateway;
use OCA\TwoFactorGateway\Service\Gateway\XMPP\GatewayConfig as XMPPConfig;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\Question;

class Configure extends Command {

	/** @var SignalGateway */
	private $signalGateway;

	/** @var SMSGateway */
	private $smsGateway;

	/** @var TelegramGateway */
	private $telegramGateway;

	/** @var XMPPGateway */
	private $xmppGateway;

	public function __construct(SignalGateway $signalGateway,
								SMSGateway $smsGateway,
								TelegramGateway $telegramGateway,
								XMPPGateway $xmppGateway) {
		parent::__construct('twofactorauth:gateway:configure');
		$this->signalGateway = $signalGateway;
		$this->smsGateway = $smsGateway;
		$this->telegramGateway = $telegramGateway;
		$this->xmppGateway = $xmppGateway;

		$this->addArgument(
			'gateway',
			InputArgument::REQUIRED,
			'The name of the gateway, e.g. sms, signal, telegram, xmpp, etc.'
		);
	}

	protected function execute(InputInterface $input, OutputInterface $output) {
		$gatewayName = $input->getArgument('gateway');

		/** @var IGateway $gateway */
		$gateway = null;

		switch ($gatewayName) {
			case 'signal':
				$this->configureSignal($input, $output);
				return 0;
			case 'sms':
				$this->configureSms($input, $output);
				return 0;
			case 'telegram':
				$this->configureTelegram($input, $output);
				return 0;
						case 'xmpp':
								$this->configureXMPP($input, $output);
								return 0;
			default:
				$output->writeln("<error>Invalid gateway $gatewayName</error>");
				return;
		}
	}

	private function configureSignal(InputInterface $input, OutputInterface $output) {
		$helper = $this->getHelper('question');
		$urlQuestion = new Question('Please enter the URL of the Signal gateway (leave blank to use default): ', 'http://localhost:5000');
		$url = $helper->ask($input, $output, $urlQuestion);
		$output->writeln("Using $url.");

		/** @var SignalConfig $config */
		$config = $this->signalGateway->getConfig();

		$config->setUrl($url);
	}

	private function configureSms(InputInterface $input, OutputInterface $output) {
		$helper = $this->getHelper('question');

		$providerQuestion = new Question('Please choose a SMS provider (sipgate, websms, playsms, clockworksms, puzzelsms, ecallsms, voipms, voipbuster, huawei_e3531, spryng, sms77io, ovh, clickatellcentral, clickatellportal, clicksend, serwersms, smsglobal, smsapi.com): ', 'websms');
		$provider = $helper->ask($input, $output, $providerQuestion);

		/** @var SMSConfig $config */
		$config = $this->smsGateway->getConfig();
		switch ($provider) {
			case 'websms':
				$config->setProvider($provider);
				/** @var WebSmsConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$usernameQuestion = new Question('Please enter your websms.de username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);
				$passwordQuestion = new Question('Please enter your websms.de password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);
				break;

			case 'sipgate':
				$config->setProvider($provider);
				/** @var SipGateConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$tokenIdQuestion = new Question('Please enter your sipgate token-id: ');
				$tokenId = $helper->ask($input, $output, $tokenIdQuestion);
				$accessTokenQuestion = new Question('Please enter your sipgate access token: ');
				$accessToken = $helper->ask($input, $output, $accessTokenQuestion);
				$webSmsExtensionQuestion = new Question('Please enter your sipgate web-sms extension: ');
				$webSmsExtension = $helper->ask($input, $output, $webSmsExtensionQuestion);

				$providerConfig->setTokenId($tokenId);
				$providerConfig->setAccessToken($accessToken);
				$providerConfig->setWebSmsExtension($webSmsExtension);
				break;

			case 'playsms':
				$config->setProvider($provider);
				/** @var PlaySMSConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$urlQuestion = new Question('Please enter your PlaySMS URL: ');
				$url = $helper->ask($input, $output, $urlQuestion);
				$usernameQuestion = new Question('Please enter your PlaySMS username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);
				$passwordQuestion = new Question('Please enter your PlaySMS password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$providerConfig->setUrl($url);
				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);
				break;

			case 'clockworksms':
				$config->setProvider($provider);
				/** @var ClockworkSMSConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$apitokenQuestion = new Question('Please enter your clockworksms api token: ');
				$apitoken = $helper->ask($input, $output, $apitokenQuestion);

				$providerConfig->setApiToken($apitoken);
				break;

			case 'puzzelsms':
				$config->setProvider($provider);

				/** @var PuzzelSMSConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$urlQuestion = new Question('Please enter your PuzzelSMS URL: ');
				$url = $helper->ask($input, $output, $urlQuestion);

				$usernameQuestion = new Question('Please enter your PuzzelSMS username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);

				$passwordQuestion = new Question('Please enter your PuzzelSMS password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$serviceQuestion = new Question('Please enter your PuzzelSMS service ID: ');
				$serviceId = $helper->ask($input, $output, $serviceQuestion);

				$providerConfig->setUrl($url);
				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);
				$providerConfig->setServiceId($serviceId);
				break;

			case 'ecallsms':
				$config->setProvider($provider);
				/** @var EcallSMSConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$usernameQuestion = new Question('Please enter your eCall.ch username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);
				$passwordQuestion = new Question('Please enter your eCall.ch password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);
				$senderIdQuestion = new Question('Please enter your eCall.ch sender ID: ');
				$senderId = $helper->ask($input, $output, $senderIdQuestion);

				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);
				$providerConfig->setSenderId($senderId);
				break;

			case 'voipms':
				$config->setProvider($provider);

				/** @var VoipMsConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$usernameQuestion = new Question('Please enter your VoIP.ms API username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);

				$passwordQuestion = new Question('Please enter your VoIP.ms API password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$didQuestion = new Question('Please enter your VoIP.ms DID: ');
				$did = $helper->ask($input, $output, $didQuestion);

				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);
				$providerConfig->setDid($did);
				break;

			case 'voipbuster':
				$config->setProvider($provider);

				/** @var VoipbusterConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$usernameQuestion = new Question('Please enter your Voipbuster API username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);

				$passwordQuestion = new Question('Please enter your Voipbuster API password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$didQuestion = new Question('Please enter your Voipbuster DID: ');
				$did = $helper->ask($input, $output, $didQuestion);

				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);
				$providerConfig->setDid($did);
				break;

			case 'huawei_e3531':
				$config->setProvider($provider);
				/** @var HuaweiE3531Config $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$urlQuestion = new Question('Please enter the base URL of the Huawei E3531 stick: ', 'http://192.168.8.1/api');
				$url = $helper->ask($input, $output, $urlQuestion);

				$providerConfig->setUrl($url);
				break;

			case 'spryng':
				$config->setProvider($provider);
				/** @var SpryngSMSConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$apitokenQuestion = new Question('Please enter your Spryng api token: ');
				$apitoken = $helper->ask($input, $output, $apitokenQuestion);

				$providerConfig->setApiToken($apitoken);
				break;

			case 'sms77io':
				$config->setProvider($provider);
				/** @var Sms77IoConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$apiKeyQuestion = new Question('Please enter your sms77.io API key: ');
				$apiKey = $helper->ask($input, $output, $apiKeyQuestion);

				$providerConfig->setApiKey($apiKey);
				break;

			case 'ovh':
				$config->setProvider($provider);

				/** @var OvhConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$endpointQ = new Question('Please enter the endpoint to use (ovh-eu, ovh-us, ovh-ca, soyoustart-eu, soyoustart-ca, kimsufi-eu, kimsufi-ca, runabove-ca): ');
				$endpoint = $helper->ask($input, $output, $endpointQ);

				$appKeyQ = new Question('Please enter your application key: ');
				$appKey = $helper->ask($input, $output, $appKeyQ);

				$appSecretQ = new Question('Please enter your application secret: ');
				$appSecret = $helper->ask($input, $output, $appSecretQ);

				$consumerKeyQ = new Question('Please enter your consumer key: ');
				$consumerKey = $helper->ask($input, $output, $consumerKeyQ);

				$accountQ = new Question('Please enter your account (sms-*****): ');
				$account = $helper->ask($input, $output, $accountQ);

				$senderQ = new Question('Please enter your sender: ');
				$sender = $helper->ask($input, $output, $senderQ);

				$providerConfig->setApplicationKey($appKey);
				$providerConfig->setApplicationSecret($appSecret);
				$providerConfig->setConsumerKey($consumerKey);
				$providerConfig->setEndpoint($endpoint);
				$providerConfig->setAccount($account);
				$providerConfig->setSender($sender);
				break;

			case 'clickatellcentral':
				$config->setProvider($provider);
				/** @var ClickatellCentralConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$apiQuestion = new Question('Please enter your central.clickatell.com API-ID: ');
				$api = $helper->ask($input, $output, $apiQuestion);
				$usernameQuestion = new Question('Please enter your central.clickatell.com username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);
				$passwordQuestion = new Question('Please enter your central.clickatell.com password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$providerConfig->setApi($api);
				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);
				break;

			case 'clickatellportal':
				$config->setProvider($provider);
				/** @var ClickatellPortalConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$apiQuestion = new Question('Please enter your portal.clickatell.com API-Key: ');
				$apiKey = $helper->ask($input, $output, $apiQuestion);
				$fromQuestion = new Question('Please enter your sender number for two-way messaging. Leave it empty for one-way messaging: ');
				$fromNumber = $helper->ask($input, $output, $fromQuestion);

				$providerConfig->setApiKey($apiKey);

				if (empty($fromNumber)) {
					$providerConfig->deleteFromNumber();
				} else {
					$providerConfig->setFromNumber($fromNumber);
				}
				break;

			case 'clicksend':
				$config->setProvider($provider);
				/** @var ClickSendConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$usernameQuestion = new Question('Please enter your clicksend.com username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);
				$apiKeyQuestion = new Question('Please enter your clicksend.com API Key (or, if subuser, the password): ');
				$apiKey = $helper->ask($input, $output, $apiKeyQuestion);

				$providerConfig->setUser($username);
				$providerConfig->setApiKey($apiKey);
				break;

			case 'smsglobal':
				$config->setProvider($provider);
				/** @var SMSGlobalConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$urlproposal = 'https://api.smsglobal.com/http-api.php';
				$urlQuestion = new Question('Please enter your SMSGlobal http-api:', $urlproposal);
				$url = $helper->ask($input, $output, $urlQuestion);
				$usernameQuestion = new Question('Please enter your SMSGlobal username (for http-api):');
				$username = $helper->ask($input, $output, $usernameQuestion);
				$passwordQuestion = new Question('Please enter your SMSGlobal password: (for http-api):');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$providerConfig->setUrl($url);
				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);
				break;

			case 'serwersms':
				$config->setProvider($provider);
				/** @var SerwerSMSConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$loginQuestion = new Question('Please enter your SerwerSMS.pl API login: ');
				$login = $helper->ask($input, $output, $loginQuestion);
				$passwordQuestion = new Question('Please enter your SerwerSMS.pl API password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);
				$senderQuestion = new Question('Please enter your SerwerSMS.pl sender name: ');
				$sender = $helper->ask($input, $output, $senderQuestion);

				$providerConfig->setLogin($login);
				$providerConfig->setPassword($password);
				$providerConfig->setSender($sender);
				break;

			case 'smsapi.com':
				$config->setProvider($provider);
				/** @var SerwerSMSConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$tokenQuestion = new Question('Please enter your SMSApi.com API token: ');
				$token = $helper->ask($input, $output, $tokenQuestion);
				$senderQuestion = new Question('Please enter your SMSApi.com sender name: ');
				$sender = $helper->ask($input, $output, $senderQuestion);

				$providerConfig->setToken($token);
                     setToken($token);
				$providerConfig->setSender($sender);
				break;

			default:
				$output->writeln("Invalid provider $provider");
				break;
		}
		return 0;
	}

	private function configureTelegram(InputInterface $input, OutputInterface $output) {
		$helper = $this->getHelper('question');
		$tokenQuestion = new Question('Please enter your Telegram bot token: ');
		$token = $helper->ask($input, $output, $tokenQuestion);
		$output->writeln("Using $token.");

		/** @var TelegramConfig $config */
		$config = $this->telegramGateway->getConfig();

		$config->setBotToken($token);
	}

	private function configureXMPP(InputInterface $input, OutputInterface $output) {
		$helper = $this->getHelper('question');
		$sender = '';
		while (empty($sender) or substr_count($sender, '@') !== 1):
				  $senderQuestion = new Question('Please enter your sender XMPP-JID: ');
		$sender = $helper->ask($input, $output, $senderQuestion);
		if (empty($sender)) {
			$output->writeln("XMPP-JID must not be empty!");
		} elseif (substr_count($sender, '@') !== 1) {
			$output->writeln("XMPP-JID not valid!");
		} else {
			$username = explode('@', $sender)[0];
		}
		endwhile;
		$output->writeln("Using $sender as XMPP-JID.\nUsing $username as username.");

		$password = '';
		while (empty($password)):
		  $passwordQuestion = new Question('Please enter your sender XMPP password: ');
		$password = $helper->ask($input, $output, $passwordQuestion);
		if (empty($password)) {
			$output->writeln("Password must not be empty!");
		}
		endwhile;
		$output->writeln("Password accepted.");
		$server = '';
		while (empty($server)):
				  $serverQuestion = new Question('Please enter full path to access REST/HTTP API: ');
		$server = $helper->ask($input, $output, $serverQuestion);
		if (empty($server)) {
			$output->writeln("API path must not be empty!");
		}
		endwhile;
		$output->writeln("Using $server as full URL to access REST/HTTP API.");
		$method = 0;
		while (intval($method) < 1 or intval($method) > 2):
		  echo "Please enter 1 or 2 for XMPP sending option:\n";
		echo "(1) prosody with mod_rest\n";
		echo "(2) prosody with mod_post_msg\n";
		$methodQuestion = new Question('Your choice: ');
		$method = $helper->ask($input, $output, $methodQuestion);
		endwhile;
		if ($method === "1") {
			$output->writeln("Using prosody with mod_rest as XMPP sending option.");
		} elseif ($method === "2") {
			$output->writeln("Using prosody with mod_post_msg as XMPP sending option.");
		}
		$output->writeln("XMPP Admin Configuration finished.");

		/** @var XMPPConfig $config */
		$config = $this->xmppGateway->getConfig();

		$config->setSender($sender);
		$config->setPassword($password);
		$config->setServer($server);
		$config->setUsername($username);
		$config->setMethod($method);
	}
}

nextcloud / twofactor_gateway

Pull Request — master (#552)

Configure::configureSms() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
