319 lines
8.9 KiB
PHP
319 lines
8.9 KiB
PHP
|
<?php
|
||
|
|
||
|
/*
|
||
|
* This file is part of RaspiSMS.
|
||
|
*
|
||
|
* (c) Pierre-Lin Bonnemaison <plebwebsas@gmail.com>
|
||
|
*
|
||
|
* 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 OctopushShortcodeAdapter implements AdapterInterface
|
||
|
{
|
||
|
const ERROR_CODE_OK = '000';
|
||
|
|
||
|
/**
|
||
|
* 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;
|
||
|
|
||
|
/**
|
||
|
* Sender name to use instead of shortcode
|
||
|
*/
|
||
|
private $sender;
|
||
|
|
||
|
/**
|
||
|
* 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->sender = $this->datas['sender'] ?? null;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* 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_shortcode_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 Shortcode';
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* 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 shortcode en utilisant <a target="_blank" href="https://www.octopush.com/">Octopush</a>. Pour trouver vos clés API Octopush <a target="_blank" href="' . $credentials_url . '">cliquez ici.</a>
|
||
|
';
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* 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' => 'sender',
|
||
|
'title' => 'Nom de l\'expéditeur',
|
||
|
'description' => 'Nom de l\'expéditeur à afficher à la place du numéro (11 caractères max).<br/>
|
||
|
<b>Laissez vide pour ne pas utiliser d\'expéditeur nommé.</b><br/>
|
||
|
<b>Si vous utilisez un expéditeur nommé, le destinataire ne pourra pas répondre.</b>',
|
||
|
'required' => false,
|
||
|
],
|
||
|
|
||
|
];
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* 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 mixed Uid of the sended message if send, False else
|
||
|
*/
|
||
|
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' => '12345',
|
||
|
];
|
||
|
|
||
|
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);
|
||
|
|
||
|
var_dump($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()
|
||
|
{
|
||
|
var_dump($_REQUEST);
|
||
|
return false;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* 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
|
||
|
{
|
||
|
return [];
|
||
|
}
|
||
|
}
|