Ma27ApiKeyAuthenticationExtension::overrideServices() - Code Metrics - Inspection of "further password API refactorings" - Ma27/Ma27ApiKeyAuthenticationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (1f013c)

by Maximilian

created 2016-08-12 16:27 UTC

overrideServices() B

↳ Parent: Ma27ApiKeyAuthenticationExtension

Complexity

Conditions	5
Paths	4

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	5

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
c	4
b	1
f	0
dl	0
loc	19
ccs	14
cts	14
cp	1
rs	8.8571
cc	5
eloc	11
nc	4
nop	2
crap	5

<?php

namespace Ma27\ApiKeyAuthenticationBundle\DependencyInjection;

use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\Alias;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\Validator\Tests\Fixtures\Reference;

/**
 * This is the class that loads and manages your bundle configuration.
 *
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
 */
class Ma27ApiKeyAuthenticationExtension extends Extension
{
    /**
     * {@inheritdoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        $configuration = new Configuration();
        $config = $this->processConfiguration($configuration, $configs);

        $container->setParameter('ma27_api_key_authentication.key_header', $config['key_header']);
        $container->setParameter('ma27_api_key_authentication.model_name', $config['user']['model_name']);
        $container->setParameter('ma27_api_key_authentication.object_manager', $config['user']['object_manager']);
        $container->setParameter('ma27_api_key_authentication.property.apiKeyLength', $config['user']['api_key_length']);

        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $this->loadPassword($container, $config['user']['password'], $loader);
        $this->loadServices($loader);
        $this->loadApiKeyPurger($container, $loader, $config['api_key_purge']);
        $this->overrideServices($container, $config['services']);

        $container->setParameter('ma27_api_key_authentication.response_values', $config['response']);
    }

    /**
     * Loads the password strategy.
     *
     * @param ContainerBuilder      $container
     * @param string                $passwordConfig
     * @param Loader\YamlFileLoader $loader
     */
    private function loadPassword(ContainerBuilder $container, $passwordConfig, Loader\YamlFileLoader $loader)
    {
        $container->setParameter('ma27_api_key_authentication.password_hashing_service', $passwordConfig['strategy']);
        $container->setParameter('ma27_api_key_authentication.password_hasher.phpass.iteration_length', 8);
        $loader->load('hashers.yml');
    }

    /**
     * Loads all internal services.
     *
     * @param Loader\YamlFileLoader $loader
     */
    private function loadServices(Loader\YamlFileLoader $loader)
    {
        foreach (array('security_key', 'authentication', 'security', 'annotation') as $file) {
            $loader->load(sprintf('%s.yml', $file));
        }
    }

    /**
     * Loads the purger job command into the container.
     *
     * @param ContainerBuilder      $container
     * @param Loader\YamlFileLoader $loader
     * @param string[]              $purgerConfig
     */
    private function loadApiKeyPurger(ContainerBuilder $container, Loader\YamlFileLoader $loader, array $purgerConfig)
    {
        if ($this->isConfigEnabled($container, $purgerConfig)) {
            $loader->load('session_cleanup.yml');

            if ($purgerConfig['log_state']) {
                @trigger_error('The options `api_key_purge.log_state` and the corresponding logger support are deprecated and will be dropped/removed in 2.0!', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                $container->setParameter(
                    'ma27_api_key_authentication.logger',
                    $purgerConfig['logger_service']
                );

                $definition = $container->getDefinition('ma27_api_key_authentication.cleanup_command');
                $definition->addArgument(new Reference($container->getParameter('ma27_api_key_authentication.logger')));

            }

            if ($this->isConfigEnabled($container, $purgerConfig['last_action_listener'])) {
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $loader->load('last_action_listener.yml');
            }
        }
    }

    /**
     * Processes the service override configuration into the container.
     *
     * @param ContainerBuilder $container
     * @param array            $services
     */
    private function overrideServices(ContainerBuilder $container, array $services)
    {
        $semanticServiceReplacements = array_filter($services);
        if (!empty($semanticServiceReplacements)) {
            $serviceConfig = array(
                'auth_handler' => 'ma27_api_key_authentication.auth_handler',
                'key_factory'  => 'ma27_api_key_authentication.key_factory',
            );

            foreach ($serviceConfig as $configIndex => $replaceableServiceId) {
                if (!isset($semanticServiceReplacements[$configIndex]) || null === $serviceId = $semanticServiceReplacements[$configIndex]) {
                    continue;
                }

                $container->removeDefinition($replaceableServiceId);
                $container->setAlias($replaceableServiceId, new Alias($serviceId));
            }
        }
    }
}


1		<?php
2
3		namespace Ma27\ApiKeyAuthenticationBundle\DependencyInjection;
4
5		use Symfony\Component\Config\FileLocator;
6		use Symfony\Component\DependencyInjection\Alias;
7		use Symfony\Component\DependencyInjection\ContainerBuilder;
8		use Symfony\Component\DependencyInjection\Loader;
9		use Symfony\Component\HttpKernel\DependencyInjection\Extension;
10		use Symfony\Component\Validator\Tests\Fixtures\Reference;
11
12		/**
13		* This is the class that loads and manages your bundle configuration.
14		*
15		* To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
16		*/
17		class Ma27ApiKeyAuthenticationExtension extends Extension
18		{
19		/**
20		* {@inheritdoc}
21		*/
22	6	public function load(array $configs, ContainerBuilder $container)
23		{
24	6	$configuration = new Configuration();
25	6	$config = $this->processConfiguration($configuration, $configs);
26
27	6	$container->setParameter('ma27_api_key_authentication.key_header', $config['key_header']);
28	6	$container->setParameter('ma27_api_key_authentication.model_name', $config['user']['model_name']);
29	6	$container->setParameter('ma27_api_key_authentication.object_manager', $config['user']['object_manager']);
30	6	$container->setParameter('ma27_api_key_authentication.property.apiKeyLength', $config['user']['api_key_length']);
31
32	6	$loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
33	6	$this->loadPassword($container, $config['user']['password'], $loader);
34	6	$this->loadServices($loader);
35	6	$this->loadApiKeyPurger($container, $loader, $config['api_key_purge']);
36	6	$this->overrideServices($container, $config['services']);
37
38	6	$container->setParameter('ma27_api_key_authentication.response_values', $config['response']);
39	6	}
40
41		/**
42		* Loads the password strategy.
43		*
44		* @param ContainerBuilder $container
45		* @param string $passwordConfig
46		* @param Loader\YamlFileLoader $loader
47		*/
48	6	private function loadPassword(ContainerBuilder $container, $passwordConfig, Loader\YamlFileLoader $loader)
49		{
50	6	$container->setParameter('ma27_api_key_authentication.password_hashing_service', $passwordConfig['strategy']);
51	6	$container->setParameter('ma27_api_key_authentication.password_hasher.phpass.iteration_length', 8);
52	6	$loader->load('hashers.yml');
53	6	}
54
55		/**
56		* Loads all internal services.
57		*
58		* @param Loader\YamlFileLoader $loader
59		*/
60	6	private function loadServices(Loader\YamlFileLoader $loader)
61		{
62	6	foreach (array('security_key', 'authentication', 'security', 'annotation') as $file) {
63	6	$loader->load(sprintf('%s.yml', $file));
64	6	}
65	6	}
66
67		/**
68		* Loads the purger job command into the container.
69		*
70		* @param ContainerBuilder $container
71		* @param Loader\YamlFileLoader $loader
72		* @param string[] $purgerConfig
73		*/
74	6	private function loadApiKeyPurger(ContainerBuilder $container, Loader\YamlFileLoader $loader, array $purgerConfig)
75		{
76	6	if ($this->isConfigEnabled($container, $purgerConfig)) {
77	2	$loader->load('session_cleanup.yml');
78
79	2	if ($purgerConfig['log_state']) {
80	1	@trigger_error('The options `api_key_purge.log_state` and the corresponding logger support are deprecated and will be dropped/removed in 2.0!', E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2016-06-18 22:25 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
81	1	$container->setParameter(
82	1	'ma27_api_key_authentication.logger',
83	1	$purgerConfig['logger_service']
84	1	);
85
86	1	$definition = $container->getDefinition('ma27_api_key_authentication.cleanup_command');
87	1	$definition->addArgument(new Reference($container->getParameter('ma27_api_key_authentication.logger')));
		0 ignored issues – show Unused Code introduced 2016-08-03 15:59 UTC by Report Bug Copy Issue Report The call to `Reference::__construct()` has too many arguments starting with `$container->getParameter...authentication.logger')`. 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...
88	1	}
89
90	2	if ($this->isConfigEnabled($container, $purgerConfig['last_action_listener'])) {
		0 ignored issues – show Documentation introduced 2016-08-03 15:59 UTC by Report Bug Copy Issue Report `$purgerConfig['last_action_listener']` is of type `string`, but the function expects a `array`. 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...
91	2	$loader->load('last_action_listener.yml');
92	2	}
93	2	}
94	6	}
95
96		/**
97		* Processes the service override configuration into the container.
98		*
99		* @param ContainerBuilder $container
100		* @param array $services
101		*/
102	6	private function overrideServices(ContainerBuilder $container, array $services)
103		{
104	6	$semanticServiceReplacements = array_filter($services);
105	6	if (!empty($semanticServiceReplacements)) {
106		$serviceConfig = array(
107	1	'auth_handler' => 'ma27_api_key_authentication.auth_handler',
108	1	'key_factory' => 'ma27_api_key_authentication.key_factory',
109	1	);
110
111	1	foreach ($serviceConfig as $configIndex => $replaceableServiceId) {
112	1	if (!isset($semanticServiceReplacements[$configIndex]) \|\| null === $serviceId = $semanticServiceReplacements[$configIndex]) {
113	1	continue;
114		}
115
116	1	$container->removeDefinition($replaceableServiceId);
117	1	$container->setAlias($replaceableServiceId, new Alias($serviceId));
118	1	}
119	1	}
120	6	}
121		}
122

Ma27 / Ma27ApiKeyAuthenticationBundle

GitHub Access Token became invalid

Branch — develop (1f013c)

overrideServices() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like