Passed
Push — develop ( 627c19...3a008b )
by Armando
02:33 queued 14s
created

Request::send()   B

Complexity

Conditions 10
Paths 5

Size

Total Lines 44
Code Lines 21

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 110

Importance

Changes 5
Bugs 0 Features 0
Metric Value
cc 10
eloc 21
c 5
b 0
f 0
nc 5
nop 2
dl 0
loc 44
ccs 0
cts 22
cp 0
crap 110
rs 7.6666

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
/**
4
 * This file is part of the TelegramBot package.
5
 *
6
 * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Longman\TelegramBot;
13
14
use GuzzleHttp\Client;
15
use GuzzleHttp\ClientInterface;
16
use GuzzleHttp\Exception\RequestException;
17
use GuzzleHttp\Psr7\Stream;
18
use Longman\TelegramBot\Entities\File;
19
use Longman\TelegramBot\Entities\InputMedia\InputMedia;
20
use Longman\TelegramBot\Entities\Message;
21
use Longman\TelegramBot\Entities\ServerResponse;
22
use Longman\TelegramBot\Exception\InvalidBotTokenException;
23
use Longman\TelegramBot\Exception\TelegramException;
24
use Throwable;
25
26
/**
27
 * Class Request
28
 *
29
 * @method static ServerResponse getUpdates(array $data)                      Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
30
 * @method static ServerResponse setWebhook(array $data)                      Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns true.
31
 * @method static ServerResponse deleteWebhook(array $data)                   Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
32
 * @method static ServerResponse getWebhookInfo()                             Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
33
 * @method static ServerResponse getMe()                                      A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.
34
 * @method static ServerResponse logOut()                                     Use this method to log out from the cloud Bot API server before launching the bot locally. Requires no parameters. Returns True on success.
35
 * @method static ServerResponse close()                                      Use this method to close the bot instance before moving it from one local server to another. Requires no parameters. Returns True on success.
36
 * @method static ServerResponse forwardMessage(array $data)                  Use this method to forward messages of any kind. On success, the sent Message is returned.
37
 * @method static ServerResponse copyMessage(array $data)                     Use this method to copy messages of any kind. The method is analogous to the method forwardMessages, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
38
 * @method static ServerResponse sendPhoto(array $data)                       Use this method to send photos. On success, the sent Message is returned.
39
 * @method static ServerResponse sendAudio(array $data)                       Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .mp3 format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
40
 * @method static ServerResponse sendDocument(array $data)                    Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
41
 * @method static ServerResponse sendSticker(array $data)                     Use this method to send .webp stickers. On success, the sent Message is returned.
42
 * @method static ServerResponse sendVideo(array $data)                       Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
43
 * @method static ServerResponse sendAnimation(array $data)                   Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
44
 * @method static ServerResponse sendVoice(array $data)                       Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
45
 * @method static ServerResponse sendVideoNote(array $data)                   Use this method to send video messages. On success, the sent Message is returned.
46
 * @method static ServerResponse sendMediaGroup(array $data)                  Use this method to send a group of photos or videos as an album. On success, an array of the sent Messages is returned.
47
 * @method static ServerResponse sendLocation(array $data)                    Use this method to send point on the map. On success, the sent Message is returned.
48
 * @method static ServerResponse editMessageLiveLocation(array $data)         Use this method to edit live location messages sent by the bot or via the bot (for inline bots). A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned.
49
 * @method static ServerResponse stopMessageLiveLocation(array $data)         Use this method to stop updating a live location message sent by the bot or via the bot (for inline bots) before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.
50
 * @method static ServerResponse sendVenue(array $data)                       Use this method to send information about a venue. On success, the sent Message is returned.
51
 * @method static ServerResponse sendContact(array $data)                     Use this method to send phone contacts. On success, the sent Message is returned.
52
 * @method static ServerResponse sendPoll(array $data)                        Use this method to send a native poll. A native poll can't be sent to a private chat. On success, the sent Message is returned.
53
 * @method static ServerResponse sendDice(array $data)                        Use this method to send a dice, which will have a random value from 1 to 6. On success, the sent Message is returned.
54
 * @method static ServerResponse sendChatAction(array $data)                  Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
55
 * @method static ServerResponse getUserProfilePhotos(array $data)            Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
56
 * @method static ServerResponse getFile(array $data)                         Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.
57
 * @method static ServerResponse banChatMember(array $data)                   Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
58
 * @method static ServerResponse unbanChatMember(array $data)                 Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. Returns True on success.
59
 * @method static ServerResponse restrictChatMember(array $data)              Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
60
 * @method static ServerResponse promoteChatMember(array $data)               Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.
61
 * @method static ServerResponse setChatAdministratorCustomTitle(array $data) Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
62
 * @method static ServerResponse banChatSenderChat(array $data)               Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
63
 * @method static ServerResponse unbanChatSenderChat(array $data)             Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
64
 * @method static ServerResponse setChatPermissions(array $data)              Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success.
65
 * @method static ServerResponse exportChatInviteLink(array $data)            Use this method to generate a new invite link for a chat. Any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.
66
 * @method static ServerResponse createChatInviteLink(array $data)            Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
67
 * @method static ServerResponse editChatInviteLink(array $data)              Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the edited invite link as a ChatInviteLink object.
68
 * @method static ServerResponse revokeChatInviteLink(array $data)            Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the revoked invite link as ChatInviteLink object.
69
 * @method static ServerResponse approveChatJoinRequest(array $data)          Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
70
 * @method static ServerResponse declineChatJoinRequest(array $data)          Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
71
 * @method static ServerResponse setChatPhoto(array $data)                    Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
72
 * @method static ServerResponse deleteChatPhoto(array $data)                 Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
73
 * @method static ServerResponse setChatTitle(array $data)                    Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
74
 * @method static ServerResponse setChatDescription(array $data)              Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
75
 * @method static ServerResponse pinChatMessage(array $data)                  Use this method to pin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.
76
 * @method static ServerResponse unpinChatMessage(array $data)                Use this method to unpin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.
77
 * @method static ServerResponse unpinAllChatMessages(array $data)            Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
78
 * @method static ServerResponse leaveChat(array $data)                       Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
79
 * @method static ServerResponse getChat(array $data)                         Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
80
 * @method static ServerResponse getChatAdministrators(array $data)           Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
81
 * @method static ServerResponse getChatMemberCount(array $data)              Use this method to get the number of members in a chat. Returns Int on success.
82
 * @method static ServerResponse getChatMember(array $data)                   Use this method to get information about a member of a chat. Returns a ChatMember object on success.
83
 * @method static ServerResponse setChatStickerSet(array $data)               Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
84
 * @method static ServerResponse deleteChatStickerSet(array $data)            Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
85
 * @method static ServerResponse answerCallbackQuery(array $data)             Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
86
 * @method static ServerResponse answerInlineQuery(array $data)               Use this method to send answers to an inline query. On success, True is returned.
87
 * @method static ServerResponse setMyCommands(array $data)                   Use this method to change the list of the bot's commands. Returns True on success.
88
 * @method static ServerResponse deleteMyCommands(array $data)                Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
89
 * @method static ServerResponse getMyCommands(array $data)                   Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of BotCommand on success.
90
 * @method static ServerResponse setChatMenuButton(array $data)               Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
91
 * @method static ServerResponse getChatMenuButton(array $data)               Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
92
 * @method static ServerResponse setMyDefaultAdministratorRights(array $data) Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.
93
 * @method static ServerResponse getMyDefaultAdministratorRights(array $data) Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
94
 * @method static ServerResponse editMessageText(array $data)                 Use this method to edit text and game messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
95
 * @method static ServerResponse editMessageCaption(array $data)              Use this method to edit captions of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
96
 * @method static ServerResponse editMessageMedia(array $data)                Use this method to edit audio, document, photo, or video messages. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned.
97
 * @method static ServerResponse editMessageReplyMarkup(array $data)          Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
98
 * @method static ServerResponse stopPoll(array $data)                        Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned.
99
 * @method static ServerResponse deleteMessage(array $data)                   Use this method to delete a message, including service messages, with certain limitations. Returns True on success.
100
 * @method static ServerResponse getStickerSet(array $data)                   Use this method to get a sticker set. On success, a StickerSet object is returned.
101
 * @method static ServerResponse uploadStickerFile(array $data)               Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
102
 * @method static ServerResponse createNewStickerSet(array $data)             Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. Returns True on success.
103
 * @method static ServerResponse addStickerToSet(array $data)                 Use this method to add a new sticker to a set created by the bot. Returns True on success.
104
 * @method static ServerResponse setStickerPositionInSet(array $data)         Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
105
 * @method static ServerResponse deleteStickerFromSet(array $data)            Use this method to delete a sticker from a set created by the bot. Returns True on success.
106
 * @method static ServerResponse setStickerSetThumb(array $data)              Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.
107
 * @method static ServerResponse answerWebAppQuery(array $data)               Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
108
 * @method static ServerResponse sendInvoice(array $data)                     Use this method to send invoices. On success, the sent Message is returned.
109
 * @method static ServerResponse answerShippingQuery(array $data)             If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
110
 * @method static ServerResponse answerPreCheckoutQuery(array $data)          Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned.
111
 * @method static ServerResponse setPassportDataErrors(array $data)           Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
112
 * @method static ServerResponse sendGame(array $data)                        Use this method to send a game. On success, the sent Message is returned.
113
 * @method static ServerResponse setGameScore(array $data)                    Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
114
 * @method static ServerResponse getGameHighScores(array $data)               Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects.
115
 */
116
class Request
117
{
118
    /**
119
     * Telegram object
120
     *
121
     * @var Telegram
122
     */
123
    private static $telegram;
124
125
    /**
126
     * URI of the Telegram API
127
     *
128
     * @var string
129
     */
130
    private static $api_base_uri = 'https://api.telegram.org';
131
132
    /**
133
     * URI of the Telegram API for downloading files (relative to $api_base_url or absolute)
134
     *
135
     * @var string
136
     */
137
    private static $api_base_download_uri = '/file/bot{API_KEY}';
138
139
    /**
140
     * Guzzle Client object
141
     *
142
     * @var ClientInterface
143
     */
144
    private static $client;
145
146
    /**
147
     * Request limiter
148
     *
149
     * @var bool
150
     */
151
    private static $limiter_enabled;
152
153
    /**
154
     * Request limiter's interval between checks
155
     *
156
     * @var float
157
     */
158
    private static $limiter_interval;
159
160
    /**
161
     * The current action that is being executed
162
     *
163
     * @var string
164
     */
165
    private static $current_action = '';
166
167
    /**
168
     * Available actions to send
169
     *
170
     * This is basically the list of all methods listed on the official API documentation.
171
     *
172
     * @link https://core.telegram.org/bots/api
173
     *
174
     * @var array
175
     */
176
    private static $actions = [
177
        'getUpdates',
178
        'setWebhook',
179
        'deleteWebhook',
180
        'getWebhookInfo',
181
        'getMe',
182
        'logOut',
183
        'close',
184
        'sendMessage',
185
        'forwardMessage',
186
        'copyMessage',
187
        'sendPhoto',
188
        'sendAudio',
189
        'sendDocument',
190
        'sendSticker',
191
        'sendVideo',
192
        'sendAnimation',
193
        'sendVoice',
194
        'sendVideoNote',
195
        'sendMediaGroup',
196
        'sendLocation',
197
        'editMessageLiveLocation',
198
        'stopMessageLiveLocation',
199
        'sendVenue',
200
        'sendContact',
201
        'sendPoll',
202
        'sendDice',
203
        'sendChatAction',
204
        'getUserProfilePhotos',
205
        'getFile',
206
        'banChatMember',
207
        'unbanChatMember',
208
        'restrictChatMember',
209
        'promoteChatMember',
210
        'setChatAdministratorCustomTitle',
211
        'banChatSenderChat',
212
        'unbanChatSenderChat',
213
        'setChatPermissions',
214
        'exportChatInviteLink',
215
        'createChatInviteLink',
216
        'editChatInviteLink',
217
        'revokeChatInviteLink',
218
        'approveChatJoinRequest',
219
        'declineChatJoinRequest',
220
        'setChatPhoto',
221
        'deleteChatPhoto',
222
        'setChatTitle',
223
        'setChatDescription',
224
        'pinChatMessage',
225
        'unpinChatMessage',
226
        'unpinAllChatMessages',
227
        'leaveChat',
228
        'getChat',
229
        'getChatAdministrators',
230
        'getChatMemberCount',
231
        'getChatMember',
232
        'setChatStickerSet',
233
        'deleteChatStickerSet',
234
        'answerCallbackQuery',
235
        'answerInlineQuery',
236
        'setMyCommands',
237
        'deleteMyCommands',
238
        'getMyCommands',
239
        'setChatMenuButton',
240
        'getChatMenuButton',
241
        'setMyDefaultAdministratorRights',
242
        'getMyDefaultAdministratorRights',
243
        'editMessageText',
244
        'editMessageCaption',
245
        'editMessageMedia',
246
        'editMessageReplyMarkup',
247
        'stopPoll',
248
        'deleteMessage',
249
        'getStickerSet',
250
        'uploadStickerFile',
251
        'createNewStickerSet',
252
        'addStickerToSet',
253
        'setStickerPositionInSet',
254
        'deleteStickerFromSet',
255
        'setStickerSetThumb',
256
        'answerWebAppQuery',
257
        'sendInvoice',
258
        'answerShippingQuery',
259
        'answerPreCheckoutQuery',
260
        'setPassportDataErrors',
261
        'sendGame',
262
        'setGameScore',
263
        'getGameHighScores',
264
    ];
265
266
    /**
267
     * Some methods need a dummy param due to certain cURL issues.
268
     *
269
     * @see Request::addDummyParamIfNecessary()
270
     *
271
     * @var array
272
     */
273
    private static $actions_need_dummy_param = [
274
        'deleteWebhook',
275
        'getWebhookInfo',
276
        'getMe',
277
        'logOut',
278
        'close',
279
        'deleteMyCommands',
280
        'getMyCommands',
281
        'setChatMenuButton',
282
        'getChatMenuButton',
283
        'setMyDefaultAdministratorRights',
284
        'getMyDefaultAdministratorRights',
285
    ];
286
287
    /**
288
     * Available fields for InputFile helper
289
     *
290
     * This is basically the list of all fields that allow InputFile objects
291
     * for which input can be simplified by providing local path directly  as string.
292
     *
293
     * @var array
294
     */
295
    private static $input_file_fields = [
296
        'setWebhook'          => ['certificate'],
297
        'sendPhoto'           => ['photo'],
298
        'sendAudio'           => ['audio', 'thumb'],
299
        'sendDocument'        => ['document', 'thumb'],
300
        'sendVideo'           => ['video', 'thumb'],
301
        'sendAnimation'       => ['animation', 'thumb'],
302
        'sendVoice'           => ['voice', 'thumb'],
303
        'sendVideoNote'       => ['video_note', 'thumb'],
304
        'setChatPhoto'        => ['photo'],
305
        'sendSticker'         => ['sticker'],
306
        'uploadStickerFile'   => ['png_sticker'],
307
        'createNewStickerSet' => ['png_sticker', 'tgs_sticker', 'webm_sticker'],
308
        'addStickerToSet'     => ['png_sticker', 'tgs_sticker', 'webm_sticker'],
309
        'setStickerSetThumb'  => ['thumb'],
310
    ];
311
312
    /**
313
     * Initialize
314
     *
315
     * @param Telegram $telegram
316
     */
317 33
    public static function initialize(Telegram $telegram): void
318
    {
319 33
        self::$telegram = $telegram;
320 33
        self::setClient(self::$client ?: new Client(['base_uri' => self::$api_base_uri]));
321
    }
322
323
    /**
324
     * Set a custom Guzzle HTTP Client object
325
     *
326
     * @param ClientInterface $client
327
     */
328 33
    public static function setClient(ClientInterface $client): void
329
    {
330 33
        self::$client = $client;
331
    }
332
333
    /**
334
     * Set a custom Bot API URL
335
     *
336
     * @param string $api_base_uri
337
     * @param string $api_base_download_uri
338
     */
339
    public static function setCustomBotApiUri(string $api_base_uri, string $api_base_download_uri = ''): void
340
    {
341
        self::$api_base_uri = $api_base_uri;
342
        if ($api_base_download_uri !== '') {
343
            self::$api_base_download_uri = $api_base_download_uri;
344
        }
345
    }
346
347
    /**
348
     * Get input from custom input or stdin and return it
349
     *
350
     * @return string
351
     */
352
    public static function getInput(): string
353
    {
354
        // First check if a custom input has been set, else get the PHP input.
355
        return self::$telegram->getCustomInput()
356
            ?: file_get_contents('php://input');
357
    }
358
359
    /**
360
     * Generate general fake server response
361
     *
362
     * @param array $data Data to add to fake response
363
     *
364
     * @return array Fake response data
365
     */
366 1
    public static function generateGeneralFakeServerResponse(array $data = []): array
367
    {
368
        //PARAM BINDED IN PHPUNIT TEST FOR TestServerResponse.php
369
        //Maybe this is not the best possible implementation
370
371
        //No value set in $data ie testing setWebhook
372
        //Provided $data['chat_id'] ie testing sendMessage
373
374 1
        $fake_response = ['ok' => true]; // :)
375
376 1
        if ($data === []) {
377 1
            $fake_response['result'] = true;
378
        }
379
380
        //some data to initialize the class method SendMessage
381 1
        if (isset($data['chat_id'])) {
382 1
            $data['message_id'] = '1234';
383 1
            $data['date']       = '1441378360';
384 1
            $data['from']       = [
385
                'id'         => 123456789,
386
                'first_name' => 'botname',
387
                'username'   => 'namebot',
388
            ];
389 1
            $data['chat']       = ['id' => $data['chat_id']];
390
391 1
            $fake_response['result'] = $data;
392
        }
393
394 1
        return $fake_response;
395
    }
396
397
    /**
398
     * Properly set up the request params
399
     *
400
     * If any item of the array is a resource, reformat it to a multipart request.
401
     * Else, just return the passed data as form params.
402
     *
403
     * @param array $data
404
     *
405
     * @return array
406
     * @throws TelegramException
407
     */
408
    private static function setUpRequestParams(array $data): array
409
    {
410
        $has_resource = false;
411
        $multipart    = [];
412
413
        foreach ($data as $key => &$item) {
414
            if ($key === 'media') {
415
                // Magical media input helper.
416
                $item = self::mediaInputHelper($item, $has_resource, $multipart);
417
            } elseif (array_key_exists(self::$current_action, self::$input_file_fields) && in_array($key, self::$input_file_fields[self::$current_action], true)) {
418
                // Allow absolute paths to local files.
419
                if (is_string($item) && file_exists($item)) {
420
                    $item = new Stream(self::encodeFile($item));
421
                }
422
            } elseif (is_array($item) || is_object($item)) {
423
                // Convert any nested arrays or objects into JSON strings.
424
                $item = json_encode($item);
425
            }
426
427
            // Reformat data array in multipart way if it contains a resource
428
            $has_resource = $has_resource || is_resource($item) || $item instanceof Stream;
429
            $multipart[]  = ['name' => $key, 'contents' => $item];
430
        }
431
        unset($item);
432
433
        if ($has_resource) {
434
            return ['multipart' => $multipart];
435
        }
436
437
        return ['form_params' => $data];
438
    }
439
440
    /**
441
     * Magical input media helper to simplify passing media.
442
     *
443
     * This allows the following:
444
     * Request::editMessageMedia([
445
     *     ...
446
     *     'media' => new InputMediaPhoto([
447
     *         'caption' => 'Caption!',
448
     *         'media'   => Request::encodeFile($local_photo),
449
     *     ]),
450
     * ]);
451
     * and
452
     * Request::sendMediaGroup([
453
     *     'media'   => [
454
     *         new InputMediaPhoto(['media' => Request::encodeFile($local_photo_1)]),
455
     *         new InputMediaPhoto(['media' => Request::encodeFile($local_photo_2)]),
456
     *         new InputMediaVideo(['media' => Request::encodeFile($local_video_1)]),
457
     *     ],
458
     * ]);
459
     * and even
460
     * Request::sendMediaGroup([
461
     *     'media'   => [
462
     *         new InputMediaPhoto(['media' => $local_photo_1]),
463
     *         new InputMediaPhoto(['media' => $local_photo_2]),
464
     *         new InputMediaVideo(['media' => $local_video_1]),
465
     *     ],
466
     * ]);
467
     *
468
     * @param mixed $item
469
     * @param bool  $has_resource
470
     * @param array $multipart
471
     *
472
     * @return mixed
473
     * @throws TelegramException
474
     */
475
    private static function mediaInputHelper($item, bool &$has_resource, array &$multipart)
476
    {
477
        $was_array = is_array($item);
478
        $was_array || $item = [$item];
479
480
        /** @var InputMedia|null $media_item */
481
        foreach ($item as $media_item) {
482
            if (!($media_item instanceof InputMedia)) {
483
                continue;
484
            }
485
486
            // Make a list of all possible media that can be handled by the helper.
487
            $possible_medias = array_filter([
488
                'media' => $media_item->getMedia(),
0 ignored issues
show
Bug introduced by
The method getMedia() does not exist on Longman\TelegramBot\Entities\InputMedia\InputMedia. Since it exists in all sub-types, consider adding an abstract or default implementation to Longman\TelegramBot\Entities\InputMedia\InputMedia. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

488
                'media' => $media_item->/** @scrutinizer ignore-call */ getMedia(),
Loading history...
489
                'thumb' => $media_item->getThumb(),
0 ignored issues
show
Bug introduced by
The method getThumb() does not exist on Longman\TelegramBot\Entities\InputMedia\InputMedia. Since it exists in all sub-types, consider adding an abstract or default implementation to Longman\TelegramBot\Entities\InputMedia\InputMedia. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

489
                'thumb' => $media_item->/** @scrutinizer ignore-call */ getThumb(),
Loading history...
490
            ]);
491
492
            foreach ($possible_medias as $type => $media) {
493
                // Allow absolute paths to local files.
494
                if (is_string($media) && strpos($media, 'attach://') !== 0 && file_exists($media)) {
495
                    $media = new Stream(self::encodeFile($media));
496
                }
497
498
                if (is_resource($media) || $media instanceof Stream) {
499
                    $has_resource = true;
500
                    $unique_key   = uniqid($type . '_', false);
501
                    $multipart[]  = ['name' => $unique_key, 'contents' => $media];
502
503
                    // We're literally overwriting the passed media type data!
504
                    $media_item->$type           = 'attach://' . $unique_key;
505
                    $media_item->raw_data[$type] = 'attach://' . $unique_key;
506
                }
507
            }
508
        }
509
510
        $was_array || $item = reset($item);
511
512
        return json_encode($item);
513
    }
514
515
    /**
516
     * Get the current action that's being executed
517
     *
518
     * @return string
519
     */
520 7
    public static function getCurrentAction(): string
521
    {
522 7
        return self::$current_action;
523
    }
524
525
    /**
526
     * Execute HTTP Request
527
     *
528
     * @param string $action Action to execute
529
     * @param array  $data   Data to attach to the execution
530
     *
531
     * @return string Result of the HTTP Request
532
     * @throws TelegramException
533
     */
534
    public static function execute(string $action, array $data = []): string
535
    {
536
        $request_params          = self::setUpRequestParams($data);
537
        $request_params['debug'] = TelegramLog::getDebugLogTempStream();
538
539
        try {
540
            $response = self::$client->post(
541
                '/bot' . self::$telegram->getApiKey() . '/' . $action,
542
                $request_params
543
            );
544
            $result   = (string) $response->getBody();
545
        } catch (RequestException $e) {
546
            $response = null;
547
            $result   = $e->getResponse() ? (string) $e->getResponse()->getBody() : '';
548
        }
549
550
        //Logging verbose debug output
551
        if (TelegramLog::$always_log_request_and_response || $response === null) {
552
            TelegramLog::debug('Request data:' . PHP_EOL . print_r($data, true));
0 ignored issues
show
Bug introduced by
Are you sure print_r($data, true) of type string|true can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

552
            TelegramLog::debug('Request data:' . PHP_EOL . /** @scrutinizer ignore-type */ print_r($data, true));
Loading history...
553
            TelegramLog::debug('Response data:' . PHP_EOL . $result);
554
            TelegramLog::endDebugLogTempStream('Verbose HTTP Request output:' . PHP_EOL . '%s' . PHP_EOL);
555
        }
556
557
        return $result;
558
    }
559
560
    /**
561
     * Download file
562
     *
563
     * @param File $file
564
     *
565
     * @return bool
566
     * @throws TelegramException
567
     */
568
    public static function downloadFile(File $file): bool
569
    {
570
        if (empty($download_path = self::$telegram->getDownloadPath())) {
571
            throw new TelegramException('Download path not set!');
572
        }
573
574
        $tg_file_path = $file->getFilePath();
575
        $file_path    = $download_path . '/' . $tg_file_path;
576
577
        $file_dir = dirname($file_path);
578
        //For safety reasons, first try to create the directory, then check that it exists.
579
        //This is in case some other process has created the folder in the meantime.
580
        if (!@mkdir($file_dir, 0755, true) && !is_dir($file_dir)) {
581
            throw new TelegramException('Directory ' . $file_dir . ' can\'t be created');
582
        }
583
584
        $debug_handle = TelegramLog::getDebugLogTempStream();
585
586
        try {
587
            $base_download_uri = str_replace('{API_KEY}', self::$telegram->getApiKey(), self::$api_base_download_uri);
588
            self::$client->get(
589
                "{$base_download_uri}/{$tg_file_path}",
590
                ['debug' => $debug_handle, 'sink' => $file_path]
591
            );
592
593
            return filesize($file_path) > 0;
594
        } catch (Throwable $e) {
595
            return false;
596
        } finally {
597
            //Logging verbose debug output
598
            TelegramLog::endDebugLogTempStream('Verbose HTTP File Download Request output:' . PHP_EOL . '%s' . PHP_EOL);
599
        }
600
    }
601
602
    /**
603
     * Encode file
604
     *
605
     * @param string $file
606
     *
607
     * @return resource
608
     * @throws TelegramException
609
     */
610
    public static function encodeFile(string $file)
611
    {
612
        $fp = fopen($file, 'rb');
613
        if ($fp === false) {
614
            throw new TelegramException('Cannot open "' . $file . '" for reading');
615
        }
616
617
        return $fp;
618
    }
619
620
    /**
621
     * Send command
622
     *
623
     * @todo Fake response doesn't need json encoding?
624
     * @todo Write debug entry on failure
625
     *
626
     * @param string $action
627
     * @param array  $data
628
     *
629
     * @return ServerResponse
630
     * @throws TelegramException
631
     */
632
    public static function send(string $action, array $data = []): ServerResponse
633
    {
634
        self::ensureValidAction($action);
635
        self::addDummyParamIfNecessary($action, $data);
636
637
        $bot_username = self::$telegram->getBotUsername();
638
639
        if (defined('PHPUNIT_TESTSUITE')) {
640
            $fake_response = self::generateGeneralFakeServerResponse($data);
641
642
            return new ServerResponse($fake_response, $bot_username);
643
        }
644
645
        self::ensureNonEmptyData($data);
646
647
        self::limitTelegramRequests($action, $data);
648
649
        // Remember which action is currently being executed.
650
        self::$current_action = $action;
651
652
        $raw_response = self::execute($action, $data);
653
        $response     = json_decode($raw_response, true);
654
655
        if (null === $response) {
656
            TelegramLog::debug($raw_response);
657
            throw new TelegramException('Telegram returned an invalid response!');
658
        }
659
660
        $response = new ServerResponse($response, $bot_username);
661
662
        if (!$response->isOk() && $response->getErrorCode() === 401 && $response->getDescription() === 'Unauthorized') {
663
            throw new InvalidBotTokenException();
664
        }
665
666
        // Special case for sent polls, which need to be saved specially.
667
        // @todo Take into account if DB gets extracted into separate module.
668
        if ($response->isOk() && ($message = $response->getResult()) && ($message instanceof Message) && $poll = $message->getPoll()) {
669
            DB::insertPollRequest($poll);
670
        }
671
672
        // Reset current action after completion.
673
        self::$current_action = '';
674
675
        return $response;
676
    }
677
678
    /**
679
     * Add a dummy parameter if the passed action requires it.
680
     *
681
     * If a method doesn't require parameters, we need to add a dummy one anyway,
682
     * because of some cURL version failed POST request without parameters.
683
     *
684
     * @link https://github.com/php-telegram-bot/core/pull/228
685
     *
686
     * @todo Would be nice to find a better solution for this!
687
     *
688
     * @param string $action
689
     * @param array  $data
690
     */
691
    protected static function addDummyParamIfNecessary(string $action, array &$data): void
692
    {
693
        if (empty($data) && in_array($action, self::$actions_need_dummy_param, true)) {
694
            // Can be anything, using a single letter to minimise request size.
695
            $data = ['d'];
696
        }
697
    }
698
699
    /**
700
     * Make sure the data isn't empty, else throw an exception
701
     *
702
     * @param array $data
703
     *
704
     * @throws TelegramException
705
     */
706
    private static function ensureNonEmptyData(array $data): void
707
    {
708
        if (count($data) === 0) {
709
            throw new TelegramException('Data is empty!');
710
        }
711
    }
712
713
    /**
714
     * Make sure the action is valid, else throw an exception
715
     *
716
     * @param string $action
717
     *
718
     * @throws TelegramException
719
     */
720
    private static function ensureValidAction(string $action): void
721
    {
722
        if (!in_array($action, self::$actions, true)) {
723
            throw new TelegramException('The action "' . $action . '" doesn\'t exist!');
724
        }
725
    }
726
727
    /**
728
     * Use this method to send text messages. On success, the last sent Message is returned
729
     *
730
     * All message responses are saved in `$extras['responses']`.
731
     * Custom encoding can be defined in `$extras['encoding']` (default: `mb_internal_encoding()`)
732
     * Custom splitting can be defined in `$extras['split']` (default: 4096)
733
     *     `$extras['split'] = null;` // force to not split message at all!
734
     *     `$extras['split'] = 200;`  // split message into 200 character chunks
735
     *
736
     * @link https://core.telegram.org/bots/api#sendmessage
737
     *
738
     * @todo Splitting formatted text may break the message.
739
     *
740
     * @param array      $data
741
     * @param array|null $extras
742
     *
743
     * @return ServerResponse
744
     * @throws TelegramException
745
     */
746
    public static function sendMessage(array $data, ?array &$extras = []): ServerResponse
747
    {
748
        $extras = array_merge([
749
            'split'    => 4096,
750
            'encoding' => mb_internal_encoding(),
751
        ], (array) $extras);
752
753
        $text       = $data['text'];
754
        $encoding   = $extras['encoding'];
755
        $max_length = $extras['split'] ?: mb_strlen($text, $encoding);
756
757
        $responses = [];
758
759
        do {
760
            // Chop off and send the first message.
761
            $data['text'] = mb_substr($text, 0, $max_length, $encoding);
762
            $responses[]  = self::send('sendMessage', $data);
763
764
            // Prepare the next message.
765
            $text = mb_substr($text, $max_length, null, $encoding);
766
        } while ($text !== '');
767
768
        // Add all response objects to referenced variable.
769
        $extras['responses'] = $responses;
770
771
        return end($responses);
772
    }
773
774
    /**
775
     * Any statically called method should be relayed to the `send` method.
776
     *
777
     * @param string $action
778
     * @param array  $data
779
     *
780
     * @return ServerResponse
781
     * @throws TelegramException
782
     */
783
    public static function __callStatic(string $action, array $data): ServerResponse
784
    {
785
        // Only argument should be the data array, ignore any others.
786
        return static::send($action, reset($data) ?: []);
787
    }
788
789
    /**
790
     * Return an empty Server Response
791
     *
792
     * No request is sent to Telegram.
793
     * This function is used in commands that don't need to fire a message after execution
794
     *
795
     * @return ServerResponse
796
     */
797
    public static function emptyResponse(): ServerResponse
798
    {
799
        return new ServerResponse(['ok' => true, 'result' => true]);
800
    }
801
802
    /**
803
     * Send message to all active chats
804
     *
805
     * @param string $callback_function
806
     * @param array  $data
807
     * @param array  $select_chats_params
808
     *
809
     * @return array
810
     * @throws TelegramException
811
     */
812
    public static function sendToActiveChats(
813
        string $callback_function,
814
        array $data,
815
        array $select_chats_params
816
    ): array {
817
        self::ensureValidAction($callback_function);
818
819
        $chats = DB::selectChats($select_chats_params);
820
821
        $results = [];
822
        if (is_array($chats)) {
823
            foreach ($chats as $row) {
824
                $data['chat_id'] = $row['chat_id'];
825
                $results[]       = self::send($callback_function, $data);
826
            }
827
        }
828
829
        return $results;
830
    }
831
832
    /**
833
     * Enable request limiter
834
     *
835
     * @param bool  $enable
836
     * @param array $options
837
     *
838
     * @throws TelegramException
839
     */
840
    public static function setLimiter(bool $enable = true, array $options = []): void
841
    {
842
        if (DB::isDbConnected()) {
843
            $options_default = [
844
                'interval' => 1,
845
            ];
846
847
            $options = array_merge($options_default, $options);
848
849
            if (!is_numeric($options['interval']) || $options['interval'] <= 0) {
850
                throw new TelegramException('Interval must be a number and must be greater than zero!');
851
            }
852
853
            self::$limiter_interval = $options['interval'];
854
            self::$limiter_enabled  = $enable;
855
        }
856
    }
857
858
    /**
859
     * This functions delays API requests to prevent reaching Telegram API limits
860
     *  Can be disabled while in execution by 'Request::setLimiter(false)'
861
     *
862
     * @link https://core.telegram.org/bots/faq#my-bot-is-hitting-limits-how-do-i-avoid-this
863
     *
864
     * @param string $action
865
     * @param array  $data
866
     *
867
     * @throws TelegramException
868
     */
869
    private static function limitTelegramRequests(string $action, array $data = []): void
870
    {
871
        if (self::$limiter_enabled) {
872
            $limited_methods = [
873
                'sendMessage',
874
                'forwardMessage',
875
                'copyMessage',
876
                'sendPhoto',
877
                'sendAudio',
878
                'sendDocument',
879
                'sendSticker',
880
                'sendVideo',
881
                'sendAnimation',
882
                'sendVoice',
883
                'sendVideoNote',
884
                'sendMediaGroup',
885
                'sendLocation',
886
                'editMessageLiveLocation',
887
                'stopMessageLiveLocation',
888
                'sendVenue',
889
                'sendContact',
890
                'sendPoll',
891
                'sendDice',
892
                'sendInvoice',
893
                'sendGame',
894
                'setGameScore',
895
                'setMyCommands',
896
                'deleteMyCommands',
897
                'editMessageText',
898
                'editMessageCaption',
899
                'editMessageMedia',
900
                'editMessageReplyMarkup',
901
                'stopPoll',
902
                'setChatTitle',
903
                'setChatDescription',
904
                'setChatStickerSet',
905
                'deleteChatStickerSet',
906
                'setPassportDataErrors',
907
            ];
908
909
            $chat_id           = $data['chat_id'] ?? null;
910
            $inline_message_id = $data['inline_message_id'] ?? null;
911
912
            if (($chat_id || $inline_message_id) && in_array($action, $limited_methods, true)) {
913
                $timeout = 60;
914
915
                while (true) {
916
                    if ($timeout <= 0) {
917
                        throw new TelegramException('Timed out while waiting for a request spot!');
918
                    }
919
920
                    if (!($requests = DB::getTelegramRequestCount($chat_id, $inline_message_id))) {
921
                        break;
922
                    }
923
924
                    // Make sure we're handling integers here.
925
                    $requests = array_map('intval', $requests);
0 ignored issues
show
Bug introduced by
It seems like $requests can also be of type true; however, parameter $array of array_map() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

925
                    $requests = array_map('intval', /** @scrutinizer ignore-type */ $requests);
Loading history...
926
927
                    $chat_per_second   = ($requests['LIMIT_PER_SEC'] === 0);    // No more than one message per second inside a particular chat
928
                    $global_per_second = ($requests['LIMIT_PER_SEC_ALL'] < 30); // No more than 30 messages per second to different chats
929
                    $groups_per_minute = (((is_numeric($chat_id) && $chat_id > 0) || $inline_message_id !== null) || ((!is_numeric($chat_id) || $chat_id < 0) && $requests['LIMIT_PER_MINUTE'] < 20));    // No more than 20 messages per minute in groups and channels
930
931
                    if ($chat_per_second && $global_per_second && $groups_per_minute) {
932
                        break;
933
                    }
934
935
                    $timeout--;
936
                    usleep((int) (self::$limiter_interval * 1000000));
937
                }
938
939
                DB::insertTelegramRequest($action, $data);
940
            }
941
        }
942
    }
943
944
    /**
945
     * Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
946
     *
947
     * @deprecated
948
     * @see Request::banChatMember()
949
     *
950
     * @param array $data
951
     *
952
     * @return ServerResponse
953
     */
954
    public static function kickChatMember(array $data = []): ServerResponse
955
    {
956
        return static::banChatMember($data);
957
    }
958
959
    /**
960
     * Use this method to get the number of members in a chat. Returns Int on success.
961
     *
962
     * @deprecated
963
     * @see Request::getChatMemberCount()
964
     *
965
     * @param array $data
966
     *
967
     * @return ServerResponse
968
     */
969
    public static function getChatMembersCount(array $data = []): ServerResponse
970
    {
971
        return static::getChatMemberCount($data);
972
    }
973
}
974