Add CustomSMS a generic provider #473
+336
−1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @author Daif Alazmi <[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\Service\Gateway\SMS\Provider; | ||
|
|
||
| use Exception; | ||
| use OCA\TwoFactorGateway\Exception\SmsTransmissionException; | ||
| use OCP\Http\Client\IClient; | ||
| use OCP\Http\Client\IClientService; | ||
|
|
||
| class CustomSMS implements IProvider { | ||
| public const PROVIDER_ID = 'customsms'; | ||
|
|
||
| /** @var IClient */ | ||
| private $client; | ||
|
|
||
| /** @var CustomSMSConfig */ | ||
| private $config; | ||
|
|
||
| public function __construct(IClientService $clientService, | ||
| CustomSMSConfig $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(); | ||
|
|
||
| try { | ||
|
|
||
| if(strtolower($config->getMethod()) == 'get') | ||
| { | ||
| $options = [ | ||
| 'query'=> [ | ||
| $config->getIdentifier()=>$identifier, | ||
| $config->getMessage()=>$message, | ||
| ] | ||
| ]; | ||
| parse_str($config->getHeaders(), $headers); | ||
| if(!empty($headers)) | ||
| { | ||
| $options['headers'] = $headers; | ||
| } | ||
| parse_str($config->getParameters(), $parameters); | ||
| if(!empty($parameters)) | ||
| { | ||
| $options['query'] = $options['query'] + $parameters; | ||
| } | ||
| $response = $this->client->get($config->getUrl(),$options); | ||
| } | ||
|
|
||
| if(strtolower($config->getMethod()) == 'post') | ||
| { | ||
| $options = [ | ||
| 'body'=> [ | ||
| $config->getIdentifier()=>$identifier, | ||
| $config->getMessage()=>$message, | ||
| ] | ||
| ]; | ||
| parse_str($config->getHeaders(), $headers); | ||
| if(!empty($headers)) | ||
| { | ||
| $options['headers'] = $headers; | ||
| } | ||
| parse_str($config->getParameters(), $parameters); | ||
| if(!empty($parameters)) | ||
| { | ||
| $options['body'] = $options['body'] + $parameters; | ||
| } | ||
| $this->client->post($config->getUrl(),$options); | ||
| } | ||
|
|
||
| } catch (Exception $ex) { | ||
| throw new SmsTransmissionException(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return CustomSMSConfig | ||
| */ | ||
| public function getConfig(): IProviderConfig { | ||
| return $this->config; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @author Daif Alazmi <[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\Service\Gateway\SMS\Provider; | ||
|
|
||
| use function array_intersect; | ||
| use OCA\TwoFactorGateway\AppInfo\Application; | ||
| use OCA\TwoFactorGateway\Exception\ConfigurationException; | ||
| use OCP\IConfig; | ||
|
|
||
| class CustomSMSConfig implements IProviderConfig { | ||
|
|
||
| const expected = [ | ||
| 'customsms_url', | ||
| 'customsms_method', | ||
| 'customsms_identifier', | ||
| 'customsms_message', | ||
| 'customsms_headers', | ||
| 'customsms_parameters', | ||
| ]; | ||
|
|
||
| /** @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('customsms_url'); | ||
| } | ||
|
|
||
| public function setUrl(string $url) { | ||
| $this->config->setAppValue(Application::APP_NAME, 'customsms_url', $url); | ||
| } | ||
|
|
||
| public function getMethod(): string { | ||
| return $this->getOrFail('customsms_method'); | ||
| } | ||
|
|
||
| public function setMethod(string $method) { | ||
| $this->config->setAppValue(Application::APP_NAME, 'customsms_method', $method); | ||
| } | ||
|
|
||
| public function getIdentifier(): string { | ||
| return $this->getOrFail('customsms_identifier'); | ||
| } | ||
|
|
||
| public function setIdentifier(string $identifier) { | ||
| $this->config->setAppValue(Application::APP_NAME, 'customsms_identifier', $identifier); | ||
| } | ||
|
|
||
| public function getMessage(): string { | ||
| return $this->getOrFail('customsms_message'); | ||
| } | ||
|
|
||
| public function setMessage(string $message) { | ||
| $this->config->setAppValue(Application::APP_NAME, 'customsms_message', $message); | ||
| } | ||
|
|
||
| public function getHeaders(): string { | ||
| return $this->getOrFail('customsms_headers'); | ||
| } | ||
|
|
||
| public function setHeaders(string $headers) { | ||
| $this->config->setAppValue(Application::APP_NAME, 'customsms_headers', $headers); | ||
| } | ||
|
|
||
| public function getParameters(): string { | ||
| return $this->getOrFail('customsms_parameters'); | ||
| } | ||
|
|
||
| public function setParameters(string $parameters) { | ||
| $this->config->setAppValue(Application::APP_NAME, 'customsms_parameters', $parameters); | ||
| } | ||
|
|
||
| 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); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that will be good implement examples of supported API payload with GET and POST.
For example:
Provider with GET:
Need accept URL on this format:
<base_url_provider>?<mobile_number_parameter>=<number> ....Provider with POST:
...
Mandatory parameters: