Как написать чат бота для telegram на javascript

npm install --save node-telegram-bot-api

const TelegramBot = require('node-telegram-bot-api');

const token = 'YOUR_TELEGRAM_BOT_TOKEN';

const bot = new TelegramBot(token, {polling: true});

bot.on('message', (msg) => {

     //anything

});

const TelegramBot = require('node-telegram-bot-api');
const token = 'YOUR_TELEGRAM_BOT_TOKEN';
const bot = new TelegramBot(token, {polling: true});

bot.on('message', (msg) => {

  //anything

});

bot.on('message', (msg) => {

var Hi = "hi";
if (msg.text.toString().toLowerCase().indexOf(Hi) === 0) {
bot.sendMessage(msg.chat.id,"Hello dear user");
}

});

bot.on('message', (msg) => {

var hi = "hi";
if (msg.text.toString().toLowerCase().indexOf(hi) === 0) {
bot.sendMessage(msg.chat.id,"Hello dear user");
}

var bye = "bye";
if (msg.text.toString().toLowerCase().includes(bye)) {
bot.sendMessage(msg.chat.id, "Hope to see you around again , Bye");
}

});

bot.onText(//start/, (msg) => {

bot.sendMessage(msg.chat.id, "Welcome");

});

bot.onText(//sendpic/, (msg) => {

bot.sendPhoto(msg.chat.id,"https://www.somesite.com/image.jpg" );

});

bot.onText(//sendpic/, (msg) => {

bot.sendPhoto(msg.chat.id,"https://www.somesite.com/image.jpg",{caption : "Here we go ! nThis is just a caption "} );

});

bot.onText(//start/, (msg) => {

bot.sendMessage(msg.chat.id, "Welcome", {
"reply_markup": {
    "keyboard": [["Sample text", "Second sample"],   ["Keyboard"], ["I'm robot"]]
    }
});

});

bot.on('message', (msg) => {
var Hi = "hi";
if (msg.text.toString().toLowerCase().indexOf(Hi) === 0) {
    bot.sendMessage(msg.chat.id, "Hello dear user");
}
var bye = "bye";
if (msg.text.toString().toLowerCase().includes(bye)) {
    bot.sendMessage(msg.chat.id, "Hope to see you around again , Bye");
}
var robot = "I'm robot";
if (msg.text.indexOf(robot) === 0) {
    bot.sendMessage(msg.chat.id, "Yes I'm robot but not in that way!");
}
});

var Hi = "hi";
if (msg.text.toString().toLowerCase().indexOf(Hi) === 0) {
    bot.sendMessage(msg.from.id, "Hello  " + msg.from.first_name);
}

bot.on('message', (msg) => {

 var Hi = "hi";
 if (msg.text.toString().toLowerCase().indexOf(Hi) === 0) {
   bot.sendMessage(msg.chat.id,"<b>bold</b> n <i>italic</i> n <em>italic with em</em> n <a href="http://www.example.com/">inline URL</a> n <code>inline fixed-width code</code> n <pre>pre-formatted fixed-width code block</pre>" ,{parse_mode : "HTML"});
   }
});

<b>bold</b>, <strong>bold</strong>
<i>italic</i>, <em>italic</em>
<a href="http://www.example.com/">inline URL</a>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>

*bold text*
_italic text_
[text](http://www.example.com/)
`inline fixed-width code`

bot.on('message', (msg) => {
    var location = "location";
    if (msg.text.indexOf(location) === 0) {
        bot.sendLocation(msg.chat.id,44.97108, -104.27719);
        bot.sendMessage(msg.chat.id, "Here is the point");

    }
});

bot.on('message', (msg) => {

var bye = "bye";
if (msg.text.toString().toLowerCase().includes(bye)) {
bot.sendMessage(msg.chat.id, "Have a nice day " + msg.from.first_name);
}

});

bot.on('message', (msg) => {

var what = "idiot";
if (msg.text.includes(what)) {
bot.kickChatMember(msg.chat.id,  msg.from.id);
}

});

Как всем уже давно известно, в популярном клиенте для обмена мгновенными сообщениями Telegram появилась возможность создавать специальных ботов, которые могут оказаться весьма полезными, будучи добавленными в групповые чаты. Боты могут показывать участникам конференции различную полезную информацию, будь то последние новости какого-либо интересного сайта, погоду или курс валют. Функциональность программ для ботов практически не ограничена, например, можно реализовать бота, который будет отправлять в приватный или групповой чат фотографию с подключенной к компьютеру Web-камеры или мониторить температуру процессора на сервере. К примеру, запустив программу бота на домашнем компьютере, можно будет следить за какими-нибудь его показателями удалённо, просто отправляя команды боту с любого устройства, на котором установлен клиент Telegram. Однако, существует несколько ограничений, которые реализованы на уровне Telegram Bot API:

• Во-первых, бот не может написать первым, он должен обязательно отозваться на команду пользователя;
• Во-вторых, боты не могут отвечать на сообщения друг-друга.

Это сделано для того, чтобы усложнить жизнь различным мошенникам и спаммерам и предотвратить возможность неконтролируемого флуда множества ботов в чатах. Создавая программу, всегда нужно помнить об этих ограничениях.

Дайджест-бот, отдающий накопленные сообщения за день в процессе работы. Скриншот из Desktop’ного клиента Telegram.

Для сообщества любителей мобильных гаджетов от Motorola — MotoFan.Ru существует весьма активная конференция в Telegram, участником которой я также являюсь. Мной было замечено, что для того, чтобы отметить значимое событие, произошедшее в течении дня, или какую-нибудь важную информацию, пользователи часто прибегают к использованию тега #digest. Подобным тегом отмечаются сообщения, которые по мнению участников конференции необходимо добавить в сводку текущий событий. При этом посетители группового чата, которые появляются в конференции достаточно редко, могут не читать огромное количество оставленных ранее сообщений, а выделить с помощью тега #digest только основную информацию. Но для этого им нужно воспользоваться поиском тега по сообщениям и попрыгать по листингу чата, что достаточно неудобно. Поэтому возникла идея создания дайджест-бота, который будет накапливать и сохранять все сообщения участников конференции, отмеченные тегом #digest за какой-либо срок, например, за неделю, а потом выдавать их скопом по команде /digest в чат. Это весьма удобно, в отличие от ручного поиска необходимых сообщений.

Содержание:

1. Знакомьтесь, Гаечка :3
2. Подготовка окружения к созданию бота на JavaScript и Node.js
3. Создаём профиль бота с помощью @BotFather
4. Реализация простейшего Hello World!-бота на JavaScript
5. Реализация дайджест-бота на JavaScript
5.1. Обработчик тега #digest
5.2. Обработчик команды /digest
5.3. Функция deleteObsoleteDigestMessages()
5.4. Генерация ответа бота на команду /digest
5.5. Заключение по дайджест-боту
6. Реализация валютного бота на JavaScript
7. Реализация упрощённого дайджест-бота на Python
8. Реализация бота, отправляющего случайную цитату с bash.im, на JavaScript
9. Реализация JavaScript-ботов, работающих со стикерами, мультимедийными объектами и интерактивными кнопками
9.1. Бот, отправляющий в ответ на стикер свой стикер
9.2. Бот, отправляющий в ответ на команду мультимедийный объект в чат
9.3. Бот, работающий с интерактивными кнопками
10. Заключение, полезные ссылки и ресурсы

1. Знакомьтесь, Гаечка :3

Из идеи, описанной выше, родилась Гаечка, программа, реализующая функциональность простейшего дайджест-бота.

Gadget Hackwrench — оригинальное имя персонажа из мультфильма Chip ‘n Dale Rescue Rangers, которое российскими локализаторами было переведено как Гаечка.

Позже Гаечке были добавлены некоторые другие возможности, которые часто были нужны участникам конференции MotoFan.Ru: например, демонстрация различных финансовых графиков, валютные котировки и курс драгоценных металлов по ЦБ РФ. Команда /digest стала понимать аргументы, например, /digest 2 выводит сводку событий за два дня, а /digest 7 за неделю. Но реализация этого функционала — это уже другая история, которая не будет затронута в рамках этой статьи. Поскольку исходный код бота был выложен под лицензией MIT, любой желающий может посмотреть на то как и каким образом работает программа и, кроме того, поучаствовать в её разработке. Ссылку на исходный код можно найти в конце статьи.

<< Перейти к содержанию

2. Подготовка окружения к созданию бота на JavaScript и Node.js

Благодаря тому, что команда разработчиков Telegram реализовала простой и хорошо документированный API для работы с ботами, привязки к различным языкам программирования и популярным современным технологиям не заставили себя ждать. Для реализации задуманной идеи я выбрал связку языка программирования JavaScript и фреймворка Node.js, поскольку для Node.js был доступен хорошо документированный пакет node-telegram-bot-api, являющийся абстракцией и удобной надстройкой над официальным Telegram Bot API. С языком программирования JavaScript я уже сталкивался и немного знаком с ним вкупе с технологией QtQuick/QML. Именно поэтому мной и был выбран Qt Creator в качестве IDE для разработки. Эта среда предоставляет базовую поддержку JavaScript, которую с лихвой хватило для удобной навигации по коду проекта. Кроме самого JavaScript’а меня прельстила простота установки необходимых зависимостей в Node.js с помощью специального менеджера пакетов, а также лёгкость разворачивания приложения на любом GNU/Linux-сервере. Реализация дайджест-бота на языке программирования Python отошла в «долгий ящик» и была написана лишь по просьбе одного из участников конференции, её можно будет посмотреть ниже. Выбор языка и технологии для имплементации вашего бота это дело вкуса, вы сами должны решить что для вас наиболее предпочтительно.

Работа с JavaScript кодом дайджест-бота в Qt Creator IDE (кликабельно).

Итак, подготовим окружение, необходимое для запуска и написания бота. Предполагается, что вы работаете в любом deb-based дистрибутиве GNU/Linux и имеете навык работы с консолью. Пользователи дистрибутивов, отличных от deb-based могут самостоятельно найти аналоги устанавливаемых пакетов в своих репозиториях и инсталлировать их с помощью соответствующего системного пакетного менеджера. Пользователи MS Windows тоже могут произвести инсталляцию необходимых программ, но идеологически правильнее будет развернуть виртуальную машину с любым GNU/Linux дистрибутивом в специальной программе виртуализации, например, в бесплатном VMWare Player.

Установку Node.js и сопутствующего ему пакетного менеджера можно произвести следующими командами, введя их в терминале:

Затем, необходимо создать директорию, в которой можно будет ставить эксперименты и разворачивать бота и перейти в неё. Это тоже проще всего сделать из терминала:

Тильда (~) перед названием директории означает обращение к вашему домашнему каталогу. Вы можете создать директорию для экспериментов в любом удобном для вас месте. Теперь в свежесозданный каталог нужно установить необходимые пакеты с помощью пакетного менеджера Node.js:

Каталог со всеми необходимыми компонентами для запуска бота, эмулятор терминала Konsole.

Заметьте, что пакеты установятся локально в ту директорию, в которой вы находитесь. В нашем случае это ~/Deploy/. Вы можете установить их глобально в систему, для этого у npm install существует специальный ключ −−global. Пакет node-telegram-bot-api, как было сказано выше, необходимая обёртка над официальным Telegram Bot API, связывающая его с Node.js, а пакет request может пригодиться нам для получения различных файлов из Интернета. В общем случае он не нужен и обычно уже идёт в стандартной поставке вместе с Node.js, но это зависит от дистрибутива. Скорее всего вам вовсе не потребуется эта зависимость, но на всякий случай установим и её.

Итак, окружение готово к работе. Теперь ваш компьютер является сервером для различных приложений на Node.js, частным случаем которых являются боты для Telegram. При желании бота можно будет перенести на какой-нибудь вменяемый хостинг, поддерживающий Node.js и запускать его оттуда. Для отладки Node.js приложений можно воспользоваться специальной облачной Web-платформой Cloud9 IDE.

И ещё нужно отметить кое-что важное, существует две разновидности ботов для Telegram: WebHook-боты с подписанным HTTPS-сертификатом и так называемые Polling-боты. Первых ботов дёргает главный сервер Telegram’а, а вторые сами постоянно ходят на сервер и сканируют чаты на предмет новых сообщений в них. Для реализации ботов первого типа нужен специальный валидный HTTPS-сертификат, причём самоподписанный не годится, поэтому рассматривать в этой статье мы их не будем. Для экспериментов и для простеньких ботов с головой хватит и Polling-режима, задержка в полсекунды не слишком критична на мой взгляд. Эти режимы регламентируются официальным Telegram Bot API и имеют полную реализацию во всех популярных пакетах-обёртках, в node-telegram-bot-api в том числе. При желании и наличии подходящего сертификата вы можете переделать Polling-бота в WebHook-бота, использующего HTTPS-сертификат, следуя официальной документации.

На этом теоретическая часть закончена. Переходим к следующим действиям.

<< Перейти к содержанию

3. Создаём профиль бота с помощью @BotFather

Для экспериментов нам потребуется «физическая сущность» бота в сети Telegram, его профиль, который можно добавлять в групповые чаты или просто начать с ним персональную беседу. Бот должен быть связан с запущенной на вашем компьютере программой посредством специального индивидуального и уникального токена. Заметьте, что этот токен предоставляет доступ к «физической сущности» вашего бота, а следовательно должен быть секретным. К счастью, если токен скомпрометирован, функционал Telegram позволяет его отозвать.

Пример создания профиля бота с помощью @BotFather. Установка изображения аватара в профиль.

@BotFather является специальным ботом, который может создавать профили других ботов, а так же выдавать их токены. Для создания собственного профиля будущего бота, просто начните разговор с @BotFather, после чего он добавится вам в список контактов. Небольшой совет: отправив сообщение, содержащее «@BotFather» в любой чат, вы получите ссылку на профиль бота и возможность начать разговор с ним, просто нажав кнопку «Send Message».

Для создания бота @BotFather‘у в чат необходимо отправить команду /newbot, после чего задать его имя, которое будет отображено в профиле и username, через который пользователи Telegram смогут получить ссылку на профиль. Заметьте, что username обязательно должен заканчиваться на «_bot», например, @MySuperTest_bot. Выберите тот username, который нравится вам и не занят. После того, как вы отправите всю необходимую информацию, @BotFather должен выдать вам уникальный токен бота. Рекомендую записать его в текстовый файл, сохранить и спрятать куда-нибудь в укромное местечко.

Общие команды бота вместе с описанием, установленные с помощью /setcommands и быстрый доступ к ним.

Далее, отправляя @BotFather‘у команды, начинающиеся с «/set» можно настроить различные параметры бота, например: установить ему имя, аватар, текст в профиль и описание. Всё достаточно интуитивно и прозрачно, но есть пара важных моментов.

Разберёмся сначала с командой /setcommands; она устанавливает команды, которые будут отображены в чате по нажатию специальной пиктограммы быстрого доступа (см. изображение выше). Кроме того, пользователь может быстро выбрать необходимую ему команду бота во всплывающей подсказке, просто набрав в чате «/». Весьма важно заполнить эту информацию, пример формата заполнения следующий:

Рекомендую сохранить текст описания команд в какой-нибудь файл, так как при изменении этого списка вам придётся его отправлять заново.

Следующие команды, на которые надо обратить особое внимание, это /setjoingroups и /setprivacy. Первая команда даёт возможность пользователям добавлять вашего бота в групповые чаты (если мне не изменяет память, по дефолту эта возможность включена), а вторая запрещает боту просматривать все сообщения в группе, кроме команд. Обязательно отключите эту способность, так как для дайджест-бота критически важна возможность мониторинга всех сообщений пользователей на предмет присутствия в них тега #digest. В общем, выставите настройки так, чтобы пользователи могли добавлять бота в групповые чаты (/setjoingroups в ENABLED) и бот мог мониторить сообщения в них (/setprivacy в DISABLED).

Теперь у нас есть токен и настроенный профиль. Самое время взяться за написание Hello World!-бота!

<< Перейти к содержанию

4. Реализация простейшего Hello World!-бота на JavaScript

Перейдём в созданную ранее директорию ~/Deploy/, создадим там файл «HelloWorldBot.js» с помощью любого, удобного вам текстового редактора с поддержкой и подсветкой синтаксиса JavaScript. Вставим в этот файл следующий текст:

Вместо WRITE_YOUR_TOKEN_HERE не забудьте вписать выданный вам токен, соблюдая синтаксис, то есть аккуратно заключив его в кавычки. Сохраним файл и пройдёмся по коду с комментариями.

Самая первая строка указывает на то, что необходимо использовать пакет node-telegram-bot-api, уже развёрнутый нами в директорию ~/Deploy/. Далее идёт описание необходимых боту аргументов и опций: это ваш токен и опция polling, определяющая разновидность бота. В данном случае эта опция говорит о том, что бот будет мониторить чат сам, без помощи главного сервера Telegram. Далее создаётся объект bot, с которым мы и будем работать. Вызов функции getMe().then() происходит при успешной авторизации токена бота и выдачи управления программе. При этом в качестве аргумента функция getMe().then() принимает функцию function(me) первым аргументом которой является объект, с помощью которого можно получить различную информацию о вашем боте и, в данном случае, вывести её в консоль. Далее, самая главная функция bot.on(‘text’, …) вызывается когда бот видит чьё-либо сообщение в чате. В качестве первого аргумента она принимает тип отслеживаемого сообщения (об этом можно подробнее почитать в документации node-telegram-bot-api), а в качестве второго аргумента она принимает функцию function(msg) первым аргументом которой является объект, с помощью которого можно «вынуть» различную информацию из полученного сообщения. Именно этим и занимаются нижеследующие строки. В переменной messageChatId сохраняется id чата, из которого пришло сообщение; в messageText — текст; в messageDate — дата, в формате: секунды, прошедшие с UNIX-time; в messageUsr — ник участника, отправившего сообщение.

Далее текст сообщения проверяется на соответствие команде /say; и если пользователь действительно отправил эту команду, вызывается функция sendMessageByBot(), являющаяся обёрткой метода bot.sendMessage(). В функцию sendMessageByBot() необходимо передать два аргумента: первый — id чата, в который нужно отправить сообщение, а второй — собственно, текст отправляемого сообщения. В нашем случае id чата, в который нужно доставить сообщение, это id чата из которого и была получена команда /say. Далее для отладки можно вывести объект msg со всеми его полями прямо в стандартный вывод консоли.

Надеюсь, с этим всё понятно. Теперь необходимо просто запустить нашего бота на исполнение. Для этого в терминале, находясь в директории ~/Deploy/, набираем команду:

nodejs HelloWorldBot

В консоль при удачном соединении и успешной авторизации будет выведена информация о профиле вашего бота. Если этого не произошло, то вы где-то ошиблись. Проверьте интернет-соединение на компьютере, где запускаете программу и корректный ввод токена.

Демонстрация Hello World!-бота, отвечающего на команду /say.

Если всё получилось, программа останется на выполнении. Теперь в клиенте Telegram можно начать диалог с ботом или добавить его в группу. Если боту отправить команду /say, то он выдаст вам в чат сообщение, содержащие текст «Hello World!» (см. изображение выше). При этом на любые сообщения бот должен реагировать выводом полей объекта msg в консоль.

Для остановки работы бота и выхода из приложения просто нажмите сочетание клавиш «Ctrl + C», когда окно терминала будет в фокусе.

На этом всё, теперь можно переходить к созданию более сложного дайджест-бота.

<< Перейти к содержанию

Для реализации функциональсти, описаной в самом начале статьи, было придумано следующее: имеется глобальный лист, образно именуемый стеком, куда будут записаны сообщения с тегом #digest. Глобальный он потому, что при каждом вызове функции bot.on(‘text’, …) в него происходит (или не происходит) добавление соответствующего сообщения или его модификация. Тут вся сложность в том, что бота можно добавить в несколько чатов сразу и в каждом он должен корректно отработать, собирая все сообщения из чатов с вышеупомянутым тегом и корректно (то есть каждому чату именно ему принадлежащие сообщения) выводить соответствующую информацию. В начале планировалось создавать индивидуальные листы, содержащие сообщения для каждого чата индивидуально, но позже пришла мысль использовать лишь один лист, добавляя в него кроме, непосредственно, сообщения ещё и различную дополнительную информацию вроде id чата и даты, благо node-telegram-bot-api позволяет это сделать. Да и возни будет меньше, так как ответ станет формироваться на выходе, где в вывод будут добавлены лишь те сообщения, которые соответствуют id того чата, из которого пришла команда /digest.

Простая схема работы дайджест-бота с листом.

Далее, нужно помнить, что наш стек может неплохо так раздуться, если в него постоянно будут добавлять сообщения из разных чатов. Поэтому необходимо придумать механизм, который будет периодически очищать стек, удаляя неактуальные сообщения. Пусть этот механизм будет работать следующим образом: пользователь, который ввёл команду /digest последним, реформирует стек, удаляя из него устаревшую информацию. Механизм удаления пусть будет следующий: у последней команды /digest берётся время и из этого времени вычитается какая-то фиксированная величина-задержка в секундах, к примеру сутки или неделя, после чего с помощью цикла перебираются все сообщения в стеке и используя сравнение по времени, вычисляется граница (в конкретном случае количество устаревших сообщений «снизу», или порядковый номер граничного сообщения), которая разделяет стек на две части из устаревших и актуальных сообщений. Далее лист режется прямиком по этой границе на две половинки, часть с устаревшими сообщениями выкидывается вместе с ними, а часть с актуальными сообщениями становится новым стеком. Но тут, конечно, нужно помнить, что имеется целых три различных варианта развития событий:

• Во-первых, это вариант, описанный выше, то есть граница чётко определена, лист делится на две части, старый стек замещается новым, а старые сообщения выбрасываются;
• Во-вторых, если получилось так, что количество устаревших сообщений равно нулю, то не нужно производить никаких манипуляций со стеком и оставить то, что есть, так как все сообщения в нём актуальны;
• В-третьих, если количество устаревших сообщений равно размеру стека, то есть получилось так, что все сообщения устарели, стек нужно полностью обнулить, а сообщения выкинуть.

Ситуация, когда пользователи постоянно пишут сообщения с тегом #digest, но не вызывают команду /digest маловероятна, поэтому опустим этот случай. При желании, конечно, можно перенести механизм (в конкретном случае одну функцию) и в обработчик, который срабатывает при получении #digest-тега, но таким образом реформация стека будет происходить уж больно часто. В описаной выше функциальности любой пользователь любого чата неявно реформирует стек при каждом вызове команды /digest, удаляя все устаревшие сообщения всех чатов, за которыми следит бот.

Программа-симулятор логики работы со стеком, описанной выше.

После того, как эта функциональность была обдумана в голове, мне захотелось проверить её в боевых действиях. Но, увы, меня подвёло моё плохое интернет-соединение. Поэтому вечером, будучи в «offline», мой воспалённый идеей мозг, накидал простенький симулятор логики на C++ и Qt (см. изображение выше). Два окна с текстом в них — имитируют два активных чата, в которые добавлен бот, реагирующий на команду /digest и тег #digest. Кнопки «Start/Stop Discussion» запускают симуляцию активной беседы в необходимом чате (простой генератор случайных чисел), иногда среди обычных сообщений попадаются имеющие тег #digest, которые старательно складываются ботом в структуру, записываемую в контейнер QList. При этом я могу симулировать поведение пользователя, вводя в текстовые поля сообщения или команду /digest, реформируя QList и получая ответ бота. Исходные тексты этой программки можно найти здесь. Утром, после того как моё интернет-соединение пришло в норму, я просто начал портировать уже готовое решение на JavaScript.

Я не буду публиковать здесь полный листинг реализации дайджест-бота, он слишком большой. Лучше ниже дам ссылку на исходные коды актуальной версии. Но рассмотреть работу некоторых важных механизмов в исходном коде, я думаю, будет полезно.

<< Перейти к содержанию

5.1. Обработчик тега #digest

Тут всё просто. Если сообщение содержит тег #digest, то начинает выполнятся тело условия. В переменную normalMessage помещается нормализированное сообщение, которое возвращает функция normalizeMessage(); она модифицирует полученное сообщение, например, удаляет из него тег, «разряжает» пробелы, меняет регистр первой буквы на заглавную и проводит ещё несколько различных манипуляций. Если сообщение после нормализации вернётся не пустым (например, сообщение, состоящее из одного тега #digest, после нормализации будет пустым), то создаётся простенькая структурка, в которую добавляется вся необходимая информация, после чего структурка закидывается в стек-лист. Затем отправляется сообщение в чат об успешном добавлении информации в стек.

<< Перейти к содержанию

5.2. Обработчик команды /digest

Формально обработчик можно разделить на две части, собственно, работу по актуализации стека и генерацию ответа на команду. Последнее мы рассмотрим немного позже. Как уже было сказано выше, здесь вводится задержка, в конкретном случае суточная, результат вычитания которой из даты принятого сообщения отправляется в функцию deleteObsoleteDigestMessages(), от возвращаемого значения которой зависит будет ли сгенерирован ответ, или же будет выполнена функция sendNoDigestMessages(), отправляющая в чат информацию об отсутствии актуальных сообщений на данный момент.

<< Перейти к содержанию

5.3. Функция deleteObsoleteDigestMessages()

Реализация уже описанной выше работы со стеком. Комментарии говорят сами за себя, что либо объяснять здесь я считаю излишним.

<< Перейти к содержанию

5.4. Генерация ответа бота на команду /digest

Генерация ответа очень проста: в строку botAnswer в цикле добавляются все подходящие сообщения из стека, вместе с форматированием. Функция getCountDigestMessagesOfChat() возвращает в переменную countOfDigestMessagesByChat количество сообщений с тегом для чата из которого была получена команда. Условие внутри цикла регламентирует добавление в botAnswer лишь тех сообщений, id которых совпадает с id чата, из которого была получена команда /digest. Потом в конец botAnswer добавляется точка, если это нужно и botAnswer отправляется в чат, если переменная countOfDigestMessagesByChat больше нуля.

<< Перейти к содержанию

5.5. Заключение по дайджест-боту

Эти функции помогут понять устройство бота и подскажут, как реализовать его самостоятельно. Мою реализацию и полный исходный код вы можете посмотреть по этой ссылке. Там же найдёте и простую инструкцию по установке и разворачиванию. Бот Гаечка, описанный в первом пункте этой статьи, является усложнённой имплементацией дайджест-бота.

Update 06-MAR-2017: Прочитать ещё немного информации по поводу дайджест-бота Gadget Hackwrench можно в разделе этой статьи.

Далее перейдём к описанию простого валютного бота.

<< Перейти к содержанию

6. Реализация валютного бота на JavaScript

Смысл валютного бота состоит в том, чтобы брать актуальные валютные котировки с сайта ЦБ РФ и отправлять их в чат. Создадим файл «Currency.js» в директории ~/Deploy/ и заполним его следующим содержимым:

Конечно же не забываем вместо WRITE_YOUR_TOKEN_HERE вписать свой токен. Далее сохраним файл и пройдёмся по коду с комментариями.

Демонстрация работы валютного бота, ответ на команду /currency.

Во-первых, нам нужно подключить пакет http, поскольку потребуется получить XML-файл с котировками, расположенный на сервере ЦБ РФ по адресу http://www.cbr.ru/scripts/XML_daily.asp?. Опции доступа к этому хосту описаны в переменной options. В глобальную переменную content мы будем сохранять ответ сервера, содержащий XML. Далее по коду отлично видно, что бот мониторит все сообщения и в том случае, если кто-то отправит команду /currency, начнёт выполняться функция updateGlobalCurrencyList(). В ней создаётся асинхронный HTTP-запрос, в результате выполнения которого в переменную content загрузятся XML-данные. По окончанию запроса необходимо распарсить XML, и отправить его в чат, что и происходит в функции res.on(«end», …). К сожалению, в языке программирования JavaScript и фреймворке Node.js отсутствуют стандартные средства для работы с XML. Поэтому для парсинга я решил не тянуть лишнюю зависимость в Node.js, а попытаться найти закономерности в файле и распарсить его костылём. Предупреждаю сразу, что лучше всего всё сделать по уму и воспользоваться библиотекой. Функция shittyParseXML() принимает в качестве единственного аргумента сырые XML-данные и работает следующим образом: нам требуется в XML найти какие-нибудь уникальные значения, чтобы привязаться к ним и работать от них. Такие данные действительно есть, это поле «CharCode», которое характеризует уникальный идентификатор валюты. Если от строки, содержащей идентификатор отступить вниз на одну, мы получим валютный номинал, а если отступить на три, то получим значение. Разделив значение на валютный номинал, мы получим другое значение, которое будет соответствовать эквиваленту одной какой-нибудь валюты. Пройдя по цепочке вызовов из shittyParseXML() обозначим наиболее интересные функции и их описание:

• getStringBelow(i, j, data_string) — собственно, спуститься от строки «i» вниз на «j» в буфере «data_string»;
• getLineFromXml(i, data_string) — возвращает строку под номером «i» в буфере «data_string»;
• removeTags(string) — принимает строку «string» с тегами и возвращает строку без тегов;
• replaceCommasByDots(string) — функция заменяет в строке «string» запятые на точки, что очень важно для глобальной функции parseFloat().

Интересный факт: этот велосипедный парсер отлично справился с XML-кой, содержащей котировки похожего формата, полученной с одного украинского финансового сайта. Но это скорее всего счастливая случайность и совпадение, чем ожидаемое поведение.

Теперь можно запустить валютного бота на исполнение. Для запуска, находясь в директории ~/Deploy/, набираем команду:

nodejs Currency

Если завести диалог с ботом и послать ему команду /currency, то в ответ он должен отправить в чат курс валют сегодняшнего дня по ЦБ РФ (см. изображение выше). Выключить бота можно сочетанием клавиш «Ctrl + C» в окне терминала.

Далее следует реализация ещё одного простенького дайджест-бота на языке программирования Python. Если вам это нисколько не интересно, можете полностью пропустить следующий раздел.

<< Перейти к содержанию

7. Реализация упрощённого дайджест-бота на Python

Один из участников конференции MotoFan.Ru, скрывающийся под ником @J()KER, попросил меня разобраться с twx.botapi и накидать реализацию какого-нибудь бота на языке программирования Python; twx.botapi — одна из двух популярных реализаций Telegram Bot API, которая максимально использует ООП (объектно-ориентированное программирование), но, к сожалению, имеет весьма скудную документацию. Вторая реализация называется pyTelegramBotAPI, она несколько проще для понимания и её документация снабжена примерами, хорошо демонстрирующими ту или иную фичу реализации. К сожалению, о pyTelegramBotAPI я узнал уже после того, как написал бота на twx.botapi. Но выбор подходящей реализации Telegram Bot API, это скорее всего дело обычного вкуса; кому-то twx.botapi может понравится больше, следовательно наш бот будет использовать именно его.

Я не в первый раз сталкиваюсь с языком программирования Python, раньше я работал с ним вкупе с технологией PyQt. Это очень приятный и выразительный язык, хотя меня немного напрягает неявная типизация совмещённая со строгой и зависимость от отступов. Мои знания Python весьма поверхностны, однако SODD (Stack Overflow Driven Development) и всеобъемлющая документация помогают очень быстро разобраться и сделать работающий прототип буквально за 20-30 минут. Просто портируем основную логику JavaScript дайджест-бота, написанного ранее, на язык программирования Python. Естественно, будет использоваться Polling-режим.

Реализация twx.botapi позволяет использовать как Python второй версии, так и третьей. Мы для написания бота будем использовать Python 3, для запуска которого требуется немного настроить окружение (далее предполагается что вы работаете в deb-based дистрибутиве). В начале устанавливаем собственно сам Python 3 и его пакетный менеджер:

sudo apt—get install python3 python3—pip

Затем с помощью Python’овского пакетного менеджера устанавливаем пакет twx.botapi:

pip3 install twx.botapi

Теперь можно зайти в любую удобную директорию, например, в ~/Deploy/ и создать в ней текстовой файл с именем «DigestBot.py», в который вставить и сохранить следующий код:

Только не забудьте WRITE_YOUR_TOKEN_HERE заменить на полученный токен бота. Итак, пробежимся по коду.

Строка from __future__ import unicode_literals говорит о том, что в нашей программе будет использоваться Unicode; это действительно так: сообщения из чата могут приходить на различных языках. Далее идёт подключение пакета twx.botapi и если скрипт запущен как независимая программа (выражение if __name__ == ‘__main__’), начинается построение класса DigestBot с полями token, admin и листом stack_list. Первый метод, который проинициализирует должным образом переменные, называется __init__(self), он является неким аналогом конструктора, но называть его конструктором несколько неправильно, так как к моменту вызова этого метода объект уже будет создан и вы будете иметь ссылку на созданный экземпляр класса. В этом методе в API отправляется ваш токен, вызывается метод get_me(), тестирующий авторизационный токен вашего бота и с помощью метода get_updates() в переменную last_updates возвращается массив объектов обновления. Если этот массив не пустой, то в поле класса last_update_id устанавливается update_id последнего элемента массива last_updates.

Далее у экземпляра класса вызывается метод run(), в котором реализован главный бесконечный цикл, в теле которого: в переменную updates возвращается массив объектов обновления начиная со значения переменной last_update_id определённой в __init__(self), затем во вложенном цикле выполняется проверка значений различных update_id, и если update_id прилетевшего события больше, чем тот, что был сохранён в поле класса, то поле класса будет обновлено, а сообщение обработано методом process_message(self, message). В теле которого в различные переменные выдирается сообщение и происходят стандартные преобразования, описанные выше в разделе про создание дайджест-бота на JavaScript: при получении тега #digest в лист добавляется структура с информацией о сообщении; при получении команды /digest идёт процесс формирования ответа. В этой версии дайджест-бота стек-лист никем не модифицируется, но при желании, конечно, можно реализовать аналог того, что было написано на JavaScript; просто я решил не раздувать листинги исходного кода. Дату сообщения, судя по документации twx.botapi, можно выдрать с помощью message.message.date в аналогичном UNIX-формате. Ещё стоит упомянуть обработку команды /stackView, которая отображает всё содержимое листа с данными изо всех чатов. Поэтому этой командой может воспользоваться только администратор, ник которого прописан в поле класса admin.

Для запуска дайджест-бота в консоли следует перейти в директорию с файлом «DigestBot.py» и набрать следующую команду в терминале:

python3 DigestBot.py

Завершить процесс можно сочетанием клавиш «Ctrl + C» в окне терминала.

Далее будет описано создание бота на JavaScript, который отправляет случайную цитату в чат с bash.im, главного цитатника Рунета.

<< Перейти к содержанию

8. Реализация бота, отправляющего случайную цитату с bash.im, на JavaScript

Пользователи конференций часто хотят развлечься и прочитать случайную цитату из главного цитатника Рунета, сайта bash.im. Давайте реализуем такой функционал у бота. Сперва в директории ~/Deploy/ создадим файл с именем «Bash.js» и вставим в него следующее содержимое:

Естественно, WRITE_YOUR_TOKEN_HERE заменяем своим токеном. Сохраним файл и немного рассмотрим его.

Демонстрация бота, отправляющего случайную цитату с bash.im

Случайную цитату можно получить по ссылке bash.im/forweb/. К сожалению, необходимая информация выдаётся в кодировке Windows-1251, поэтому нам нужно преобразовать ответ сервера в UTF-8. Для работы с кодировками существует несколько пакетов, например, node-iconv, но нам подойдёт самый компактный из них — iconv-lite. Устанавливаем его в директорию ~/Deploy/ с помощью пакетного менеджера Node.js:

npm install iconv—lite

В листинге кода выше, этот пакет подключается третьей строкой. Далее всё достаточно стандартно: при отправке команды /bash в чат, бот вызывает у себя функцию sendRandomBashImQuote(), в которой создаёт запрос и конвертирует полученную информацию в UTF-8 (см. документацию для более подробного изучения работы этой функции). Далее из результата ответа сервера, хранящегося в переменной decodedBody уже в правильной кодировке, вычленяется блок, отвечающий за саму цитату с помощью функции getQuoteBlockFromContent(). Эта функция возвращает массив, который сохраняется в переменную content, второй элемент которого (по индексу [1]) отправляется в функцию removeAllMarkUp, отвечающую за удаление всей HTML-разметки. Результат выполнения функции снова записывается в content и после отправляется в чат.

Для запуска бота, находясь в директории ~/Deploy/, следует выполнить команду:

nodejs Bash

Теперь, если завести диалог с ботом и написать команду /bash в чат, то в ответ он должен отправить случайную цитату с вышеупомянутого сайта (см. изображение выше). Если часто отсылать команду /bash, то можно заметить, что цитата не изменилась. За выдачу рандомной цитаты отвечает сервер bash.im, поэтому вряд ли что-то здесь можно сделать. Разве что прикрутить задержку. Выключить бота можно нажав сочетание клавиш «Ctrl + C» в окне терминала.

В следующем разделе статьи будут описаны примеры исходного кода JavaScript-ботов, работающих с такими объектами, как изображения, видео, аудио, стикеры и интерактивные кнопки.

<< Перейти к содержанию

9. Реализация JavaScript-ботов, работающих со стикерами, мультимедийными объектами и интерактивными кнопками

Помимо отправки и получения простой текстовой информации, боты могут анализировать и другие события, вроде получения изображений или стикеров. Соответственно, так же как и пользователи, они могут отправлять различные мультимедийные объекты в чат. Кроме того, у ботов имеется интересная возможность создавать у пользователей в клиенте Telegram под полем ввода специальные интерактивные кнопки, нажимая на которые участник конференции может выбрать какое-либо необходимое ему действие. Ниже мы рассмотрим примеры таких ботов, а в заключительной части статьи я перечислю ресурсы с полезной информацией, которая вам пригодится, если вы заинтересуетесь созданием ботов для Telegram.

<< Перейти к содержанию

9.1. Бот, отправляющий в ответ на стикер свой стикер.

У каждого стикера, загруженного на серверы Telegram, существует его уникальный идентификатор file_id, который можно увидеть, выведя объект msg в консоль. Отправляя этот идентификатор в качестве одного из аргументов функции bot.sendSticker(), мы по сути отправляем этот стикер в чат с помощью бота. Логика программы простая: в ответ на любой стикер, полученный из чата, бот отправит в ответ случайный стикер из листа stickersList, где перечислены их уникальные идентификаторы. Заметьте, что аргументом API-метода может быть и подходящий под понятие стикера файл (например, формата webp с разрешением 512×512).

<< Перейти к содержанию

9.2. Бот, отправляющий в ответ на команду мультимедийный объект в чат.

Telegram Bot API позволяет отправлять как локальные мультимедийные объекты и файлы, так и удалённые. Для того, чтобы иметь возможность отправлять удалённые объекты, полученные по URL, требуется подключить пакет request, о котором и говорилось в начале статьи. Список всех доступных send-методов можно посмотреть здесь. Помимо этого можно скачать файл в любую удобную директорию, например, рядом с js-файлом и потом уже отправить его оттуда, как это реализовано здесь.

<< Перейти к содержанию

9.3. Бот, работающий с интерактивными кнопками.

Бот в ответ на команду /keys отправляет специальное сообщение-ответ с особым параметром-клавиатурой. Пользователь может нажать на какую-нибудь из интерактивных кнопок, тем самым отправляя текст этой кнопки в чат, после чего бот снова обработает сообщение и в зависимости от варианта ответа произведёт какие-либо действия. Подобный режим весьма полезен для ботов, которые работают не с групповыми чатами, а с отдельными пользователями в индивидуальных диалогах. Выскакивающая клавиатура может раздражать пользователей в конференциях, поэтому используйте эту функциональность осторожно.

Демонстрация работы валютного бота @RubBot, использующего интерактивные кнопки.

Примером удачной реализации такого бота служит @RubBot, который отправляет необходимую котировку, в зависимости от нажатой пользователем кнопки.

<< Перейти к содержанию

10. Заключение, полезные ссылки и ресурсы

В этой статье были описаны варианты создания различных ботов на языках программирования JavaScript и Python. Я буду рад, если материал поможет вам разобраться во всех тонкостях работы с Telegram Bot API и поспособствует реализации ваших идей. Как было сказано в самом начале статьи, с помощью ботов можно организовать удобное получение и обработку различной информации. Для тех, кто заинтересовался этой темой, я предлагаю воспользоваться полезными ссылками, опубликованными ниже. Небольшой совет: обязательно читайте документацию реализации Telegram Bot API, используемой вами, и множество вопросов отпадут сами собой. Хочу выразить огромную благодарность создателю Telegram-конференции сообщества MotoFan.Ru — @ZorgeR‘у, который помог мне в имплементации различных аспектов дайджест-бота Гаечки и не раз наставлял меня на правильный и верный путь.

1. Репозиторий с исходным кодом дайджест-бота на JavaScript и инструкцией по его установке;
2. Исходный код простого дайджест-бота на Python;
3. Официальная документация Telegram Bot API;
4. Документация и официальный репозиторий реализации Telegram Bot API на языке JavaScript под Node.js — node-telegram-bot-api;
5. Документация реализации Telegram Bot API на языке Python — twx.botapi;
6. Официальный репозиторий реализации Telegram Bot API на языке Python — twx.botapi;
7. Документация и официальный репозиторий реализации Telegram Bot API на языке Python — pyTelegramBotAPI;
8. Отличная статья про реализацию JavaScript-ботов на Node.js и node-telegram-bot-api от Catethysis.

Update 18-MAR-2016: Официальное Telegram Bot API теперь предоставляет возможность использования специальных inline-ботов, которые могут искать различную информацию в Интернете и позволять пользователю выбирать подходящие варианты. Простой пример такого бота можно посмотреть здесь (исходный код), у него должен быть особый атрибут inline-бота, установить который можно с помощью команды /setinline, которую следует отправить @BotFather боту.

<< Перейти к содержанию