Completed
Push — master ( e62fa2...4391c3 )
by Kristof
133:20 queued 117:59
created

DependencyInjection/KunstmaanAdminExtension.php (2 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace Kunstmaan\AdminBundle\DependencyInjection;
4
5
use FOS\UserBundle\Form\Type\ResettingFormType;
6
use InvalidArgumentException;
7
use Kunstmaan\AdminBundle\Helper\Menu\MenuAdaptorInterface;
8
use Symfony\Component\Config\FileLocator;
9
use Symfony\Component\DependencyInjection\ContainerBuilder;
10
use Symfony\Component\DependencyInjection\Definition;
11
use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
12
use Symfony\Component\DependencyInjection\Loader;
13
use Symfony\Component\DependencyInjection\Reference;
14
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
15
16
/**
17
 * This is the class that loads and manages your bundle configuration
18
 *
19
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
20
 */
21
class KunstmaanAdminExtension extends Extension implements PrependExtensionInterface
22
{
23
    /**
24
     * Loads a specific configuration.
25
     *
26
     * @param array            $configs   An array of configuration values
27
     * @param ContainerBuilder $container A ContainerBuilder instance
28
     *
29
     * @throws InvalidArgumentException When provided tag is not defined in this extension
30
     */
31
    public function load(array $configs, ContainerBuilder $container)
32
    {
33
        $container->setParameter('version_checker.url', 'https://bundles.kunstmaan.be/version-check');
34
        $container->setParameter('version_checker.timeframe', 60 * 60 * 24);
35
        $container->setParameter('version_checker.enabled', true);
36
37
        $configuration = new Configuration();
38
        $config = $this->processConfiguration($configuration, $configs);
39
40
        if (array_key_exists('dashboard_route', $config)) {
41
            $container->setParameter('kunstmaan_admin.dashboard_route', $config['dashboard_route']);
42
        }
43
        if (array_key_exists('admin_password', $config)) {
44
            $container->setParameter('kunstmaan_admin.admin_password', $config['admin_password']);
45
        }
46
        $container->setParameter('kunstmaan_admin.admin_locales', $config['admin_locales']);
47
        $container->setParameter('kunstmaan_admin.default_admin_locale', $config['default_admin_locale']);
48
49
        $container->setParameter('kunstmaan_admin.session_security.ip_check', $config['session_security']['ip_check']);
50
        $container->setParameter('kunstmaan_admin.session_security.user_agent_check', $config['session_security']['user_agent_check']);
51
52
        $container->setParameter('kunstmaan_admin.admin_prefix', $this->normalizeUrlSlice($config['admin_prefix']));
53
54
        $container->setParameter('kunstmaan_admin.admin_exception_excludes', $config['admin_exception_excludes']);
55
56
        $container->setParameter('kunstmaan_admin.google_signin.enabled', $config['google_signin']['enabled']);
57
        $container->setParameter('kunstmaan_admin.google_signin.client_id', $config['google_signin']['client_id']);
58
        $container->setParameter('kunstmaan_admin.google_signin.client_secret', $config['google_signin']['client_secret']);
59
        $container->setParameter('kunstmaan_admin.google_signin.hosted_domains', $config['google_signin']['hosted_domains']);
60
61
        $container->setParameter('kunstmaan_admin.password_restrictions.min_digits', $config['password_restrictions']['min_digits']);
62
        $container->setParameter('kunstmaan_admin.password_restrictions.min_uppercase', $config['password_restrictions']['min_uppercase']);
63
        $container->setParameter('kunstmaan_admin.password_restrictions.min_special_characters', $config['password_restrictions']['min_special_characters']);
64
        $container->setParameter('kunstmaan_admin.password_restrictions.min_length', $config['password_restrictions']['min_length']);
65
        $container->setParameter('kunstmaan_admin.password_restrictions.max_length', $config['password_restrictions']['max_length']);
66
        $container->setParameter('kunstmaan_admin.enable_toolbar_helper', $config['enable_toolbar_helper']);
67
        $container->setParameter('kunstmaan_admin.toolbar_firewall_names', !empty($config['provider_keys']) ? $config['provider_keys'] : $config['toolbar_firewall_names']);
68
        $container->setParameter('kunstmaan_admin.admin_firewall_name', $config['admin_firewall_name']);
69
70
        $container->registerForAutoconfiguration(MenuAdaptorInterface::class)
71
            ->addTag('kunstmaan_admin.menu.adaptor');
72
73
        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
74
        $loader->load('services.yml');
75
        $loader->load('commands.yml');
76
77
        if (!empty($config['enable_console_exception_listener']) && $config['enable_console_exception_listener']) {
78
            $loader->load('console_listener.yml');
79
        }
80
81
        if (0 !== count($config['menu_items'])) {
82
            $this->addSimpleMenuAdaptor($container, $config['menu_items']);
83
        }
84
85
        $websiteTitle = $container->hasParameter('websitetitle') ? $container->getParameter('websitetitle') : '';
86
        if (null === $config['website_title']) {
87
            @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);
0 ignored issues
show
Security Best Practice introduced by
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...
88
        } else {
89
            $websiteTitle = $config['website_title'];
90
        }
91
92
        $container->setParameter('kunstmaan_admin.website_title', $websiteTitle);
93
    }
94
95
    public function prepend(ContainerBuilder $container)
96
    {
97
        $knpMenuConfig['twig'] = true; // set to false to disable the Twig extension and the TwigRenderer
98
        $knpMenuConfig['templating'] = false; // if true, enables the helper for PHP templates
99
        $knpMenuConfig['default_renderer'] = 'twig'; // The renderer to use, list is also available by default
100
        $container->prependExtensionConfig('knp_menu', $knpMenuConfig);
101
102
        $fosUserConfig['db_driver'] = 'orm'; // other valid values are 'mongodb', 'couchdb'
103
        $fosUserConfig['from_email']['address'] = '[email protected]';
104
        $fosUserConfig['from_email']['sender_name'] = 'KunstmaanCMS';
105
        $fosUserConfig['firewall_name'] = 'main';
106
        $fosUserConfig['user_class'] = 'Kunstmaan\AdminBundle\Entity\User';
107
        $fosUserConfig['group']['group_class'] = 'Kunstmaan\AdminBundle\Entity\Group';
108
        $fosUserConfig['resetting']['token_ttl'] = 86400;
109
        // Use this node only if you don't want the global email address for the resetting email
110
        $fosUserConfig['resetting']['email']['from_email']['address'] = '[email protected]';
111
        $fosUserConfig['resetting']['email']['from_email']['sender_name'] = 'KunstmaanCMS';
112
        $fosUserConfig['resetting']['email']['template'] = 'FOSUserBundle:Resetting:email.txt.twig';
113
        $fosUserConfig['resetting']['form']['type'] = ResettingFormType::class;
114
        $fosUserConfig['resetting']['form']['name'] = 'fos_user_resetting_form';
115
        $fosUserConfig['resetting']['form']['validation_groups'] = ['ResetPassword'];
116
        $container->prependExtensionConfig('fos_user', $fosUserConfig);
117
118
        $monologConfig['handlers']['main']['type'] = 'rotating_file';
119
        $monologConfig['handlers']['main']['path'] = sprintf('%s/%s', $container->getParameter('kernel.logs_dir'), $container->getParameter('kernel.environment'));
120
        $monologConfig['handlers']['main']['level'] = 'debug';
121
        $container->prependExtensionConfig('monolog', $monologConfig);
122
123
        $twigConfig['paths'][] = ['value' => dirname(__DIR__).'/Resources/views', 'namespace' => 'FOSUser'];
0 ignored issues
show
Coding Style Comprehensibility introduced by
$twigConfig was never initialized. Although not strictly required by PHP, it is generally a good practice to add $twigConfig = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
124
        $container->prependExtensionConfig('twig', $twigConfig);
125
126
        $configs = $container->getExtensionConfig($this->getAlias());
127
        $this->processConfiguration(new Configuration(), $configs);
128
    }
129
130
    /**
131
     * {@inheritdoc}
132
     */
133
    public function getNamespace()
134
    {
135
        return 'http://bundles.kunstmaan.be/schema/dic/admin';
136
    }
137
138
    /**
139
     * {@inheritdoc}
140
     */
141
    public function getXsdValidationBasePath()
142
    {
143
        return __DIR__.'/../Resources/config/schema';
144
    }
145
146
    private function addSimpleMenuAdaptor(ContainerBuilder $container, array $menuItems)
147
    {
148
        $definition = new Definition('Kunstmaan\AdminBundle\Helper\Menu\SimpleMenuAdaptor', [
149
            new Reference('security.authorization_checker'),
150
            $menuItems,
151
        ]);
152
        $definition->addTag('kunstmaan_admin.menu.adaptor');
153
154
        $container->setDefinition('kunstmaan_admin.menu.adaptor.simple', $definition);
155
    }
156
157
    /**
158
     * @param string $urlSlice
159
     *
160
     * @return string
161
     */
162
    protected function normalizeUrlSlice($urlSlice)
163
    {
164
        /* Get rid of exotic characters that would break the url */
165
        $urlSlice = filter_var($urlSlice, FILTER_SANITIZE_URL);
166
167
        /* Remove leading and trailing slashes */
168
        $urlSlice = trim($urlSlice, '/');
169
170
        /* Make sure our $urlSlice is literally used in our regex */
171
        $urlSlice = preg_quote($urlSlice);
172
173
        return $urlSlice;
174
    }
175
}
176