XoopsModules\Newbb\OnlineHandler

Complexity

Total Complexity

55

Size/Duplication

Total Lines	355
Duplicated Lines	17.18 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	init()	15	20	4
B	update()	0	28	6
C	render()	23	55	10
C	showOnline()	23	57	10
B	write()	0	49	6
A	gc()	0	9	1
B	getAll()	0	25	6
C	checkStatus()	0	28	7
A	getCount()	0	13	4

<?php namespace XoopsModules\Newbb;

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 23 and the first side effect is on line 18.

/**
 * NewBB 5.0x,  the forum module for XOOPS project
 *
 * @copyright      XOOPS Project (https://xoops.org)
 * @license        GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @author         Taiwen Jiang (phppp or D.J.) <phppp@users.sourceforge.net>
 * @since          4.00
 * @package        module::newbb
 */

use Xmf\IPAddress;
use XoopsModules\Newbb;

// defined('XOOPS_ROOT_PATH') || exit('Restricted access.');

70% of this comment could be valid code. Did you maybe forget this after debugging?

include_once __DIR__ . '/../include/functions.config.php';

/**
 * Class OnlineHandler
 */
class OnlineHandler
{
    public $db;

Avoid variables with short names like $db. Configured minimum length is 3.

    public $forum_id;

$forum_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    public $forumObject;
    public $topic_id;

$topic_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    public $user_ids = [];

$user_ids does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * OnlineHandler constructor.
     * @param \XoopsDatabase $db
     */
    public function __construct(\XoopsDatabase $db)

Avoid variables with short names like $db. Configured minimum length is 3.

    {
        $this->db = $db;
    }

    /**
     * @param null|Newbb\Forum $forum
     * @param null|Topic  $forumtopic
     */
    public function init($forum = null, $forumtopic = null)
    {
        if (is_object($forum)) {

This code seems to be duplicated across your project.

            $this->forum_id    = $forum->getVar('forum_id');
            $this->forumObject = $forum;
        } else {
            $this->forum_id    = (int)$forum;
            $this->forumObject = $forum;
        }
        if (is_object($forumtopic)) {

This code seems to be duplicated across your project.

            $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();
    }

    public function update()

update uses the super-global variable $GLOBALS which is generally not recommended.

    {
        global $xoopsModule;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        mt_srand((double)microtime() * 1000000);
        // set gc probabillity to 10% for now..
        if (mt_rand(1, 100) < 60) {
            $this->gc(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  = '';
        }

        $xoops_onlineHandler = xoops_getHandler('online');

$xoops_onlineHandler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $xoopsupdate         = $xoops_onlineHandler->write($uid, $uname, time(), $xoopsModule->getVar('mid'), \Xmf\IPAddress::fromRequest()->asReadable());

$xoops_onlineHandler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        if (!$xoopsupdate) {

This if statement is empty and can be removed.

            //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 $xoopsTpl
     */
    public function render(\Smarty $xoopsTpl)
    {
        include_once __DIR__ . '/../include/functions.render.php';
        include_once __DIR__ . '/../include/functions.user.php';
        $criteria = null;
        if ($this->topic_id) {

This code seems to be duplicated across your project.

            $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_total does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $num_user     = 0;

$num_user does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $users_id     = [];

$users_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $users_online = [];

$users_online does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        for ($i = 0; $i < $num_total; ++$i) {

$num_total does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

This code seems to be duplicated across your project.

            if (empty($users[$i]['online_uid'])) {
                continue;
            }
            $users_id[]                             = $users[$i]['online_uid'];

$users_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $users_online[$users[$i]['online_uid']] = [

$users_online does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                'link'  => XOOPS_URL . '/userinfo.php?uid=' . $users[$i]['online_uid'],
                'uname' => $users[$i]['online_uname']
            ];
            ++$num_user;

$num_user does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        }
        $num_anonymous           = $num_total - $num_user;

$num_anonymous does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $online                  = [];
        $online['image']         = newbbDisplayImage('whosonline');
        $online['num_total']     = $num_total;

$num_total does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $online['num_user']      = $num_user;

$num_user does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $online['num_anonymous'] = $num_anonymous;

$num_anonymous does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $administrator_list      = newbbIsModuleAdministrators($users_id);

$administrator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $moderator_list          = [];

$moderator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        if ($member_list = array_diff(array_keys($administrator_list), $users_id)) {

$member_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

This code seems to be duplicated across your project.

            if (is_object($this->forumObject)) {
                $moderator_list = $this->forumObject->getVar('forum_moderator');

$moderator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            } else {
                $moderator_list = newbbIsForumModerators($member_list);

$moderator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            }
        }
        foreach ($users_online as $uid => $user) {

$users_online does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            if (!empty($administrator_list[$uid])) {

$administrator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                $user['level'] = 2;
            } elseif (!empty($moderator_list[$uid])) {

$moderator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                $user['level'] = 1;
            } else {
                $user['level'] = 0;
            }
            $online['users'][] = $user;
        }

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

    /**
     * Deprecated
     */
    public function showOnline()
    {
        include_once __DIR__ . '/../include/functions.render.php';
        include_once __DIR__ . '/../include/functions.user.php';
        $criteria = null;
        if ($this->topic_id) {

This code seems to be duplicated across your project.

            $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_total does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $num_user     = 0;

$num_user does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $users_id     = [];

$users_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $users_online = [];

$users_online does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        for ($i = 0; $i < $num_total; ++$i) {

$num_total does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

This code seems to be duplicated across your project.

            if (empty($users[$i]['online_uid'])) {
                continue;
            }
            $users_id[]                             = $users[$i]['online_uid'];

$users_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $users_online[$users[$i]['online_uid']] = [

$users_online does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                'link'  => XOOPS_URL . '/userinfo.php?uid=' . $users[$i]['online_uid'],
                'uname' => $users[$i]['online_uname']
            ];
            ++$num_user;

$num_user does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        }
        $num_anonymous           = $num_total - $num_user;

$num_anonymous does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $online                  = [];
        $online['image']         = newbbDisplayImage('whosonline');
        $online['statistik']     = newbbDisplayImage('statistik');
        $online['num_total']     = $num_total;

$num_total does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $online['num_user']      = $num_user;

$num_user does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $online['num_anonymous'] = $num_anonymous;

$num_anonymous does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $administrator_list      = newbbIsModuleAdministrators($users_id);

$administrator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $moderator_list          = [];

$moderator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        if ($member_list = array_diff($users_id, array_keys($administrator_list))) {

$member_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

This code seems to be duplicated across your project.

            if (is_object($this->forumObject)) {
                $moderator_list = $this->forumObject->getVar('forum_moderator');

$moderator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            } else {
                $moderator_list = newbbIsForumModerators($member_list);

$moderator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            }
        }

        foreach ($users_online as $uid => $user) {

$users_online does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            if (in_array($uid, $administrator_list)) {

$administrator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                $user['level'] = 2;
            } elseif (in_array($uid, $moderator_list)) {

$moderator_list does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                $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         $time
     * @param  string $forum_id Current forum_id
     * @param  string $ip       User's IP adress
     * @param         $topic_id
     * @return bool   TRUE on success
     * @internal param string $timestamp
     */
    public function write($uid, $uname, $time, $forum_id, $ip, $topic_id)

function write() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

$forum_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

Avoid variables with short names like $ip. Configured minimum length is 3.

    {
        global $xoopsModule, $xoopsDB;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        $uid = (int)$uid;
        if ($uid > 0) {
            $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('newbb_online') . ' WHERE online_uid=' . $uid;
        } else {
            $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('newbb_online') . ' WHERE online_uid=' . $uid . " AND online_ip='" . $ip . "'";
        }
        list($count) = $this->db->fetchRow($this->db->queryF($sql));
        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;

$forum_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            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);

$forum_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        }
        if (!$this->db->queryF($sql)) {
            //xoops_error($this->db->error());

73% of this comment could be valid code. Did you maybe forget this after debugging?

            return false;
        }

        /** @var \XoopsOnlineHandler $xoops_onlineHandler */
        $xoops_onlineHandler = xoops_getHandler('online');

$xoops_onlineHandler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $xoopsOnlineTable    = $xoops_onlineHandler->table;

$xoops_onlineHandler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $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 ) )';

        if ($result = $this->db->queryF($sql)) {

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

The if-else statement can be simplified to return (bool) ($result = $this->db->queryF($sql));.

            return true;
        } else {
            //xoops_error($this->db->error());

73% of this comment could be valid code. Did you maybe forget this after debugging?

            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 gc($expire)

This method's name is shorter than the configured minimum length of 3 characters.

    {
        global $xoopsModule;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        $sql = 'DELETE FROM ' . $this->db->prefix('newbb_online') . ' WHERE online_updated < ' . (time() - (int)$expire);
        $this->db->queryF($sql);

        $xoops_onlineHandler = xoops_getHandler('online');

$xoops_onlineHandler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $xoops_onlineHandler->gc($expire);

$xoops_onlineHandler does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    }

    /**
     * Get an array of online information
     *
     * @param  \CriteriaElement $criteria {@link \CriteriaElement}

Should the type for parameter $criteria not be null|\CriteriaElement?

     * @return array           Array of associative arrays of online information
     */
    public function getAll(\CriteriaElement $criteria = null)
    {
        $ret   = [];
        $limit = $start = 0;
        $sql   = 'SELECT * FROM ' . $this->db->prefix('newbb_online');
        if (is_object($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
            $sql   .= ' ' . $criteria->renderWhere();
            $limit = $criteria->getLimit();
            $start = $criteria->getStart();
        }
        $result = $this->db->query($sql, $limit, $start);
        if (!$result) {
            return $ret;
        }
        while ($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 $uids
     * @return array
     */
    public function checkStatus($uids)
    {
        $online_users = [];

$online_users does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $ret          = [];
        if (!empty($this->user_ids)) {
            $online_users = $this->user_ids;

$online_users does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        } else {
            $sql = 'SELECT online_uid FROM ' . $this->db->prefix('newbb_online');
            if (!empty($uids)) {
                $sql .= ' WHERE online_uid IN (' . implode(', ', array_map('intval', $uids)) . ')';
            }

            $result = $this->db->query($sql);
            if (!$result) {
                return $ret;
            }
            while (list($uid) = $this->db->fetchRow($result)) {
                $online_users[] = $uid;

$online_users does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            }
        }
        foreach ($uids as $uid) {
            if (in_array($uid, $online_users)) {

$online_users does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                $ret[$uid] = 1;
            }
        }

        return $ret;
    }

    /**
     * Count the number of online users
     *
     * @param  \CriteriaElement $criteria {@link CriteriaElement}

Should the type for parameter $criteria not be null|\CriteriaElement?

     * @return bool
     */
    public function getCount(\CriteriaElement $criteria = null)

function getCount() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('newbb_online');
        if (is_object($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        list($ret) = $this->db->fetchRow($result);

        return $ret;
    }
}