GenerateSubjectIdentifiersCommand::getClientMetadata() - Code Metrics - Inspection of "Merge pull request #735 from PROCERGS/preview-1.17..." - PROCERGS/login-cidadao - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c3efa2...a812ec )

by Guilherme

created 2017-11-14 18:48 UTC

getClientMetadata() A

↳ Parent: GenerateSubjectIdentifiersCommand

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	8
nc	2
nop	1
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * This file is part of the login-cidadao project or it's bundles.
 *
 * (c) Guilherme Donato <guilhermednt on github>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace LoginCidadao\OpenIDBundle\Command;

use Doctrine\ORM\EntityManagerInterface;
use LoginCidadao\CoreBundle\Entity\Authorization;
use LoginCidadao\CoreBundle\Entity\AuthorizationRepository;
use LoginCidadao\OAuthBundle\Entity\Client;
use LoginCidadao\OpenIDBundle\Entity\ClientMetadata;
use LoginCidadao\OpenIDBundle\Entity\SubjectIdentifier;
use LoginCidadao\OpenIDBundle\Service\SubjectIdentifierService;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

class GenerateSubjectIdentifiersCommand extends ContainerAwareCommand
{
    /** @var EntityManagerInterface */
    private $em;

    /** @var array */
    private $clientMetadata = [];

    protected function configure()
    {
        $this
            ->setName('lc:oidc:generate-subject-identifiers')
            ->setDescription("Generates and persists Subject Identifiers for Authorizations that don't have it.")
            ->setHelp(
                "This command will persist the Subject Identifiers for all Authorizations that do not have it yet since it's a new feature."
            );
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $io = new SymfonyStyle($input, $output);

        $io->title('Generate Missing Subject Identifiers');

        $this->em = $this->getContainer()->get('doctrine.orm.entity_manager');

        $io->section("Searching Authorizations with missing Subject Identifiers...");

        $repo = $this->getAuthorizationRepository();
        $count = $repo->createQueryBuilder('a')
            ->select('COUNT(a)')
            ->leftJoin(
                'LoginCidadaoOpenIDBundle:SubjectIdentifier',
                's',
                'WITH',
                's.person = a.person AND s.client = a.client'
            )
            ->where('s.subjectIdentifier IS NULL')
            ->getQuery()
            ->getSingleScalarResult();

        if ($count === 0) {
            $io->success("No changes needed. You're all set!");

            return;
        }

        $io->text("{$count} entries found");

        $missingSubId = $repo->createQueryBuilder('a')
            ->leftJoin(
                'LoginCidadaoOpenIDBundle:SubjectIdentifier',
                's',
                'WITH',
                's.person = a.person AND s.client = a.client'
            )
            ->where('s.subjectIdentifier IS NULL')
            ->getQuery()->iterate();

        $io->section("Generating Sector Identifiers...");

        /** @var SubjectIdentifierService $subIdService */
        $subIdService = $this->getContainer()->get('oidc.subject_identifier.service');

        $io->progressStart($count);
        $current = 0;
        foreach ($missingSubId as $row) {
            /** @var Authorization $auth */
            $auth = $row[0];
            $subId = $subIdService->getSubjectIdentifier(
                $auth->getPerson(),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                $this->getClientMetadata($auth->getClient()),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                false
            );
            $sub = new SubjectIdentifier();
            $sub
                ->setPerson($auth->getPerson())
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                ->setClient($auth->getClient())
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                ->setSubjectIdentifier($subId);
            $this->em->persist($sub);
            if ($current++ % 50 === 0) {
                $this->em->flush();
                $this->em->clear();
            }
            $io->progressAdvance();
        }
        $this->em->flush();
        $this->em->clear();
        $io->progressFinish();

        $io->success("Done! {$count} Authorizations updated!");
    }

    /**
     * @return AuthorizationRepository
     */
    private function getAuthorizationRepository()
    {
        /** @var AuthorizationRepository $repo */
        $repo = $this->em->getRepository('LoginCidadaoCoreBundle:Authorization');

        return $repo;
    }

    /**
     * @param Client $client
     * @return ClientMetadata
     */
    private function getClientMetadata(Client $client)
    {
        $id = $client->getId();
        if (array_key_exists($id, $this->clientMetadata)) {
            $metadata = $this->clientMetadata[$id];
        } else {
            $metadata = $client->getMetadata();
            $this->clientMetadata[$id] = $metadata;
        }

        return $metadata;
    }
}


1			<?php
2			/**
3			* This file is part of the login-cidadao project or it's bundles.
4			*
5			* (c) Guilherme Donato <guilhermednt on github>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace LoginCidadao\OpenIDBundle\Command;
12
13			use Doctrine\ORM\EntityManagerInterface;
14			use LoginCidadao\CoreBundle\Entity\Authorization;
15			use LoginCidadao\CoreBundle\Entity\AuthorizationRepository;
16			use LoginCidadao\OAuthBundle\Entity\Client;
17			use LoginCidadao\OpenIDBundle\Entity\ClientMetadata;
18			use LoginCidadao\OpenIDBundle\Entity\SubjectIdentifier;
19			use LoginCidadao\OpenIDBundle\Service\SubjectIdentifierService;
20			use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
21			use Symfony\Component\Console\Input\InputInterface;
22			use Symfony\Component\Console\Output\OutputInterface;
23			use Symfony\Component\Console\Style\SymfonyStyle;
24
25			class GenerateSubjectIdentifiersCommand extends ContainerAwareCommand
26			{
27			/** @var EntityManagerInterface */
28			private $em;
29
30			/** @var array */
31			private $clientMetadata = [];
32
33			protected function configure()
34			{
35			$this
36			->setName('lc:oidc:generate-subject-identifiers')
37			->setDescription("Generates and persists Subject Identifiers for Authorizations that don't have it.")
38			->setHelp(
39			"This command will persist the Subject Identifiers for all Authorizations that do not have it yet since it's a new feature."
40			);
41			}
42
43			protected function execute(InputInterface $input, OutputInterface $output)
44			{
45			$io = new SymfonyStyle($input, $output);
46
47			$io->title('Generate Missing Subject Identifiers');
48
49			$this->em = $this->getContainer()->get('doctrine.orm.entity_manager');
50
51			$io->section("Searching Authorizations with missing Subject Identifiers...");
52
53			$repo = $this->getAuthorizationRepository();
54			$count = $repo->createQueryBuilder('a')
55			->select('COUNT(a)')
56			->leftJoin(
57			'LoginCidadaoOpenIDBundle:SubjectIdentifier',
58			's',
59			'WITH',
60			's.person = a.person AND s.client = a.client'
61			)
62			->where('s.subjectIdentifier IS NULL')
63			->getQuery()
64			->getSingleScalarResult();
65
66			if ($count === 0) {
67			$io->success("No changes needed. You're all set!");
68
69			return;
70			}
71
72			$io->text("{$count} entries found");
73
74			$missingSubId = $repo->createQueryBuilder('a')
75			->leftJoin(
76			'LoginCidadaoOpenIDBundle:SubjectIdentifier',
77			's',
78			'WITH',
79			's.person = a.person AND s.client = a.client'
80			)
81			->where('s.subjectIdentifier IS NULL')
82			->getQuery()->iterate();
83
84			$io->section("Generating Sector Identifiers...");
85
86			/** @var SubjectIdentifierService $subIdService */
87			$subIdService = $this->getContainer()->get('oidc.subject_identifier.service');
88
89			$io->progressStart($count);
90			$current = 0;
91			foreach ($missingSubId as $row) {
92			/** @var Authorization $auth */
93			$auth = $row[0];
94			$subId = $subIdService->getSubjectIdentifier(
95			$auth->getPerson(),
			0 ignored issues – show Bug introduced 2017-11-08 13:11 UTC by Report Bug Copy Issue Report It seems like `$auth->getPerson()` can be `null`; however, `getSubjectIdentifier()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
96			$this->getClientMetadata($auth->getClient()),
			0 ignored issues – show Bug introduced 2017-11-08 13:11 UTC by Report Bug Copy Issue Report It seems like `$auth->getClient()` can be `null`; however, `getClientMetadata()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
97			false
98			);
99			$sub = new SubjectIdentifier();
100			$sub
101			->setPerson($auth->getPerson())
			0 ignored issues – show Bug introduced 2017-11-08 13:11 UTC by Report Bug Copy Issue Report It seems like `$auth->getPerson()` can be `null`; however, `setPerson()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
102			->setClient($auth->getClient())
			0 ignored issues – show Bug introduced 2017-11-08 13:11 UTC by Report Bug Copy Issue Report It seems like `$auth->getClient()` can be `null`; however, `setClient()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
103			->setSubjectIdentifier($subId);
104			$this->em->persist($sub);
105			if ($current++ % 50 === 0) {
106			$this->em->flush();
107			$this->em->clear();
108			}
109			$io->progressAdvance();
110			}
111			$this->em->flush();
112			$this->em->clear();
113			$io->progressFinish();
114
115			$io->success("Done! {$count} Authorizations updated!");
116			}
117
118			/**
119			* @return AuthorizationRepository
120			*/
121			private function getAuthorizationRepository()
122			{
123			/** @var AuthorizationRepository $repo */
124			$repo = $this->em->getRepository('LoginCidadaoCoreBundle:Authorization');
125
126			return $repo;
127			}
128
129			/**
130			* @param Client $client
131			* @return ClientMetadata
132			*/
133			private function getClientMetadata(Client $client)
134			{
135			$id = $client->getId();
136			if (array_key_exists($id, $this->clientMetadata)) {
137			$metadata = $this->clientMetadata[$id];
138			} else {
139			$metadata = $client->getMetadata();
140			$this->clientMetadata[$id] = $metadata;
141			}
142
143			return $metadata;
144			}
145			}
146

PROCERGS / login-cidadao

Push — master ( c3efa2...a812ec )

getClientMetadata() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like