Completed
Push — 811-helper_for_media_groups ( c599d5...2499c6 )
by Armando
02:40
created

Request::send()   B

Complexity

Conditions 6
Paths 4

Size

Total Lines 39

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 42

Importance

Changes 0
Metric Value
dl 0
loc 39
ccs 0
cts 20
cp 0
rs 8.6737
c 0
b 0
f 0
cc 6
nc 4
nop 2
crap 42
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 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.
46
 * @method static ServerResponse getUserProfilePhotos(array $data)    Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
47
 * @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.
48
 * @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.
49
 * @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.
50
 * @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.
51
 * @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.
52
 * @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.
53
 * @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.
54
 * @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.
55
 * @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.
56
 * @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.
57
 * @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.
58
 * @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.
59
 * @method static ServerResponse leaveChat(array $data)               Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
60
 * @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.
61
 * @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.
62
 * @method static ServerResponse getChatMembersCount(array $data)     Use this method to get the number of members in a chat. Returns Int on success.
63
 * @method static ServerResponse getChatMember(array $data)           Use this method to get information about a member of a chat. Returns a ChatMember object on success.
64
 * @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.
65
 * @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.
66
 * @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.
67
 * @method static ServerResponse answerInlineQuery(array $data)       Use this method to send answers to an inline query. On success, True is returned.
68
 * @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.
69
 * @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.
70
 * @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.
71
 * @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.
72
 * @method static ServerResponse deleteMessage(array $data)           Use this method to delete a message, including service messages, with certain limitations. Returns True on success.
73
 * @method static ServerResponse getStickerSet(array $data)           Use this method to get a sticker set. On success, a StickerSet object is returned.
74
 * @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.
75
 * @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.
76
 * @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.
77
 * @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.
78
 * @method static ServerResponse deleteStickerFromSet(array $data)    Use this method to delete a sticker from a set created by the bot. Returns True on success.
79
 * @method static ServerResponse sendInvoice(array $data)             Use this method to send invoices. On success, the sent Message is returned.
80
 * @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.
81
 * @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.
82
 * @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.
83
 * @method static ServerResponse sendGame(array $data)                Use this method to send a game. On success, the sent Message is returned.
84
 * @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.
85
 * @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.
86
 */
87
class Request
88
{
89
    /**
90
     * Telegram object
91
     *
92
     * @var \Longman\TelegramBot\Telegram
93
     */
94
    private static $telegram;
95
96
    /**
97
     * URI of the Telegram API
98
     *
99
     * @var string
100
     */
101
    private static $api_base_uri = 'https://api.telegram.org';
102
103
    /**
104
     * Guzzle Client object
105
     *
106
     * @var \GuzzleHttp\Client
107
     */
108
    private static $client;
109
110
    /**
111
     * Input value of the request
112
     *
113
     * @var string
114
     */
115
    private static $input;
116
117
    /**
118
     * Request limiter
119
     *
120
     * @var boolean
121
     */
122
    private static $limiter_enabled;
123
124
    /**
125
     * Request limiter's interval between checks
126
     *
127
     * @var float
128
     */
129
    private static $limiter_interval;
130
131
    /**
132
     * Get the current action that is being executed
133
     *
134
     * @var string
135
     */
136
    private static $current_action;
137
138
    /**
139
     * Available actions to send
140
     *
141
     * This is basically the list of all methods listed on the official API documentation.
142
     *
143
     * @link https://core.telegram.org/bots/api
144
     *
145
     * @var array
146
     */
147
    private static $actions = [
148
        'getUpdates',
149
        'setWebhook',
150
        'deleteWebhook',
151
        'getWebhookInfo',
152
        'getMe',
153
        'sendMessage',
154
        'forwardMessage',
155
        'sendPhoto',
156
        'sendAudio',
157
        'sendDocument',
158
        'sendSticker',
159
        'sendVideo',
160
        'sendAnimation',
161
        'sendVoice',
162
        'sendVideoNote',
163
        'sendMediaGroup',
164
        'sendLocation',
165
        'editMessageLiveLocation',
166
        'stopMessageLiveLocation',
167
        'sendVenue',
168
        'sendContact',
169
        'sendChatAction',
170
        'getUserProfilePhotos',
171
        'getFile',
172
        'kickChatMember',
173
        'unbanChatMember',
174
        'restrictChatMember',
175
        'promoteChatMember',
176
        'exportChatInviteLink',
177
        'setChatPhoto',
178
        'deleteChatPhoto',
179
        'setChatTitle',
180
        'setChatDescription',
181
        'pinChatMessage',
182
        'unpinChatMessage',
183
        'leaveChat',
184
        'getChat',
185
        'getChatAdministrators',
186
        'getChatMembersCount',
187
        'getChatMember',
188
        'setChatStickerSet',
189
        'deleteChatStickerSet',
190
        'answerCallbackQuery',
191
        'answerInlineQuery',
192
        'editMessageText',
193
        'editMessageCaption',
194
        'editMessageMedia',
195
        'editMessageReplyMarkup',
196
        'deleteMessage',
197
        'getStickerSet',
198
        'uploadStickerFile',
199
        'createNewStickerSet',
200
        'addStickerToSet',
201
        'setStickerPositionInSet',
202
        'deleteStickerFromSet',
203
        'sendInvoice',
204
        'answerShippingQuery',
205
        'answerPreCheckoutQuery',
206
        'setPassportDataErrors',
207
        'sendGame',
208
        'setGameScore',
209
        'getGameHighScores',
210
    ];
211
212
    /**
213
     * Some methods need a dummy param due to certain cURL issues.
214
     *
215
     * @see Request::addDummyParamIfNecessary()
216
     *
217
     * @var array
218
     */
219
    private static $actions_need_dummy_param = [
220
        'deleteWebhook',
221
        'getWebhookInfo',
222
        'getMe',
223
    ];
224
225
    /**
226
     * Initialize
227
     *
228
     * @param \Longman\TelegramBot\Telegram $telegram
229
     *
230
     * @throws TelegramException
231
     */
232 30
    public static function initialize(Telegram $telegram)
233
    {
234 30
        if (!($telegram instanceof Telegram)) {
235
            throw new TelegramException('Invalid Telegram pointer!');
236
        }
237
238 30
        self::$telegram = $telegram;
239 30
        self::setClient(new Client(['base_uri' => self::$api_base_uri]));
240 30
    }
241
242
    /**
243
     * Set a custom Guzzle HTTP Client object
244
     *
245
     * @param Client $client
246
     *
247
     * @throws TelegramException
248
     */
249 30
    public static function setClient(Client $client)
250
    {
251 30
        if (!($client instanceof Client)) {
252
            throw new TelegramException('Invalid GuzzleHttp\Client pointer!');
253
        }
254
255 30
        self::$client = $client;
256 30
    }
257
258
    /**
259
     * Set input from custom input or stdin and return it
260
     *
261
     * @return string
262
     * @throws \Longman\TelegramBot\Exception\TelegramException
263
     */
264
    public static function getInput()
265
    {
266
        // First check if a custom input has been set, else get the PHP input.
267
        if (!($input = self::$telegram->getCustomInput())) {
268
            $input = file_get_contents('php://input');
269
        }
270
271
        // Make sure we have a string to work with.
272
        if (!is_string($input)) {
273
            throw new TelegramException('Input must be a string!');
274
        }
275
276
        self::$input = $input;
277
278
        TelegramLog::update(self::$input);
279
280
        return self::$input;
281
    }
282
283
    /**
284
     * Generate general fake server response
285
     *
286
     * @param array $data Data to add to fake response
287
     *
288
     * @return array Fake response data
289
     */
290 1
    public static function generateGeneralFakeServerResponse(array $data = [])
291
    {
292
        //PARAM BINDED IN PHPUNIT TEST FOR TestServerResponse.php
293
        //Maybe this is not the best possible implementation
294
295
        //No value set in $data ie testing setWebhook
296
        //Provided $data['chat_id'] ie testing sendMessage
297
298 1
        $fake_response = ['ok' => true]; // :)
299
300 1
        if ($data === []) {
301 1
            $fake_response['result'] = true;
302
        }
303
304
        //some data to let iniatilize the class method SendMessage
305 1
        if (isset($data['chat_id'])) {
306 1
            $data['message_id'] = '1234';
307 1
            $data['date']       = '1441378360';
308 1
            $data['from']       = [
309
                'id'         => 123456789,
310
                'first_name' => 'botname',
311
                'username'   => 'namebot',
312
            ];
313 1
            $data['chat']       = ['id' => $data['chat_id']];
314
315 1
            $fake_response['result'] = $data;
316
        }
317
318 1
        return $fake_response;
319
    }
320
321
    /**
322
     * Properly set up the request params
323
     *
324
     * If any item of the array is a resource, reformat it to a multipart request.
325
     * Else, just return the passed data as form params.
326
     *
327
     * @param array $data
328
     *
329
     * @return array
330
     */
331
    private static function setUpRequestParams(array $data)
332
    {
333
        $has_resource = false;
334
        $multipart    = [];
335
336
        foreach ($data as $key => &$item) {
337
            if ($key === 'media') {
338
                // Magical media input helper.
339
                $item = self::mediaInputHelper($item, $has_resource, $multipart);
340
            } elseif (is_array($item)) {
341
                // Convert any nested arrays into JSON strings.
342
                $item = json_encode($item);
343
            }
344
345
            // Reformat data array in multipart way if it contains a resource
346
            $has_resource |= (is_resource($item) || $item instanceof Stream);
347
            $multipart[]  = ['name' => $key, 'contents' => $item];
348
        }
349
350
        if ($has_resource) {
351
            return ['multipart' => $multipart];
352
        }
353
354
        return ['form_params' => $data];
355
    }
356
357
    /**
358
     * Magical input media helper to simplify passing media.
359
     *
360
     * This allows the following:
361
     * Request::editMessageMedia([
362
     *     ...
363
     *     'media' => new InputMediaPhoto([
364
     *         'caption' => 'Caption!',
365
     *         'media'   => Request::encodeFile($local_photo),
366
     *     ]),
367
     * ]);
368
     * and
369
     * Request::sendMediaGroup([
370
     *     'media'   => [
371
     *         new InputMediaPhoto(['media' => Request::encodeFile($photo_1)]),
372
     *         new InputMediaPhoto(['media' => Request::encodeFile($photo_2)]),
373
     *         new InputMediaVideo(['media' => Request::encodeFile($video_1)]),
374
     *     ],
375
     * ]);
376
     *
377
     * @param mixed $item
378
     * @param bool  $has_resource
379
     * @param array $multipart
380
     *
381
     * @return mixed
382
     */
383
    private static function mediaInputHelper($item, &$has_resource, array &$multipart)
384
    {
385
        $was_array = is_array($item);
386
        $was_array || $item = [$item];
387
388
        foreach ($item as $media_item) {
389
            if (!($media_item instanceof InputMedia)) {
390
                continue;
391
            }
392
393
            $media = $media_item->getMedia();
394
            if (is_resource($media) || $media instanceof Stream) {
395
                $has_resource = true;
396
                $rnd_key      = uniqid('media_', false);
397
                $multipart[]  = ['name' => $rnd_key, 'contents' => $media];
398
399
                // We're literally overwriting the passed media data!
400
                $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...
401
                $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...
402
            }
403
        }
404
405
        $was_array || $item = reset($item);
406
407
        return json_encode($item);
408
    }
409
410
    /**
411
     * Get the current action that's being executed
412
     *
413
     * @return string
414
     */
415 7
    public static function getCurrentAction()
416
    {
417 7
        return self::$current_action;
418
    }
419
420
    /**
421
     * Execute HTTP Request
422
     *
423
     * @param string $action Action to execute
424
     * @param array  $data   Data to attach to the execution
425
     *
426
     * @return string Result of the HTTP Request
427
     * @throws \Longman\TelegramBot\Exception\TelegramException
428
     */
429
    public static function execute($action, array $data = [])
430
    {
431
        //Fix so that the keyboard markup is a string, not an object
432
        if (isset($data['reply_markup'])) {
433
            $data['reply_markup'] = json_encode($data['reply_markup']);
434
        }
435
436
        $result                  = null;
437
        $request_params          = self::setUpRequestParams($data);
438
        $request_params['debug'] = TelegramLog::getDebugLogTempStream();
439
440
        try {
441
            $response = self::$client->post(
442
                '/bot' . self::$telegram->getApiKey() . '/' . $action,
443
                $request_params
444
            );
445
            $result   = (string) $response->getBody();
446
447
            //Logging getUpdates Update
448
            if ($action === 'getUpdates') {
449
                TelegramLog::update($result);
450
            }
451
        } catch (RequestException $e) {
452
            $result = $e->getResponse() ? (string) $e->getResponse()->getBody() : '';
453
        } finally {
454
            //Logging verbose debug output
455
            TelegramLog::endDebugLogTempStream('Verbose HTTP Request output:' . PHP_EOL . '%s' . PHP_EOL);
456
        }
457
458
        return $result;
459
    }
460
461
    /**
462
     * Download file
463
     *
464
     * @param \Longman\TelegramBot\Entities\File $file
465
     *
466
     * @return boolean
467
     * @throws \Longman\TelegramBot\Exception\TelegramException
468
     */
469
    public static function downloadFile(File $file)
470
    {
471
        if (empty($download_path = self::$telegram->getDownloadPath())) {
472
            throw new TelegramException('Download path not set!');
473
        }
474
475
        $tg_file_path = $file->getFilePath();
476
        $file_path    = $download_path . '/' . $tg_file_path;
477
478
        $file_dir = dirname($file_path);
479
        //For safety reasons, first try to create the directory, then check that it exists.
480
        //This is in case some other process has created the folder in the meantime.
481
        if (!@mkdir($file_dir, 0755, true) && !is_dir($file_dir)) {
482
            throw new TelegramException('Directory ' . $file_dir . ' can\'t be created');
483
        }
484
485
        $debug_handle = TelegramLog::getDebugLogTempStream();
486
487
        try {
488
            self::$client->get(
489
                '/file/bot' . self::$telegram->getApiKey() . '/' . $tg_file_path,
490
                ['debug' => $debug_handle, 'sink' => $file_path]
491
            );
492
493
            return filesize($file_path) > 0;
494
        } catch (RequestException $e) {
495
            return ($e->getResponse()) ? (string) $e->getResponse()->getBody() : '';
496
        } finally {
497
            //Logging verbose debug output
498
            TelegramLog::endDebugLogTempStream('Verbose HTTP File Download Request output:' . PHP_EOL . '%s' . PHP_EOL);
499
        }
500
    }
501
502
    /**
503
     * Encode file
504
     *
505
     * @param string $file
506
     *
507
     * @return resource
508
     * @throws \Longman\TelegramBot\Exception\TelegramException
509
     */
510
    public static function encodeFile($file)
511
    {
512
        $fp = fopen($file, 'rb');
513
        if ($fp === false) {
514
            throw new TelegramException('Cannot open "' . $file . '" for reading');
515
        }
516
517
        return $fp;
518
    }
519
520
    /**
521
     * Send command
522
     *
523
     * @todo Fake response doesn't need json encoding?
524
     * @todo Write debug entry on failure
525
     *
526
     * @param string $action
527
     * @param array  $data
528
     *
529
     * @return \Longman\TelegramBot\Entities\ServerResponse
530
     * @throws \Longman\TelegramBot\Exception\TelegramException
531
     */
532
    public static function send($action, array $data = [])
533
    {
534
        self::ensureValidAction($action);
535
        self::addDummyParamIfNecessary($action, $data);
536
537
        $bot_username = self::$telegram->getBotUsername();
538
539
        if (defined('PHPUNIT_TESTSUITE')) {
540
            $fake_response = self::generateGeneralFakeServerResponse($data);
541
542
            return new ServerResponse($fake_response, $bot_username);
543
        }
544
545
        self::ensureNonEmptyData($data);
546
547
        self::limitTelegramRequests($action, $data);
548
549
        // Remember which action is currently being executed.
550
        self::$current_action = $action;
551
552
        $raw_response = self::execute($action, $data);
553
        $response     = json_decode($raw_response, true);
554
555
        if (null === $response) {
556
            TelegramLog::debug($raw_response);
557
            throw new TelegramException('Telegram returned an invalid response!');
558
        }
559
560
        $response = new ServerResponse($response, $bot_username);
561
562
        if (!$response->isOk() && $response->getErrorCode() === 401 && $response->getDescription() === 'Unauthorized') {
563
            throw new InvalidBotTokenException();
564
        }
565
566
        // Reset current action after completion.
567
        self::$current_action = null;
568
569
        return $response;
570
    }
571
572
    /**
573
     * Add a dummy parameter if the passed action requires it.
574
     *
575
     * If a method doesn't require parameters, we need to add a dummy one anyway,
576
     * because of some cURL version failed POST request without parameters.
577
     *
578
     * @link https://github.com/php-telegram-bot/core/pull/228
579
     *
580
     * @todo Would be nice to find a better solution for this!
581
     *
582
     * @param string $action
583
     * @param array  $data
584
     */
585
    protected static function addDummyParamIfNecessary($action, array &$data)
586
    {
587
        if (in_array($action, self::$actions_need_dummy_param, true)) {
588
            // Can be anything, using a single letter to minimise request size.
589
            $data = ['d'];
590
        }
591
    }
592
593
    /**
594
     * Make sure the data isn't empty, else throw an exception
595
     *
596
     * @param array $data
597
     *
598
     * @throws \Longman\TelegramBot\Exception\TelegramException
599
     */
600
    private static function ensureNonEmptyData(array $data)
601
    {
602
        if (count($data) === 0) {
603
            throw new TelegramException('Data is empty!');
604
        }
605
    }
606
607
    /**
608
     * Make sure the action is valid, else throw an exception
609
     *
610
     * @param string $action
611
     *
612
     * @throws \Longman\TelegramBot\Exception\TelegramException
613
     */
614
    private static function ensureValidAction($action)
615
    {
616
        if (!in_array($action, self::$actions, true)) {
617
            throw new TelegramException('The action "' . $action . '" doesn\'t exist!');
618
        }
619
    }
620
621
    /**
622
     * Use this method to send text messages. On success, the sent Message is returned
623
     *
624
     * @link https://core.telegram.org/bots/api#sendmessage
625
     *
626
     * @param array $data
627
     *
628
     * @return \Longman\TelegramBot\Entities\ServerResponse
629
     * @throws \Longman\TelegramBot\Exception\TelegramException
630
     */
631
    public static function sendMessage(array $data)
632
    {
633
        $text = $data['text'];
634
635
        do {
636
            //Chop off and send the first message
637
            $data['text'] = mb_substr($text, 0, 4096);
638
            $response     = self::send('sendMessage', $data);
639
640
            //Prepare the next message
641
            $text = mb_substr($text, 4096);
642
        } while (mb_strlen($text, 'UTF-8') > 0);
643
644
        return $response;
645
    }
646
647
    /**
648
     * Any statically called method should be relayed to the `send` method.
649
     *
650
     * @param string $action
651
     * @param array  $data
652
     *
653
     * @return \Longman\TelegramBot\Entities\ServerResponse
654
     * @throws \Longman\TelegramBot\Exception\TelegramException
655
     */
656
    public static function __callStatic($action, array $data)
657
    {
658
        // Make sure to add the action being called as the first parameter to be passed.
659
        array_unshift($data, $action);
660
661
        // @todo Use splat operator for unpacking when we move to PHP 5.6+
662
        return call_user_func_array('static::send', $data);
663
    }
664
665
    /**
666
     * Return an empty Server Response
667
     *
668
     * No request to telegram are sent, this function is used in commands that
669
     * don't need to fire a message after execution
670
     *
671
     * @return \Longman\TelegramBot\Entities\ServerResponse
672
     * @throws \Longman\TelegramBot\Exception\TelegramException
673
     */
674
    public static function emptyResponse()
675
    {
676
        return new ServerResponse(['ok' => true, 'result' => true], null);
677
    }
678
679
    /**
680
     * Send message to all active chats
681
     *
682
     * @param string $callback_function
683
     * @param array  $data
684
     * @param array  $select_chats_params
685
     *
686
     * @return array
687
     * @throws TelegramException
688
     */
689
    public static function sendToActiveChats(
690
        $callback_function,
691
        array $data,
692
        array $select_chats_params
693
    ) {
694
        self::ensureValidAction($callback_function);
695
696
        $chats = DB::selectChats($select_chats_params);
697
698
        $results = [];
699
        if (is_array($chats)) {
700
            foreach ($chats as $row) {
701
                $data['chat_id'] = $row['chat_id'];
702
                $results[]       = self::send($callback_function, $data);
703
            }
704
        }
705
706
        return $results;
707
    }
708
709
    /**
710
     * Enable request limiter
711
     *
712
     * @param boolean $enable
713
     * @param array   $options
714
     *
715
     * @throws \Longman\TelegramBot\Exception\TelegramException
716
     */
717
    public static function setLimiter($enable = true, array $options = [])
718
    {
719
        if (DB::isDbConnected()) {
720
            $options_default = [
721
                'interval' => 1,
722
            ];
723
724
            $options = array_merge($options_default, $options);
725
726
            if (!is_numeric($options['interval']) || $options['interval'] <= 0) {
727
                throw new TelegramException('Interval must be a number and must be greater than zero!');
728
            }
729
730
            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...
731
            self::$limiter_enabled  = $enable;
732
        }
733
    }
734
735
    /**
736
     * This functions delays API requests to prevent reaching Telegram API limits
737
     *  Can be disabled while in execution by 'Request::setLimiter(false)'
738
     *
739
     * @link https://core.telegram.org/bots/faq#my-bot-is-hitting-limits-how-do-i-avoid-this
740
     *
741
     * @param string $action
742
     * @param array  $data
743
     *
744
     * @throws \Longman\TelegramBot\Exception\TelegramException
745
     */
746
    private static function limitTelegramRequests($action, array $data = [])
747
    {
748
        if (self::$limiter_enabled) {
749
            $limited_methods = [
750
                'sendMessage',
751
                'forwardMessage',
752
                'sendPhoto',
753
                'sendAudio',
754
                'sendDocument',
755
                'sendSticker',
756
                'sendVideo',
757
                'sendAnimation',
758
                'sendVoice',
759
                'sendVideoNote',
760
                'sendMediaGroup',
761
                'sendLocation',
762
                'editMessageLiveLocation',
763
                'stopMessageLiveLocation',
764
                'sendVenue',
765
                'sendContact',
766
                'sendInvoice',
767
                'sendGame',
768
                'setGameScore',
769
                'editMessageText',
770
                'editMessageCaption',
771
                'editMessageMedia',
772
                'editMessageReplyMarkup',
773
                'setChatTitle',
774
                'setChatDescription',
775
                'setChatStickerSet',
776
                'deleteChatStickerSet',
777
                'setPassportDataErrors',
778
            ];
779
780
            $chat_id           = isset($data['chat_id']) ? $data['chat_id'] : null;
781
            $inline_message_id = isset($data['inline_message_id']) ? $data['inline_message_id'] : null;
782
783
            if (($chat_id || $inline_message_id) && in_array($action, $limited_methods)) {
784
                $timeout = 60;
785
786
                while (true) {
787
                    if ($timeout <= 0) {
788
                        throw new TelegramException('Timed out while waiting for a request spot!');
789
                    }
790
791
                    $requests = DB::getTelegramRequestCount($chat_id, $inline_message_id);
792
793
                    $chat_per_second   = ($requests['LIMIT_PER_SEC'] == 0); // No more than one message per second inside a particular chat
794
                    $global_per_second = ($requests['LIMIT_PER_SEC_ALL'] < 30);    // No more than 30 messages per second to different chats
795
                    $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
796
797
                    if ($chat_per_second && $global_per_second && $groups_per_minute) {
798
                        break;
799
                    }
800
801
                    $timeout--;
802
                    usleep(self::$limiter_interval * 1000000);
803
                }
804
805
                DB::insertTelegramRequest($action, $data);
806
            }
807
        }
808
    }
809
}
810