Micro\Auth\Drivers\DbAcl

Complexity

Total Complexity

19

Size/Duplication

Total Lines	230
Duplicated Lines	13.48 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	15	30	4
A	check()	0	20	1
A	createRole()	3	6	2
A	createPermission()	3	6	2
A	deletePermission()	0	4	1
A	deleteRole()	0	8	2
A	rolePerms()	10	10	1
A	assignRolePermission()	0	4	1
A	revokeRolePermission()	0	4	1
A	grantPrivilege()	0	8	2
A	forbidPrivilege()	0	8	2

<?php /** MicroDbACL */

namespace Micro\Auth\Drivers;

use Micro\Db\IConnection;
use Micro\Mvc\Models\Query;

/**
 * Database ACL class file.
 *
 * ACL security logic with DB
 *
 * @author Oleg Lunegov <testuser@mail.linpax.org>
 * @link https://github.com/linpax/microphp-framework
 * @copyright Copyright (c) 2013 Oleg Lunegov
 * @license https://github.com/linpax/microphp-framework/blob/master/LICENSE
 * @package Micro
 * @subpackage Auth\Drivers
 * @version 1.0
 * @since 1.0
 */
class DbAcl extends Acl
{
    /**
     * Constructor DB acl
     *
     * @access public
     *
     * @param IConnection $db
     * @param array $params config array
     *
     * @result void
     */
    public function __construct(IConnection $db, array $params = [])
    {
        parent::__construct($db, $params);

        /** @var array $tables */
        $tables = $this->db->listTables();

        if (empty($tables['acl_role'])) {
            $this->db->createTable('acl_role', [
                '`id` int(10) unsigned NOT NULL AUTO_INCREMENT',
                '`name` varchar(255) NOT NULL',
                'PRIMARY KEY (`id`)'
            ], 'ENGINE=MyISAM DEFAULT CHARSET=utf8');
        }
        if (empty($tables['acl_perm'])) {

This code seems to be duplicated across your project.

            $this->db->createTable('acl_perm', [
                '`id` int(10) unsigned NOT NULL AUTO_INCREMENT',
                '`name` varchar(255) NOT NULL',
                'PRIMARY KEY (`id`)'
            ], 'ENGINE=MyISAM DEFAULT CHARSET=utf8');
        }
        if (empty($tables['acl_role_perm'])) {

This code seems to be duplicated across your project.

            $this->db->createTable('acl_role_perm', [
                '`id` int(10) unsigned NOT NULL AUTO_INCREMENT',
                '`role` int(11) unsigned DEFAULT NOT NULL',
                '`perm` int(11) unsigned DEFAULT NOT NULL',
                'PRIMARY KEY (`id`)'
            ], 'ENGINE=MyISAM DEFAULT CHARSET=utf8');
        }
    }

    /**
     * Check user access to permission
     *
     * @access public
     *
     * @param integer $userId user id
     * @param string $permission checked permission
     * @param array $data for compatible, not used!
     *
     * @return bool
     * @throws \Micro\Base\Exception
     */
    public function check($userId, $permission, array $data = [])
    {
        $query = new Query($this->db);
        $query->select = '*';
        $query->table = '`acl_user` AS `au`';

        $query->addJoin('`acl_perm` AS  `ap`', '`ap`.`id` =  `au`.`perm`');
        $query->addJoin('`acl_role_perm` AS  `arp`', '`arp`.`role` =  `au`.`role`');
        $query->addJoin('`acl_perm` AS  `ap1`', '`ap1`.`id` =  `arp`.`perm`');

        $query->addWhere('`au`.`user`='.$userId);
        $query->addWhere('`ap`.`name`=:perm OR `ap1`.`name`=:perm');

        $query->limit = 1;

        $query->params = [':perm' => $permission];
        $query->single = true;

        return (bool)$query->run();
    }

    /**
     * Create new role
     *
     * @access public
     *
     * @param string $name role name
     *
     * @return void
     */
    public function createRole($name)
    {
        if (!$this->db->exists('acl_role', ['name' => $name])) {

This code seems to be duplicated across your project.

            $this->db->insert('acl_role', ['name' => $name]);
        }
    }

    /**
     * Create new permission
     *
     * @access public
     *
     * @param string $name permission name
     *
     * @return void
     */
    public function createPermission($name)
    {
        if (!$this->db->exists('acl_role', ['name' => $name])) {

This code seems to be duplicated across your project.

            $this->db->insert('acl_role', ['name' => $name]);
        }
    }

    /**
     * Delete permission by name
     *
     * @access public
     *
     * @param string $name permission name
     *
     * @return void
     */
    public function deletePermission($name)
    {
        $this->db->delete('acl_perm', ['name' => $name]);

array('name' => $name) is of type array<string,string,{"name":"string"}>, but the function expects a string.

    }

    /**
     * Delete role by name
     *
     * @access public
     *
     * @param string $name role name
     *
     * @return void
     * @throws \Micro\Base\Exception
     */
    public function deleteRole($name)
    {
        foreach ($this->rolePerms($name) AS $perm) {
            $this->db->delete('acl_role_perm', ['id' => $perm['perm']]);

array('id' => $perm['perm']) is of type array<string,?,{"id":"?"}>, but the function expects a string.

        }

        $this->db->delete('acl_role', ['name' => $name]);

array('name' => $name) is of type array<string,string,{"name":"string"}>, but the function expects a string.

    }

    /**
     * Get role perms
     *
     * @access public
     *
     * @param string $role role name
     *
     * @return array
     * @throws \Micro\Base\Exception
     */
    protected function rolePerms($role)

This method seems to be duplicated in your project.

    {
        $query = new Query($this->db);
        $query->select = '*';
        $query->table = 'acl_role_perm';
        $query->addWhere('role='.$role);
        $query->single = false;

        return $query->run();
    }

    /**
     * Assign role permission
     *
     * @access public
     *
     * @param string $role role name
     * @param string $permission permission name
     *
     * @return void
     */
    public function assignRolePermission($role, $permission)
    {
        $this->db->insert('acl_role_perm', ['role' => $role, 'perm' => $permission]);
    }

    /**
     * Revoke role permission
     *
     * @access public
     *
     * @param string $role role name
     * @param string $permission permission name
     *
     * @return void
     */
    public function revokeRolePermission($role, $permission)
    {
        $this->db->delete('acl_role_perm', ['role' => $role, 'perm' => $permission]);

array('role' => $role, 'perm' => $permission) is of type array<string,string,{"role":"string","perm":"string"}>, but the function expects a string.

    }

    /**
     * Grant privilege to user
     *
     * @access public
     *
     * @param integer $userId user ID
     * @param integer $privilege privilege ID
     * @param boolean $asRole as role?
     *
     * @return void
     */
    public function grantPrivilege($userId, $privilege = null, $asRole = true)
    {
        if ($asRole) {
            $this->db->insert('acl_user', ['user' => $userId, 'role' => $privilege]);
        } else {
            $this->db->insert('acl_user', ['user' => $userId, 'perm' => $privilege]);
        }
    }

    /**
     * Forbid privilege
     *
     * @access public
     *
     * @param integer $userId user ID
     * @param integer $privilege privilege ID
     * @param bool $asRole as role?
     */
    public function forbidPrivilege($userId, $privilege = null, $asRole = true)
    {
        if ($asRole) {
            $this->db->delete('acl_user', '`user`="'.$userId.'" AND `role`="'.$privilege.'"');
        } else {
            $this->db->delete('acl_user', '`user`="'.$userId.'" AND `perm`="'.$privilege.'"');
        }
    }
}