KunstmaanAdminExtension - Code Metrics - Inspection of "[AdminBundle][FosuUserBundle] Deprecate FosUserBun..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#2737)

by Jeroen
created 2020-10-30 14:49 UTC
KunstmaanAdminExtension A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	259
Duplicated Lines	19.69 %
Coupling/Cohesion

Components	1
Dependencies	10
Test Coverage

Coverage
97.32%
Importance

Changes
Metric	Value
wmc	38
lcom	1
cbo	10
dl	51
loc	259
ccs	109
cts	112
cp	0.9732
rs	9.36
c	0
b	0
f	0
11 Methods

Rating	Name	Duplication	Size	Complexity
A	getXsdValidationBasePath()	0	4	1
A	addRequiredLocalesParameter()	12	12	3
A	getNamespace()	0	4	1
A	addWebsiteTitleParameter()	11	11	3
A	addMultiLanguageParameter()	11	11	3
A	prepend()	0	35	4
A	addSimpleMenuAdaptor()	0	10	1
A	normalizeUrlSlice()	0	13	1
A	addDefaultLocaleParameter()	11	11	3
B	load()	0	64	7
C	configureAuthentication()	6	52	11
How to fix Duplicated Code

<?php

namespace Kunstmaan\AdminBundle\DependencyInjection;

use FOS\UserBundle\Form\Type\ResettingFormType;
use InvalidArgumentException;
use Kunstmaan\AdminBundle\Helper\Menu\MenuAdaptorInterface;
use Kunstmaan\AdminBundle\Service\AuthenticationMailer\SwiftmailerService;
use Kunstmaan\AdminBundle\Service\AuthenticationMailer\SymfonyMailerService;
use Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Loader\LoaderInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Exception\LogicException;
use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
use Symfony\Component\DependencyInjection\Loader;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\Mailer\Mailer;
use Kunstmaan\AdminBundle\DependencyInjection\Routes\FosRouteLoader;

/**
 * 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 KunstmaanAdminExtension extends Extension implements PrependExtensionInterface
{
    /**
     * Loads a specific configuration.
     *
     * @param array            $configs   An array of configuration values
     * @param ContainerBuilder $container A ContainerBuilder instance
     *
     * @throws InvalidArgumentException When provided tag is not defined in this extension
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('services.yml');
        $loader->load('commands.yml');

        $container->setParameter('version_checker.url', 'https://cms.kunstmaan.be/version-check');
        $container->setParameter('version_checker.timeframe', 60 * 60 * 24);
        $container->setParameter('version_checker.enabled', true);

        $configuration = new Configuration();
        $config = $this->processConfiguration($configuration, $configs);

        if (\array_key_exists('dashboard_route', $config)) {
            $container->setParameter('kunstmaan_admin.dashboard_route', $config['dashboard_route']);
        }
        if (\array_key_exists('admin_password', $config)) {
            $container->setParameter('kunstmaan_admin.admin_password', $config['admin_password']);
        }

        $this->configureAuthentication($config, $container, $loader);

        $container->setParameter('kunstmaan_admin.admin_locales', $config['admin_locales']);
        $container->setParameter('kunstmaan_admin.default_admin_locale', $config['default_admin_locale']);

        $container->setParameter('kunstmaan_admin.session_security.ip_check', $config['session_security']['ip_check']);
        $container->setParameter('kunstmaan_admin.session_security.user_agent_check', $config['session_security']['user_agent_check']);

        $container->setParameter('kunstmaan_admin.admin_prefix', $this->normalizeUrlSlice($config['admin_prefix']));

        $container->setParameter('kunstmaan_admin.admin_exception_excludes', $config['admin_exception_excludes']);

        $container->setParameter('kunstmaan_admin.google_signin.enabled', $config['google_signin']['enabled']);
        $container->setParameter('kunstmaan_admin.google_signin.client_id', $config['google_signin']['client_id']);
        $container->setParameter('kunstmaan_admin.google_signin.client_secret', $config['google_signin']['client_secret']);
        $container->setParameter('kunstmaan_admin.google_signin.hosted_domains', $config['google_signin']['hosted_domains']);

        $container->setParameter('kunstmaan_admin.password_restrictions.min_digits', $config['password_restrictions']['min_digits']);
        $container->setParameter('kunstmaan_admin.password_restrictions.min_uppercase', $config['password_restrictions']['min_uppercase']);
        $container->setParameter('kunstmaan_admin.password_restrictions.min_special_characters', $config['password_restrictions']['min_special_characters']);
        $container->setParameter('kunstmaan_admin.password_restrictions.min_length', $config['password_restrictions']['min_length']);
        $container->setParameter('kunstmaan_admin.password_restrictions.max_length', $config['password_restrictions']['max_length']);
        $container->setParameter('kunstmaan_admin.enable_toolbar_helper', $config['enable_toolbar_helper']);
        $container->setParameter('kunstmaan_admin.toolbar_firewall_names', !empty($config['provider_keys']) ? $config['provider_keys'] : $config['toolbar_firewall_names']);
        $container->setParameter('kunstmaan_admin.admin_firewall_name', $config['admin_firewall_name']);
        $container->setParameter('kunstmaan_admin.user_class', $config['admin_user_class']);
        $container->setParameter('kunstmaan_admin.group_class', $config['admin_group_class']);

        $container->registerForAutoconfiguration(MenuAdaptorInterface::class)
            ->addTag('kunstmaan_admin.menu.adaptor');

        if (!empty($config['enable_console_exception_listener']) && $config['enable_console_exception_listener']) {
            $loader->load('console_listener.yml');
        }

        if (0 !== \count($config['menu_items'])) {
            $this->addSimpleMenuAdaptor($container, $config['menu_items']);
        }

        $this->addWebsiteTitleParameter($container, $config);
        $this->addMultiLanguageParameter($container, $config);
        $this->addRequiredLocalesParameter($container, $config);
        $this->addDefaultLocaleParameter($container, $config);
    }

    public function prepend(ContainerBuilder $container)
    {
        $fosUserOriginalConfig = $container->getExtensionConfig('fos_user');
        if (!isset($fosUserOriginalConfig[0]['db_driver'])) {
            $fosUserConfig['db_driver'] = 'orm'; // other valid values are 'mongodb', 'couchdb'
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }
        $fosUserConfig['from_email']['address'] = '[email protected]';
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
        $fosUserConfig['from_email']['sender_name'] = 'KunstmaanCMS';
        $fosUserConfig['firewall_name'] = 'main';
        $fosUserConfig['user_class'] = 'Kunstmaan\AdminBundle\Entity\User';
        $fosUserConfig['group']['group_class'] = 'Kunstmaan\AdminBundle\Entity\Group';
        $fosUserConfig['resetting']['token_ttl'] = 86400;
        // Use this node only if you don't want the global email address for the resetting email
        $fosUserConfig['resetting']['email']['from_email']['address'] = '[email protected]';
        $fosUserConfig['resetting']['email']['from_email']['sender_name'] = 'KunstmaanCMS';
        $fosUserConfig['resetting']['email']['template'] = '@FOSUser/Resetting/email.txt.twig';
        $fosUserConfig['resetting']['form']['type'] = ResettingFormType::class;
        $fosUserConfig['resetting']['form']['name'] = 'fos_user_resetting_form';
        $fosUserConfig['resetting']['form']['validation_groups'] = ['ResetPassword'];

        $fosUserConfig['service']['mailer'] = 'fos_user.mailer.twig_swift';
        $container->prependExtensionConfig('fos_user', $fosUserConfig);

        // Manually register the KunstmaanAdminBundle folder as a FosUser override for symfony 4.
        if ($container->hasParameter('kernel.project_dir') && file_exists($container->getParameter('kernel.project_dir').'/templates/bundles/KunstmaanAdminBundle')) {
            $twigConfig['paths'][] = ['value' => '%kernel.project_dir%/templates/bundles/KunstmaanAdminBundle', 'namespace' => 'FOSUser'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }
        $twigConfig['paths'][] = ['value' => \dirname(__DIR__).'/Resources/views', 'namespace' => 'FOSUser'];
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
        $container->prependExtensionConfig('twig', $twigConfig);

        // NEXT_MAJOR: Remove templating dependency

        $configs = $container->getExtensionConfig($this->getAlias());
        $this->processConfiguration(new Configuration(), $configs);
    }

    /**
     * {@inheritdoc}
     */
    public function getNamespace()
    {
        return 'http://bundles.kunstmaan.be/schema/dic/admin';
    }

    /**
     * {@inheritdoc}
     */
    public function getXsdValidationBasePath()
    {
        return __DIR__.'/../Resources/config/schema';
    }

    private function addSimpleMenuAdaptor(ContainerBuilder $container, array $menuItems)
    {
        $definition = new Definition('Kunstmaan\AdminBundle\Helper\Menu\SimpleMenuAdaptor', [
            new Reference('security.authorization_checker'),
            $menuItems,
        ]);
        $definition->addTag('kunstmaan_admin.menu.adaptor');

        $container->setDefinition('kunstmaan_admin.menu.adaptor.simple', $definition);
    }

    /**
     * @param string $urlSlice
     *
     * @return string
     */
    protected function normalizeUrlSlice($urlSlice)
    {
        /* Get rid of exotic characters that would break the url */
        $urlSlice = filter_var($urlSlice, FILTER_SANITIZE_URL);

        /* Remove leading and trailing slashes */
        $urlSlice = trim($urlSlice, '/');

        /* Make sure our $urlSlice is literally used in our regex */
        $urlSlice = preg_quote($urlSlice);

        return $urlSlice;
    }

    private function addWebsiteTitleParameter(ContainerBuilder $container, array $config)

    {
        $websiteTitle = $config['website_title'];
        if (null === $config['website_title']) {
            @trigger_error('Not providing a value for the "kunstmaan_admin.website_title" config is deprecated since KunstmaanAdminBundle 5.2, this config value will be required in KunstmaanAdminBundle 6.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.');
}

            $websiteTitle = $container->hasParameter('websitetitle') ? $container->getParameter('websitetitle') : '';
        }

        $container->setParameter('kunstmaan_admin.website_title', $websiteTitle);
    }

    private function addMultiLanguageParameter(ContainerBuilder $container, array $config)

    {
        $multilanguage = $config['multi_language'];
        if (null === $multilanguage) {
            @trigger_error('Not providing a value for the "kunstmaan_admin.multi_language" config is deprecated since KunstmaanAdminBundle 5.2, this config value will be required in KunstmaanAdminBundle 6.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.');
}

            $multilanguage = $container->hasParameter('multilanguage') ? $container->getParameter('multilanguage') : '';
        }

        $container->setParameter('kunstmaan_admin.multi_language', $multilanguage);
    }

    private function addRequiredLocalesParameter(ContainerBuilder $container, array $config)

    {
        $requiredLocales = $config['required_locales'];
        if (null === $config['required_locales']) {
            @trigger_error('Not providing a value for the "kunstmaan_admin.required_locales" config is deprecated since KunstmaanAdminBundle 5.2, this config value will be required in KunstmaanAdminBundle 6.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.');
}

            $requiredLocales = $container->hasParameter('requiredlocales') ? $container->getParameter('requiredlocales') : '';
        }

        $container->setParameter('kunstmaan_admin.required_locales', $requiredLocales);
        $container->setParameter('requiredlocales', $requiredLocales); //Keep old parameter for to keep BC with routing config
    }

    private function addDefaultLocaleParameter(ContainerBuilder $container, array $config)

    {
        $defaultLocale = $config['default_locale'];
        if (null === $config['default_locale']) {
            @trigger_error('Not providing a value for the "kunstmaan_admin.default_locale" config is deprecated since KunstmaanAdminBundle 5.2, this config value will be required in KunstmaanAdminBundle 6.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.');
}

            $defaultLocale = $container->hasParameter('defaultlocale') ? $container->getParameter('defaultlocale') : '';
        }

        $container->setParameter('kunstmaan_admin.default_locale', $defaultLocale);
    }

    private function configureAuthentication(array $config, ContainerBuilder $container, LoaderInterface $loader)
    {
        $enableCustomLogin = $config['authentication']['enable_new_authentication'];
        $container->setParameter('kunstmaan_admin.enable_new_cms_authentication', $enableCustomLogin);

        if (!$enableCustomLogin) {
            @trigger_error('Not setting "kunstmaan_admin.authentication.enable_new_authentication" to true is deprecated since KunstmaanAdminBundle 5.8, it will always be true in KunstmaanAdminBundle 6.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.');
}

            return;
        }

        $loader->load('authentication.yml');

        $fosRouteLoaderDefinition = $container->getDefinition(FosRouteLoader::class);
        $fosRouteLoaderDefinition->setArgument(0, $enableCustomLogin);

        $container->setAlias('kunstmaan_admin.authentication.mailer', $config['authentication']['mailer']['service']);

        // Validate mailer config
        if (!class_exists(SwiftmailerBundle::class) && !class_exists(Mailer::class)) {
            throw new LogicException('No mail integration found to enable the authentication mailer. Try running "composer require symfony/mailer" or "composer require symfony/swiftmailer-bundle".');
        }

        if ($config['authentication']['mailer']['service'] === SymfonyMailerService::class && !class_exists(Mailer::class)) {

            throw new LogicException('Symfony mailer support for the authentication mailer cannot be enabled as the component is not installed. Try running "composer require symfony/mailer".');
        }

        if ($config['authentication']['mailer']['service'] === SwiftmailerService::class && !class_exists(SwiftmailerBundle::class)) {

            throw new LogicException('Swiftmailer support for the authentication mailer cannot be enabled as the component is not installed. Try running "composer require symfony/swiftmailer-bundle".');
        }

        // Cleanup mailer services
        if (!class_exists(SwiftmailerBundle::class)) {
            $container->removeDefinition(SwiftmailerService::class);
        }

        if (!class_exists(Mailer::class)) {
            $container->removeDefinition(SymfonyMailerService::class);
        }

        if ($container->hasDefinition(SwiftmailerService::class)) {
            $definition = $container->getDefinition(SwiftmailerService::class);
            $definition
                ->setArgument(4, $config['authentication']['mailer']['from_address'])
                ->setArgument(5, $config['authentication']['mailer']['from_name'])
            ;
        }

        $mailerAddress = $container->getDefinition('kunstmaan_admin.mailer.default_sender');
        $mailerAddress->setArgument(0, $config['authentication']['mailer']['from_address']);
        $mailerAddress->setArgument(1, $config['authentication']['mailer']['from_name']);
    }
}

Pull Request — master (#2737)

KunstmaanAdminExtension A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Kunstmaan / KunstmaanBundlesCMS

Pull Request — master (#2737)

KunstmaanAdminExtension A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
