Merge pull request #1199 from php-telegram-bot/bot_api_5.1

Bot API 5.1

Author: noplanman

CHANGELOG.md

@@ -7,6 +7,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 ### Notes
 - [:ledger: View file changes][Unreleased] ∙ [:page_with_curl: DB migration script][unreleased-sql-migration]
 ### Added
+- Bot API 5.1 (ChatMember Update types, Improved Invite Links, Voice Chat). (@massadm, @noplanman)
 ### Changed
 ### Deprecated
 ### Removed

README.md

@@ -7,7 +7,7 @@
 
 A Telegram Bot based on the official [Telegram Bot API]
 
-[![API Version](https://img.shields.io/badge/Bot%20API-5.0%20%28November%202020%29-32a2da.svg)](https://core.telegram.org/bots/api#november-4-2020)
+[![API Version](https://img.shields.io/badge/Bot%20API-5.1%20%28March%202021%29-32a2da.svg)](https://core.telegram.org/bots/api#november-4-2020)
 [![Join the bot support group on Telegram](https://img.shields.io/badge/telegram-@PHP__Telegram__Bot__Support-64659d.svg)](https://telegram.me/PHP_Telegram_Bot_Support)
 [![Donate](https://img.shields.io/badge/%F0%9F%92%99-Donate%20%2F%20Support%20Us-blue.svg)](#donate)
 
@@ -78,7 +78,7 @@ This Bot aims to provide a platform where one can simply write a bot and have in
 
 The Bot can:
 - Retrieve updates with [webhook](#webhook-installation) and [getUpdates](#getupdates-installation) methods.
-- Supports all types and methods according to Telegram Bot API 5.0 (November 2020).
+- Supports all types and methods according to Telegram Bot API 5.1 (March 2021).
 - Supports supergroups.
 - Handle commands in chat with other bots.
 - Manage Channel from the bot admin interface.
@@ -343,15 +343,15 @@ $telegram->useGetUpdatesWithoutDatabase();
 
 ### Types
 
-All types are implemented according to Telegram API 5.0 (November 2020).
+All types are implemented according to Telegram API 5.1 (March 2021).
 
 ### Inline Query
 
-Full support for inline query according to Telegram API 5.0 (November 2020).
+Full support for inline query according to Telegram API 5.1 (March 2021).
 
 ### Methods
 
-All methods are implemented according to Telegram API 5.0 (November 2020).
+All methods are implemented according to Telegram API 5.1 (March 2021).
 
 #### Send Message
 

src/DB.php

@@ -14,6 +14,7 @@
 
 use Longman\TelegramBot\Entities\CallbackQuery;
 use Longman\TelegramBot\Entities\Chat;
+use Longman\TelegramBot\Entities\ChatMemberUpdated;
 use Longman\TelegramBot\Entities\ChosenInlineResult;
 use Longman\TelegramBot\Entities\InlineQuery;
 use Longman\TelegramBot\Entities\Message;
@@ -140,13 +141,14 @@ protected static function defineTables(): void
         $tables = [
             'callback_query',
             'chat',
+            'chat_member_updated',
             'chosen_inline_result',
             'edited_message',
             'inline_query',
             'message',
-            'pre_checkout_query',
             'poll',
             'poll_answer',
+            'pre_checkout_query',
             'request_limiter',
             'shipping_query',
             'telegram_update',
@@ -320,6 +322,8 @@ public static function entitiesArrayToJson(array $entities, $default = null)
      * @param string|null $pre_checkout_query_id
      * @param string|null $poll_id
      * @param string|null $poll_answer_poll_id
+     * @param string|null $my_chat_member_updated_id
+     * @param string|null $chat_member_updated_id
      *
      * @return bool If the insert was successful
      * @throws TelegramException
@@ -337,10 +341,12 @@ protected static function insertTelegramUpdate(
         ?string $shipping_query_id = null,
         ?string $pre_checkout_query_id = null,
         ?string $poll_id = null,
-        ?string $poll_answer_poll_id = null
+        ?string $poll_answer_poll_id = null,
+        ?string $my_chat_member_updated_id = null,
+        ?string $chat_member_updated_id = null
     ): ?bool {
-        if ($message_id === null && $edited_message_id === null && $channel_post_id === null && $edited_channel_post_id === null && $inline_query_id === null && $chosen_inline_result_id === null && $callback_query_id === null && $shipping_query_id === null && $pre_checkout_query_id === null && $poll_id === null && $poll_answer_poll_id === null) {
-            throw new TelegramException('message_id, edited_message_id, channel_post_id, edited_channel_post_id, inline_query_id, chosen_inline_result_id, callback_query_id, shipping_query_id, pre_checkout_query_id, poll_id, poll_answer_poll_id are all null');
+        if ($message_id === null && $edited_message_id === null && $channel_post_id === null && $edited_channel_post_id === null && $inline_query_id === null && $chosen_inline_result_id === null && $callback_query_id === null && $shipping_query_id === null && $pre_checkout_query_id === null && $poll_id === null && $poll_answer_poll_id === null && $my_chat_member_updated_id === null && $chat_member_updated_id === null) {
+            throw new TelegramException('message_id, edited_message_id, channel_post_id, edited_channel_post_id, inline_query_id, chosen_inline_result_id, callback_query_id, shipping_query_id, pre_checkout_query_id, poll_id, poll_answer_poll_id, my_chat_member_updated_id, chat_member_updated_id are all null');
         }
 
         if (!self::isDbConnected()) {
@@ -350,9 +356,9 @@ protected static function insertTelegramUpdate(
         try {
             $sth = self::$pdo->prepare('
                 INSERT IGNORE INTO `' . TB_TELEGRAM_UPDATE . '`
-                (`id`, `chat_id`, `message_id`, `edited_message_id`, `channel_post_id`, `edited_channel_post_id`, `inline_query_id`, `chosen_inline_result_id`, `callback_query_id`, `shipping_query_id`, `pre_checkout_query_id`, `poll_id`, `poll_answer_poll_id`)
+                (`id`, `chat_id`, `message_id`, `edited_message_id`, `channel_post_id`, `edited_channel_post_id`, `inline_query_id`, `chosen_inline_result_id`, `callback_query_id`, `shipping_query_id`, `pre_checkout_query_id`, `poll_id`, `poll_answer_poll_id`, `my_chat_member_updated_id`, `chat_member_updated_id`)
                 VALUES
-                (:id, :chat_id, :message_id, :edited_message_id, :channel_post_id, :edited_channel_post_id, :inline_query_id, :chosen_inline_result_id, :callback_query_id, :shipping_query_id, :pre_checkout_query_id, :poll_id, :poll_answer_poll_id)
+                (:id, :chat_id, :message_id, :edited_message_id, :channel_post_id, :edited_channel_post_id, :inline_query_id, :chosen_inline_result_id, :callback_query_id, :shipping_query_id, :pre_checkout_query_id, :poll_id, :poll_answer_poll_id, :my_chat_member_updated_id, :chat_member_updated_id)
             ');
 
             $sth->bindValue(':id', $update_id);
@@ -368,6 +374,8 @@ protected static function insertTelegramUpdate(
             $sth->bindValue(':pre_checkout_query_id', $pre_checkout_query_id);
             $sth->bindValue(':poll_id', $poll_id);
             $sth->bindValue(':poll_answer_poll_id', $poll_answer_poll_id);
+            $sth->bindValue(':my_chat_member_updated_id', $my_chat_member_updated_id);
+            $sth->bindValue(':chat_member_updated_id', $chat_member_updated_id);
 
             return $sth->execute();
         } catch (PDOException $e) {
@@ -520,18 +528,20 @@ public static function insertRequest(Update $update): bool
             return false;
         }
 
-        $chat_id                 = null;
-        $message_id              = null;
-        $edited_message_id       = null;
-        $channel_post_id         = null;
-        $edited_channel_post_id  = null;
-        $inline_query_id         = null;
-        $chosen_inline_result_id = null;
-        $callback_query_id       = null;
-        $shipping_query_id       = null;
-        $pre_checkout_query_id   = null;
-        $poll_id                 = null;
-        $poll_answer_poll_id     = null;
+        $chat_id                   = null;
+        $message_id                = null;
+        $edited_message_id         = null;
+        $channel_post_id           = null;
+        $edited_channel_post_id    = null;
+        $inline_query_id           = null;
+        $chosen_inline_result_id   = null;
+        $callback_query_id         = null;
+        $shipping_query_id         = null;
+        $pre_checkout_query_id     = null;
+        $poll_id                   = null;
+        $poll_answer_poll_id       = null;
+        $my_chat_member_updated_id = null;
+        $chat_member_updated_id    = null;
 
         if (($message = $update->getMessage()) && self::insertMessageRequest($message)) {
             $chat_id    = $message->getChat()->getId();
@@ -559,6 +569,10 @@ public static function insertRequest(Update $update): bool
             $poll_id = $poll->getId();
         } elseif (($poll_answer = $update->getPollAnswer()) && self::insertPollAnswerRequest($poll_answer)) {
             $poll_answer_poll_id = $poll_answer->getPollId();
+        } elseif (($my_chat_member = $update->getMyChatMember()) && self::insertChatMemberUpdatedRequest($my_chat_member)) {
+            $my_chat_member_updated_id = self::$pdo->lastInsertId();
+        } elseif (($chat_member = $update->getChatMember()) && self::insertChatMemberUpdatedRequest($chat_member)) {
+            $chat_member_updated_id = self::$pdo->lastInsertId();
         } else {
             return false;
         }
@@ -576,7 +590,9 @@ public static function insertRequest(Update $update): bool
             $shipping_query_id,
             $pre_checkout_query_id,
             $poll_id,
-            $poll_answer_poll_id
+            $poll_answer_poll_id,
+            $my_chat_member_updated_id,
+            $chat_member_updated_id
         );
     }
 
@@ -918,6 +934,55 @@ public static function insertPollAnswerRequest(PollAnswer $poll_answer): bool
         }
     }
 
+    /**
+     * Insert chat member updated request into database
+     *
+     * @param ChatMemberUpdated $chat_member_updated
+     *
+     * @return bool If the insert was successful
+     * @throws TelegramException
+     */
+    public static function insertChatMemberUpdatedRequest(ChatMemberUpdated $chat_member_updated): bool
+    {
+        if (!self::isDbConnected()) {
+            return false;
+        }
+
+        try {
+            $sth = self::$pdo->prepare('
+                INSERT INTO `' . TB_CHAT_MEMBER_UPDATED . '`
+                (`chat_id`, `user_id`, `date`, `old_chat_member`, `new_chat_member`, `invite_link`, `created_at`)
+                VALUES
+                (:chat_id, :user_id, :date, :old_chat_member, :new_chat_member, :invite_link, :created_at)
+            ');
+
+            $date    = self::getTimestamp();
+            $chat_id = null;
+            $user_id = null;
+
+            if ($chat = $chat_member_updated->getChat()) {
+                $chat_id = $chat->getId();
+                self::insertChat($chat, $date);
+            }
+            if ($user = $chat_member_updated->getFrom()) {
+                $user_id = $user->getId();
+                self::insertUser($user, $date);
+            }
+
+            $sth->bindValue(':chat_id', $chat_id);
+            $sth->bindValue(':user_id', $user_id);
+            $sth->bindValue(':date', self::getTimestamp($chat_member_updated->getDate()));
+            $sth->bindValue(':old_chat_member', $chat_member_updated->getOldChatMember());
+            $sth->bindValue(':new_chat_member', $chat_member_updated->getNewChatMember());
+            $sth->bindValue(':invite_link', $chat_member_updated->getInviteLink());
+            $sth->bindValue(':created_at', $date);
+
+            return $sth->execute();
+        } catch (PDOException $e) {
+            throw new TelegramException($e->getMessage());
+        }
+    }
+
     /**
      * Insert Message request in db
      *
@@ -998,17 +1063,19 @@ public static function insertMessageRequest(Message $message): bool
                     `audio`, `document`, `animation`, `game`, `photo`, `sticker`, `video`, `voice`, `video_note`, `caption`, `contact`,
                     `location`, `venue`, `poll`, `dice`, `new_chat_members`, `left_chat_member`,
                     `new_chat_title`, `new_chat_photo`, `delete_chat_photo`, `group_chat_created`,
-                    `supergroup_chat_created`, `channel_chat_created`, `migrate_to_chat_id`, `migrate_from_chat_id`,
-                    `pinned_message`, `invoice`, `successful_payment`, `connected_website`, `passport_data`, `proximity_alert_triggered`, `reply_markup`
+                    `supergroup_chat_created`, `channel_chat_created`, `message_auto_delete_timer_changed`, `migrate_to_chat_id`, `migrate_from_chat_id`,
+                    `pinned_message`, `invoice`, `successful_payment`, `connected_website`, `passport_data`, `proximity_alert_triggered`,
+                    `voice_chat_started`, `voice_chat_ended`, `voice_chat_participants_invited`, `reply_markup`
                 ) VALUES (
                     :message_id, :user_id, :chat_id, :sender_chat_id, :date, :forward_from, :forward_from_chat, :forward_from_message_id,
                     :forward_signature, :forward_sender_name, :forward_date,
                     :reply_to_chat, :reply_to_message, :via_bot, :edit_date, :media_group_id, :author_signature, :text, :entities, :caption_entities,
                     :audio, :document, :animation, :game, :photo, :sticker, :video, :voice, :video_note, :caption, :contact,
                     :location, :venue, :poll, :dice, :new_chat_members, :left_chat_member,
                     :new_chat_title, :new_chat_photo, :delete_chat_photo, :group_chat_created,
-                    :supergroup_chat_created, :channel_chat_created, :migrate_to_chat_id, :migrate_from_chat_id,
-                    :pinned_message, :invoice, :successful_payment, :connected_website, :passport_data, :proximity_alert_triggered, :reply_markup
+                    :supergroup_chat_created, :channel_chat_created, :message_auto_delete_timer_changed, :migrate_to_chat_id, :migrate_from_chat_id,
+                    :pinned_message, :invoice, :successful_payment, :connected_website, :passport_data, :proximity_alert_triggered,
+                    :voice_chat_started, :voice_chat_ended, :voice_chat_participants_invited, :reply_markup
                 )
             ');
 
@@ -1043,7 +1110,7 @@ public static function insertMessageRequest(Message $message): bool
             $sth->bindValue(':reply_to_message', $reply_to_message_id);
 
             $sth->bindValue(':via_bot', $via_bot_id);
-            $sth->bindValue(':edit_date', $message->getEditDate());
+            $sth->bindValue(':edit_date', self::getTimestamp($message->getEditDate()));
             $sth->bindValue(':media_group_id', $message->getMediaGroupId());
             $sth->bindValue(':author_signature', $message->getAuthorSignature());
             $sth->bindValue(':text', $message->getText());
@@ -1072,6 +1139,7 @@ public static function insertMessageRequest(Message $message): bool
             $sth->bindValue(':group_chat_created', $message->getGroupChatCreated());
             $sth->bindValue(':supergroup_chat_created', $message->getSupergroupChatCreated());
             $sth->bindValue(':channel_chat_created', $message->getChannelChatCreated());
+            $sth->bindValue(':message_auto_delete_timer_changed', $message->getMessageAutoDeleteTimerChanged());
             $sth->bindValue(':migrate_to_chat_id', $message->getMigrateToChatId());
             $sth->bindValue(':migrate_from_chat_id', $message->getMigrateFromChatId());
             $sth->bindValue(':pinned_message', $message->getPinnedMessage());
@@ -1080,6 +1148,9 @@ public static function insertMessageRequest(Message $message): bool
             $sth->bindValue(':connected_website', $message->getConnectedWebsite());
             $sth->bindValue(':passport_data', $message->getPassportData());
             $sth->bindValue(':proximity_alert_triggered', $message->getProximityAlertTriggered());
+            $sth->bindValue(':voice_chat_started', $message->getVoiceChatStarted());
+            $sth->bindValue(':voice_chat_ended', $message->getVoiceChatEnded());
+            $sth->bindValue(':voice_chat_participants_invited', $message->getVoiceChatParticipantsInvited());
             $sth->bindValue(':reply_markup', $message->getReplyMarkup());
 
             return $sth->execute();

src/Entities/ChatInviteLink.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Longman\TelegramBot\Entities;
+
+/**
+ * Class ChatInviteLink
+ *
+ * Represents an invite link for a chat
+ *
+ * @link https://core.telegram.org/bots/api#chatinvitelink
+ *
+ * @method string  GetInviteLink()       The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”
+ * @method User    getCreator()          Creator of the link
+ * @method bool    getIsPrimary()        True, if the link is primary
+ * @method bool    getIsRevoked()        True, if the link is revoked
+ * @method int     getExpireDate()       Optional. Point in time (Unix timestamp) when the link will expire or has been expired
+ * @method int     getMemberLimit()      Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
+ */
+class ChatInviteLink extends Entity
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function subEntities(): array
+    {
+        return [
+            'creator' => User::class,
+        ];
+    }
+}