From 74a85abddfb84b5e2a2cb64f5318d8d0d6d3c8c6 Mon Sep 17 00:00:00 2001
From: osaajani <>
Date: Fri, 3 Apr 2020 03:46:58 +0200
Subject: [PATCH] create octopush variation for virtualnumber
---
adapters/OctopushVirtualNumberAdapter.php | 426 ++++++++++++++++++++++
1 file changed, 426 insertions(+)
create mode 100644 adapters/OctopushVirtualNumberAdapter.php
diff --git a/adapters/OctopushVirtualNumberAdapter.php b/adapters/OctopushVirtualNumberAdapter.php
new file mode 100644
index 0000000..41998c6
--- /dev/null
+++ b/adapters/OctopushVirtualNumberAdapter.php
@@ -0,0 +1,426 @@
+
+ *
+ * This source file is subject to the GPL-3.0 license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace adapters;
+
+/**
+ * Octopush SMS service with a shortcode adapter
+ */
+class OctopushVirtualNumberAdapter implements AdapterInterface
+{
+ const ERROR_CODE_OK = '000';
+ const SMS_TYPE_LOWCOST = 'XXX';
+ const SMS_TYPE_PREMIUM = 'FR';
+ const SMS_TYPE_INTERNATIONAL = 'WWW';
+
+ /**
+ * Datas used to configure interaction with the implemented service. (e.g : Api credentials, ports numbers, etc.).
+ */
+ private $datas;
+
+ /**
+ * Octopush login
+ */
+ private $login;
+
+ /**
+ * Octopush api key
+ */
+ private $api_key;
+
+ /**
+ * Number phone to use
+ */
+ private $number;
+
+ /**
+ * Number phone to use formated for octopush compatibility
+ */
+ private $formatted_number;
+
+ /**
+ * Octopush api baseurl
+ */
+ private $api_url = 'https://www.octopush-dm.com/api';
+
+ /**
+ * Adapter constructor, called when instanciated by RaspiSMS.
+ *
+ * @param string $number : Phone number the adapter is used for
+ * @param json string $datas : JSON string of the datas to configure interaction with the implemented service
+ */
+ public function __construct(string $datas)
+ {
+ $this->datas = json_decode($datas, true);
+
+ $this->login = $this->datas['login'];
+ $this->api_key = $this->datas['api_key'];
+ $this->number = $this->datas['number'];
+ $this->formatted_number = '+' . mb_substr($this->datas['number'], 2);
+ }
+
+ /**
+ * Classname of the adapter.
+ */
+ public static function meta_classname(): string
+ {
+ return __CLASS__;
+ }
+
+
+ /**
+ * Uniq name of the adapter
+ * It should be the classname of the adapter un snakecase
+ */
+ public static function meta_uid() : string
+ {
+ return 'octopush_virtual_number_adapter';
+ }
+
+ /**
+ * Name of the adapter.
+ * It should probably be the name of the service it adapt (e.g : Gammu SMSD, OVH SMS, SIM800L, etc.).
+ */
+ public static function meta_name(): string
+ {
+ return 'Octopush Numéro virtuel';
+ }
+
+ /**
+ * Description of the adapter.
+ * A short description of the service the adapter implements.
+ */
+ public static function meta_description(): string
+ {
+ $credentials_url = 'https://www.octopush-dm.com/api-logins';
+ return '
+ Envoi de SMS avec un numéro virtuel en utilisant Octopush. Pour trouver vos clés API Octopush cliquez ici.
+ ';
+ }
+
+ /**
+ * List of entries we want in datas for the adapter.
+ *
+ * @return array : Every line is a field as an array with keys : name, title, description, required
+ */
+ public static function meta_datas_fields(): array
+ {
+ return [
+ [
+ 'name' => 'login',
+ 'title' => 'Octopush Login',
+ 'description' => 'Login du compte Octopush à employer. Trouvable sur la page des identifiants API Octopush.',
+ 'required' => true,
+ ],
+ [
+ 'name' => 'api_key',
+ 'title' => 'API Key',
+ 'description' => 'Clef API octopush. Trouvable sur la page des identifiants API Octopush.',
+ 'required' => true,
+ ],
+ [
+ 'name' => 'number',
+ 'title' => 'Numéro de téléphone virtuel',
+ 'description' => 'Numéro de téléphone virtuel Octopush à utiliser.',
+ 'required' => true,
+ 'number' => true,
+ ],
+
+ ];
+ }
+
+ /**
+ * Does the implemented service support reading smss.
+ */
+ public static function meta_support_read(): bool
+ {
+ return false;
+ }
+
+ /**
+ * Does the implemented service support flash smss.
+ */
+ public static function meta_support_flash(): bool
+ {
+ return false;
+ }
+
+ /**
+ * Does the implemented service support status change.
+ */
+ public static function meta_support_status_change(): bool
+ {
+ return true;
+ }
+
+ /**
+ * Does the implemented service support reception callback.
+ */
+ public static function meta_support_reception(): bool
+ {
+ return true;
+ }
+
+ /**
+ * Method called to send a SMS to a number.
+ *
+ * @param string $destination : Phone number to send the sms to
+ * @param string $text : Text of the SMS to send
+ * @param bool $flash : Is the SMS a Flash SMS
+ *
+ * @return array : [
+ * bool 'error' => false if no error, true else
+ * ?string 'error_message' => null if no error, else error message
+ * array 'uid' => Uid of the sms created on success
+ * ]
+ */
+ public function send(string $destination, string $text, bool $flash = false)
+ {
+ $response = [
+ 'error' => false,
+ 'error_message' => null,
+ 'uid' => null,
+ ];
+
+ try
+ {
+ $datas = [
+ 'user_login' => $this->login,
+ 'api_key' => $this->api_key,
+ 'sms_text' => $text,
+ 'sms_recipients' => str_replace('+', '00', $destination), //Must use 00 instead of + notation
+ 'sms_sender' => $this->formatted_number,
+ 'sms_type' => self::SMS_TYPE_LOWCOST,
+ ];
+
+ if ($this->sender !== null)
+ {
+ $datas['sms_sender'] = $this->sender;
+ }
+
+ $endpoint = $this->api_url . '/sms/json';
+
+ $curl = curl_init();
+ curl_setopt($curl, CURLOPT_URL, $endpoint);
+ curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
+ curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
+ curl_setopt($curl, CURLOPT_POST, true);
+ curl_setopt($curl, CURLOPT_POSTFIELDS, $datas);
+ $response = curl_exec($curl);
+ curl_close($curl);
+
+ if ($response === false)
+ {
+ $response['error'] = true;
+ $response['error_message'] = 'HTTP query failed.';
+ return $response;
+ }
+
+ $response_decode = json_decode($response, true);
+ if ($response_decode === null)
+ {
+ $response['error'] = true;
+ $response['error_message'] = 'Invalid JSON for response.';
+ return $response;
+ }
+
+ if ($response_decode['error_code'] != self::ERROR_CODE_OK)
+ {
+ $response['error'] = true;
+ $response['error_message'] = 'Response indicate error code : ' . $response_decode['error_code'];
+ return $response;
+ }
+
+ $uid = $response_decode['ticket'] ?? false;
+ if (!$uid)
+ {
+ $response['error'] = true;
+ $response['error_message'] = 'Cannot extract SMS uid';
+ return $response;
+ }
+
+ $response['uid'] = $uid;
+ return $response;
+ }
+ catch (\Throwable $t)
+ {
+ $response['error'] = true;
+ $response['error_message'] = $t->getMessage();
+ return $response;
+ }
+ }
+
+ /**
+ * Method called to read SMSs of the number.
+ *
+ * @return array : [
+ * bool 'error' => false if no error, true else
+ * ?string 'error_message' => null if no error, else error message
+ * array 'sms' => Array of the sms reads
+ * ]
+ */
+ public function read(): array
+ {
+ return [];
+ }
+
+ /**
+ * Method called to verify if the adapter is working correctly
+ * should be use for exemple to verify that credentials and number are both valid.
+ *
+ * @return bool : False on error, true else
+ */
+ public function test(): bool
+ {
+ try
+ {
+ $success = true;
+
+ if ($this->datas['sender'] && (mb_strlen($this->datas['sender']) < 3 || mb_strlen($this->datas['sender'] > 11)))
+ {
+ return false;
+ }
+
+ $datas = [
+ 'user_login' => $this->login,
+ 'api_key' => $this->api_key,
+ ];
+
+ //Check service name
+ $endpoint = $this->api_url . '/balance/json';
+ $curl = curl_init();
+ curl_setopt($curl, CURLOPT_URL, $endpoint);
+ curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
+ curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
+ curl_setopt($curl, CURLOPT_POST, true);
+ curl_setopt($curl, CURLOPT_POSTFIELDS, $datas);
+ $response = curl_exec($curl);
+ curl_close($curl);
+
+ if ($response === false)
+ {
+ return false;
+ }
+
+ $response_decode = json_decode($response, true);
+ if ($response_decode === null)
+ {
+ return false;
+ }
+
+ if ($response_decode['error_code'] != self::ERROR_CODE_OK)
+ {
+ return false;
+ }
+
+ return true;
+ }
+ catch (\Throwable $t)
+ {
+ return false;
+ }
+ }
+
+ /**
+ * Method called on reception of a status update notification for a SMS.
+ *
+ * @return mixed : False on error, else array ['uid' => uid of the sms, 'status' => New status of the sms (\models\Sended::STATUS_UNKNOWN, \models\Sended::STATUS_DELIVERED, \models\Sended::STATUS_FAILED)]
+ */
+ public static function status_change_callback()
+ {
+ header('Connection: close');
+ header('Content-Encoding: none');
+ header('Content-Length: 0');
+
+ $uid = $_POST['message_id'] ?? false;
+ $status = $_POST['status'] ?? false;
+
+ if ($uid === false || $status === false)
+ {
+ return false;
+ }
+
+ switch ($status)
+ {
+ case 'DELIVERED':
+ $status = \models\Sended::STATUS_DELIVERED;
+ break;
+
+ case 'NOT_ALLOWED':
+ case 'INVALID_DESTINATION_ADDRESS':
+ case 'OUT_OF_DATE':
+ case 'EXPIRED':
+ case 'BLACKLISTED_NUMBER':
+ $status = \models\Sended::STATUS_FAILED;
+ break;
+
+ default :
+ $status = \models\Sended::STATUS_UNKNOWN;
+ break;
+ }
+
+ return ['uid' => $uid, 'status' => $status];
+ }
+
+
+ /**
+ * Method called on reception of a sms notification.
+ *
+ * @return array : [
+ * bool 'error' => false on success, true on error
+ * ?string 'error_message' => null on success, error message else
+ * array 'sms' => array [
+ * string 'at' : Recepetion date format Y-m-d H:i:s,
+ * string 'text' : SMS body,
+ * string 'origin' : SMS sender,
+ * ]
+ *
+ * ]
+ */
+ public static function reception_callback() : array
+ {
+ $response = [
+ 'error' => false,
+ 'error_message' => null,
+ 'uid' => null,
+ ];
+
+ header('Connection: close');
+ header('Content-Encoding: none');
+ header('Content-Length: 0');
+
+ $number = $_POST['number'] ?? false;
+ $text = $_POST['text'] ?? false;
+ $at = $_POST['reception_date'] ?? false;
+
+ if (!$number || !$text || !$at)
+ {
+ $response['error'] = true;
+ $response['error_message'] = 'One required data of the callback is missing.';
+ return $response;
+ }
+
+ $origin = \controllers\internals\Tool::parse_phone('+' . mb_substr($number, 2));
+ if (!$origin)
+ {
+ $response['error'] = true;
+ $response['error_message'] = 'Invalid origin number : ' . mb_substr($number, 2);
+ return $response;
+ }
+
+ $response['sms'] = [
+ 'at' => $at,
+ 'text' => $text,
+ 'origin' => $origin,
+ ];
+ return $response;
+ }
+}