GenerateObjectAclCommand::getUserEntityClass() - Code Metrics - Inspection of "WIP: Remove deprecated code" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6210)

by Jordi Sala

created 2020-07-18 15:50 UTC

GenerateObjectAclCommand::getUserEntityClass() A

↳ Parent: Project

Complexity

Conditions	5
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	36
rs	9.0328
c	0
b	0
f	0
cc	5
nc	10
nop	2

<?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';

    /**
     * @var string
     */
    protected $userModelClass = '';

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

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

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

    /**
     * @param RegistryInterface|ManagerRegistry|null $registry
     */
    public function __construct(Pool $pool, array $aclObjectManipulators, $registry = null)
    {
        $this->pool = $pool;
        $this->aclObjectManipulators = $aclObjectManipulators;
        if (null !== $registry && (!$registry instanceof RegistryInterface && !$registry instanceof ManagerRegistry)) {
            if (!$registry instanceof ManagerRegistry) {
                @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.');
}
                    'Passing an object that doesn\'t implement %s as argument 3 to %s() is deprecated since'
                    .' sonata-project/admin-bundle 3.56.',
                    ManagerRegistry::class,
                    __METHOD__
                ), E_USER_DEPRECATED);
            }

            throw new \TypeError(sprintf(

                'Argument 3 passed to %s() must be either an instance of %s or %s, %s given.',
                __METHOD__,
                RegistryInterface::class,
                ManagerRegistry::class,
                \is_object($registry) ? \get_class($registry) : \gettype($registry)
            ));
        }
        $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.')
            ->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);
    }

    protected function getUserModelClass(InputInterface $input, OutputInterface $output): string
    {
        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);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

        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			* @var string
38			*/
39			protected $userModelClass = '';
40
41			/**
42			* @var Pool
43			*/
44			private $pool;
45
46			/**
47			* An array of object ACL manipulators indexed by their service ids.
48			*
49			* @var ObjectAclManipulatorInterface[]
50			*/
51			private $aclObjectManipulators = [];
52
53			/**
54			* @var RegistryInterface\|ManagerRegistry\|null
55			*/
56			private $registry;
57
58			/**
59			* @param RegistryInterface\|ManagerRegistry\|null $registry
60			*/
61			public function __construct(Pool $pool, array $aclObjectManipulators, $registry = null)
62			{
63			$this->pool = $pool;
64			$this->aclObjectManipulators = $aclObjectManipulators;
65			if (null !== $registry && (!$registry instanceof RegistryInterface && !$registry instanceof ManagerRegistry)) {
66			if (!$registry instanceof ManagerRegistry) {
67			@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...
68			'Passing an object that doesn\'t implement %s as argument 3 to %s() is deprecated since'
69			.' sonata-project/admin-bundle 3.56.',
70			ManagerRegistry::class,
71			__METHOD__
72			), E_USER_DEPRECATED);
73			}
74
75			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-06-10 17:59 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Argument 3 pass... : \gettype($registry))`. 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...
76			'Argument 3 passed to %s() must be either an instance of %s or %s, %s given.',
77			__METHOD__,
78			RegistryInterface::class,
79			ManagerRegistry::class,
80			\is_object($registry) ? \get_class($registry) : \gettype($registry)
81			));
82			}
83			$this->registry = $registry;
84
85			parent::__construct();
86			}
87
88			public function configure(): void
89			{
90			$this
91			->setDescription('Install ACL for the objects of the Admin Classes.')
92			->addOption('object_owner', null, InputOption::VALUE_OPTIONAL, 'If set, the task will set the object owner for each admin.')
93			->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.')
94			->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.')
95			;
96			}
97
98			public function execute(InputInterface $input, OutputInterface $output): int
99			{
100			$output->writeln('Welcome to the AdminBundle object ACL generator');
101			$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...
102			'',
103			'This command helps you to generate ACL entities for the objects handled by the AdminBundle.',
104			'',
105			'If the step option is used, you will be asked if you want to generate the object ACL entities for each Admin.',
106			'You must use the shortcut notation like <comment>AcmeDemoBundle:User</comment> if you want to set an object owner.',
107			'',
108			]);
109
110			if (!$this->registry) {
111			throw new ServiceNotFoundException('doctrine', static::class, null, [], sprintf(
112			'The command "%s" has a dependency on a non-existent service "doctrine".',
113			static::$defaultName
114			));
115			}
116
117			if ($input->getOption('user_model')) {
118			try {
119			$this->getUserEntityClass($input, $output);
			0 ignored issues – show Bug introduced 2020-07-18 09:26 UTC by Report Bug Copy Issue Report The method `getUserEntityClass()` does not seem to exist on `object<Sonata\AdminBundl...nerateObjectAclCommand>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
120			} catch (\Exception $e) {
121			$output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
122
123			return 1;
124			}
125			}
126
127			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...
128			$output->writeln('No manipulators are implemented : <info>ignoring</info>');
129
130			return 1;
131			}
132
133			foreach ($this->pool->getAdminServiceIds() as $id) {
134			try {
135			$admin = $this->pool->getInstance($id);
136			} catch (\Exception $e) {
137			$output->writeln('<error>Warning : The admin class cannot be initiated from the command line</error>');
138			$output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
139
140			continue;
141			}
142
143			if ($input->getOption('step') && !$this->askConfirmation($input, $output, sprintf("<question>Generate ACLs for the object instances handled by \"%s\"?</question>\n", $id), 'no', '?')) {
			0 ignored issues – show Unused Code introduced 2020-07-18 09:26 UTC by Report Bug Copy Issue Report The call to `GenerateObjectAclCommand::askConfirmation()` has too many arguments starting with `'?'`. 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...
144			continue;
145			}
146
147			$securityIdentity = null;
148			if ($input->getOption('step') && $this->askConfirmation($input, $output, "<question>Set an object owner?</question>\n", 'no', '?')) {
			0 ignored issues – show Unused Code introduced 2020-07-18 09:26 UTC by Report Bug Copy Issue Report The call to `GenerateObjectAclCommand::askConfirmation()` has too many arguments starting with `'?'`. 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...
149			$username = $this->askAndValidate($input, $output, 'Please enter the username: ', '', 'Sonata\AdminBundle\Command\Validators::validateUsername');
150
151			$securityIdentity = new UserSecurityIdentity($username, $this->getUserEntityClass($input, $output));
			0 ignored issues – show Bug introduced 2020-07-18 09:26 UTC by Report Bug Copy Issue Report The method `getUserEntityClass()` does not seem to exist on `object<Sonata\AdminBundl...nerateObjectAclCommand>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
152			}
153			if (!$input->getOption('step') && $input->getOption('object_owner')) {
154			$securityIdentity = new UserSecurityIdentity($input->getOption('object_owner'), $this->getUserEntityClass($input, $output));
			0 ignored issues – show Bug introduced 2020-07-18 09:26 UTC by Report Bug Copy Issue Report The method `getUserEntityClass()` does not seem to exist on `object<Sonata\AdminBundl...nerateObjectAclCommand>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
155			}
156
157			$manipulatorId = sprintf('sonata.admin.manipulator.acl.object.%s', $admin->getManagerType());
158			if (!$manipulator = $this->aclObjectManipulators[$manipulatorId] ?? null) {
159			$output->writeln('Admin class is using a manager type that has no manipulator implemented : <info>ignoring</info>');
160
161			continue;
162			}
163			if (!$manipulator instanceof ObjectAclManipulatorInterface) {
164			$output->writeln(sprintf('The interface "ObjectAclManipulatorInterface" is not implemented for %s: <info>ignoring</info>', \get_class($manipulator)));
165
166			continue;
167			}
168
169			\assert($admin instanceof AdminInterface);
170			$manipulator->batchConfigureAcls($output, $admin, $securityIdentity);
171			}
172
173			return 0;
174			}
175
176			protected function initialize(InputInterface $input, OutputInterface $output)
177			{
178			parent::initialize($input, $output);
179			}
180
181			protected function getUserModelClass(InputInterface $input, OutputInterface $output): string
182			{
183			if ('' === $this->userEntityClass) {
184			if ($input->getOption('user_model')) {
185			[$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...
186			} else {
187			[$userBundle, $userModel] = $this->askAndValidate(
188			$input,
189			$output,
190			'Please enter the User Entity shortcut name: ',
191			'',
192			'Sonata\AdminBundle\Command\Validators::validateEntityName'
193			);
194			}
195
196			// Entity exists?
197			if ($this->registry instanceof RegistryInterface) {
198			$namespace = $this->registry->getEntityNamespace($userBundle);
199			} else {
200			$namespace = $this->registry->getAliasNamespace($userBundle);
201			}
202
203			$this->userEntityClass = sprintf('%s\%s', $namespace, $userModel);
			0 ignored issues – show Bug introduced 2020-07-18 09:26 UTC by Report Bug Copy Issue Report The property `userEntityClass` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
204			}
205
206			return $this->userEntityClass;
207			}
208			}
209

sonata-project / SonataAdminBundle

Pull Request — master (#6210)

GenerateObjectAclCommand::getUserEntityClass() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like