Mascali
/
raspisms
mirror of https://github.com/RaspbianFrance/raspisms.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Working octopush shortcode

This commit is contained in:
osaajani 2021-06-25 02:04:35 +02:00
parent 017c7fee53
commit 88ebc8042c
3 changed files with 183 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
adapters/OctopushShortcodeAdapter.php
View File

@ -16,10 +16,8 @@ namespace adapters;
*/ */
class OctopushShortcodeAdapter implements AdapterInterface class OctopushShortcodeAdapter implements AdapterInterface
{ {
const ERROR_CODE_OK = '000'; const SMS_TYPE_LOWCOST = 'sms_low_cost';
const SMS_TYPE_LOWCOST = 'XXX'; const SMS_TYPE_PREMIUM = 'sms_premium';
const SMS_TYPE_PREMIUM = 'FR';
const SMS_TYPE_INTERNATIONAL = 'WWW';
/** /**
* Data used to configure interaction with the implemented service. (e.g : Api credentials, ports numbers, etc.). * Data used to configure interaction with the implemented service. (e.g : Api credentials, ports numbers, etc.).
@ -40,11 +38,17 @@ class OctopushShortcodeAdapter implements AdapterInterface
* Sender name to use instead of shortcode. * Sender name to use instead of shortcode.
*/ */
private $sender; private $sender;
/**
* Octopush SMS type
*/
private $sms_type;
/** /**
* Octopush api baseurl. * Octopush api baseurl.
*/ */
private $api_url = 'https://www.octopush-dm.com/api'; private $api_url = 'https://api.octopush.com/v1/public';
/** /**
* Adapter constructor, called when instanciated by RaspiSMS. * Adapter constructor, called when instanciated by RaspiSMS.
@ -58,6 +62,13 @@ class OctopushShortcodeAdapter implements AdapterInterface
$this->login = $this->data['login']; $this->login = $this->data['login'];
$this->api_key = $this->data['api_key']; $this->api_key = $this->data['api_key'];
$this->sms_type = self::SMS_TYPE_LOWCOST;
if (($this->data['sms_type'] ?? false) && $this->data['sms_type'] === 'premium')
{
$this->sms_type = self::SMS_TYPE_PREMIUM;
}
$this->sender = $this->data['sender'] ?? null; $this->sender = $this->data['sender'] ?? null;
} }
@ -130,6 +141,12 @@ class OctopushShortcodeAdapter implements AdapterInterface
'description' => 'Clef API octopush. Trouvable sur la page des identifiants API Octopush.', 'description' => 'Clef API octopush. Trouvable sur la page des identifiants API Octopush.',
'required' => true, 'required' => true,
], ],
[
'name' => 'sms_type',
'title' => 'Type de SMS à employer',
'description' => 'Type de SMS à employer coté Octopush, rentrez "low cost" ou "premium" selon le type de SMS que vous souhaitez employer. Laissez vide pour utiliser par défaut des SMS low cost.',
'required' => false,
],
[ [
'name' => 'sender', 'name' => 'sender',
'title' => 'Nom de l\'expéditeur', 'title' => 'Nom de l\'expéditeur',
@ -209,21 +226,32 @@ class OctopushShortcodeAdapter implements AdapterInterface
try try
{ {
$data = [ $headers = [
'user_login' => $this->login, 'api-login: ' . $this->login,
'api_key' => $this->api_key, 'api-key: ' . $this->api_key,
'sms_text' => $text, 'Content-Type: application/json',
'sms_recipients' => str_replace('+', '00', $destination), //Must use 00 instead of + notation
'sms_sender' => '12345',
'sms_type' => self::SMS_TYPE_LOWCOST,
]; ];
if (null !== $this->sender) $data = [
'text' => $text,
'recipients' => [['phone_number' => $destination]],
'sms_type' => $this->sms_type,
'purpose' => 'alert',
];
if ($this->sender)
{ {
$data['sms_sender'] = $this->sender; $data['sender'] = $this->sender;
}
else
{
$data['with_replies'] = "True";
} }
$endpoint = $this->api_url . '/sms/json'; $data = json_encode($data);
$endpoint = $this->api_url . '/sms-campaign/send';
$curl = curl_init(); $curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $endpoint); curl_setopt($curl, CURLOPT_URL, $endpoint);
@ -231,10 +259,13 @@ class OctopushShortcodeAdapter implements AdapterInterface
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true); curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_POST, true); curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data); curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
$response = curl_exec($curl); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$curl_response = curl_exec($curl);
$http_code = (int) curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl); curl_close($curl);
if (false === $response) if (false === $curl_response)
{ {
$response['error'] = true; $response['error'] = true;
$response['error_message'] = 'HTTP query failed.'; $response['error_message'] = 'HTTP query failed.';
@ -242,7 +273,7 @@ class OctopushShortcodeAdapter implements AdapterInterface
return $response; return $response;
} }
$response_decode = json_decode($response, true); $response_decode = json_decode($curl_response, true);
if (null === $response_decode) if (null === $response_decode)
{ {
$response['error'] = true; $response['error'] = true;
@ -251,15 +282,15 @@ class OctopushShortcodeAdapter implements AdapterInterface
return $response; return $response;
} }
if (self::ERROR_CODE_OK !== $response_decode['error_code']) if (200 !== $http_code)
{ {
$response['error'] = true; $response['error'] = true;
$response['error_message'] = 'Response indicate error code : ' . $response_decode['error_code']; $response['error_message'] = 'Response indicate error code : ' . $response_decode['code'] . ' -> """' . $response_decode['message'] . '""" AND HTTP CODE -> ' . $http_code;
return $response; return $response;
} }
$uid = $response_decode['ticket'] ?? false; $uid = $response_decode['sms_ticket'] ?? false;
if (!$uid) if (!$uid)
{ {
$response['error'] = true; $response['error'] = true;
@ -297,34 +328,29 @@ class OctopushShortcodeAdapter implements AdapterInterface
return false; return false;
} }
$data = [ if (!empty($this->data['sms_type']) && !in_array($this->data['sms_type'], ['premium', 'low cost']))
'user_login' => $this->login, {
'api_key' => $this->api_key, return false;
}
$headers = [
'api-login: ' . $this->login,
'api-key: ' . $this->api_key,
'Content-Type: application/json',
]; ];
//Check service name //Check service name
$endpoint = $this->api_url . '/balance/json'; $endpoint = $this->api_url . '/wallet/check-balance';
$curl = curl_init(); $curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $endpoint); curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true); curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_POST, true); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
$response = curl_exec($curl); $response = curl_exec($curl);
$http_code = (int) curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl); curl_close($curl);
if (false === $response) if ($http_code !== 200)
{
return false;
}
$response_decode = json_decode($response, true);
if (null === $response_decode)
{
return false;
}
if (self::ERROR_CODE_OK !== $response_decode['error_code'])
{ {
return false; return false;
} }
@ -343,14 +369,23 @@ class OctopushShortcodeAdapter implements AdapterInterface
header('Content-Encoding: none'); header('Content-Encoding: none');
header('Content-Length: 0'); header('Content-Length: 0');
$uid = $_POST['message_id'] ?? false;
$status = $_POST['status'] ?? false; $input = file_get_contents('php://input');
$content = json_decode($input, true);
if (null === $content)
{
return false;
}
$uid = $content['message_id'] ?? false;
$status = $content['status'] ?? false;
if (false === $uid || false === $status) if (false === $uid || false === $status)
{ {
return false; return false;
} }
switch ($status) switch ($status)
{ {
case 'DELIVERED': case 'DELIVERED':
@ -358,10 +393,8 @@ class OctopushShortcodeAdapter implements AdapterInterface
break; break;
case 'NOT_DELIVERED':
case 'NOT_ALLOWED': case 'NOT_ALLOWED':
case 'INVALID_DESTINATION_ADDRESS':
case 'OUT_OF_DATE':
case 'EXPIRED':
case 'BLACKLISTED_NUMBER': case 'BLACKLISTED_NUMBER':
$status = \models\Sended::STATUS_FAILED; $status = \models\Sended::STATUS_FAILED;
@ -387,10 +420,20 @@ class OctopushShortcodeAdapter implements AdapterInterface
header('Connection: close'); header('Connection: close');
header('Content-Encoding: none'); header('Content-Encoding: none');
header('Content-Length: 0'); header('Content-Length: 0');
$input = file_get_contents('php://input');
$content = json_decode($input, true);
if (null === $content)
{
$response['error'] = true;
$response['error_message'] = 'Cannot read input data from callback request.';
return $response;
}
$number = $_POST['number'] ?? false; $number = $content['number'] ?? false;
$text = $_POST['text'] ?? false; $text = $content['text'] ?? false;
$at = $_POST['reception_date'] ?? false; $at = $content['reception_date'] ?? false;
if (!$number || !$text || !$at) if (!$number || !$text || !$at)
{ {
@ -400,11 +443,11 @@ class OctopushShortcodeAdapter implements AdapterInterface
return $response; return $response;
} }
$origin = \controllers\internals\Tool::parse_phone('+' . mb_substr($number, 2)); $origin = \controllers\internals\Tool::parse_phone($number);
if (!$origin) if (!$origin)
{ {
$response['error'] = true; $response['error'] = true;
$response['error_message'] = 'Invalid origin number : ' . mb_substr($number, 2); $response['error_message'] = 'Invalid origin number : ' . $number;
return $response; return $response;
} }

142
adapters/OctopushVirtualNumberAdapter.php
View File

@ -16,10 +16,8 @@ namespace adapters;
*/ */
class OctopushVirtualNumberAdapter implements AdapterInterface class OctopushVirtualNumberAdapter implements AdapterInterface
{ {
const ERROR_CODE_OK = '000'; const SMS_TYPE_LOWCOST = 'sms_low_cost';
const SMS_TYPE_LOWCOST = 'XXX'; const SMS_TYPE_PREMIUM = 'sms_premium';
const SMS_TYPE_PREMIUM = 'FR';
const SMS_TYPE_INTERNATIONAL = 'WWW';
/** /**
* Data used to configure interaction with the implemented service. (e.g : Api credentials, ports numbers, etc.). * Data used to configure interaction with the implemented service. (e.g : Api credentials, ports numbers, etc.).
@ -40,16 +38,16 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
* Number phone to use. * Number phone to use.
*/ */
private $number; private $number;
/** /**
* Number phone to use formated for octopush compatibility. * Octopush SMS type
*/ */
private $formatted_number; private $sms_type;
/** /**
* Octopush api baseurl. * Octopush api baseurl.
*/ */
private $api_url = 'https://www.octopush-dm.com/api'; private $api_url = 'https://api.octopush.com/v1/public';
/** /**
* Adapter constructor, called when instanciated by RaspiSMS. * Adapter constructor, called when instanciated by RaspiSMS.
@ -64,7 +62,14 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
$this->login = $this->data['login']; $this->login = $this->data['login'];
$this->api_key = $this->data['api_key']; $this->api_key = $this->data['api_key'];
$this->number = $this->data['number']; $this->number = $this->data['number'];
$this->formatted_number = '+' . mb_substr($this->data['number'], 2);
$this->sms_type = self::SMS_TYPE_LOWCOST;
if (($this->data['sms_type'] ?? false) && $this->data['sms_type'] === 'premium')
{
$this->sms_type = self::SMS_TYPE_PREMIUM;
}
} }
/** /**
@ -143,6 +148,12 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
'required' => true, 'required' => true,
'number' => true, 'number' => true,
], ],
[
'name' => 'sms_type',
'title' => 'Type de SMS à employer',
'description' => 'Type de SMS à employer coté Octopush, rentrez "low cost" ou "premium" selon le type de SMS que vous souhaitez employer. Laissez vide pour utiliser par défaut des SMS low cost.',
'required' => false,
],
]; ];
} }
@ -214,16 +225,25 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
try try
{ {
$data = [ $headers = [
'user_login' => $this->login, 'api-login: ' . $this->login,
'api_key' => $this->api_key, 'api-key: ' . $this->api_key,
'sms_text' => $text, 'Content-Type: application/json',
'sms_recipients' => str_replace('+', '00', $destination), //Must use 00 instead of + notation
'sms_sender' => $this->formatted_number,
'sms_type' => self::SMS_TYPE_LOWCOST,
]; ];
$endpoint = $this->api_url . '/sms/json'; $data = [
'text' => $text,
'recipients' => [['phone_number' => $destination]],
'sms_type' => $this->sms_type,
'purpose' => 'alert',
'sender' => $this->number,
'with_replies' => "True",
];
$data = json_encode($data);
$endpoint = $this->api_url . '/sms-campaign/send';
$curl = curl_init(); $curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $endpoint); curl_setopt($curl, CURLOPT_URL, $endpoint);
@ -231,10 +251,12 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true); curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_POST, true); curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data); curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
$response = curl_exec($curl); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$curl_response = curl_exec($curl);
$http_code = (int) curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl); curl_close($curl);
if (false === $response) if (false === $curl_response)
{ {
$response['error'] = true; $response['error'] = true;
$response['error_message'] = 'HTTP query failed.'; $response['error_message'] = 'HTTP query failed.';
@ -242,7 +264,7 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
return $response; return $response;
} }
$response_decode = json_decode($response, true); $response_decode = json_decode($curl_response, true);
if (null === $response_decode) if (null === $response_decode)
{ {
$response['error'] = true; $response['error'] = true;
@ -251,15 +273,15 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
return $response; return $response;
} }
if (self::ERROR_CODE_OK !== $response_decode['error_code']) if (200 !== $http_code)
{ {
$response['error'] = true; $response['error'] = true;
$response['error_message'] = 'Response indicate error code : ' . $response_decode['error_code']; $response['error_message'] = 'Response indicate error code : ' . $response_decode['code'] . ' -> """' . $response_decode['message'] . '""" AND HTTP CODE -> ' . $http_code;
return $response; return $response;
} }
$uid = $response_decode['ticket'] ?? false; $uid = $response_decode['sms_ticket'] ?? false;
if (!$uid) if (!$uid)
{ {
$response['error'] = true; $response['error'] = true;
@ -297,34 +319,36 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
return false; return false;
} }
$data = [ if (!empty($this->data['sms_type']) && !in_array($this->data['sms_type'], ['premium', 'low cost']))
'user_login' => $this->login, {
'api_key' => $this->api_key, return false;
}
$origin = \controllers\internals\Tool::parse_phone($this->data['number']);
if (!$origin)
{
return false;
}
$headers = [
'api-login: ' . $this->login,
'api-key: ' . $this->api_key,
'Content-Type: application/json',
]; ];
//Check service name //Check service name
$endpoint = $this->api_url . '/balance/json'; $endpoint = $this->api_url . '/wallet/check-balance';
$curl = curl_init(); $curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $endpoint); curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true); curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_POST, true); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
$response = curl_exec($curl); $response = curl_exec($curl);
$http_code = (int) curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl); curl_close($curl);
if (false === $response) if ($http_code !== 200)
{
return false;
}
$response_decode = json_decode($response, true);
if (null === $response_decode)
{
return false;
}
if (self::ERROR_CODE_OK !== $response_decode['error_code'])
{ {
return false; return false;
} }
@ -343,14 +367,23 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
header('Content-Encoding: none'); header('Content-Encoding: none');
header('Content-Length: 0'); header('Content-Length: 0');
$uid = $_POST['message_id'] ?? false;
$status = $_POST['status'] ?? false; $input = file_get_contents('php://input');
$content = json_decode($input, true);
if (null === $content)
{
return false;
}
$uid = $content['message_id'] ?? false;
$status = $content['status'] ?? false;
if (false === $uid || false === $status) if (false === $uid || false === $status)
{ {
return false; return false;
} }
switch ($status) switch ($status)
{ {
case 'DELIVERED': case 'DELIVERED':
@ -358,10 +391,8 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
break; break;
case 'NOT_DELIVERED':
case 'NOT_ALLOWED': case 'NOT_ALLOWED':
case 'INVALID_DESTINATION_ADDRESS':
case 'OUT_OF_DATE':
case 'EXPIRED':
case 'BLACKLISTED_NUMBER': case 'BLACKLISTED_NUMBER':
$status = \models\Sended::STATUS_FAILED; $status = \models\Sended::STATUS_FAILED;
@ -381,16 +412,23 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
$response = [ $response = [
'error' => false, 'error' => false,
'error_message' => null, 'error_message' => null,
'uid' => null, 'sms' => null,
]; ];
header('Connection: close'); header('Connection: close');
header('Content-Encoding: none'); header('Content-Encoding: none');
header('Content-Length: 0'); header('Content-Length: 0');
$input = file_get_contents('php://input');
$content = json_decode($input, true);
if (null === $content)
{
return false;
}
$number = $_POST['number'] ?? false; $number = $content['number'] ?? false;
$text = $_POST['text'] ?? false; $text = $content['text'] ?? false;
$at = $_POST['reception_date'] ?? false; $at = $content['reception_date'] ?? false;
if (!$number || !$text || !$at) if (!$number || !$text || !$at)
{ {
@ -400,11 +438,11 @@ class OctopushVirtualNumberAdapter implements AdapterInterface
return $response; return $response;
} }
$origin = \controllers\internals\Tool::parse_phone('+' . mb_substr($number, 2)); $origin = \controllers\internals\Tool::parse_phone($number);
if (!$origin) if (!$origin)
{ {
$response['error'] = true; $response['error'] = true;
$response['error_message'] = 'Invalid origin number : ' . mb_substr($number, 2); $response['error_message'] = 'Invalid origin number : ' . $number;
return $response; return $response;
} }

2
controllers/publics/Callback.php
View File

@ -191,7 +191,7 @@ use Monolog\Logger;
} }
$sms = $response['sms']; $sms = $response['sms'];
$mms = (bool) $sms['mms'] ?? false; $mms = (bool) ($sms['mms'] ?? false);
$medias = empty($sms['medias']) ? [] : $sms['medias']; $medias = empty($sms['medias']) ? [] : $sms['medias'];
$response = $this->internal_received->receive($this->user['id'], $id_phone, $sms['text'], $sms['origin'], $sms['at'], \models\Received::STATUS_UNREAD, $mms, $medias); $response = $this->internal_received->receive($this->user['id'], $id_phone, $sms['text'], $sms['origin'], $sms['at'], \models\Received::STATUS_UNREAD, $mms, $medias);