Merge pull request #457 from bosdla/master

Adding sms provider SMSGlobal

6 files changed, 210 insertions, 1 deletions

diff --git a/doc/Admin Documentation.md b/doc/Admin Documentation.md
index 62cb0c3..47e24da 100644
--- a/doc/Admin Documentation.md
+++ b/doc/Admin Documentation.md
@@ -15,6 +15,17 @@ Interactive admin configuration:
 occ twofactorauth:gateway:configure sms
 ```
 
+### SMSGlobal 
+URL: https://www.smsglobal.com/
+Stability: Experimental
+
+Use the Webservices provided by SMSGlobal for sending SMS.
+
+Interactive admin configuration:
+```bash
+occ twofactorauth:gateway:configure sms
+```
+
 ### Signal
 URL: https://www.signal.org/
 Stability: Experimental
diff --git a/doc/User Documentation.md b/doc/User Documentation.md
index 16137b1..c47e95a 100644
--- a/doc/User Documentation.md
+++ b/doc/User Documentation.md
@@ -10,6 +10,12 @@ Stability: Experimental
 
 Use the Webservices provided by playSMS for sending SMS.
 
+### SMSGlobal 
+URL: https://www.smsglobal.com
+Stability: Experimental
+
+Use the Webservices provided by SMSGlobal for sending SMS.
+
 ### Signal
 URL: https://www.signal.org/
 Stability: Experimental
diff --git a/lib/Command/Configure.php b/lib/Command/Configure.php
index c963018..a67a203 100644
--- a/lib/Command/Configure.php
+++ b/lib/Command/Configure.php
@@ -32,6 +32,7 @@ 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;
@@ -112,7 +113,7 @@ class Configure extends Command {
 	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, clicksend, serwersms): ', 'websms');
+		$providerQuestion = new Question('Please choose a SMS provider (sipgate, websms, playsms, clockworksms, puzzelsms, ecallsms, voipms, voipbuster, huawei_e3531, spryng, sms77io, ovh, clickatellcentral, clicksend, serwersms, smsglobal): ', 'websms');
 		$provider = $helper->ask($input, $output, $providerQuestion);
 
 		/** @var SMSConfig $config */
@@ -354,6 +355,24 @@ class Configure extends Command {
 				$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);
diff --git a/lib/Service/Gateway/SMS/Provider/ProviderFactory.php b/lib/Service/Gateway/SMS/Provider/ProviderFactory.php
index 7aaf939..b886284 100644
--- a/lib/Service/Gateway/SMS/Provider/ProviderFactory.php
+++ b/lib/Service/Gateway/SMS/Provider/ProviderFactory.php
@@ -43,6 +43,8 @@ class ProviderFactory {
 				return $this->container->query(PuzzelSMS::class);
 			case PlaySMS::PROVIDER_ID:
 				return $this->container->query(PlaySMS::class);
+			case SMSGlobal::PROVIDER_ID:
+				return $this->container->query(SMSGlobal::class);
 			case WebSms::PROVIDER_ID:
 				return $this->container->query(WebSms::class);
 			case ClockworkSMS::PROVIDER_ID:
diff --git a/lib/Service/Gateway/SMS/Provider/SMSGlobal.php b/lib/Service/Gateway/SMS/Provider/SMSGlobal.php
new file mode 100644
index 0000000..5543b29
--- /dev/null
+++ b/lib/Service/Gateway/SMS/Provider/SMSGlobal.php
@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @author Bosdla
+ *
+ * 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\Service\Gateway\SMS\Provider;
+
+use Exception;
+use OCA\TwoFactorGateway\Exception\SmsTransmissionException;
+use OCP\Http\Client\IClient;
+use OCP\Http\Client\IClientService;
+
+class SMSGlobal implements IProvider {
+	public const PROVIDER_ID = 'smsglobal';
+
+	/** @var IClient */
+	private $client;
+
+	/** @var SMSGlobalConfig */
+	private $config;
+
+	public function __construct(IClientService $clientService,
+								SMSGlobalConfig $config) {
+		$this->client = $clientService->newClient();
+		$this->config = $config;
+	}
+
+	/**
+	 * @param string $identifier
+	 * @param string $message
+	 *
+	 * @throws SmsTransmissionException
+	 */
+	public function send(string $identifier, string $message) {
+		$config = $this->getConfig();
+		$to = str_replace("+", "", $identifier);
+
+		try {
+			$this->client->get(
+				$config->getUrl(),
+				[
+					'query' => [
+						'action' => 'sendsms',
+						'user' => $config->getUser(),
+						'password' => $config->getPassword(),
+						'origin' => 'nextcloud',
+						'from' => 'nextcloud',
+						'to' => $to,
+						'text' => $message,
+						'clientcharset' => 'UTF-8',
+						'detectcharset' => 1
+					],
+				]
+			);
+		} catch (Exception $ex) {
+			throw new SmsTransmissionException();
+		}
+	}
+
+	/**
+	 * @return SMSGlobalConfig
+	 */
+	public function getConfig(): IProviderConfig {
+		return $this->config;
+	}
+}
diff --git a/lib/Service/Gateway/SMS/Provider/SMSGlobalConfig.php b/lib/Service/Gateway/SMS/Provider/SMSGlobalConfig.php
new file mode 100644
index 0000000..597df28
--- /dev/null
+++ b/lib/Service/Gateway/SMS/Provider/SMSGlobalConfig.php
@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @author Bosdla
+ *
+ * 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\Service\Gateway\SMS\Provider;
+
+use function array_intersect;
+use OCA\TwoFactorGateway\AppInfo\Application;
+use OCA\TwoFactorGateway\Exception\ConfigurationException;
+use OCP\IConfig;
+
+class SMSGlobalConfig implements IProviderConfig {
+	private const expected = [
+		'smsglobal_url',
+		'smsglobal_user',
+		'smsglobal_password',
+	];
+
+	/** @var IConfig */
+	private $config;
+
+	public function __construct(IConfig $config) {
+		$this->config = $config;
+	}
+
+	private function getOrFail(string $key): string {
+		$val = $this->config->getAppValue(Application::APP_NAME, $key, null);
+		if (is_null($val)) {
+			throw new ConfigurationException();
+		}
+		return $val;
+	}
+
+	public function getUrl(): string {
+		return $this->getOrFail('smsglobal_url');
+	}
+
+	public function setUrl(string $url) {
+		$this->config->setAppValue(Application::APP_NAME, 'smsglobal_url', $url);
+	}
+
+	public function getUser(): string {
+		return $this->getOrFail('smsglobal_user');
+	}
+
+	public function setUser(string $user) {
+		$this->config->setAppValue(Application::APP_NAME, 'smsglobal_user', $user);
+	}
+
+	public function getPassword(): string {
+		return $this->getOrFail('smsglobal_password');
+	}
+
+	public function setPassword(string $password) {
+		$this->config->setAppValue(Application::APP_NAME, 'smsglobal_password', $password);
+	}
+
+	public function isComplete(): bool {
+		$set = $this->config->getAppKeys(Application::APP_NAME);
+		return count(array_intersect($set, self::expected)) === count(self::expected);
+	}
+
+	public function remove() {
+		foreach (self::expected as $key) {
+			$this->config->deleteAppValue(Application::APP_NAME, $key);
+		}
+	}
+}