Телеграм 1С Вебхуки Апач Самоподписанный сертификат / Хабр

Эта статья является дополнением к предыдущей «

Пишем бота для Telegram и хостим его на heroku

». Здесь я покажу, как сделать бота с поддержкой вебхуков на Heroku и с самоподписанным сертификатом на своём сервере. Расскажу о новых возможностях библиотеки tgbots-module, а также покажу пример встраивания двух ботов в один проект.

Содержание  – tgbots-module
– 1. Базовая реализация бота
– 2. Добавляем систему команд
– 3. Команда на регулярных выражениях
– 4. Группа команд
– 5. config.yaml и профили
– 6a. Запуск на Heroku
– 6b. Запуск на своём сервере с самоподписанным сертификатом
– 7. Второй модуль бота

tgbots-module
tgbots-module основана на библиотеке TelegramBots и имеет ряд улучшений:

  • Возможность вести разработку ботов в отдельных проектах, а затем собирать всех в одном исполняемом файле. Это позволяет работать над каждым ботом отдельно, заводить для них отдельные репозитории и т.д.
TelegramBots поддерживает регистрацию нескольких обработчиков для ботов в одном проекте, но для отключения бота приходится пересобирать проект. В tgbots-module для включения/отключения бота можно просто добавить или удалить строчку в конфиге, а затем перезапустить приложение.

  • Возможность переключать способ получения обновлений с long polling на webhook и обратно без пересборки проекта. В TelegramBots для этого нужно менять базовый класс (TelegramLongPollingBot и TelegramWebHookBot), а затем пересобирать проект.

  • Система команд с поддержкой ролей. Есть простые текстовые команды (/start, /help), команды с аргументами (/say hello), команды на регулярных выражениях (/donate (d{1,3})) и команды для CallbackQuery и InlineQuery.

  • Различные улучшения в API и полезные утилиты. Загрузчик yaml-конфигов, классы для локализации ботов, препроцессинг методов API. Есть возможность вызывать методы Telegram API из класса Methods. В таком случае появляются дополнительные полезные методы, которых нет в TelegramBots:

Можно вызывать синхронный

.call(this)

, а можно асинхронный

.callAsync(this)

.

1. Базовая реализация бота
Чтобы было проще понять, на каком этапе что реализуется, я разбил создание двухмодульного бота на мелкие шаги. Начнём с создания простого бота. Можно смотреть коммит.

Создаём модуль бота и его обработчик:

Токен и юзернейм бота будут браться из yaml конфига testbot.yaml:

И помещаться в объект:

В конфиге строчка

env(TOKEN)

говорит о том, что значение следует взять из переменной окружения. Это в дальнейшем будет полезно при работе с Heroku. Чтобы поместить токен в переменную окружения, можно настроить Run configurations в идее:

Содержимое метода onUpdate должно быть уже вам знакомо по библиотеке TelegramBots: если в update приходит сообщение боту, в котором есть текст, то выводит id юзера в консоль и отправляем этот же текст в верхнем регистре юзеру.

Запускаем проект, пишем боту и получаем ответ:

2. Добавляем систему команд
Добавляем систему команд с простой текстовой командой /start:

Система команд поддерживает разделение прав доступа. Можно задать команду, которая будет доступна только главному админу бота. По умолчанию команда доступна всем пользователям.

Чтобы реестр команд понимал кто есть кто, нужно реализовать интерфейс Authority или воспользоваться встроенным SimpleAuthority, которому нужно передать userId главного админа бота. Как обычно, чтобы не хардкодить, добавляем значение в конфиг:

Наконец, нужно добавить строку в onUpdate:

Коммит

со всеми изменениями на этом шаге.

3. Команда на регулярных выражениях
Обработчики простых команд удобно регистрировать лямбдой, а вот команды побольше лучше вынести в отдельный класс. Рассмотрим пример команды, которая распознаёт ссылку на YouTube:

Для RegexCommand указываем регулярное выражение, роли и сам обработчик.

Чтобы зарегистрировать команду, нужно добавить одну строчку:

Коммит

для этого шага.

4. Группа команд
Ещё одной полезной возможностью является вынесение команд в группу.
Например, есть простая текстовая команда /game, которая создаёт игру и отправляет сообщение с inline-клавиатурой. Также есть команда для обработки CallbackQuery этой игры. Почему бы не задать эти команды в одном классе?

callback data для inline-кнопки выглядит так:

Где, guess это команда, распознаваемая системой команд, а всё остальное — аргументы. Они разделяются пробелом и их можно достать по порядковому номеру через

ctx.argument(..)

Регистрируем набор команд:

Коммит

с изменениями.

5. config.yaml и профили
В config.yaml задаются настройки вебхуков, а также перечисляются модули ботов:

Именно здесь можно переключать long polling и webhook, а также отключать ботов.

Конфиг можно размещать как файл, либо как ресурс внутри приложения (удобно, если бот запускается на Heroku).

При этом, конфиг не является обязательным. По умолчанию используется long polling, а модулем становится тот, который указан в main:

Также есть поддержка профилей. Профиль по умолчанию использует config.yaml, но если задать профиль test или prod, то использоваться будут config-test.yaml или config-prod.yaml соответственно.

Чтобы указать профиль, необходимо передать его первым аргументом в Runner. Я делаю это из командной строки:

Всё это позволяет запускать одного бота на лонг поллинге при разработке, и всех ботов на вебхуках уже в продакшене.

Коммит для этого шага.

6a. Запуск на Heroku
Добавляем Procfile:

Так как используется Java 11, указываем это в system.properties:

Также добавляем gradle таск stage в build.gradle:

Иначе Heroku не сможет собрать приложение.

Не забываем добавить файл config.yaml:

Heroku запускает веб-приложение каждый раз на разном порту, заранее узнать и записать значение порта нельзя. Но поскольку номер порта помещается в переменную окружения PORT, можно указать env(PORT) в конфиге.

То же самое проделываем с URL, чтобы не коммитить новый адрес при смене приложения в Heroku.

Создаём приложение в Heroku, добавляем в Config Vars токен от бота и адрес приложения:

Деплоим бота из гитхаба или из Heroku Git и радуемся работающему на вебхуках боту.

В отличие от лонг поллинга, который держит приложение всегда активным и, тем самым отъедая бесплатную квоту, бот на вебхуках может засыпать при длительном бездействии, что экономит дино-часы. Пробуждение составляет порядка 10-15 секунд, это вполне терпимо для обычного бота, но совершенно не подходит для инлайн ботов, имейте в виду.

6b. Запуск на своём сервере с самоподписанным сертификатом
Имеем: Debian или Ubuntu сервер, на котором порты 80 и 443 заняты основным сайтом, но хочется на нём запустить бота на вебхуках на порту 8443, который, благо, поддерживается телеграмом.

Допустим, IP-адрес сервера 123.45.67.89, находится он в Москве.

1. Создаём сертификат при помощи openssl
certgen.sh

Изменяем IP адрес и информацию о локации сервера на этой строчке:

Запускаем скрипт, придумываем и вводим несколько раз пароль от сертификата, получаем в итоге два файла:

keystore.jks

и

public_cert.pem

.

2. Настраиваем вебхуки в config.yaml

3. Запускаем приложение со всеми необходимыми переменными окружения

7. Второй модуль бота
Если вы планируете запускать бота на собственном сервере, а не на Heroku, тогда можно создать Gradle Multiproject в котором подпроектами будут отдельные модули бота:

При этом остаётся возможность держать отдельные модули в отдельных репозиториях, запускать их по отдельности при отладке и собирать все модули в один jar при сборке.

Но Heroku требует лишь один репозиторий. И чтобы подключить второй репозиторий как зависимость для первого и основного, мы воспользуемся JitPack.

Создаём отдельный проект со вторым ботом (можно сразу смотреть весь репозиторий tgbotsmodule-bot2).

В build.gradle должны присутствовать как минимум эти три плагина:

Первый позволит точнее указывать зависимости (

api

,

implementation

), второй позводит запускать приложение для отладки, а третий подготовит нужные файлы для релиза.

Так как используется Java 11, создаём файл jitpack.yml:

Создаём конфиг для второго бота secondbot.yaml:

Не забываем о возможном конфликте переменных окружения, токен для второго бота должен задаваться в другой переменной, нежели токен для первого.

config.yaml у второго ботмодуля в этот раз уже не понадобится, он будет у главного приложения.

В главном приложении в build.gradle добавляем новый репозиторий maven и зависимость:

Правильно подключить зависимость поможет главная страница

https://jitpack.io/

Вставляем адрес репозитория и нажимаем Look up, а напротив нужного коммита кнопку Get it:

Ниже появятся инструкции для подключения зависимости в проект.

В config.yaml главного приложения добавляем ещё один модуль:

Остаётся только запушить изменения на гитхаб, добавить в Heroku новую переменную окружения с токеном для второго бота и сделать Deploy.

Коммит с изменениями на этом шаге.

После успешного деплоя, оба бота будут работать на вебхуках в одном проекте.

Посмотреть в действии можно тут:

Первый бот

:

@tgbotsmodulebot

(

исходники

)

Второй бот

:

@tgbotsmodule2bot

(

исходники

)

Много строк исписано про интеграцию Телеграма и 1С. Но нигде не увидел полной инструкции по установке и настройке вебхуков. Попробую её написать.

Для всего этого нам понадобится (или правильнее будет сказать, что было использовано мной):

1. Apache 2.2.24
2. OpenSSL (входящий в установку апача)
3. 1C (с модулями веб-сервера)
4. Свой домен
5. Созданный бот в Телеграм (не буду описывать его создание, т.к. оно достаточно тривиально)

Предполагается, что весь софт у вас установлен.

Итак, начнем с получения сертификата. Открываем командную строку и выполняем следующий код:

openssl req -newkey rsa:2048 -sha256 -nodes -keyout YOURPRIVATE.key -x509 -days 365 -out YOURPUBLIC.pem -subj "/C=US/ST=New York/L=Brooklyn/O=Example Brooklyn Company/CN=YOURDOMAIN.EXAMPLE"

Где:

YOURPRIVATE.key — закрытый ключ сертификата. Будет использован в апаче

YOURPUBLIC.pem — открытый ключ сертификата. Будет использован при регистрации вебхука

YOURDOMAIN.EXAMPLE — адрес вашего домена с вебхуком. Должен таки совпадать с адресом вебхука!!!

После выполнения этого кода в папке openssl ( у меня это «C:Program FilesApache Software FoundationApache2.2bin») появятся файлы ключей.

Я их скопировал в папку conf апача.

Переходим к настройке Apache.

Я видел много разных способов. У меня сработал следующий:

В httpd.conf добавлены следующие строки:

Listen 443 

для того, чтобы апач «слушал» 443 порт.

Блок <IfModule ssl_module> приведен к следующему виду:

<IfModule ssl_module>
SSLMutex default
SSLSessionCache none
</IfModule>

В самом конце добавлены строчки, где указываю пути к сертификату:

SSLEngine On
SSLCertificateFile conf/YOURPUBLIC.pem
SSLCertificateKeyFile conf/YOURPRIVATE.key

И раскомменитурйте строчку:

LoadModule ssl_module modules/mod_ssl.so 

В конфигурации создаем HTTP-сервис. Именно он будет отвечать телеграму и обрабатывать его обращения.

В моём случае указаны следующие параметры:

Имя: ТГВебхук
КорневойURL: webhook
Повторное использование сеансов: Не использовать (с автоматическим режимом у меня не заработало)
Время жизни: 20
Шаблоны URL: создан шаблон «Любой» с двумя методами: GET и POST

Обработчики методов создаются по умолчанию. В обработчик POST добавлю следующее, просто для проверки связи:

Функция ЛюбойPOST(Запрос)

	ВыслатьТестовоеСообщение(""); //chat_id
	Ответ = Новый HTTPСервисОтвет(200);
	Возврат Ответ;
	
КонецФункции


&НаСервере
Процедура ВыслатьТестовоеСообщение(Чат)
	
		Сообщение = "Тестовое сообщение";
		Токен = "";//Ваш токен telegram
		Сервер = "api.telegram.org";
	    Ресурс = "bot"   Токен   "/sendMessage?chat_id="   СтрЗаменить(Формат(Чат, "ЧДЦ=; ЧС=; ЧРГ=."), ".", "")   "&text="   Сообщение;
   		Соединение  =  Новый HTTPСоединение(Сервер,443,,,,,Новый ЗащищенноеСоединениеOpenSSL());
		Запрос = Новый HTTPЗапрос(Ресурс);
		Ответ = Соединение.Получить(Запрос);
	
КонецПроцедуры

Осталось опубликовать базу и привязать вебхук.

Публикация делается как всегда, необходимо только добавить галочки на публикации HTTP-сервиса:

Последним шагом мы привяжем нашу 1С к телеграму. Я для этого использовал простую html страничку со следующим кодом:

<html>
<body>

<form action="https://api.telegram.org/bot<ЗдесьДолженБытьТокен>/setwebhook" method="post" enctype="multipart/form-data">
    Select Certificate to upload:
    <input type="file" name="certificate" id="fileToUpload">
	URL: <input type="text" name="url"  value="https://<YOURWEBSITE>/<YOUR_PHP_URL>"><br>
    <input type="submit" value="Upload Certificate" name="submit">
</form>

</body>
</html>

В форме просто выбираем публичный ключ и вводим полный путь к нашему http-сервису. Напоминаю, что полный путь к сервису будет выглядеть следующим образом:

ВашДомен/ИмяБазы/hs/ИмяСервиса/v1

Прошу не пинать ногами за код, некоторые вещи умышленно сделаны хардкодом, т.к. это всё делалось исключительно в демонстрационных целях.

Публикация была написана, т.к. ни одного рабочего примера по работе с вебхуками на сайте не нашел, кроме Конструктор ботов Телеграм. Но она платная и, возможно, не всем нужна в таком виде.

В архиве содержится установка апача 2.2.24 вместе с Openssl (почему-то поиск оной занял у меня много времени), файл html для регистрации вебхука, файл конфигурации апача и cf конфигурации с http-сервисом и примером отправки тестового сообщения. К скачиванию необязателен, т.к. всё содержимое есть в статье.