Multiple bots support (BoShurik#49)

Author: BoShurik

.gitattributes

@@ -0,0 +1,11 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes             export-ignore
+/.gitignore                 export-ignore
+/.github                    export-ignore
+/phpunit.xml.dist           export-ignore
+/.php-cs-fixer.dist.php     export-ignore
+/psalm.xml                  export-ignore
+/tests                      export-ignore

CHANGELOG.md

@@ -1,8 +1,10 @@
 CHANGELOG
 =========
 
-5.1.0 (2023-xx-xx)
+6.0.0 (2023-xx-xx)
 ------------------
+
+* Allow multiple bots
 * Improve the webhook:set command so that it accepts the hostname. The webhook URL will be generated automatically. 
 * Moved config yaml files to php.
 

README.md

@@ -37,7 +37,14 @@ public function registerBundles()
 ``` yaml
 BoShurikTelegramBotBundle:
     resource: "@BoShurikTelegramBotBundle/Resources/config/routing.php"
-    prefix: /_telegram/<some-secret>
+    prefix: /_telegram/%telegram_bot_route_secret%
+```
+
+or for multiple bots:
+``` yaml
+BoShurikTelegramBotBundle:
+    resource: "@BoShurikTelegramBotBundle/Resources/config/routing.php"
+    prefix: /_telegram/{bot}/%telegram_bot_route_secret%
 ```
 
 #### Configuration
@@ -49,12 +56,39 @@ boshurik_telegram_bot:
         proxy: "socks5://127.0.0.1:8888"
 ```
 
+or for multiple bots:
+``` yaml
+boshurik_telegram_bot:
+    api:
+        default_bot: first
+        bots:
+            first: "%first_telegram_bot_api_token%"
+            second: "%second_telegram_bot_api_token%"
+        proxy: "socks5://127.0.0.1:8888"
+```
+
 ## Usage
 
 #### API
 
+To get default bot api:
+```php
+use TelegramBot\Api\BotApi;
+public function __construct(private BotApi $api)
+```
+
+For multiple bots:
+
 ```php
-    $api = $this->container->get(TelegramBot\Api\BotApi::class);
+
+use BoShurik\TelegramBotBundle\Telegram\BotLocator;
+use TelegramBot\Api\BotApi;
+
+public function foo(BotLocator $botLocator)
+{
+    /** @var BotApi $api */
+    $api = $botLocator->get('first');
+}
 ```
 
 For more info see [Usage][2] section in [`telegram-bot/api`][1] library
@@ -63,6 +97,7 @@ For more info see [Usage][2] section in [`telegram-bot/api`][1] library
 
 ``` bash
 bin/console telegram:updates
+bin/console telegram:updates first
 ```
 
 For more information see [official documentation][3]
@@ -72,13 +107,15 @@ For more information see [official documentation][3]
 ##### Set
 
 ``` bash
-bin/console telegram:webhook:set <url> [<path-to-certificate>]
+bin/console telegram:webhook:set <url-or-hostname> [<path-to-certificate>]
+bin/console telegram:webhook:set <url-or-hostname> [<path-to-certificate>] --bot first
 ```
 
 ##### Unset
 
 ``` bash
 bin/console telegram:webhook:unset
+bin/console telegram:webhook:unset first
 ```
 
 For more information see [official documentation][4]
@@ -118,16 +155,43 @@ app.telegram.command:
 
 If you use `autoconfigure` tag will be added automatically
 
-There is predefined `\BoShurik\TelegramBotBundle\Telegram\Command\HelpCommand`. You need to register it:
+For application with multiple bots you need to pass bot id:
+``` yaml
+app.telegram.command:
+    class: AppBundle\Telegram\Command\SomeCommand
+    tags:
+        - { name: boshurik_telegram_bot.command, bot: first }
+```
+If you need to use same command for multiple bots you must add multiple tags for each bot:
+``` yaml
+app.telegram.command:
+    class: AppBundle\Telegram\Command\SomeCommand
+    tags:
+        - { name: boshurik_telegram_bot.command, bot: first }
+        - { name: boshurik_telegram_bot.command, bot: second }
+```
+
+There is predefined `\BoShurik\TelegramBotBundle\Telegram\Command\HelpCommand`.
+It displays commands which additionally implement `\BoShurik\TelegramBotBundle\Telegram\Command\PublicCommandInterface`
+
+You need to register it:
 ``` yaml
 app.telegram.command.help:
     class: BoShurik\TelegramBotBundle\Telegram\Command\HelpCommand
     arguments:
-        - '@BoShurik\TelegramBotBundle\Telegram\Command\CommandRegistry'
+        - '@boshurik_telegram_bot.command.registry.default'
     tags:
         - { name: boshurik_telegram_bot.command }
 ```
-It displays commands which additionally implement `\BoShurik\TelegramBotBundle\Telegram\Command\PublicCommandInterface`
+or for multiple bots:
+``` yaml
+app.telegram.command.help:
+    class: BoShurik\TelegramBotBundle\Telegram\Command\HelpCommand
+    arguments:
+        - '@boshurik_telegram_bot.command.registry.first'
+    tags:
+        - { name: boshurik_telegram_bot.command, bot: first }
+```
 
 #### Events
 
@@ -147,7 +211,7 @@ public function onUpdate(UpdateEvent $event)
 
 This bundle supports login through Telegram Api
 
-If you want allow your Bot's users to login without requiring them to register again
+If you want to allow your Bot's users to login without requiring them to register again
 follow these [instructions](LOGIN_WITH_TELEGRAM.md).
 
 [1]: https://github.com/TelegramBot/Api

composer.json

@@ -64,7 +64,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "5.0.x-dev"
+            "dev-master": "6.0.x-dev"
         }
     }
 }

phpunit.xml.dist

@@ -18,7 +18,7 @@
 
   <php>
     <ini name="error_reporting" value="-1" />
-      <server name="KERNEL_CLASS" value="BoShurik\TelegramBotBundle\Tests\Kernel\TestKernel" />
+      <server name="KERNEL_CLASS" value="BoShurik\TelegramBotBundle\Tests\Kernel\Single\SingleTestKernel" />
       <server name="SYMFONY_DEPRECATIONS_HELPER" value="weak" />
   </php>
 

src/Authenticator/TelegramAuthenticator.php

@@ -24,7 +24,7 @@
 use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
 use Symfony\Component\Security\Http\Util\TargetPathTrait;
 
-class TelegramAuthenticator extends AbstractAuthenticator
+final class TelegramAuthenticator extends AbstractAuthenticator
 {
     use TargetPathTrait;
 

src/Authenticator/TelegramLoginValidator.php

@@ -13,7 +13,10 @@
 
 use BoShurik\TelegramBotBundle\Exception\AuthenticationException;
 
-class TelegramLoginValidator
+/**
+ * @final
+ */
+/* final */ class TelegramLoginValidator
 {
     private const EXPIRING_TIMEOUT = 3600;
 

src/BoShurikTelegramBotBundle.php

@@ -17,9 +17,9 @@
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
-class BoShurikTelegramBotBundle extends Bundle
+final class BoShurikTelegramBotBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

src/Command/UpdatesCommand.php

@@ -13,10 +13,11 @@
 
 use BoShurik\TelegramBotBundle\Telegram\Telegram;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class UpdatesCommand extends Command
+final class UpdatesCommand extends Command
 {
     public function __construct(private Telegram $telegram)
     {
@@ -27,13 +28,20 @@ protected function configure(): void
     {
         $this
             ->setName('telegram:updates')
+            ->addArgument('bot', InputArgument::OPTIONAL, 'Bot')
             ->setDescription('Get updates')
         ;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $this->telegram->processUpdates();
+        /** @var string|null $bot */
+        $bot = $input->getArgument('bot');
+        if ($bot) {
+            $this->telegram->processUpdates($bot);
+        } else {
+            $this->telegram->processAllUpdates();
+        }
 
         return Command::SUCCESS;
     }

src/Command/Webhook/InfoCommand.php

@@ -11,15 +11,17 @@
 
 namespace BoShurik\TelegramBotBundle\Command\Webhook;
 
+use BoShurik\TelegramBotBundle\Telegram\BotLocator;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use TelegramBot\Api\BotApi;
 
-class InfoCommand extends Command
+final class InfoCommand extends Command
 {
-    public function __construct(private BotApi $api)
+    public function __construct(private BotLocator $botLocator)
     {
         parent::__construct();
     }
@@ -28,6 +30,7 @@ protected function configure(): void
     {
         $this
             ->setName('telegram:webhook:info')
+            ->addArgument('bot', InputArgument::OPTIONAL, 'Bot')
             ->setDescription('Webhook info')
         ;
     }
@@ -36,43 +39,60 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
-        $info = $this->api->getWebhookInfo();
+        /** @var string|null $bot */
+        $bot = $input->getArgument('bot');
+        if ($bot) {
+            $api = $this->botLocator->get($bot);
+
+            $this->printWebhookInfo($io, $bot, $api);
+        } else {
+            foreach ($this->botLocator->all() as $name => $api) {
+                $this->printWebhookInfo($io, $name, $api);
+            }
+        }
+
+        return Command::SUCCESS;
+    }
+
+    private function printWebhookInfo(SymfonyStyle $io, string $name, BotApi $api): void
+    {
+        $io->block(sprintf('Bot "%s"', $name));
+
+        $info = $api->getWebhookInfo();
 
         $values = [];
         $values[] = [
             'Webhook URL',
             $info->getUrl(),
         ];
         $values[] = [
-            'custom certificate',
+            'Custom Certificate',
             $info->hasCustomCertificate() ? 'yes' : 'no',
         ];
         $values[] = [
-            'pending update count',
+            'Pending Update Count',
             $info->getPendingUpdateCount(),
         ];
         $values[] = [
-            'last error date',
+            'Last Error Date',
             $info->getLastErrorDate() ? date('Y-m-d H:i:s', $info->getLastErrorDate()) : '-',
         ];
         $values[] = [
-            'last error message',
+            'Last Error Message',
             $info->getLastErrorMessage() ?? '-',
         ];
         $values[] = [
-            'max connections',
+            'Max Connections',
             $info->getMaxConnections(),
         ];
         $values[] = [
-            'allowed updates',
+            'Allowed Updates',
             \is_array($info->getAllowedUpdates()) ? implode(', ', $info->getAllowedUpdates()) : '-',
         ];
 
         $io->table([
-            'name',
-            'value',
+            'Name',
+            'Value',
         ], $values);
-
-        return Command::SUCCESS;
     }
 }