8 Commits
3.4.x ... 4.2.0

18 changed files with 728 additions and 442 deletions

4
.gitignore vendored
View File

@@ -1 +1,3 @@
/vendor
!.gitignore
composer.phar
vendor

View File

@@ -1,5 +1,5 @@
# Колпачный фреймворк для ВКонтакте
Развивается как многопоточный фреймворк с поддержкой всех возможностей API ВКонтакте, а так же не добавленных, но необходимых функций, работу с большим количеством роботов под разными сессиями, поддерживающий PSR-спецификацию и полностью покрытый тестами
# PHP-фреймворк ВКонтакте
Многопоточный фреймворк с поддержкой всех возможностей API ВКонтакте
### Установка:
```sh

View File

@@ -1,32 +1,33 @@
{
"name": "mirzaev/vk",
"type": "framework",
"description": "Фреймворк VK API",
"description": "Framework for vk.com API",
"readme": "README.md",
"keywords": [
"vk",
"api"
],
"homepage": "https://git.hood.su/mirzaev/vk",
"homepage": "https://git.mirzaev.sexy/mirzaev/vk",
"license": "WTFPL",
"authors": [
{
"name": "Arsen Mirzaev Tatyano-Muradovich",
"email": "red@hood.su",
"homepage": "https://hood.su/mirzaev",
"email": "arsen@mirzaev.sexy",
"homepage": "https://mirzaev.sexy/mirzaev",
"role": "Programmer"
}
],
"support": {
"docs": "https://git.hood.su/mirzaev/vk/manual",
"issues": "https://git.hood.su/mirzaev/vk/issues"
"docs": "https://git.mirzaev.sexy/mirzaev/vk/wiki",
"issues": "https://git.mirzaev.sexy/mirzaev/vk/issues"
},
"require": {
"php": "~8.0",
"php": "~8.1",
"psr/log": "~1.0",
"mirzaev/accounts": "~0.1.x-dev",
"mirzaev/accounts": "~1.2.0",
"monolog/monolog": "~1.6",
"jasny/error-handler": "~0.2",
"guzzlehttp/guzzle": "~7.2"
"guzzlehttp/guzzle": "~7.5"
},
"require-dev": {
"phpunit/phpunit": "~9.5"

618
composer.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -2,7 +2,7 @@
// declare(strict_types=1);
// namespace Hood\VK\API;
// namespace mirzaev\vk\API;
// class CallBack extends CallBackAbstract
// {

View File

@@ -7,7 +7,8 @@ namespace mirzaev\vk\api;
use Exception;
use mirzaev\vk\core,
mirzaev\vk\robots\robot;
mirzaev\vk\robots\robot,
mirzaev\vk\robots\group;
/**
* LongPoll
@@ -25,7 +26,7 @@ use mirzaev\vk\core,
* @see https://vk.com/dev/groups.setLongPollSettings
*
* @package mirzaev\vk\api
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*
* @todo Добавить обработку ошибок ($request['errors];)
*/
@@ -36,14 +37,14 @@ final class longpoll
*
* @see $this->get()
*/
private string $key;
private readonly string $key;
/**
* Сервер (URL)
*
* @see $this->get()
*/
private string $server;
private readonly string $server;
/**
* Идентификатор последнего события
@@ -59,7 +60,7 @@ final class longpoll
*
* $robot Робот
*/
public function __construct(private robot $robot)
public function __construct(private robot&group $robot)
{
// Инициализация
if (empty($robot->id)) throw new Exception('Необходимо указать идентификатор ВКонтакте');

View File

@@ -0,0 +1,115 @@
<?php
declare(strict_types=1);
namespace mirzaev\vk\api\methods;
// Файлы проекта
use mirzaev\vk\robots\user;
// Встроенные библиотеки
use Exception;
/**
* Аккаунт
*
* @method public getInfo(?array $fields = null) Запросить информацию об аккаунте
* @method public getProfileInfo(?array $fields = null) Запросить информацию о профиле
*
* @see https://dev.vk.com/method/account
*
* @package mirzaev\vk\api
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class account extends method
{
/**
* Конструктор
*
* @param user $user Робот
*/
public function __construct(
protected user $robot
) {
}
/**
* Запросить информацию об аккаунте
*
* @see https://dev.vk.com/method/account.getInfo
*
* @param array $fields Выбор полей с запрашиваемой информацией (оставить пустым, если нужны все)
*
* @return ?array Информация об аккаунте, если получена
*
* @todo
* 1. Доделать
* 2. Написать обработчик ошибок возвращаемых ВКонтакте
*/
public function getInfo(array $fields = []): array
{
// Реиницилазиция
$this->robot->api->reinit();
foreach ($fields as $key => $field) {
// Перебор запрашиваемых полей с информацией
// Запись запрашиваемого поля
$this->robot->api['fields'] .= $field;
// Запись разделителя
if ($key === array_key_last($fields)) break;
else $this->robot->api['fields'] .= ', ';
}
// Запрос
$request = json_decode($this->robot->browser->request('POST', 'account.getInfo', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
// Если в ответе ошибка
if (isset($request->error)) {
throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
}
return $request->response;
}
/**
* Запросить информацию о профиле
*
* @see https://dev.vk.com/method/account.getProfileInfo
*
* @param array $fields Выбор полей с запрашиваемой информацией (оставить пустым, если нужны все)
*
* @return ?array Информация об аккаунте, если получена
*
* @todo
* 1. Доделать
* 2. Написать обработчик ошибок возвращаемых ВКонтакте
*/
public function getProfileInfo(array $fields = []): array
{
// Реиницилазиция
$this->robot->api->reinit();
foreach ($fields as $key => $field) {
// Перебор запрашиваемых полей с информацией
// Запись запрашиваемого поля
$this->robot->api['fields'] .= $field;
// Запись разделителя
if ($key === array_key_last($fields)) break;
else $this->robot->api['fields'] .= ', ';
}
// Запрос
$request = json_decode($this->robot->browser->request('POST', 'account.getProfileInfo', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
// Если в ответе ошибка
if (isset($request->error)) {
throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
}
return $request->response;
}
}

View File

@@ -4,12 +4,27 @@ declare(strict_types=1);
namespace mirzaev\vk\api\methods;
use Exception;
// Файлы проекта
use mirzaev\accounts\vk,
mirzaev\vk\robots\robot,
mirzaev\vk\api\data,
mirzaev\vk\robots\group;
use mirzaev\accounts\vk;
use mirzaev\vk\robots\robot;
use mirzaev\vk\api\data;
use mirzaev\vk\robots\group;
// Встроенные библиотеки
use stdClass,
Exception;
/**
* Режимы отправки сообщений
*/
enum mode
{
/** Быстро - случайный идентификатор (умножение на rand()) */
case random;
/** Надёжно - проверка отправки (поиск сообщения через messages.getById) */
case search;
}
/**
* Сообщение
@@ -20,16 +35,16 @@ use mirzaev\vk\robots\group;
* @see https://vk.com/dev/messages.getById
*
* @package mirzaev\vk\api
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*
* @todo Доработать строгий режим отправки: проверку сообщения в беседе (не имеет ID сообщений)
*/
final class messages extends method
{
/**
* @var int $mode Режим отправки
* @var mode $mode Режим отправки сообщений
*/
protected int $mode = 1;
protected mode $mode = mode::random;
/**
* @var array[int] Сообщения для пересылки
@@ -45,18 +60,18 @@ final class messages extends method
* Конструктор
*
* @param robot $robot Робот
* @param int|string|array|null $destination Получатель
* @param int|string|array|null $receiver Получатель
* @param string|null $text Текст
*/
public function __construct(
protected robot $robot,
int|string|array|null $destination = null,
int|string|array|null $receiver = null,
protected string|null $text = null
) {
if (isset($this->text, $destination)) {
if (isset($this->text, $receiver)) {
// Быстрая отправка
$this->send($destination);
$this->send($receiver);
}
}
@@ -108,29 +123,44 @@ final class messages extends method
*
* @see https://vk.com/dev/messages.send
*
* @param int|string|array|null $destination Получатель
* @param int|string|array|null $receiver Получатель
*
* @return int|array Идентификатор успешно отправленного сообщения или ответ сервера (подразумевается ошибка)
*
* @todo Написать обработчик ошибок возвращаемых ВКонтакте
*/
public function send(int|string|array|null $destination): int|array
public function send(int|string|array|null $receiver): int|array
{
// Идентификатор
$random_id = time();
if ($this->mode = 1) {
// Перемножение (по умолчанию)
if ($this->mode === mode::random) {
// Быстрая отправка сообщения
$random_id *= rand();
}
// Реиницилазиция
$this->robot->api->reinit();
// Цель отправки
$this->robot->api->destination($destination);
if (is_int($receiver)) {
// Идентификатор
// Инициализация идентификатора (защита от повторных отправок) в настройках API
// Инициализация получателя
$this->robot->api['peer_id'] = $receiver;
} else if (is_array($receiver)) {
// Идентификаторы
// Инициализация получателя
$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
@@ -165,8 +195,8 @@ final class messages extends method
throw new Exception('Вконтакте: ' . $request->error->error_msg, $request->error->error_code);
}
if ($this->mode >= 2) {
// Если установлен режим 2 (усиленная проверка отправленного сообщения)
if ($this->mode === mode::search) {
// Надёжная доставка сообщения
if (!empty($request["response"])) {
// Ответ получен
@@ -177,7 +207,6 @@ final class messages extends method
// Запрашиваемые сообщения
$this->robot->api['message_ids'] = $request["response"];
// Запрос
if ($this->robot->browser->request('POST', 'messages.getById', ['form_params' => $this->robot->api->settings])['response']['count'] === 0) {
// Сообщения не существует
//!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -185,7 +214,7 @@ final class messages extends method
//!!!!!!!!!!!!!!!!!!!!!!!!!
// Повторная отправка
$this->send($destination);
$this->send($receiver);
}
} else {
}
@@ -194,6 +223,59 @@ final class messages extends method
return $request->response;
}
/**
* Удалить сообщение
*
* @see https://vk.com/dev/messages.delete
*
* @param int|string|array|null $messages Получатель (message_ids + cmids)
* @param int|string|null $peer_id Идентификатор беседы
* @param bool $spam Пометить как спам?
* @param bool $delete_for_all Удалить для всех?
*
* @return int|array Идентификатор успешно отправленного сообщения или ответ сервера (подразумевается ошибка)
*
* @todo Написать обработчик ошибок возвращаемых ВКонтакте
*/
public function delete(string|int|array|null $messages = null, int|string|null $peer_id = null, bool $spam = false, bool $delete_for_all = false): stdClass
{
// Реиницилазиция настроек
$this->robot->api->reinit();
if (isset($peer_id)) {
// Получен идентификатор беседы
// Инициализация идентификатора беседы
$this->robot->api['peer_id'] = $peer_id;
// Инициализация идентификаторов сообщений
$this->robot->api['cmids'] = $messages;
// Инициализация: "удалить для всех?"
$this->robot->api['delete_for_all'] = 1;
} else {
// Не получен идентификатор беседы
// Инициализация идентификаторов сообщений
$this->robot->api['message_ids'] = $messages;
// Инициализация: "удалить для всех?"
if ($delete_for_all) $this->robot->api['delete_for_all'] = 1;
}
// Инициализация: "сообщить о спаме?"
if ($spam) $this->robot->api['spam'] = $spam;
// Запрос
$request = json_decode($this->robot->browser->request('POST', 'messages.delete', ['form_params' => $this->robot->api->settings])->getBody()->getContents());
// Проверка на наличие ошибок в ответе от ВКонтакте
if (isset($request->error)) throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
return $request->response;
}
/**
* Записать свойство
*

View File

@@ -4,58 +4,12 @@ declare(strict_types=1);
namespace mirzaev\vk\api\methods;
use mirzaev\vk\robots\robot;
/**
* Абстракция метода API
*
* @method protected static put(string $url, ...$params) Создать
* @method protected static post(string $url, ...$params) Изменить
* @method protected static get(string $url, ...$params) Получить
* @method protected static delete(string $url, ...$params) Удалить
* Абстракция метода API ВКонтакте
*
* @package mirzaev\vk\api\methods
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
abstract class method
{
/**
* Создать
*
* @return array Ответ сервера
*/
public static function put(): array
{
return ['error' => 'Метод не поддерживается'];
}
/**
* Изменить
*
* @return array Ответ сервера
*/
public static function post(): array
{
return ['error' => 'Метод не поддерживается'];
}
/**
* Получить
*
* @return array Ответ сервера
*/
public static function get(): array
{
return ['error' => 'Метод не поддерживается'];
}
/**
* Удалить
*
* @return array Ответ сервера
*/
public static function delete(): array
{
return ['error' => 'Метод не поддерживается'];
}
}

View File

@@ -20,14 +20,14 @@ use mirzaev\accounts\vk as account;
* @see https://vk.com/dev/messages.getById
*
* @package mirzaev\vk\api\methods
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*
* @todo Добавить обработку ошибок ($request['errors];)
*/
final class photos extends method
{
/**
* Создать сообщение
* Конструктор
*
* @param robot $robot Робот
*/

View File

@@ -0,0 +1,95 @@
<?php
declare(strict_types=1);
namespace mirzaev\vk\api\methods;
// Файлы проекта
use mirzaev\vk\robots\user;
// Встроенные библиотеки
use Exception;
/**
* Пользователь
*
*
* @see https://dev.vk.com/method/users
*
* @package mirzaev\vk\api
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class users extends method
{
/**
* Конструктор
*
* @param user $user Робот
*/
public function __construct(
protected user $robot
) {
}
/**
* Запросить информацию о пользователе
*
* @see https://dev.vk.com/method/users.get
*
* @param array $user_ids Выбор пользователей для запроса информации
* @param array $fields Выбор дополнительных запрашиваемых полей
* @param string $name_case Падеж
*
* @return ?array Информация об аккаунте, если получена
*
* @todo
* 1. Доделать
* 2. Написать обработчик ошибок возвращаемых ВКонтакте
*/
public function get(array $user_ids = [], array $fields = [], string $name_case = ''): array
{
// Реиницилазиция
$this->robot->api->reinit();
// Инициализация пользователей для запроса информации
if (!empty($user_ids)) $this->robot->api['user_ids'] = '';
foreach ($user_ids as $key => $user_id) {
// Перебор пользователей для получения информации
// Запись пользователя
$this->robot->api['user_ids'] .= $user_id;
// Запись разделителя
if ($key === array_key_last($user_ids)) break;
else $this->robot->api['user_ids'] .= ', ';
}
// Инициализация дополнительных запрашиваемых полей
if (!empty($fields)) $this->robot->api['fields'] = '';
foreach ($fields as $key => $field) {
// Перебор дополнительных запрашиваемых полей
// Запись запрашиваемого дополнительного поля
$this->robot->api['fields'] .= $field;
// Запись разделителя
if ($key === array_key_last($fields)) break;
else $this->robot->api['fields'] .= ', ';
}
// Инициализация падежа
if (!empty($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());
// Если в ответе ошибка
if (isset($request->error)) {
throw new Exception('ВКонтакте: ' . $request->error->error_msg, $request->error->error_code);
}
return $request->response;
}
}

View File

@@ -21,7 +21,7 @@ use mirzaev\vk\robots\robot;
* 1. Создать __isset(), __unset()
*
* @package mirzaev\vk\api
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
class settings implements ArrayAccess
{
@@ -145,36 +145,6 @@ class settings implements ArrayAccess
return $this;
}
/**
* Инициализация получателя
*
* @see mirzaev\vk\api\methods\messages Сообщения
*/
public function destination(string|array|int $target): self
{
if (is_int($target)) {
// Идентификатор
$this->settings['peer_id'] = $target;
return $this;
} else if (is_array($target)) {
// Идентификаторы
$this->settings['user_ids'] = $target;
return $this;
} else if (is_string($target)) {
// Домен
$this->settings['domain'] = $target;
return $this;
}
throw new Exception('Не удалось определить получателя', 500);
}
/**
* Записать свойство
*
@@ -219,7 +189,7 @@ class settings implements ArrayAccess
/**
* Записать по смещению
*/
public function offsetSet(mixed $offset, mixed $value): mixed
public function offsetSet(mixed $offset, mixed $value): void
{
if (isset($this->settings)) {
if (strcasecmp($offset, 'settings') === 0) {
@@ -236,21 +206,27 @@ class settings implements ArrayAccess
if (is_array($value)) {
// Жесткая запись
return $this->settings['attachments'] = $value;
$this->settings['attachments'] = $value;
return;
}
if (empty($this->settings['attachments']) || count($this->settings['attachments']) < 10) {
// Записано менее чем 10 вложений (от 0 до 9)
// Запись (конкатенация)
return $this->settings['attachments'][] = $value;
$this->settings['attachments'][] = $value;
return;
}
throw new Exception('Превышено ограничение на 10 вложений', 500);
} else {
// Запись по ключу или смещению
return $this->settings[$offset] = $value;
$this->settings[$offset] = $value;
return;
}
}

View File

@@ -24,7 +24,7 @@ use exception;
* @method public function get($id = null) Чтение из реестра
*
* @package mirzaev\vk
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class core
{
@@ -45,22 +45,22 @@ final class core
*
* Используется в логировании
*/
private string $timezone;
private readonly string $timezone;
/**
* Путь до корня проекта
*/
private string $path_root;
private readonly string $path_root;
/**
* Путь до папки журналов
*/
private string $path_logs;
private readonly string $path_logs;
/**
* Путь до временной папки
*/
private string $path_temp;
private readonly string $path_temp;
/**
* Запись в журнал

View File

@@ -21,7 +21,7 @@ use mirzaev\vk\core,
* @see Jasny\ErrorHandler
*
* @package mirzaev\vk\loggers
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class jasmo extends logger
{

View File

@@ -8,7 +8,7 @@ namespace mirzaev\vk\loggers;
* Абстрактный класс журналиста
*
* @package mirzaev\vk\loggers
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
abstract class logger
{

View File

@@ -22,7 +22,7 @@ use mirzaev\vk\robots\robot,
* @method public function __isset($name) Проверка на инициализированность свойства
*
* @package mirzaev\vk\robots
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class group extends robot
{
@@ -38,8 +38,8 @@ final class group extends robot
* @param string|null $key Ключ
*/
public function __construct(
protected int|null $id = null,
protected string|null $key = null
protected ?int $id = null,
protected ?string $key = null
) {
parent::__construct($id, $key);

View File

@@ -39,39 +39,39 @@ use GuzzleHttp\Client as browser;
* @method public function __toString() Конвертация в строку
*
* @package mirzaev\vk\robots
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
abstract class robot
{
/**
* Сессия
* @var int $session Сессия
*/
protected int $session;
protected readonly int $session;
/**
* Аккаунт
* @var account $account Аккаунт ВКонтакте
*/
private account $account;
private readonly account $account;
/**
* $messages_mode Режим отправки сообщений
* @var api $api API ВКонтакте
*/
protected int $messages_mode = 1;
protected readonly api $api;
/**
* @var api API ВКонтакте
* @var browser $browser Браузер
*/
protected api $api;
protected readonly browser $browser;
/**
* Конструктор
*
* @param int|null $id Идентификатор
* @param string|null $key Ключ
* @param int|null $id Идентификатор робота
* @param string|null $key Ключ API ВКонтакте
*/
public function __construct(
protected int|null $id = null,
protected string|null $key = null
protected ?int $id = null,
protected ?string $key = null
) {
// Инициализация ядра
$core = core::init();
@@ -183,14 +183,13 @@ abstract class robot
public function __set(string $name, mixed $value): void
{
match ($name) {
'id' => isset($this->id) ? throw new Exception('Запрещено перезаписывать идентификатор', 500) : $this->id = (int) $value,
'session' => isset($this->session) ? throw new Exception('Запрещено перезаписывать сессию', 500) : $this->session = (int) $value,
'id' => empty($this->id) ?: $this->id = $value,
'session' => empty($this->session) ?: $this->session = $value,
'key' => $this->key((string) $value),
'account' => $this->account($value),
'api' => $this->api(),
'browser' => isset($this->browser) ? throw new Exception('Запрещено перезаписывать браузер', 500) : $this->browser = $value,
'messages_new' => $this->messages_new = (int) $value,
default => throw new Exception("Свойство $name не найдено", 404)
'browser' => empty($this->browser) ?: $this->browser = $value,
'messages_new' => $this->messages_new = (int) $value
};
}
@@ -219,23 +218,16 @@ abstract class robot
}
/**
* Проверить свойство на инициализированность
* Проверить на инициализированность
*
* @param string $name Название
*
* @return mixed
* @param mixed $name Название
*/
public function __isset(string $name): bool
{
return match ($name) {
'id' => isset($this->id),
'session' => isset($this->session),
'key' => isset($this->key),
'account' => isset($this->account),
'api' => isset($this->api),
'browser' => isset($this->browser),
'messages_new' => isset($this->messages_new),
default => throw new Exception("Свойство $name не найдено", 404)
default => false
};
}

View File

@@ -12,7 +12,7 @@ use mirzaev\accounts\vk as account;
* Робот-пользователь
*
* @package mirzaev\vk\robots
* @author Arsen Mirzaev Tatyano-Muradovich <red@hood.su>
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class user extends robot
{
@@ -23,8 +23,8 @@ final class user extends robot
* @param string|null $key Ключ
*/
public function __construct(
protected int|null $id = null,
protected string|null $key = null
protected readonly int|null $id = null,
protected readonly string|null $key = null
) {
parent::__construct($id, $key);