Passed
Push — master ( f55fd1...466468 )
by Armando
02:34
created

Request::setUpRequestParams()   C

Complexity

Conditions 12
Paths 32

Size

Total Lines 30
Code Lines 16

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 156

Importance

Changes 7
Bugs 0 Features 0
Metric Value
cc 12
eloc 16
c 7
b 0
f 0
nc 32
nop 1
dl 0
loc 30
ccs 0
cts 17
cp 0
crap 156
rs 6.9666

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
 * This file is part of the TelegramBot package.
4
 *
5
 * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
6
 *
7
 * For the full copyright and license information, please view the LICENSE
8
 * file that was distributed with this source code.
9
 */
10
11
namespace Longman\TelegramBot;
12
13
use GuzzleHttp\Client;
14
use GuzzleHttp\Exception\RequestException;
15
use GuzzleHttp\Psr7\Stream;
16
use Longman\TelegramBot\Entities\File;
17
use Longman\TelegramBot\Entities\InputMedia\InputMedia;
18
use Longman\TelegramBot\Entities\ServerResponse;
19
use Longman\TelegramBot\Exception\InvalidBotTokenException;
20
use Longman\TelegramBot\Exception\TelegramException;
21
22
/**
23
 * Class Request
24
 *
25
 * @method static ServerResponse getUpdates(array $data)              Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
26
 * @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.
27
 * @method static ServerResponse deleteWebhook()                      Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters.
28
 * @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.
29
 * @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.
30
 * @method static ServerResponse forwardMessage(array $data)          Use this method to forward messages of any kind. On success, the sent Message is returned.
31
 * @method static ServerResponse sendPhoto(array $data)               Use this method to send photos. On success, the sent Message is returned.
32
 * @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.
33
 * @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.
34
 * @method static ServerResponse sendSticker(array $data)             Use this method to send .webp stickers. On success, the sent Message is returned.
35
 * @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.
36
 * @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.
37
 * @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.
38
 * @method static ServerResponse sendVideoNote(array $data)           Use this method to send video messages. On success, the sent Message is returned.
39
 * @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.
40
 * @method static ServerResponse sendLocation(array $data)            Use this method to send point on the map. On success, the sent Message is returned.
41
 * @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.
42
 * @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.
43
 * @method static ServerResponse sendVenue(array $data)               Use this method to send information about a venue. On success, the sent Message is returned.
44
 * @method static ServerResponse sendContact(array $data)             Use this method to send phone contacts. On success, the sent Message is returned.
45
 * @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.
46
 * @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.
47
 * @method static ServerResponse getUserProfilePhotos(array $data)    Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
48
 * @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.
49
 * @method static ServerResponse kickChatMember(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.
50
 * @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.
51
 * @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.
52
 * @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.
53
 * @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.
54
 * @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.
55
 * @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.
56
 * @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.
57
 * @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.
58
 * @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.
59
 * @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.
60
 * @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.
61
 * @method static ServerResponse leaveChat(array $data)               Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
62
 * @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.
63
 * @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.
64
 * @method static ServerResponse getChatMembersCount(array $data)     Use this method to get the number of members in a chat. Returns Int on success.
65
 * @method static ServerResponse getChatMember(array $data)           Use this method to get information about a member of a chat. Returns a ChatMember object on success.
66
 * @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.
67
 * @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.
68
 * @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.
69
 * @method static ServerResponse answerInlineQuery(array $data)       Use this method to send answers to an inline query. On success, True is returned.
70
 * @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.
71
 * @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.
72
 * @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.
73
 * @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.
74
 * @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.
75
 * @method static ServerResponse deleteMessage(array $data)           Use this method to delete a message, including service messages, with certain limitations. Returns True on success.
76
 * @method static ServerResponse getStickerSet(array $data)           Use this method to get a sticker set. On success, a StickerSet object is returned.
77
 * @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.
78
 * @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.
79
 * @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.
80
 * @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.
81
 * @method static ServerResponse deleteStickerFromSet(array $data)    Use this method to delete a sticker from a set created by the bot. Returns True on success.
82
 * @method static ServerResponse sendInvoice(array $data)             Use this method to send invoices. On success, the sent Message is returned.
83
 * @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.
84
 * @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.
85
 * @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.
86
 * @method static ServerResponse sendGame(array $data)                Use this method to send a game. On success, the sent Message is returned.
87
 * @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.
88
 * @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.
89
 */
90
class Request
91
{
92
    /**
93
     * Telegram object
94
     *
95
     * @var Telegram
96
     */
97
    private static $telegram;
98
99
    /**
100
     * URI of the Telegram API
101
     *
102
     * @var string
103
     */
104
    private static $api_base_uri = 'https://api.telegram.org';
105
106
    /**
107
     * Guzzle Client object
108
     *
109
     * @var Client
110
     */
111
    private static $client;
112
113
    /**
114
     * Input value of the request
115
     *
116
     * @var string
117
     */
118
    private static $input;
119
120
    /**
121
     * Request limiter
122
     *
123
     * @var boolean
124
     */
125
    private static $limiter_enabled;
126
127
    /**
128
     * Request limiter's interval between checks
129
     *
130
     * @var float
131
     */
132
    private static $limiter_interval;
133
134
    /**
135
     * Get the current action that is being executed
136
     *
137
     * @var string
138
     */
139
    private static $current_action;
140
141
    /**
142
     * Available actions to send
143
     *
144
     * This is basically the list of all methods listed on the official API documentation.
145
     *
146
     * @link https://core.telegram.org/bots/api
147
     *
148
     * @var array
149
     */
150
    private static $actions = [
151
        'getUpdates',
152
        'setWebhook',
153
        'deleteWebhook',
154
        'getWebhookInfo',
155
        'getMe',
156
        'sendMessage',
157
        'forwardMessage',
158
        'sendPhoto',
159
        'sendAudio',
160
        'sendDocument',
161
        'sendSticker',
162
        'sendVideo',
163
        'sendAnimation',
164
        'sendVoice',
165
        'sendVideoNote',
166
        'sendMediaGroup',
167
        'sendLocation',
168
        'editMessageLiveLocation',
169
        'stopMessageLiveLocation',
170
        'sendVenue',
171
        'sendContact',
172
        'sendPoll',
173
        'sendChatAction',
174
        'getUserProfilePhotos',
175
        'getFile',
176
        'kickChatMember',
177
        'unbanChatMember',
178
        'restrictChatMember',
179
        'promoteChatMember',
180
        'setChatPermissions',
181
        'exportChatInviteLink',
182
        'setChatPhoto',
183
        'deleteChatPhoto',
184
        'setChatTitle',
185
        'setChatDescription',
186
        'pinChatMessage',
187
        'unpinChatMessage',
188
        'leaveChat',
189
        'getChat',
190
        'getChatAdministrators',
191
        'getChatMembersCount',
192
        'getChatMember',
193
        'setChatStickerSet',
194
        'deleteChatStickerSet',
195
        'answerCallbackQuery',
196
        'answerInlineQuery',
197
        'editMessageText',
198
        'editMessageCaption',
199
        'editMessageMedia',
200
        'editMessageReplyMarkup',
201
        'stopPoll',
202
        'deleteMessage',
203
        'getStickerSet',
204
        'uploadStickerFile',
205
        'createNewStickerSet',
206
        'addStickerToSet',
207
        'setStickerPositionInSet',
208
        'deleteStickerFromSet',
209
        'sendInvoice',
210
        'answerShippingQuery',
211
        'answerPreCheckoutQuery',
212
        'setPassportDataErrors',
213
        'sendGame',
214
        'setGameScore',
215
        'getGameHighScores',
216
    ];
217
218
    /**
219
     * Some methods need a dummy param due to certain cURL issues.
220
     *
221
     * @see Request::addDummyParamIfNecessary()
222
     *
223
     * @var array
224
     */
225
    private static $actions_need_dummy_param = [
226
        'deleteWebhook',
227
        'getWebhookInfo',
228
        'getMe',
229
    ];
230
231
    /**
232
     * Available fields for InputFile helper
233
     *
234
     * This is basically the list of all fields that allow InputFile objects
235
     * for which input can be simplified by providing local path directly  as string.
236
     *
237
     * @var array
238
     */
239
    private static $input_file_fields = [
240
        'setWebhook'          => ['certificate'],
241
        'sendPhoto'           => ['photo'],
242
        'sendAudio'           => ['audio', 'thumb'],
243
        'sendDocument'        => ['document', 'thumb'],
244
        'sendVideo'           => ['video', 'thumb'],
245
        'sendAnimation'       => ['animation', 'thumb'],
246
        'sendVoice'           => ['voice', 'thumb'],
247
        'sendVideoNote'       => ['video_note', 'thumb'],
248
        'setChatPhoto'        => ['photo'],
249
        'sendSticker'         => ['sticker'],
250
        'uploadStickerFile'   => ['png_sticker'],
251
        'createNewStickerSet' => ['png_sticker'],
252
        'addStickerToSet'     => ['png_sticker'],
253
    ];
254
255
    /**
256
     * Initialize
257
     *
258
     * @param Telegram $telegram
259
     *
260
     * @throws TelegramException
261
     */
262 30
    public static function initialize(Telegram $telegram)
263
    {
264 30
        if (!($telegram instanceof Telegram)) {
0 ignored issues
show
introduced by
$telegram is always a sub-type of Longman\TelegramBot\Telegram.
Loading history...
265
            throw new TelegramException('Invalid Telegram pointer!');
266
        }
267
268 30
        self::$telegram = $telegram;
269 30
        self::setClient(self::$client ?: new Client(['base_uri' => self::$api_base_uri]));
270 30
    }
271
272
    /**
273
     * Set a custom Guzzle HTTP Client object
274
     *
275
     * @param Client $client
276
     *
277
     * @throws TelegramException
278
     */
279 30
    public static function setClient(Client $client)
280
    {
281 30
        if (!($client instanceof Client)) {
0 ignored issues
show
introduced by
$client is always a sub-type of GuzzleHttp\Client.
Loading history...
282
            throw new TelegramException('Invalid GuzzleHttp\Client pointer!');
283
        }
284
285 30
        self::$client = $client;
286 30
    }
287
288
    /**
289
     * Set input from custom input or stdin and return it
290
     *
291
     * @return string
292
     * @throws TelegramException
293
     */
294
    public static function getInput()
295
    {
296
        // First check if a custom input has been set, else get the PHP input.
297
        if (!($input = self::$telegram->getCustomInput())) {
298
            $input = file_get_contents('php://input');
299
        }
300
301
        // Make sure we have a string to work with.
302
        if (!is_string($input)) {
0 ignored issues
show
introduced by
The condition is_string($input) is always true.
Loading history...
303
            throw new TelegramException('Input must be a string!');
304
        }
305
306
        self::$input = $input;
307
308
        TelegramLog::update(self::$input);
309
310
        return self::$input;
311
    }
312
313
    /**
314
     * Generate general fake server response
315
     *
316
     * @param array $data Data to add to fake response
317
     *
318
     * @return array Fake response data
319
     */
320 1
    public static function generateGeneralFakeServerResponse(array $data = [])
321
    {
322
        //PARAM BINDED IN PHPUNIT TEST FOR TestServerResponse.php
323
        //Maybe this is not the best possible implementation
324
325
        //No value set in $data ie testing setWebhook
326
        //Provided $data['chat_id'] ie testing sendMessage
327
328 1
        $fake_response = ['ok' => true]; // :)
329
330 1
        if ($data === []) {
331 1
            $fake_response['result'] = true;
332
        }
333
334
        //some data to let iniatilize the class method SendMessage
335 1
        if (isset($data['chat_id'])) {
336 1
            $data['message_id'] = '1234';
337 1
            $data['date']       = '1441378360';
338 1
            $data['from']       = [
339
                'id'         => 123456789,
340
                'first_name' => 'botname',
341
                'username'   => 'namebot',
342
            ];
343 1
            $data['chat']       = ['id' => $data['chat_id']];
344
345 1
            $fake_response['result'] = $data;
346
        }
347
348 1
        return $fake_response;
349
    }
350
351
    /**
352
     * Properly set up the request params
353
     *
354
     * If any item of the array is a resource, reformat it to a multipart request.
355
     * Else, just return the passed data as form params.
356
     *
357
     * @param array $data
358
     *
359
     * @return array
360
     * @throws TelegramException
361
     */
362
    private static function setUpRequestParams(array $data)
363
    {
364
        $has_resource = false;
365
        $multipart    = [];
366
367
        foreach ($data as $key => &$item) {
368
            if ($key === 'media') {
369
                // Magical media input helper.
370
                $item = self::mediaInputHelper($item, $has_resource, $multipart);
371
            } elseif (array_key_exists(self::$current_action, self::$input_file_fields) && in_array($key, self::$input_file_fields[self::$current_action], true)) {
372
                // Allow absolute paths to local files.
373
                if (is_string($item) && file_exists($item)) {
374
                    $item = new Stream(self::encodeFile($item));
375
                }
376
            } elseif (is_array($item) || is_object($item)) {
377
                // Convert any nested arrays or objects into JSON strings.
378
                $item = json_encode($item);
379
            }
380
381
            // Reformat data array in multipart way if it contains a resource
382
            $has_resource = $has_resource || is_resource($item) || $item instanceof Stream;
383
            $multipart[]  = ['name' => $key, 'contents' => $item];
384
        }
385
        unset($item);
386
387
        if ($has_resource) {
388
            return ['multipart' => $multipart];
389
        }
390
391
        return ['form_params' => $data];
392
    }
393
394
    /**
395
     * Magical input media helper to simplify passing media.
396
     *
397
     * This allows the following:
398
     * Request::editMessageMedia([
399
     *     ...
400
     *     'media' => new InputMediaPhoto([
401
     *         'caption' => 'Caption!',
402
     *         'media'   => Request::encodeFile($local_photo),
403
     *     ]),
404
     * ]);
405
     * and
406
     * Request::sendMediaGroup([
407
     *     'media'   => [
408
     *         new InputMediaPhoto(['media' => Request::encodeFile($local_photo_1)]),
409
     *         new InputMediaPhoto(['media' => Request::encodeFile($local_photo_2)]),
410
     *         new InputMediaVideo(['media' => Request::encodeFile($local_video_1)]),
411
     *     ],
412
     * ]);
413
     * and even
414
     * Request::sendMediaGroup([
415
     *     'media'   => [
416
     *         new InputMediaPhoto(['media' => $local_photo_1]),
417
     *         new InputMediaPhoto(['media' => $local_photo_2]),
418
     *         new InputMediaVideo(['media' => $local_video_1]),
419
     *     ],
420
     * ]);
421
     *
422
     * @param mixed $item
423
     * @param bool  $has_resource
424
     * @param array $multipart
425
     *
426
     * @return mixed
427
     * @throws TelegramException
428
     */
429
    private static function mediaInputHelper($item, &$has_resource, array &$multipart)
430
    {
431
        $was_array = is_array($item);
432
        $was_array || $item = [$item];
433
434
        foreach ($item as $media_item) {
435
            if (!($media_item instanceof InputMedia)) {
436
                continue;
437
            }
438
439
            $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

439
            /** @scrutinizer ignore-call */ 
440
            $media = $media_item->getMedia();
Loading history...
440
441
            // Allow absolute paths to local files.
442
            if (is_string($media) && file_exists($media)) {
443
                $media = new Stream(self::encodeFile($media));
444
            }
445
446
            if (is_resource($media) || $media instanceof Stream) {
447
                $has_resource = true;
448
                $rnd_key      = uniqid('media_', false);
449
                $multipart[]  = ['name' => $rnd_key, 'contents' => $media];
450
451
                // We're literally overwriting the passed media data!
452
                $media_item->media             = 'attach://' . $rnd_key;
453
                $media_item->raw_data['media'] = 'attach://' . $rnd_key;
454
            }
455
        }
456
457
        $was_array || $item = reset($item);
458
459
        return json_encode($item);
460
    }
461
462
    /**
463
     * Get the current action that's being executed
464
     *
465
     * @return string
466
     */
467 7
    public static function getCurrentAction()
468
    {
469 7
        return self::$current_action;
470
    }
471
472
    /**
473
     * Execute HTTP Request
474
     *
475
     * @param string $action Action to execute
476
     * @param array  $data   Data to attach to the execution
477
     *
478
     * @return string Result of the HTTP Request
479
     * @throws TelegramException
480
     */
481
    public static function execute($action, array $data = [])
482
    {
483
        $result                  = null;
484
        $request_params          = self::setUpRequestParams($data);
485
        $request_params['debug'] = TelegramLog::getDebugLogTempStream();
486
487
        try {
488
            $response = self::$client->post(
489
                '/bot' . self::$telegram->getApiKey() . '/' . $action,
490
                $request_params
491
            );
492
            $result   = (string) $response->getBody();
493
494
            //Logging getUpdates Update
495
            if ($action === 'getUpdates') {
496
                TelegramLog::update($result);
497
            }
498
        } catch (RequestException $e) {
499
            $result = $e->getResponse() ? (string) $e->getResponse()->getBody() : '';
500
        } finally {
501
            //Logging verbose debug output
502
            TelegramLog::endDebugLogTempStream('Verbose HTTP Request output:' . PHP_EOL . '%s' . PHP_EOL);
503
        }
504
505
        return $result;
506
    }
507
508
    /**
509
     * Download file
510
     *
511
     * @param File $file
512
     *
513
     * @return boolean
514
     * @throws TelegramException
515
     */
516
    public static function downloadFile(File $file)
517
    {
518
        if (empty($download_path = self::$telegram->getDownloadPath())) {
519
            throw new TelegramException('Download path not set!');
520
        }
521
522
        $tg_file_path = $file->getFilePath();
523
        $file_path    = $download_path . '/' . $tg_file_path;
524
525
        $file_dir = dirname($file_path);
526
        //For safety reasons, first try to create the directory, then check that it exists.
527
        //This is in case some other process has created the folder in the meantime.
528
        if (!@mkdir($file_dir, 0755, true) && !is_dir($file_dir)) {
529
            throw new TelegramException('Directory ' . $file_dir . ' can\'t be created');
530
        }
531
532
        $debug_handle = TelegramLog::getDebugLogTempStream();
533
534
        try {
535
            self::$client->get(
536
                '/file/bot' . self::$telegram->getApiKey() . '/' . $tg_file_path,
537
                ['debug' => $debug_handle, 'sink' => $file_path]
538
            );
539
540
            return filesize($file_path) > 0;
541
        } catch (RequestException $e) {
542
            return false;
543
        } finally {
544
            //Logging verbose debug output
545
            TelegramLog::endDebugLogTempStream('Verbose HTTP File Download Request output:' . PHP_EOL . '%s' . PHP_EOL);
546
        }
547
    }
548
549
    /**
550
     * Encode file
551
     *
552
     * @param string $file
553
     *
554
     * @return resource
555
     * @throws TelegramException
556
     */
557
    public static function encodeFile($file)
558
    {
559
        $fp = fopen($file, 'rb');
560
        if ($fp === false) {
561
            throw new TelegramException('Cannot open "' . $file . '" for reading');
562
        }
563
564
        return $fp;
565
    }
566
567
    /**
568
     * Send command
569
     *
570
     * @todo Fake response doesn't need json encoding?
571
     * @todo Write debug entry on failure
572
     *
573
     * @param string $action
574
     * @param array  $data
575
     *
576
     * @return ServerResponse
577
     * @throws TelegramException
578
     */
579
    public static function send($action, array $data = [])
580
    {
581
        self::ensureValidAction($action);
582
        self::addDummyParamIfNecessary($action, $data);
583
584
        $bot_username = self::$telegram->getBotUsername();
585
586
        if (defined('PHPUNIT_TESTSUITE')) {
587
            $fake_response = self::generateGeneralFakeServerResponse($data);
588
589
            return new ServerResponse($fake_response, $bot_username);
590
        }
591
592
        self::ensureNonEmptyData($data);
593
594
        self::limitTelegramRequests($action, $data);
595
596
        // Remember which action is currently being executed.
597
        self::$current_action = $action;
598
599
        $raw_response = self::execute($action, $data);
600
        $response     = json_decode($raw_response, true);
601
602
        if (null === $response) {
603
            TelegramLog::debug($raw_response);
604
            throw new TelegramException('Telegram returned an invalid response!');
605
        }
606
607
        $response = new ServerResponse($response, $bot_username);
608
609
        if (!$response->isOk() && $response->getErrorCode() === 401 && $response->getDescription() === 'Unauthorized') {
610
            throw new InvalidBotTokenException();
611
        }
612
613
        // Reset current action after completion.
614
        self::$current_action = null;
615
616
        return $response;
617
    }
618
619
    /**
620
     * Add a dummy parameter if the passed action requires it.
621
     *
622
     * If a method doesn't require parameters, we need to add a dummy one anyway,
623
     * because of some cURL version failed POST request without parameters.
624
     *
625
     * @link https://github.com/php-telegram-bot/core/pull/228
626
     *
627
     * @todo Would be nice to find a better solution for this!
628
     *
629
     * @param string $action
630
     * @param array  $data
631
     */
632
    protected static function addDummyParamIfNecessary($action, array &$data)
633
    {
634
        if (in_array($action, self::$actions_need_dummy_param, true)) {
635
            // Can be anything, using a single letter to minimise request size.
636
            $data = ['d'];
637
        }
638
    }
639
640
    /**
641
     * Make sure the data isn't empty, else throw an exception
642
     *
643
     * @param array $data
644
     *
645
     * @throws TelegramException
646
     */
647
    private static function ensureNonEmptyData(array $data)
648
    {
649
        if (count($data) === 0) {
650
            throw new TelegramException('Data is empty!');
651
        }
652
    }
653
654
    /**
655
     * Make sure the action is valid, else throw an exception
656
     *
657
     * @param string $action
658
     *
659
     * @throws TelegramException
660
     */
661
    private static function ensureValidAction($action)
662
    {
663
        if (!in_array($action, self::$actions, true)) {
664
            throw new TelegramException('The action "' . $action . '" doesn\'t exist!');
665
        }
666
    }
667
668
    /**
669
     * Use this method to send text messages. On success, the sent Message is returned
670
     *
671
     * @link https://core.telegram.org/bots/api#sendmessage
672
     *
673
     * @param array $data
674
     *
675
     * @return ServerResponse
676
     * @throws TelegramException
677
     */
678
    public static function sendMessage(array $data)
679
    {
680
        $text = $data['text'];
681
682
        do {
683
            //Chop off and send the first message
684
            $data['text'] = mb_substr($text, 0, 4096);
685
            $response     = self::send('sendMessage', $data);
686
687
            //Prepare the next message
688
            $text = mb_substr($text, 4096);
689
        } while (mb_strlen($text, 'UTF-8') > 0);
690
691
        return $response;
692
    }
693
694
    /**
695
     * Any statically called method should be relayed to the `send` method.
696
     *
697
     * @param string $action
698
     * @param array  $data
699
     *
700
     * @return ServerResponse
701
     */
702
    public static function __callStatic($action, array $data)
703
    {
704
        // Make sure to add the action being called as the first parameter to be passed.
705
        array_unshift($data, $action);
706
707
        // @todo Use splat operator for unpacking when we move to PHP 5.6+
708
        return call_user_func_array('static::send', $data);
709
    }
710
711
    /**
712
     * Return an empty Server Response
713
     *
714
     * No request to telegram are sent, this function is used in commands that
715
     * don't need to fire a message after execution
716
     *
717
     * @return ServerResponse
718
     */
719
    public static function emptyResponse()
720
    {
721
        return new ServerResponse(['ok' => true, 'result' => true], null);
722
    }
723
724
    /**
725
     * Send message to all active chats
726
     *
727
     * @param string $callback_function
728
     * @param array  $data
729
     * @param array  $select_chats_params
730
     *
731
     * @return array
732
     * @throws TelegramException
733
     */
734
    public static function sendToActiveChats(
735
        $callback_function,
736
        array $data,
737
        array $select_chats_params
738
    ) {
739
        self::ensureValidAction($callback_function);
740
741
        $chats = DB::selectChats($select_chats_params);
742
743
        $results = [];
744
        if (is_array($chats)) {
745
            foreach ($chats as $row) {
746
                $data['chat_id'] = $row['chat_id'];
747
                $results[]       = self::send($callback_function, $data);
748
            }
749
        }
750
751
        return $results;
752
    }
753
754
    /**
755
     * Enable request limiter
756
     *
757
     * @param boolean $enable
758
     * @param array   $options
759
     *
760
     * @throws TelegramException
761
     */
762
    public static function setLimiter($enable = true, array $options = [])
763
    {
764
        if (DB::isDbConnected()) {
765
            $options_default = [
766
                'interval' => 1,
767
            ];
768
769
            $options = array_merge($options_default, $options);
770
771
            if (!is_numeric($options['interval']) || $options['interval'] <= 0) {
772
                throw new TelegramException('Interval must be a number and must be greater than zero!');
773
            }
774
775
            self::$limiter_interval = $options['interval'];
776
            self::$limiter_enabled  = $enable;
777
        }
778
    }
779
780
    /**
781
     * This functions delays API requests to prevent reaching Telegram API limits
782
     *  Can be disabled while in execution by 'Request::setLimiter(false)'
783
     *
784
     * @link https://core.telegram.org/bots/faq#my-bot-is-hitting-limits-how-do-i-avoid-this
785
     *
786
     * @param string $action
787
     * @param array  $data
788
     *
789
     * @throws TelegramException
790
     */
791
    private static function limitTelegramRequests($action, array $data = [])
792
    {
793
        if (self::$limiter_enabled) {
794
            $limited_methods = [
795
                'sendMessage',
796
                'forwardMessage',
797
                'sendPhoto',
798
                'sendAudio',
799
                'sendDocument',
800
                'sendSticker',
801
                'sendVideo',
802
                'sendAnimation',
803
                'sendVoice',
804
                'sendVideoNote',
805
                'sendMediaGroup',
806
                'sendLocation',
807
                'editMessageLiveLocation',
808
                'stopMessageLiveLocation',
809
                'sendVenue',
810
                'sendContact',
811
                'sendPoll',
812
                'sendInvoice',
813
                'sendGame',
814
                'setGameScore',
815
                'editMessageText',
816
                'editMessageCaption',
817
                'editMessageMedia',
818
                'editMessageReplyMarkup',
819
                'stopPoll',
820
                'setChatTitle',
821
                'setChatDescription',
822
                'setChatStickerSet',
823
                'deleteChatStickerSet',
824
                'setPassportDataErrors',
825
            ];
826
827
            $chat_id           = isset($data['chat_id']) ? $data['chat_id'] : null;
828
            $inline_message_id = isset($data['inline_message_id']) ? $data['inline_message_id'] : null;
829
830
            if (($chat_id || $inline_message_id) && in_array($action, $limited_methods, true)) {
831
                $timeout = 60;
832
833
                while (true) {
834
                    if ($timeout <= 0) {
835
                        throw new TelegramException('Timed out while waiting for a request spot!');
836
                    }
837
838
                    if (!($requests = DB::getTelegramRequestCount($chat_id, $inline_message_id))) {
839
                        break;
840
                    }
841
842
                    // Make sure we're handling integers here.
843
                    $requests = array_map('intval', $requests);
844
845
                    $chat_per_second   = ($requests['LIMIT_PER_SEC'] === 0);    // No more than one message per second inside a particular chat
846
                    $global_per_second = ($requests['LIMIT_PER_SEC_ALL'] < 30); // No more than 30 messages per second to different chats
847
                    $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
848
849
                    if ($chat_per_second && $global_per_second && $groups_per_minute) {
850
                        break;
851
                    }
852
853
                    $timeout--;
854
                    usleep((int) (self::$limiter_interval * 1000000));
855
                }
856
857
                DB::insertTelegramRequest($action, $data);
858
            }
859
        }
860
    }
861
}
862