Merge pull request #31 from php-telegram-bot/develop

Version 1.1.0

Author: noplanman

CHANGELOG.md

@@ -11,6 +11,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 ### Fixed
 ### Security
 
+## [1.1.0] - 2017-05-23
+### Added
+- `webhookinfo` action to get result from `getWebhookInfo`.
+### Changed
+- Clean up and refactor some methods.
+### Fixed
+- Passing an empty array to `webhook.allowed_updates` parameter now correctly resets to defaults.
+
 ## [1.0.1] - 2017-05-09
 ### Changed
 - Use more stable `longman/ip-tools` for IP matching.

README.md

@@ -59,8 +59,8 @@ There are a few parameters available to get things rolling:
 | --------- | ----------- |
 | s         | **s**ecret: This is a special secret value defined in the main `manager.php` file. |
 |           | This parameter is required to call the script via browser! |
-| a         | **a**ction: The actual action to perform. (handle (default), cron, set, unset, reset) |
-|           | **handle** executes the `getUpdates` method; **cron** executes cron commands; **set** / **unset** / **reset** the webhook. |
+| a         | **a**ction: The actual action to perform. (handle (default), webhookinfo, cron, set, unset, reset) |
+|           | **handle** executes the `getUpdates` method; **webhookinfo** to get result from `getWebhookInfo`, **cron** executes cron commands; **set** / **unset** / **reset** the webhook. |
 | l         | **l**oop: Number of seconds to loop the script for (used for getUpdates method). |
 |           | This would be used mainly via CLI, to continually get updates for a certain period. |
 | i         | **i**nterval: Number of seconds to wait between getUpdates requests (used for getUpdates method, default is 2). |
@@ -180,7 +180,8 @@ The `secret` is a user-defined key that is required to execute any of the librar
 Best make it long, random and very unique!
 
 For 84 random characters:
-- If you have `pwgen` installed, just execute `pwgen 84` and choose any one.
+- If you have `pwgen` installed, just execute `pwgen 84 1` and copy the output.
+- If you have `openssl` installed, use `openssl rand -hex 84`.
 - Or just go [here][random-characters] and put all the output onto a single line.
 
 (You get 2 guesses why 84 is a good number :wink:)

src/Action.php

@@ -23,6 +23,7 @@ class Action
         'reset',
         'handle',
         'cron',
+        'webhookinfo',
     ];
 
     /**

src/BotManager.php

@@ -122,18 +122,22 @@ public function run(): self
     {
         // Make sure this is a valid call.
         $this->validateSecret();
+        $this->validateRequest();
 
-        if (!$this->isValidRequest()) {
-            throw new InvalidAccessException('Invalid access');
+        if ($this->action->isAction('webhookinfo')) {
+            $webhookinfo = Request::getWebhookInfo();
+            print_r($webhookinfo->getResult() ?: $webhookinfo->printError());
+            return $this;
         }
-
         if ($this->action->isAction(['set', 'unset', 'reset'])) {
-            $this->validateAndSetWebhook();
-        } elseif ($this->action->isAction('handle')) {
-            $this->setBotExtras();
+            return $this->validateAndSetWebhook();
+        }
+
+        $this->setBotExtras();
+
+        if ($this->action->isAction('handle')) {
             $this->handleRequest();
         } elseif ($this->action->isAction('cron')) {
-            $this->setBotExtras();
             $this->handleCron();
         }
 
@@ -206,7 +210,13 @@ public function validateAndSetWebhook(): self
                 'certificate'     => $webhook['certificate'] ?? null,
                 'max_connections' => $webhook['max_connections'] ?? null,
                 'allowed_updates' => $webhook['allowed_updates'] ?? null,
-            ]);
+            ], function ($v, $k) {
+                if ($k === 'allowed_updates') {
+                    // Special case for allowed_updates, which can be an empty array.
+                    return is_array($v);
+                }
+                return !empty($v);
+            }, ARRAY_FILTER_USE_BOTH);
 
             $this->handleOutput(
                 $this->telegram->setWebhook(
@@ -328,17 +338,15 @@ protected function setBotExtrasRequest(): self
      */
     public function handleRequest(): self
     {
-        if (empty($this->params->getBotParam('webhook.url'))) {
-            if ($loop_time = $this->getLoopTime()) {
-                $this->handleGetUpdatesLoop($loop_time, $this->getLoopInterval());
-            } else {
-                $this->handleGetUpdates();
-            }
-        } else {
-            $this->handleWebhook();
+        if ($this->params->getBotParam('webhook.url')) {
+            return $this->handleWebhook();
         }
 
-        return $this;
+        if ($loop_time = $this->getLoopTime()) {
+            return $this->handleGetUpdatesLoop($loop_time, $this->getLoopInterval());
+        }
+
+        return $this->handleGetUpdates();
     }
 
     /**
@@ -353,9 +361,9 @@ public function handleCron(): self
 
         $commands = [];
         foreach ($groups as $group) {
-            $commands = array_merge($commands, $this->params->getBotParam('cron.groups.' . $group, []));
+            $commands[] = $this->params->getBotParam('cron.groups.' . $group, []);
         }
-        $this->telegram->runCommands($commands);
+        $this->telegram->runCommands(array_merge(...$commands));
 
         return $this;
     }
@@ -524,4 +532,16 @@ public function isValidRequest(): bool
             (array) $this->params->getBotParam('valid_ips', [])
         ));
     }
+
+    /**
+     * Make sure this is a valid request.
+     *
+     * @throws \TelegramBot\TelegramBotManager\Exception\InvalidAccessException
+     */
+    private function validateRequest()
+    {
+        if (!$this->isValidRequest()) {
+            throw new InvalidAccessException('Invalid access');
+        }
+    }
 }

src/Params.php

@@ -110,37 +110,67 @@ public function __construct(array $params)
     /**
      * Validate and set up the vital and extra params.
      *
-     * @param $params
+     * @param array $params
      *
      * @return \TelegramBot\TelegramBotManager\Params
      * @throws \TelegramBot\TelegramBotManager\Exception\InvalidParamsException
      */
-    private function validateAndSetBotParams($params): self
+    private function validateAndSetBotParams(array $params): self
+    {
+        $this->validateAndSetBotParamsVital($params);
+        $this->validateAndSetBotParamsSpecial($params);
+        $this->validateAndSetBotParamsExtra($params);
+
+        return $this;
+    }
+
+    /**
+     * Set all vital params.
+     *
+     * @param array $params
+     *
+     * @throws \TelegramBot\TelegramBotManager\Exception\InvalidParamsException
+     */
+    private function validateAndSetBotParamsVital(array $params)
     {
-        // Set all vital params.
         foreach (self::$valid_vital_bot_params as $vital_key) {
             if (!array_key_exists($vital_key, $params)) {
                 throw new InvalidParamsException('Some vital info is missing: ' . $vital_key);
             }
 
             $this->bot_params[$vital_key] = $params[$vital_key];
         }
+    }
 
+    /**
+     * Special case parameters.
+     *
+     * @param array $params
+     *
+     * @throws \TelegramBot\TelegramBotManager\Exception\InvalidParamsException
+     */
+    private function validateAndSetBotParamsSpecial(array $params)
+    {
         // Special case, where secret MUST be defined if we have a webhook.
         if (($params['webhook'] ?? null) && !($params['secret'] ?? null)) {
             throw new InvalidParamsException('Some vital info is missing: secret');
         }
+    }
 
-        // Set all extra params.
+    /**
+     * Set all extra params.
+     *
+     * @param array $params
+     */
+    private function validateAndSetBotParamsExtra(array $params)
+    {
         foreach (self::$valid_extra_bot_params as $extra_key) {
             if (!array_key_exists($extra_key, $params)) {
                 continue;
             }
 
             $this->bot_params[$extra_key] = $params[$extra_key];
         }
-
-        return $this;
     }
 
     /**
@@ -152,28 +182,44 @@ private function validateAndSetBotParams($params): self
      * @return \TelegramBot\TelegramBotManager\Params
      */
     private function validateAndSetScriptParams(): self
+    {
+        $this->setScriptParams();
+        $this->validateScriptParams();
+
+        return $this;
+    }
+
+    /**
+     * Set script parameters from query string or CLI.
+     */
+    private function setScriptParams()
     {
         $this->script_params = $_GET;
 
-        // If we're running from CLI, properly set script parameters.
-        if ('cli' === PHP_SAPI) {
-            // We don't need the first arg (the file name).
-            $args = array_slice($_SERVER['argv'], 1);
+        // If we're not running from CLI, script parameters are already set from $_GET.
+        if ('cli' !== PHP_SAPI) {
+            return;
+        }
 
-            /** @var array $args */
-            foreach ($args as $arg) {
-                @list($key, $val) = explode('=', $arg);
-                isset($key, $val) && $this->script_params[$key] = $val;
-            }
+        // We don't need the first arg (the file name).
+        $args = array_slice($_SERVER['argv'], 1);
+
+        /** @var array $args */
+        foreach ($args as $arg) {
+            @list($key, $val) = explode('=', $arg);
+            isset($key, $val) && $this->script_params[$key] = $val;
         }
+    }
 
-        // Keep only valid ones.
+    /**
+     * Keep only valid script parameters.
+     */
+    private function validateScriptParams()
+    {
         $this->script_params = array_intersect_key(
             $this->script_params,
             array_fill_keys(self::$valid_script_params, null)
         );
-
-        return $this;
     }
 
     /**

tests/ActionTest.php

@@ -21,6 +21,7 @@ public function testConstruct()
         self::assertEquals('reset', (new Action('reset'))->getAction());
         self::assertEquals('handle', (new Action('handle'))->getAction());
         self::assertEquals('cron', (new Action('cron'))->getAction());
+        self::assertEquals('webhookinfo', (new Action('webhookinfo'))->getAction());
     }
 
     /**