Nfg::__construct() - Code Metrics - Inspection of "Merge pull request #748 from PROCERGS/preview-1.18..." - PROCERGS/login-cidadao - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions
Branch — master (116909)

by Guilherme
created 2018-01-16 11:00 UTC
Nfg::__construct() B

↳ Parent: Nfg
Complexity

Conditions	1
Paths	1
Size

Total Lines	32
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	15
nc	1
nop	15
dl	0
loc	32
ccs	0
cts	16
cp	0
crap	2
rs	8.8571
c	0
b	0
f	0
How to fix Many Parameters

<?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 PROCERGS\LoginCidadao\NfgBundle\Service;

use Doctrine\ORM\EntityManager;
use FOS\UserBundle\Model\UserManagerInterface;
use FOS\UserBundle\Event\FilterUserResponseEvent;
use FOS\UserBundle\Event\FormEvent;
use FOS\UserBundle\Event\GetResponseUserEvent;
use FOS\UserBundle\Form\Factory\FormFactory;
use FOS\UserBundle\FOSUserEvents;
use FOS\UserBundle\Security\LoginManagerInterface;
use FOS\UserBundle\Util\CanonicalizerInterface;
use LoginCidadao\CoreBundle\Model\PersonInterface;
use PROCERGS\LoginCidadao\NfgBundle\Entity\NfgProfile;
use PROCERGS\LoginCidadao\CoreBundle\Entity\PersonMeuRS;
use PROCERGS\LoginCidadao\CoreBundle\Helper\MeuRSHelper;
use PROCERGS\LoginCidadao\NfgBundle\Entity\NfgProfileRepository;
use PROCERGS\LoginCidadao\NfgBundle\Event\GetConnectCallbackResponseEvent;
use PROCERGS\LoginCidadao\NfgBundle\Event\GetDisconnectCallbackResponseEvent;
use PROCERGS\LoginCidadao\NfgBundle\Event\GetLoginCallbackResponseEvent;
use PROCERGS\LoginCidadao\NfgBundle\Exception\ConnectionNotFoundException;
use PROCERGS\LoginCidadao\NfgBundle\Exception\CpfInUseException;
use PROCERGS\LoginCidadao\NfgBundle\Exception\CpfMismatchException;
use PROCERGS\LoginCidadao\NfgBundle\Exception\EmailInUseException;
use PROCERGS\LoginCidadao\NfgBundle\Exception\MissingRequiredInformationException;
use PROCERGS\LoginCidadao\NfgBundle\Exception\NfgAccountCollisionException;
use PROCERGS\LoginCidadao\NfgBundle\Exception\NfgServiceUnavailableException;
use PROCERGS\LoginCidadao\NfgBundle\Exception\OverrideResponseException;
use PROCERGS\LoginCidadao\NfgBundle\Helper\UrlHelper;
use PROCERGS\LoginCidadao\NfgBundle\Mailer\MailerInterface;
use PROCERGS\LoginCidadao\NfgBundle\NfgEvents;
use PROCERGS\LoginCidadao\NfgBundle\Traits\CircuitBreakerAwareTrait;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Ramsey\Uuid\Uuid;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Session\SessionInterface;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Component\Security\Core\Exception\AccountStatusException;

class Nfg implements LoggerAwareInterface
{
    use CircuitBreakerAwareTrait {
        reportSuccess as traitReportSuccess;
        reportFailure as traitReportFailure;
    }

    /**
     * Key used to store the NFG AccessID in session
     */
    const ACCESS_ID_SESSION_KEY = 'nfg.access_id';

    /** @var EntityManager */
    private $em;

    /** @var NfgSoapInterface */
    private $nfgSoap;

    /** @var RouterInterface */
    private $router;

    /** @var SessionInterface */
    private $session;

    /** @var LoginManagerInterface */
    private $loginManager;

    /** @var MeuRSHelper */
    private $meuRSHelper;

    /** @var LoggerInterface */
    private $logger;

    /** @var string */
    private $loginEndpoint;

    /** @var string */
    private $authorizationEndpoint;

    /** @var string */
    private $firewallName;

    /** @var UserManagerInterface */
    private $userManager;

    /** @var EventDispatcherInterface */
    private $dispatcher;

    /** @var FormFactory */
    private $formFactory;

    /** @var NfgProfileRepository */
    private $nfgProfileRepository;

    /** @var MailerInterface */
    private $mailer;

    /** @var CanonicalizerInterface */
    private $emailCanonicalizer;

    public function __construct(
        EntityManager $em,
        NfgSoapInterface $client,
        RouterInterface $router,
        SessionInterface $session,
        LoginManagerInterface $loginManager,
        MeuRSHelper $meuRSHelper,
        EventDispatcherInterface $dispatcher,
        UserManagerInterface $userManager,
        FormFactory $formFactory,
        NfgProfileRepository $nfgProfileRepository,
        MailerInterface $mailer,
        CanonicalizerInterface $emailCanonicalizer,
        $firewallName,
        $loginEndpoint,
        $authorizationEndpoint
    ) {
        $this->em = $em;
        $this->nfgSoap = $client;
        $this->router = $router;
        $this->session = $session;
        $this->loginManager = $loginManager;
        $this->meuRSHelper = $meuRSHelper;
        $this->dispatcher = $dispatcher;
        $this->userManager = $userManager;
        $this->formFactory = $formFactory;
        $this->nfgProfileRepository = $nfgProfileRepository;
        $this->mailer = $mailer;
        $this->emailCanonicalizer = $emailCanonicalizer;
        $this->firewallName = $firewallName;
        $this->loginEndpoint = $loginEndpoint;
        $this->authorizationEndpoint = $authorizationEndpoint;
    }

    /**
     * @return string
     * @throws NfgServiceUnavailableException
     */
    private function getAccessId()
    {
        $nfgSoap = $this->nfgSoap;

        return $this->protect(function () use ($nfgSoap) {
            try {
                $accessId = $nfgSoap->getAccessID();

                return $accessId;
            } catch (NfgServiceUnavailableException $e) {
                throw $e;
            } catch (\Exception $e) {
                throw new NfgServiceUnavailableException($e->getMessage(), 500, $e);
            }
        });
    }

    /**
     * @param string $accessToken
     * @param string|null $voterRegistration
     * @param bool $testRequiredInfo
     * @return NfgProfile
     */
    public function getUserInfo($accessToken, $voterRegistration = null, $testRequiredInfo = true)
    {
        $nfgSoap = $this->nfgSoap;

        try {
            $nfgProfile = $this->protect(function () use ($nfgSoap, $accessToken, $voterRegistration) {

                return $this->nfgSoap->getUserInfo($accessToken, $voterRegistration);
            });
        } catch (NfgServiceUnavailableException $e) {
            throw $e;
        } catch (\Exception $e) {
            throw new NfgServiceUnavailableException($e->getMessage(), 500, $e);
        }

        $requiredInfo = [$nfgProfile->getName(), $nfgProfile->getCpf(), $nfgProfile->getEmail()];
        $missingRequiredInfo = array_search(null, $requiredInfo);

        if ($testRequiredInfo && false !== $missingRequiredInfo) {
            throw new MissingRequiredInformationException('Some needed information was not authorized on NFG.');
        }

        return $nfgProfile;
    }

    /**
     * @return JsonResponse
     */
    public function login()
    {
        return $this->redirect($this->loginEndpoint, 'nfg_login_callback');
    }

    public function loginCallback(array $params, $secret)
    {
        $cpf = array_key_exists('cpf', $params) ? $params['cpf'] : null;
        $accessId = array_key_exists('accessId', $params) ? $params['accessId'] : null;
        $prsec = array_key_exists('prsec', $params) ? $params['prsec'] : null;

        if (!$cpf || !$accessId || !$prsec) {
            throw new BadRequestHttpException('Missing CPF, AccessID or PRSEC');
        }

        $signature = hash_hmac('sha256', "$cpf$accessId", $secret);
        if (!$signature || strcmp(strtolower($signature), strtolower($prsec)) !== 0) {
            throw new AccessDeniedHttpException('Invalid PRSEC signature.');
        }

        if ($this->session->get(self::ACCESS_ID_SESSION_KEY) !== $accessId) {
            throw new AccessDeniedHttpException('Invalid AccessID');
        }

        /** @var PersonInterface $user */
        $personMeuRS = $this->meuRSHelper->getPersonByCpf($this->sanitizeCpf($cpf), true);

        if (!$personMeuRS || !$personMeuRS->getPerson() || !$personMeuRS->getNfgAccessToken()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw new ConnectionNotFoundException('No user found matching this CPF');
        }
        $user = $personMeuRS->getPerson();

        return $this->logInUser($user, $params);
    }

    public function connect()
    {
        return $this->redirect($this->authorizationEndpoint, 'nfg_connect_callback');
    }

    /**
     * @param Request $request
     * @param PersonMeuRS $personMeuRS
     * @param bool $overrideExisting
     * @return Response
     */
    public function connectCallback(Request $request, PersonMeuRS $personMeuRS, $overrideExisting = false)
    {
        $response = null;
        $accessToken = $request->get('paccessid');
        if (!$accessToken) {
            throw new BadRequestHttpException("Missing paccessid parameter");
        }

        $nfgProfile = $this->getUserInfo($accessToken, $personMeuRS->getVoterRegistration());

        if (!($personMeuRS->getPerson() instanceof PersonInterface)) {

            try {
                $response = $this->register($request, $personMeuRS, $nfgProfile);
            } catch (OverrideResponseException $e) {
                $event = new GetConnectCallbackResponseEvent(
                    $request, $personMeuRS, $overrideExisting, $e->getResponse()
                );
                $this->dispatcher->dispatch(NfgEvents::CONNECT_CALLBACK_RESPONSE, $event);

                return $event->getResponse();
            }
        }

        $sanitizedCpf = $this->sanitizeCpf($nfgProfile->getCpf());
        if (!$personMeuRS->getPerson()->getCpf()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $personMeuRS->getPerson()->setCpf($sanitizedCpf);
        }

        try {
            $this->checkCpf($personMeuRS, $nfgProfile, $overrideExisting);
        } catch (NfgAccountCollisionException $e) {
            $e->setAccessToken($accessToken);
            throw $e;
        }

        $nfgProfile = $this->syncNfgProfile($nfgProfile);

        $this->em->persist($nfgProfile);
        $personMeuRS->setNfgProfile($nfgProfile);
        $personMeuRS->setNfgAccessToken($accessToken);
        $this->em->flush();

        if (!$response) {
            $response = new RedirectResponse($this->router->generate('fos_user_profile_edit'));
        }

        $event = new GetConnectCallbackResponseEvent($request, $personMeuRS, $overrideExisting, $response);
        $this->dispatcher->dispatch(NfgEvents::CONNECT_CALLBACK_RESPONSE, $event);

        return $event->getResponse();
    }

    /**
     * @param PersonMeuRS $personMeuRS
     * @return Response
     */
    public function disconnect(PersonMeuRS $personMeuRS)
    {
        if ($personMeuRS->getNfgProfile()) {
            $this->em->remove($personMeuRS->getNfgProfile());
            $personMeuRS->setNfgAccessToken(null);
            $personMeuRS->setNfgProfile(null);
            $this->em->flush();
        }

        $response = new RedirectResponse($this->router->generate('fos_user_profile_edit'));
        $event = new GetDisconnectCallbackResponseEvent($personMeuRS, $response);
        $this->dispatcher->dispatch(NfgEvents::DISCONNECT_CALLBACK_RESPONSE, $event);

        return $event->getResponse();
    }

    private function redirect($endpoint, $callbackRoute)
    {
        $accessId = $this->getAccessId();
        $this->session->set(self::ACCESS_ID_SESSION_KEY, $accessId);
        $callbackUrl = $this->router->generate($callbackRoute, [], RouterInterface::ABSOLUTE_URL);

        $url = parse_url($endpoint);
        $url['query'] = UrlHelper::addToQuery(
            [
                'accessid' => $accessId,
                'urlretorno' => $callbackUrl,
            ],
            isset($url['query']) ? $url['query'] : null
        );

        return new JsonResponse(['target' => http_build_url($url)]);
    }

    /**
     * Sets a logger instance on the object.
     *
     * @param LoggerInterface $logger
     *
     * @return void
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    private function sanitizeCpf($cpf)
    {
        return str_pad(preg_replace('/[^0-9]/', '', $cpf), 11, '0', STR_PAD_LEFT);
    }

    /**
     * @param PersonMeuRS $personMeuRS
     * @param NfgProfile $nfgProfile
     * @param bool $overrideExisting
     */
    private function checkCpf(PersonMeuRS $personMeuRS, NfgProfile $nfgProfile, $overrideExisting = false)
    {
        $person = $personMeuRS->getPerson();

        // Check data inconsistency
        if ($person->getCpf() !== $this->sanitizeCpf($nfgProfile->getCpf())) {
            throw new CpfMismatchException("User's CPF doesn't match CPF from NFG.");
        }

        // Check CPF collision
        $otherPerson = $this->meuRSHelper->getPersonByCpf($person->getCpf(), true);
        if (null === $otherPerson || $otherPerson->getId() === $personMeuRS->getId()) {
            // No collision found. We're good! :)
            return;
        }

        if (!$otherPerson->getNfgProfile()) {
            // The other person isn't linked with NFG, so $person can safely get the CPF
            $otherPerson->getPerson()->setCpf(null);
            $this->em->persist($otherPerson->getPerson());
            $this->em->flush($otherPerson->getPerson());

            $this->mailer->notifyCpfLost($otherPerson->getPerson());

            return;
        }

        // Both users are linked to the same NFG account
        // What should we do?
        if (false === $overrideExisting) {
            throw new NfgAccountCollisionException();
        }
        // The user's choice was to remove the previous connection and use this new one
        $otherPerson->getPerson()->setCpf(null);
        $this->em->persist($otherPerson->getPerson());
        $this->em->flush($otherPerson->getPerson());
        $this->disconnect($otherPerson);
        $this->mailer->notifyConnectionTransferred($otherPerson->getPerson());
    }

    /**
     * @param Request $request
     * @param PersonMeuRS $personMeuRS
     * @param NfgProfile $nfgProfile
     * @return null|RedirectResponse|Response
     * @throws OverrideResponseException
     */
    private function register(Request $request, PersonMeuRS $personMeuRS, NfgProfile $nfgProfile)
    {
        $email = $this->emailCanonicalizer->canonicalize($nfgProfile->getEmail());
        if ($this->meuRSHelper->getPersonByEmail($email, true) !== null) {
            throw new EmailInUseException();
        }

        $sanitizedCpf = $this->sanitizeCpf($nfgProfile->getCpf());
        $otherPersonMeuRS = $this->meuRSHelper->getPersonByCpf($sanitizedCpf, true);

        if ($otherPersonMeuRS !== null) {
            if ($otherPersonMeuRS->getNfgProfile()) {
                $otherPersonNfgCpf = $otherPersonMeuRS->getNfgProfile()->getCpf();
            } else {
                $otherPersonNfgCpf = null;
            }
            if ($otherPersonMeuRS->getNfgAccessToken() && $otherPersonNfgCpf == $sanitizedCpf) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $response = $this->logInUser($otherPersonMeuRS->getPerson());
                throw new OverrideResponseException($response);
            }
            $this->handleCpfCollision($otherPersonMeuRS);
        }

        $names = explode(' ', $nfgProfile->getName());

        /** @var PersonInterface $user */
        $user = $this->userManager->createUser();
        $user->setUsername(Uuid::uuid4()->toString());
        $user
            ->setFirstName(array_shift($names))
            ->setSurname(implode(' ', $names))
            ->setEmail($nfgProfile->getEmail())
            ->setCpf($sanitizedCpf)
            ->setBirthdate($nfgProfile->getBirthdate())
            ->setMobile($nfgProfile->getMobile())
            ->setPassword('')
            ->setEnabled(true);

        $event = new GetResponseUserEvent($user, $request);
        $this->dispatcher->dispatch(FOSUserEvents::REGISTRATION_INITIALIZE, $event);

        if (null !== $event->getResponse()) {
            throw new OverrideResponseException($event->getResponse());
        }

        $form = $this->formFactory->createForm();
        $form->setData($user);

        $event = new FormEvent($form, $request);
        $this->dispatcher->dispatch(FOSUserEvents::REGISTRATION_SUCCESS, $event);

        $this->userManager->updateUser($user);

        $nfgProfile = $this->syncNfgProfile($nfgProfile);
        $personMeuRS->setPerson($user);
        $personMeuRS->setNfgProfile($nfgProfile);
        $this->em->persist($personMeuRS);
        $this->em->persist($nfgProfile);
        $this->em->flush();

        if (null === $response = $event->getResponse()) {

            $url = $this->router->generate('fos_user_registration_confirmed');
            $response = new RedirectResponse($url);
        }

        $this->dispatcher->dispatch(
            FOSUserEvents::REGISTRATION_COMPLETED,
            new FilterUserResponseEvent($user, $request, $response)
        );

        return $response;
    }

    /**
     * @param NfgProfile $latestNfgProfile
     * @return NfgProfile
     */
    public function syncNfgProfile(NfgProfile $latestNfgProfile)
    {
        $existingNfgProfile = $this->nfgProfileRepository->findByCpf($latestNfgProfile->getCpf());

        if ($existingNfgProfile instanceof NfgProfile) {
            $existingNfgProfile
                ->setName($latestNfgProfile->getName())
                ->setEmail($latestNfgProfile->getEmail())
                ->setBirthdate($latestNfgProfile->getBirthdate())
                ->setMobile($latestNfgProfile->getMobile())
                ->setAccessLvl($latestNfgProfile->getAccessLvl())
                ->setVoterRegistration($latestNfgProfile->getVoterRegistration())
                ->setVoterRegistrationSit($latestNfgProfile->getVoterRegistrationSit());

            return $existingNfgProfile;
        } else {
            return $latestNfgProfile;
        }
    }

    private function logInUser(PersonInterface $user, array $params = [])
    {
        $response = new RedirectResponse($this->router->generate('lc_home'));

        try {
            $this->loginManager->logInUser($this->firewallName, $user, $response);
        } catch (AccountStatusException $e) {
            // User account is disabled or something like that
            throw $e;
        }

        $event = new GetLoginCallbackResponseEvent($params, $response);
        $this->dispatcher->dispatch(NfgEvents::LOGIN_CALLBACK_RESPONSE, $event);

        return $event->getResponse();
    }

    private function handleCpfCollision(PersonMeuRS $otherPersonMeuRS)
    {
        if (!$otherPersonMeuRS->getNfgAccessToken()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $otherPersonMeuRS->getPerson()->setCpf(null);
            $this->mailer->notifyCpfLost($otherPersonMeuRS->getPerson());
            $this->em->persist($otherPersonMeuRS->getPerson());
            $this->em->flush($otherPersonMeuRS->getPerson());
        } else {
            throw new CpfInUseException();
        }
    }
}

PROCERGS / login-cidadao

Branch — master (116909)

Nfg::__construct() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like
