Ubiquity\security\acl\models\AclList

Complexity

Total Complexity

52

Size/Duplication

Total Lines	251
Duplicated Lines	0 %

Test Coverage

Coverage

83.64%

Importance

Changes	5
Bugs	0	Features	1

25 Methods

Rating	Name	Duplication	Size	Complexity
A	getProviders()	0	2	1
A	setProviders()	0	2	1
A	getResourceByName()	0	2	1
A	loadAcls()	0	5	2
A	getRoles()	0	2	1
A	getResources()	0	2	1
A	loadPermissions()	0	5	2
A	elementExistByName()	0	7	3
A	getProviderClasses()	0	6	2
A	hasCache()	0	7	3
A	getAcls()	0	2	1
A	getPermissionByName()	0	2	1
A	getElementsNames()	0	6	2
A	loadRoles()	0	5	2
A	getElementByName()	0	7	3
A	__construct()	0	3	1
A	isAllowed()	0	12	4
A	addProvider()	0	2	1
A	getPermissions()	0	2	1
A	getRoleByName()	0	2	1
A	getAclById_()	0	7	3
A	loadResources()	0	5	2
A	getProvider()	0	7	3
B	getRolePermissionsOn()	0	17	8
A	init()	0	14	2

<?php
namespace Ubiquity\security\acl\models;

use Ubiquity\security\acl\persistence\AclProviderInterface;
use Ubiquity\exceptions\AclException;
use Ubiquity\security\acl\models\traits\AclListOperationsTrait;
use Ubiquity\security\acl\models\traits\AclListQueryTrait;
use Ubiquity\security\acl\persistence\AclCacheProvider;

/**
 * Ubiquity\security\acl\models$AclList
 * This class is part of Ubiquity
 *
 * @author jc
 * @version 1.0.1
 *
 */
class AclList {
	use AclListOperationsTrait,AclListQueryTrait;

	/**
	 *
	 * @var AclElement[]
	 */
	protected $acls;

	/**
	 *
	 * @var Role[]
	 */
	protected $roles;

	/**
	 *
	 * @var \Ubiquity\security\acl\models\Resource[]
	 */
	protected $resources;

	/**
	 *
	 * @var Permission[]
	 */
	protected $permissions;

	/**
	 *
	 * @var AclProviderInterface[]
	 */
	protected $providers = [];

	protected $elementsCache = [];

	protected function getElementByName(string $name, array $inArray, string $type) {
		foreach ($inArray as $elm) {
			if ($elm->getName() == $name) {
				return $elm;
			}
		}
		throw new AclException("$name does not exist in $type ACL");
	}

	protected function elementExistByName(string $name, array $inArray): bool {
		foreach ($inArray as $elm) {
			if ($elm->getName() == $name) {
				return true;
			}
		}
		return false;
	}

	public function __construct() {
		$this->providers = [];
		$this->init();
	}

	public function init() {
		$this->roles = [
			'@ALL' => new Role('@ALL')
		];
		$this->resources = [
			'*' => new Resource('*')
		];
		$this->permissions = [
			'ALL' => new Permission('ALL', 1000)
		];
		$this->elementsCache = [];
		$this->acls = [];
		foreach ($this->providers as $prov) {
			$prov->clearAll();
		}
	}

	public function getRoleByName(string $name) {
		return $this->elementsCache[$name] ??= $this->getElementByName($name, $this->roles, 'roles');
	}

	public function getResourceByName(string $name) {
		return $this->elementsCache[$name] ??= $this->getElementByName($name, $this->resources, 'resources');
	}

	public function getPermissionByName(string $name) {
		return $this->elementsCache[$name] ??= $this->getElementByName($name, $this->permissions, 'permissions');
	}

	public function loadAcls(): array {
		foreach ($this->providers as $provider) {
			$this->acls += $provider->loadAllAcls();
		}
		return $this->acls;
	}

	public function loadRoles(): array {
		foreach ($this->providers as $provider) {
			$this->roles += $provider->loadAllRoles();
		}
		return $this->roles;
	}

	public function loadResources(): array {
		foreach ($this->providers as $provider) {
			$this->resources += $provider->loadAllResources();
		}
		return $this->resources;
	}

	public function loadPermissions(): array {
		foreach ($this->providers as $provider) {
			$this->permissions+=$provider->loadAllPermissions();
		}
		return $this->permissions;
	}

	public function addProvider(AclProviderInterface $provider) {
		$this->providers[] = $provider;
	}

	/**
	 *
	 * @return AclElement[]
	 */
	public function getAcls() {
		return $this->acls;
	}

	/**
	 *
	 * @return Role[]
	 */
	public function getRoles() {
		return $this->roles;
	}

	/**
	 *
	 * @return \Ubiquity\security\acl\models\Resource[]
	 */
	public function getResources() {
		return $this->resources;
	}

	/**
	 *
	 * @return Permission[]
	 */
	public function getPermissions() {
		return $this->permissions;
	}

	/**
	 *
	 * @return AclProviderInterface[]
	 */
	public function getProviders() {
		return $this->providers;
	}

	/**
	 *
	 * @param AclProviderInterface[] $providers
	 */
	public function setProviders($providers) {
		$this->providers = $providers;
	}

	public function getRolePermissionsOn(string $roleName, $resourceName = '*'): array {
		$role = $this->getRoleByName($roleName);
		$parents = $role->getParentsArray();
		$result = [];
		foreach ($this->acls as $aclElement) {
			$aclRoleName = $aclElement->getRole()->getName();
			if ($aclRoleName === '@ALL' || $aclRoleName === $roleName) {
				$aclResourceName = $aclElement->getResource()->getName();
				if ($aclResourceName === '*' || $aclResourceName === $resourceName || \strpos($resourceName, $aclResourceName.'.')!==false) {
					$result[] = $aclElement;
				}
			}
		}
		foreach ($parents as $parentElm) {
			$result += $this->getRolePermissionsOn($parentElm, $resourceName);
		}
		return $result;
	}

	public function isAllowed(string $roleName, string $resourceName, string $permissionName) {
		$acls = $this->getRolePermissionsOn($roleName, $resourceName);
		if (\count($acls) > 0) {
			$permissionLevel = $this->getPermissionByName($permissionName)->getLevel();
			foreach ($acls as $aclElm) {
				$level = $aclElm->getPermission()->getLevel();
				if ($level >= $permissionLevel) {
					return true;
				}
			}
		}
		return false;
	}

	/**
	 *
	 * @param string $providerClass
	 * @return \Ubiquity\security\acl\persistence\AclProviderInterface|NULL
	 */
	public function getProvider(string $providerClass) {
		foreach ($this->providers as $prov) {
			if ($prov instanceof $providerClass) {
				return $prov;
			}
		}
		return null;
	}

	/**
	 *
	 * @param string $id_
	 * @return ?AclElement
	 */
	public function getAclById_(string $id_): ?AclElement {
		foreach ($this->acls as $acl) {
			if ($acl->getId_() === $id_) {
				return $acl;
			}
		}
		return null;
	}

	public function getProviderClasses() {
		$result = [];
		foreach ($this->providers as $prov) {
			$result[] = \get_class($prov);
		}
		return $result;
	}

	public function hasCache() {
		foreach ($this->providers as $prov) {
			if ($prov instanceof AclCacheProvider) {
				return true;
			}
		}
		return false;
	}

	public function getElementsNames($part) {
		$result = [];
		foreach ($this->$part as $elm) {
			$result[] = $elm->__toString();
		}
		return $result;
	}
}