Add optional parameter 'interval' to modify check interval for request limiter

Author: jacklul

examples/cron.php

@@ -64,7 +64,9 @@
     //$telegram->setUploadPath('../Upload');
 
     // Requests Limiter (tries to prevent reaching Telegram API limits)
+    // Second argument are options
     $telegram->enableLimiter();
+    //$telegram->enableLimiter(['interval' => 0.5);
 
     // Run user selected commands
     $telegram->runCommands($commands);

examples/getUpdatesCLI.php

@@ -70,7 +70,9 @@
     //$telegram->enableBotan('your_token', ['timeout' => 3]);
 
     // Requests Limiter (tries to prevent reaching Telegram API limits)
+    // Second argument are options
     $telegram->enableLimiter();
+    //$telegram->enableLimiter(['interval' => 0.5);
 
     // Handle telegram getUpdates request
     $serverResponse = $telegram->handleGetUpdates();

examples/hook.php

@@ -69,7 +69,9 @@
     //$telegram->enableBotan('your_token', ['timeout' => 3]);
 
     // Requests Limiter (tries to prevent reaching Telegram API limits)
+    // Second argument are options
     $telegram->enableLimiter();
+    //$telegram->enableLimiter(['interval' => 0.5);
 
     // Handle telegram webhook request
     $telegram->handle();

src/Request.php

@@ -53,6 +53,13 @@ class Request
      */
     private static $limiter_enabled;
 
+    /**
+     * Request limiter's interval between checks
+     *
+     * @var boolean
+     */
+    private static $limiter_interval;
+
     /**
      * Available actions to send
      *
@@ -990,10 +997,24 @@ public static function getWebhookInfo()
      * Enable request limiter
      *
      * @param boolean $value
+     * @param array   $options
+     *
+     * @throws \Longman\TelegramBot\Exception\TelegramException
      */
-    public static function setLimiter($value = true)
+    public static function setLimiter($value = true, array $options = [])
     {
         if (DB::isDbConnected()) {
+            $options_default = [
+                'interval' => 1,
+            ];
+
+            $options = array_merge($options_default, $options);
+
+            if (!is_numeric($options['interval']) || $options['interval'] <= 0) {
+                throw new TelegramException('Interval must be a number and must be greater than zero!');
+            }
+
+            self::$limiter_interval = $options['interval'];
             self::$limiter_enabled = $value;
         }
     }
@@ -1042,15 +1063,15 @@ private static function limitTelegramRequests($action, array $data = [])
 
                     $requests = DB::getTelegramRequestCount($chat_id, $inline_message_id);
 
-                    if ($requests['LIMIT_PER_SEC'] == 0  // No more than one message per second inside a particular chat
-                        && ((($chat_id > 0 || $inline_message_id) && $requests['LIMIT_PER_SEC_ALL'] < 30)  // No more than 30 messages per second globally
-                        || ($chat_id < 0 && $requests['LIMIT_PER_MINUTE'] < 20))
+                    if ($requests['LIMIT_PER_SEC'] == 0     // No more than one message per second inside a particular chat
+                        && ((($chat_id > 0 || $inline_message_id) && $requests['LIMIT_PER_SEC_ALL'] < 30)       // No more than 30 messages per second globally
+                        || ($chat_id < 0 && $requests['LIMIT_PER_MINUTE'] < 20))        // No more than 20 messages per minute in groups and channels
                     ) {
                         break;
                     }
 
                     $timeout--;
-                    sleep(1);
+                    usleep(self::$limiter_interval * 1000000);
                 }
 
                 DB::insertTelegramRequest($action, $data);

src/Telegram.php

@@ -882,10 +882,14 @@ public function enableBotan($token, array $options = [])
 
     /**
      * Enable requests limiter
+     *
+     * @param  array  $options
+     * 
+     * @return \Longman\TelegramBot\Telegram
      */
-    public function enableLimiter()
+    public function enableLimiter(array $options = [])
     {
-        Request::setLimiter(true);
+        Request::setLimiter(true, $options);
 
         return $this;
     }