PhpBotFramework\Database\LongPolling

Complexity

Total Complexity

17

Size/Duplication

Total Lines	174
Duplicated Lines	13.22 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	getUpdates()	0	1	?
	initCommands()	0	1	?
A	getUpdateOffsetRedis()	0	21	3
B	getUpdatesRedis()	16	29	5
B	getUpdateOffsetDatabase()	0	27	4
B	getUpdatesDatabase()	0	31	5

<?php

/*
 * This file is part of the PhpBotFramework.
 *
 * PhpBotFramework is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * PhpBotFramework is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace PhpBotFramework\Database;

trait LongPolling
{

    abstract public function getUpdates(int $offset = 0, int $limit = 100, int $timeout = 60);

    abstract protected function initCommands();

    /**
     * \addtogroup Bot
     * @{
     */

    /** Redis connection. */
    public $redis;

    /** Pdo connection to the database. */
    public $pdo;

    /**
     * \addtogroup LongPollingDatabase Long polling With Database
     * \brief Use getUpdates saving and getting offset in redis/sql-database.
     * @{
     */

    /**
     * \brief (<i>Internal</i>)Get first update offset in redis.
     * \details Called by getUpdatesRedis to get the offset saved in redis or to get it from telegram and save it in redis.
     * @param $offset_key Name of the variable where the offset is saved on Redis
     * @return Id of the first update to process.
     */
    protected function getUpdateOffsetRedis(string $offset_key) : int
    {

        // If offset is already set in redis
        if ($this->redis->exists($offset_key)) {
            // return the value saved
            return $this->redis->get($offset_key);

            // Else get the offset from the id from the first update received
        } else {
            do {
                $update = $this->getUpdates(0, 1);
            } while (empty($update));

            $offset = $update[0]['update_id'];

            $this->redis->set($offset_key, $offset);

            return $offset_key;
        }
    }

    /**
     * \brief Get updates received by the bot, using redis to save and get the last offset.
     * \details It check if an offset exists on redis, then get it, or call getUpdates to set it.
     * Then it start an infinite loop where it process updates and update the offset on redis.
     * Each update is surrounded by a try/catch.
     * @see getUpdates
     * @param $limit <i>Optional</i>. Limits the number of updates to be retrieved. Values between 1—100 are accepted.
     * @param $timeout <i>Optional</i>. Timeout in seconds for long polling.
     * @param $offset_key <i>Optional</i>. Name of the variable where the offset is saved on Redis
     */
    public function getUpdatesRedis(int $limit = 100, int $timeout = 60, string $offset_key = 'offset')
    {

        // Check redis connection
        if (!isset($this->redis)) {
            throw new BotException("Redis connection is not set");
        }

        $offset = $this->getUpdateOffsetRedis();

The call to getUpdateOffsetRedis() misses a required argument $offset_key.

        $this->initCommands();

         // Process all updates received
        while (true) {

This code seems to be duplicated across your project.

            $updates = $this->getUpdates($offset, $limit, $timeout);

            // Parse all updates received
            foreach ($updates as $key => $update) {
                try {
                    $this->processUpdate($update);

It seems like processUpdate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                } catch (BotException $e) {

The class PhpBotFramework\Database\BotException does not exist. Did you forget a USE statement, or did you not list all dependencies?

                    echo $e->getMessage();
                }
            }

            // Update the offset in redis
            $this->redis->set($offset_key, $offset + count($updates));
        }
    }

    /**
     * \brief (<i>Internal</i>) Get first update offset in database.
     * \details Called by getUpdatesDatabase to get the offset saved in database or to get it from telegram and save it in database.
     * @param $table_name Name of the table where offset is saved in the database
     * @param $column_name Name of the column where the offset is saved in the database
     * @return Id of the first update to process.
     */
    protected function getUpdateOffsetDatabase(string $table_name, string $column_name) : int
    {

        // Get the offset from the database
        $sth = $this->pdo->prepare('SELECT ' . $column_name . ' FROM ' . $table_name);

        try {
            $sth->execute();
        } catch (PDOException $e) {

The class PhpBotFramework\Database\PDOException does not exist. Did you forget a USE statement, or did you not list all dependencies?

            echo $e->getMessage();
        }

        $offset = $sth->fetchColumn();

        $sth = null;

$sth is not used, you could remove the assignment.

        // Get the offset from the first update to update
        if ($offset === false) {
            do {
                $update = $this->getUpdates(0, 1);
            } while (empty($update));

            $offset = $update[0]['update_id'];
        }

        return $offset;
    }

    /**
     * \brief Get updates received by the bot, using the sql database to store and get the last offset.
     * \details It check if an offset exists on redis, then get it, or call getUpdates to set it.
     * Then it start an infinite loop where it process updates and update the offset on redis.
     * Each update is surrounded by a try/catch.
     * @see getUpdates
     * @param $limit <i>Optional</i>. Limits the number of updates to be retrieved. Values between 1—100 are accepted.
     * @param $timeout <i>Optional</i>. Timeout in seconds for long polling.
     * @param $table_name <i>Optional</i>. Name of the table where offset is saved in the database
     * @param $column_name <i>Optional</i>. Name of the column where the offset is saved in the database
     */
    public function getUpdatesDatabase(int $limit = 100, int $timeout = 0, string $table_name = 'telegram', string $column_name = 'bot_offset')
    {

        if (!isset($this->_database)) {
            throw new BotException("Database connection is not set");
        }

        // Get offset from database
        $this->getUpdateOffsetDatabase($table_name, $column_name);

        $this->initCommands();

        // Prepare the query for updating the offset in the database
        $sth = $this->pdo->prepare('UPDATE "' . $table_name . '" SET "' . $column_name . '" = :new_offset');

        while (true) {
            $updates = $this->getUpdates($offset, $limit, $timeout);

The variable $offset does not exist. Did you forget to declare it?

            foreach ($updates as $key => $update) {
                try {
                    $this->processUpdate($update);

It seems like processUpdate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                } catch (BotException $e) {

The class PhpBotFramework\Database\BotException does not exist. Did you forget a USE statement, or did you not list all dependencies?

                    echo $e->getMessage();
                }
            }

            // Update the offset on the database
            $sth->bindParam(':new_offset', $offset + sizeof($updates));
            $sth->execute();
        }
    }

    /** @} */

    /** @} */
}