Abac::processExtraData() - Code Metrics - Inspection of "Release v2.1.0" - Kilix/php-abac - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7bf065...13ae28 )

by Axel

created 2016-10-09 15:30 UTC

Abac::processExtraData() B

↳ Parent: Abac

Complexity

Conditions	4
Paths	4

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	4

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	24
ccs	14
cts	14
cp	1
rs	8.6845
cc	4
eloc	14
nc	4
nop	3
crap	4

<?php

namespace PhpAbac;

use PhpAbac\Manager\AttributeManager;
use PhpAbac\Manager\PolicyRuleManager;
use PhpAbac\Manager\ConfigurationManager;
use PhpAbac\Manager\CacheManager;
use PhpAbac\Manager\ComparisonManager;

use Symfony\Component\Config\FileLocator;

use PhpAbac\Model\PolicyRuleAttribute;

class Abac
{
    /** @var \PhpAbac\Manager\ConfigurationManager **/
    private $configuration;
    /** @var \PhpAbac\Manager\PolicyRuleManager **/
    private $policyRuleManager;
    /** @var \PhpAbac\Manager\AttributeManager **/
    private $attributeManager;
    /** @var \PhpAbac\Manager\CacheManager **/
    private $cacheManager;
    /** @var \PhpAbac\Manager\ComparisonManager **/
    private $comparisonManager;

    /**
     * @param array $configPaths
     * @param array $options
     */
    public function __construct($configPaths, $options = [])
    {
        $this->configure($configPaths);
        $this->attributeManager = new AttributeManager($this->configuration->getAttributes());
        $this->policyRuleManager = new PolicyRuleManager($this->attributeManager, $this->configuration->getRules());
        $this->cacheManager = new CacheManager($options);
        $this->comparisonManager = new ComparisonManager($this->attributeManager);
    }

    /**
     * @param array $configPaths
     */
    public function configure($configPaths) {
        $locator = new FileLocator($configPaths);
        $this->configuration = new ConfigurationManager($locator);
        $this->configuration->parseConfigurationFile($configPaths);
    }

    /**
     * Return true if both user and object respects all the rules conditions
     * If the objectId is null, policy rules about its attributes will be ignored
     * In case of mismatch between attributes and expected values,
     * an array with the concerned attributes slugs will be returned.
     *
     * Available options are :
     * * dynamic_attributes: array
     * * cache_result: boolean
     * * cache_ttl: integer
     * * cache_driver: string
     *
     * Available cache drivers are :
     * * memory
     *
     * @param string $ruleName
     * @param object $user
     * @param object $resource
     * @param array $options
     * @return boolean|array
     */
    public function enforce($ruleName, $user, $resource = null, $options = []) {
        // If there is dynamic attributes, we pass them to the comparison manager
        // When a comparison will be performed, the passed values will be retrieved and used
        if(isset($options['dynamic_attributes'])) {

            $this->comparisonManager->setDynamicAttributes($options['dynamic_attributes']);
        }
        // Retrieve cache value for the current rule and values if cache item is valid
        if(($cacheResult = isset($options['cache_result']) && $options['cache_result'] === true) === true) {

            $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
            );
            // We check if the cache value s valid before returning it
            if(($cacheValue = $cacheItem->get()) !== null) {

                return $cacheValue;
            }
        }
        $policyRule = $this->policyRuleManager->getRule($ruleName, $user, $resource);

        // For each policy rule attribute, we retrieve the attribute value and proceed configured extra data
        foreach ($policyRule->getPolicyRuleAttributes() as $pra) {
            $attribute = $pra->getAttribute();
            $attribute->setValue($this->attributeManager->retrieveAttribute($attribute, $user, $resource));
            if(count($pra->getExtraData()) > 0) {

                $this->processExtraData($pra, $user, $resource);

            }
            $this->comparisonManager->compare($pra);
        }
        // The given result could be an array of rejected attributes or true
        // True means that the rule is correctly enforced for the given user and resource
        $result = $this->comparisonManager->getResult();
        if($cacheResult) {

            $cacheItem->set($result);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
            $this->cacheManager->save($cacheItem);
        }
        return $result;
    }

    /**
     * @param \PhpAbac\Model\PolicyRuleAttribute $pra
     * @param object $user
     * @param object $resource
     */
    public function processExtraData(PolicyRuleAttribute $pra, $user, $resource) {
        foreach($pra->getExtraData() as $key => $data) {

            switch($key) {

                case 'with':
                    // This data has to be removed for it will be stored elsewhere
                    // in the policy rule attribute
                    $pra->removeExtraData('with');
                    // The "with" extra data is an array of attributes, which are objects
                    // Once we process it as policy rule attributes, we set it as the main policy rule attribute value
                    $subPolicyRuleAttributes = [];
                    $extraData = [];
$myVar = 'Value';
$higher = false;

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

                    foreach($this->policyRuleManager->processRuleAttributes($data, $user, $resource) as $subPolicyRuleAttribute) {

                        $subPolicyRuleAttributes[] = $subPolicyRuleAttribute;
                    }
                    $pra->setValue($subPolicyRuleAttributes);
                    // This data can be used in complex comparisons
                    $pra->addExtraData('attribute', $pra->getAttribute());
                    $pra->addExtraData('user', $user);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $pra->addExtraData('resource', $resource);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    break;
            }
        }
    }
}


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		{
17		/ @var \PhpAbac\Manager\ConfigurationManager /
18		private $configuration;
19		/ @var \PhpAbac\Manager\PolicyRuleManager /
20		private $policyRuleManager;
21		/ @var \PhpAbac\Manager\AttributeManager /
22		private $attributeManager;
23		/ @var \PhpAbac\Manager\CacheManager /
24		private $cacheManager;
25		/ @var \PhpAbac\Manager\ComparisonManager /
26		private $comparisonManager;
27
28		/**
29		* @param array $configPaths
30		* @param array $options
31		*/
32	1	public function __construct($configPaths, $options = [])
33		{
34	1	$this->configure($configPaths);
35	1	$this->attributeManager = new AttributeManager($this->configuration->getAttributes());
36	1	$this->policyRuleManager = new PolicyRuleManager($this->attributeManager, $this->configuration->getRules());
37	1	$this->cacheManager = new CacheManager($options);
38	1	$this->comparisonManager = new ComparisonManager($this->attributeManager);
39	1	}
40
41		/**
42		* @param array $configPaths
43		*/
44	1	public function configure($configPaths) {
45	1	$locator = new FileLocator($configPaths);
46	1	$this->configuration = new ConfigurationManager($locator);
47	1	$this->configuration->parseConfigurationFile($configPaths);
48	1	}
49
50		/**
51		* Return true if both user and object respects all the rules conditions
52		* If the objectId is null, policy rules about its attributes will be ignored
53		* In case of mismatch between attributes and expected values,
54		* an array with the concerned attributes slugs will be returned.
55		*
56		* Available options are :
57		* * dynamic_attributes: array
58		* * cache_result: boolean
59		* * cache_ttl: integer
60		* * cache_driver: string
61		*
62		* Available cache drivers are :
63		* * memory
64		*
65		* @param string $ruleName
66		* @param object $user
67		* @param object $resource
68		* @param array $options
69		* @return boolean\|array
70		*/
71	1	public function enforce($ruleName, $user, $resource = null, $options = []) {
72		// If there is dynamic attributes, we pass them to the comparison manager
73		// When a comparison will be performed, the passed values will be retrieved and used
74	1	if(isset($options['dynamic_attributes'])) {
		0 ignored issues – show Coding Style introduced 2016-06-03 22:46 UTC by Report Bug Copy Issue Report Expected 1 space after IF keyword; 0 found Loading history...
75	1	$this->comparisonManager->setDynamicAttributes($options['dynamic_attributes']);
76		}
77		// Retrieve cache value for the current rule and values if cache item is valid
78	1	if(($cacheResult = isset($options['cache_result']) && $options['cache_result'] === true) === true) {
		0 ignored issues – show Comprehensibility introduced 2016-04-20 12:03 UTC by Report Bug Copy Issue Report Consider adding parentheses for clarity. Current Interpretation: `$cacheResult = (isset($o...ache_result'] === true)`, Probably Intended Meaning: `($cacheResult = isset($o...cache_result'] === true` Loading history... Coding Style introduced 2016-04-20 12:03 UTC by Report Bug Copy Issue Report Expected 1 space after IF keyword; 0 found Loading history...
79		$cacheItem = $this->cacheManager->getItem(
80		"$ruleName-{$user->getId()}-" . (($resource !== null) ? $resource->getId() : ''),
81		(isset($options['cache_driver'])) ? $options['cache_driver'] : null,
82		(isset($options['cache_ttl'])) ? $options['cache_ttl'] : null
83		);
84		// We check if the cache value s valid before returning it
85		if(($cacheValue = $cacheItem->get()) !== null) {
		0 ignored issues – show Coding Style introduced 2016-04-20 12:03 UTC by Report Bug Copy Issue Report Expected 1 space after IF keyword; 0 found Loading history...
86		return $cacheValue;
87		}
88		}
89	1	$policyRule = $this->policyRuleManager->getRule($ruleName, $user, $resource);
		0 ignored issues – show Bug introduced 2016-10-09 15:22 UTC by Report Bug Copy Issue Report It seems like `$resource` defined by parameter `$resource` on line 71 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...
90		// For each policy rule attribute, we retrieve the attribute value and proceed configured extra data
91	1	foreach ($policyRule->getPolicyRuleAttributes() as $pra) {
92	1	$attribute = $pra->getAttribute();
93	1	$attribute->setValue($this->attributeManager->retrieveAttribute($attribute, $user, $resource));
94	1	if(count($pra->getExtraData()) > 0) {
		0 ignored issues – show Coding Style introduced 2016-06-02 17:05 UTC by Report Bug Copy Issue Report Expected 1 space after IF keyword; 0 found Loading history...
95	1	$this->processExtraData($pra, $user, $resource);
		0 ignored issues – show Bug introduced 2016-06-03 22:46 UTC by Report Bug Copy Issue Report It seems like `$resource` defined by parameter `$resource` on line 71 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...
96		}
97	1	$this->comparisonManager->compare($pra);
98		}
99		// The given result could be an array of rejected attributes or true
100		// True means that the rule is correctly enforced for the given user and resource
101	1	$result = $this->comparisonManager->getResult();
102	1	if($cacheResult) {
		0 ignored issues – show Coding Style introduced 2016-04-20 12:03 UTC by Report Bug Copy Issue Report Expected 1 space after IF keyword; 0 found Loading history...
103		$cacheItem->set($result);
		0 ignored issues – show Bug introduced 2016-04-20 12:03 UTC by Report Bug Copy Issue Report 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 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; } } 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; } 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...
104		$this->cacheManager->save($cacheItem);
105		}
106	1	return $result;
107		}
108
109		/**
110		* @param \PhpAbac\Model\PolicyRuleAttribute $pra
111		* @param object $user
112		* @param object $resource
113		*/
114	1	public function processExtraData(PolicyRuleAttribute $pra, $user, $resource) {
115	1	foreach($pra->getExtraData() as $key => $data) {
		0 ignored issues – show Coding Style introduced 2016-06-02 17:05 UTC by Report Bug Copy Issue Report Expected 1 space after FOREACH keyword; 0 found Loading history...
116		switch($key) {
		0 ignored issues – show Coding Style introduced 2016-06-02 17:05 UTC by Report Bug Copy Issue Report Expected 1 space after SWITCH keyword; 0 found Loading history...
117	1	case 'with':
118		// This data has to be removed for it will be stored elsewhere
119		// in the policy rule attribute
120	1	$pra->removeExtraData('with');
121		// The "with" extra data is an array of attributes, which are objects
122		// Once we process it as policy rule attributes, we set it as the main policy rule attribute value
123	1	$subPolicyRuleAttributes = [];
124	1	$extraData = [];
		0 ignored issues – show Unused Code introduced 2016-10-09 15:22 UTC by Report Bug Copy Issue Report `$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...
125
126	1	foreach($this->policyRuleManager->processRuleAttributes($data, $user, $resource) as $subPolicyRuleAttribute) {
		0 ignored issues – show Coding Style introduced 2016-06-02 17:05 UTC by Report Bug Copy Issue Report Expected 1 space after FOREACH keyword; 0 found Loading history...
127	1	$subPolicyRuleAttributes[] = $subPolicyRuleAttribute;
128		}
129	1	$pra->setValue($subPolicyRuleAttributes);
130		// This data can be used in complex comparisons
131	1	$pra->addExtraData('attribute', $pra->getAttribute());
132	1	$pra->addExtraData('user', $user);
		0 ignored issues – show Documentation introduced 2016-06-03 22:46 UTC by Report Bug Copy Issue Report `$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...
133	1	$pra->addExtraData('resource', $resource);
		0 ignored issues – show Documentation introduced 2016-06-03 22:46 UTC by Report Bug Copy Issue Report `$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...
134	1	break;
135		}
136		}
137	1	}
138		}
139

Kilix / php-abac

GitHub Access Token became invalid

Push — master ( 7bf065...13ae28 )

Abac::processExtraData() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like