Completed
Push — master ( 2cfb8a...1785d9 )
by Armando
07:47 queued 02:48
created

Request::setUpRequestParams()   B

Complexity

Conditions 10
Paths 22

Size

Total Lines 30

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 110

Importance

Changes 0
Metric Value
dl 0
loc 30
ccs 0
cts 14
cp 0
rs 7.6666
c 0
b 0
f 0
cc 10
nc 22
nop 1
crap 110

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

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
449
                $media_item->raw_data['media'] = 'attach://' . $rnd_key;
0 ignored issues
show
Bug introduced by
Accessing raw_data on the interface Longman\TelegramBot\Entities\InputMedia\InputMedia suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
450
            }
451
        }
452
453
        $was_array || $item = reset($item);
454
455
        return json_encode($item);
456
    }
457
458
    /**
459
     * Get the current action that's being executed
460
     *
461
     * @return string
462
     */
463
    public static function getCurrentAction()
464
    {
465
        return self::$current_action;
466
    }
467
468
    /**
469
     * Execute HTTP Request
470
     *
471
     * @param string $action Action to execute
472
     * @param array  $data   Data to attach to the execution
473
     *
474
     * @return string Result of the HTTP Request
475
     * @throws \Longman\TelegramBot\Exception\TelegramException
476
     */
477
    public static function execute($action, array $data = [])
478
    {
479
        //Fix so that the keyboard markup is a string, not an object
480
        if (isset($data['reply_markup'])) {
481
            $data['reply_markup'] = json_encode($data['reply_markup']);
482
        }
483
484
        $result                  = null;
485
        $request_params          = self::setUpRequestParams($data);
486
        $request_params['debug'] = TelegramLog::getDebugLogTempStream();
487
488
        try {
489
            $response = self::$client->post(
490
                '/bot' . self::$telegram->getApiKey() . '/' . $action,
491
                $request_params
492
            );
493
            $result   = (string) $response->getBody();
494
495
            //Logging getUpdates Update
496
            if ($action === 'getUpdates') {
497
                TelegramLog::update($result);
498
            }
499
        } catch (RequestException $e) {
500
            $result = $e->getResponse() ? (string) $e->getResponse()->getBody() : '';
501
        } finally {
502
            //Logging verbose debug output
503
            TelegramLog::endDebugLogTempStream('Verbose HTTP Request output:' . PHP_EOL . '%s' . PHP_EOL);
504
        }
505
506
        return $result;
507
    }
508
509
    /**
510
     * Download file
511
     *
512
     * @param \Longman\TelegramBot\Entities\File $file
513
     *
514
     * @return boolean
515
     * @throws \Longman\TelegramBot\Exception\TelegramException
516
     */
517
    public static function downloadFile(File $file)
518
    {
519
        if (empty($download_path = self::$telegram->getDownloadPath())) {
520
            throw new TelegramException('Download path not set!');
521
        }
522
523
        $tg_file_path = $file->getFilePath();
524
        $file_path    = $download_path . '/' . $tg_file_path;
525
526
        $file_dir = dirname($file_path);
527
        //For safety reasons, first try to create the directory, then check that it exists.
528
        //This is in case some other process has created the folder in the meantime.
529
        if (!@mkdir($file_dir, 0755, true) && !is_dir($file_dir)) {
530
            throw new TelegramException('Directory ' . $file_dir . ' can\'t be created');
531
        }
532
533
        $debug_handle = TelegramLog::getDebugLogTempStream();
534
535
        try {
536
            self::$client->get(
537
                '/file/bot' . self::$telegram->getApiKey() . '/' . $tg_file_path,
538
                ['debug' => $debug_handle, 'sink' => $file_path]
539
            );
540
541
            return filesize($file_path) > 0;
542
        } catch (RequestException $e) {
543
            return ($e->getResponse()) ? (string) $e->getResponse()->getBody() : '';
544
        } finally {
545
            //Logging verbose debug output
546
            TelegramLog::endDebugLogTempStream('Verbose HTTP File Download Request output:' . PHP_EOL . '%s' . PHP_EOL);
547
        }
548
    }
549
550
    /**
551
     * Encode file
552
     *
553
     * @param string $file
554
     *
555
     * @return resource
556
     * @throws \Longman\TelegramBot\Exception\TelegramException
557
     */
558
    public static function encodeFile($file)
559
    {
560
        $fp = fopen($file, 'rb');
561
        if ($fp === false) {
562
            throw new TelegramException('Cannot open "' . $file . '" for reading');
563
        }
564
565
        return $fp;
566
    }
567
568
    /**
569
     * Send command
570
     *
571
     * @todo Fake response doesn't need json encoding?
572
     * @todo Write debug entry on failure
573
     *
574
     * @param string $action
575
     * @param array  $data
576
     *
577
     * @return \Longman\TelegramBot\Entities\ServerResponse
578
     * @throws \Longman\TelegramBot\Exception\TelegramException
579
     */
580
    public static function send($action, array $data = [])
581
    {
582
        self::ensureValidAction($action);
583
        self::addDummyParamIfNecessary($action, $data);
584
585
        $bot_username = self::$telegram->getBotUsername();
586
587
        if (defined('PHPUNIT_TESTSUITE')) {
588
            $fake_response = self::generateGeneralFakeServerResponse($data);
589
590
            return new ServerResponse($fake_response, $bot_username);
591
        }
592
593
        self::ensureNonEmptyData($data);
594
595
        self::limitTelegramRequests($action, $data);
596
597
        // Remember which action is currently being executed.
598
        self::$current_action = $action;
599
600
        $raw_response = self::execute($action, $data);
601
        $response     = json_decode($raw_response, true);
602
603
        if (null === $response) {
604
            TelegramLog::debug($raw_response);
605
            throw new TelegramException('Telegram returned an invalid response!');
606
        }
607
608
        $response = new ServerResponse($response, $bot_username);
609
610
        if (!$response->isOk() && $response->getErrorCode() === 401 && $response->getDescription() === 'Unauthorized') {
611
            throw new InvalidBotTokenException();
612
        }
613
614
        // Reset current action after completion.
615
        self::$current_action = null;
616
617
        return $response;
618
    }
619
620
    /**
621
     * Add a dummy parameter if the passed action requires it.
622
     *
623
     * If a method doesn't require parameters, we need to add a dummy one anyway,
624
     * because of some cURL version failed POST request without parameters.
625
     *
626
     * @link https://github.com/php-telegram-bot/core/pull/228
627
     *
628
     * @todo Would be nice to find a better solution for this!
629
     *
630
     * @param string $action
631
     * @param array  $data
632
     */
633
    protected static function addDummyParamIfNecessary($action, array &$data)
634
    {
635
        if (in_array($action, self::$actions_need_dummy_param, true)) {
636
            // Can be anything, using a single letter to minimise request size.
637
            $data = ['d'];
638
        }
639
    }
640
641
    /**
642
     * Make sure the data isn't empty, else throw an exception
643
     *
644
     * @param array $data
645
     *
646
     * @throws \Longman\TelegramBot\Exception\TelegramException
647
     */
648
    private static function ensureNonEmptyData(array $data)
649
    {
650
        if (count($data) === 0) {
651
            throw new TelegramException('Data is empty!');
652
        }
653
    }
654
655
    /**
656
     * Make sure the action is valid, else throw an exception
657
     *
658
     * @param string $action
659
     *
660
     * @throws \Longman\TelegramBot\Exception\TelegramException
661
     */
662
    private static function ensureValidAction($action)
663
    {
664
        if (!in_array($action, self::$actions, true)) {
665
            throw new TelegramException('The action "' . $action . '" doesn\'t exist!');
666
        }
667
    }
668
669
    /**
670
     * Use this method to send text messages. On success, the sent Message is returned
671
     *
672
     * @link https://core.telegram.org/bots/api#sendmessage
673
     *
674
     * @param array $data
675
     *
676
     * @return \Longman\TelegramBot\Entities\ServerResponse
677
     * @throws \Longman\TelegramBot\Exception\TelegramException
678
     */
679
    public static function sendMessage(array $data)
680
    {
681
        $text = $data['text'];
682
683
        do {
684
            //Chop off and send the first message
685
            $data['text'] = mb_substr($text, 0, 4096);
686
            $response     = self::send('sendMessage', $data);
687
688
            //Prepare the next message
689
            $text = mb_substr($text, 4096);
690
        } while (mb_strlen($text, 'UTF-8') > 0);
691
692
        return $response;
693
    }
694
695
    /**
696
     * Any statically called method should be relayed to the `send` method.
697
     *
698
     * @param string $action
699
     * @param array  $data
700
     *
701
     * @return \Longman\TelegramBot\Entities\ServerResponse
702
     * @throws \Longman\TelegramBot\Exception\TelegramException
703
     */
704
    public static function __callStatic($action, array $data)
705
    {
706
        // Make sure to add the action being called as the first parameter to be passed.
707
        array_unshift($data, $action);
708
709
        // @todo Use splat operator for unpacking when we move to PHP 5.6+
710
        return call_user_func_array('static::send', $data);
711
    }
712
713
    /**
714
     * Return an empty Server Response
715
     *
716
     * No request to telegram are sent, this function is used in commands that
717
     * don't need to fire a message after execution
718
     *
719
     * @return \Longman\TelegramBot\Entities\ServerResponse
720
     * @throws \Longman\TelegramBot\Exception\TelegramException
721
     */
722
    public static function emptyResponse()
723
    {
724
        return new ServerResponse(['ok' => true, 'result' => true], null);
725
    }
726
727
    /**
728
     * Send message to all active chats
729
     *
730
     * @param string $callback_function
731
     * @param array  $data
732
     * @param array  $select_chats_params
733
     *
734
     * @return array
735
     * @throws TelegramException
736
     */
737
    public static function sendToActiveChats(
738
        $callback_function,
739
        array $data,
740
        array $select_chats_params
741
    ) {
742
        self::ensureValidAction($callback_function);
743
744
        $chats = DB::selectChats($select_chats_params);
745
746
        $results = [];
747
        if (is_array($chats)) {
748
            foreach ($chats as $row) {
749
                $data['chat_id'] = $row['chat_id'];
750
                $results[]       = self::send($callback_function, $data);
751
            }
752
        }
753
754
        return $results;
755
    }
756
757
    /**
758
     * Enable request limiter
759
     *
760
     * @param boolean $enable
761
     * @param array   $options
762
     *
763
     * @throws \Longman\TelegramBot\Exception\TelegramException
764
     */
765
    public static function setLimiter($enable = true, array $options = [])
766
    {
767
        if (DB::isDbConnected()) {
768
            $options_default = [
769
                'interval' => 1,
770
            ];
771
772
            $options = array_merge($options_default, $options);
773
774
            if (!is_numeric($options['interval']) || $options['interval'] <= 0) {
775
                throw new TelegramException('Interval must be a number and must be greater than zero!');
776
            }
777
778
            self::$limiter_interval = $options['interval'];
0 ignored issues
show
Documentation Bug introduced by
It seems like $options['interval'] can also be of type integer or string. However, the property $limiter_interval is declared as type double. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
779
            self::$limiter_enabled  = $enable;
780
        }
781
    }
782
783
    /**
784
     * This functions delays API requests to prevent reaching Telegram API limits
785
     *  Can be disabled while in execution by 'Request::setLimiter(false)'
786
     *
787
     * @link https://core.telegram.org/bots/faq#my-bot-is-hitting-limits-how-do-i-avoid-this
788
     *
789
     * @param string $action
790
     * @param array  $data
791
     *
792
     * @throws \Longman\TelegramBot\Exception\TelegramException
793
     */
794
    private static function limitTelegramRequests($action, array $data = [])
795
    {
796
        if (self::$limiter_enabled) {
797
            $limited_methods = [
798
                'sendMessage',
799
                'forwardMessage',
800
                'sendPhoto',
801
                'sendAudio',
802
                'sendDocument',
803
                'sendSticker',
804
                'sendVideo',
805
                'sendAnimation',
806
                'sendVoice',
807
                'sendVideoNote',
808
                'sendMediaGroup',
809
                'sendLocation',
810
                'editMessageLiveLocation',
811
                'stopMessageLiveLocation',
812
                'sendVenue',
813
                'sendContact',
814
                'sendPoll',
815
                'sendInvoice',
816
                'sendGame',
817
                'setGameScore',
818
                'editMessageText',
819
                'editMessageCaption',
820
                'editMessageMedia',
821
                'editMessageReplyMarkup',
822
                'stopPoll',
823
                'setChatTitle',
824
                'setChatDescription',
825
                'setChatStickerSet',
826
                'deleteChatStickerSet',
827
                'setPassportDataErrors',
828
            ];
829
830
            $chat_id           = isset($data['chat_id']) ? $data['chat_id'] : null;
831
            $inline_message_id = isset($data['inline_message_id']) ? $data['inline_message_id'] : null;
832
833
            if (($chat_id || $inline_message_id) && in_array($action, $limited_methods)) {
834
                $timeout = 60;
835
836
                while (true) {
837
                    if ($timeout <= 0) {
838
                        throw new TelegramException('Timed out while waiting for a request spot!');
839
                    }
840
841
                    $requests = DB::getTelegramRequestCount($chat_id, $inline_message_id);
842
843
                    $chat_per_second   = ($requests['LIMIT_PER_SEC'] == 0); // No more than one message per second inside a particular chat
844
                    $global_per_second = ($requests['LIMIT_PER_SEC_ALL'] < 30);    // No more than 30 messages per second to different chats
845
                    $groups_per_minute = (((is_numeric($chat_id) && $chat_id > 0) || !is_null($inline_message_id)) || ((!is_numeric($chat_id) || $chat_id < 0) && $requests['LIMIT_PER_MINUTE'] < 20));    // No more than 20 messages per minute in groups and channels
846
847
                    if ($chat_per_second && $global_per_second && $groups_per_minute) {
848
                        break;
849
                    }
850
851
                    $timeout--;
852
                    usleep(self::$limiter_interval * 1000000);
853
                }
854
855
                DB::insertTelegramRequest($action, $data);
856
            }
857
        }
858
    }
859
}
860