UserPermissionsComponent::notInArrayAction() - Code Metrics - AlessandroMinoccheri/UserPermissions - Measure and Improve Code Quality continuously with Scrutinizer

UserPermissionsComponent::notInArrayAction() A
last analyzed 2018-11-08 09:08 UTC

↳ Parent: UserPermissionsComponent

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2

<?php
namespace UserPermissions\Controller\Component;

use Cake\Controller\Component;
use Cake\Controller\ComponentRegistry;
use Cake\Controller\Component\FlashComponent;
use Cake\Datasource\ConnectionManager;
use Cake\Log\Log;
use Cake\ORM\TableRegistry;
use UserPermissions\Exception\MissingHandlerException;

class UserPermissionsComponent extends Component {

    /**
     * Controller name
     *
     * @var string
     */
	public $controller = null;

    /**
     * Session
     *
     * @var string
     */
	public $session = null;

    /**
     * Components array
     *
     * @var array
     */
   	public $components = ['Flash'];

    private $actions;

    private $allow;

    private $redirect;

    private $params;

    private $message;

    private $userType;

    private $action;
	
	/**
	 * Boolean value which holds the configuration for the behavior in case of
	 * missing handlers.
	 */
	private $throwEx;

    /**
    * Initialization to get controller variable
    *
	* For this component available settings:
	* 	bool throwEx - default false - if set to true, an exception will be
	*		thrown, if a handler is about to be called but does not exist.
	*
    * @param array $config Configuration array for the component.
    */
    public function initialize(array $config)
    {
        parent::initialize($config);
        
        $this->controller = $this->_registry->getController();

        $this->session = $this->controller->request->session();

        $this->actions 		= array();
		$this->allow 		= true;
		$this->redirect 	= '';
		$this->params 		= '';
		$this->message 		= '';
		$this->userType 	= '';
		$this->action   	= null;
		$this->throwEx      = isset($config["throwEx"]) && $config["throwEx"];
    }

    /**
    * Initialization to get controller variable
    *
    * @param array $rules Array of rules for permissions.
    * @return bool false if user / group doesn't have permission, true if has permission
    */
    public function allow ($rules) {
    	$this->setUserValues();
    	$this->bindConfiguration($rules);

		if (!$this->applyGroupsRules($rules)) {
			$this->applyViewsRules($rules);
		}

		return $this->allow;
    }

    private function setUserValues()
    {
    	$userId = $this->session->read('Auth.User.id');


    	if (!isset($userId)) {
			$this->userType = 'guest';
		}
    }

    private function bindConfiguration(array $rules) 
    {
    	foreach($rules as $key => $value){
			switch($key){
				case "user_type":
			        $this->userType = $value;
			        break;
			    case "redirect":
			        $this->redirect = $value;
			        break;
			    case "action":
			        $this->action = $value;
			        break;
			    case "controller":
			        $this->controller = $value;
					if(!is_object($value)) {
						Log::write("warning", sprintf("controller is not an object (%s)", gettype($value)));
					}
			        break;
			    case "message":
			        $this->message = $value;
			        break;
			}
		}

		foreach($rules['groups']  as $key => $value){
			if($key == $this->userType){
				foreach($value as $v){
					array_push($this->actions, $v);
				}
			}
		}
    }

    private function applyGroupsRules(array $rules)
    {
    	$existRulesForGroups = false;

    	if(isset($rules['groups'])){
			foreach($rules['groups'] as $key => $value){
				$this->searchForApplyGroupRules($key);
			}
		}

		return $existRulesForGroups;
    }

    private function searchForApplyGroupRules($key)
    {
    	if($key == $this->userType){
    		if ($this->notInArrayAction()) {
				$this->redirectIfIsSet();
				
				$this->allow = false;
			}
		}
    }

    private function notInArrayAction()
    {
    	return ((!in_array('*', $this->actions)) && (!in_array($this->action, $this->actions)));
    }

    private function applyViewsRules(array $rules)
    {
    	if(isset($rules['views'])){
			foreach($rules['views'] as $key => $value){
				$this->searchForApplyViewRules($key, $value);
			}
		}
    }

    private function searchForApplyViewRules($key, $value)
    {
    	if($key == $this->action) {
			if(!$this->checkForHandler($this->controller, $value) || !$this->controller->$value()){

				$this->redirectIfIsSet();
				
				$this->allow = false;
			}
		}
    }
	
	private function checkForHandler($controller, $handler)
	{
		if(!method_exists($controller, $handler)) {
			$msg = sprintf(
				"Controller %s=%s has no method called '%s'",
				is_object($controller) ? "class" : "type",
				is_object($controller) ? get_class($controller) : gettype($controller),
				$handler
			);
			Log::write("debug", $msg);
			if($this->throwEx) {
				throw new MissingHandlerException($msg);
			}
			return false;
		}
		
		return true;
	}

    private function redirectIfIsSet()
    {
    	if($this->redirect != ''){
			if($this->message != ''){
				$this->Flash->set($this->message);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			}
			
			header("Location: " . $this->redirect);
			exit;
		}
	}
}

1		<?php
2		namespace UserPermissions\Controller\Component;
3
4		use Cake\Controller\Component;
5		use Cake\Controller\ComponentRegistry;
6		use Cake\Controller\Component\FlashComponent;
7		use Cake\Datasource\ConnectionManager;
8		use Cake\Log\Log;
9		use Cake\ORM\TableRegistry;
10		use UserPermissions\Exception\MissingHandlerException;
11
12		class UserPermissionsComponent extends Component {
13
14		/**
15		* Controller name
16		*
17		* @var string
18		*/
19		public $controller = null;
20
21		/**
22		* Session
23		*
24		* @var string
25		*/
26		public $session = null;
27
28		/**
29		* Components array
30		*
31		* @var array
32		*/
33		public $components = ['Flash'];
34
35		private $actions;
36
37		private $allow;
38
39		private $redirect;
40
41		private $params;
42
43		private $message;
44
45		private $userType;
46
47		private $action;
48
49		/**
50		* Boolean value which holds the configuration for the behavior in case of
51		* missing handlers.
52		*/
53		private $throwEx;
54
55		/**
56		* Initialization to get controller variable
57		*
58		* For this component available settings:
59		* bool throwEx - default false - if set to true, an exception will be
60		* thrown, if a handler is about to be called but does not exist.
61		*
62		* @param array $config Configuration array for the component.
63		*/
64	7	public function initialize(array $config)
65		{
66	7	parent::initialize($config);
67
68	7	$this->controller = $this->_registry->getController();
		0 ignored issues – show Documentation Bug introduced 2017-05-28 08:32 UTC by Report Bug Copy Issue Report It seems like `$this->_registry->getController()` of type `object<Cake\Controller\Controller>` is incompatible with the declared type `string` of property `$controller`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
69	7	$this->session = $this->controller->request->session();
70
71	7	$this->actions = array();
72	7	$this->allow = true;
73	7	$this->redirect = '';
74	7	$this->params = '';
75	7	$this->message = '';
76	7	$this->userType = '';
77	7	$this->action = null;
78	7	$this->throwEx = isset($config["throwEx"]) && $config["throwEx"];
79	7	}
80
81		/**
82		* Initialization to get controller variable
83		*
84		* @param array $rules Array of rules for permissions.
85		* @return bool false if user / group doesn't have permission, true if has permission
86		*/
87	7	public function allow ($rules) {
88	7	$this->setUserValues();
89	7	$this->bindConfiguration($rules);
90
91	7	if (!$this->applyGroupsRules($rules)) {
92	7	$this->applyViewsRules($rules);
93		}
94
95	6	return $this->allow;
96		}
97
98	7	private function setUserValues()
99		{
100	7	$userId = $this->session->read('Auth.User.id');
		0 ignored issues – show Bug introduced 2017-05-28 08:02 UTC by Report Bug Copy Issue Report The method `read` cannot be called on `$this->session` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
101
102	7	if (!isset($userId)) {
103	7	$this->userType = 'guest';
104		}
105	7	}
106
107	7	private function bindConfiguration(array $rules)
108		{
109	7	foreach($rules as $key => $value){
110		switch($key){
111	7	case "user_type":
112	7	$this->userType = $value;
113	7	break;
114	7	case "redirect":
115	7	$this->redirect = $value;
116	7	break;
117	7	case "action":
118	7	$this->action = $value;
119	7	break;
120	7	case "controller":
121	7	$this->controller = $value;
122	7	if(!is_object($value)) {
123		Log::write("warning", sprintf("controller is not an object (%s)", gettype($value)));
124		}
125	7	break;
126	7	case "message":
127	7	$this->message = $value;
128	7	break;
129		}
130		}
131
132	7	foreach($rules['groups'] as $key => $value){
133	7	if($key == $this->userType){
134	7	foreach($value as $v){
135	7	array_push($this->actions, $v);
136		}
137		}
138		}
139	7	}
140
141	7	private function applyGroupsRules(array $rules)
142		{
143	7	$existRulesForGroups = false;
144
145	7	if(isset($rules['groups'])){
146	7	foreach($rules['groups'] as $key => $value){
147	7	$this->searchForApplyGroupRules($key);
148		}
149		}
150
151	7	return $existRulesForGroups;
152		}
153
154	7	private function searchForApplyGroupRules($key)
155		{
156	7	if($key == $this->userType){
157	7	if ($this->notInArrayAction()) {
158	2	$this->redirectIfIsSet();
159
160	2	$this->allow = false;
161		}
162		}
163	7	}
164
165	7	private function notInArrayAction()
166		{
167	7	return ((!in_array('*', $this->actions)) && (!in_array($this->action, $this->actions)));
168		}
169
170	7	private function applyViewsRules(array $rules)
171		{
172	7	if(isset($rules['views'])){
173	4	foreach($rules['views'] as $key => $value){
174	4	$this->searchForApplyViewRules($key, $value);
175		}
176		}
177	6	}
178
179	4	private function searchForApplyViewRules($key, $value)
180		{
181	4	if($key == $this->action) {
182	4	if(!$this->checkForHandler($this->controller, $value) \|\| !$this->controller->$value()){
		0 ignored issues – show Bug introduced 2017-09-20 06:40 UTC by Report Bug Copy Issue Report The method `$value` cannot be called on `$this->controller` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
183	2	$this->redirectIfIsSet();
184
185	2	$this->allow = false;
186		}
187		}
188	3	}
189
190	4	private function checkForHandler($controller, $handler)
191		{
192	4	if(!method_exists($controller, $handler)) {
193	2	$msg = sprintf(
194	2	"Controller %s=%s has no method called '%s'",
195	2	is_object($controller) ? "class" : "type",
196	2	is_object($controller) ? get_class($controller) : gettype($controller),
197	2	$handler
198		);
199	2	Log::write("debug", $msg);
200	2	if($this->throwEx) {
201	1	throw new MissingHandlerException($msg);
202		}
203	1	return false;
204		}
205
206	2	return true;
207		}
208
209	4	private function redirectIfIsSet()
210		{
211	4	if($this->redirect != ''){
212		if($this->message != ''){
213		$this->Flash->set($this->message);
		0 ignored issues – show Documentation introduced 2017-05-28 09:58 UTC by Report Bug Copy Issue Report The property `Flash` does not exist on `object<UserPermissions\C...erPermissionsComponent>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
214		}
215
216		header("Location: " . $this->redirect);
217		exit;
218		}
219		}
220		}

AlessandroMinoccheri / UserPermissions

UserPermissionsComponent::notInArrayAction() A last analyzed 2018-11-08 09:08 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

UserPermissionsComponent::notInArrayAction() A
last analyzed 2018-11-08 09:08 UTC