GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.

Abac::prepareGetterParams()   B
last analyzed

Complexity

Conditions 5
Paths 5

Size

Total Lines 15
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 10
CRAP Score 5.1158

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 15
ccs 10
cts 12
cp 0.8333
rs 8.8571
cc 5
eloc 10
nc 5
nop 3
crap 5.1158
1
<?php
2
3
namespace PhpAbac;
4
5
use PhpAbac\Manager\AttributeManager;
6
use PhpAbac\Manager\PolicyRuleManager;
7
use PhpAbac\Manager\ConfigurationManager;
8
use PhpAbac\Manager\CacheManager;
9
use PhpAbac\Manager\ComparisonManager;
10
11
use Symfony\Component\Config\FileLocator;
12
13
use PhpAbac\Model\PolicyRuleAttribute;
14
15
class Abac {
16
	/** @var \PhpAbac\Manager\ConfigurationManager * */
17
	private $configuration;
18
	/** @var \PhpAbac\Manager\PolicyRuleManager * */
19
	private $policyRuleManager;
20
	/** @var \PhpAbac\Manager\AttributeManager * */
21
	private $attributeManager;
22
	/** @var \PhpAbac\Manager\CacheManager * */
23
	private $cacheManager;
24
	/** @var \PhpAbac\Manager\ComparisonManager * */
25
	private $comparisonManager;
26
	
27
	/**
28
	 * @param array  $configPaths
29
	 * @param array  $cacheOptions     Option for cache
30
	 * @param string $configPaths_root The origin folder to find $configPaths
31
	 * @param array  $options
32
	 */
33 4
	public function __construct( $configPaths, $cacheOptions = [], $configPaths_root = null, $options = [] ) {
0 ignored issues
show
Coding Style introduced by
Expected 0 spaces between opening bracket and argument "$configPaths"; 1 found
Loading history...
Coding Style introduced by
Expected 0 spaces between argument "$options" and closing bracket; 1 found
Loading history...
34 4
		$this->configure( $configPaths, $configPaths_root );
35 4
		$this->attributeManager = new AttributeManager( $this->configuration->getAttributes(), $options );
36 4
		$this->policyRuleManager = new PolicyRuleManager( $this->attributeManager, $this->configuration->getRules() );
37 4
		$this->cacheManager      = new CacheManager( $cacheOptions );
38 4
		$this->comparisonManager = new ComparisonManager( $this->attributeManager );
39 4
	}
40
	
41
	/**
42
	 * @param array  $configPaths
43
	 * @param string $configPaths_root The origin folder to find $configPaths
44
	 */
45 4
	public function configure( $configPaths, $configPaths_root = null ) {
0 ignored issues
show
Coding Style introduced by
Expected 0 spaces between opening bracket and argument "$configPaths"; 1 found
Loading history...
Coding Style introduced by
Expected 0 spaces between argument "$configPaths_root" and closing bracket; 1 found
Loading history...
46
//		foreach ( $configPaths as &$configPath ) {
47
//			$configPath = $configPaths_root . $configPath;
48
//		}
49 4
		$locator             = new FileLocator( $configPaths_root );
50 4
		$this->configuration = new ConfigurationManager( $locator );
51 4
		$this->configuration->setConfigPathRoot( $configPaths_root );
52 4
		$this->configuration->parseConfigurationFile( $configPaths );
53 4
	}
54
	
55
	/**
56
	 * Return true if both user and object respects all the rules conditions
57
	 * If the objectId is null, policy rules about its attributes will be ignored
58
	 * In case of mismatch between attributes and expected values,
59
	 * an array with the concerned attributes slugs will be returned.
60
	 *
61
	 * Available options are :
62
	 * * dynamic_attributes: array
63
	 * * cache_result: boolean
64
	 * * cache_ttl: integer
65
	 * * cache_driver: string
66
	 *
67
	 * Available cache drivers are :
68
	 * * memory
69
	 *
70
	 * @param string $ruleName
71
	 * @param object $user
72
	 * @param object $resource
73
	 * @param array  $options
74
	 *
75
	 * @return boolean|array
76
	 */
77 4
	public function enforce( $ruleName, $user, $resource = null, $options = [] ) {
0 ignored issues
show
Coding Style introduced by
Expected 0 spaces between opening bracket and argument "$ruleName"; 1 found
Loading history...
Coding Style introduced by
Expected 0 spaces between argument "$options" and closing bracket; 1 found
Loading history...
78
		// If there is dynamic attributes, we pass them to the comparison manager
79
		// When a comparison will be performed, the passed values will be retrieved and used
80 4
		if ( isset( $options[ 'dynamic_attributes' ] ) ) {
81 1
			$this->comparisonManager->setDynamicAttributes( $options[ 'dynamic_attributes' ] );
82 1
		}
83
		// Retrieve cache value for the current rule and values if cache item is valid
84 4
		if ( ( $cacheResult = isset( $options[ 'cache_result' ] ) && $options[ 'cache_result' ] === true ) === true ) {
0 ignored issues
show
Comprehensibility introduced by
Consider adding parentheses for clarity. Current Interpretation: $cacheResult = (isset($o...ache_result'] === true), Probably Intended Meaning: ($cacheResult = isset($o...cache_result'] === true
Loading history...
85
			$cacheItem = $this->cacheManager->getItem( "$ruleName-{$user->getId()}-" . ( ( $resource !== null ) ? $resource->getId() : '' ), ( isset( $options[ 'cache_driver' ] ) ) ? $options[ 'cache_driver' ] : null, ( isset( $options[ 'cache_ttl' ] ) ) ? $options[ 'cache_ttl' ] : null );
86
			// We check if the cache value s valid before returning it
87
			if ( ( $cacheValue = $cacheItem->get() ) !== null ) {
0 ignored issues
show
Coding Style introduced by
Expected 0 spaces before closing bracket; 1 found
Loading history...
88
				return $cacheValue;
89
			}
90
		}
91 4
		$policyRule_a = $this->policyRuleManager->getRule( $ruleName, $user, $resource );
0 ignored issues
show
Bug introduced by
It seems like $resource defined by parameter $resource on line 77 can also be of type null; however, PhpAbac\Manager\PolicyRuleManager::getRule() does only seem to accept object, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
92
		
93 4
		foreach ( $policyRule_a as $policyRule ) {
0 ignored issues
show
Coding Style introduced by
Space found after opening bracket of FOREACH loop
Loading history...
Coding Style introduced by
Space found before closing bracket of FOREACH loop
Loading history...
Coding Style introduced by
Expected 0 spaces before closing bracket; 1 found
Loading history...
94
			// For each policy rule attribute, we retrieve the attribute value and proceed configured extra data
95 4
			foreach ( $policyRule->getPolicyRuleAttributes() as $pra ) {
0 ignored issues
show
Coding Style introduced by
Space found after opening bracket of FOREACH loop
Loading history...
Coding Style introduced by
Space found before closing bracket of FOREACH loop
Loading history...
Coding Style introduced by
Expected 0 spaces before closing bracket; 1 found
Loading history...
96
				/** @var PolicyRuleAttribute $pra */
97 4
				$attribute = $pra->getAttribute();
98
				
99 4
				$getter_params = $this->prepareGetterParams($pra->getGetterParams(), $user, $resource);
100
//				var_dump($pra->getGetterParams());
101
//				var_dump($getter_params);
102 4
				$attribute->setValue( $this->attributeManager->retrieveAttribute( $attribute, $user, $resource, $getter_params ) );
103 4
				if ( count( $pra->getExtraData() ) > 0 ) {
104 3
					$this->processExtraData( $pra, $user, $resource );
0 ignored issues
show
Bug introduced by
It seems like $resource defined by parameter $resource on line 77 can also be of type null; however, PhpAbac\Abac::processExtraData() does only seem to accept object, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
105 3
				}
106 4
				$this->comparisonManager->compare( $pra );
107 4
			}
108
			// The given result could be an array of rejected attributes or true
109
			// True means that the rule is correctly enforced for the given user and resource
110 4
			$result = $this->comparisonManager->getResult();
111 4
			if ( true === $result ) {
0 ignored issues
show
Coding Style introduced by
Expected 0 spaces before closing bracket; 1 found
Loading history...
112 4
				break;
113
			}
114 4
		}
115 4
		if ( $cacheResult ) {
0 ignored issues
show
Coding Style introduced by
Expected 0 spaces before closing bracket; 1 found
Loading history...
116
			$cacheItem->set( $result );
0 ignored issues
show
Bug introduced by
The variable $cacheItem does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
Bug introduced by
The variable $result does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
117
			$this->cacheManager->save( $cacheItem );
118
		}
119
		
120 4
		return $result;
121
	}
122
	
123
	/**
124
	 * Function to prepare Getter Params when getter require parameters ( this parameters must be specified in configuration file)
125
	 *
126
	 * @param $getter_params
127
	 * @param $user
128
	 * @param $resource
129
	 *
130
	 * @return array
131
	 */
132 4
	private function prepareGetterParams($getter_params, $user, $resource) {
133 4
		if (empty($getter_params)) return [];
0 ignored issues
show
Coding Style Best Practice introduced by
It is generally a best practice to always use braces with control structures.

Adding braces to control structures avoids accidental mistakes as your code changes:

// Without braces (not recommended)
if (true)
    doSomething();

// Recommended
if (true) {
    doSomething();
}
Loading history...
134 2
		$values = [];
135 2
		foreach($getter_params as $getter_name=>$params) {
0 ignored issues
show
Coding Style introduced by
Expected 1 space after FOREACH keyword; 0 found
Loading history...
Coding Style introduced by
Expected 1 space before "=>"; 0 found
Loading history...
Coding Style introduced by
Expected 1 space after "=>"; 0 found
Loading history...
136 2
			foreach($params as $param) {
0 ignored issues
show
Coding Style introduced by
Expected 1 space after FOREACH keyword; 0 found
Loading history...
137 2
				if ( '@' !== $param[ 'param_name' ][ 0 ] ) {
0 ignored issues
show
Coding Style introduced by
Expected 0 spaces before closing bracket; 1 found
Loading history...
138
					$values[$getter_name][] = $param[ 'param_value' ];
139
				}
140
				else {
141 2
					$values[$getter_name][] = $this->attributeManager->retrieveAttribute( $this->attributeManager->getAttribute( $param[ 'param_value' ] ) , $user, $resource );
0 ignored issues
show
Coding Style introduced by
Space found before comma in function call
Loading history...
142
				}
143 2
			}
144 2
		}
145 2
		return $values;
146
	}
147
	
148
	/**
149
	 * @param \PhpAbac\Model\PolicyRuleAttribute $pra
150
	 * @param object                             $user
151
	 * @param object                             $resource
152
	 */
153 3
	public function processExtraData( PolicyRuleAttribute $pra, $user, $resource ) {
0 ignored issues
show
Coding Style introduced by
Expected 0 spaces between opening bracket and type hint "PolicyRuleAttribute"; 1 found
Loading history...
Coding Style introduced by
Expected 0 spaces between argument "$resource" and closing bracket; 1 found
Loading history...
154 3
		foreach ( $pra->getExtraData() as $key => $data ) {
0 ignored issues
show
Coding Style introduced by
Space found after opening bracket of FOREACH loop
Loading history...
Coding Style introduced by
Space found before closing bracket of FOREACH loop
Loading history...
Coding Style introduced by
Expected 0 spaces before closing bracket; 1 found
Loading history...
155
			switch ( $key ) {
0 ignored issues
show
Coding Style introduced by
Expected 0 spaces before closing bracket; 1 found
Loading history...
156 3
				case 'with':
157
					// This data has to be removed for it will be stored elsewhere
158
					// in the policy rule attribute
159 3
					$pra->removeExtraData( 'with' );
160
					// The "with" extra data is an array of attributes, which are objects
161
					// Once we process it as policy rule attributes, we set it as the main policy rule attribute value
162 3
					$subPolicyRuleAttributes = [];
163 3
					$extraData               = [];
0 ignored issues
show
Unused Code introduced by
$extraData is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
164
					
165 3
					foreach ( $this->policyRuleManager->processRuleAttributes( $data, $user, $resource ) as $subPolicyRuleAttribute ) {
0 ignored issues
show
Coding Style introduced by
Space found after opening bracket of FOREACH loop
Loading history...
Coding Style introduced by
Space found before closing bracket of FOREACH loop
Loading history...
166 3
						$subPolicyRuleAttributes[] = $subPolicyRuleAttribute;
167 3
					}
168 3
					$pra->setValue( $subPolicyRuleAttributes );
169
					// This data can be used in complex comparisons
170 3
					$pra->addExtraData( 'attribute', $pra->getAttribute() );
171 3
					$pra->addExtraData( 'user', $user );
0 ignored issues
show
Documentation introduced by
$user is of type object, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
172 3
					$pra->addExtraData( 'resource', $resource );
0 ignored issues
show
Documentation introduced by
$resource is of type object, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
173 3
					break;
174
			}
175 3
		}
176 3
	}
177
}
178