OnlineHandler::getAll() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/mambax..." - mambax7/newbb5 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 62af87...249590 )

by Michael

created 2018-01-13 06:18 UTC

OnlineHandler::getAll() B

↳ Parent: OnlineHandler

Complexity

Conditions	6
Paths	8

Size

Total Lines	25
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	18
nc	8
nop	1
dl	0
loc	25
rs	8.439
c	0
b	0
f	0

<?php namespace XoopsModules\Newbb;


/**
 * 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.) <[email protected]>
 * @since          4.00
 * @package        module::newbb
 */

use Xmf\IPAddress;
use XoopsModules\Newbb;

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


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

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

    public $forum_id;

    public $forumObject;
    public $topic_id;

    public $user_ids = [];


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

    {
        $this->db = $db;
    }

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

            $this->forum_id    = $forum->getVar('forum_id');
            $this->forumObject = $forum;
        } 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();
    }

    public function update()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}

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

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

        if (!$xoopsupdate) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            //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) {

            $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 = [];

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

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

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

                'link'  => XOOPS_URL . '/userinfo.php?uid=' . $users[$i]['online_uid'],
                'uname' => $users[$i]['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          = [];

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

            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
     */
    public function showOnline()
    {
        include_once __DIR__ . '/../include/functions.render.php';
        include_once __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 = [];

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

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

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

                'link'  => XOOPS_URL . '/userinfo.php?uid=' . $users[$i]['online_uid'],
                'uname' => $users[$i]['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          = [];

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

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

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

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

    {
        global $xoopsModule, $xoopsDB;
function myFunction($a, $b) {
    // Do something
}

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

            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 $xoops_onlineHandler */
        $xoops_onlineHandler = xoops_getHandler('online');

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

        if ($result = $this->db->queryF($sql)) {
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            return true;
        } else {
            //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 gc($expire)

    {
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}
        $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->gc($expire);

    }

    /**
     * Get an array of online information
     *
     * @param  \CriteriaElement $criteria {@link \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 = [];

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

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

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

                $ret[$uid] = 1;
            }
        }

        return $ret;
    }

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

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

    {
        $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;
    }
}


Push — master ( 62af87...249590 )

OnlineHandler::getAll() B

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php namespace XoopsModules\Newbb;
			0 ignored issues – show Coding Style Compatibility introduced 2018-01-13 06:21 UTC by Report Bug Copy Issue Report 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. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			/**
4			* NewBB 5.0x, the forum module for XOOPS project
5			*
6			* @copyright XOOPS Project (https://xoops.org)
7			* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
8			* @author Taiwen Jiang (phppp or D.J.) <[email protected]>
9			* @since 4.00
10			* @package module::newbb
11			*/
12
13			use Xmf\IPAddress;
14			use XoopsModules\Newbb;
15
16			// defined('XOOPS_ROOT_PATH') \|\| exit('Restricted access.');
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-13 06:21 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
17
18			include_once __DIR__ . '/../include/functions.config.php';
19
20			/**
21			* Class OnlineHandler
22			*/
23			class OnlineHandler
24			{
25			public $db;
			0 ignored issues – show Comprehensibility introduced 2017-11-20 06:47 UTC by Report Bug Copy Issue Report Avoid variables with short names like $db. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
26			public $forum_id;
			0 ignored issues – show Coding Style introduced 2017-11-20 06:47 UTC by Report Bug Copy Issue Report `$forum_id` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
27			public $forumObject;
28			public $topic_id;
			0 ignored issues – show Coding Style introduced 2017-11-20 06:47 UTC by Report Bug Copy Issue Report `$topic_id` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
29			public $user_ids = [];
			0 ignored issues – show Coding Style introduced 2018-01-13 06:21 UTC by Report Bug Copy Issue Report `$user_ids` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
30
31			/**
32			* OnlineHandler constructor.
33			* @param \XoopsDatabase $db
34			*/

mambax7 / newbb5

Push — master ( 62af87...249590 )

OnlineHandler::getAll() B

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like