Ticket #4984 - Integrate SMS.RU as new SMS provider.

inc/classes/BxDolSmsSmsRu.php

@@ -0,0 +1,341 @@
+<?php defined('BX_DOL') or die('hack attempt');
+/**
+ * Copyright (c) UNA, Inc - https://una.io
+ * MIT License - https://opensource.org/licenses/MIT
+ *
+ * @defgroup    UnaCore UNA Core
+ * @{
+ */
+
+class BxDolSmsSmsRu extends BxDolSms
+{
+    protected $_sApiId;
+    protected $_sFromNumber;
+
+    protected function __construct($aObject, $oTemplate = null, $sDbClassName = '')
+    {
+        parent::__construct($aObject, $oTemplate, $sDbClassName);
+
+        $this->_sApiId = getParam('sys_sms_smsru_api_id');
+        $this->_sFromNumber = getParam('sys_sms_smsru_from_number');
+    }
+
+    public function send($sTo, $sMessage, $sFrom = '')
+    {
+        $oProvider = new SMSRU($this->_sApiId);
+
+        $oData = new stdClass();
+        $oData->to = $sTo;
+        $oData->text = $sMessage;
+        if($sFrom != '')
+            $oData->from = $this->normalizePhone($sFrom);
+        else if($this->_sFromNumber != '')
+            $oData->from = $this->normalizePhone($this->_sFromNumber);
+
+        if(($oResult = $oProvider->send_one($oData)) && $oResult->status == "OK")
+            return true;
+
+        $this->_writeLog($oResult->status_code . ': ' . $oResult->status_text);
+        return false;
+    }
+}
+
+
+/**
+ * Класс для работы с API сайта sms.ru для PHP 5.3 и выше
+ * Разработчик WebProgrammer (kl.dm.vl@yandex.ru), легкие корректировки - Роман Гудев <rgudev@bk.ru>
+ */
+class SMSRU {
+
+	private $ApiKey;
+	private $protocol = 'https';
+	private $domain = 'sms.ru';
+	private $count_repeat = 5; //количество попыток достучаться до сервера если он не доступен
+
+	function __construct($ApiKey) {
+		$this->ApiKey = $ApiKey;
+	}
+
+	/**
+	 * Совершает отправку СМС сообщения одному или нескольким получателям.
+	 * @param $post
+	 *   $post->to = string - Номер телефона получателя (либо несколько номеров, через запятую — до 100 штук за один запрос). Если вы указываете несколько номеров и один из них указан неверно, то на остальные номера сообщения также не отправляются, и возвращается код ошибки.
+	 *   $post->msg = string - Текст сообщения в кодировке UTF-8
+	 *   $post->multi = array('номер получателя' => 'текст сообщения') - Если вы хотите в одном запросе отправить разные сообщения на несколько номеров, то воспользуйтесь этим параметром (до 100 сообщений за 1 запрос). В этом случае, параметры to и text использовать не нужно
+	 *   $post->from = string - Имя отправителя (должно быть согласовано с администрацией). Если не заполнено, в качестве отправителя будет указан ваш номер.
+	 *   $post->time = Если вам нужна отложенная отправка, то укажите время отправки. Указывается в формате UNIX TIME (пример: 1280307978). Должно быть не больше 7 дней с момента подачи запроса. Если время меньше текущего времени, сообщение отправляется моментально.
+	 *   $post->translit = 1 - Переводит все русские символы в латинские. (по умолчанию 0)
+	 *   $post->test = 1 - Имитирует отправку сообщения для тестирования ваших программ на правильность обработки ответов сервера. При этом само сообщение не отправляется и баланс не расходуется. (по умолчанию 0)
+	 *   $post->partner_id = int - Если вы участвуете в партнерской программе, укажите этот параметр в запросе и получайте проценты от стоимости отправленных сообщений.
+	 *   $post->ip = string - IP адрес пользователя, в случае если вы отправляете код авторизации ему на номер в ответ на его запрос (к примеру, при регистрации). В случае аттаки на ваш сайт, наша система сможет помочь с защитой.
+	 * @return array|mixed|\stdClass
+	 */
+	public function send_one($post) {
+		$url = $this->protocol . '://' . $this->domain . '/sms/send';
+		$request = $this->Request($url, $post);
+		$resp = $this->CheckReplyError($request, 'send');
+
+		if ($resp->status == "OK") {
+			$temp = (array) $resp->sms;
+			unset($resp->sms);
+
+			$temp = array_pop($temp);
+
+			if ($temp) {
+				return $temp;
+			} else {
+				return $resp;
+			}
+		} else {
+			return $resp;
+		}
+
+	}
+
+	public function send($post) {
+		$url = $this->protocol . '://' . $this->domain . '/sms/send';
+		$request = $this->Request($url, $post);
+		return $this->CheckReplyError($request, 'send');
+	}
+
+	/**
+	 * Отправка СМС сообщений по электронной почте
+	 * @param $post
+	 *   $post->from = string - Ваш электронный адрес
+	 *   $post->charset = string - кодировка переданных данных
+	 *   $post->send_charset = string - кодировка переданных письма
+	 *   $post->subject = string - тема письма
+	 *   $post->body = string - текст письма
+	 * @return bool
+	 */
+	public function sendSmtp($post) {
+		$post->to = $this->ApiKey . '@' . $this->domain;
+		$post->subject = $this->sms_mime_header_encode($post->subject, $post->charset, $post->send_charset);
+		if ($post->charset != $post->send_charset) {
+			$post->body = iconv($post->charset, $post->send_charset, $post->body);
+		}
+		$headers = "From: $post->\r\n";
+		$headers .= "Content-type: text/plain; charset=$post->send_charset\r\n";
+		return mail($post->to, $post->subject, $post->body, $headers);
+	}
+
+	public function getStatus($id) {
+		$url = $this->protocol . '://' . $this->domain . '/sms/status';
+
+		$post = new stdClass();
+		$post->sms_id = $id;
+
+		$request = $this->Request($url, $post);
+		return $this->CheckReplyError($request, 'getStatus');
+	}
+
+	/**
+	 * Возвращает стоимость сообщения на указанный номер и количество сообщений, необходимых для его отправки.
+	 * @param $post
+	 *   $post->to = string - Номер телефона получателя (либо несколько номеров, через запятую — до 100 штук за один запрос) Если вы указываете несколько номеров и один из них указан неверно, то возвращается код ошибки.
+	 *   $post->text = string - Текст сообщения в кодировке UTF-8. Если текст не введен, то возвращается стоимость 1 сообщения. Если текст введен, то возвращается стоимость, рассчитанная по длине сообщения.
+	 *   $post->translit = int - Переводит все русские символы в латинские
+	 * @return mixed|\stdClass
+	 */
+	public function getCost($post) {
+		$url = $this->protocol . '://' . $this->domain . '/sms/cost';
+		$request = $this->Request($url, $post);
+		return $this->CheckReplyError($request, 'getCost');
+	}
+
+	/**
+	 * Получение состояния баланса
+	 */
+	public function getBalance() {
+		$url = $this->protocol . '://' . $this->domain . '/my/balance';
+		$request = $this->Request($url);
+		return $this->CheckReplyError($request, 'getBalance');
+	}
+
+	/**
+	 * Получение текущего состояния вашего дневного лимита.
+	 */
+	public function getLimit() {
+		$url = $this->protocol . '://' . $this->domain . '/my/limit';
+		$request = $this->Request($url);
+		return $this->CheckReplyError($request, 'getLimit');
+	}
+
+	/**
+	 * Получение списка отправителей
+	 */
+	public function getSenders() {
+		$url = $this->protocol . '://' . $this->domain . '/my/senders';
+		$request = $this->Request($url);
+		return $this->CheckReplyError($request, 'getSenders');
+	}
+
+	/**
+	 * Проверка номера телефона и пароля на действительность.
+	 * @param $post
+	 *   $post->login = string - номер телефона
+	 *   $post->password = string - пароль
+	 * @return mixed|\stdClass
+	 */
+	public function authCheck($post) {
+		$url = $this->protocol . '://' . $this->domain . '/auth/check';
+		$post->api_id = 'none';
+		return $this->CheckReplyError($request, 'AuthCheck');
+	}
+
+	/**
+	 * На номера, добавленные в стоплист, не доставляются сообщения (и за них не списываются деньги)
+	 * @param string $phone Номер телефона.
+	 * @param string $text Примечание (доступно только вам).
+	 * @return mixed|\stdClass
+	 */
+	public function addStopList($phone, $text = "") {
+		$url = $this->protocol . '://' . $this->domain . '/stoplist/add';
+
+		$post = new stdClass();
+		$post->stoplist_phone = $phone;
+		$post->stoplist_text = $text;
+
+		$request = $this->Request($url, $post);
+		return $this->CheckReplyError($request, 'addStopList');
+	}
+
+	/**
+	 * Удаляет один номер из стоплиста
+	 * @param string $phone Номер телефона.
+	 * @return mixed|\stdClass
+	 */
+	public function delStopList($phone) {
+		$url = $this->protocol . '://' . $this->domain . '/stoplist/del';
+
+		$post = new stdClass();
+		$post->stoplist_phone = $phone;
+
+		$request = $this->Request($url, $post);
+		return $this->CheckReplyError($request, 'delStopList');
+	}
+
+	/**
+	 * Получить номера занесённые в стоплист
+	 */
+	public function getStopList() {
+		$url = $this->protocol . '://' . $this->domain . '/stoplist/get';
+		$request = $this->Request($url);
+		return $this->CheckReplyError($request, 'getStopList');
+	}
+
+	/**
+	 * Позволяет отправлять СМС сообщения, переданные через XML компании UCS, которая создала ПО R-Keeper CRM (RKeeper). Вам достаточно указать адрес ниже в качестве адреса шлюза и сообщения будут доставляться автоматически.
+	 */
+	public function ucsSms() {
+		$url = $this->protocol . '://' . $this->domain . '/ucs/sms';
+		$request = $this->Request($url);
+		$output->status = "OK";
+		$output->status_code = '100';
+		return $output;
+	}
+
+	/**
+	 * Добавить URL Callback системы на вашей стороне, на которую будут возвращаться статусы отправленных вами сообщений
+	 * @param $post
+	 *    $post->url = string - Адрес обработчика (должен начинаться на http://)
+	 * @return mixed|\stdClass
+	 */
+	public function addCallback($post) {
+		$url = $this->protocol . '://' . $this->domain . '/callback/add';
+		$request = $this->Request($url, $post);
+		return $this->CheckReplyError($request, 'addCallback');
+	}
+
+	/**
+	 * Удалить обработчик, внесенный вами ранее
+	 * @param $post
+	 *   $post->url = string - Адрес обработчика (должен начинаться на http://)
+	 * @return mixed|\stdClass
+	 */
+	public function delCallback($post) {
+		$url = $this->protocol . '://' . $this->domain . '/callback/del';
+		$request = $this->Request($url, $post);
+		return $this->CheckReplyError($request, 'delCallback');
+	}
+
+	/**
+	 * Все имеющиеся у вас обработчики
+	 */
+	public function getCallback() {
+		$url = $this->protocol . '://' . $this->domain . '/callback/get';
+		$request = $this->Request($url);
+		return $this->CheckReplyError($request, 'getCallback');
+	}
+
+	private function Request($url, $post = FALSE) {
+		if ($post) {
+			$r_post = $post;
+		}
+		$ch = curl_init($url . "?json=1");
+		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+		curl_setopt($ch, CURLOPT_TIMEOUT, 30);
+
+		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
+		curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);
+
+		curl_setopt($ch, CURLOPT_VERBOSE, 1);
+
+		if (!$post) {
+			$post = new stdClass();
+		}
+
+		if (!empty($post->api_id) && $post->api_id == 'none') {
+		} else {
+			$post->api_id = $this->ApiKey;
+		}
+
+		curl_setopt($ch, CURLOPT_POST, 1);
+		curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query((array) $post));
+
+		$body = curl_exec($ch);
+		if ($body === FALSE) {
+			$error = curl_error($ch);
+		} else {
+			$error = FALSE;
+		}
+		curl_close($ch);
+		if ($error && $this->count_repeat > 0) {
+			$this->count_repeat--;
+			return $this->Request($url, $r_post);
+		}
+		return $body;
+	}
+
+	private function CheckReplyError($res, $action) {
+
+		if (!$res) {
+			$temp = new stdClass();
+			$temp->status = "ERROR";
+			$temp->status_code = "000";
+			$temp->status_text = "Невозможно установить связь с сервером SMS.RU. Проверьте - правильно ли указаны DNS сервера в настройках вашего сервера (nslookup sms.ru), и есть ли связь с интернетом (ping sms.ru).";
+			return $temp;
+		}
+
+		$result = json_decode($res);
+
+		if (!$result || !$result->status) {
+			$temp = new stdClass();
+			$temp->status = "ERROR";
+			$temp->status_code = "000";
+			$temp->status_text = "Невозможно установить связь с сервером SMS.RU. Проверьте - правильно ли указаны DNS сервера в настройках вашего сервера (nslookup sms.ru), и есть ли связь с интернетом (ping sms.ru)";
+			return $temp;
+		}
+
+		return $result;
+	}
+
+	private function sms_mime_header_encode($str, $post_charset, $send_charset) {
+		if ($post_charset != $send_charset) {
+			$str = iconv($post_charset, $send_charset, $str);
+		}
+		return "=?" . $send_charset . "?B?" . base64_encode($str) . "?=";
+	}
+}
+
+/** @} */

install/sql/system.sql

@@ -91,7 +91,8 @@ CREATE TABLE `sys_objects_sms` (
 );
 
 INSERT INTO `sys_objects_sms` (`object`, `title`, `override_class_name`, `override_class_file`) VALUES
-('sys_twilio', 'Twilio', 'BxDolSmsTwilio', '');
+('sys_twilio', 'Twilio', 'BxDolSmsTwilio', ''),
+('sys_smsru', 'SMS.RU', 'BxDolSmsSmsRu', '');
 
 
 -- --------------------------------------------------------
@@ -741,7 +742,10 @@ INSERT INTO `sys_options`(`category_id`, `name`, `caption`, `value`, `type`, `ex
 
 (@iCategoryId, 'sys_sms_twilio_sid', '_adm_stg_cpt_option_sys_sms_twilio_sid', '', 'digit', '', '', '', 11),
 (@iCategoryId, 'sys_sms_twilio_token', '_adm_stg_cpt_option_sys_sms_twilio_token', '', 'digit', '', '', '', 12),
-(@iCategoryId, 'sys_sms_twilio_from_number', '_adm_stg_cpt_option_sys_sms_twilio_from_number', '', 'digit', '', '', '', 13);
+(@iCategoryId, 'sys_sms_twilio_from_number', '_adm_stg_cpt_option_sys_sms_twilio_from_number', '', 'digit', '', '', '', 13),
+
+(@iCategoryId, 'sys_sms_smsru_api_id', '_adm_stg_cpt_option_sys_sms_smsru_api_id', '', 'digit', '', '', '', 21),
+(@iCategoryId, 'sys_sms_smsru_from_number', '_adm_stg_cpt_option_sys_sms_smsru_from_number', '', 'digit', '', '', '', 22);
 
 
 --

modules/boonex/english/data/langs/system/en.xml

@@ -1688,7 +1688,9 @@
     <string name="_adm_stg_cpt_option_sys_sms_default"><![CDATA[Provider]]></string>
     <string name="_adm_stg_cpt_option_sys_sms_twilio_sid"><![CDATA[Twilio: Account SID]]></string>
     <string name="_adm_stg_cpt_option_sys_sms_twilio_token"><![CDATA[Twilio: Auth token]]></string>
-    <string name="_adm_stg_cpt_option_sys_sms_twilio_from_number"><![CDATA[Twilio: Default 'From' number for SMS]]></string>    
+    <string name="_adm_stg_cpt_option_sys_sms_twilio_from_number"><![CDATA[Twilio: Default 'From' number for SMS]]></string>
+    <string name="_adm_stg_cpt_option_sys_sms_smsru_api_id"><![CDATA[SMS.RU: API ID]]></string>
+    <string name="_adm_stg_cpt_option_sys_sms_smsru_from_number"><![CDATA[SMS.RU: Default 'From' number for SMS]]></string>
     <string name="_adm_stg_cpt_option_sys_nominatim_server"><![CDATA[Nominatim server URL]]></string>    
     <string name="_adm_stg_cpt_option_sys_nominatim_email"><![CDATA[Nominatim email to identify requests]]></string>
     <string name="_adm_stg_cpt_option_sys_recaptcha_key_private"><![CDATA[reCAPTCHA/hCaptcha private key]]></string>

modules/boonex/russian/data/langs/system/ru.xml

@@ -1665,6 +1665,8 @@
     <string name="_adm_stg_cpt_option_sys_sms_twilio_sid"><![CDATA[Twilio: SID учетной записи]]></string>
     <string name="_adm_stg_cpt_option_sys_sms_twilio_token"><![CDATA[Twilio: Токен аутентификации]]></string>
     <string name="_adm_stg_cpt_option_sys_sms_twilio_from_number"><![CDATA[Twilio: Номер для отправки SMS по умолчанию]]></string>
+    <string name="_adm_stg_cpt_option_sys_sms_smsru_api_id"><![CDATA[SMS.RU: API ID]]></string>
+    <string name="_adm_stg_cpt_option_sys_sms_smsru_from_number"><![CDATA[SMS.RU: Номер для отправки SMS по умолчанию]]></string>
     <string name="_adm_stg_cpt_option_sys_nominatim_server"><![CDATA[Nominatim сервер (URL)]]></string>    
     <string name="_adm_stg_cpt_option_sys_nominatim_email"><![CDATA[Nominatim Email адрес (чтобы идентифицировать запросы)]]></string>
     <string name="_adm_stg_cpt_option_sys_recaptcha_key_private"><![CDATA[reCAPTCHA/hCaptcha - приватный ключ]]></string>