northmule/telegram-antisapm-registrations-bot

Skeleton of the Laminas application with a module for combating spam registration in the Telegram group

1.1.2 2021-11-21 17:54 UTC

Requires

• php: >=7.4
• ext-pdo: *
• doctrine/doctrine-orm-module: ^3.1
• doctrine/migrations: ^3.0
• doctrine/orm: ^2.7
• northmule/telegram-bot-anti-registration: ^1.1.0
• ramsey/uuid: ^4.1
• vlucas/phpdotenv: ^5.2

Requires (Dev)

• phpstan/phpstan: ^1.2
• phpstan/phpstan-doctrine: ^1.0
• slevomat/coding-standard: ^7.0
• squizlabs/php_codesniffer: ^3.6

MIT

README

Приложение использует элементы Laminas Framework, так же за основу скелета приложения взята структура Laminas Framework (Бывший Zend Framework)

Для чего этот бот применим

1. Для борьбы с автоподпиской на группу
2. Для блокирования всех тех кто не смог ответить на простой вопрос
3. Автоматически блокирует ботов (без вопросов)

Что умеет БОТ

1. Блокировать все действия пользователя после его вступления в группу
2. Разблокировать все (не ограниченные глобально) действия пользователя после ответа на вопрос
3. Удалить после удачного ответа за собой сообщение
4. Поприветствовать пользователя

Запуск на своём домене

1. Клонируйте репозитарий
2. Настройте ваш сервер так что бы корнем сайта была папка public
3. Переименуйте файл .env.dist в .env
4. Настройте данные в .env
5. Если всё верно - вы увидите страницу приветствия (базовый шаблон приложения)

Настройка

1. В первую очередь создайте своего бота в Telegram
2. После создания своего бота у вас будет (Токен и имя бота)
3. Заполните все значения в файле .env
4. Выполните миграцию таблиц Doctrina или выполните запрос на создание нужной таблицы в вашей MySQL

CREATE TABLE `coderun_bot_telegram_users_chat` (
	`id` INT(11) NOT NULL AUTO_INCREMENT,
	`userId` BIGINT(20) NULL DEFAULT NULL COMMENT 'ИД пользователя Телеграм',
	`userName` VARCHAR(250) NULL DEFAULT NULL COMMENT 'логин пользователя' COLLATE 'utf8_unicode_ci',
	`approved` TINYINT(1) NOT NULL COMMENT 'Можно писать в чат или нет',
	`languageCode` VARCHAR(20) NULL DEFAULT NULL COMMENT 'Код языка' COLLATE 'utf8_unicode_ci',
	`chatId` BIGINT(20) NOT NULL COMMENT 'ИД чата',
	`chatName` VARCHAR(250) NULL DEFAULT NULL COMMENT 'Имя чата' COLLATE 'utf8_unicode_ci',
	`dateCreated` DATETIME NULL DEFAULT NULL COMMENT 'Дата создания записи',
	`dateUpdated` DATETIME NULL DEFAULT NULL COMMENT 'Дата обновления записи',
	`uuid` VARCHAR(36) NULL DEFAULT NULL COMMENT 'Уникальный код, автогенерируется при вставке' COLLATE 'utf8_unicode_ci',
	`dtype` VARCHAR(255) NOT NULL COLLATE 'utf8_unicode_ci',
	PRIMARY KEY (`id`) USING BTREE,
	UNIQUE INDEX `UNIQ_2F8DF3B6D17F50A6` (`uuid`) USING BTREE,
	INDEX `user_in_chat_idx` (`userId`, `chatId`) USING BTREE
)
COMMENT='Пользователи чата'
COLLATE='utf8_unicode_ci'
ENGINE=InnoDB
AUTO_INCREMENT=2;

1. Выполните запрос в браузере "https://Ваш_домен/telegram-bot/set-hook" (APP_MODULE_TELEGRAM_BOT_HOOK_URL - должен содержать https://ваш_домен в .env)
2. Если результат положительный, установите в .env APP_MODULE_TELEGRAM_DISABLE_SET в значение 1
3. Создайте Группу и добавьте туда вашего бота. Сделайте бота администратором группы
4. Протестируйте результат

Примеры

1. Пример развёрнутого приложения Здесь
2. Бот которого можно добавить в свою группу и посмотреть как он работает @akismetBot
3. Боту @akismetBot необходимы права администратора

Ещё....

1. Ошибки записываются в лог в /data/logs
2. Лог запросов от сервиса Телеграм записывается в лог в /data/logs
3. Базовая информация о пользователях сохраняется в MySQL
4. Есть несколько событий на которые можно подписаться

Дополнительная информация

Ссылки на документацию сторонних источников

1. Laminas
2. PHP Telegram CORE
3. TelegramAPI
4. Основная логика бота