¶ Документация работы команды feedback в телеграм боте
¶ Информация о функциональности
Изначально функционал команды feedback рассчитан только для его сбора, но чтобы добиться получения их в определенной группе или в чате с определенным пользователем в телеграмме необходимо проделать некоторые действия для авторизации.
¶ Необходимые действия для авторизации
Внимание! Для авторизации необходимо не иметь работающий по данному токену телеграмм бот. Лучше проводить авторизацию до запуска любых сервисов.
- Определение чата прихода репортов
В случае работы с группой: добавить бота в группу.
В случае работы в определенном чате с пользователем: зайти в чат с ботом
- Зайти в репозиторий проекта
- Зайти в папку auth, находящуюся в корне проекта
- Cоздать образ контейнера авторизации чата репортов
docker build . -t auth_group_1
- Запустить контейнер авторизации
docker run -it --env telegram_secret = <telegram_bot_token> auth_group_1
6.Выполнить команду /register в определенном ранее чате
В консоли появится chat id соответствующего чата
внимание: минус перед числом входит в chat id
- Скопировать значение chat_id
- Выйти из терминала докера - ctrl+C.
- Остановить работу контейнера
-- это лишний пункт
docker stop auth_group_1
- Открыть файл .env, где находятся переменные окружения проекта
nano .env
- Вставить соответствующую переменную окружения
REPORTGROUPCHATID = <chat_id>, где <chat_id> -- ранее cкопированный из терминала чат id
- Закрыть и сохранить файл
¶ Описание реализации кода:
¶ Описание реализации авторизации
Директории aвторизации: ~/onlineedu/auth/run_auth.py
| Функция | Описание |
|---|---|
| get_group_chat_id() | Отображает chat id в консоле для авторизации группы |
¶ Описание реализации функциональности команды /report
Директория бота: ~/services/receive/tg.py
Схема стэйтов
- Обработка команды /report initial
- Обработка feedback (картинкой или тестовый) пользователя report
- Обработка подписи к картинке image_description
| Функция | Описание |
|---|---|
| get_state(chat_id) | Анализирует состояние пользователя в таблице TgUser |
| send_feedback(text, str = "") | Отправляет тектсовый feedback в групповой чат |
| send_image_feedback(chat_id: str) | Отправляет feedback картинкой в групповой чат |
| report_command_handler(message) | Обрабатывет команду репорт |
| handle_report(message) | Обрабатывает текстовый feedback и посылает его в групповой чат |
| handle_image_report(message) | Обрабатывает feedback картинкой |
| handle_error_image_report(message) | Обработывает картинки, посылаемой документом (ошибочный репорт картинкой) |
| handle_image_description(message) | Обрабатывает сообщения описания к картинке и посылает картинку с описанием в чат репортов |
¶ Описание дополнительных данных в бд
Для грамотного функционирования бота необходимо задать дополнительные таблицы в БД
Директория структуры БД ~/services/web/core/data/db_app.py
¶ Таблица: tguser
Поля:
- user_id - user id чата в телеграмме
- email - email пользователя в телеграмме
- state - состояние пользователя в таблице состояний
¶ Таблица: tgreportimage
Поля:
- user_id - user id чата в телеграмме
- image_id - image id отправленной картинки в телеграмме