SchemaBuilderInstallerPass::warnAboutRelyingOnDeprecatedService() - Code Metrics - Inspection of "EZP-30797: Implemented configuration for user pass..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp_30797 ( b39740...a92ef0 )

unknown

created 2019-09-20 15:25 UTC

warnAboutRelyingOnDeprecatedService() A

↳ Parent: SchemaBuilderInstallerPass

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	2
nop	2
dl	0
loc	27
rs	9.488
c	0
b	0
f	0

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
declare(strict_types=1);

namespace EzSystems\PlatformInstallerBundle\DependencyInjection\Compiler;

use EzSystems\DoctrineSchema\API\Builder\SchemaBuilder;
use EzSystems\PlatformInstallerBundle\Installer\CoreInstaller;
use EzSystems\PlatformInstallerBundle\Installer\DbBasedInstaller;
use Symfony\Component\DependencyInjection\ChildDefinition;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;

/**
 * Enable installer which uses SchemaBuilder.
 *
 * <code>DoctrineSchemaBundle</code> is available via <code>ezsystems/doctrine-dbal-schema</code> package.
 *
 * @see \EzSystems\DoctrineSchemaBundle\DoctrineSchemaBundle
 * @see \EzSystems\PlatformInstallerBundle\Installer\CoreInstaller
 */
class SchemaBuilderInstallerPass implements CompilerPassInterface
{
    const CLEAN_INSTALLER_DEF_ID = 'ezplatform.installer.clean_installer';
    const DB_BASED_INSTALLER_DEF_ID = 'ezplatform.installer.db_based_installer';

    /**
     * Replace Clean installer with CoreInstaller if required SchemaBuilder from DoctrineSchemaBundle is available.
     *
     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
     *
     * @throws \Exception
     */
    public function process(ContainerBuilder $container)
    {
        if (!$container->hasAlias(SchemaBuilder::class)) {
            $container->removeDefinition(CoreInstaller::class);
            @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                sprintf(
                    'Using eZ Platform Installer Bundle without enabling Doctrine Schema Bundle (%s) ' .
                    'is deprecated since v2.5 LTS and will cause a fatal error in eZ Platform v3.0',
                    'https://github.com/ezsystems/doctrine-dbal-schema'
                ),
                E_USER_DEPRECATED
            );
        } elseif ($container->hasDefinition(self::CLEAN_INSTALLER_DEF_ID)) {
            // remove the actual definition first for alias to work properly
            $container->removeDefinition(self::CLEAN_INSTALLER_DEF_ID);
            $container->setAlias(self::CLEAN_INSTALLER_DEF_ID, CoreInstaller::class);
        }

        $this->warnAboutRelyingOnDeprecatedService(
            $container,
            [
                self::DB_BASED_INSTALLER_DEF_ID => DbBasedInstaller::class,
                self::CLEAN_INSTALLER_DEF_ID => CoreInstaller::class,
            ]
        );
    }

    /**
     * Find usages of deprecated service definitions in custom services.
     *
     * Note: natural choice would be to use `deprecated` attribute in DIC instead, however
     * in Symfony 3.4 neither deprecating service alias nor deprecating abstract service gives
     * proper warning in the application logs.
     *
     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
     * @param string[] a map of old to new names (associative array)
     */
    private function warnAboutRelyingOnDeprecatedService(
        ContainerBuilder $container,
        array $oldNewNameMap
    ): void {
        // find usages of deprecated definitions as parents
        /** @var \Symfony\Component\DependencyInjection\ChildDefinition[] $deprecatedParentDefinitions */
        $deprecatedParentDefinitions = array_filter(
            $container->getDefinitions(),
            function (Definition $definition) use ($oldNewNameMap) {
                return $definition instanceof ChildDefinition
                    && array_key_exists($definition->getParent(), $oldNewNameMap);
            }
        );
        // trigger deprecation warnings to be logged
        foreach ($deprecatedParentDefinitions as $id => $definition) {
            $parent = $definition->getParent();
            @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                sprintf(
                    'The service definition "%s" relies on the deprecated "%s" service. Use "%s" instead',
                    $id,
                    $parent,
                    $oldNewNameMap[$parent]
                ),
                E_USER_DEPRECATED
            );
        }
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
5			* @license For full copyright and license information view LICENSE file distributed with this source code.
6			*/
7			declare(strict_types=1);
8
9			namespace EzSystems\PlatformInstallerBundle\DependencyInjection\Compiler;
10
11			use EzSystems\DoctrineSchema\API\Builder\SchemaBuilder;
12			use EzSystems\PlatformInstallerBundle\Installer\CoreInstaller;
13			use EzSystems\PlatformInstallerBundle\Installer\DbBasedInstaller;
14			use Symfony\Component\DependencyInjection\ChildDefinition;
15			use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
16			use Symfony\Component\DependencyInjection\ContainerBuilder;
17			use Symfony\Component\DependencyInjection\Definition;
18
19			/**
20			* Enable installer which uses SchemaBuilder.
21			*
22			* <code>DoctrineSchemaBundle</code> is available via <code>ezsystems/doctrine-dbal-schema</code> package.
23			*
24			* @see \EzSystems\DoctrineSchemaBundle\DoctrineSchemaBundle
25			* @see \EzSystems\PlatformInstallerBundle\Installer\CoreInstaller
26			*/
27			class SchemaBuilderInstallerPass implements CompilerPassInterface
28			{
29			const CLEAN_INSTALLER_DEF_ID = 'ezplatform.installer.clean_installer';
30			const DB_BASED_INSTALLER_DEF_ID = 'ezplatform.installer.db_based_installer';
31
32			/**
33			* Replace Clean installer with CoreInstaller if required SchemaBuilder from DoctrineSchemaBundle is available.
34			*
35			* @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
36			*
37			* @throws \Exception
38			*/
39			public function process(ContainerBuilder $container)
40			{
41			if (!$container->hasAlias(SchemaBuilder::class)) {
42			$container->removeDefinition(CoreInstaller::class);
43			@trigger_error(
			0 ignored issues – show Security Best Practice introduced 2019-09-11 09:47 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...
44			sprintf(
45			'Using eZ Platform Installer Bundle without enabling Doctrine Schema Bundle (%s) ' .
46			'is deprecated since v2.5 LTS and will cause a fatal error in eZ Platform v3.0',
47			'https://github.com/ezsystems/doctrine-dbal-schema'
48			),
49			E_USER_DEPRECATED
50			);
51			} elseif ($container->hasDefinition(self::CLEAN_INSTALLER_DEF_ID)) {
52			// remove the actual definition first for alias to work properly
53			$container->removeDefinition(self::CLEAN_INSTALLER_DEF_ID);
54			$container->setAlias(self::CLEAN_INSTALLER_DEF_ID, CoreInstaller::class);
55			}
56
57			$this->warnAboutRelyingOnDeprecatedService(
58			$container,
59			[
60			self::DB_BASED_INSTALLER_DEF_ID => DbBasedInstaller::class,
61			self::CLEAN_INSTALLER_DEF_ID => CoreInstaller::class,
62			]
63			);
64			}
65
66			/**
67			* Find usages of deprecated service definitions in custom services.
68			*
69			* Note: natural choice would be to use `deprecated` attribute in DIC instead, however
70			* in Symfony 3.4 neither deprecating service alias nor deprecating abstract service gives
71			* proper warning in the application logs.
72			*
73			* @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
74			* @param string[] a map of old to new names (associative array)
75			*/
76			private function warnAboutRelyingOnDeprecatedService(
77			ContainerBuilder $container,
78			array $oldNewNameMap
79			): void {
80			// find usages of deprecated definitions as parents
81			/** @var \Symfony\Component\DependencyInjection\ChildDefinition[] $deprecatedParentDefinitions */
82			$deprecatedParentDefinitions = array_filter(
83			$container->getDefinitions(),
84			function (Definition $definition) use ($oldNewNameMap) {
85			return $definition instanceof ChildDefinition
86			&& array_key_exists($definition->getParent(), $oldNewNameMap);
87			}
88			);
89			// trigger deprecation warnings to be logged
90			foreach ($deprecatedParentDefinitions as $id => $definition) {
91			$parent = $definition->getParent();
92			@trigger_error(
			0 ignored issues – show Security Best Practice introduced 2019-09-11 09:47 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...
93			sprintf(
94			'The service definition "%s" relies on the deprecated "%s" service. Use "%s" instead',
95			$id,
96			$parent,
97			$oldNewNameMap[$parent]
98			),
99			E_USER_DEPRECATED
100			);
101			}
102			}
103			}
104

ezsystems / ezpublish-kernel

Push — ezp_30797 ( b39740...a92ef0 )

warnAboutRelyingOnDeprecatedService() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like