XoopsModules\Newbb\StatsHandler

Complexity

Total Complexity

31

Size/Duplication

Total Lines	249
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getInstance()	0	8	2
A	__construct()	0	7	1
B	update()	0	57	7
F	reset()	0	107	13
B	getStats()	0	26	8

<?php declare(strict_types=1);

namespace XoopsModules\Newbb;

/**
 * NewBB,  the forum module for XOOPS project
 *
 * @copyright      XOOPS Project (https://xoops.org)
 * @license        GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author         Taiwen Jiang (phppp or D.J.) <phppp@users.sourceforge.net>
 * @since          4.00
 */
\defined('NEWBB_FUNCTIONS_INI') || require \dirname(__DIR__) . '/include/functions.ini.php';

\define('NEWBB_STATS_TYPE_TOPIC', 1);
\define('NEWBB_STATS_TYPE_POST', 2);
\define('NEWBB_STATS_TYPE_DIGEST', 3);
\define('NEWBB_STATS_TYPE_VIEW', 4);

\define('NEWBB_STATS_PERIOD_TOTAL', 1);
\define('NEWBB_STATS_PERIOD_DAY', 2);
\define('NEWBB_STATS_PERIOD_WEEK', 3);
\define('NEWBB_STATS_PERIOD_MONTH', 4);

/**
 * Stats for forum
 */
class StatsHandler
{
    /** @var \XoopsMySQLDatabase|null $db */
    public ?\XoopsMySQLDatabase $db;
    /** @var string $table */
    public string $table;
    /** @var array $param */
    public array $param = [
        'type'   => ['topic', 'post', 'digest', 'view'],
        'period' => ['total', 'day', 'week', 'month'],
    ];

    /**
     * @param \XoopsMySQLDatabase|null $db
     */
    public function __construct(\XoopsMySQLDatabase $db = null)
    {
        $this->db = $db;
        //if (!$db || !($db instanceof \XoopsMySQLDatabase)) {
//        $this->db = $GLOBALS['xoopsDB'];
        //}
        $this->table = $this->db->prefix('newbb_stats');

The method prefix() does not exist on null.

    }

    /**
     * @param \XoopsMySQLDatabase|null $db
     * @return StatsHandler
     */
    public static function getInstance(\XoopsMySQLDatabase $db = null): StatsHandler
    {
        static $instance;
        if (null === $instance) {
            $instance = new static($db);
        }

        return $instance;
    }

    /**
     * @param int|string $id
     * @param string     $type
     * @param int        $increment
     * @return bool
     */
    public function update($id, string $type, int $increment = 1): bool
    {
        $id        = (int)$id;
        $increment = (int)$increment;

        if ($increment !== 0 || false === ($type = \array_search($type, $this->param['type'], true))) {
            return false;
        }

        $sql    = "    UPDATE {$this->table}"
                  . '    SET stats_value = CASE '
                  . "                    WHEN time_format = '' OR DATE_FORMAT(time_update, time_format) = DATE_FORMAT(NOW(), time_format)  THEN stats_value + '{$increment}' "
                  . "                    ELSE '{$increment}' "
                  . '                END, '
                  . '        time_update = NOW()'
                  . '    WHERE '
                  . "        (stats_id = '0' OR stats_id = '{$id}') "
                  . "        AND stats_type='{$type}' ";
        $result = $this->db->queryF($sql);
        $rows   = $this->db->getAffectedRows();
        if (0 == $rows) {
            $sql    = "    INSERT INTO {$this->table}"
                      . '        (`stats_id`, `stats_value`, `stats_type`, `stats_period`, `time_update`, `time_format`) '
                      . '    VALUES '
                      . "        ('0', '{$increment}', '{$type}', '"
                      . \array_search('total', $this->param['period'], true)
                      . "', NOW(), ''), "
                      . "        ('0', '{$increment}', '{$type}', '"
                      . \array_search('day', $this->param['period'], true)
                      . "', NOW(), '%Y%j'), "
                      . "        ('0', '{$increment}', '{$type}', '"
                      . \array_search('week', $this->param['period'], true)
                      . "', NOW(), '%Y%u'), "
                      . "        ('0', '{$increment}', '{$type}', '"
                      . \array_search('month', $this->param['period'], true)
                      . "', NOW(), '%Y%m')";
            $result = $this->db->queryF($sql);
        }
        if ($rows < 2 * (is_countable($this->param['period']) ? \count($this->param['period']) : 0) && !empty($id)) {
            $sql    = "    INSERT INTO {$this->table}"
                      . '        (`stats_id`, `stats_value`, `stats_type`, `stats_period`, `time_update`, `time_format`) '
                      . '    VALUES '
                      . "        ('{$id}', '{$increment}', '{$type}', '"
                      . \array_search('total', $this->param['period'], true)
                      . "', NOW(), ''), "
                      . "        ('{$id}', '{$increment}', '{$type}', '"
                      . \array_search('day', $this->param['period'], true)
                      . "', NOW(), '%Y%j'), "
                      . "        ('{$id}', '{$increment}', '{$type}', '"
                      . \array_search('week', $this->param['period'], true)
                      . "', NOW(), '%Y%u'), "
                      . "        ('{$id}', '{$increment}', '{$type}', '"
                      . \array_search('month', $this->param['period'], true)
                      . "', NOW(), '%Y%m')";
            $result = $this->db->queryF($sql);
        }
        return $result;

The expression return $result could return the type mysqli_result which is incompatible with the type-hinted return boolean. Consider adding an additional type-check to rule them out.

    }

    /**
     *  Get stats of "Today"
     *
     * @param array $ids     ID of forum: > 0, forum; 0 - global; empty - all
     * @param array $types   type of stats items: 1 - topic; 2 - post; 3 - digest; 4 - click; empty - all
     * @param array $periods time period: 1 - all time; 2 - today; 3 - this week; 4 - this month; empty - all
     *
     * @return array[][]
     *
     * @psalm-return array<string, array<array>>
     */
    public function getStats(array $ids = [], array $types = [], array $periods = []): array
    {
        $ret = [];

        $_types = [];
        foreach ($types as $type) {
            $_types[] = \array_search($type, $this->param['type'], true);
        }
        $_periods = [];
        foreach ($periods as $period) {
            $_periods[] = \array_search($period, $this->param['period'], true);
        }
        $sql    = '    SELECT stats_id, stats_value, stats_type, stats_period ' . "    FROM {$this->table} " . '    WHERE ' . "        ( time_format = '' OR DATE_FORMAT(time_update, time_format) = DATE_FORMAT(NOW(), time_format) ) " . '        ' . ($ids === [] ? '' : 'AND stats_id IN (' . \implode(
                    ', ',
                    \array_map(
                        '\intval',
                        $ids
                    )
                ) . ')') . '        ' . ($_types === [] ? '' : 'AND stats_type IN (' . \implode(', ', $_types) . ')') . '        ' . ($_periods === [] ? '' : 'AND stats_period IN (' . \implode(', ', $_periods) . ')');
        $result = $this->db->query($sql);
        if ($this->db->isResultSet($result)) {
            while (false !== ($row = $this->db->fetchArray($result))) {

It seems like $result can also be of type boolean; however, parameter $result of XoopsMySQLDatabase::fetchArray() does only seem to accept mysqli_result, maybe add an additional type check?

                $ret[(string)$row['stats_id']][$this->param['type'][$row['stats_type']]][$this->param['period'][$row['stats_period']]] = $row['stats_value'];
            }
        }
        return $ret;
    }

    public function reset(): void
    {
        $this->db->queryF('TRUNCATE TABLE ' . $this->table);
        $now        = \time();
        $time_start = [
            'day'   => '%Y%j',
            'week'  => '%Y%u',
            'month' => '%Y%m',
        ];
        $counts     = [];

        $sql = '    SELECT forum_id' . '    FROM ' . $this->db->prefix('newbb_forums');
        $ret = $this->db->query($sql);
        if (!$this->db->isResultSet($ret)) {
            \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
        }
        while ([$forum_id] = $this->db->fetchRow($ret)) {

It seems like $ret can also be of type boolean; however, parameter $result of XoopsMySQLDatabase::fetchRow() does only seem to accept mysqli_result, maybe add an additional type check?

            $sql    = '    SELECT COUNT(*), SUM(topic_views)' . '    FROM ' . $this->db->prefix('newbb_topics') . "    WHERE approved=1 AND forum_id = {$forum_id}";
            $result = $this->db->query($sql);
            if (!$this->db->isResultSet($result)) {
                \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
            }
            [$topics, $views] = $this->db->fetchRow($result);
            $this->update($forum_id, 'topic', (int)$topics);
            $this->update($forum_id, 'view', (int)$views);

            $sql    = '    SELECT COUNT(*)' . '    FROM ' . $this->db->prefix('newbb_topics') . "    WHERE approved=1 AND topic_digest >0 AND forum_id = {$forum_id}";
            $result = $this->db->query($sql);
            if (!$this->db->isResultSet($result)) {
                \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
            }
            [$digests] = $this->db->fetchRow($result);
            $this->update($forum_id, 'digest', (int)$digests);

            $sql    = '    SELECT COUNT(*)' . '    FROM ' . $this->db->prefix('newbb_posts') . "    WHERE approved=1 AND forum_id = {$forum_id}";
            $result = $this->db->query($sql);
            if (!$this->db->isResultSet($result)) {
                \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
            }
            [$posts] = $this->db->fetchRow($result);
            $this->update($forum_id, 'post', (int)$posts);

            foreach ($time_start as $period => $format) {
                $sql    = '    SELECT COUNT(*), SUM(topic_views)' . '    FROM ' . $this->db->prefix('newbb_topics') . "    WHERE approved=1 AND forum_id = {$forum_id}" . "        AND FROM_UNIXTIME(topic_time, '{$format}') >= FROM_UNIXTIME({$now}, '{$format}')";
                $result = $this->db->query($sql);
                if (!$this->db->isResultSet($result)) {
                    \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
                }
                [$topics, $views] = $this->db->fetchRow($result);
                $views = empty($views) ? 0 : $views; // null check

                $sql    = " INSERT INTO {$this->table}" . '        (`stats_id`, `stats_value`, `stats_type`, `stats_period`, `time_update`, `time_format`) ' . '    VALUES ' . "        ('{$forum_id}', '{$topics}', '" . \array_search('topic', $this->param['type'], true) . "', '" . \array_search(
                        $period,
                        $this->param['period'],
                        true
                    ) . "', NOW(), '{$format}')";
                $result = $this->db->queryF($sql);

The assignment to $result is dead and can be removed.

                $sql    = " INSERT INTO {$this->table}" . '        (`stats_id`, `stats_value`, `stats_type`, `stats_period`, `time_update`, `time_format`) ' . '    VALUES ' . "        ('{$forum_id}', '{$views}', '" . \array_search('view', $this->param['type'], true) . "', '" . \array_search(
                        $period,
                        $this->param['period'],
                        true
                    ) . "', NOW(), '{$format}')";
                $result = $this->db->queryF($sql);
                @$counts['topic'][$period] += $topics;
                @$counts['view'][$period] += $views;

                $sql    = '    SELECT COUNT(*)' . '    FROM ' . $this->db->prefix('newbb_topics') . "    WHERE approved=1 AND topic_digest >0 AND forum_id = {$forum_id}" . "        AND FROM_UNIXTIME(digest_time, '{$format}') >= FROM_UNIXTIME({$now}, '{$format}')";
                $result = $this->db->query($sql);
                if (!$this->db->isResultSet($result)) {
                    \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
                }
                [$digests] = $this->db->fetchRow($result);
                $sql    = " INSERT INTO {$this->table}" . '        (`stats_id`, `stats_value`, `stats_type`, `stats_period`, `time_update`, `time_format`) ' . '    VALUES ' . "        ('{$forum_id}', '{$digests}', '" . \array_search('digest', $this->param['type'], true) . "', '" . \array_search(
                        $period,
                        $this->param['period'],
                        true
                    ) . "', NOW(), '{$format}')";
                $result = $this->db->queryF($sql);
                @$counts['digest'][$period] += $digests;

                $sql    = ' SELECT COUNT(*)' . '    FROM ' . $this->db->prefix('newbb_posts') . "    WHERE approved=1 AND forum_id = {$forum_id}" . "        AND FROM_UNIXTIME(post_time, '{$format}') >= FROM_UNIXTIME({$now}, '{$format}')";
                $result = $this->db->query($sql);
                if (!$this->db->isResultSet($result)) {
                    \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
                }
                [$posts] = $this->db->fetchRow($result);
                $sql    = " INSERT INTO {$this->table}" . '        (`stats_id`, `stats_value`, `stats_type`, `stats_period`, `time_update`, `time_format`) ' . '    VALUES ' . "        ('{$forum_id}', '{$posts}', '" . \array_search('post', $this->param['type'], true) . "', '" . \array_search(
                        $period,
                        $this->param['period'],
                        true
                    ) . "', NOW(), '{$format}')";
                $result = $this->db->queryF($sql);
                @$counts['post'][$period] += $posts;
            }
        }

        $sql    = "    DELETE FROM {$this->table}" . "    WHERE stats_id = '0' AND stats_period <> " . \array_search('total', $this->param['period'], true);
        $result = $this->db->queryF($sql);
        foreach ($time_start as $period => $format) {
            foreach (\array_keys($counts) as $type) {
                $sql    = " INSERT INTO {$this->table}" . '        (`stats_id`, `stats_value`, `stats_type`, `stats_period`, `time_update`, `time_format`) ' . '    VALUES ' . "        ('0', '{$counts[$type][$period]}', '" . \array_search($type, $this->param['type'], true) . "', '" . \array_search(
                        $period,
                        $this->param['period'],
                        true
                    ) . "', NOW(), '{$format}')";
                $result = $this->db->queryF($sql);
            }
        }
    }
}