Manager::getRuleGuid() - Code Metrics - Inspection of "Update manager" - pgaultier/yii2-redis-rbac - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — devel ( a8277a...da4c7c )

by Philippe
created 2016-05-02 11:26 UTC
Manager::getRuleGuid() A

↳ Parent: Manager
Complexity

Conditions	1
Paths	1
Size

Total Lines	6
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	4
CRAP Score	1
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	4
cts	4
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	1
crap	1
<?php
/**
 * Manager.php
 *
 * PHP version 5.6+
 *
 * @author Philippe Gaultier <[email protected]>
 * @copyright 2010-2016 Philippe Gaultier
 * @license http://www.sweelix.net/license license
 * @version XXX
 * @link http://www.sweelix.net
 * @package sweelix\rbac\redis
 */

namespace sweelix\rbac\redis;

use sweelix\guid\Guid;
use Yii;
use yii\base\InvalidCallException;
use yii\base\InvalidParamException;
use yii\di\Instance;
use yii\rbac\Assignment;
use yii\rbac\BaseManager;
use yii\rbac\Permission;
use yii\rbac\Role;
use yii\rbac\Item;
use yii\rbac\Rule;
use yii\redis\Connection;

/**
 * REDIS Manager represents an authorization manager that stores
 * authorization information in REDIS database
 *
 * @author Philippe Gaultier <[email protected]>
 * @copyright 2010-2016 Philippe Gaultier
 * @license http://www.sweelix.net/license license
 * @version XXX
 * @link http://www.sweelix.net
 * @package application\controllers
 * @since XXX
 */
class Manager extends BaseManager
{
    /**
     * @var Connection|array|string the Redis DB connection object or the application component ID of the DB connection.
     */
    public $db = 'redis';

    /**
     * @var string
     */
    public $globalMatchKey = 'auth:*';

    /**
     * @var string
     */
    public $userAssignmentsKey = 'auth:users:{id}:assignments';

    /**
     * @var string
     */
    public $roleAssignmentsKey = 'auth:roles:{id}:assignments';

    /**
     * @var string
     */
    public $ruleKey = 'auth:rules:{id}';

    /**
     * @var string
     */
    public $typeItemsKey = 'auth:types:{id}:items';

    /**
     * @var string
     */
    public $itemKey = 'auth:items:{id}';

    /**
     * @var string
     */
    public $ruleItemsKey = 'auth:rules:{id}:items';

    /**
     * @var string
     */
    public $itemChildrenKey = 'auth:items:{id}:children';

    /**
     * @var string
     */
    public $itemParentsKey = 'auth:items:{id}:parents';

    /**
     * @var string
     */
    public $itemMappings = 'auth:mappings:items';

    /**
     * @var string
     */
    public $itemMappingsGuid = 'auth:mappings:itemsguid';

    /**
     * @var string
     */
    public $ruleMappings = 'auth:mappings:rules';

    /**
     * @var string
     */
    public $ruleMappingsGuid = 'auth:mappings:rulesguid';


    /**
     * @param string|integer $userId user id
     * @return string the user assignments key
     * @since XXX
     */
    public function getUserAssignmentsKey($userId)
    {
        return str_replace('{id}', $userId, $this->userAssignmentsKey);
    }

    /**
     * @param string $roleGuid role guid
     * @return string the rule assignments key
     * @since XXX
     */
    public function getRoleAssignmentsKey($roleGuid)
    {
        return str_replace('{id}', $roleGuid, $this->roleAssignmentsKey);
    }

    /**
     * @param string $ruleGuid rule guid
     * @return string the rule key
     * @since XXX
     */
    public function getRuleKey($ruleGuid)
    {
        return str_replace('{id}', $ruleGuid, $this->ruleKey);
    }

    /**
     * @param integer $typeId type id
     * @return string the type id key
     * @since XXX
     */
    public function getTypeItemsKey($typeId)
    {
        return str_replace('{id}', $typeId, $this->typeItemsKey);
    }

    /**
     * @param string $itemGuid item guid
     * @return string
     * @since XXX
     */
    public function getItemKey($itemGuid)
    {
        return str_replace('{id}', $itemGuid, $this->itemKey);
    }

    /**
     * @param string $ruleGuid rule guid
     * @return string the rule items key
     * @since XXX
     */
    public function getRuleItemsKey($ruleGuid)
    {
        return str_replace('{id}', $ruleGuid, $this->ruleItemsKey);
    }

    /**
     * @param string $itemGuid item guid
     * @return string the item children key
     * @since XXX
     */
    public function getItemChildrenKey($itemGuid)
    {
        return str_replace('{id}', $itemGuid, $this->itemChildrenKey);
    }

    /**
     * @param string $itemGuid item guid
     * @return string the item parents key
     * @since XXX
     */
    public function getItemParentsKey($itemGuid)
    {
        return str_replace('{id}', $itemGuid, $this->itemParentsKey);
    }

    /**
     * @return string the item mapping key
     * @since XXX
     */
    public function getItemMappingKey()
    {
        return $this->itemMappings;
    }

    /**
     * @return string the rule mapping key
     * @since XXX
     */
    public function getRuleMappingKey()
    {
        return $this->ruleMappings;
    }

    /**
     * @return string the item mapping key
     * @since XXX
     */
    public function getItemMappingGuidKey()
    {
        return $this->itemMappingsGuid;
    }

    /**
     * @return string the rule mapping key
     * @since XXX
     */
    public function getRuleMappingGuidKey()
    {
        return $this->ruleMappingsGuid;
    }


    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        $this->db = Instance::ensure($this->db, Connection::className());
    }

    /**
     * @inheritdoc
     */
    protected function getItem($name)
    {
        $item = null;
        $guid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $name]);
        if ($guid !== null)
        {
            $item = $this->getItemByGuid($guid, $name);
        }
        return $item;
    }

    /**
     * @param string $guid item guid
     * @param string $name name if known to avoid additional call
     * @return mixed
     * @since XXX
     */
    protected function getItemByGuid($guid, $name = null)
    {
        if ($name === null) {
            $name = $this->db->executeCommand('HGET', [$this->getItemMappingGuidKey(), $guid]);
        }
        $data = $this->db->executeCommand('HGETALL', [$this->getItemKey($guid)]);
        $dataRow = ['name' => $name];
        $nbProps = count($data);
        for ($i = 0; $i < $nbProps; $i = $i + 2) {
            $dataRow[$data[$i]] = $data[($i + 1)];
        }
        if (isset($dataRow['ruleGuid']) === true) {
            $ruleName = $this->db->executeCommand('HGET', [$this->getRuleMappingGuidKey(), $dataRow['ruleGuid']]);
            if ($ruleName !== null) {
                $dataRow['ruleName'] = $ruleName;
            }
            unset($dataRow['ruleGuid']);
        } elseif(isset($dataRow['ruleClass']) === true) {
            $dataRow['ruleName'] = $dataRow['ruleClass'];
            unset($dataRow['ruleClass']);
        }
        $item = $this->populateItem($dataRow);
        return $item;
    }

    /**
     * @inheritdoc
     */
    protected function getItems($type)
    {
        $itemGuids = $this->db->executeCommand('SMEMBERS', [$this->getTypeItemsKey($type)]);
        $items = [];
        foreach($itemGuids as $itemGuid) {
            $item = $this->getItemByGuid($itemGuid);
            $items[$item->name] = $item;
        }
        return $items;
    }

    /**
     * @inheritdoc
     */
    protected function addItem($item)
    {
        if (empty($item->name) === true) {
            throw new InvalidParamException("Item name must be defined");
        }
        $itemExists = (int)$this->db->executeCommand('HEXISTS', [$this->getItemMappingKey(), $item->name]);
        if ($itemExists === 1)
        {
            throw new DuplicateKeyException("Rule '{$item->name}' already defined");
        }
        $guid = Guid::v4();
        $time = time();
        if ($item->createdAt === null) {
            $item->createdAt = $time;
        }
        if ($item->updatedAt === null) {
            $item->updatedAt = $time;
        }

        $insertInRedis = $this->buildRedisItemInsert($item, $guid);
        $this->db->executeCommand('MULTI');
        // update mapping
        $this->db->executeCommand('HSET', [$this->getItemMappingKey(), $item->name, $guid]);
        $this->db->executeCommand('HSET', [$this->getItemMappingGuidKey(), $guid, $item->name]);
        // insert item
        $this->db->executeCommand('HMSET', $insertInRedis);
        $this->db->executeCommand('SADD', [$this->getTypeItemsKey($item->type), $guid]);
        // affect rule
        if (isset($insertInRedis['ruleGuid']) === true) {
            $this->db->executeCommand('SADD', [$this->getRuleItemsKey($insertInRedis['ruleGuid']), $guid]);
        }
        $this->db->executeCommand('EXEC');
        return true;

    }

    /**
     * @param Item $item item to insert in DB
     * @param string $guid guid generated
     * @return array Redis command
     * @since XXX
     */
    private function buildRedisItemInsert($item, $guid)
    {
        $insertItem = [$this->getItemKey($guid),
            'data', serialize($item->data),
            'type', $item->type,
            'createdAt', $item->createdAt,
            'updatedAt', $item->updatedAt
        ];
        $ruleGuid = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $ruleGuid = $this->db->executeCommand('HGET', [$this->getRuleMappingKey(), $item->ruleName]);

        if ($ruleGuid !== null) {
            $insertItem[] = 'ruleGuid';
            $insertItem[] = $ruleGuid;
        } elseif (class_exists($item->ruleName) || Yii::$container->has($item->ruleName)) {
            $insertItem[] = 'ruleClass';
            $insertItem[] = $item->ruleName;
        }

        if ($item->description !== null) {
            $insertItem[] = 'description';
            $insertItem[] = $item->description;
        }
        return $insertItem;
    }

    /**
     * @inheritdoc
     */
    protected function updateItem($name, $item)
    {
        $item->updatedAt = time();

        $guid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $name]);

        $ruleGuid = null;
        $ruleClass = null;
        if (empty($item->ruleName) === false) {
            $ruleGuid = $this->db->executeCommand('HGET', [$this->getRuleMappingKey(), $item->ruleName]);
            if (($ruleGuid === null) && class_exists($item->ruleName)) {
                $ruleClass = $item->ruleName;
            } elseif(($ruleGuid === null) && (Yii::$container->has($item->ruleName))) {
                $ruleClass = $item->ruleName;
            }
        }
        $newRule = ($ruleGuid === null) ? $ruleClass : $ruleGuid;

        list($currentRuleGuid, $currentRuleClass, $currentType) = $this->db->executeCommand('HMGET', [$this->getItemKey($guid), 'ruleGuid', 'ruleClass', 'type']);

        $oldRule = ($currentRuleGuid === null) ? $currentRuleClass : $currentRuleGuid;

        $this->db->executeCommand('MULTI');
        if ($name !== $item->name) {
            // delete old mapping
            $this->db->executeCommand('HDEL', [$this->getItemMappingKey(), $name]);
            // add new mapping
            $this->db->executeCommand('HSET', [$this->getItemMappingKey(), $item->name, $guid]);
            $this->db->executeCommand('HSET', [$this->getItemMappingGuidKey(), $guid, $item->name]);
        }

        $updateEmptyItem = [$this->getItemKey($guid)];
        $updateItem = [$this->getItemKey($guid),
            'data', serialize($item->data),
            'type', $item->type,
            'createdAt', $item->createdAt,
            'updatedAt', $item->updatedAt
        ];
        if ($item->description !== null) {
            $updateItem[] = 'description';
            $updateItem[] = $item->description;
        } else {
            $updateEmptyItem[] = 'description';
        }
        if ($newRule !== $oldRule) {
            if ($currentRuleGuid !== null) {
                $this->db->executeCommand('SREM', [$this->getRuleItemsKey($currentRuleGuid), $guid]);
            }
            if ($ruleGuid !== null) {
                $this->db->executeCommand('SADD', [$this->getRuleItemsKey($ruleGuid), $guid]);
            }
            if ($ruleGuid !== null) {
                $updateItem[] = 'ruleGuid';
                $updateItem[] = $ruleGuid;
            } else {
                $updateEmptyItem[] = 'ruleGuid';
            }
            if ($ruleClass !== null) {
                $updateItem[] = 'ruleClass';
                $updateItem[] = $ruleClass;
            } else {
                $updateEmptyItem[] = 'ruleClass';
            }
        }
        if ($item->type !== $currentType) {
            $this->db->executeCommand('SREM', [$this->getTypeItemsKey($currentType), $guid]);
            $this->db->executeCommand('SADD', [$this->getTypeItemsKey($item->type), $guid]);
        }

        // update item
        $this->db->executeCommand('HMSET', $updateItem);
        // remove useless props
        if (count($updateEmptyItem) > 1) {
            $this->db->executeCommand('HDEL', $updateEmptyItem);
        }


        $this->db->executeCommand('EXEC');
        return true;

    }

    /**
     * @inheritdoc
     */
    protected function removeItem($item)
    {
        $guid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $item->name]);
        $ruleGuid = $this->db->executeCommand('HGET', [$this->getRuleMappingKey(), $item->ruleName]);

        $parentGuids = $this->db->executeCommand('SMEMBERS', [$this->getItemParentsKey($guid)]);
        $childrenGuids = $this->db->executeCommand('SMEMBERS', [$this->getItemChildrenKey($guid)]);

        $this->db->executeCommand('MULTI');
        // delete mapping
        $this->db->executeCommand('HDEL', [$this->getItemMappingKey(), $item->name]);
        $this->db->executeCommand('HDEL', [$this->getItemMappingGuidKey(), $guid]);
        // delete rule <-> item link
        $this->db->executeCommand('SREM', [$this->getRuleItemsKey($ruleGuid), $guid]);
        $this->db->executeCommand('SREM', [$this->getTypeItemsKey($item->type), $guid]);
        // detach from hierarchy
        foreach($parentGuids as $parentGuid) {
            $this->db->executeCommand('SREM', [$this->getItemChildrenKey($parentGuid), $guid]);
        }
        // detach children
        foreach($childrenGuids as $childGuid) {
            $this->db->executeCommand('SREM', [$this->getItemParentsKey($childGuid), $guid]);
        }
        $this->db->executeCommand('DEL', [$this->getItemParentsKey($guid)]);
        $this->db->executeCommand('DEL', [$this->getItemChildrenKey($guid)]);
        // delete rule
        $this->db->executeCommand('DEL', [$this->getItemKey($guid)]);
        $this->db->executeCommand('EXEC');
        return true;

    }

    /**
     * @inheritdoc
     */
    protected function addRule($rule)
    {
        if(empty($rule->name) === true) {
            throw new InvalidParamException("Rule name must be defined");
        }
        $ruleExists = (int)$this->db->executeCommand('HEXISTS', [$this->getRuleMappingKey(), $rule->name]);
        if ($ruleExists === 1)
        {
            throw new DuplicateKeyException("Rule '{$rule->name}' already defined");
        }
        $guid = Guid::v4();
        $time = time();
        if ($rule->createdAt === null) {
            $rule->createdAt = $time;
        }
        if ($rule->updatedAt === null) {
            $rule->updatedAt = $time;
        }
        $this->db->executeCommand('MULTI');
        $this->db->executeCommand('HSET', [$this->getRuleMappingKey(), $rule->name, $guid]);
        $this->db->executeCommand('HSET', [$this->getRuleMappingGuidKey(),$guid, $rule->name]);
        $this->db->executeCommand('HMSET', [$this->getRuleKey($guid),
            'data', serialize($rule),
            'createdAt', $rule->createdAt,
            'updatedAt', $rule->updatedAt
        ]);

        $this->db->executeCommand('EXEC');
        return true;

    }

    /**
     * @inheritdoc
     */
    protected function updateRule($name, $rule)
    {
        $rule->updatedAt = time();

        $guid = $this->db->executeCommand('HGET', [$this->getRuleMappingKey(), $name]);

        $this->db->executeCommand('MULTI');
        if ($name !== $rule->name) {
            // delete old mapping
            $this->db->executeCommand('HDEL', [$this->getRuleMappingKey(), $name]);
            // add new mapping
            $this->db->executeCommand('HSET', [$this->getRuleMappingKey(), $rule->name, $guid]);
            $this->db->executeCommand('HSET', [$this->getRuleMappingGuidKey(),$guid, $rule->name]);
        }
        $this->db->executeCommand('HMSET', [$this->getRuleKey($guid),
            'data', serialize($rule),
            'createdAt', $rule->createdAt,
            'updatedAt', $rule->updatedAt
        ]);

        $this->db->executeCommand('EXEC');
        return true;
    }

    /**
     * @inheritdoc
     */
    protected function removeRule($rule)
    {
        $guid = $this->db->executeCommand('HGET', [$this->getRuleMappingKey(), $rule->name]);

        $ruleMembers = $this->db->executeCommand('SMEMBERS', [$this->getRuleItemsKey($guid)]);

        $this->db->executeCommand('MULTI');
        // delete mapping
        $this->db->executeCommand('HDEL', [$this->getRuleMappingKey(), $rule->name]);
        $this->db->executeCommand('HDEL', [$this->getRuleMappingGuidKey(), $guid]);
        // detach items
        foreach($ruleMembers as $itemGuid)
        {
            $this->db->executeCommand('HDEL', [$this->getItemKey($itemGuid), 'ruleGuid']);
        }
        // delete rule <-> item link
        $this->db->executeCommand('DEL', [$this->getRuleItemsKey($guid)]);
        // delete rule
        $this->db->executeCommand('DEL', [$this->getRuleKey($guid)]);
        $this->db->executeCommand('EXEC');
        return true;
    }

    /**
     * @inheritdoc
     */
    public function getRules()
    {
        $ruleNames = $this->db->executeCommand('HKEYS', [$this->getRuleMappingKey()]);
        $rules = [];
        foreach ($ruleNames as $ruleName)
        {
            $rules[$ruleName] = $this->getRule($ruleName);
        }
        return $rules;
    }

    /**
     * @inheritdoc
     */
    public function getRule($name)
    {
        $rule = null;
        $guid = $this->db->executeCommand('HGET', [$this->getRuleMappingKey(), $name]);
        if ($guid !== null) {
            $rule = $this->getRuleGuid($guid);
        } elseif(class_exists($name) === true) {
            $rule = new $name;
        } elseif(Yii::$container->has($name) === true) {
            $rule = Yii::$container->get($name);
        }
        return $rule;
    }

    /**
     * @param string $guid rule unique ID
     * @return Rule
     * @since XXX
     */
    protected function getRuleGuid($guid)
    {
        $data = $this->db->executeCommand('HGET', [$this->getRuleKey($guid), 'data']);
        $rule = unserialize($data);
        return $rule;
    }

    /**
     * @inheritdoc
     */
    public function addChild($parent, $child)
    {
        if ($parent->name === $child->name) {
            throw new InvalidParamException("Cannot add '{$parent->name}' as a child of itself.");
        }
        if ($parent instanceof Permission && $child instanceof Role) {
            throw new InvalidParamException('Cannot add a role as a child of a permission.');
        }
        if ($this->detectLoop($parent, $child)) {
            throw new InvalidCallException("Cannot add '{$child->name}' as a child of '{$parent->name}'. A loop has been detected.");
        }

        list($parentGuid, $childGuid) = $this->db->executeCommand('HMGET', [$this->getItemMappingKey(), $parent->name, $child->name]);

        $this->db->executeCommand('MULTI');
        $this->db->executeCommand('SADD', [$this->getItemParentsKey($childGuid), $parentGuid]);
        $this->db->executeCommand('SADD', [$this->getItemChildrenKey($parentGuid), $childGuid]);
        $this->db->executeCommand('EXEC');
        return true;
    }

    /**
     * @inheritdoc
     */
    public function removeChild($parent, $child)
    {
        list($parentGuid, $childGuid) = $this->db->executeCommand('HMGET', [$this->getItemMappingKey(), $parent->name, $child->name]);
        $this->db->executeCommand('MULTI');
        $this->db->executeCommand('SREM', [$this->getItemParentsKey($childGuid), $parentGuid]);
        $this->db->executeCommand('SREM', [$this->getItemChildrenKey($parentGuid), $childGuid]);
        $this->db->executeCommand('EXEC');
        return true;

    }

    /**
     * @inheritdoc
     */
    public function removeChildren($parent)
    {
        $guid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $parent->name]);
        $childrenGuids = $this->db->executeCommand('SMEMBERS', [$this->getItemChildrenKey($guid)]);

        $this->db->executeCommand('MULTI');
        foreach($childrenGuids as $childGuid)
        {
            $this->db->executeCommand('SREM', [$this->getItemParentsKey($childGuid), $guid]);
        }
        $this->db->executeCommand('DEL', [$this->getItemChildrenKey($guid)]);
        $this->db->executeCommand('EXEC');
        return true;

    }

    /**
     * @inheritdoc
     */
    public function getChildren($name)
    {
        $guid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $name]);
        return $this->getChildrenByGuid($guid);

    }

    /**
     * @param string $guid item guid
     * @return Item[]
     * @since XXX
     */
    protected function getChildrenByGuid($guid)
    {
        $childrenGuids = $this->db->executeCommand('SMEMBERS', [$this->getItemChildrenKey($guid)]);
        $children = [];
        if (count($childrenGuids) > 0) {
            foreach($childrenGuids as $childGuid) {
                $children[] = $this->getItemByGuid($childGuid);
            }
        }
        return $children;
    }

    /**
     * @inheritdoc
     */
    public function hasChild($parent, $child)
    {
        list($parentGuid, $childGuid) = $this->db->executeCommand('HMGET', [$this->getItemMappingKey(), $parent->name, $child->name]);
        $result = (int)$this->db->executeCommand('SISMEMBER', [$this->getItemChildrenKey($parentGuid), $childGuid]);

        return $result === 1;

    }

    /**
     * @inheritdoc
     */
    public function revokeAll($userId)
    {
        if (empty($userId) === true) {
            return false;
        }
        $roleGuids = $this->db->executeCommand('ZRANGEBYSCORE', [$this->getUserAssignmentsKey($userId), '-inf', '+inf']);
        $this->db->executeCommand('MULTI');
        if (count($roleGuids) > 0) {
            foreach ($roleGuids as $roleGuid) {
                $this->db->executeCommand('ZREM', [$this->getRoleAssignmentsKey($roleGuid), $userId]);
            }
        }
        $this->db->executeCommand('DEL', [$this->getUserAssignmentsKey($userId)]);
        $this->db->executeCommand('EXEC');
        return true;

    }

    /**
     * @inheritdoc
     */
    public function revoke($role, $userId)
    {
        if (empty($userId) === true) {
            return false;
        }
        $roleGuid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $role->name]);

        $this->db->executeCommand('MULTI');
        $this->db->executeCommand('ZREM', [$this->getUserAssignmentsKey($userId), $roleGuid]);
        $this->db->executeCommand('ZREM', [$this->getRoleAssignmentsKey($roleGuid), $userId]);
        $this->db->executeCommand('EXEC');
        return true;
    }

    /**
     * @inheritdoc
     */
    public function removeAllRoles()
    {
        $this->removeAllItems(Item::TYPE_ROLE);
    }

    /**
     * @inheritdoc
     */
    public function removeAllRules()
    {
        $rules = $this->getRules();
        foreach($rules as $rule) {
            $this->removeRule($rule);
        }
    }

    /**
     * @inheritdoc
     */
    public function removeAllPermissions()
    {
        $this->removeAllItems(Item::TYPE_PERMISSION);
    }

    /**
     * @inheritdoc
     */
    public function removeAll()
    {
        $authKeys = [];
        $nextCursor = 0;
        do {
            list($nextCursor, $keys) = $this->db->executeCommand('SCAN', [$nextCursor, 'MATCH', $this->globalMatchKey]);
            $authKeys = array_merge($authKeys, $keys);

        } while($nextCursor != 0);

        if (count($authKeys) > 0) {
            $this->db->executeCommand('DEL', $authKeys);
        }
    }

    /**
     * @inheritdoc
     */
    public function removeAllAssignments()
    {
        $roleAssignKey = $this->getRoleAssignmentsKey('*');
        $userAssignKey = $this->getUserAssignmentsKey('*');
        $assignmentKeys = [];

        $nextCursor = 0;
        do {
            list($nextCursor, $keys) = $this->db->executeCommand('SCAN', [$nextCursor, 'MATCH', $roleAssignKey]);
            $assignmentKeys = array_merge($assignmentKeys, $keys);

        } while($nextCursor != 0);

        $nextCursor = 0;
        do {
            list($nextCursor, $keys) = $this->db->executeCommand('SCAN', [$nextCursor, 'MATCH', $userAssignKey]);
            $assignmentKeys = array_merge($assignmentKeys, $keys);

        } while($nextCursor != 0);

        if (count($assignmentKeys) > 0) {
            $this->db->executeCommand('DEL', $assignmentKeys);
        }
    }

    /**
     * @param integer $type
     * @since XXX
     */
    public function removeAllItems($type)
    {
        $items = $this->getItems($type);
        foreach ($items as $item) {
            $this->removeItem($item);
        }
    }

    /**
     * @inheritdoc
     */
    public function getRolesByUser($userId)
    {
        if (!isset($userId) || $userId === '') {
            return [];
        }
        $roleGuids = $this->db->executeCommand('ZRANGEBYSCORE', [$this->getUserAssignmentsKey($userId), '-inf', '+inf']);
        $roles = [];
        if (count($roleGuids) > 0) {
            foreach ($roleGuids as $roleGuid) {
                $isRole = (int)$this->db->executeCommand('SISMEMBER', [$this->getTypeItemsKey(Item::TYPE_ROLE), $roleGuid]);
                if ($isRole === 1) {
                    $item = $this->getItemByGuid($roleGuid);
                    $roles[$item->name] = $item;
                }
            }
        }

        return $roles;
    }

    /**
     * @inheritdoc
     */
    public function getUserIdsByRole($roleName)
    {
        if (empty($roleName)) {
            return [];
        }
        $roleGuid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $roleName]);
        $userIds = [];
        if ($roleGuid !== null) {
            $userIds = $this->db->executeCommand('ZRANGEBYSCORE', [$this->getRoleAssignmentsKey($roleGuid), '-inf', '+inf']);
        }
        return $userIds;

    }

    /**
     * @inheritdoc
     */
    public function assign($role, $userId)
    {
        $assignment = new Assignment([
            'userId' => $userId,
            'roleName' => $role->name,
            'createdAt' => time(),
        ]);
        $roleGuid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $role->name]);

        $this->db->executeCommand('MULTI');
        $this->db->executeCommand('ZADD', [$this->getUserAssignmentsKey($userId), $assignment->createdAt, $roleGuid]);
        $this->db->executeCommand('ZADD', [$this->getRoleAssignmentsKey($roleGuid), $assignment->createdAt, $userId]);
        $this->db->executeCommand('EXEC');
        return $assignment;
    }

    /**
     * @inheritdoc
     */
    public function getPermissionsByUser($userId)
    {
        $rolesGuids = $this->db->executeCommand('ZRANGEBYSCORE', [$this->getUserAssignmentsKey($userId), '-inf', '+inf']);
        $permissions = [];
        if (count($rolesGuids) > 0) {
            $permissionsGuid = [];
            foreach($rolesGuids as $roleGuid) {
                $isPerm = (int)$this->db->executeCommand('SISMEMBER', [$this->getTypeItemsKey(Item::TYPE_PERMISSION), $roleGuid]);
                if ($isPerm === 1) {
                    $permissionsGuid[] = $roleGuid;
                }
            }
            foreach ($rolesGuids as $roleGuid) {
                list(, $permGuids) = $this->getChildrenRecursiveGuid($roleGuid, Item::TYPE_PERMISSION);
                $permissionsGuid = array_merge($permissionsGuid, $permGuids);
            }
            foreach($permissionsGuid as $permissionGuid) {
                $item = $this->getItemByGuid($permissionGuid);
                $permissions[$item->name] = $item;
            }
        }
        return $permissions;
    }

    /**
     * @inheritdoc
     */
    public function getPermissionsByRole($roleName)
    {
        $roleGuid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $roleName]);
        $permissions = [];
        list(, $permissionsGuid) = $this->getChildrenRecursiveGuid($roleGuid, Item::TYPE_PERMISSION);
        foreach($permissionsGuid as $permissionGuid) {
            $item = $this->getItemByGuid($permissionGuid);
            $permissions[$item->name] = $item;
        }
        return $permissions;
    }

    /**
     * @param string $itemGuid item unique ID
     * @param integer $type Item type
     * @return array
     * @since XXX
     */
    protected function getChildrenRecursiveGuid($itemGuid, $type)
    {
        $childrenGuid = $this->db->executeCommand('SMEMBERS', [$this->getItemChildrenKey($itemGuid)]);
        $typedChildrenGuid = $this->db->executeCommand('SINTER', [$this->getItemChildrenKey($itemGuid), $this->getTypeItemsKey($type)]);
        foreach($childrenGuid as $childGuid) {
            list($subChildrenGuid, $subTypedChildrenGuid) = $this->getChildrenRecursiveGuid($childGuid, $type);
            $childrenGuid = array_merge($childrenGuid, $subChildrenGuid);
            $typedChildrenGuid = array_merge($typedChildrenGuid, $subTypedChildrenGuid);
        }
        return [$childrenGuid, $typedChildrenGuid];
    }

    /**
     * @param Item $parent parent item
     * @param Item $child child item
     * @return bool
     * @since XXX
     */
    protected function detectLoop(Item $parent, Item $child)
    {
        if ($child->name === $parent->name) {
            return true;
        }
        foreach ($this->getChildren($child->name) as $grandchild) {
            if ($this->detectLoop($parent, $grandchild)) {
                return true;
            }
        }
        return false;
    }

    /**
     * @param string $itemName item name
     * @return array
     * @since XXX
     */
    public function getParents($itemName)
    {
        $itemGuid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $itemName]);
        return $this->getParentsGuid($itemGuid);
    }

    protected function getParentsGuid($itemGuid)
    {
        $parentsGuid = $this->db->executeCommand('SMEMBERS', [$this->getItemParentsKey($itemGuid)]);
        $parents = [];
        if (count($parentsGuid) > 0) {
            array_unshift($parentsGuid, $this->getItemMappingGuidKey());
            $parents = $this->db->executeCommand('HMGET', $parentsGuid);
        }
        return $parents;
    }

    /**
     * @inheritdoc
     */
    public function getAssignments($userId)
    {
        $roleGuids = $this->db->executeCommand('ZRANGEBYSCORE', [$this->getUserAssignmentsKey($userId), '-inf', '+inf', 'WITHSCORES']);
        $assignments = [];
        if (count($roleGuids) > 0) {
            $guids = [];
            $dates = [];
            $nbRolesGuids = count($roleGuids);
            for($i=0; $i < $nbRolesGuids; $i = $i+2) {
                $guids[] = $roleGuids[$i];
                $dates[] = $roleGuids[($i + 1)];
            }
            array_unshift($guids, $this->getItemMappingGuidKey());
            $names = $this->db->executeCommand('HMGET', $guids);
            foreach ($names as $i => $name) {
                $assignments[$name] = new Assignment([
                    'userId' => $userId,
                    'roleName' => $name,
                    'createdAt' => $dates[$i],
                ]);
            }
        }

        return $assignments;

    }

    /**
     * @inheritdoc
     */
    public function getAssignment($roleName, $userId)
    {
        $roleGuid = $this->db->executeCommand('HGET', [$this->getItemMappingKey(), $roleName]);
        $assignment = null;
        if ($roleGuid !== null) {
            $assignmentScore = $this->db->executeCommand('ZSCORE', [$this->getUserAssignmentsKey($userId), $roleGuid]);
            if ($assignmentScore !== null) {
                $assignment = new Assignment([
                    'userId' => $userId,
                    'roleName' => $roleName,
                    'createdAt' => $assignmentScore,
                ]);
            }
        }
        return $assignment;
    }

    /**
     * @inheritdoc
     */
    public function checkAccess($userId, $permissionName, $params = [])
    {
        $assignments = $this->getAssignments($userId);
        return $this->checkAccessRecursive($userId, $permissionName, $params, $assignments);
    }


    /**
     * @param Item $parent parent item
     * @param Item $child child item
     * @return bool
     * @since XXX
     */
    public function canAddChild(Item $parent, Item $child)
    {
        return !$this->detectLoop($parent, $child);
    }

    /**
     * @param string|integer $user user ID
     * @param string $itemName current item name
     * @param array $params parameters applied in rule
     * @param Assignment[] $assignments
     * @return bool
     * @since XXX
     * @throws \yii\base\InvalidConfigException
     */
    protected function checkAccessRecursive($user, $itemName, $params, $assignments)
    {
        if (($item = $this->getItem($itemName)) === null) {
            return false;
        }
        Yii::trace($item instanceof Role ? "Checking role: $itemName" : "Checking permission: $itemName", __METHOD__);
        if (!$this->executeRule($user, $item, $params)) {
            return false;
        }
        if (isset($assignments[$itemName]) || in_array($itemName, $this->defaultRoles)) {
            return true;
        }
        $parents = $this->getParents($itemName);
        foreach ($parents as $parent) {
            if ($this->checkAccessRecursive($user, $parent, $params, $assignments)) {
                return true;
            }
        }
        return false;
    }

    /**
     * @param array $dataRow
     * @return Permission|Role
     * @since XXX
     */
    protected function populateItem($dataRow)
    {
        $class = $dataRow['type'] == Item::TYPE_PERMISSION ? Permission::className() : Role::className();
        if (!isset($dataRow['data']) || ($data = @unserialize($dataRow['data'])) === false) {
            $data = null;
        }

        return new $class([
            'name' => $dataRow['name'],
            'type' => $dataRow['type'],
            'description' => isset($dataRow['description']) ? $dataRow['description'] : null,
            'ruleName' => isset($dataRow['ruleName']) ? $dataRow['ruleName'] : null,
            'data' => $data,
            'createdAt' => $dataRow['createdAt'],
            'updatedAt' => $dataRow['updatedAt'],
        ]);
    }
}

pgaultier / yii2-redis-rbac

Push — devel ( a8277a...da4c7c )

Manager::getRuleGuid() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
