UserPermissionsComponent::redirectIfIsSet() - Code Metrics - Inspection of "added error handling for invalid handlers and some..." - AlessandroMinoccheri/UserPermissions - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#6)

unknown

created 2017-09-20 06:35 UTC

UserPermissionsComponent::redirectIfIsSet() A

↳ Parent: UserPermissionsComponent

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	4.679

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	3
cts	7
cp	0.4286
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	6
nc	3
nop	0
crap	4.679

<?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, $value);

			}
		}

		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)) return;
			
			if(!$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	6	public function initialize(array $config)
65		{
66	6	parent::initialize($config);
67
68	6	$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	6	$this->session = $this->controller->request->session();
70
71	6	$this->actions = array();
72	6	$this->allow = true;
73	6	$this->redirect = '';
74	6	$this->params = '';
75	6	$this->message = '';
76	6	$this->userType = '';
77	6	$this->action = null;
78	6	$this->throwEx = isset($config["throwEx"]) && $config["throwEx"];
79	6	}
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	6	public function allow ($rules) {
88	6	$this->setUserValues();
89	6	$this->bindConfiguration($rules);
90
91	6	if (!$this->applyGroupsRules($rules)) {
92	6	$this->applyViewsRules($rules);
93		}
94
95	6	return $this->allow;
96		}
97
98	6	private function setUserValues()
99		{
100	6	$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	6	if (!isset($userId)) {
103	6	$this->userType = 'guest';
104		}
105	6	}
106
107	6	private function bindConfiguration(array $rules)
108		{
109	6	foreach($rules as $key => $value){
110		switch($key){
111	6	case "user_type":
112	6	$this->userType = $value;
113	6	break;
114	6	case "redirect":
115	6	$this->redirect = $value;
116	6	break;
117	6	case "action":
118	6	$this->action = $value;
119	6	break;
120	6	case "controller":
121	6	$this->controller = $value;
122	6	if(!is_object($value)) {
123		Log::write("warning", sprintf("controller is not an object (%s)", gettype($value)));
124		}
125	6	break;
126	6	case "message":
127	6	$this->message = $value;
128	6	break;
129		}
130		}
131
132	6	foreach($rules['groups'] as $key => $value){
133	6	if($key == $this->userType){
134	6	foreach($value as $v){
135	6	array_push($this->actions, $v);
136		}
137		}
138		}
139	6	}
140
141	6	private function applyGroupsRules(array $rules)
142		{
143	6	$existRulesForGroups = false;
144
145	6	if(isset($rules['groups'])){
146	6	foreach($rules['groups'] as $key => $value){
147	6	$this->searchForApplyGroupRules($key, $value);
		0 ignored issues – show Unused Code introduced 2017-09-18 11:47 UTC by Report Bug Copy Issue Report The call to `UserPermissionsComponent...rchForApplyGroupRules()` has too many arguments starting with `$value`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
148		}
149		}
150
151	6	return $existRulesForGroups;
152		}
153
154	6	private function searchForApplyGroupRules($key)
155		{
156	6	if($key == $this->userType){
157	6	if ($this->notInArrayAction()) {
158	2	$this->redirectIfIsSet();
159
160	2	$this->allow = false;
161		}
162		}
163	6	}
164
165	6	private function notInArrayAction()
166		{
167	6	return ((!in_array('*', $this->actions)) && (!in_array($this->action, $this->actions)));
168		}
169
170	6	private function applyViewsRules(array $rules)
171		{
172	6	if(isset($rules['views'])){
173	3	foreach($rules['views'] as $key => $value){
174	3	$this->searchForApplyViewRules($key, $value);
175		}
176		}
177	6	}
178
179	3	private function searchForApplyViewRules($key, $value)
180		{
181	3	if($key == $this->action) {
182	3	if(!$this->checkForHandler($this->controller, $value)) return;
183
184	2	if(!$this->controller->$value()){
		0 ignored issues – show Bug introduced 2017-05-28 08:02 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...
185	1	$this->redirectIfIsSet();
186
187	1	$this->allow = false;
188		}
189		}
190	2	}
191
192	3	private function checkForHandler($controller, $handler)
193		{
194	3	if(!method_exists($controller, $handler)) {
195	1	$msg = sprintf(
196	1	"Controller %s=%s has no method called '%s'",
197	1	is_object($controller) ? "class" : "type",
198	1	is_object($controller) ? get_class($controller) : gettype($controller),
199	1	$handler
200		);
201	1	Log::write("debug", $msg);
202	1	if($this->throwEx) {
203		throw new MissingHandlerException($msg);
204		}
205	1	return false;
206		}
207
208	2	return true;
209		}
210
211	3	private function redirectIfIsSet()
212		{
213	3	if($this->redirect != ''){
214		if($this->message != ''){
215		$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...
216		}
217
218		header("Location: " . $this->redirect);
219		exit;
		0 ignored issues – show Coding Style Compatibility introduced 2017-09-18 11:47 UTC by Report Bug Copy Issue Report The method `redirectIfIsSet()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
220		}
221		}
222		}

AlessandroMinoccheri / UserPermissions

Pull Request — master (#6)

UserPermissionsComponent::redirectIfIsSet() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like