AbstractSecurityController::forgotPasswordAction() - Code Metrics - Inspection of "GitHub actions" - smartbooster/authentication-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#23)

by Nicolas
created 2020-11-18 04:37 UTC
AbstractSecurityController::forgotPasswordAction() A

↳ Parent: AbstractSecurityController
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10
<?php

namespace Smart\AuthenticationBundle\Controller;

use Smart\AuthenticationBundle\Email\ForgotPasswordEmail;
use Smart\AuthenticationBundle\Form\Type\Security\ForgotPasswordType;
use Smart\AuthenticationBundle\Security\Form\Type\ResetPasswordType;
use Smart\AuthenticationBundle\Security\Form\Type\UserProfileType;
use Smart\AuthenticationBundle\Security\SmartUserInterface;
use Smart\AuthenticationBundle\Security\Token;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;
use Yokai\SecurityTokenBundle\Exception\TokenConsumedException;
use Yokai\SecurityTokenBundle\Exception\TokenExpiredException;
use Yokai\SecurityTokenBundle\Exception\TokenNotFoundException;
use Yokai\SecurityTokenBundle\Manager\TokenManagerInterface;

/**
 * @author Nicolas Bastien <[email protected]>
 *
 * Fix phpstan error cf. https://github.com/phpstan/phpstan/issues/3200
 *
 * @property ContainerInterface $container
 */
class AbstractSecurityController extends Controller
class AbstractSecurityController extends /** @scrutinizer ignore-deprecated */ Controller
{
    /**
     * Define application context, override this in your controller.
     *
     * @var string
     */
    protected $context;

    /**
     * @var TokenManagerInterface
     */
    protected $tokenManager;

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

    public function __construct(TokenManagerInterface $tokenManager, MailerInterface $mailer)
    {
        $this->tokenManager = $tokenManager;
        $this->mailer = $mailer;
    }

    /**
     * @deprecated
     *
     * @return Response
     */
    public function loginAction()
    {
        return $this->login();
    }

    /**
     * @deprecated
     *
     * @return Response
     */
    public function forgotPasswordAction(Request $request)
    {
        return $this->forgotPassword($request);
    }

    /**
     * @deprecated
     *
     * @return Response
     */
    public function resetPasswordAction(Request $request)
    {
        return $this->resetPassword($request);
    }

    /**
     * @deprecated
     *
     * @return Response
     */
    public function profileAction(Request $request)
    {
        return $this->profile($request);
    }

    /**
     * @return Response
     */
    public function login()
    {
        $helper = $this->getAuthenticationUtils();

        return $this->render($this->context.'/security/login.html.twig', [
            'last_username' => $helper->getLastUsername(),
            'error' => $helper->getLastAuthenticationError(),
            'layout_template' => $this->context.'/empty_layout.html.twig',
            'security_login_check_url' => $this->generateUrl($this->context.'_security_login_check'),
            'security_forgot_password_url' => $this->generateUrl($this->context.'_security_forgot_password'),
        ]);
    }

    /**
     * @return Response
     */
    public function forgotPassword(Request $request)
    {
        $form = $this->createForm(ForgotPasswordType::class);
        $form->handleRequest($request);

        if (!$form->isSubmitted() || !$form->isValid()) {
            return $this->render(
                $this->context.'/security/forgot_password.html.twig',
                [
                    'form' => $form->createView(),
                    'security_login_form_url' => $this->generateUrl($this->context.'_security_login_form'),
                    'security_forgot_password_url' => $this->generateUrl($this->context.'_security_forgot_password'),
                ]
            );
        }

        try {
            $user = $this->get($this->context.'_user_provider')->loadUserByUsername($form->get('email')->getData());

            if ($user instanceof SmartUserInterface) {
                $token = $this->tokenManager->create(Token::RESET_PASSWORD, $user);

                $this->mailer->send($this->getForgotPasswordEmail([
                    'from' => $this->container->getParameter('app.mail_from'),
                    'subject' => $this->translate('security.forgot_password.subject', [], 'email'),
                    'context' => $this->context,
                    'token' => $token->getValue(),
                    'domain' => $this->getDomain(),
                    'security_reset_password_route' => $this->context.'_security_reset_password',
                ], $user->getEmail()));

                $this->addFlash('success', 'flash.forgot_password.success');
            }
        } catch (UsernameNotFoundException $e) {
            $this->addFlash('error', 'flash.forgot_password.unknown');
        }

        return $this->redirectToRoute($this->context.'_security_login_form');
    }

    /**
     * This provide a default email for the forgot password.
     *
     * @param array<mixed> $parameters
     * @param string       $email
     *
     * @return TemplatedEmail
     */
    protected function getForgotPasswordEmail(array $parameters, $email)
    {
        return new ForgotPasswordEmail($parameters, $email);
    }

    /**
     * @return Response
     */
    public function resetPassword(Request $request)
    {
        if ($this->getUser()) {
            return $this->redirectToRoute($this->context.'_dashboard');
        }

        if (!$request->query->has('token')) {
            $this->addFlash('error', 'flash.security.invalid_token');

            return $this->redirectToRoute($this->context.'_security_login_form');
        }

        try {
            $token = $this->tokenManager->get(Token::RESET_PASSWORD, $request->query->get('token'));
        } catch (TokenNotFoundException $e) {
            $this->addFlash('error', 'flash.security.token_not_found');

            return $this->redirectToRoute($this->context.'_security_login_form');
        } catch (TokenExpiredException $e) {
            $this->addFlash('error', 'flash.security.token_expired');

            return $this->redirectToRoute($this->context.'_security_login_form');
        } catch (TokenConsumedException $e) {
            $this->addFlash('error', 'flash.security.token_used');

            return $this->redirectToRoute($this->context.'_security_login_form');
        }

        /** @var SmartUserInterface $user */
        $user = $this->tokenManager->getUser($token);

        $form = $this->createForm(ResetPasswordType::class, $user);
        $form->handleRequest($request);

        if (!$form->isSubmitted() || !$form->isValid()) {
            return $this->render(
                $this->context.'/security/reset_password.html.twig',
                [
                    'token' => $token->getValue(),
                    'form' => $form->createView(),
                    'security_reset_password_route' => $this->context.'_security_reset_password',
                ]
            );
        }

        try {
            if (null !== $user->getPlainPassword()) {

                $this->updateUser($user);
                $this->tokenManager->consume($token);
            }
            $this->addFlash('success', 'flash.reset_password.success');
        } catch (\Exception $e) {
            $this->addFlash('error', 'flash.reset_password.error');
        }

        return $this->redirectToRoute($this->context.'_security_login_form');
    }

    /**
     * @return Response
     */
    public function profile(Request $request)
    {
        /** @var SmartUserInterface $user */
        $user = $this->getUser();

        $form = $this->createForm(UserProfileType::class, $user, []);

        $form->handleRequest($request);

        if (!$form->isSubmitted() || !$form->isValid()) {
            return $this->render($this->context.'/security/profile.html.twig', [
                'base_template' => $this->get('sonata.admin.pool')->getTemplate('layout'),
                'admin_pool' => $this->get('sonata.admin.pool'),
                'form' => $form->createView(),
                'security_profile_url' => $this->generateUrl('admin_security_profile'),
            ]);
        }

        $this->updateUser($user);

        $this->addFlash('success', $this->translate('profile_edit.processed', [], 'security'));

        return $this->redirectToRoute('sonata_admin_dashboard');
    }

    /**
     * @return AuthenticationUtils
     */
    private function getAuthenticationUtils()
    {
        return $this->get('security.authentication_utils');
    }

    /**
     * @param string       $id         The message id (may also be an object that can be cast to string)
     * @param array<array> $parameters An array of parameters for the message
     * @param string|null  $domain     The domain for the message or null to use the default
     *
     * @return string
     */
    protected function translate($id, array $parameters = [], $domain = null)
    {
        return $this->get('translator')->trans($id, $parameters, $domain);
    }

    /**
     * @return void
     */
    protected function updateUser(SmartUserInterface $user)
    {
        if (null !== $user->getPlainPassword()) {

            $encoder = $this->get('security.password_encoder');
            $user->setPassword(
                $encoder->encodePassword($user, $user->getPlainPassword())
            );
        }

        $manager = $this->getDoctrine()->getManager();
        $manager->persist($user);
        $manager->flush();
    }

    /**
     * Override this method if your application use custom domain.
     *
     * @return string
     */
    protected function getDomain()
    {
        return $this->container->getParameter('domain');
    }
}

smartbooster / authentication-bundle

Pull Request — master (#23)

AbstractSecurityController::forgotPasswordAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
