AclList::isAllowed() - Code Metrics - Inspection of "Update AclCacheProviderTest.php" - phpMv/ubiquity-acl - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( f39298...b455ba )

by Jean-Christophe

created 2020-11-05 23:14 UTC

AclList::isAllowed() A

↳ Parent: AclList

Complexity

Conditions	4
Paths	3

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	8
nc	3
nop	3
dl	0
loc	12
ccs	9
cts	9
cp	1
crap	4
rs	10
c	0
b	0
f	0

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

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

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

	/**
	 *
	 * @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 init() {
		$this->roles['role_@ALL'] = new Role('@ALL');
		$this->resources['res_*'] = new Resource('*');
		$this->permissions['perm_ALL'] = new Permission('ALL', 1000);
		$this->acls = [];
	}

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

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

	public function getPermissionByName(string $name) {
		return $this->elementsCache["perm_$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 addRole(Role $role) {
		$this->roles[$role->getName()] = $role;
		$this->savePart($role);
	}

	public function addResource(Resource $resource) {
		$this->resources[$resource->getName()] = $resource;
		$this->savePart($resource);
	}

	public function addPermission(Permission $permission) {
		$this->permissions[$permission->getName()] = $permission;
		$this->savePart($permission);
	}

	public function setPermissionLevel(string $name, int $level) {
		$perm = $this->getPermissionByName($name);
		$perm->setLevel($level);
		$this->updatePart($perm);
	}

	public function allow(string $roleName, string $resourceName, string $permissionName) {
		$aclElm = new AclElement();
		$aclElm->allow($this->getRoleByName($roleName), $this->getResourceByName($resourceName), $this->getPermissionByName($permissionName));
		$this->acls[] = $aclElm;
		$this->saveAclElement($aclElm);
	}

	public function addAndAllow(string $roleName, string $resourceName, string $permissionName) {
		if (! $this->elementExistByName($roleName, $this->roles)) {
			$this->addRole(new Role($roleName));
		}
		if ($resourceName !== '*' && ! $this->elementExistByName($resourceName, $this->resources)) {
			$this->addResource(new Resource($resourceName));
		}
		if ($permissionName !== 'ALL' && ! $this->elementExistByName($permissionName, $this->permissions)) {
			$this->addPermission(new Permission($permissionName));
		}
		$this->allow($roleName, $resourceName ?? '*', $permissionName ?? 'ALL');
	}

	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) {
					$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 AbstractAclPart $part
	 * @param string $providerClass
	 * @return boolean
	 */
	public function existPartIn(AbstractAclPart $part, string $providerClass) {
		$prov = $this->getProvider($providerClass);
		if (isset($prov)) {
			return $prov->existPart($part);
		}
		return false;
	}

	/**
	 *
	 * @param AclElement $elm
	 * @param string $providerClass
	 * @return boolean
	 */
	public function existAclIn(AclElement $elm, string $providerClass) {
		$prov = $this->getProvider($providerClass);
		if (isset($prov)) {
			return $prov->existAcl($elm);
		}
		return false;
	}
}



1		<?php
2		namespace Ubiquity\security\acl\models;
3
4		use Ubiquity\security\acl\persistence\AclProviderInterface;
5		use Ubiquity\exceptions\AclException;
6		use Ubiquity\security\acl\models\traits\AclListOperationsTrait;
7
8		/**
9		* Ubiquity\security\acl\models$AclList
10		* This class is part of Ubiquity
11		*
12		* @author jc
13		* @version 1.0.0
14		*
15		*/
16		class AclList {
17		use AclListOperationsTrait;
18
19		/**
20		*
21		* @var AclElement[]
22		*/
23		protected $acls;
24
25		/**
26		*
27		* @var Role[]
28		*/
29		protected $roles;
30
31		/**
32		*
33		* @var \Ubiquity\security\acl\models\Resource[]
34		*/
35		protected $resources;
36
37		/**
38		*
39		* @var Permission[]
40		*/
41		protected $permissions;
42
43		/**
44		*
45		* @var AclProviderInterface[]
46		*/
47		protected $providers = [];
48
49		protected $elementsCache = [];
50
51	21	protected function getElementByName(string $name, array $inArray, string $type) {
52	21	foreach ($inArray as $elm) {
53	21	if ($elm->getName() == $name) {
54	20	return $elm;
55		}
56		}
57	7	throw new AclException("$name does not exist in $type ACL");
58		}
59
60	4	protected function elementExistByName(string $name, array $inArray): bool {
61	4	foreach ($inArray as $elm) {
62	4	if ($elm->getName() == $name) {
63	3	return true;
64		}
65		}
66	4	return false;
67		}
68
69	21	public function init() {
70	21	$this->roles['role_@ALL'] = new Role('@ALL');
71	21	$this->resources['res_'] = new Resource('');
72	21	$this->permissions['perm_ALL'] = new Permission('ALL', 1000);
73	21	$this->acls = [];
74	21	}
75
76	21	public function getRoleByName(string $name) {
77	21	return $this->elementsCache["role_$name"] ??= $this->getElementByName($name, $this->roles, 'roles');
78		}
79
80	13	public function getResourceByName(string $name) {
81	13	return $this->elementsCache["res_$name"] ??= $this->getElementByName($name, $this->resources, 'resources');
82		}
83
84	17	public function getPermissionByName(string $name) {
85	17	return $this->elementsCache["perm_$name"] ??= $this->getElementByName($name, $this->permissions, 'permissions');
86		}
87
88	9	public function loadAcls(): array {
89	9	foreach ($this->providers as $provider) {
90	9	$this->acls += $provider->loadAllAcls();
91		}
92	9	return $this->acls;
93		}
94
95	9	public function loadRoles(): array {
96	9	foreach ($this->providers as $provider) {
97	9	$this->roles += $provider->loadAllRoles();
98		}
99	9	return $this->roles;
100		}
101
102	9	public function loadResources(): array {
103	9	foreach ($this->providers as $provider) {
104	9	$this->resources += $provider->loadAllResources();
105		}
106	9	return $this->resources;
107		}
108
109	9	public function loadPermissions(): array {
110	9	foreach ($this->providers as $provider) {
111	9	$this->permissions += $provider->loadAllPermissions();
112		}
113	9	return $this->permissions;
114		}
115
116		public function addProvider(AclProviderInterface $provider) {
117		$this->providers[] = $provider;
118		}
119
120		/**
121		*
122		* @return AclElement[]
123		*/
124	6	public function getAcls() {
125	6	return $this->acls;
126		}
127
128		/**
129		*
130		* @return Role[]
131		*/
132	9	public function getRoles() {
133	9	return $this->roles;
134		}
135
136		/**
137		*
138		* @return \Ubiquity\security\acl\models\Resource[]
139		*/
140	8	public function getResources() {
141	8	return $this->resources;
142		}
143
144		/**
145		*
146		* @return Permission[]
147		*/
148	12	public function getPermissions() {
149	12	return $this->permissions;
150		}
151
152		/**
153		*
154		* @return AclProviderInterface[]
155		*/
156		public function getProviders() {
157		return $this->providers;
158		}
159
160		/**
161		*
162		* @param AclProviderInterface[] $providers
163		*/
164	10	public function setProviders($providers) {
165	10	$this->providers = $providers;
166	10	}
167
168	11	public function addRole(Role $role) {
169	11	$this->roles[$role->getName()] = $role;
170	11	$this->savePart($role);
171	11	}
172
173	10	public function addResource(Resource $resource) {
174	10	$this->resources[$resource->getName()] = $resource;
175	10	$this->savePart($resource);
176	10	}
177
178	12	public function addPermission(Permission $permission) {
179	12	$this->permissions[$permission->getName()] = $permission;
180	12	$this->savePart($permission);
181	12	}
182
183	3	public function setPermissionLevel(string $name, int $level) {
184	3	$perm = $this->getPermissionByName($name);
185	2	$perm->setLevel($level);
186	2	$this->updatePart($perm);
187	2	}
188
189	13	public function allow(string $roleName, string $resourceName, string $permissionName) {
190	13	$aclElm = new AclElement();
191	13	$aclElm->allow($this->getRoleByName($roleName), $this->getResourceByName($resourceName), $this->getPermissionByName($permissionName));
192	13	$this->acls[] = $aclElm;
193	13	$this->saveAclElement($aclElm);
194	13	}
195
196	4	public function addAndAllow(string $roleName, string $resourceName, string $permissionName) {
197	4	if (! $this->elementExistByName($roleName, $this->roles)) {
198	4	$this->addRole(new Role($roleName));
199		}
200	4	if ($resourceName !== '*' && ! $this->elementExistByName($resourceName, $this->resources)) {
201	4	$this->addResource(new Resource($resourceName));
202		}
203	4	if ($permissionName !== 'ALL' && ! $this->elementExistByName($permissionName, $this->permissions)) {
204	4	$this->addPermission(new Permission($permissionName));
205		}
206	4	$this->allow($roleName, $resourceName ?? '*', $permissionName ?? 'ALL');
207	4	}
208
209	20	public function getRolePermissionsOn(string $roleName, $resourceName = '*'): array {
210	20	$role = $this->getRoleByName($roleName);
211	19	$parents = $role->getParentsArray();
212	19	$result = [];
213	19	foreach ($this->acls as $aclElement) {
214	16	$aclRoleName = $aclElement->getRole()->getName();
215	16	if ($aclRoleName === '@ALL' \|\| $aclRoleName === $roleName) {
216	16	$aclResourceName = $aclElement->getResource()->getName();
217	16	if ($aclResourceName === '*' \|\| $aclResourceName === $resourceName) {
218	16	$result[] = $aclElement;
219		}
220		}
221		}
222	19	foreach ($parents as $parentElm) {
223	4	$result += $this->getRolePermissionsOn($parentElm, $resourceName);
224		}
225	19	return $result;
226		}
227
228	20	public function isAllowed(string $roleName, string $resourceName, string $permissionName) {
229	20	$acls = $this->getRolePermissionsOn($roleName, $resourceName);
230	19	if (\count($acls) > 0) {
231	16	$permissionLevel = $this->getPermissionByName($permissionName)->getLevel();
232	15	foreach ($acls as $aclElm) {
233	15	$level = $aclElm->getPermission()->getLevel();
234	15	if ($level >= $permissionLevel) {
235	15	return true;
236		}
237		}
238		}
239	14	return false;
240		}
241
242		/**
243		*
244		* @param string $providerClass
245		* @return \Ubiquity\security\acl\persistence\AclProviderInterface\|NULL
246		*/
247	2	public function getProvider(string $providerClass) {
248	2	foreach ($this->providers as $prov) {
249	2	if ($prov instanceof $providerClass) {
250	2	return $prov;
251		}
252		}
253		return null;
254		}
255
256		/**
257		*
258		* @param AbstractAclPart $part
259		* @param string $providerClass
260		* @return boolean
261		*/
262	2	public function existPartIn(AbstractAclPart $part, string $providerClass) {
263	2	$prov = $this->getProvider($providerClass);
264	2	if (isset($prov)) {
265	2	return $prov->existPart($part);
266		}
267		return false;
268		}
269
270		/**
271		*
272		* @param AclElement $elm
273		* @param string $providerClass
274		* @return boolean
275		*/
276	2	public function existAclIn(AclElement $elm, string $providerClass) {
277	2	$prov = $this->getProvider($providerClass);
278	2	if (isset($prov)) {
279	2	return $prov->existAcl($elm);
280		}
281		return false;
282		}
283		}
284
285

phpMv / ubiquity-acl

Push — main ( f39298...b455ba )

AclList::isAllowed() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like