XoopsModules\Newbb\PermissionForumHandler

Complexity

Total Complexity

42

Size/Duplication

Total Lines	245
Duplicated Lines	11.02 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getValidPerms()	0	16	4
D	getValidItems()	0	34	9
C	getPermissions()	16	46	8
C	getPermissionTable()	0	28	8
A	deleteByForum()	0	14	2
C	applyTemplate()	11	34	8
A	getTemplate()	0	5	1
A	setTemplate()	0	4	1

<?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 24 and the first side effect is on line 21.

/**
 * 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 XoopsModules\Newbb;

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

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

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

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

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

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

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

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

        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)

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

    {
        static $suspension = [];
        $full_items = [];

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

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

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

        }

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

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

        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;

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

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

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

        }

        return $full_items;

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

    }

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

Consider making the return type a bit more specific; maybe use false|array.

     */
    public function getPermissions($id = 0)

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

    {
        $permissions = [];
        if (is_object($GLOBALS['xoopsModule']) && 'newbb' === $GLOBALS['xoopsModule']->getVar('dirname')) {

This code seems to be duplicated across your project.

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

This code seems to be duplicated across your project.

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

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

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

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

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

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

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

        // Return the permission array
        return $permissions;
    }

    /**
     * @param  Forum|int $forum

Consider making the type for parameter $forum a bit more specific; maybe use integer.

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

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

    {
        $perm = [];

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

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

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

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

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

                    && (!$topic_locked

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

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

function deleteByForum() 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]*$).

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

    {
        $forum_id = (int)$forum_id;

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

        if (empty($forum_id)) {

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

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

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

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

    /**
     * @param       $forum
     * @param  int  $mid
     * @return bool
     */
    public function applyTemplate($forum, $mid = 0)

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

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

    {
        if (!$perm_template = $this->getTemplate()) {

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

            return false;
        }

        if (empty($mid)) {

This code seems to be duplicated across your project.

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

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

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

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

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