Compare commits

..

2 Commits

5 changed files with 273 additions and 116 deletions

View File

@ -22,15 +22,18 @@
"issues": "https://git.mirzaev.sexy/mirzaev/vk/issues" "issues": "https://git.mirzaev.sexy/mirzaev/vk/issues"
}, },
"require": { "require": {
"php": "~8.1", "php": "^8.1",
"psr/log": "~1.0", "psr/log": "^1.0",
"mirzaev/accounts": "~1.2.0", "mirzaev/accounts": "^1.2.0",
"monolog/monolog": "~1.6", "monolog/monolog": "^1.6",
"jasny/error-handler": "~0.2", "jasny/error-handler": "^0.2",
"guzzlehttp/guzzle": "~7.5" "guzzlehttp/guzzle": "^7.5"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "~9.5" "phpunit/phpunit": "^9.5"
},
"suggest": {
"ext-sodium": "Can be selected in some conditions to increase security"
}, },
"autoload": { "autoload": {
"psr-4": { "psr-4": {

View File

@ -5,9 +5,7 @@ declare(strict_types=1);
namespace mirzaev\vk\api\methods; namespace mirzaev\vk\api\methods;
// Файлы проекта // Файлы проекта
use mirzaev\accounts\vk, use mirzaev\vk\robots\robot,
mirzaev\vk\robots\robot,
mirzaev\vk\api\data,
mirzaev\vk\robots\group; mirzaev\vk\robots\group;
// Встроенные библиотеки // Встроенные библиотеки
@ -17,13 +15,28 @@ use stdClass,
/** /**
* Режимы отправки сообщений * Режимы отправки сообщений
*/ */
enum mode enum message_send
{ {
/** Быстро - случайный идентификатор (умножение на rand()) */ /** Обычная отправка */
case simple;
/** Проверка отправки */
case check;
}
/**
* Режимы генерации идентификатора сессии доставки сообщения
*/
enum random_id
{
/** Генерация: time() (нельзя отправить более чем 1 сообщение в секунду) */
case date;
/** Генерация: rand() */
case random; case random;
/** Надёжно - проверка отправки (поиск сообщения через messages.getById) */ /** Генерация: random_int(0, PHP_INT_MAX) */
case search; case crypto;
} }
/** /**
@ -42,19 +55,64 @@ enum mode
final class messages extends method final class messages extends method
{ {
/** /**
* @var mode $mode Режим отправки сообщений * @var message_send $send_mode Режим отправки сообщений
*/ */
protected mode $mode = mode::random; protected message_send $send_mode = message_send::simple;
/** /**
* @var array[int] Сообщения для пересылки * @var random_id $generate_mode Режим генерации идентификатора сессии доставки сообщения
*/ */
protected array $forward; protected random_id $generate_mode = random_id::crypto;
/** /**
* @var int Сообщение для ответа * @var ?int $lat Географическая ширина
*/ */
protected int $reply; protected ?int $lat = null;
/**
* @var ?int $long Географическая долгота
*/
protected ?int $long = null;
/**
* @var ?int $reply_to Идентификатор сообщения, на которое требуется ответить
*/
protected ?int $reply_to = null;
/**
* @var ?array $forward_messages Идентификаторы пересылаемых сообщений
*/
protected ?array $forward_messages = null;
/**
* @var ?string $sticker_id Идентификатор стикера
*/
protected ?string $sticker_id = null;
/**
* @var ?string $payload Полезная нагрузка
*/
protected ?string $payload = null;
/**
* @var bool $dont_parse_links Не создавать представление ссылки в сообщении?
*/
protected bool $dont_parse_links = false;
/**
* @var bool $disable_mentions Отключить уведомление об упоминании в сообщении?
*/
protected bool $disable_mentions = false;
/**
* @var ?string $intent Интент
*/
protected ?string $intent = null;
/**
* @var ?string $subscribe_id Число, которое будет использоваться для работы с интентами
*/
protected ?int $subscribe_id = null;
/** /**
* Конструктор * Конструктор
@ -123,79 +181,131 @@ final class messages extends method
* *
* @see https://vk.com/dev/messages.send * @see https://vk.com/dev/messages.send
* *
* @param int|string|array|null $receiver Получатель * @param int|string|null $receiver Получатель
* @param ?string $message Сообщение
* @param ?int $lat Географическая ширина
* @param ?int $long Географическая долгота
* @param ?array $attachments Вложения
* @param ?int $reply_to Идентификатор сообщения, на которое требуется ответить
* @param ?array $forward_messages Идентификаторы пересылаемых сообщений
* @param ?forward $forward Пересылаемые сообщения (в другой чат)
* @param ?string $sticker_id Идентификатор стикера
* @param ?keyboard $keyboard Инстанция клавиатуры
* @param ?template $template Инстанция шаблона сообщения
* @param ?string $payload Полезная нагрузка
* @param bool $dont_parse_links Не создавать представление ссылки в сообщении?
* @param bool $disable_mentions Отключить уведомление об упоминании в сообщении?
* @param ?string $intent Интент
* @param ?int $subscribe_id Число, которое будет использоваться для работы с интентами
* @param ?int $random_id Идентификатор сессии доставки сообщения (защита от повторных отправок)
* *
* @return int|array Идентификатор успешно отправленного сообщения или ответ сервера (подразумевается ошибка) * @return int|array Идентификатор успешно отправленного сообщения или ответ сервера (подразумевается ошибка)
* *
* @todo Написать обработчик ошибок возвращаемых ВКонтакте * @todo
* 1. Написать обработчик ошибок возвращаемых ВКонтакте
* 2. Добавить параметр forward (не путать с forward_messages)
* 3. Добавить клавиатуру
* 4. Добавить шаблоны сообщений
* 5. Добавить content_source
*/ */
public function send(int|string|array|null $receiver): int|array public function send(
{ int|string|null $receiver,
// Идентификатор ?string $message = null,
$random_id = time(); ?int $lat = null,
?int $long = null,
if ($this->mode === mode::random) { ?array $attachments = null,
// Быстрая отправка сообщения ?int $reply_to = null,
?array $forward_messages = null,
$random_id *= rand(); // ?forward $forward = null,
} ?string $sticker_id = null,
// ?keyboard $keyboard = null,
// Реиницилазиция // ?template $template = null,
?string $payload = null,
bool $dont_parse_links = false,
bool $disable_mentions = false,
?string $intent = null,
?int $subscribe_id = null,
?int $random_id = null,
): int|array {
// Реинициализация настроек
$this->robot->api->reinit(); $this->robot->api->reinit();
if (is_int($receiver)) { // Инициализация получателя
// Идентификатор if (is_int($receiver)) ($id = $receiver - 2000000000) > 0 ? $this->robot->api['peer_id'] = $receiver : $this->robot->api['chat_id'] = $id;
else if (is_array($receiver)) $this->robot->api['peer_ids'] = implode(',', $receiver);
else if (is_string($receiver)) $this->robot->api['domain'] = $receiver;
// Инициализация получателя // Инициализация идентификатора сессии доставки сообщения (защита от повторных отправок)
$this->robot->api['peer_id'] = $receiver; $this->robot->api['random_id'] = $random_id ?? match ($this->generate_mode) {
} else if (is_array($receiver)) { random_id::date => time(),
// Идентификаторы random_id::random => rand(),
random_id::crypto => random_int(0, PHP_INT_MAX),
// Инициализация получателя default => random_int(0, PHP_INT_MAX)
$this->robot->api['user_ids'] = $receiver; };
} else if (is_string($receiver)) {
// Домен
// Инициализация получателя
$this->robot->api['domain'] = $receiver;
}
// Инициализация идентификатора сообщения (защита от повторных отправок) в настройках API
$this->robot->api['random_id'] = $random_id;
// Инициализация текста в настройках API // Инициализация текста в настройках API
$this->robot->api['message'] = $this->text; if (isset($message)) $this->robot->api['message'] = $message;
else if (isset($this->text)) $this->robot->api['message'] = $this->text;
// Пересылаемые сообщения // Инициализация широты
if (!empty($this->forwardMessages)) { if (isset($lat)) $this->robot->api['lat'] = $lat;
else if (isset($this->lat)) $this->robot->api['lat'] = $this->lat;
// Инициализация пересылаемых сообщений в настройках API // Инициализация долготы
$this->robot->api['forward_messages'] = implode(',', $this->forwardMessages); if (isset($long)) $this->robot->api['long'] = $long;
} else if (isset($this->long)) $this->robot->api['long'] = $this->tlongext;
// Ответные сообщения // Инициализация вложений
if (isset($this->ReplyMessage)) { if (isset($attachments)) $this->robot->api['attachment'] = implode(',', $attachments);
else if (isset($this->robot->api->data) && $this->robot->api->__get('data') !== []) $this->robot->api['attachment'] = implode(',', $this->robot->api->__get('data'));
// Инициализация идентификатора сообщения на которое обрабатывается ответ в настройках API // Инициализация сообщения, на которое требуется ответить
$this->robot->api['reply_to'] = $this->ReplyMessage; if (isset($reply_to)) $this->robot->api['reply_to'] = $reply_to;
} else if (isset($this->reply)) $this->robot->api['reply_to'] = $this->reply;
// Вложения // Инициализация пересылаемых сообщений
if (isset($this->data) && $this->__get('data') !== []) { // !empty($this->data->data) почемуто не работает if (isset($forward_messages)) $this->robot->api['forward_messages'] = implode(',', $forward_messages);
else if (isset($this->forward_messages)) $this->robot->api['forward_messages'] = implode(',', $this->forward_messages);
// Инициализация вложений в настройках API // Инициализация стикера
$this->robot->api['attachment'] = implode(',', $this->__get('data')); if (isset($sticker_id)) $this->robot->api['sticker_id'] = $sticker_id;
} else if (isset($this->sticker_id)) $this->robot->api['sticker_id'] = $this->sticker_id;
// Инициализация полезной нагрузки
if (isset($payload)) $this->robot->api['payload'] = $payload;
else if (isset($this->payload)) $this->robot->api['payload'] = $this->payload;
// Инициализация пользовательского соглашения
// $this->robot->api['content_source'] = $this->robot->content_source;
// Инициализация "не создавать представление ссылки в сообщении?"
if ($dont_parse_links) $this->robot->api['dont_parse_links'] = 1;
else if ($this->dont_parse_links) $this->robot->api['dont_parse_links'] = 1;
// Инициализация "отключить уведомление об упоминании в сообщении?"
if ($disable_mentions) $this->robot->api['disable_mentions'] = 1;
else if ($this->disable_mentions) $this->robot->api['disable_mentions'] = 1;
// Инициализация интентов
if (isset($intent)) $this->robot->api['intent'] = $intent;
else if (isset($this->intent)) $this->robot->api['intent'] = $this->intent;
// Инициализация числа, которое будет использоваться для работы с интентами
if (isset($subscribe_id)) $this->robot->api['subscribe_id'] = $subscribe_id;
else if (isset($this->subscribe_id)) $this->robot->api['subscribe_id'] = $this->subscribe_id;
// Проверка сформированного сообщения
if (!$this->robot->api->offsetExists('message') && !$this->robot->api->offsetExists('attachment')) throw new Exception('Сообщение должно содержать текст, либо вложение');
// Запрос // Запрос
$request = json_decode($this->robot->browser->request('POST', 'messages.send', ['form_params' => $this->robot->api->settings])->getBody()->getContents()); $request = json_decode($this->robot->browser->request('POST', 'messages.send', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
// Если в ответе ошибка // Если в ответе ошибка
if (isset($request->error)) { if (isset($request->error)) {
throw new Exception('Вконтакте: ' . $request->error->error_msg, $request->error->error_code); throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
} }
if ($this->mode === mode::search) { if ($this->send_mode === message_send::check) {
// Надёжная доставка сообщения // Надёжная доставка сообщения
if (!empty($request["response"])) { if (!empty($request["response"])) {

View File

@ -4,12 +4,12 @@ declare(strict_types=1);
namespace mirzaev\vk\api\methods; namespace mirzaev\vk\api\methods;
use Exception; // Файлы проекта
use mirzaev\vk\robots\robot, use mirzaev\vk\robots\robot,
mirzaev\vk\robots\group; mirzaev\vk\robots\group;
use mirzaev\accounts\vk as account; // Встроенные библиотеки
use Exception;
/** /**
* Фотографии (изображения) * Фотографии (изображения)
@ -22,7 +22,7 @@ use mirzaev\accounts\vk as account;
* @package mirzaev\vk\api\methods * @package mirzaev\vk\api\methods
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy> * @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
* *
* @todo Добавить обработку ошибок ($request['errors];) * @todo Добавить обработку ошибок ($request['errors])
*/ */
final class photos extends method final class photos extends method
{ {

View File

@ -5,10 +5,11 @@ declare(strict_types=1);
namespace mirzaev\vk\api\methods; namespace mirzaev\vk\api\methods;
// Файлы проекта // Файлы проекта
use mirzaev\vk\robots\user; use mirzaev\vk\robots\robot;
// Встроенные библиотеки // Встроенные библиотеки
use Exception; use Exception,
stdClass;
/** /**
* Пользователь * Пользователь
@ -24,10 +25,10 @@ final class users extends method
/** /**
* Конструктор * Конструктор
* *
* @param user $user Робот * @param robot $user Робот
*/ */
public function __construct( public function __construct(
protected user $robot protected robot $robot
) { ) {
} }
@ -36,51 +37,69 @@ final class users extends method
* *
* @see https://dev.vk.com/method/users.get * @see https://dev.vk.com/method/users.get
* *
* @param array $user_ids Выбор пользователей для запроса информации * @param array $receiver Выбор пользователей для запроса информации (user_ids)
* @param array $fields Выбор дополнительных запрашиваемых полей * @param array $fields Выбор дополнительных запрашиваемых полей
* @param string $name_case Падеж * @param string $name_case Падеж
* *
* @return ?array Информация об аккаунте, если получена * @return stdClass|array|null Информация об аккаунте или массив с информацией об аккаунтах, если найдена
* *
* @todo * @todo
* 1. Доделать * 1. Доделать
* 2. Написать обработчик ошибок возвращаемых ВКонтакте * 2. Написать обработчик ошибок возвращаемых ВКонтакте
*/ */
public function get(array $user_ids = [], array $fields = [], string $name_case = ''): array public function get(int|string|array $receiver = [], array $fields = [], ?string $name_case = null): stdClass|array|null
{ {
// Реиницилазиция // Реиницилазиция
$this->robot->api->reinit(); $this->robot->api->reinit();
// Инициализация пользователей для запроса информации if (is_int($receiver)) {
if (!empty($user_ids)) $this->robot->api['user_ids'] = ''; // Идентификатор
foreach ($user_ids as $key => $user_id) { // Инициализация пользователя
// Перебор пользователей для получения информации $this->robot->api['user_ids'] = $receiver;
} else if (is_array($receiver)) {
// Идентификаторы
// Запись пользователя // Инициализация пользователей
$this->robot->api['user_ids'] .= $user_id; $this->robot->api['user_ids'] = '';
// Запись разделителя foreach ($receiver as $key => $user_id) {
if ($key === array_key_last($user_ids)) break; // Перебор пользователей для получения информации
else $this->robot->api['user_ids'] .= ', ';
// Запись пользователя
$this->robot->api['user_ids'] .= $user_id;
// Запись разделителя
if ($key === array_key_last($receiver)) break;
else $this->robot->api['user_ids'] .= ', ';
}
} else if (is_string($receiver)) {
// Домен
// Инициализация пользователя
$this->robot->api['user_ids'] = $receiver;
} }
// Инициализация дополнительных запрашиваемых полей if (isset($fields)) {
if (!empty($fields)) $this->robot->api['fields'] = ''; // Запрошены дополнительные запрашиваемые поля
foreach ($fields as $key => $field) { // Инициализация дополнительных запрашиваемых полей
// Перебор дополнительных запрашиваемых полей $this->robot->api['fields'] = '';
// Запись запрашиваемого дополнительного поля foreach ($fields as $key => $field) {
$this->robot->api['fields'] .= $field; // Перебор дополнительных запрашиваемых полей
// Запись разделителя // Запись запрашиваемого дополнительного поля
if ($key === array_key_last($fields)) break; $this->robot->api['fields'] .= $field;
else $this->robot->api['fields'] .= ', ';
// Запись разделителя
if ($key === array_key_last($fields)) break;
else $this->robot->api['fields'] .= ', ';
}
} }
// Инициализация падежа // Инициализация падежа
if (!empty($name_case)) $this->robot->api['name_case'] = $name_case; if (isset($name_case)) $this->robot->api['name_case'] = $name_case;
// Запрос // Запрос
$request = json_decode($this->robot->browser->request('POST', 'users.get', ['form_params' => $this->robot->api->settings])->getBody()->getContents()); $request = json_decode($this->robot->browser->request('POST', 'users.get', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
@ -90,6 +109,6 @@ final class users extends method
throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code); throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
} }
return $request->response; return is_array($receiver) ? $request->response : (isset($request->response[0]) ? $request->response[0] : null);
} }
} }

View File

@ -17,9 +17,6 @@ use mirzaev\vk\robots\robot;
* @var array $settings Настройки * @var array $settings Настройки
* @var float $version Версия API * @var float $version Версия API
* *
* @todo
* 1. Создать __isset(), __unset()
*
* @package mirzaev\vk\api * @package mirzaev\vk\api
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy> * @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/ */
@ -30,7 +27,7 @@ class settings implements ArrayAccess
* *
* Должна иметь тип string потому, что PHP при стандартных настройках удаляет нули у float * Должна иметь тип string потому, что PHP при стандартных настройках удаляет нули у float
*/ */
protected const VK_API_VERSION_DEFAULT = '5.130'; protected const VK_API_VERSION_DEFAULT = '5.131';
/** /**
* Конструктор * Конструктор
@ -176,15 +173,39 @@ class settings implements ArrayAccess
}; };
} }
// public function __unset(string $name): void /**
// { * Проверить инициализированность свойства
// match ($name) { *
// 'settings' => throw new Exception('Запрещено удалять настройки', 500), * @param string $name Название
// 'robot' => throw new Exception('Запрещено удалять робота', 500), *
// 'data', 'attachments' => $this->offsetUnset('attachments'), * @return bool Свойство инициализировано?
// default => $this->offsetUnset($name) */
// }; public function __isset(string $name): bool
// } {
return match ($name) {
'settings' => isset($this->settings),
'robot' => isset($this->robot),
'data', 'attachments' => $this->offsetExists('attachments'),
default => $this->offsetExists($name)
};
}
/**
* Деинициализированность свойство
*
* @param string $name Название
*
* @return void
*/
public function __unset(string $name): void
{
match ($name) {
'settings' => throw new Exception('Запрещено деинициализировать настройки', 500),
'robot' => throw new Exception('Запрещено деинициализировать робота', 500),
'data', 'attachments' => $this->offsetUnset('attachments'),
default => $this->offsetUnset($name)
};
}
/** /**
* Записать по смещению * Записать по смещению
@ -236,7 +257,7 @@ class settings implements ArrayAccess
/** /**
* Прочитать по смещению * Прочитать по смещению
*/ */
public function &offsetGet(mixed $offset): mixed public function offsetGet(mixed $offset): mixed
{ {
if (isset($this->settings)) { if (isset($this->settings)) {
if (strcasecmp($offset, 'settings') === 0) { if (strcasecmp($offset, 'settings') === 0) {
@ -260,7 +281,11 @@ class settings implements ArrayAccess
} }
/** /**
* Проверка существования смещения * Проверить существование смещения
*
* @param mixed $offset Сдвиг
*
* @return bool Смещение существует?
*/ */
public function offsetExists(mixed $offset): bool public function offsetExists(mixed $offset): bool
{ {