├── .gitignore
├── .styleci.yml
├── changelog.md
├── composer.json
├── config
    └── telegram.php
├── database
    └── migrations
    │   ├── 2021_06_14_171118_create_telegram_bot_structure.php
    │   ├── 2022_02_18_175100_update_to_0.75.0.php
    │   ├── 2022_04_24_175700_update_to_0.77.0.php
    │   ├── 2022_10_04_221900_update_to_0.78.0.php
    │   ├── 2022_11_11_130500_update_to_0.80.0.php
    │   ├── 2023_05-07_101600_update_to_0.81.0.php
    │   └── sql
    │       ├── 0.74.0-0.75.0.sql
    │       ├── 0.76.1-0.77.0.sql
    │       ├── 0.77.1-0.78.0.sql
    │       ├── 0.79.0-0.80.0.sql
    │       ├── 0.80.0-0.81.0.sql
    │       └── structure-0.73.0.sql
├── license.md
├── phpunit.xml
├── readme.md
├── routes
    └── telegram.php
└── src
    ├── Console
        └── Commands
        │   ├── GeneratorCommand.php
        │   ├── MakeTelegramCommand.php
        │   ├── TelegramCloseCommand.php
        │   ├── TelegramDeleteWebhookCommand.php
        │   ├── TelegramFetchCommand.php
        │   ├── TelegramLogoutCommand.php
        │   ├── TelegramPublishCommand.php
        │   ├── TelegramSetWebhookCommand.php
        │   └── stubs
        │       ├── example-start-command.stub
        │       └── telegram-command.stub
    ├── Facades
        ├── CallbackButton.php
        └── Telegram.php
    ├── Factories
        └── CallbackButton.php
    ├── Http
        └── Middleware
        │   └── TrustTelegramNetwork.php
    ├── LaravelTelegramBot.php
    ├── Telegram
        ├── Commands
        │   ├── CallbackqueryCommand.php
        │   └── GenericmessageCommand.php
        ├── Conversation
        │   ├── ConversationWrapper.php
        │   └── LeadsConversation.php
        ├── InlineKeyboardButton
        │   ├── CallbackPayload.php
        │   └── RemembersCallbackPayload.php
        └── UsesEffectiveEntities.php
    └── TelegramServiceProvider.php


/.gitignore:
--------------------------------------------------------------------------------
 1 | 
 2 | # Created by https://www.toptal.com/developers/gitignore/api/laravel,composer
 3 | # Edit at https://www.toptal.com/developers/gitignore?templates=laravel,composer
 4 | 
 5 | ### Composer ###
 6 | composer.phar
 7 | /vendor/
 8 | 
 9 | # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
10 | # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
11 | composer.lock
12 | 
13 | ### Laravel ###
14 | node_modules/
15 | npm-debug.log
16 | yarn-error.log
17 | 
18 | # Laravel 4 specific
19 | bootstrap/compiled.php
20 | app/storage/
21 | 
22 | # Laravel 5 & Lumen specific
23 | public/storage
24 | public/hot
25 | 
26 | # Laravel 5 & Lumen specific with changed public path
27 | public_html/storage
28 | public_html/hot
29 | 
30 | storage/*.key
31 | .env
32 | Homestead.yaml
33 | Homestead.json
34 | /.vagrant
35 | .phpunit.result.cache
36 | 
37 | # Laravel IDE helper
38 | *.meta.*
39 | _ide_*
40 | 
41 | # End of https://www.toptal.com/developers/gitignore/api/laravel,composer
42 | 
43 | /.idea
44 | 


--------------------------------------------------------------------------------
/.styleci.yml:
--------------------------------------------------------------------------------
1 | preset: laravel


--------------------------------------------------------------------------------
/changelog.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | 
 3 | All notable changes to `LaravelTelegramBot` will be documented in this file.
 4 | 
 5 | ## Version 2.1.0
 6 | 
 7 | ### Added
 8 | - Support for Laravel 10
 9 | 
10 | ### Changed
11 | - Bump to core version 0.81.0
12 | 
13 | ## Version 2.0.0
14 | 
15 | ### Added
16 | - Everything
17 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "php-telegram-bot/laravel",
 3 |     "description": "Integrates PHP Telegram Bot into Laravel.",
 4 |     "license": "MIT",
 5 |     "authors": [
 6 |         {
 7 |             "name": "Avtandil Kikabidze aka LONGMAN",
 8 |             "email": "akalongman@gmail.com",
 9 |             "homepage": "http://longman.me",
10 |             "role": "Maintainer, Developer"
11 |         },
12 |         {
13 |             "name": "Tii",
14 |             "email": "mail@tii.one",
15 |             "role": "Developer"
16 |         }
17 |     ],
18 |     "homepage": "https://github.com/php-telegram-bot/laravel",
19 |     "keywords": ["laravel", "telegram", "bot"],
20 |     "require": {
21 |         "illuminate/support": "~7|~8|~9|~10|~11|~12",
22 |         "longman/telegram-bot": "^0.81",
23 |         "ext-pcntl": "*"
24 |     },
25 |     "require-dev": {
26 |         "phpunit/phpunit": "~9.0",
27 |         "symfony/process": "^5.3"
28 |     },
29 |     "autoload": {
30 |         "psr-4": {
31 |             "PhpTelegramBot\\Laravel\\": "src/"
32 |         }
33 |     },
34 |     "extra": {
35 |         "branch-alias": {
36 |             "dev-main": "2.1.x-dev"
37 |         },
38 |         "laravel": {
39 |             "providers": [
40 |               "PhpTelegramBot\\Laravel\\TelegramServiceProvider"
41 |             ],
42 |             "aliases": {
43 |                 "CallbackButton": "PhpTelegramBot\\Laravel\\Facades\\CallbackButton",
44 |                 "Telegram": "PhpTelegramBot\\Laravel\\Facades\\Telegram"
45 |             }
46 |         }
47 |     },
48 |     "minimum-stability": "dev",
49 |     "prefer-stable": true,
50 |     "config": {
51 |         "allow-plugins": {
52 |             "dealerdirect/phpcodesniffer-composer-installer": true
53 |         }
54 |     }
55 | }
56 | 


--------------------------------------------------------------------------------
/config/telegram.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 |     'bot' => [
 5 |         'api_token' => env('TELEGRAM_API_TOKEN'),
 6 | 
 7 |         'username' => env('TELEGRAM_BOT_USERNAME', ''),
 8 | 
 9 |         'api_url' => env('TELEGRAM_API_URL'),
10 |     ],
11 | 
12 |     'admins' => env('TELEGRAM_ADMINS', '')
13 | 
14 | ];
15 | 


--------------------------------------------------------------------------------
/database/migrations/2021_06_14_171118_create_telegram_bot_structure.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Illuminate\Database\Migrations\Migration;
 4 | 
 5 | return new class extends Migration {
 6 |     public function up()
 7 |     {
 8 |         DB::unprepared(file_get_contents(__DIR__ . '/sql/structure-0.73.0.sql'));
 9 |     }
10 | 
11 |     public function down()
12 |     {
13 |         //
14 |     }
15 | };
16 | 


--------------------------------------------------------------------------------
/database/migrations/2022_02_18_175100_update_to_0.75.0.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Illuminate\Database\Migrations\Migration;
 4 | 
 5 | return new class extends Migration {
 6 |     public function up()
 7 |     {
 8 |         DB::unprepared(file_get_contents(__DIR__ . '/sql/0.74.0-0.75.0.sql'));
 9 |     }
10 | 
11 |     public function down()
12 |     {
13 |         //
14 |     }
15 | };
16 | 


--------------------------------------------------------------------------------
/database/migrations/2022_04_24_175700_update_to_0.77.0.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Illuminate\Database\Migrations\Migration;
 4 | 
 5 | return new class extends Migration {
 6 |     public function up()
 7 |     {
 8 |         DB::unprepared(file_get_contents(__DIR__ . '/sql/0.76.1-0.77.0.sql'));
 9 |     }
10 | 
11 |     public function down()
12 |     {
13 |         //
14 |     }
15 | };
16 | 


--------------------------------------------------------------------------------
/database/migrations/2022_10_04_221900_update_to_0.78.0.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Illuminate\Database\Migrations\Migration;
 4 | 
 5 | return new class extends Migration {
 6 |     public function up()
 7 |     {
 8 |         DB::unprepared(file_get_contents(__DIR__ . '/sql/0.77.1-0.78.0.sql'));
 9 |     }
10 | 
11 |     public function down()
12 |     {
13 |         //
14 |     }
15 | };
16 | 


--------------------------------------------------------------------------------
/database/migrations/2022_11_11_130500_update_to_0.80.0.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Illuminate\Database\Migrations\Migration;
 4 | use Illuminate\Support\Facades\DB;
 5 | 
 6 | return new class extends Migration {
 7 |     public function up()
 8 |     {
 9 |         DB::unprepared(file_get_contents(__DIR__ . '/sql/0.79.0-0.80.0.sql'));
10 |     }
11 | 
12 |     public function down()
13 |     {
14 |         //
15 |     }
16 | };
17 | 


--------------------------------------------------------------------------------
/database/migrations/2023_05-07_101600_update_to_0.81.0.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Illuminate\Database\Migrations\Migration;
 4 | use Illuminate\Support\Facades\DB;
 5 | 
 6 | return new class extends Migration {
 7 |     public function up()
 8 |     {
 9 |         DB::unprepared(file_get_contents(__DIR__ . '/sql/0.80.0-0.81.0.sql'));
10 |     }
11 | 
12 |     public function down()
13 |     {
14 |         //
15 |     }
16 | };
17 | 


--------------------------------------------------------------------------------
/database/migrations/sql/0.74.0-0.75.0.sql:
--------------------------------------------------------------------------------
 1 | CREATE TABLE IF NOT EXISTS `bot_chat_join_request` (
 2 |     `id` BIGINT UNSIGNED AUTO_INCREMENT COMMENT 'Unique identifier for this entry',
 3 |     `chat_id` BIGINT NOT NULL COMMENT 'Chat to which the request was sent',
 4 |     `user_id` BIGINT NOT NULL COMMENT 'User that sent the join request',
 5 |     `date` TIMESTAMP NOT NULL COMMENT 'Date the request was sent in Unix time',
 6 |     `bio` TEXT NULL COMMENT 'Optional. Bio of the user',
 7 |     `invite_link` TEXT NULL COMMENT 'Optional. Chat invite link that was used by the user to send the join request',
 8 |     `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
 9 | 
10 |     PRIMARY KEY (`id`),
11 | 
12 |     FOREIGN KEY (`chat_id`) REFERENCES `bot_chat` (`id`),
13 |     FOREIGN KEY (`user_id`) REFERENCES `bot_user` (`id`)
14 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
15 | 
16 | ALTER TABLE `bot_telegram_update` ADD COLUMN `chat_join_request_id` BIGINT UNSIGNED NULL COMMENT 'A request to join the chat has been sent';
17 | ALTER TABLE `bot_telegram_update` ADD FOREIGN KEY (`chat_join_request_id`) REFERENCES `bot_chat_join_request` (`id`);
18 | 
19 | ALTER TABLE `bot_message` ADD COLUMN `is_automatic_forward` tinyint(1) DEFAULT 0 COMMENT 'True, if the message is a channel post that was automatically forwarded to the connected discussion group' AFTER `forward_date`;
20 | ALTER TABLE `bot_message` ADD COLUMN `has_protected_content` tinyint(1) DEFAULT 0 COMMENT 'True, if the message can''t be forwarded' AFTER `edit_date`;
21 | 


--------------------------------------------------------------------------------
/database/migrations/sql/0.76.1-0.77.0.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE `bot_message` ADD COLUMN `web_app_data` TEXT NULL DEFAULT NULL COMMENT 'Service message: data sent by a Web App' AFTER `voice_chat_participants_invited`;
2 | 
3 | ALTER TABLE `bot_message`
4 |     CHANGE `voice_chat_scheduled` `video_chat_scheduled` TEXT COMMENT 'Service message: video chat scheduled',
5 |     CHANGE `voice_chat_started` `video_chat_started` TEXT COMMENT 'Service message: video chat started',
6 |     CHANGE `voice_chat_ended` `video_chat_ended` TEXT COMMENT 'Service message: video chat ended',
7 |     CHANGE `voice_chat_participants_invited` `video_chat_participants_invited` TEXT COMMENT 'Service message: new participants invited to a video chat';
8 | 


--------------------------------------------------------------------------------
/database/migrations/sql/0.77.1-0.78.0.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE `bot_user` ADD COLUMN `is_premium` tinyint(1) DEFAULT 0 COMMENT 'True, if this user is a Telegram Premium user' AFTER `language_code`;
2 | ALTER TABLE `bot_user` ADD COLUMN `added_to_attachment_menu` tinyint(1) DEFAULT 0 COMMENT 'True, if this user added the bot to the attachment menu' AFTER `is_premium`;
3 | 


--------------------------------------------------------------------------------
/database/migrations/sql/0.79.0-0.80.0.sql:
--------------------------------------------------------------------------------
 1 | ALTER TABLE `bot_message`
 2 |     ADD COLUMN `is_topic_message` TINYINT(1) DEFAULT 0 COMMENT 'True, if the message is sent to a forum topic' AFTER `forward_date`,
 3 |     ADD COLUMN `message_thread_id` BIGINT(20) NULL DEFAULT NULL COMMENT 'Unique identifier of a message thread to which the message belongs; for supergroups only' AFTER `id`,
 4 |     ADD COLUMN `forum_topic_created` TEXT NULL DEFAULT NULL COMMENT 'Service message: forum topic created' AFTER `proximity_alert_triggered`,
 5 |     ADD COLUMN `forum_topic_closed` TEXT NULL DEFAULT NULL COMMENT 'Service message: forum topic closed' AFTER `forum_topic_created`,
 6 |     ADD COLUMN `forum_topic_reopened` TEXT NULL DEFAULT NULL COMMENT 'Service message: forum topic reopened' AFTER `forum_topic_closed`;
 7 | 
 8 | ALTER TABLE `bot_chat`
 9 |     ADD COLUMN `is_forum` TINYINT(1) DEFAULT 0 COMMENT 'True, if the supergroup chat is a forum (has topics enabled)' AFTER `last_name`;
10 | 


--------------------------------------------------------------------------------
/database/migrations/sql/0.80.0-0.81.0.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE `bot_message`
2 |     ADD COLUMN `has_media_spoiler`            TINYINT(1) DEFAULT 0 COMMENT 'True, if the message media is covered by a spoiler animation' AFTER `caption`,
3 |     ADD COLUMN `write_access_allowed`         TEXT       DEFAULT NULL COMMENT 'Service message: the user allowed the bot added to the attachment menu to write messages' AFTER `connected_website`,
4 |     ADD COLUMN `forum_topic_edited`           TEXT       DEFAULT NULL COMMENT 'Service message: forum topic edited' AFTER `forum_topic_created`,
5 |     ADD COLUMN `general_forum_topic_hidden`   TEXT       DEFAULT NULL COMMENT 'Service message: the General forum topic hidden' AFTER `forum_topic_reopened`,
6 |     ADD COLUMN `general_forum_topic_unhidden` TEXT       DEFAULT NULL COMMENT 'Service message: the General forum topic unhidden' AFTER `general_forum_topic_hidden`,
7 |     ADD COLUMN `user_shared`                  TEXT       DEFAULT NULL COMMENT 'Optional. Service message: a user was shared with the bot' AFTER `successful_payment`,
8 |     ADD COLUMN `chat_shared`                  TEXT       DEFAULT NULL COMMENT 'Optional. Service message: a chat was shared with the bot' AFTER `user_shared`;


--------------------------------------------------------------------------------
/database/migrations/sql/structure-0.73.0.sql:
--------------------------------------------------------------------------------
  1 | CREATE TABLE IF NOT EXISTS bot_user (
  2 |   `id` bigint COMMENT 'Unique identifier for this user or bot',
  3 |   `is_bot` tinyint(1) DEFAULT 0 COMMENT 'True, if this user is a bot',
  4 |   `first_name` CHAR(255) NOT NULL DEFAULT '' COMMENT 'User''s or bot''s first name',
  5 |   `last_name` CHAR(255) DEFAULT NULL COMMENT 'User''s or bot''s last name',
  6 |   `username` CHAR(191) DEFAULT NULL COMMENT 'User''s or bot''s username',
  7 |   `language_code` CHAR(10) DEFAULT NULL COMMENT 'IETF language tag of the user''s language',
  8 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
  9 |   `updated_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date update',
 10 | 
 11 |   PRIMARY KEY (`id`),
 12 |   KEY `username` (`username`)
 13 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 14 | 
 15 | CREATE TABLE IF NOT EXISTS bot_chat (
 16 |   `id` bigint COMMENT 'Unique identifier for this chat',
 17 |   `type` ENUM('private', 'group', 'supergroup', 'channel') NOT NULL COMMENT 'Type of chat, can be either private, group, supergroup or channel',
 18 |   `title` CHAR(255) DEFAULT '' COMMENT 'Title, for supergroups, channels and group chats',
 19 |   `username` CHAR(255) DEFAULT NULL COMMENT 'Username, for private chats, supergroups and channels if available',
 20 |   `first_name` CHAR(255) DEFAULT NULL COMMENT 'First name of the other party in a private chat',
 21 |   `last_name` CHAR(255) DEFAULT NULL COMMENT 'Last name of the other party in a private chat',
 22 |   `all_members_are_administrators` tinyint(1) DEFAULT 0 COMMENT 'True if a all members of this group are admins',
 23 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
 24 |   `updated_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date update',
 25 |   `old_id` bigint DEFAULT NULL COMMENT 'Unique chat identifier, this is filled when a group is converted to a supergroup',
 26 | 
 27 |   PRIMARY KEY (`id`),
 28 |   KEY `old_id` (`old_id`)
 29 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 30 | 
 31 | CREATE TABLE IF NOT EXISTS bot_user_chat (
 32 |   `user_id` bigint COMMENT 'Unique user identifier',
 33 |   `chat_id` bigint COMMENT 'Unique user or chat identifier',
 34 | 
 35 |   PRIMARY KEY (`user_id`, `chat_id`),
 36 | 
 37 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
 38 |   FOREIGN KEY (`chat_id`) REFERENCES bot_chat (`id`) ON DELETE CASCADE ON UPDATE CASCADE
 39 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 40 | 
 41 | CREATE TABLE IF NOT EXISTS bot_inline_query (
 42 |   `id` bigint UNSIGNED COMMENT 'Unique identifier for this query',
 43 |   `user_id` bigint NULL COMMENT 'Unique user identifier',
 44 |   `location` CHAR(255) NULL DEFAULT NULL COMMENT 'Location of the user',
 45 |   `query` TEXT NOT NULL COMMENT 'Text of the query',
 46 |   `offset` CHAR(255) NULL DEFAULT NULL COMMENT 'Offset of the result',
 47 |   `chat_type` CHAR(255) NULL DEFAULT NULL COMMENT 'Optional. Type of the chat, from which the inline query was sent.',
 48 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
 49 | 
 50 |   PRIMARY KEY (`id`),
 51 |   KEY `user_id` (`user_id`),
 52 | 
 53 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`)
 54 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 55 | 
 56 | CREATE TABLE IF NOT EXISTS bot_chosen_inline_result (
 57 |   `id` bigint UNSIGNED AUTO_INCREMENT COMMENT 'Unique identifier for this entry',
 58 |   `result_id` CHAR(255) NOT NULL DEFAULT '' COMMENT 'The unique identifier for the result that was chosen',
 59 |   `user_id` bigint NULL COMMENT 'The user that chose the result',
 60 |   `location` CHAR(255) NULL DEFAULT NULL COMMENT 'Sender location, only for bots that require user location',
 61 |   `inline_message_id` CHAR(255) NULL DEFAULT NULL COMMENT 'Identifier of the sent inline message',
 62 |   `query` TEXT NOT NULL COMMENT 'The query that was used to obtain the result',
 63 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
 64 | 
 65 |   PRIMARY KEY (`id`),
 66 |   KEY `user_id` (`user_id`),
 67 | 
 68 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`)
 69 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 70 | 
 71 | CREATE TABLE IF NOT EXISTS bot_message (
 72 |   `chat_id` bigint COMMENT 'Unique chat identifier',
 73 |   `sender_chat_id` bigint COMMENT 'Sender of the message, sent on behalf of a chat',
 74 |   `id` bigint UNSIGNED COMMENT 'Unique message identifier',
 75 |   `user_id` bigint NULL COMMENT 'Unique user identifier',
 76 |   `date` timestamp NULL DEFAULT NULL COMMENT 'Date the message was sent in timestamp format',
 77 |   `forward_from` bigint NULL DEFAULT NULL COMMENT 'Unique user identifier, sender of the original message',
 78 |   `forward_from_chat` bigint NULL DEFAULT NULL COMMENT 'Unique chat identifier, chat the original message belongs to',
 79 |   `forward_from_message_id` bigint NULL DEFAULT NULL COMMENT 'Unique chat identifier of the original message in the channel',
 80 |   `forward_signature` TEXT NULL DEFAULT NULL COMMENT 'For messages forwarded from channels, signature of the post author if present',
 81 |   `forward_sender_name` TEXT NULL DEFAULT NULL COMMENT 'Sender''s name for messages forwarded from users who disallow adding a link to their account in forwarded messages',
 82 |   `forward_date` timestamp NULL DEFAULT NULL COMMENT 'date the original message was sent in timestamp format',
 83 |   `reply_to_chat` bigint NULL DEFAULT NULL COMMENT 'Unique chat identifier',
 84 |   `reply_to_message` bigint UNSIGNED DEFAULT NULL COMMENT 'Message that this message is reply to',
 85 |   `via_bot` bigint NULL DEFAULT NULL COMMENT 'Optional. Bot through which the message was sent',
 86 |   `edit_date` timestamp NULL DEFAULT NULL COMMENT 'Date the message was last edited in Unix time',
 87 |   `media_group_id` TEXT COMMENT 'The unique identifier of a media message group this message belongs to',
 88 |   `author_signature` TEXT COMMENT 'Signature of the post author for messages in channels',
 89 |   `text` TEXT COMMENT 'For text messages, the actual UTF-8 text of the message max message length 4096 char utf8mb4',
 90 |   `entities` TEXT COMMENT 'For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text',
 91 |   `caption_entities` TEXT COMMENT 'For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption',
 92 |   `audio` TEXT COMMENT 'Audio object. Message is an audio file, information about the file',
 93 |   `document` TEXT COMMENT 'Document object. Message is a general file, information about the file',
 94 |   `animation` TEXT COMMENT 'Message is an animation, information about the animation',
 95 |   `game` TEXT COMMENT 'Game object. Message is a game, information about the game',
 96 |   `photo` TEXT COMMENT 'Array of PhotoSize objects. Message is a photo, available sizes of the photo',
 97 |   `sticker` TEXT COMMENT 'Sticker object. Message is a sticker, information about the sticker',
 98 |   `video` TEXT COMMENT 'Video object. Message is a video, information about the video',
 99 |   `voice` TEXT COMMENT 'Voice Object. Message is a Voice, information about the Voice',
100 |   `video_note` TEXT COMMENT 'VoiceNote Object. Message is a Video Note, information about the Video Note',
101 |   `caption` TEXT COMMENT  'For message with caption, the actual UTF-8 text of the caption',
102 |   `contact` TEXT COMMENT 'Contact object. Message is a shared contact, information about the contact',
103 |   `location` TEXT COMMENT 'Location object. Message is a shared location, information about the location',
104 |   `venue` TEXT COMMENT 'Venue object. Message is a Venue, information about the Venue',
105 |   `poll` TEXT COMMENT 'Poll object. Message is a native poll, information about the poll',
106 |   `dice` TEXT COMMENT 'Message is a dice with random value from 1 to 6',
107 |   `new_chat_members` TEXT COMMENT 'List of unique user identifiers, new member(s) were added to the group, information about them (one of these members may be the bot itself)',
108 |   `left_chat_member` bigint NULL DEFAULT NULL COMMENT 'Unique user identifier, a member was removed from the group, information about them (this member may be the bot itself)',
109 |   `new_chat_title` CHAR(255) DEFAULT NULL COMMENT 'A chat title was changed to this value',
110 |   `new_chat_photo` TEXT COMMENT 'Array of PhotoSize objects. A chat photo was change to this value',
111 |   `delete_chat_photo` tinyint(1) DEFAULT 0 COMMENT 'Informs that the chat photo was deleted',
112 |   `group_chat_created` tinyint(1) DEFAULT 0 COMMENT 'Informs that the group has been created',
113 |   `supergroup_chat_created` tinyint(1) DEFAULT 0 COMMENT 'Informs that the supergroup has been created',
114 |   `channel_chat_created` tinyint(1) DEFAULT 0 COMMENT 'Informs that the channel chat has been created',
115 |   `message_auto_delete_timer_changed` TEXT COMMENT 'MessageAutoDeleteTimerChanged object. Message is a service message: auto-delete timer settings changed in the chat',
116 |   `migrate_to_chat_id` bigint NULL DEFAULT NULL COMMENT 'Migrate to chat identifier. The group has been migrated to a supergroup with the specified identifier',
117 |   `migrate_from_chat_id` bigint NULL DEFAULT NULL COMMENT 'Migrate from chat identifier. The supergroup has been migrated from a group with the specified identifier',
118 |   `pinned_message` TEXT NULL COMMENT 'Message object. Specified message was pinned',
119 |   `invoice` TEXT NULL COMMENT 'Message is an invoice for a payment, information about the invoice',
120 |   `successful_payment` TEXT NULL COMMENT 'Message is a service message about a successful payment, information about the payment',
121 |   `connected_website` TEXT NULL COMMENT 'The domain name of the website on which the user has logged in.',
122 |   `passport_data` TEXT NULL COMMENT 'Telegram Passport data',
123 |   `proximity_alert_triggered` TEXT NULL COMMENT 'Service message. A user in the chat triggered another user''s proximity alert while sharing Live Location.',
124 |   `voice_chat_scheduled` TEXT COMMENT 'VoiceChatScheduled object. Message is a service message: voice chat scheduled',
125 |   `voice_chat_started` TEXT COMMENT 'VoiceChatStarted object. Message is a service message: voice chat started',
126 |   `voice_chat_ended` TEXT COMMENT 'VoiceChatEnded object. Message is a service message: voice chat ended',
127 |   `voice_chat_participants_invited` TEXT COMMENT 'VoiceChatParticipantsInvited object. Message is a service message: new participants invited to a voice chat',
128 |   `reply_markup` TEXT NULL COMMENT 'Inline keyboard attached to the message',
129 | 
130 |   PRIMARY KEY (`chat_id`, `id`),
131 |   KEY `user_id` (`user_id`),
132 |   KEY `forward_from` (`forward_from`),
133 |   KEY `forward_from_chat` (`forward_from_chat`),
134 |   KEY `reply_to_chat` (`reply_to_chat`),
135 |   KEY `reply_to_message` (`reply_to_message`),
136 |   KEY `via_bot` (`via_bot`),
137 |   KEY `left_chat_member` (`left_chat_member`),
138 |   KEY `migrate_from_chat_id` (`migrate_from_chat_id`),
139 |   KEY `migrate_to_chat_id` (`migrate_to_chat_id`),
140 | 
141 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`),
142 |   FOREIGN KEY (`chat_id`) REFERENCES bot_chat (`id`),
143 |   FOREIGN KEY (`forward_from`) REFERENCES bot_user (`id`),
144 |   FOREIGN KEY (`forward_from_chat`) REFERENCES bot_chat (`id`),
145 |   FOREIGN KEY (`reply_to_chat`, `reply_to_message`) REFERENCES bot_message (`chat_id`, `id`),
146 |   FOREIGN KEY (`via_bot`) REFERENCES bot_user (`id`),
147 |   FOREIGN KEY (`left_chat_member`) REFERENCES bot_user (`id`)
148 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
149 | 
150 | CREATE TABLE IF NOT EXISTS bot_edited_message (
151 |   `id` bigint UNSIGNED AUTO_INCREMENT COMMENT 'Unique identifier for this entry',
152 |   `chat_id` bigint COMMENT 'Unique chat identifier',
153 |   `message_id` bigint UNSIGNED COMMENT 'Unique message identifier',
154 |   `user_id` bigint NULL COMMENT 'Unique user identifier',
155 |   `edit_date` timestamp NULL DEFAULT NULL COMMENT 'Date the message was edited in timestamp format',
156 |   `text` TEXT COMMENT 'For text messages, the actual UTF-8 text of the message max message length 4096 char utf8',
157 |   `entities` TEXT COMMENT 'For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text',
158 |   `caption` TEXT COMMENT  'For message with caption, the actual UTF-8 text of the caption',
159 | 
160 |   PRIMARY KEY (`id`),
161 |   KEY `chat_id` (`chat_id`),
162 |   KEY `message_id` (`message_id`),
163 |   KEY `user_id` (`user_id`),
164 | 
165 |   FOREIGN KEY (`chat_id`) REFERENCES bot_chat (`id`),
166 |   FOREIGN KEY (`chat_id`, `message_id`) REFERENCES bot_message (`chat_id`, `id`),
167 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`)
168 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
169 | 
170 | CREATE TABLE IF NOT EXISTS bot_callback_query (
171 |   `id` bigint UNSIGNED COMMENT 'Unique identifier for this query',
172 |   `user_id` bigint NULL COMMENT 'Unique user identifier',
173 |   `chat_id` bigint NULL COMMENT 'Unique chat identifier',
174 |   `message_id` bigint UNSIGNED COMMENT 'Unique message identifier',
175 |   `inline_message_id` CHAR(255) NULL DEFAULT NULL COMMENT 'Identifier of the message sent via the bot in inline mode, that originated the query',
176 |   `chat_instance` CHAR(255) NOT NULL DEFAULT '' COMMENT 'Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent',
177 |   `data` CHAR(255) NOT NULL DEFAULT '' COMMENT 'Data associated with the callback button',
178 |   `game_short_name` CHAR(255) NOT NULL DEFAULT '' COMMENT 'Short name of a Game to be returned, serves as the unique identifier for the game',
179 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
180 | 
181 |   PRIMARY KEY (`id`),
182 |   KEY `user_id` (`user_id`),
183 |   KEY `chat_id` (`chat_id`),
184 |   KEY `message_id` (`message_id`),
185 | 
186 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`),
187 |   FOREIGN KEY (`chat_id`, `message_id`) REFERENCES bot_message (`chat_id`, `id`)
188 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
189 | 
190 | CREATE TABLE IF NOT EXISTS bot_shipping_query (
191 |   `id` bigint UNSIGNED COMMENT 'Unique query identifier',
192 |   `user_id` bigint COMMENT 'User who sent the query',
193 |   `invoice_payload` CHAR(255) NOT NULL DEFAULT '' COMMENT 'Bot specified invoice payload',
194 |   `shipping_address` CHAR(255) NOT NULL DEFAULT '' COMMENT 'User specified shipping address',
195 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
196 | 
197 |   PRIMARY KEY (`id`),
198 |   KEY `user_id` (`user_id`),
199 | 
200 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`)
201 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
202 | 
203 | CREATE TABLE IF NOT EXISTS bot_pre_checkout_query (
204 |   `id` bigint UNSIGNED COMMENT 'Unique query identifier',
205 |   `user_id` bigint COMMENT 'User who sent the query',
206 |   `currency` CHAR(3) COMMENT 'Three-letter ISO 4217 currency code',
207 |   `total_amount` bigint COMMENT 'Total price in the smallest units of the currency',
208 |   `invoice_payload` CHAR(255) NOT NULL DEFAULT '' COMMENT 'Bot specified invoice payload',
209 |   `shipping_option_id` CHAR(255) NULL COMMENT 'Identifier of the shipping option chosen by the user',
210 |   `order_info` TEXT NULL COMMENT 'Order info provided by the user',
211 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
212 | 
213 |   PRIMARY KEY (`id`),
214 |   KEY `user_id` (`user_id`),
215 | 
216 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`)
217 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
218 | 
219 | CREATE TABLE IF NOT EXISTS bot_poll (
220 |   `id` bigint UNSIGNED COMMENT 'Unique poll identifier',
221 |   `question` text NOT NULL COMMENT 'Poll question',
222 |   `options` text NOT NULL COMMENT 'List of poll options',
223 |   `total_voter_count` int UNSIGNED COMMENT 'Total number of users that voted in the poll',
224 |   `is_closed` tinyint(1) DEFAULT 0 COMMENT 'True, if the poll is closed',
225 |   `is_anonymous` tinyint(1) DEFAULT 1 COMMENT 'True, if the poll is anonymous',
226 |   `type` char(255) COMMENT 'Poll type, currently can be “regular” or “quiz”',
227 |   `allows_multiple_answers` tinyint(1) DEFAULT 0 COMMENT 'True, if the poll allows multiple answers',
228 |   `correct_option_id` int UNSIGNED COMMENT '0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.',
229 |   `explanation` varchar(255) DEFAULT NULL COMMENT 'Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters',
230 |   `explanation_entities` text DEFAULT NULL COMMENT 'Special entities like usernames, URLs, bot commands, etc. that appear in the explanation',
231 |   `open_period` int UNSIGNED DEFAULT NULL COMMENT 'Amount of time in seconds the poll will be active after creation',
232 |   `close_date` timestamp NULL DEFAULT NULL COMMENT 'Point in time (Unix timestamp) when the poll will be automatically closed',
233 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
234 | 
235 |   PRIMARY KEY (`id`)
236 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
237 | 
238 | CREATE TABLE IF NOT EXISTS bot_poll_answer (
239 |   `poll_id` bigint UNSIGNED COMMENT 'Unique poll identifier',
240 |   `user_id` bigint NOT NULL COMMENT 'The user, who changed the answer to the poll',
241 |   `option_ids` text NOT NULL COMMENT '0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.',
242 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
243 | 
244 |   PRIMARY KEY (`poll_id`, `user_id`),
245 |   FOREIGN KEY (`poll_id`) REFERENCES bot_poll (`id`)
246 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
247 | 
248 | CREATE TABLE IF NOT EXISTS bot_chat_member_updated (
249 |   `id` BIGINT UNSIGNED AUTO_INCREMENT COMMENT 'Unique identifier for this entry',
250 |   `chat_id` BIGINT NOT NULL COMMENT 'Chat the user belongs to',
251 |   `user_id` BIGINT NOT NULL COMMENT 'Performer of the action, which resulted in the change',
252 |   `date` TIMESTAMP NOT NULL COMMENT 'Date the change was done in Unix time',
253 |   `old_chat_member` TEXT NOT NULL COMMENT 'Previous information about the chat member',
254 |   `new_chat_member` TEXT NOT NULL COMMENT 'New information about the chat member',
255 |   `invite_link` TEXT NULL COMMENT 'Chat invite link, which was used by the user to join the chat; for joining by invite link events only',
256 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
257 | 
258 |   PRIMARY KEY (`id`),
259 |   FOREIGN KEY (`chat_id`) REFERENCES bot_chat (`id`),
260 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`)
261 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
262 | 
263 | CREATE TABLE IF NOT EXISTS bot_telegram_update (
264 |   `id` bigint UNSIGNED COMMENT 'Update''s unique identifier',
265 |   `chat_id` bigint NULL DEFAULT NULL COMMENT 'Unique chat identifier',
266 |   `message_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New incoming message of any kind - text, photo, sticker, etc.',
267 |   `edited_message_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New version of a message that is known to the bot and was edited',
268 |   `channel_post_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New incoming channel post of any kind - text, photo, sticker, etc.',
269 |   `edited_channel_post_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New version of a channel post that is known to the bot and was edited',
270 |   `inline_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New incoming inline query',
271 |   `chosen_inline_result_id` bigint UNSIGNED DEFAULT NULL COMMENT 'The result of an inline query that was chosen by a user and sent to their chat partner',
272 |   `callback_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New incoming callback query',
273 |   `shipping_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New incoming shipping query. Only for invoices with flexible price',
274 |   `pre_checkout_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New incoming pre-checkout query. Contains full information about checkout',
275 |   `poll_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New poll state. Bots receive only updates about polls, which are sent or stopped by the bot',
276 |   `poll_answer_poll_id` bigint UNSIGNED DEFAULT NULL COMMENT 'A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.',
277 |   `my_chat_member_updated_id` BIGINT UNSIGNED NULL COMMENT 'The bot''s chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.',
278 |   `chat_member_updated_id` BIGINT UNSIGNED NULL COMMENT 'A chat member''s status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates.',
279 | 
280 |   PRIMARY KEY (`id`),
281 |   KEY `message_id` (`message_id`),
282 |   KEY `chat_message_id` (`chat_id`, `message_id`),
283 |   KEY `edited_message_id` (`edited_message_id`),
284 |   KEY `channel_post_id` (`channel_post_id`),
285 |   KEY `edited_channel_post_id` (`edited_channel_post_id`),
286 |   KEY `inline_query_id` (`inline_query_id`),
287 |   KEY `chosen_inline_result_id` (`chosen_inline_result_id`),
288 |   KEY `callback_query_id` (`callback_query_id`),
289 |   KEY `shipping_query_id` (`shipping_query_id`),
290 |   KEY `pre_checkout_query_id` (`pre_checkout_query_id`),
291 |   KEY `poll_id` (`poll_id`),
292 |   KEY `poll_answer_poll_id` (`poll_answer_poll_id`),
293 |   KEY `my_chat_member_updated_id` (`my_chat_member_updated_id`),
294 |   KEY `chat_member_updated_id` (`chat_member_updated_id`),
295 | 
296 |   FOREIGN KEY (`chat_id`, `message_id`) REFERENCES bot_message (`chat_id`, `id`),
297 |   FOREIGN KEY (`edited_message_id`) REFERENCES bot_edited_message (`id`),
298 |   FOREIGN KEY (`chat_id`, `channel_post_id`) REFERENCES bot_message (`chat_id`, `id`),
299 |   FOREIGN KEY (`edited_channel_post_id`) REFERENCES bot_edited_message (`id`),
300 |   FOREIGN KEY (`inline_query_id`) REFERENCES bot_inline_query (`id`),
301 |   FOREIGN KEY (`chosen_inline_result_id`) REFERENCES bot_chosen_inline_result (`id`),
302 |   FOREIGN KEY (`callback_query_id`) REFERENCES bot_callback_query (`id`),
303 |   FOREIGN KEY (`shipping_query_id`) REFERENCES bot_shipping_query (`id`),
304 |   FOREIGN KEY (`pre_checkout_query_id`) REFERENCES bot_pre_checkout_query (`id`),
305 |   FOREIGN KEY (`poll_id`) REFERENCES bot_poll (`id`),
306 |   FOREIGN KEY (`poll_answer_poll_id`) REFERENCES bot_poll_answer (`poll_id`),
307 |   FOREIGN KEY (`my_chat_member_updated_id`) REFERENCES bot_chat_member_updated (`id`),
308 |   FOREIGN KEY (`chat_member_updated_id`) REFERENCES bot_chat_member_updated (`id`)
309 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
310 | 
311 | CREATE TABLE IF NOT EXISTS bot_conversation (
312 |   `id` bigint(20) unsigned AUTO_INCREMENT COMMENT 'Unique identifier for this entry',
313 |   `user_id` bigint NULL DEFAULT NULL COMMENT 'Unique user identifier',
314 |   `chat_id` bigint NULL DEFAULT NULL COMMENT 'Unique user or chat identifier',
315 |   `status` ENUM('active', 'cancelled', 'stopped') NOT NULL DEFAULT 'active' COMMENT 'Conversation state',
316 |   `command` varchar(160) DEFAULT '' COMMENT 'Default command to execute',
317 |   `notes` text DEFAULT NULL COMMENT 'Data stored from command',
318 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
319 |   `updated_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date update',
320 | 
321 |   PRIMARY KEY (`id`),
322 |   KEY `user_id` (`user_id`),
323 |   KEY `chat_id` (`chat_id`),
324 |   KEY `status` (`status`),
325 | 
326 |   FOREIGN KEY (`user_id`) REFERENCES bot_user (`id`),
327 |   FOREIGN KEY (`chat_id`) REFERENCES bot_chat (`id`)
328 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
329 | 
330 | CREATE TABLE IF NOT EXISTS bot_request_limiter (
331 |   `id` bigint UNSIGNED AUTO_INCREMENT COMMENT 'Unique identifier for this entry',
332 |   `chat_id` char(255) NULL DEFAULT NULL COMMENT 'Unique chat identifier',
333 |   `inline_message_id` char(255) NULL DEFAULT NULL COMMENT 'Identifier of the sent inline message',
334 |   `method` char(255) DEFAULT NULL COMMENT 'Request method',
335 |   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
336 | 
337 |   PRIMARY KEY (`id`)
338 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
339 | 


--------------------------------------------------------------------------------
/license.md:
--------------------------------------------------------------------------------
 1 | # The license
 2 | 
 3 | MIT License
 4 | 
 5 | Copyright (c) 2022 [PHP Telegram Bot](https://github.com/php-telegram-bot)
 6 | 
 7 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 8 | 
 9 | The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
10 | 
11 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
12 | 


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit bootstrap="vendor/autoload.php"
 3 |          backupGlobals="false"
 4 |          backupStaticAttributes="false"
 5 |          colors="true"
 6 |          verbose="true"
 7 |          convertErrorsToExceptions="true"
 8 |          convertNoticesToExceptions="true"
 9 |          convertWarningsToExceptions="true"
10 |          processIsolation="false"
11 |          stopOnFailure="false">
12 |     <testsuites>
13 |         <testsuite name="Package">
14 |             <directory suffix=".php">./tests/</directory>
15 |         </testsuite>
16 |     </testsuites>
17 |     <filter>
18 |         <whitelist>
19 |             <directory>src/</directory>
20 |         </whitelist>
21 |     </filter>
22 | </phpunit>
23 | 


--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
  1 | # LaravelTelegramBot
  2 | 
  3 | [![Latest Version on Packagist][ico-version]][link-packagist]
  4 | [![Total Downloads][ico-downloads]][link-downloads]
  5 | 
  6 | ## Installation
  7 | 
  8 | Install this package through Composer. Run this command in your project's terminal:
  9 | 
 10 | ``` bash
 11 | composer require php-telegram-bot/laravel
 12 | ```
 13 | 
 14 | Execute the following command to publish the folder structure to your Laravel application:
 15 | ```bash
 16 | php artisan telegram:publish
 17 | ```
 18 | This also includes a dummy `/start` command to give you a quick start.
 19 | 
 20 | Since we're using the database part of php-telegram-bot you should run the migrations so the database schema gets installed:
 21 | ```bash
 22 | php artisan migrate
 23 | ```
 24 | 
 25 | And add the following lines to your .env file:
 26 | ```dotenv
 27 | TELEGRAM_API_TOKEN=
 28 | TELEGRAM_BOT_USERNAME=
 29 | TELEGRAM_API_URL=
 30 | TELEGRAM_ADMINS=
 31 | ```
 32 | 
 33 | `TELEGRAM_API_TOKEN` and `TELEGRAM_BOT_USERNAME` should be filled with the corresponding data from [@BotFather](https://t.me/BotFather)
 34 | 
 35 | `TELEGRAM_API_URL` is optional and can be filled with the URL to your  [custom Bot API Server](https://core.telegram.org/bots/api#using-a-local-bot-api-server) if you want to use one.
 36 | 
 37 | `TELEGRAM_ADMINS` is optional and a comma-separated list of Telegram User IDs that gets passed to the `enableAdmins` command of php-telegram-bot to enable admin commands for those users.
 38 | 
 39 | After that you can run `php artisan telegram:set-webhook` if your development server is reachable from the outside or you're using a custom bot api server. 
 40 | 
 41 | Or `php artisan telegram:fetch` to start fetching your updates via polling.
 42 | 
 43 | ⚠️ Be aware that you have to cancel and restart the `telegram:fetch` command, if you change your code.
 44 | 
 45 | ## Usage
 46 | For further basic configuration of this Laravel package you do not need to create any configuration files.
 47 | 
 48 | Artisan terminal commands for the Webhook usage (remember, that you need an HTTPS server for it):
 49 | ``` bash
 50 | # Use this method to specify a url and receive incoming updates via an outgoing webhook
 51 | php artisan telegram:set-webhook
 52 | # List of available options: 
 53 | # --d|drop-pending-updates : Drop all pending updates
 54 | # --a|all-update-types : Explicitly allow all updates (including "chat_member")
 55 | # --allowed-updates= : Define allowed updates (comma-seperated)
 56 | 
 57 | # Use this method to remove webhook integration if you decide to switch back to getUpdates
 58 | php artisan telegram:delete-webhook
 59 | # List of available options:
 60 | # --d|drop-pending-updates : Pass to drop all pending updates
 61 | ```
 62 | Artisan terminal commands for the Telegram getUpdates method:
 63 | ``` bash
 64 | # Fetches Telegram updates periodically
 65 | php artisan telegram:fetch 
 66 | # List of available options:
 67 | # --a|all-update-types : Explicitly allow all updates (including "chat_member")
 68 | # --allowed-updates= : Define allowed updates (comma-seperated)
 69 | ```
 70 | Artisan terminal command for Telegram Server logging out:
 71 | ``` bash
 72 | # Sends a logout to the currently registered Telegram Server
 73 | php artisan telegram:logout
 74 | ```
 75 | Artisan terminal command for closing Telegram Server:
 76 | ``` bash
 77 | # Sends a close to the currently registered Telegram Server
 78 | php artisan telegram:close
 79 | ```
 80 | Artisan terminal command for publishing Telegram command folder structure in your project:
 81 | ``` bash
 82 | # Publishes folder structure for Telegram Commands
 83 | # Default StartCommand class will be created
 84 | php artisan telegram:publish
 85 | ```
 86 | Artisan terminal command for creating new Telegram command class in your project:
 87 | ``` bash
 88 | # Create a new Telegram Bot Command class
 89 | # e.g. php artisan make:telegram-command Menu --> will make User command class MenuCommand 
 90 | # e.g. php artisan make:telegram-command Genericmessage --system --> will make System command class GenericmessageCommand
 91 | php artisan make:telegram-command
 92 | # List of available options:
 93 | # name : Name of the Telegram Command
 94 | # --a|admin : Generate a AdminCommand
 95 | # --s|system : Generate a SystemCommand
 96 | # Without admin or system option default User command will be created
 97 | ```
 98 | 
 99 | 
100 | 
101 | ## Credits
102 | 
103 | - [Avtandil Kikabidze aka LONGMAN](https://github.com/akalongman)
104 | - [TiiFuchs](https://github.com/TiiFuchs)
105 | - [All Contributors][link-contributors]
106 | 
107 | ## License
108 | 
109 | Please see the [license file](license.md) for more information.
110 | 
111 | [ico-version]: https://img.shields.io/packagist/v/php-telegram-bot/laravel.svg?style=flat-square
112 | [ico-downloads]: https://img.shields.io/packagist/dt/php-telegram-bot/laravel.svg?style=flat-square
113 | 
114 | [link-packagist]: https://packagist.org/packages/php-telegram-bot/laravel
115 | [link-downloads]: https://packagist.org/packages/php-telegram-bot/laravel
116 | [link-contributors]: https://github.com/php-telegram-bot/laravel/contributors
117 | 


--------------------------------------------------------------------------------
/routes/telegram.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | Route::post('/api/telegram/webhook/{token}', static function (\Longman\TelegramBot\Telegram $bot, $token) {
 4 |     if ($token != config('telegram.bot.api_token')) {
 5 |         abort(400);
 6 |     }
 7 | 
 8 |     $bot->handle();
 9 | })->middleware('telegram.network')->name('telegram.webhook');
10 | 


--------------------------------------------------------------------------------
/src/Console/Commands/GeneratorCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace PhpTelegramBot\Laravel\Console\Commands;
 5 | 
 6 | 
 7 | use Illuminate\Console\Command;
 8 | 
 9 | abstract class GeneratorCommand extends Command
10 | {
11 | 
12 |     protected function publish(string $source, string $destination, array $replacements = [], bool $overwrite = false) : bool
13 |     {
14 |         if (file_exists($destination) && ! $overwrite) {
15 |             $basename = basename($destination);
16 |             $this->error("{$basename} already exists!");
17 |             return false;
18 |         }
19 | 
20 |         $content = file_get_contents($source);
21 |         $content = $this->replacePlaceholder($content, $replacements);
22 |         file_put_contents($destination, $content);
23 | 
24 |         return true;
25 |     }
26 | 
27 |     protected function replacePlaceholder(string $content, array $replacements): string
28 |     {
29 |         foreach ($replacements as $from => $to) {
30 |             $content = str_replace($from, $to, $content);
31 |         }
32 | 
33 |         return $content;
34 |     }
35 | 
36 |     protected function getRootNamespace(): string
37 |     {
38 |         return rtrim($this->laravel->getNamespace(), '\\');
39 |     }
40 | 
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Console/Commands/MakeTelegramCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Console\Commands;
 4 | 
 5 | use Illuminate\Support\Str;
 6 | 
 7 | class MakeTelegramCommand extends GeneratorCommand
 8 | {
 9 |     protected $signature = 'make:telegram-command
10 |                             {name : Name of the Telegram Command}
11 |                             {--a|admin : Generate a AdminCommand}
12 |                             {--s|system : Generate a SystemCommand}';
13 | 
14 |     protected $description = 'Create a new Telegram Bot Command class';
15 | 
16 |     /*
17 |      * DummyNamespace
18 |      * DummyParent
19 |      * DummyClass
20 |      * {{name}}
21 |      */
22 | 
23 |     public function handle()
24 |     {
25 |         $name = $this->argument('name'); // start
26 | 
27 |         if (Str::endsWith($name, ['Command', 'command'])) {
28 |             $name = (string) Str::of($name)->substr(0, -7)->lower();
29 |         } else {
30 |             $name = Str::lower($name);
31 |         }
32 | 
33 |         $class = Str::studly($name) . 'Command';
34 | 
35 |         $success = $this->publish(
36 |             __DIR__ . '/stubs/telegram-command.stub',
37 |             app_path("Telegram/Commands/{$class}.php"),
38 |             [
39 |                 'DummyNamespace' => $this->getRootNamespace(),
40 |                 'DummyParent'    => $this->getParentClassName(),
41 |                 'DummyClass'     => $class,
42 |                 '{{name}}'       => $name
43 |             ]
44 |         );
45 | 
46 |         if ($success) {
47 |             $this->info('Telegram Command created successfully');
48 |         }
49 |     }
50 | 
51 |     protected function getParentClassName()
52 |     {
53 |         if ($this->option('admin')) {
54 |             return 'AdminCommand';
55 |         }
56 | 
57 |         if ($this->option('system')) {
58 |             return 'SystemCommand';
59 |         }
60 | 
61 |         return 'UserCommand';
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/src/Console/Commands/TelegramCloseCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Console\Commands;
 4 | 
 5 | use Illuminate\Console\Command;
 6 | use Longman\TelegramBot\Request;
 7 | use Longman\TelegramBot\Telegram;
 8 | 
 9 | class TelegramCloseCommand extends Command
10 | {
11 |     protected $signature = 'telegram:close';
12 | 
13 |     protected $description = 'Sends a close to the currently registered Telegram Server';
14 | 
15 |     public function handle(Telegram $bot)
16 |     {
17 |         $response = Request::close();
18 | 
19 |         if (! $response->isOk()) {
20 |             $this->error($response->getDescription());
21 |         }
22 | 
23 |         $this->info($response->getDescription());
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Console/Commands/TelegramDeleteWebhookCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Console\Commands;
 4 | 
 5 | use Illuminate\Console\Command;
 6 | use Longman\TelegramBot\Request;
 7 | use Longman\TelegramBot\Telegram;
 8 | 
 9 | class TelegramDeleteWebhookCommand extends Command
10 | {
11 |     protected $signature = 'telegram:delete-webhook
12 |                             {--d|drop-pending-updates : Pass to drop all pending updates}';
13 | 
14 |     protected $description = 'Use this method to remove webhook integration if you decide to switch back to getUpdates';
15 | 
16 |     public function handle(Telegram $bot)
17 |     {
18 |         $options = [];
19 |         if ($this->option('drop-pending-updates')) {
20 |             $options['drop_pending_updates'] = true;
21 |         }
22 | 
23 |         $response = Request::deleteWebhook($options);
24 | 
25 |         if (! $response->isOk()) {
26 |             $this->error($response->getDescription());
27 |         }
28 | 
29 |         $this->info($response->getDescription());
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Console/Commands/TelegramFetchCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace PhpTelegramBot\Laravel\Console\Commands;
 5 | 
 6 | 
 7 | use Illuminate\Console\Command;
 8 | use Illuminate\Support\Str;
 9 | use Longman\TelegramBot\Entities\Update;
10 | use Longman\TelegramBot\Exception\TelegramException;
11 | use Longman\TelegramBot\Telegram;
12 | use Symfony\Component\Console\Command\SignalableCommandInterface;
13 | 
14 | class TelegramFetchCommand extends Command implements SignalableCommandInterface
15 | {
16 | 
17 |     protected $signature = 'telegram:fetch
18 |                             {--a|all-update-types : Explicitly allow all updates (including "chat_member")}
19 |                             {--allowed-updates= : Define allowed updates (comma-seperated)}';
20 | 
21 |     protected $description = 'Fetches Telegram updates periodically';
22 | 
23 |     protected bool $shallExit = false;
24 | 
25 |     protected ?int $childPid = null;
26 | 
27 |     public function handle(Telegram $bot)
28 |     {
29 |         $this->callSilent('telegram:delete-webhook');
30 | 
31 |         $options = [
32 |             'timeout' => 30
33 |         ];
34 | 
35 |         // allowed_updates
36 |         if ($this->option('all-update-types')) {
37 |             $options['allowed_updates'] = Update::getUpdateTypes();
38 |         } elseif ($allowedUpdates = $this->option('allowed-updates')) {
39 |             $options['allowed_updates'] = Str::of($allowedUpdates)->explode(',');
40 |         }
41 | 
42 |         $this->info("Start fetching updates...\n<comment>(Exit with Ctrl + C)</comment>");
43 | 
44 |         if ($this->childPid = pcntl_fork()) {
45 |             // Parent process
46 | 
47 |             while (true) {
48 | 
49 |                 if ($this->shallExit) {
50 |                     exec('kill -9 ' . $this->childPid);
51 |                     break;
52 |                 }
53 | 
54 |             }
55 | 
56 |         } else {
57 |             // Child process
58 | 
59 |             while (true) {
60 | 
61 |                 $response = rescue(fn() => $bot->handleGetUpdates($options));
62 | 
63 |                 if ($response !== null && ! $response->isOk()) {
64 |                     $this->error($response->getDescription());
65 |                 }
66 | 
67 |             }
68 | 
69 |         }
70 |     }
71 | 
72 |     public function getSubscribedSignals(): array
73 |     {
74 |         return [SIGINT];
75 |     }
76 | 
77 |     public function handleSignal(int $signal, int|false $previousExitCode = 0): int|false
78 |     {
79 |         $this->shallExit = true;
80 |     }
81 | }
82 | 


--------------------------------------------------------------------------------
/src/Console/Commands/TelegramLogoutCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Console\Commands;
 4 | 
 5 | use Illuminate\Console\Command;
 6 | use Longman\TelegramBot\Request;
 7 | use Longman\TelegramBot\Telegram;
 8 | 
 9 | class TelegramLogoutCommand extends Command
10 | {
11 |     protected $signature = 'telegram:logout';
12 | 
13 |     protected $description = 'Sends a logout to the currently registered Telegram Server';
14 | 
15 |     public function handle(Telegram $bot)
16 |     {
17 |         $response = Request::logOut();
18 | 
19 |         if (! $response->isOk()) {
20 |             $this->error($response->getDescription());
21 |         }
22 | 
23 |         $this->info($response->getDescription());
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Console/Commands/TelegramPublishCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Console\Commands;
 4 | 
 5 | use Illuminate\Filesystem\Filesystem;
 6 | 
 7 | class TelegramPublishCommand extends GeneratorCommand
 8 | {
 9 |     protected $signature = 'telegram:publish';
10 | 
11 |     protected $description = 'Publishes folder structure for Telegram Commands';
12 | 
13 |     public function handle()
14 |     {
15 |         (new Filesystem())->ensureDirectoryExists(app_path('Telegram/Commands'));
16 |         $success = $this->publish(
17 |             __DIR__ . '/stubs/example-start-command.stub',
18 |             app_path('Telegram/Commands/StartCommand.php'),
19 |             [
20 |                 'DummyRootNamespace' => $this->getRootNamespace(),
21 |             ]
22 |         );
23 | 
24 |         if ($success) {
25 |             $this->info('Publishing complete.');
26 |         }
27 |     }
28 | 
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Console/Commands/TelegramSetWebhookCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Console\Commands;
 4 | 
 5 | use Illuminate\Console\Command;
 6 | use Illuminate\Support\Str;
 7 | use Longman\TelegramBot\Entities\Update;
 8 | use Longman\TelegramBot\Telegram;
 9 | 
10 | class TelegramSetWebhookCommand extends Command
11 | {
12 |     protected $signature = 'telegram:set-webhook
13 |                             {hostname? : Hostname to set}
14 |                             {--d|drop-pending-updates : Drop all pending updates}
15 |                             {--a|all-update-types : Explicitly allow all updates (including "chat_member")}
16 |                             {--allowed-updates= : Define allowed updates (comma-seperated)}';
17 | 
18 |     protected $description = 'Use this method to specify a url and receive incoming updates via an outgoing webhook';
19 | 
20 |     public function handle(Telegram $bot)
21 |     {
22 |         $hostname = $this->argument('hostname');
23 |         if (! $hostname) {
24 |             $hostname = $this->ask('Which hostname do you like to set?', config('app.url'));
25 |         }
26 | 
27 |         if (! Str::of($hostname)->startsWith('http')) {
28 |             $schema = match (app()->environment()) {
29 |                 'local' => 'http',
30 |                 default => 'https'
31 |             };
32 |             $hostname = "{$schema}://{$hostname}";
33 |         }
34 | 
35 |         $url = $hostname . route('telegram.webhook', [
36 |                 'token' => config('telegram.bot.api_token')
37 |             ], false);
38 | 
39 |         $options = [];
40 |         if ($this->option('drop-pending-updates')) {
41 |             $options['drop_pending_updates'] = true;
42 |         }
43 | 
44 |         if ($this->option('all-update-types')) {
45 |             $options['allowed_updates'] = Update::getUpdateTypes();
46 |         } elseif ($allowedUpdates = $this->option('allowed-updates')) {
47 |             $options['allowed_updates'] = Str::of($allowedUpdates)->explode(',');
48 |         }
49 | 
50 |         $response = $bot->setWebhook($url, $options);
51 | 
52 |         if (! $response->isOk()) {
53 |             $this->error($response->getDescription());
54 |         }
55 | 
56 |         $this->info("Telegram Webhook set to <comment>{$url}</comment>");
57 |     }
58 | }
59 | 


--------------------------------------------------------------------------------
/src/Console/Commands/stubs/example-start-command.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace DummyRootNamespace\Telegram\Commands;
 5 | 
 6 | 
 7 | use Longman\TelegramBot\Commands\UserCommand;
 8 | use Longman\TelegramBot\Entities\ServerResponse;
 9 | use Longman\TelegramBot\Exception\TelegramException;
10 | 
11 | class StartCommand extends UserCommand
12 | {
13 | 
14 |     /** @var string Command name */
15 |     protected $name = 'start';
16 |     /** @var string Command description */
17 |     protected $description = 'Start';
18 |     /** @var string Usage description */
19 |     protected $usage = '/start';
20 |     /** @var string Version */
21 |     protected $version = '1.0.0';
22 | 
23 |     public function execute(): ServerResponse
24 |     {
25 |         return $this->replyToChat('Hello world! 👋');
26 |     }
27 | 
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Console/Commands/stubs/telegram-command.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace DummyNamespace\Telegram\Commands;
 5 | 
 6 | 
 7 | use Longman\TelegramBot\Commands\DummyParent;
 8 | use Longman\TelegramBot\Entities\ServerResponse;
 9 | use Longman\TelegramBot\Exception\TelegramException;
10 | 
11 | class DummyClass extends DummyParent
12 | {
13 | 
14 |     /** @var string Command name */
15 |     protected $name = '{{name}}';
16 |     /** @var string Command description */
17 |     protected $description = '';
18 |     /** @var string Usage description */
19 |     protected $usage = '/{{name}}';
20 |     /** @var string Version */
21 |     protected $version = '1.0.0';
22 | 
23 |     public function execute(): ServerResponse
24 |     {
25 | 
26 |     }
27 | 
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Facades/CallbackButton.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace PhpTelegramBot\Laravel\Facades;
 5 | 
 6 | 
 7 | use Illuminate\Support\Facades\Facade;
 8 | 
 9 | class CallbackButton extends Facade
10 | {
11 |     protected static function getFacadeAccessor()
12 |     {
13 |         return \PhpTelegramBot\Laravel\Factories\CallbackButton::class;
14 |     }
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Facades/Telegram.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Facades;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | use PhpTelegramBot\Laravel\LaravelTelegramBot;
 7 | 
 8 | class Telegram extends Facade
 9 | {
10 |     protected static function getFacadeAccessor()
11 |     {
12 |         return LaravelTelegramBot::class;
13 |     }
14 | }


--------------------------------------------------------------------------------
/src/Factories/CallbackButton.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace PhpTelegramBot\Laravel\Factories;
 5 | 
 6 | 
 7 | use Illuminate\Support\Facades\Cache;
 8 | use Illuminate\Support\Str;
 9 | use Longman\TelegramBot\Entities\InlineKeyboardButton;
10 | 
11 | class CallbackButton
12 | {
13 | 
14 |     protected string $className;
15 |     protected array $data;
16 | 
17 |     public function __call(string $name, array $arguments): self
18 |     {
19 |         // ->withXxxxx($value)
20 |         if (Str::startsWith($name, 'with')) {
21 |             $key = (string) Str::of($name)->after('with')->snake();
22 |             $value = head($arguments);
23 | 
24 |             return $this->with($key, $value);
25 |         }
26 | 
27 |         throw new \BadMethodCallException("Call to undefined method CallbackButton::{$name}()");
28 |     }
29 | 
30 |     public function with(string $key, mixed $value): self
31 |     {
32 |         $this->data[$key] = $value;
33 |         return $this;
34 |     }
35 | 
36 |     public function new(): self
37 |     {
38 |         return clone $this;
39 |     }
40 | 
41 |     public function returnTo(string $className): self
42 |     {
43 |         $this->className = $className;
44 |         return $this;
45 |     }
46 | 
47 |     public function make(string $text, array $payload = []): InlineKeyboardButton
48 |     {
49 |         // Find valid hash
50 |         do {
51 |             $hash = Str::random(32);
52 |             $cacheKey = 'CallbackQuery:'.$hash;
53 |         } while (Cache::has($cacheKey));
54 | 
55 |         // Save payload
56 |         $payload = $payload + $this->data;
57 |         if (isset($this->className)) {
58 |             $payload['__class'] = $this->className;
59 |         }
60 |         Cache::put($cacheKey, $payload);
61 | 
62 |         // Assemble button
63 |         return new InlineKeyboardButton([
64 |             'text'          => $text,
65 |             'callback_data' => $hash
66 |         ]);
67 |     }
68 | 
69 | }
70 | 


--------------------------------------------------------------------------------
/src/Http/Middleware/TrustTelegramNetwork.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Http\Middleware;
 4 | 
 5 | use Closure;
 6 | use Illuminate\Support\Facades\App;
 7 | use Symfony\Component\HttpFoundation\IpUtils;
 8 | 
 9 | class TrustTelegramNetwork
10 | {
11 | 
12 |     /**
13 |      * Trusted Telegram IP addresses
14 |      * @see https://core.telegram.org/bots/webhooks#the-short-version
15 |      * @var array
16 |      */
17 |     protected array $trustedIpNets = [
18 |         '149.154.160.0/20',
19 |         '91.108.4.0/22'
20 |     ];
21 | 
22 |     /**
23 |      * Local networks for debugging
24 |      * @var array|string[]
25 |      */
26 |     protected array $localIpNets = [
27 |         '127.0.0.1/32',
28 |         '10.0.0.0/8',
29 |         '172.16.0.0/12',
30 |         '192.168.0.0/16'
31 |     ];
32 | 
33 |     /**
34 |      * Handle an incoming request.
35 |      *
36 |      * @param  \Illuminate\Http\Request  $request
37 |      * @param  \Closure  $next
38 |      * @return mixed
39 |      */
40 |     public function handle($request, Closure $next)
41 |     {
42 |         if (App::environment('local') && IpUtils::checkIp($request->ip(), $this->localIpNets)) {
43 |             return $next($request);
44 |         }
45 | 
46 |         if (IpUtils::checkIp($request->ip(), $this->trustedIpNets)) {
47 |             return $next($request);
48 |         }
49 | 
50 |         abort(403);
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/src/LaravelTelegramBot.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel;
 4 | 
 5 | use Longman\TelegramBot\Entities\ServerResponse;
 6 | use Longman\TelegramBot\Entities\Update;
 7 | use Longman\TelegramBot\Request;
 8 | 
 9 | class LaravelTelegramBot
10 | {
11 | 
12 |     protected array $callbacks = [];
13 | 
14 |     public function register(callable $callback)
15 |     {
16 |         $this->callbacks[] = $callback;
17 |     }
18 | 
19 |     public function call(Update $update): ?ServerResponse
20 |     {
21 |         foreach ($this->callbacks as $callback) {
22 |             $return = $callback($update);
23 | 
24 |             if ($return instanceof ServerResponse) {
25 |                 return $return;
26 |             } elseif ($return === true) {
27 |                 return Request::emptyResponse();
28 |             }
29 |         }
30 | 
31 |         return null;
32 |     }
33 | 
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Telegram/Commands/CallbackqueryCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace PhpTelegramBot\Laravel\Telegram\Commands;
 5 | 
 6 | 
 7 | use Illuminate\Support\Facades\App;
 8 | use Longman\TelegramBot\Commands\Command;
 9 | use Longman\TelegramBot\Commands\SystemCommand;
10 | use Longman\TelegramBot\Conversation;
11 | use Longman\TelegramBot\Entities\ServerResponse;
12 | use Longman\TelegramBot\Request;
13 | use PhpTelegramBot\Laravel\Facades\Telegram;
14 | use PhpTelegramBot\Laravel\Telegram\Conversation\ConversationWrapper;
15 | use PhpTelegramBot\Laravel\Telegram\InlineKeyboardButton\RemembersCallbackPayload;
16 | use PhpTelegramBot\Laravel\Telegram\UsesEffectiveEntities;
17 | 
18 | class CallbackqueryCommand extends SystemCommand
19 | {
20 |     use RemembersCallbackPayload, UsesEffectiveEntities;
21 | 
22 |     protected $name = 'callbackquery';
23 |     protected $description = 'Handles CallbackQueries';
24 |     protected $version = '1.0';
25 | 
26 |     public function execute(): ServerResponse
27 |     {
28 |         $return = Telegram::call($this->getUpdate());
29 |         if ($return instanceof ServerResponse) {
30 |             return $return;
31 |         }
32 | 
33 |         // Check if we have data for that hash in the Cache
34 |         if ($class = $this->payload()?->get('__class')) {
35 |             if (class_exists($class) && is_subclass_of($class, Command::class)) {
36 |                 /** @var Command $command */
37 |                 $command = new $class($this->telegram, $this->update);
38 |                 return $command->preExecute();
39 |             }
40 |         }
41 | 
42 |         // Check if conversation is active
43 |         $user = $this->getEffectiveUser($this->getUpdate());
44 |         $chat = $this->getEffectiveChat($this->getUpdate());
45 | 
46 |         $conversation = new Conversation(
47 |             user_id: $user->getId(),
48 |             chat_id: $chat->getId()
49 |         );
50 | 
51 |         if ($conversation->exists() && ($command = $conversation->getCommand())) {
52 |             return $this->getTelegram()->executeCommand($command);
53 |         }
54 | 
55 |         // Check if own CallbackqueryCommand class is available
56 |         $class = App::getNamespace() . 'Telegram\\Commands\\CallbackqueryCommand';
57 |         if (class_exists($class) && is_subclass_of($class, SystemCommand::class)) {
58 |             /** @var SystemCommand $command */
59 |             $command = new $class($this->telegram, $this->update);
60 |             return $command->preExecute();
61 |         }
62 | 
63 |         return Request::emptyResponse();
64 |     }
65 | }
66 | 


--------------------------------------------------------------------------------
/src/Telegram/Commands/GenericmessageCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Telegram\Commands;
 4 | 
 5 | use Illuminate\Support\Facades\App;
 6 | use Longman\TelegramBot\Commands\SystemCommand;
 7 | use Longman\TelegramBot\Conversation;
 8 | use Longman\TelegramBot\Entities\ServerResponse;
 9 | use Longman\TelegramBot\Request;
10 | use PhpTelegramBot\Laravel\Facades\Telegram;
11 | use PhpTelegramBot\Laravel\Telegram\Conversation\ConversationWrapper;
12 | use PhpTelegramBot\Laravel\Telegram\UsesEffectiveEntities;
13 | 
14 | class GenericmessageCommand extends SystemCommand
15 | {
16 |     use UsesEffectiveEntities;
17 | 
18 |     protected $name = 'genericmessage';
19 |     protected $description = 'Handles Genericmessages';
20 |     protected $version = '1.0';
21 | 
22 |     public function execute(): ServerResponse
23 |     {
24 |         $return = Telegram::call($this->getUpdate());
25 |         if ($return instanceof ServerResponse) {
26 |             return $return;
27 |         }
28 | 
29 |         $user = $this->getEffectiveUser($this->getUpdate());
30 |         $chat = $this->getEffectiveChat($this->getUpdate());
31 | 
32 |         // Check Conversation
33 |         $conversation = new Conversation(
34 |             user_id: $user->getId(),
35 |             chat_id: $chat->getId()
36 |         );
37 | 
38 |         if ($conversation->exists() && ($command = $conversation->getCommand())) {
39 |             return $this->getTelegram()->executeCommand($command);
40 |         }
41 | 
42 |         // Check if own GenericmessageCommand class is available
43 |         $class = App::getNamespace() . 'Telegram\\Commands\\GenericmessageCommand';
44 |         if (class_exists($class) && is_subclass_of($class, SystemCommand::class)) {
45 |             /** @var SystemCommand $command */
46 |             $command = new $class($this->telegram, $this->update);
47 |             return $command->preExecute();
48 |         }
49 | 
50 |         return Request::emptyResponse();
51 |     }
52 | 
53 | }


--------------------------------------------------------------------------------
/src/Telegram/Conversation/ConversationWrapper.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace PhpTelegramBot\Laravel\Telegram\Conversation;
  4 | 
  5 | use Longman\TelegramBot\Conversation;
  6 | use Longman\TelegramBot\Entities\Update;
  7 | 
  8 | class ConversationWrapper
  9 | {
 10 | 
 11 |     protected Conversation $conversation;
 12 |     protected array $temporary = [];
 13 | 
 14 |     public function __construct(Update $update, $command = '')
 15 |     {
 16 |         if ($message = $update->getMessage() ?? $update->getEditedMessage()) {
 17 |             $user = $message->getFrom();
 18 |             $chat = $message->getChat();
 19 |         } elseif ($callbackQuery = $update->getCallbackQuery()) {
 20 |             $user = $callbackQuery->getFrom();
 21 |             $chat = $callbackQuery->getMessage()?->getChat();
 22 |         }
 23 | 
 24 |         // TODO: Use getEffective*() Methods that should be created in \Bot Facade
 25 | 
 26 |         if (! isset($user) || ! isset($chat)) {
 27 |             throw new \InvalidArgumentException('Could not determine user or chat for ConversationWrapper');
 28 |         }
 29 | 
 30 |         $this->conversation = new Conversation(
 31 |             user_id: $user->getId(),
 32 |             chat_id: $chat->getId(),
 33 |             command: $command
 34 |         );
 35 | 
 36 |         $notes = &$this->conversation->notes;
 37 |         $notes['vars'] ??= [];
 38 |         $notes['persist'] ??= [];
 39 | 
 40 |         if ($this->conversation->exists()) {
 41 |             // Remove temporary variables
 42 |             foreach ($notes['vars'] as $key => $value) {
 43 |                 if (array_search($key, $notes['persist']) === false) {
 44 |                     // Is temporary
 45 |                     $this->temporary[$key] = $value;
 46 |                     unset($notes['vars'][$key]);
 47 |                 }
 48 |             }
 49 |             $this->conversation->update();
 50 |         }
 51 |     }
 52 | 
 53 |     public function all(): array
 54 |     {
 55 |         return $this->conversation->notes['vars'] + $this->temporary;
 56 |     }
 57 | 
 58 |     public function get(string $key, string $default = null): mixed
 59 |     {
 60 |         return data_get($this->conversation->notes['vars'], $key)
 61 |             ?? data_get($this->temporary, $key, $default);
 62 |     }
 63 | 
 64 |     public function has(string $key): bool
 65 |     {
 66 |         return $this->get($key) !== null;
 67 |     }
 68 | 
 69 |     public function getConversation(): Conversation
 70 |     {
 71 |         return $this->conversation;
 72 |     }
 73 | 
 74 |     public function persist(array $data): self
 75 |     {
 76 |         $notes = &$this->conversation->notes;
 77 |         foreach ($data as $key => $value) {
 78 |             $notes['vars'][$key] = $value;
 79 |             $notes['persist'][] = $key;
 80 |         }
 81 |         $this->conversation->update();
 82 | 
 83 |         return $this;
 84 |     }
 85 | 
 86 |     public function remember(array $data = [], bool $keepPreviousData = false): self
 87 |     {
 88 |         $notes = &$this->conversation->notes;
 89 | 
 90 |         if ($keepPreviousData) {
 91 |             foreach ($this->temporary as $key => $value) {
 92 |                 $notes['vars'][$key] = $value;
 93 |             }
 94 |         }
 95 | 
 96 |         foreach ($data as $key => $value) {
 97 |             $notes['vars'][$key] = $value;
 98 |             $index = array_search($key, $notes['persist']);
 99 |             if ($index !== false) {
100 |                 unset($notes['persist'][$index]);
101 |             }
102 |         }
103 | 
104 |         $notes['persist'] = array_values($notes['persist']);
105 |         $this->conversation->update();
106 |         return $this;
107 |     }
108 | 
109 |     public function exists(): bool
110 |     {
111 |         return $this->conversation->exists();
112 |     }
113 | 
114 |     public function end(): void
115 |     {
116 |         $this->conversation->stop();
117 |     }
118 | 
119 |     public function cancel(): void
120 |     {
121 |         $this->conversation->cancel();
122 |     }
123 | 
124 | }
125 | 


--------------------------------------------------------------------------------
/src/Telegram/Conversation/LeadsConversation.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace PhpTelegramBot\Laravel\Telegram\Conversation;
 5 | 
 6 | use Longman\TelegramBot\Entities\Update;
 7 | 
 8 | /**
 9 |  * Trait LeadsConversation
10 |  * @package PhpTelegramBot\Laravel
11 |  * @method Update getUpdate()
12 |  * @method string getName()
13 |  */
14 | trait LeadsConversation
15 | {
16 | 
17 |     /**
18 |      * @internal
19 |      */
20 |     protected ?ConversationWrapper $conversation;
21 | 
22 |     /**
23 |      * @param  string|null  $key
24 |      * @param  string|null  $default
25 |      * @return ?ConversationWrapper|mixed
26 |      */
27 |     protected function conversation(string $key = null, string $default = null)
28 |     {
29 |         if (! isset($this->conversation)) {
30 |             $this->conversation = new ConversationWrapper($this->getUpdate(), $this->getName());
31 |         }
32 | 
33 |         if (isset($key)) {
34 |             return $this->conversation->get($key, $default);
35 |         }
36 | 
37 |         return $this->conversation;
38 |     }
39 | 
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Telegram/InlineKeyboardButton/CallbackPayload.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace PhpTelegramBot\Laravel\Telegram\InlineKeyboardButton;
 5 | 
 6 | 
 7 | class CallbackPayload
 8 | {
 9 | 
10 |     public function __construct(protected array $payload)
11 |     {
12 |     }
13 | 
14 |     public function all(): array
15 |     {
16 |         return $this->payload;
17 |     }
18 | 
19 |     public function get(string $key, string $default = null): mixed
20 |     {
21 |         return data_get($this->payload, $key, $default);
22 |     }
23 | 
24 |     public function has(string $key): bool
25 |     {
26 |         return $this->get($key) !== null;
27 |     }
28 | 
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Telegram/InlineKeyboardButton/RemembersCallbackPayload.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Telegram\InlineKeyboardButton;
 4 | 
 5 | 
 6 | use Illuminate\Support\Facades\Cache;
 7 | use Longman\TelegramBot\Commands\Command;
 8 | use Longman\TelegramBot\Entities\Update;
 9 | 
10 | /**
11 |  * Trait CallbackQueryCache
12 |  * @package PhpTelegramBot\Laravel\Services
13 |  * @method Update getUpdate()
14 |  */
15 | trait RemembersCallbackPayload
16 | {
17 |     /**
18 |      * @var CallbackPayload
19 |      * @internal
20 |      */
21 |     protected ?CallbackPayload $payload;
22 | 
23 |     /**
24 |      * @param string|null $key
25 |      * @param string|null $default
26 |      * @return CallbackPayload|null|mixed
27 |      */
28 |     protected function payload(string $key = null, string $default = null)
29 |     {
30 |         if (! isset($this->payload)) {
31 |             $update = $this->getUpdate();
32 |             $data = $update?->getCallbackQuery()?->getData();
33 | 
34 |             if ($data === null) {
35 |                 return null;
36 |             }
37 | 
38 |             // TODO: Move CacheKey and initialization in CallbackPayload::__construct()
39 |             $cacheKey = 'CallbackQuery:'.$data;
40 | 
41 |             if (! Cache::has($cacheKey)) {
42 |                 return null;
43 |             }
44 | 
45 |             $payload = Cache::get($cacheKey);
46 |             $this->payload = new CallbackPayload($payload);
47 |         }
48 | 
49 |         if (isset($key)) {
50 |             return $this->payload->get($key, $default);
51 |         }
52 | 
53 |         return $this->payload;
54 |     }
55 | 
56 | }
57 | 


--------------------------------------------------------------------------------
/src/Telegram/UsesEffectiveEntities.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace PhpTelegramBot\Laravel\Telegram;
 4 | 
 5 | use Longman\TelegramBot\Entities\Chat;
 6 | use Longman\TelegramBot\Entities\Message;
 7 | use Longman\TelegramBot\Entities\Update;
 8 | use Longman\TelegramBot\Entities\User;
 9 | 
10 | trait UsesEffectiveEntities
11 | {
12 | 
13 |     protected function getEffectiveUser(Update $update): ?User
14 |     {
15 |         $type = $update->getUpdateType();
16 | 
17 |         $user = $update->$type['from']
18 |             ?? $update->poll_answer['user']
19 |             ?? null;
20 | 
21 |         return $user ? new User($user) : null;
22 |     }
23 | 
24 |     protected function getEffectiveChat(Update $update): ?Chat
25 |     {
26 |         $type = $update->getUpdateType();
27 | 
28 |         $chat = $update->$type['chat']
29 |             ?? $update->callback_query['message']['chat']
30 |             ?? null;
31 | 
32 |         return $chat ? new Chat($chat) : null;
33 |     }
34 | 
35 |     protected function getEffectiveMessage(Update $update): ?Message
36 |     {
37 |         $message = $update->edited_channel_post
38 |             ?? $update->channel_post
39 |             ?? $update->callback_query['message']
40 |             ?? $update->edited_message
41 |             ?? $update->message
42 |             ?? null;
43 | 
44 |         return $message ? new Message($message) : null;
45 |     }
46 | 
47 | }


--------------------------------------------------------------------------------
/src/TelegramServiceProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace PhpTelegramBot\Laravel;
  4 | 
  5 | use Illuminate\Routing\Router;
  6 | use Illuminate\Support\Facades\File;
  7 | use Illuminate\Support\ServiceProvider;
  8 | use Longman\TelegramBot\Commands\Command;
  9 | use Longman\TelegramBot\Request;
 10 | use Longman\TelegramBot\Telegram;
 11 | use Symfony\Component\Finder\Finder;
 12 | use PhpTelegramBot\Laravel\Console\Commands\TelegramCloseCommand;
 13 | use PhpTelegramBot\Laravel\Console\Commands\TelegramDeleteWebhookCommand;
 14 | use PhpTelegramBot\Laravel\Console\Commands\TelegramFetchCommand;
 15 | use PhpTelegramBot\Laravel\Console\Commands\TelegramLogoutCommand;
 16 | use PhpTelegramBot\Laravel\Console\Commands\TelegramPublishCommand;
 17 | use PhpTelegramBot\Laravel\Console\Commands\TelegramSetWebhookCommand;
 18 | use PhpTelegramBot\Laravel\Console\Commands\MakeTelegramCommand;
 19 | use PhpTelegramBot\Laravel\Factories\CallbackButton;
 20 | use PhpTelegramBot\Laravel\Http\Middleware\TrustTelegramNetwork;
 21 | use PhpTelegramBot\Laravel\Telegram\Commands\CallbackqueryCommand;
 22 | use PhpTelegramBot\Laravel\Telegram\Commands\GenericmessageCommand;
 23 | 
 24 | class TelegramServiceProvider extends ServiceProvider
 25 | {
 26 |     /**
 27 |      * Perform post-registration booting of services.
 28 |      *
 29 |      * @return void
 30 |      */
 31 |     public function boot(): void
 32 |     {
 33 |         $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
 34 | 
 35 |         if (file_exists(base_path('routes/telegram.php'))) {
 36 |             $this->loadRoutesFrom(base_path('routes/telegram.php'));
 37 |         } else {
 38 |             $this->loadRoutesFrom(__DIR__ . '/../routes/telegram.php');
 39 |         }
 40 | 
 41 |         $router = $this->app->make(Router::class);
 42 |         $router->aliasMiddleware('telegram.network', TrustTelegramNetwork::class);
 43 | 
 44 |         // Publishing is only necessary when using the CLI.
 45 |         if ($this->app->runningInConsole()) {
 46 |             $this->bootForConsole();
 47 |         }
 48 |     }
 49 | 
 50 |     /**
 51 |      * Register any package services.
 52 |      *
 53 |      * @return void
 54 |      */
 55 |     public function register(): void
 56 |     {
 57 |         $this->mergeConfigFrom(__DIR__ . '/../config/telegram.php', 'telegram');
 58 | 
 59 |         $this->configureTelegramBot();
 60 |     }
 61 | 
 62 |     protected function configureTelegramBot()
 63 |     {
 64 |         $token = config('telegram.bot.api_token');
 65 | 
 66 |         if (! $token) {
 67 |             return;
 68 |         }
 69 | 
 70 |         $username = config('telegram.bot.username');
 71 | 
 72 |         $apiUrl = config('telegram.bot.api_url', '');
 73 |         if (! empty($apiUrl)) {
 74 |             Request::setCustomBotApiUri($apiUrl);
 75 |         }
 76 | 
 77 |         $bot = new Telegram($token, $username);
 78 | 
 79 |         // Commands Discovery
 80 |         $this->discoverTelegramCommands($bot);
 81 |         $bot->addCommandClass(CallbackqueryCommand::class);
 82 |         $bot->addCommandClass(GenericmessageCommand::class);
 83 | 
 84 |         // Set MySQL Connection
 85 |         $connection = app('db')->connection('mysql');
 86 |         $bot->enableExternalMySql($connection->getPdo(), 'bot_');
 87 | 
 88 |         // Register admins
 89 |         $this->registerTelegramAdmins($bot);
 90 | 
 91 |         $this->app->instance(Telegram::class, $bot);
 92 |     }
 93 | 
 94 |     /**
 95 |      * Console-specific booting.
 96 |      *
 97 |      * @return void
 98 |      */
 99 |     protected function bootForConsole(): void
100 |     {
101 |         // Publishing the configuration file.
102 |         $this->publishes([
103 |             __DIR__ . '/../config/telegram.php' => config_path('telegram.php'),
104 |         ], 'telegram-config');
105 | 
106 |         $this->publishes([
107 |             __DIR__ . '/../routes/telegram.php' => base_path('routes/telegram.php')
108 |         ], 'telegram-routes');
109 | 
110 |         // Registering package commands.
111 |         $this->commands([
112 |             MakeTelegramCommand::class,
113 |             TelegramCloseCommand::class,
114 |             TelegramDeleteWebhookCommand::class,
115 |             TelegramFetchCommand::class,
116 |             TelegramLogoutCommand::class,
117 |             TelegramPublishCommand::class,
118 |             TelegramSetWebhookCommand::class,
119 |         ]);
120 |     }
121 | 
122 |     /**
123 |      * @param  Telegram  $bot
124 |      * @throws \ReflectionException
125 |      */
126 |     protected function discoverTelegramCommands(Telegram $bot): void
127 |     {
128 |         $namespace = $this->app->getNamespace();
129 |         $commandsPath = app_path('Telegram/Commands');
130 |         File::ensureDirectoryExists($commandsPath);
131 | 
132 |         foreach ((new Finder)->in($commandsPath)->files() as $command) {
133 |             $command = $namespace . str_replace(
134 |                     ['/', '.php'],
135 |                     ['\\', ''],
136 |                     \Str::after($command->getRealPath(), realpath(app_path()) . DIRECTORY_SEPARATOR)
137 |                 );
138 | 
139 |             if (is_subclass_of($command, Command::class) &&
140 |                 ! (new \ReflectionClass($command))->isAbstract()) {
141 |                 $bot->addCommandClass($command);
142 |             }
143 |         }
144 |     }
145 | 
146 |     /**
147 |      * @param  Telegram  $bot
148 |      */
149 |     protected function registerTelegramAdmins(Telegram $bot): void
150 |     {
151 |         $admins = config('telegram.admins', '');
152 |         if (! empty($admins)) {
153 |             $admins = explode(',', $admins);
154 |             $bot->enableAdmins($admins);
155 |         }
156 |     }
157 | }
158 | 


--------------------------------------------------------------------------------