mambax7 / newbb

class/OnlineHandler.php

<?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
 */


use Xmf\IPAddress;
use XoopsDatabase;

/** @var \XoopsOnlineHandler $xoopsOnlineHandler */
require_once \dirname(__DIR__) . '/include/functions.config.php';

/**
 * Class OnlineHandler
 */
class OnlineHandler
{
    public ?XoopsDatabase $db;
    public int            $forum_id;

    /**
     * @var Forum|int|null|string
     */
    public           $forumObject;
    public int            $topic_id;
    public array          $user_ids = [];

    /**
     * OnlineHandler constructor.
     */
    public function __construct(XoopsDatabase $db = null)
    {
        if (null === $db) {
            $db = \XoopsDatabaseFactory::getDatabaseConnection();
        }
        $this->db = $db;
    }

    /**
     * @param Forum|string|int|null $forum
     * @param Topic|null $forumtopic
     * @throws \Exception
     */
    public function init($forum = null, Topic $forumtopic = null): void
    {
        if (\is_object($forum)) {
            $this->forum_id    = $forum->getVar('forum_id');
        } else {
            $this->forum_id    = (int)$forum;
        }
        $this->forumObject = $forum;
        if (\is_object($forumtopic)) {
            $this->topic_id = $forumtopic->getVar('topic_id');
            if (empty($this->forum_id)) {
                $this->forum_id = $forumtopic->getVar('forum_id');
            }
        } else {
            $this->topic_id = (int)$forumtopic;
        }

        $this->update();
    }

    /**
     * @throws \Exception
     */
    public function update(): void
    {
        global $xoopsModule;

        // set gc probabillity to 10% for now..
        if (\random_int(1, 100) < 60) {
            $this->garbageCollection(150);
        }
        if (\is_object($GLOBALS['xoopsUser'])) {
            $uid   = $GLOBALS['xoopsUser']->getVar('uid');
            $uname = $GLOBALS['xoopsUser']->getVar('uname');
            $name  = $GLOBALS['xoopsUser']->getVar('name');
        } else {
            $uid   = 0;
            $uname = '';
            $name  = '';
        }

        /** @var \XoopsOnlineHandler $xoopsOnlineHandler */
        $xoopsOnlineHandler = \xoops_getHandler('online');
        $xoopsupdate        = $xoopsOnlineHandler->write($uid, $uname, \time(), $xoopsModule->getVar('mid'), \Xmf\IPAddress::fromRequest()->asReadable());
        if (!$xoopsupdate) {
            //xoops_error("newbb online upate error");
        }

        $uname = (empty($GLOBALS['xoopsModuleConfig']['show_realname']) || empty($name)) ? $uname : $name;
        $this->write($uid, $uname, \time(), $this->forum_id, IPAddress::fromRequest()->asReadable(), $this->topic_id);
    }

    /**
     * @param \Smarty $xoopsTpl
     */
    public function render(\Smarty $xoopsTpl): void
    {
        require_once \dirname(__DIR__) . '/include/functions.render.php';
        require_once \dirname(__DIR__) . '/include/functions.user.php';
        $criteria = null;
        if ($this->topic_id) {
            $criteria = new \Criteria('online_topic', $this->topic_id);
        } elseif ($this->forum_id) {
            $criteria = new \Criteria('online_forum', $this->forum_id);
        }
        $users     = $this->getAll($criteria);
        $num_total = \count($users);

        $num_user     = 0;
        $users_id     = [];
        $users_online = [];
        foreach ($users as $i => $iValue) {
            if (empty($iValue['online_uid'])) {
                continue;
            }
            $users_id[]                          = $iValue['online_uid'];
            $users_online[$iValue['online_uid']] = [
                'link'  => XOOPS_URL . '/userinfo.php?uid=' . $iValue['online_uid'],
                'uname' => $iValue['online_uname'],
            ];
            ++$num_user;
        }
        $num_anonymous           = $num_total - $num_user;
        $online                  = [];
        $online['image']         = \newbbDisplayImage('whosonline');
        $online['num_total']     = $num_total;
        $online['num_user']      = $num_user;
        $online['num_anonymous'] = $num_anonymous;
        $administrator_list      = \newbbIsModuleAdministrators($users_id);
        $moderator_list          = [];
        $member_list             = \array_diff(\array_keys($administrator_list), $users_id);
        if ($member_list) {

The expression $member_list of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            if (\is_object($this->forumObject)) {
                $moderator_list = $this->forumObject->getVar('forum_moderator');
            } else {
                $moderator_list = \newbbIsForumModerators($member_list);
            }
        }
        foreach ($users_online as $uid => $user) {
            if (!empty($administrator_list[$uid])) {
                $user['level'] = 2;
            } elseif (!empty($moderator_list[$uid])) {
                $user['level'] = 1;
            } else {
                $user['level'] = 0;
            }
            $online['users'][] = $user;
        }

        $xoopsTpl->assign_by_ref('online', $online);
    }

    /**
     *  Deprecated
     *
     * @return ((int|mixed|string)[][]|int|mixed)[]
     *
     * @psalm-return array{image: mixed, statistik: mixed, num_total: 0|positive-int, num_user: 0|positive-int, num_anonymous: int, users?: non-empty-list<array{link: string, uname: mixed, level: 0|1|2}>}
     */
    public function showOnline(): array
    {
        require_once \dirname(__DIR__) . '/include/functions.render.php';
        require_once \dirname(__DIR__) . '/include/functions.user.php';
        $criteria = null;
        if ($this->topic_id) {
            $criteria = new \Criteria('online_topic', $this->topic_id);
        } elseif ($this->forum_id) {
            $criteria = new \Criteria('online_forum', $this->forum_id);
        }
        $users     = $this->getAll($criteria);
        $num_total = \count($users);

        $num_user     = 0;
        $users_id     = [];
        $users_online = [];
        foreach ($users as $i => $iValue) {
            if (empty($iValue['online_uid'])) {
                continue;
            }
            $users_id[]                          = $iValue['online_uid'];
            $users_online[$iValue['online_uid']] = [
                'link'  => XOOPS_URL . '/userinfo.php?uid=' . $iValue['online_uid'],
                'uname' => $iValue['online_uname'],
            ];
            ++$num_user;
        }
        $num_anonymous           = $num_total - $num_user;
        $online                  = [];
        $online['image']         = \newbbDisplayImage('whosonline');
        $online['statistik']     = \newbbDisplayImage('statistik');
        $online['num_total']     = $num_total;
        $online['num_user']      = $num_user;
        $online['num_anonymous'] = $num_anonymous;
        $administrator_list      = \newbbIsModuleAdministrators($users_id);
        $moderator_list          = [];
        $member_list             = \array_diff($users_id, \array_keys($administrator_list));
        if ($member_list) {

The expression $member_list of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            if (\is_object($this->forumObject)) {
                $moderator_list = $this->forumObject->getVar('forum_moderator');
            } else {
                $moderator_list = \newbbIsForumModerators($member_list);
            }
        }

        foreach ($users_online as $uid => $user) {
            if (\in_array($uid, $administrator_list, true)) {
                $user['level'] = 2;
            } elseif (\in_array($uid, $moderator_list, true)) {
                $user['level'] = 1;
            } else {
                $user['level'] = 0;
            }
            $online['users'][] = $user;
        }

        return $online;
    }

    /**
     * Write online information to the database
     *
     * @param int    $uid      UID of the active user
     * @param string $uname    Username
     * @param int    $time
     * @param int    $forum_id Current forum_id
     * @param string $ip       User's IP adress
     * @param int    $topic_id
     * @return bool   TRUE on success
     * @internal param string $timestamp
     */
    public function write(int $uid, string $uname, int $time, int $forum_id, string $ip, int $topic_id): bool
    {
        global $xoopsModule, $xoopsDB;

        $uid = (int)$uid;
        if ($uid > 0) {
            $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('newbb_online') . ' WHERE online_uid=' . $uid;

The method prefix() does not exist on null.

        } else {
            $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('newbb_online') . ' WHERE online_uid=' . $uid . " AND online_ip='" . $ip . "'";
        }
        $result = $this->db->queryF($sql);
        if (!$this->db->isResultSet($result)) {
            \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
        }
        [$count] = $this->db->fetchRow($result);
        if ($count > 0) {
            $sql = 'UPDATE ' . $this->db->prefix('newbb_online') . " SET online_updated= '" . $time . "', online_forum = '" . $forum_id . "', online_topic = '" . $topic_id . "' WHERE online_uid = " . $uid;
            if (0 === $uid) {
                $sql .= " AND online_ip='" . $ip . "'";
            }
        } else {
            $sql = \sprintf('INSERT INTO `%s` (online_uid, online_uname, online_updated, online_ip, online_forum, online_topic) VALUES (%u, %s, %u, %s, %u, %u)', $this->db->prefix('newbb_online'), $uid, $this->db->quote($uname), $time, $this->db->quote($ip), $forum_id, $topic_id);
        }
        if (!$this->db->queryF($sql)) {
            //xoops_error($this->db->error());
            return false;
        }

        /** @var \XoopsOnlineHandler $xoopsOnlineHandler */
        $xoopsOnlineHandler = \xoops_getHandler('online');
        $xoopsOnlineTable   = $xoopsOnlineHandler->table;

        $sql = 'DELETE FROM '
               . $this->db->prefix('newbb_online')
               . ' WHERE'
               . ' ( online_uid > 0 AND online_uid NOT IN ( SELECT online_uid FROM '
               . $xoopsOnlineTable
               . ' WHERE online_module ='
               . $xoopsModule->getVar('mid')
               . ' ) )'
               . ' OR ( online_uid = 0 AND online_ip NOT IN ( SELECT online_ip FROM '
               . $xoopsOnlineTable
               . ' WHERE online_module ='
               . $xoopsModule->getVar('mid')
               . ' AND online_uid = 0 ) )';

        $result = $this->db->queryF($sql);
        if ($result) {
            return true;
        }
        //xoops_error($this->db->error());
        return false;
    }

    /**
     * Garbage Collection
     *
     * Delete all online information that has not been updated for a certain time
     *
     * @param int $expire Expiration time in seconds
     */
    public function garbageCollection(int $expire): void
    {
        global $xoopsModule;
        $sql = 'DELETE FROM ' . $this->db->prefix('newbb_online') . ' WHERE online_updated < ' . (\time() - (int)$expire);
        $this->db->queryF($sql);

        /** @var \XoopsOnlineHandler $xoopsOnlineHandler */
        $xoopsOnlineHandler = \xoops_getHandler('online');
        $xoopsOnlineHandler->gc($expire);
    }

    /**
     *  Get an array of online information
     *
     * @param \CriteriaElement|null $criteria {@link \CriteriaElement}
     *
     * @return array Array of associative arrays of online information
     *
     * @psalm-return list<mixed>
     */
    public function getAll(\CriteriaElement $criteria = null): array
    {
        $ret   = [];
        $limit = $start = 0;
        $sql   = 'SELECT * FROM ' . $this->db->prefix('newbb_online');
         if (\is_object($criteria) && \is_subclass_of($criteria, \CriteriaElement::class)) {
            $sql   .= ' ' . $criteria->renderWhere();

The method renderWhere() does not exist on CriteriaElement. Did you maybe mean render()?

            $limit = $criteria->getLimit();
            $start = $criteria->getStart();
        }
        $result = $this->db->query($sql, $limit, $start);
        if ($this->db->isResultSet($result)) {
            while (false !== ($myrow = $this->db->fetchArray($result))) {
                $ret[] = $myrow;
                if ($myrow['online_uid'] > 0) {
                    $this->user_ids[] = $myrow['online_uid'];
                }
                unset($myrow);
            }
            $this->user_ids = \array_unique($this->user_ids);
        }

        return $ret;
    }

    /**
     * @param array $uids
     *
     * @return int[]
     *
     * @psalm-return array<1>
     */
    public function checkStatus(array $uids): array
    {
        $online_users = [];
        $ret          = [];
        if (!empty($this->user_ids)) {
            $online_users = $this->user_ids;
        } else {
            $sql = 'SELECT online_uid FROM ' . $this->db->prefix('newbb_online');
            if ($uids !== []) {
                $sql .= ' WHERE online_uid IN (' . \implode(', ', \array_map('\intval', $uids)) . ')';
            }

            $result = $this->db->query($sql);
            if (!$this->db->isResultSet($result)) {
//                \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
                return $ret;
            }
            while ([$uid] = $this->db->fetchRow($result)) {
                $online_users[] = $uid;
            }
        }
        foreach ($uids as $uid) {
            if (\in_array($uid, $online_users, true)) {
                $ret[$uid] = 1;
            }
        }

        return $ret;
    }

    /**
     *  Count the number of online users
     *
     * @param \CriteriaElement|null $criteria
     *
     * @return bool
     */
    public function getCount(\CriteriaElement $criteria = null): bool
    {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('newbb_online');
         if (\is_object($criteria) && \is_subclass_of($criteria, \CriteriaElement::class)) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        $result = $this->db->query($sql);
        if (!$this->db->isResultSet($result)) {
            //                \trigger_error("Query Failed! SQL: $sql- Error: " . $this->db->error(), E_USER_ERROR);
            return false;
        }
        [$ret] = $this->db->fetchRow($result);

        return $ret;
    }
}