GenerateObjectAclCommand::__construct() - Code Metrics - Inspection of "Symfony 5.0 compatibility" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6093)

by Mathieu

created 2020-07-31 17:04 UTC

GenerateObjectAclCommand::__construct() A

↳ Parent: GenerateObjectAclCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	3

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Command;

use Doctrine\Common\Persistence\ManagerRegistry;
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\Pool;
use Sonata\AdminBundle\Util\ObjectAclManipulatorInterface;
use Symfony\Bridge\Doctrine\RegistryInterface;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
use Symfony\Component\Security\Acl\Domain\UserSecurityIdentity;

/**
 * @final since sonata-project/admin-bundle 3.52
 *
 * @author Thomas Rabaix <[email protected]>
 */
class GenerateObjectAclCommand extends QuestionableCommand
{
    protected static $defaultName = 'sonata:admin:generate-object-acl';

    /**
     * NEXT_MAJOR: Rename to `$userModelClass`.
     *
     * @var string
     */
    protected $userEntityClass = '';

    /**
     * @var Pool
     */
    private $pool;

    /**
     * An array of object ACL manipulators indexed by their service ids.
     *
     * @var ObjectAclManipulatorInterface[]
     */
    private $aclObjectManipulators = [];

    /**
     * @var ManagerRegistry|null
     */
    private $registry;

    public function __construct(Pool $pool, array $aclObjectManipulators, ?ManagerRegistry $registry = null)
    {
        $this->pool = $pool;
        $this->aclObjectManipulators = $aclObjectManipulators;
        $this->registry = $registry;

        parent::__construct();
    }

    public function configure(): void
    {
        $this
            ->setDescription('Install ACL for the objects of the Admin Classes.')
            ->addOption('object_owner', null, InputOption::VALUE_OPTIONAL, 'If set, the task will set the object owner for each admin.')
            // NEXT_MAJOR: Remove "user_entity" option.
            ->addOption('user_entity', null, InputOption::VALUE_OPTIONAL, '<error>DEPRECATED</error> Use <comment>user_model</comment> option instead.')
            ->addOption('user_model', null, InputOption::VALUE_OPTIONAL, 'Shortcut notation like <comment>AcmeDemoBundle:User</comment>. If not set, it will be asked the first time an object owner is set.')
            ->addOption('step', null, InputOption::VALUE_NONE, 'If set, the task will ask for each admin if the ACLs need to be generated and what object owner to set, if any.')
        ;
    }

    public function execute(InputInterface $input, OutputInterface $output): int
    {
        $output->writeln('Welcome to the AdminBundle object ACL generator');
        $output->writeln([
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            '',
            'This command helps you to generate ACL entities for the objects handled by the AdminBundle.',
            '',
            'If the step option is used, you will be asked if you want to generate the object ACL entities for each Admin.',
            'You must use the shortcut notation like <comment>AcmeDemoBundle:User</comment> if you want to set an object owner.',
            '',
        ]);

        if (!$this->registry) {
            throw new ServiceNotFoundException('doctrine', static::class, null, [], sprintf(
                'The command "%s" has a dependency on a non-existent service "doctrine".',
                static::$defaultName
            ));
        }

        if ($input->getOption('user_model')) {
            try {
                $this->getUserEntityClass($input, $output);

            } catch (\Exception $e) {
                $output->writeln(sprintf('<error>%s</error>', $e->getMessage()));

                return 1;
            }
        }

        if (!$this->aclObjectManipulators) {

            $output->writeln('No manipulators are implemented : <info>ignoring</info>');

            return 1;
        }

        foreach ($this->pool->getAdminServiceIds() as $id) {
            try {
                $admin = $this->pool->getInstance($id);
            } catch (\Exception $e) {
                $output->writeln('<error>Warning : The admin class cannot be initiated from the command line</error>');
                $output->writeln(sprintf('<error>%s</error>', $e->getMessage()));

                continue;
            }

            if ($input->getOption('step') && !$this->askConfirmation($input, $output, sprintf("<question>Generate ACLs for the object instances handled by \"%s\"?</question>\n", $id), 'no', '?')) {
                continue;
            }

            $securityIdentity = null;
            if ($input->getOption('step') && $this->askConfirmation($input, $output, "<question>Set an object owner?</question>\n", 'no', '?')) {
                $username = $this->askAndValidate($input, $output, 'Please enter the username: ', '', 'Sonata\AdminBundle\Command\Validators::validateUsername');

                $securityIdentity = new UserSecurityIdentity($username, $this->getUserEntityClass($input, $output));

            }
            if (!$input->getOption('step') && $input->getOption('object_owner')) {
                $securityIdentity = new UserSecurityIdentity($input->getOption('object_owner'), $this->getUserEntityClass($input, $output));

            }

            $manipulatorId = sprintf('sonata.admin.manipulator.acl.object.%s', $admin->getManagerType());
            if (!$manipulator = $this->aclObjectManipulators[$manipulatorId] ?? null) {
                $output->writeln('Admin class is using a manager type that has no manipulator implemented : <info>ignoring</info>');

                continue;
            }
            if (!$manipulator instanceof ObjectAclManipulatorInterface) {
                $output->writeln(sprintf('The interface "ObjectAclManipulatorInterface" is not implemented for %s: <info>ignoring</info>', \get_class($manipulator)));

                continue;
            }

            \assert($admin instanceof AdminInterface);
            $manipulator->batchConfigureAcls($output, $admin, $securityIdentity);
        }

        return 0;
    }

    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        parent::initialize($input, $output);

        // NEXT_MAJOR: Remove the following conditional block.
        if (null !== $input->getOption('user_entity')) {
            $output->writeln([
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'Option <comment>user_entity</comment> is deprecated since sonata-project/admin-bundle 3.69 and will be removed in version 4.0.'
                .' Use <comment>user_model</comment> option instead.',
                '',
            ]);

            @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                'Option "user_entity" is deprecated since sonata-project/admin-bundle 3.69 and will be removed in version 4.0.'
                .' Use "user_model" option instead.',
                E_USER_DEPRECATED
            );

            if (null === $input->getOption('user_model')) {
                $input->setOption('user_model', $input->getOption('user_entity'));
            }
        }
    }

    protected function getUserModelClass(InputInterface $input, OutputInterface $output): string
    {
        return $this->getUserEntityClass($input, $output);

    }

    /**
     * NEXT_MAJOR: Remove this method and move its body to `getUserModelClass()`.
     *
     * @deprecated since sonata-project/admin-bundle 3.69. Use `getUserModelClass()` instead.
     *
     * @return string
     */
    protected function getUserEntityClass(InputInterface $input, OutputInterface $output)
    {
        if (self::class !== static::class) {
            @trigger_error(sprintf(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                'Method %s() is deprecated since sonata-project/admin-bundle 3.69 and will be removed in version 4.0.'
                .' Use %s::getUserModelClass() instead.',
                __METHOD__,
                __CLASS__
            ), E_USER_DEPRECATED);
        }

        if ('' === $this->userEntityClass) {
            if ($input->getOption('user_model')) {
                [$userBundle, $userModel] = Validators::validateEntityName($input->getOption('user_model'));

            } else {
                [$userBundle, $userModel] = $this->askAndValidate(
                    $input,
                    $output,
                    'Please enter the User Entity shortcut name: ',
                    '',
                    'Sonata\AdminBundle\Command\Validators::validateEntityName'
                );
            }

            // Entity exists?
            if ($this->registry instanceof RegistryInterface) {
                $namespace = $this->registry->getEntityNamespace($userBundle);
            } else {
                $namespace = $this->registry->getAliasNamespace($userBundle);
            }

            $this->userEntityClass = sprintf('%s\%s', $namespace, $userModel);
        }

        return $this->userEntityClass;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\AdminBundle\Command;
15
16			use Doctrine\Common\Persistence\ManagerRegistry;
17			use Sonata\AdminBundle\Admin\AdminInterface;
18			use Sonata\AdminBundle\Admin\Pool;
19			use Sonata\AdminBundle\Util\ObjectAclManipulatorInterface;
20			use Symfony\Bridge\Doctrine\RegistryInterface;
21			use Symfony\Component\Console\Input\InputInterface;
22			use Symfony\Component\Console\Input\InputOption;
23			use Symfony\Component\Console\Output\OutputInterface;
24			use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
25			use Symfony\Component\Security\Acl\Domain\UserSecurityIdentity;
26
27			/**
28			* @final since sonata-project/admin-bundle 3.52
29			*
30			* @author Thomas Rabaix <[email protected]>
31			*/
32			class GenerateObjectAclCommand extends QuestionableCommand
33			{
34			protected static $defaultName = 'sonata:admin:generate-object-acl';
35
36			/**
37			* NEXT_MAJOR: Rename to `$userModelClass`.
38			*
39			* @var string
40			*/
41			protected $userEntityClass = '';
42
43			/**
44			* @var Pool
45			*/
46			private $pool;
47
48			/**
49			* An array of object ACL manipulators indexed by their service ids.
50			*
51			* @var ObjectAclManipulatorInterface[]
52			*/
53			private $aclObjectManipulators = [];
54
55			/**
56			* @var ManagerRegistry\|null
57			*/
58			private $registry;
59
60			public function __construct(Pool $pool, array $aclObjectManipulators, ?ManagerRegistry $registry = null)
61			{
62			$this->pool = $pool;
63			$this->aclObjectManipulators = $aclObjectManipulators;
64			$this->registry = $registry;
65
66			parent::__construct();
67			}
68
69			public function configure(): void
70			{
71			$this
72			->setDescription('Install ACL for the objects of the Admin Classes.')
73			->addOption('object_owner', null, InputOption::VALUE_OPTIONAL, 'If set, the task will set the object owner for each admin.')
74			// NEXT_MAJOR: Remove "user_entity" option.
75			->addOption('user_entity', null, InputOption::VALUE_OPTIONAL, '<error>DEPRECATED</error> Use <comment>user_model</comment> option instead.')
76			->addOption('user_model', null, InputOption::VALUE_OPTIONAL, 'Shortcut notation like <comment>AcmeDemoBundle:User</comment>. If not set, it will be asked the first time an object owner is set.')
77			->addOption('step', null, InputOption::VALUE_NONE, 'If set, the task will ask for each admin if the ACLs need to be generated and what object owner to set, if any.')
78			;
79			}
80
81			public function execute(InputInterface $input, OutputInterface $output): int
82			{
83			$output->writeln('Welcome to the AdminBundle object ACL generator');
84			$output->writeln([
			0 ignored issues – show Documentation introduced 2019-12-21 01:13 UTC by Report Bug Copy Issue Report `array('', 'This command ... an object owner.', '')` is of type `array<integer,string,{"0..."string","5":"string"}>`, but the function expects a `string\|object<Symfony\Co...onsole\Output\iterable>`. 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...
85			'',
86			'This command helps you to generate ACL entities for the objects handled by the AdminBundle.',
87			'',
88			'If the step option is used, you will be asked if you want to generate the object ACL entities for each Admin.',
89			'You must use the shortcut notation like <comment>AcmeDemoBundle:User</comment> if you want to set an object owner.',
90			'',
91			]);
92
93			if (!$this->registry) {
94			throw new ServiceNotFoundException('doctrine', static::class, null, [], sprintf(
95			'The command "%s" has a dependency on a non-existent service "doctrine".',
96			static::$defaultName
97			));
98			}
99
100			if ($input->getOption('user_model')) {
101			try {
102			$this->getUserEntityClass($input, $output);
			0 ignored issues – show Deprecated Code introduced 2020-06-14 09:35 UTC by Report Bug Copy Issue Report The method `Sonata\AdminBundle\Comma...d::getUserEntityClass()` has been deprecated with message: since sonata-project/admin-bundle 3.69. Use `getUserModelClass()` instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
103			} catch (\Exception $e) {
104			$output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
105
106			return 1;
107			}
108			}
109
110			if (!$this->aclObjectManipulators) {
			0 ignored issues – show Bug Best Practice introduced 2019-09-24 09:08 UTC by Report Bug Copy Issue Report The expression `$this->aclObjectManipulators` of type `Sonata\AdminBundle\Util\...lManipulatorInterface[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
111			$output->writeln('No manipulators are implemented : <info>ignoring</info>');
112
113			return 1;
114			}
115
116			foreach ($this->pool->getAdminServiceIds() as $id) {
117			try {
118			$admin = $this->pool->getInstance($id);
119			} catch (\Exception $e) {
120			$output->writeln('<error>Warning : The admin class cannot be initiated from the command line</error>');
121			$output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
122
123			continue;
124			}
125
126			if ($input->getOption('step') && !$this->askConfirmation($input, $output, sprintf("<question>Generate ACLs for the object instances handled by \"%s\"?</question>\n", $id), 'no', '?')) {
127			continue;
128			}
129
130			$securityIdentity = null;
131			if ($input->getOption('step') && $this->askConfirmation($input, $output, "<question>Set an object owner?</question>\n", 'no', '?')) {
132			$username = $this->askAndValidate($input, $output, 'Please enter the username: ', '', 'Sonata\AdminBundle\Command\Validators::validateUsername');
133
134			$securityIdentity = new UserSecurityIdentity($username, $this->getUserEntityClass($input, $output));
			0 ignored issues – show Deprecated Code introduced 2020-06-14 09:35 UTC by Report Bug Copy Issue Report The method `Sonata\AdminBundle\Comma...d::getUserEntityClass()` has been deprecated with message: since sonata-project/admin-bundle 3.69. Use `getUserModelClass()` instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
135			}
136			if (!$input->getOption('step') && $input->getOption('object_owner')) {
137			$securityIdentity = new UserSecurityIdentity($input->getOption('object_owner'), $this->getUserEntityClass($input, $output));
			0 ignored issues – show Deprecated Code introduced 2020-06-14 09:35 UTC by Report Bug Copy Issue Report The method `Sonata\AdminBundle\Comma...d::getUserEntityClass()` has been deprecated with message: since sonata-project/admin-bundle 3.69. Use `getUserModelClass()` instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
138			}
139
140			$manipulatorId = sprintf('sonata.admin.manipulator.acl.object.%s', $admin->getManagerType());
141			if (!$manipulator = $this->aclObjectManipulators[$manipulatorId] ?? null) {
142			$output->writeln('Admin class is using a manager type that has no manipulator implemented : <info>ignoring</info>');
143
144			continue;
145			}
146			if (!$manipulator instanceof ObjectAclManipulatorInterface) {
147			$output->writeln(sprintf('The interface "ObjectAclManipulatorInterface" is not implemented for %s: <info>ignoring</info>', \get_class($manipulator)));
148
149			continue;
150			}
151
152			\assert($admin instanceof AdminInterface);
153			$manipulator->batchConfigureAcls($output, $admin, $securityIdentity);
154			}
155
156			return 0;
157			}
158
159			protected function initialize(InputInterface $input, OutputInterface $output)
160			{
161			parent::initialize($input, $output);
162
163			// NEXT_MAJOR: Remove the following conditional block.
164			if (null !== $input->getOption('user_entity')) {
165			$output->writeln([
			0 ignored issues – show Documentation introduced 2020-06-14 09:35 UTC by Report Bug Copy Issue Report `array('Option <comment>u...> option instead.', '')` is of type `array<integer,string,{"0":"string","1":"string"}>`, but the function expects a `string\|object<Symfony\Co...onsole\Output\iterable>`. 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...
166			'Option <comment>user_entity</comment> is deprecated since sonata-project/admin-bundle 3.69 and will be removed in version 4.0.'
167			.' Use <comment>user_model</comment> option instead.',
168			'',
169			]);
170
171			@trigger_error(
			0 ignored issues – show Security Best Practice introduced 2020-06-10 17:59 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...
172			'Option "user_entity" is deprecated since sonata-project/admin-bundle 3.69 and will be removed in version 4.0.'
173			.' Use "user_model" option instead.',
174			E_USER_DEPRECATED
175			);
176
177			if (null === $input->getOption('user_model')) {
178			$input->setOption('user_model', $input->getOption('user_entity'));
179			}
180			}
181			}
182
183			protected function getUserModelClass(InputInterface $input, OutputInterface $output): string
184			{
185			return $this->getUserEntityClass($input, $output);
			0 ignored issues – show Deprecated Code introduced 2020-06-14 09:35 UTC by Report Bug Copy Issue Report The method `Sonata\AdminBundle\Comma...d::getUserEntityClass()` has been deprecated with message: since sonata-project/admin-bundle 3.69. Use `getUserModelClass()` instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
186			}
187
188			/**
189			* NEXT_MAJOR: Remove this method and move its body to `getUserModelClass()`.
190			*
191			* @deprecated since sonata-project/admin-bundle 3.69. Use `getUserModelClass()` instead.
192			*
193			* @return string
194			*/
195			protected function getUserEntityClass(InputInterface $input, OutputInterface $output)
196			{
197			if (self::class !== static::class) {
198			@trigger_error(sprintf(
			0 ignored issues – show Security Best Practice introduced 2020-06-10 17:59 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...
199			'Method %s() is deprecated since sonata-project/admin-bundle 3.69 and will be removed in version 4.0.'
200			.' Use %s::getUserModelClass() instead.',
201			__METHOD__,
202			__CLASS__
203			), E_USER_DEPRECATED);
204			}
205
206			if ('' === $this->userEntityClass) {
207			if ($input->getOption('user_model')) {
208			[$userBundle, $userModel] = Validators::validateEntityName($input->getOption('user_model'));
			0 ignored issues – show Bug introduced 2020-04-28 15:46 UTC by Report Bug Copy Issue Report The variable `$userBundle` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2020-06-15 08:23 UTC by Report Bug Copy Issue Report The variable `$userModel` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
209			} else {
210			[$userBundle, $userModel] = $this->askAndValidate(
211			$input,
212			$output,
213			'Please enter the User Entity shortcut name: ',
214			'',
215			'Sonata\AdminBundle\Command\Validators::validateEntityName'
216			);
217			}
218
219			// Entity exists?
220			if ($this->registry instanceof RegistryInterface) {
221			$namespace = $this->registry->getEntityNamespace($userBundle);
222			} else {
223			$namespace = $this->registry->getAliasNamespace($userBundle);
224			}
225
226			$this->userEntityClass = sprintf('%s\%s', $namespace, $userModel);
227			}
228
229			return $this->userEntityClass;
230			}
231			}
232

sonata-project / SonataAdminBundle

Pull Request — master (#6093)

GenerateObjectAclCommand::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like