DeadEntitiesCommand::with() - Code Metrics - Inspection of "Fist steps to close DDC-2134" - doctrine/orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5964)

by Marco

created 2016-08-04 19:10 UTC

DeadEntitiesCommand::with() A

↳ Parent: DeadEntitiesCommand

Complexity

Conditions	4
Paths	3

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
dl	0
loc	10
rs	9.2
c	2
b	0
f	0
cc	4
eloc	7
nc	3
nop	1

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\ORM\Tools\Console\Command;

use Doctrine\ORM\Mapping\MappingException;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Command\Command;
use Doctrine\ORM\Query\QueryException;

/**
 * Show information about dead entities.
 *
 * Dead entities appear in a database where data has been inserted improperly.
 * For example someone can disable referential integrity checks, delete the
 * parent row in a parent-child relationship, and then enable referential
 * integrity checks.
 *
 * Even worse we could face the nightmare of having to work with a database
 * designed before referential integrity, and data modeling, was conceived by
 * the humar race. And yes, there a countries where this still happens!
 *
 * @link    www.doctrine-project.org
 * @since   2.6
 * @author  Marco Buschini <[email protected]>
 */
class DeadEntitiesCommand extends Command
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName('orm:deadentities')
            ->setDescription('Checks for dead entities in the DB')
            ->setHelp(<<<EOT
The <info>%command.name%</info> shows entities that have a reference to a
missing entity, such as children with a parent that has been deleted.
EOT
        );
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        /* @var $entityManager \Doctrine\ORM\EntityManager */
        $entityManager = $this->getHelper('em')->getEntityManager();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $schema = $entityManager->getConnection()->getSchemaManager();

        $classNames = $entityManager->getConfiguration()->getMetadataDriverImpl()->getAllClassNames();

        if (!$classNames) {
            throw new \Exception(
                'You do not have any mapped Doctrine ORM entities according to the current configuration. '.
                'If you have entities or mapping files you should check your mapping configuration for errors.'
            );
        }

        $output->writeln(sprintf("Found <info>%d</info> mapped entities:", count($classNames)));

        $tableNames = array();
        foreach($classNames as $className) {
            $tableNames[$entityManager->getClassMetadata($className)->getTableName()] = $className;
        }
        $failure = false;
        $entity = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        foreach ($classNames as $className) {
            try {
                $tableName = array_search($className, $tableNames);
                $keys = $schema->listTableForeignKeys($tableName);
                $output->writeln('<info>'.$className.'('.$tableName.')'.'</info> '.count($keys).' foreign key(s)');
                $assoc = $entityManager->getClassMetadata($className)->getAssociationMappings();
                foreach($assoc as $a) {
                    if(array_key_exists('sourceToTargetKeyColumns', $a)) {
                        $output->writeln('-> Entity: '.$a['targetEntity'].'('.array_search($a['targetEntity'], $tableNames).')');
                        $sourceFields = array();
                        $sourceColumns = array();
                        foreach ($a['joinColumnFieldNames'] as $column => $field) {
                            $output->writeln("\tField: $field($column)");
                            $sourceFields[] = $field;
                            $sourceColumns[] = $column;
                        }
                        $targetFields = array();
                        $targetColumns = array();
                        foreach($a['sourceToTargetKeyColumns'] as $fcolumn => $ffield) {
                            $output->writeln("\t\tForeign key: $ffield($fcolumn)");
                            $targetFields[] = $ffield;
                            $targetColumns[] = $fcolumn;
                        }
                        $missing = $this->findMissingEntities($a, $output);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                    }
                }
            } catch (MappingException $e) {
                $output->writeln("<error>[FAIL]</error> ".$className);
                $output->writeln(sprintf("<comment>%s</comment>", $e->getMessage()));
                $output->writeln('');

                $failure = true;
            }
        }
        return $failure ? 1 : 0;
    }

    private function findMissingEntities($entity, $output) {
        $dql = "SELECT _inner, _outer\n"
              ."  FROM ".$entity['sourceEntity']." _inner\n"
              ."  LEFT JOIN ".$entity['targetEntity']." _outer"
              .$this->with($entity)
              .$this->where($entity);
        
        $entityManager = $this->getHelper('em')->getEntityManager();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        try {
            $query = $entityManager->createQuery($dql);
            $ret = $query->getResult();
        } catch(QueryException $e) {
            $output->writeln("<error>Data model too complex to analyze.</error>");
            return;
        }

        foreach($ret as $key) {
            if($key == null) {
                continue;
            }
            $output->writeln("\t".$entity['targetEntity'].' id with missing reference '.$key->getId());
        }
    }
    
    private function with($entity) {
        if(count($entity['joinColumns']) == 1 || true) {
            return "\n  WITH _inner.".$entity['fieldName']." = _outer";
        }
        $ret = "\n  WITH ";
        foreach($entity['joinColumns'] as $column) {
            $ret .= "_inner.".$column['name']." = _outer.".$column['referencedColumnName']."\n   AND ";
        }
        return substr($ret, 0, strlen($ret) - 6);
    }
    
    private function where($entity) {
        if(count($entity['joinColumns']) != 0) {
            $ret = "\n WHERE ";
            foreach($entity['joinColumns'] as $column) {
                $ret .= "_outer.".$column['referencedColumnName']." IS NULL\n   AND ";
            }
            return substr($ret, 0, strlen($ret) - 6);
        } else {
            return "\n WHERE _outer IS NULL";
        }
    }
}


1			<?php
2			/*
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*
15			* This software consists of voluntary contributions made by many individuals
16			* and is licensed under the MIT license. For more information, see
17			* <http://www.doctrine-project.org>.
18			*/
19
20			namespace Doctrine\ORM\Tools\Console\Command;
21
22			use Doctrine\ORM\Mapping\MappingException;
23			use Symfony\Component\Console\Input\InputInterface;
24			use Symfony\Component\Console\Output\OutputInterface;
25			use Symfony\Component\Console\Command\Command;
26			use Doctrine\ORM\Query\QueryException;
27
28			/**
29			* Show information about dead entities.
30			*
31			* Dead entities appear in a database where data has been inserted improperly.
32			* For example someone can disable referential integrity checks, delete the
33			* parent row in a parent-child relationship, and then enable referential
34			* integrity checks.
35			*
36			* Even worse we could face the nightmare of having to work with a database
37			* designed before referential integrity, and data modeling, was conceived by
38			* the humar race. And yes, there a countries where this still happens!
39			*
40			* @link www.doctrine-project.org
41			* @since 2.6
42			* @author Marco Buschini <[email protected]>
43			*/
44			class DeadEntitiesCommand extends Command
45			{
46			/**
47			* {@inheritdoc}
48			*/
49			protected function configure()
50			{
51			$this
52			->setName('orm:deadentities')
53			->setDescription('Checks for dead entities in the DB')
54			->setHelp(<<<EOT
55			The <info>%command.name%</info> shows entities that have a reference to a
56			missing entity, such as children with a parent that has been deleted.
57			EOT
58			);
59			}
60
61			/**
62			* {@inheritdoc}
63			*/
64			protected function execute(InputInterface $input, OutputInterface $output)
65			{
66			/* @var $entityManager \Doctrine\ORM\EntityManager */
67			$entityManager = $this->getHelper('em')->getEntityManager();
			0 ignored issues – show Bug introduced 2016-08-04 20:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `getEntityManager()` does only exist in the following implementations of said interface: `Doctrine\ORM\Tools\Conso...per\EntityManagerHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
68			$schema = $entityManager->getConnection()->getSchemaManager();
69
70			$classNames = $entityManager->getConfiguration()->getMetadataDriverImpl()->getAllClassNames();
71
72			if (!$classNames) {
73			throw new \Exception(
74			'You do not have any mapped Doctrine ORM entities according to the current configuration. '.
75			'If you have entities or mapping files you should check your mapping configuration for errors.'
76			);
77			}
78
79			$output->writeln(sprintf("Found <info>%d</info> mapped entities:", count($classNames)));
80
81			$tableNames = array();
82			foreach($classNames as $className) {
83			$tableNames[$entityManager->getClassMetadata($className)->getTableName()] = $className;
84			}
85			$failure = false;
86			$entity = array();
			0 ignored issues – show Unused Code introduced 2016-08-04 20:15 UTC by Report Bug Copy Issue Report `$entity` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
87			foreach ($classNames as $className) {
88			try {
89			$tableName = array_search($className, $tableNames);
90			$keys = $schema->listTableForeignKeys($tableName);
91			$output->writeln('<info>'.$className.'('.$tableName.')'.'</info> '.count($keys).' foreign key(s)');
92			$assoc = $entityManager->getClassMetadata($className)->getAssociationMappings();
93			foreach($assoc as $a) {
94			if(array_key_exists('sourceToTargetKeyColumns', $a)) {
95			$output->writeln('-> Entity: '.$a['targetEntity'].'('.array_search($a['targetEntity'], $tableNames).')');
96			$sourceFields = array();
97			$sourceColumns = array();
98			foreach ($a['joinColumnFieldNames'] as $column => $field) {
99			$output->writeln("\tField: $field($column)");
100			$sourceFields[] = $field;
101			$sourceColumns[] = $column;
102			}
103			$targetFields = array();
104			$targetColumns = array();
105			foreach($a['sourceToTargetKeyColumns'] as $fcolumn => $ffield) {
106			$output->writeln("\t\tForeign key: $ffield($fcolumn)");
107			$targetFields[] = $ffield;
108			$targetColumns[] = $fcolumn;
109			}
110			$missing = $this->findMissingEntities($a, $output);
			0 ignored issues – show Bug introduced 2016-08-04 20:15 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$missing` is correct as `$this->findMissingEntities($a, $output)` (which targets `Doctrine\ORM\Tools\Conso...::findMissingEntities()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history... Unused Code introduced 2016-08-04 20:15 UTC by Report Bug Copy Issue Report `$missing` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
111			}
112			}
113			} catch (MappingException $e) {
114			$output->writeln("<error>[FAIL]</error> ".$className);
115			$output->writeln(sprintf("<comment>%s</comment>", $e->getMessage()));
116			$output->writeln('');
117
118			$failure = true;
119			}
120			}
121			return $failure ? 1 : 0;
122			}
123
124			private function findMissingEntities($entity, $output) {
125			$dql = "SELECT _inner, _outer\n"
126			." FROM ".$entity['sourceEntity']." _inner\n"
127			." LEFT JOIN ".$entity['targetEntity']." _outer"
128			.$this->with($entity)
129			.$this->where($entity);
130
131			$entityManager = $this->getHelper('em')->getEntityManager();
			0 ignored issues – show Bug introduced 2016-08-04 20:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `getEntityManager()` does only exist in the following implementations of said interface: `Doctrine\ORM\Tools\Conso...per\EntityManagerHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
132			try {
133			$query = $entityManager->createQuery($dql);
134			$ret = $query->getResult();
135			} catch(QueryException $e) {
136			$output->writeln("<error>Data model too complex to analyze.</error>");
137			return;
138			}
139
140			foreach($ret as $key) {
141			if($key == null) {
142			continue;
143			}
144			$output->writeln("\t".$entity['targetEntity'].' id with missing reference '.$key->getId());
145			}
146			}
147
148			private function with($entity) {
149			if(count($entity['joinColumns']) == 1 \|\| true) {
150			return "\n WITH _inner.".$entity['fieldName']." = _outer";
151			}
152			$ret = "\n WITH ";
153			foreach($entity['joinColumns'] as $column) {
154			$ret .= "_inner.".$column['name']." = _outer.".$column['referencedColumnName']."\n AND ";
155			}
156			return substr($ret, 0, strlen($ret) - 6);
157			}
158
159			private function where($entity) {
160			if(count($entity['joinColumns']) != 0) {
161			$ret = "\n WHERE ";
162			foreach($entity['joinColumns'] as $column) {
163			$ret .= "_outer.".$column['referencedColumnName']." IS NULL\n AND ";
164			}
165			return substr($ret, 0, strlen($ret) - 6);
166			} else {
167			return "\n WHERE _outer IS NULL";
168			}
169			}
170			}
171

doctrine / orm

Pull Request — master (#5964)

DeadEntitiesCommand::with() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like