PermissionForumHandler::setTemplate() - 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

PermissionForumHandler::setTemplate() A

↳ Parent: PermissionForumHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
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 XoopsModules\Newbb;

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


//defined("NEWBB_HANDLER_PERMISSION") || include __DIR__.'/permission.php';

//define("NEWBB_HANDLER_PERMISSION_FORUM", 1);

if (defined('FORUM_PERM_ITEMS') && class_exists('ForumPermissionHandler')) {
    exit('access denied');
}
// irmtfan add pdf and print permissions.
define('FORUM_PERM_ITEMS', 'access,view,post,reply,edit,delete,addpoll,vote,attach,noapprove,type,html,signature,pdf,print');

/**
 * Class PermissionForumHandler
 */
class PermissionForumHandler extends PermissionHandler
{
    protected $templateFilename;

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

    {
        //        $this->PermissionHandler($db);

        parent::__construct($db);
        $this->templateFilename = XOOPS_VAR_PATH . '/configs/newbb_permission_template.php';
    }

    /**
     * @param  bool $fullname
     * @return array
     */
    public function getValidPerms($fullname = false)
    {
        static $validPerms = [];
        if (isset($validPerms[(int)$fullname])) {
            return $validPerms[(int)$fullname];
        }
        $items = array_filter(array_map('trim', explode(',', FORUM_PERM_ITEMS)));
        if (!empty($fullname)) {
            foreach (array_keys($items) as $key) {
                $items[$key] = 'forum_' . $items[$key];
            }
        }
        $validPerms[(int)$fullname] = $items;

        return $items;
    }

    /**
     * @param        $mid
     * @param  int   $id
     * @return array
     */
    public function getValidItems($mid, $id = 0)
// 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);
    }
}
    {
        static $suspension = [];
        $full_items = [];

        if (empty($mid)) {
            return $full_items;

        }

        include_once __DIR__ . '/../include/functions.user.php';
        $uid = is_object($GLOBALS['xoopsUser']) ? $GLOBALS['xoopsUser']->getVar('uid') : 0;
        $ip  = \Xmf\IPAddress::fromRequest()->asReadable();

        if (!empty($GLOBALS['xoopsModuleConfig']['enable_usermoderate']) && !isset($suspension[$uid][$id])
            && !newbbIsAdmin($id)) {
            /** @var Newbb\ModerateHandler $moderateHandler */
            $moderateHandler = Newbb\Helper::getInstance()->getHandler('Moderate');
            if (!$moderateHandler->verifyUser($uid, '', $id)) {
                $suspension[$uid][$ip][$id] = 1;
            } else {
                $suspension[$uid][$ip][$id] = 0;
            }
        }

        $items = $this->getValidPerms();
        foreach ($items as $item) {
            /* skip access for suspended users */
            //if ( !empty($suspension[$uid][$ip][$id]) && in_array($item, array("post", "reply", "edit", "delete", "addpoll", "vote", "attach", "noapprove", "type")) ) continue;

            if (!empty($suspension[$uid][$ip][$id])) {
                continue;
            }
            $full_items[] = "'forum_{$item}'";

        }

        return $full_items;

    }

    /*
    * Returns permissions for a certain type
    *
    * @param int $id id of the item (forum, topic or possibly post) to get permissions for
    *
    * @return array
    */
    /**
     * @param  int $id
     * @return bool|array

     */
    public function getPermissions($id = 0)
// 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);
    }
}
    {
        $permissions = [];
        if (is_object($GLOBALS['xoopsModule']) && 'newbb' === $GLOBALS['xoopsModule']->getVar('dirname')) {

            $modid = $GLOBALS['xoopsModule']->getVar('mid');
        } else {
            /** @var \XoopsModuleHandler $moduleHandler */
            $moduleHandler = xoops_getHandler('module');
            $xoopsNewBB    = $moduleHandler->getByDirname('newbb');
            $modid         = $xoopsNewBB->getVar('mid');
            unset($xoopsNewBB);
        }

        // Get user's groups
        $groups = is_object($GLOBALS['xoopsUser']) ? $GLOBALS['xoopsUser']->getGroups() : [XOOPS_GROUP_ANONYMOUS];
        // Create string of groupid's separated by commas, inserted in a set of brackets
        if (count($groups) < 1) {
            return false;
        }
        // Create criteria for getting only the permissions regarding this module and this user's groups
        $criteria = new \CriteriaCompo(new \Criteria('gperm_modid', $modid));
        $criteria->add(new \Criteria('gperm_groupid', '(' . implode(',', $groups) . ')', 'IN'));
        if ($id) {

            if (is_array($id)) {
                $criteria->add(new \Criteria('gperm_itemid', '(' . implode(',', $id) . ')', 'IN'));
            } else {
                $criteria->add(new \Criteria('gperm_itemid', (int)$id));
            }
        }
        $gperm_names = implode(', ', $this->getValidItems($modid, $id));


        // Add criteria for gpermnames
        $criteria->add(new \Criteria('gperm_name', '(' . $gperm_names . ')', 'IN'));

        // Get all permission objects in this module and for this user's groups
        $userpermissions = $this->getObjects($criteria, true);

        // Set the granted permissions to 1
        foreach ($userpermissions as $gperm_id => $gperm) {

            $permissions[$gperm->getVar('gperm_itemid')][$gperm->getVar('gperm_name')] = 1;
        }
        $userpermissions = null;
        unset($userpermissions);

        // Return the permission array
        return $permissions;
    }

    /**
     * @param  Forum|int $forum

     * @param  bool      $topic_locked
     * @param  bool      $isAdmin
     * @return array
     */
    public function getPermissionTable($forum = 0, $topic_locked = false, $isAdmin = false)

    {
        $perm = [];

        $forumId = $forum;
        if (is_object($forum)) {
            $forumId = $forum->getVar('forum_id');
        }

        $permission_set = $this->getPermissions($forumId);


        $permItems = $this->getValidPerms();
        foreach ($permItems as $item) {
            if ('access' === $item) {
                continue;
            }
            if ($isAdmin
                || (isset($permission_set[$forumId]['forum_' . $item])

                    && (!$topic_locked

                        || 'view' === $item))) {
                $perm[] = constant('_MD_NEWBB_CAN_' . strtoupper($item));
            } else {
                $perm[] = constant('_MD_NEWBB_CANNOT_' . strtoupper($item));
            }
        }

        return $perm;
    }

    /**
     * @param $forum_id
     * @return bool
     */
    public function deleteByForum($forum_id)
// 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);
    }
}
    {
        $forum_id = (int)$forum_id;

        if (empty($forum_id)) {

            return false;
        }
        $gpermHandler = xoops_getHandler('groupperm');
        $criteria     = new \CriteriaCompo(new \Criteria('gperm_modid', $GLOBALS['xoopsModule']->getVar('mid')));
        $items        = $this->getValidPerms(true);
        $criteria->add(new \Criteria('gperm_name', "('" . implode("', '", $items) . "')", 'IN'));
        $criteria->add(new \Criteria('gperm_itemid', $forum_id));


        return $gpermHandler->deleteAll($criteria);
    }

    /**
     * @param       $forum
     * @param  int  $mid
     * @return bool
     */
    public function applyTemplate($forum, $mid = 0)
// 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);
    }
}
    {
        if (!$perm_template = $this->getTemplate()) {

            return false;
        }

        if (empty($mid)) {

            if (is_object($GLOBALS['xoopsModule']) && 'newbb' === $GLOBALS['xoopsModule']->getVar('dirname')) {
                $mid = $GLOBALS['xoopsModule']->getVar('mid');
            } else {
                /** @var \XoopsModuleHandler $moduleHandler */
                $moduleHandler = xoops_getHandler('module');
                $newbb         = $moduleHandler->getByDirname('newbb');
                $mid           = $newbb->getVar('mid');
                unset($newbb);
            }
        }

        /** @var \XoopsMemberHandler $memberHandler */
        $memberHandler = xoops_getHandler('member');
        $glist         = $memberHandler->getGroupList();
        $perms         = $this->getValidPerms(true);
        foreach (array_keys($glist) as $group) {
            foreach ($perms as $perm) {
                if (!empty($perm_template[$group][$perm])) {

                    $this->validateRight($perm, $forum, $group, $mid);
                } else {
                    $this->deleteRight($perm, $forum, $group, $mid);
                }
            }
        }

        return true;
    }

    /**
     * @return array|false
     */
    public function getTemplate()
    {
        $perms = \Xmf\Yaml::readWrapped($this->templateFilename);
        return $perms;
    }

    /**
     * @param array $perms
     * @return bool
     */
    public function setTemplate($perms)

    {
        return \Xmf\Yaml::saveWrapped($perms, $this->templateFilename);
    }
}


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 24 and the first side effect is on line 21. 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 XoopsModules\Newbb;
14
15			// defined('XOOPS_ROOT_PATH') \|\| exit('Restricted access.');
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-07 04:30 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...
16
17			//defined("NEWBB_HANDLER_PERMISSION") \|\| include __DIR__.'/permission.php';
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-06-25 02:50 UTC by Report Bug Copy Issue Report `64%` 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...
18			//define("NEWBB_HANDLER_PERMISSION_FORUM", 1);
19
20			if (defined('FORUM_PERM_ITEMS') && class_exists('ForumPermissionHandler')) {
21			exit('access denied');
22			}
23			// irmtfan add pdf and print permissions.
24			define('FORUM_PERM_ITEMS', 'access,view,post,reply,edit,delete,addpoll,vote,attach,noapprove,type,html,signature,pdf,print');
25
26			/**
27			* Class PermissionForumHandler
28			*/
29			class PermissionForumHandler extends PermissionHandler
30			{
31			protected $templateFilename;
32
33			/**
34			* @param \XoopsDatabase $db
35			*/
36			public function __construct(\XoopsDatabase $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...

mambax7 / newbb5

Push — master ( 62af87...249590 )

PermissionForumHandler::setTemplate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like