LoginController::getTranslatedErrorMessageFromAuthenticationException() - Code Metrics - sumocoders/FrameworkMultiUserBundle - Measure and Improve Code Quality continuously with Scrutinizer

getTranslatedErrorMessageFromAuthenticationException() A
last analyzed 2018-11-26 16:44 UTC

↳ Parent: LoginController

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.3554
c	0
b	0
f	0
cc	5
nc	5
nop	1

<?php

namespace SumoCoders\FrameworkMultiUserBundle\Controller;

use SumoCoders\FrameworkMultiUserBundle\Security\FormAuthenticator;
use SumoCoders\FrameworkMultiUserBundle\User\Interfaces\User;
use Symfony\Bundle\FrameworkBundle\Translation\Translator;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\Exception\BadCredentialsException;
use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
use Symfony\Component\Templating\EngineInterface;
use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;

final class LoginController
{
    /** @var EngineInterface */
    private $templating;

    /** @var AuthenticationUtils */
    private $authenticationUtils;

    /** @var FormAuthenticator */
    private $formAuthenticator;

    /** @var TokenStorage */
    private $tokenStorage;

    /** @var Translator */
    private $translator;

    public function __construct(
        EngineInterface $templating,
        AuthenticationUtils $authenticationUtils,
        FormAuthenticator $formAuthenticator,
        TokenStorage $tokenStorage,
        Translator $translator
    ) {
        $this->templating = $templating;
        $this->authenticationUtils = $authenticationUtils;
        $this->formAuthenticator = $formAuthenticator;
        $this->tokenStorage = $tokenStorage;
        $this->translator = $translator;
    }

    public function loginAction(): Response
    {
        if ($this->tokenStorage->getToken()->getUser() instanceof User) {
            return new RedirectResponse(
                $this->formAuthenticator->getSuccessRedirectUrl($this->tokenStorage->getToken())
/** @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);
    }
}
            );
        }

        $exception = $this->authenticationUtils->getLastAuthenticationError();

        return $this->templating->renderResponse(
            'SumoCodersFrameworkMultiUserBundle:Login:login.html.twig',
            [
                'error' => $this->getTranslatedErrorMessageFromAuthenticationException($exception),
            ]
        );
    }

    private function getTranslatedErrorMessageFromAuthenticationException(
        ?AuthenticationException $exception = null
    ): ?string {
        if ($exception === null) {
            return null;
        }

        switch (true) {
            case $exception instanceof UsernameNotFoundException:
                return $this->translateValidatorMessage('sumocoders.multiuserbundle.login.username_not_found');
            case $exception instanceof BadCredentialsException:
                return $this->translateValidatorMessage('sumocoders.multiuserbundle.login.bad_credentials');
            case $exception instanceof UnsupportedUserException:
                return $this->translateValidatorMessage('sumocoders.multiuserbundle.login.unsupported_user');
            default:
                return $this->translateValidatorMessage('sumocoders.multiuserbundle.something_went_wrong');
        }
    }

    private function translateValidatorMessage(string $messageString): string
    {
        return $this->translator->trans(
            $messageString,
            [],
            'validators'
        );
    }
}


1			<?php
2
3			namespace SumoCoders\FrameworkMultiUserBundle\Controller;
4
5			use SumoCoders\FrameworkMultiUserBundle\Security\FormAuthenticator;
6			use SumoCoders\FrameworkMultiUserBundle\User\Interfaces\User;
7			use Symfony\Bundle\FrameworkBundle\Translation\Translator;
8			use Symfony\Component\HttpFoundation\RedirectResponse;
9			use Symfony\Component\HttpFoundation\Response;
10			use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
11			use Symfony\Component\Security\Core\Exception\AuthenticationException;
12			use Symfony\Component\Security\Core\Exception\BadCredentialsException;
13			use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
14			use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
15			use Symfony\Component\Templating\EngineInterface;
16			use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;
17
18			final class LoginController
19			{
20			/** @var EngineInterface */
21			private $templating;
22
23			/** @var AuthenticationUtils */
24			private $authenticationUtils;
25
26			/** @var FormAuthenticator */
27			private $formAuthenticator;
28
29			/** @var TokenStorage */
30			private $tokenStorage;
31
32			/** @var Translator */
33			private $translator;
34
35			public function __construct(
36			EngineInterface $templating,
37			AuthenticationUtils $authenticationUtils,
38			FormAuthenticator $formAuthenticator,
39			TokenStorage $tokenStorage,
40			Translator $translator
41			) {
42			$this->templating = $templating;
43			$this->authenticationUtils = $authenticationUtils;
44			$this->formAuthenticator = $formAuthenticator;
45			$this->tokenStorage = $tokenStorage;
46			$this->translator = $translator;
47			}
48
49			public function loginAction(): Response
50			{
51			if ($this->tokenStorage->getToken()->getUser() instanceof User) {
52			return new RedirectResponse(
53			$this->formAuthenticator->getSuccessRedirectUrl($this->tokenStorage->getToken())
			0 ignored issues – show Bug introduced 2016-06-29 20:22 UTC by Report Bug Copy Issue Report It seems like `$this->tokenStorage->getToken()` can be `null`; however, `getSuccessRedirectUrl()` 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...
54			);
55			}
56
57			$exception = $this->authenticationUtils->getLastAuthenticationError();
58
59			return $this->templating->renderResponse(
60			'SumoCodersFrameworkMultiUserBundle:Login:login.html.twig',
61			[
62			'error' => $this->getTranslatedErrorMessageFromAuthenticationException($exception),
63			]
64			);
65			}
66
67			private function getTranslatedErrorMessageFromAuthenticationException(
68			?AuthenticationException $exception = null
69			): ?string {
70			if ($exception === null) {
71			return null;
72			}
73
74			switch (true) {
75			case $exception instanceof UsernameNotFoundException:
76			return $this->translateValidatorMessage('sumocoders.multiuserbundle.login.username_not_found');
77			case $exception instanceof BadCredentialsException:
78			return $this->translateValidatorMessage('sumocoders.multiuserbundle.login.bad_credentials');
79			case $exception instanceof UnsupportedUserException:
80			return $this->translateValidatorMessage('sumocoders.multiuserbundle.login.unsupported_user');
81			default:
82			return $this->translateValidatorMessage('sumocoders.multiuserbundle.something_went_wrong');
83			}
84			}
85
86			private function translateValidatorMessage(string $messageString): string
87			{
88			return $this->translator->trans(
89			$messageString,
90			[],
91			'validators'
92			);
93			}
94			}
95

sumocoders / FrameworkMultiUserBundle

getTranslatedErrorMessageFromAuthenticationException() A last analyzed 2018-11-26 16:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

getTranslatedErrorMessageFromAuthenticationException() A
last analyzed 2018-11-26 16:44 UTC