Modules::getAvailableModules() - Code Metrics - Inspection of "Update Modules.php" - tvdijen/simplesamlphp-module-monitor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a8ed13...20cb9d )

by Tim

created 2018-01-03 09:38 UTC

Modules::getAvailableModules() A

↳ Parent: Modules

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	0
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?php

namespace SimpleSAML\Module\monitor\TestSuite;

use \SimpleSAML\Module\monitor\TestConfiguration as TestConfiguration;
use \SimpleSAML\Module\monitor\State as State;
use \SimpleSAML\Module\monitor\TestData as TestData;

final class Modules extends \SimpleSAML\Module\monitor\TestSuiteFactory
{
    /**
     * @var array
     */
    private $requiredApacheModules = array();

    /**
     * @var array
     */
    private $requiredPhpModules = array();

    /**
     * @var array
     */
    // Important!!  Modules-names are handled case-sensitive!!
    private $storeApacheDependencies = array();

    /**
     * @var array
     */
    private $storePhpDependencies = array(
        'memcache' => 'memcached|memcache',
        'phpsession' => 'session',
        'redis' => 'redis',
        'redissentinel' => 'redis',
        'riak:Store' => 'riak',
        'sql' => 'PDO'
    );

    /**
     * @var array
     */
    private $moduleApacheDependencies = array(
        'negotiateext' => 'mod_auth_kerb|mod_auth_gssapi'
    );

    /**
     * @var array
     */
    private $modulePhpDependencies = array(
        'authfacebook' => array('curl', 'json'),
        'authYubiKey' => 'curl',
// TODO: consent only requires pdo when database backend is used.. Should probably add this to required-list when processing metadata
//        'consent' => 'PDO',
        'consentAdmin' => 'PDO',
        'ldap' => 'ldap',
        'memcacheMonitor' => 'memcached|memcache',
        'negotiate' => 'krb5',
        'radius' => 'radius',
        'riak' => 'riak',
        'sqlauth' => 'PDO'
    );

    /**
     * @param TestConfiguration|null $configuration
     */
    public function __construct($configuration = null)
    {
        parent::__construct($configuration);
    }

    /**
     * @return void
     */
    protected function initialize()
    {
        $this->setRequiredApacheModules();
        $this->setRequiredPhpModules();
        $this->setRequiredSspModules();
    }

    /**
     * @return void
     */
    private function addRequiredApacheModule($module)
    {
        if (!in_array($module, $this->requiredApacheModules)) {
            $this->requiredApacheModules[] = $module;
        }
    }

    /**
     * @return void
     */
    private function addRequiredPhpModule($module)
    {
        if (!in_array($module, $this->requiredPhpModules)) {
            $this->requiredPhpModules[] = $module;
        }
    }

    /**
     * @return void
     */
    private function setRequiredApacheModules()
    {
        // Apache Modules
        if (\SimpleSAML\Utils\HTTP::isHTTPS()) {
            $this->addRequiredApacheModule('mod_ssl');
        }
        if (function_exists('apache_get_modules')) {
            $this->addRequiredApacheModule('mod_php|mod_php5');
        }

        // Determine extra required modules
        $configuration = $this->getConfiguration();
        $globalConfig = $configuration->getGlobalConfig();
        $store = $globalConfig->getValue('store.type');
        if (array_key_exists($store, $this->storeApacheDependencies)) {
            $this->addRequiredApacheModule($this->storeApacheDependencies[$store]);
        }
    }

    /**
     * @return void
     */
    private function setRequiredPhpModules()
    {
        // PHP modules
        $composerFile = \SimpleSAML\Utils\System::resolvePath('composer.json');
        $composerData = file_get_contents($composerFile);
        $composer = json_decode($composerData, true);
        $composerRequired = $composer['require'];

        foreach ($composerRequired as $ext => $ver) {
            if (preg_match('/^ext-/', $ext)) {
                $this->addRequiredPhpModule(substr($ext, 4));
            }
        }

        // Determine extra required modules
        $configuration = $this->getConfiguration();
        $globalConfig = $configuration->getGlobalConfig();
        $store = $globalConfig->getValue('store.type');
        if (array_key_exists($store, $this->storePhpDependencies)) {
            $this->addRequiredPhpModule($this->storePhpDependencies[$store]);
        }
    }

    /**
     * @return void
     */
    private function setRequiredSspModules()
    {
        $modules = \SimpleSAML\Module::getModules();
        foreach ($modules as $module) {
            if (\SimpleSAML\Module::isModuleEnabled($module)) {
                if (array_key_exists($module, $this->moduleApacheDependencies)) {
                    $dependencies = \SimpleSAML\Utils\Arrays::Arrayize($this->moduleApacheDependencies[$module]);
                    foreach ($dependencies as $dependency) {
                        $this->addRequiredApacheModule($dependency);
                    }
                }
                if (array_key_exists($module, $this->modulePhpDependencies)) {
                    $dependencies = \SimpleSAML\Utils\Arrays::Arrayize($this->modulePhpDependencies[$module]);
                    foreach ($dependencies as $dependency) {
                        $this->addRequiredPhpModule($dependency);
                    }
                }
            }
        }
    }

    /**
     * @return string[]

     */
    public function getAvailableModules()
    {
        $configuration = $this->getConfiguration();
        return array(
            'Apache' => $configuration->getAvailableApacheModules(),
            'Php' => $configuration->getAvailablePhpModules()
        );
    }

    /**
     * @return array<string,array>
     */
    private function getRequiredModules()
    {
        return array('Apache' => $this->requiredApacheModules, 'Php' => $this->requiredPhpModules);
    }

    /**
     * @return array<string,array>
     */
    private function getModuleDependencies()
    {
        return array('Apache' => $this->moduleApacheDependencies, 'Php' => $this->modulePhpDependencies);
    }

    /**
     * @return void
     */
    protected function invokeTestSuite()
    {
        $availableModules = $this->getAvailableModules();
        $requiredModules = $this->getRequiredModules();
        $moduleDependencies = $this->getModuleDependencies();
        $output = array();

        // Test for the availability of required modules
        foreach ($availableModules as $category => $available) {
            if (is_null($available)) {
                $output[$category][] = array(State::SKIPPED, $category, implode(', ', $requiredModules[$category]), 'Unable to verify installed modules');
            } else {
                $dependencies = array_key_exists($category, $moduleDependencies) ? $moduleDependencies[$category] : array();
                $required = array_key_exists($category, $requiredModules) ? $requiredModules[$category] : array();
                $available = array_key_exists($category, $availableModules) ? $availableModules[$category] : array();

                foreach ($required as $require) {
                    $testData = new TestData(
                        array(
                            'require' => $require,
                            'available' => $available
                        )
                    );
                    $this->testRequirement($testData, $category, $dependencies, $output);
                }
            }
        }

        $tests = $this->getTests();
        foreach ($availableModules as $category => $available) {
            $categories = array_fill(0, count($tests), $category);
            if (!isSet($output[$category])) {
                $modules = array_map(
                  function($test, $category) {
                    return ($test->getCategory() === $category) ? $test->getModuleName() : false;
                  }, $tests, $categories
                );
                $modules = array_diff($modules, array(false));
                $output[$category][] = array(State::OK, $category, implode(', ', $modules), "All required modules are loaded");
            }
            $this->addMessages($output[$category], $category);
        }

        $this->calculateState();
    }

    /**
     * @param TestData $testData
     * @param string $category
     * @param array $dependencies
     * @param array $output
     *
     * @return void
     */
    private function testRequirement($testData, $category, $dependencies, &$output)
    {
        $require = $testData->getInput('require');
        $class = '\\SimpleSAML\\Module\\monitor\\TestCase\\Module\\' . $category;

        $test = new $class($this, $testData);
        $this->addTest($test);

        $state = $test->getState();
        if ($state !== State::OK) {
            $missing = array();
            while ($dependency = array_search($require, $dependencies)) {
                if (\SimpleSAML\Module::isModuleEnabled($dependency)) {
                    $missing[] = $dependency;
                }
                unset($dependencies[$dependency]);
            }
        }

        if (!empty($missing)) {
            $output[$category][] = array($state, $category, $test->getModuleName(), 'Module not loaded; dependency for ' . implode(', ', $missing));
        } else {
            $output[$category][] = array($state, $category, $test->getModuleName(), 'Module not loaded');
        }
    }
}


1			<?php
2
3			namespace SimpleSAML\Module\monitor\TestSuite;
4
5			use \SimpleSAML\Module\monitor\TestConfiguration as TestConfiguration;
6			use \SimpleSAML\Module\monitor\State as State;
7			use \SimpleSAML\Module\monitor\TestData as TestData;
8
9			final class Modules extends \SimpleSAML\Module\monitor\TestSuiteFactory
10			{
11			/**
12			* @var array
13			*/
14			private $requiredApacheModules = array();
15
16			/**
17			* @var array
18			*/
19			private $requiredPhpModules = array();
20
21			/**
22			* @var array
23			*/
24			// Important!! Modules-names are handled case-sensitive!!
25			private $storeApacheDependencies = array();
26
27			/**
28			* @var array
29			*/
30			private $storePhpDependencies = array(
31			'memcache' => 'memcached\|memcache',
32			'phpsession' => 'session',
33			'redis' => 'redis',
34			'redissentinel' => 'redis',
35			'riak:Store' => 'riak',
36			'sql' => 'PDO'
37			);
38
39			/**
40			* @var array
41			*/
42			private $moduleApacheDependencies = array(
43			'negotiateext' => 'mod_auth_kerb\|mod_auth_gssapi'
44			);
45
46			/**
47			* @var array
48			*/
49			private $modulePhpDependencies = array(
50			'authfacebook' => array('curl', 'json'),
51			'authYubiKey' => 'curl',
52			// TODO: consent only requires pdo when database backend is used.. Should probably add this to required-list when processing metadata
53			// 'consent' => 'PDO',
54			'consentAdmin' => 'PDO',
55			'ldap' => 'ldap',
56			'memcacheMonitor' => 'memcached\|memcache',
57			'negotiate' => 'krb5',
58			'radius' => 'radius',
59			'riak' => 'riak',
60			'sqlauth' => 'PDO'
61			);
62
63			/**
64			* @param TestConfiguration\|null $configuration
65			*/
66			public function __construct($configuration = null)
67			{
68			parent::__construct($configuration);
69			}
70
71			/**
72			* @return void
73			*/
74			protected function initialize()
75			{
76			$this->setRequiredApacheModules();
77			$this->setRequiredPhpModules();
78			$this->setRequiredSspModules();
79			}
80
81			/**
82			* @return void
83			*/
84			private function addRequiredApacheModule($module)
85			{
86			if (!in_array($module, $this->requiredApacheModules)) {
87			$this->requiredApacheModules[] = $module;
88			}
89			}
90
91			/**
92			* @return void
93			*/
94			private function addRequiredPhpModule($module)
95			{
96			if (!in_array($module, $this->requiredPhpModules)) {
97			$this->requiredPhpModules[] = $module;
98			}
99			}
100
101			/**
102			* @return void
103			*/
104			private function setRequiredApacheModules()
105			{
106			// Apache Modules
107			if (\SimpleSAML\Utils\HTTP::isHTTPS()) {
108			$this->addRequiredApacheModule('mod_ssl');
109			}
110			if (function_exists('apache_get_modules')) {
111			$this->addRequiredApacheModule('mod_php\|mod_php5');
112			}
113
114			// Determine extra required modules
115			$configuration = $this->getConfiguration();
116			$globalConfig = $configuration->getGlobalConfig();
117			$store = $globalConfig->getValue('store.type');
118			if (array_key_exists($store, $this->storeApacheDependencies)) {
119			$this->addRequiredApacheModule($this->storeApacheDependencies[$store]);
120			}
121			}
122
123			/**
124			* @return void
125			*/
126			private function setRequiredPhpModules()
127			{
128			// PHP modules
129			$composerFile = \SimpleSAML\Utils\System::resolvePath('composer.json');
130			$composerData = file_get_contents($composerFile);
131			$composer = json_decode($composerData, true);
132			$composerRequired = $composer['require'];
133
134			foreach ($composerRequired as $ext => $ver) {
135			if (preg_match('/^ext-/', $ext)) {
136			$this->addRequiredPhpModule(substr($ext, 4));
137			}
138			}
139
140			// Determine extra required modules
141			$configuration = $this->getConfiguration();
142			$globalConfig = $configuration->getGlobalConfig();
143			$store = $globalConfig->getValue('store.type');
144			if (array_key_exists($store, $this->storePhpDependencies)) {
145			$this->addRequiredPhpModule($this->storePhpDependencies[$store]);
146			}
147			}
148
149			/**
150			* @return void
151			*/
152			private function setRequiredSspModules()
153			{
154			$modules = \SimpleSAML\Module::getModules();
155			foreach ($modules as $module) {
156			if (\SimpleSAML\Module::isModuleEnabled($module)) {
157			if (array_key_exists($module, $this->moduleApacheDependencies)) {
158			$dependencies = \SimpleSAML\Utils\Arrays::Arrayize($this->moduleApacheDependencies[$module]);
159			foreach ($dependencies as $dependency) {
160			$this->addRequiredApacheModule($dependency);
161			}
162			}
163			if (array_key_exists($module, $this->modulePhpDependencies)) {
164			$dependencies = \SimpleSAML\Utils\Arrays::Arrayize($this->modulePhpDependencies[$module]);
165			foreach ($dependencies as $dependency) {
166			$this->addRequiredPhpModule($dependency);
167			}
168			}
169			}
170			}
171			}
172
173			/**
174			* @return string[]
			0 ignored issues – show Documentation introduced 2018-01-03 09:54 UTC by Report Bug Copy Issue Report Should the return type not be `array<string,array>`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
175			*/
176			public function getAvailableModules()
177			{
178			$configuration = $this->getConfiguration();
179			return array(
180			'Apache' => $configuration->getAvailableApacheModules(),
181			'Php' => $configuration->getAvailablePhpModules()
182			);
183			}
184
185			/**
186			* @return array<string,array>
187			*/
188			private function getRequiredModules()
189			{
190			return array('Apache' => $this->requiredApacheModules, 'Php' => $this->requiredPhpModules);
191			}
192
193			/**
194			* @return array<string,array>
195			*/
196			private function getModuleDependencies()
197			{
198			return array('Apache' => $this->moduleApacheDependencies, 'Php' => $this->modulePhpDependencies);
199			}
200
201			/**
202			* @return void
203			*/
204			protected function invokeTestSuite()
205			{
206			$availableModules = $this->getAvailableModules();
207			$requiredModules = $this->getRequiredModules();
208			$moduleDependencies = $this->getModuleDependencies();
209			$output = array();
210
211			// Test for the availability of required modules
212			foreach ($availableModules as $category => $available) {
213			if (is_null($available)) {
214			$output[$category][] = array(State::SKIPPED, $category, implode(', ', $requiredModules[$category]), 'Unable to verify installed modules');
215			} else {
216			$dependencies = array_key_exists($category, $moduleDependencies) ? $moduleDependencies[$category] : array();
217			$required = array_key_exists($category, $requiredModules) ? $requiredModules[$category] : array();
218			$available = array_key_exists($category, $availableModules) ? $availableModules[$category] : array();
219
220			foreach ($required as $require) {
221			$testData = new TestData(
222			array(
223			'require' => $require,
224			'available' => $available
225			)
226			);
227			$this->testRequirement($testData, $category, $dependencies, $output);
228			}
229			}
230			}
231
232			$tests = $this->getTests();
233			foreach ($availableModules as $category => $available) {
234			$categories = array_fill(0, count($tests), $category);
235			if (!isSet($output[$category])) {
236			$modules = array_map(
237			function($test, $category) {
238			return ($test->getCategory() === $category) ? $test->getModuleName() : false;
239			}, $tests, $categories
240			);
241			$modules = array_diff($modules, array(false));
242			$output[$category][] = array(State::OK, $category, implode(', ', $modules), "All required modules are loaded");
243			}
244			$this->addMessages($output[$category], $category);
245			}
246
247			$this->calculateState();
248			}
249
250			/**
251			* @param TestData $testData
252			* @param string $category
253			* @param array $dependencies
254			* @param array $output
255			*
256			* @return void
257			*/
258			private function testRequirement($testData, $category, $dependencies, &$output)
259			{
260			$require = $testData->getInput('require');
261			$class = '\\SimpleSAML\\Module\\monitor\\TestCase\\Module\\' . $category;
262
263			$test = new $class($this, $testData);
264			$this->addTest($test);
265
266			$state = $test->getState();
267			if ($state !== State::OK) {
268			$missing = array();
269			while ($dependency = array_search($require, $dependencies)) {
270			if (\SimpleSAML\Module::isModuleEnabled($dependency)) {
271			$missing[] = $dependency;
272			}
273			unset($dependencies[$dependency]);
274			}
275			}
276
277			if (!empty($missing)) {
278			$output[$category][] = array($state, $category, $test->getModuleName(), 'Module not loaded; dependency for ' . implode(', ', $missing));
279			} else {
280			$output[$category][] = array($state, $category, $test->getModuleName(), 'Module not loaded');
281			}
282			}
283			}
284

tvdijen / simplesamlphp-module-monitor

Push — master ( a8ed13...20cb9d )

Modules::getAvailableModules() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like