ForgotController::reset() - Code Metrics - Inspection of "#146 【パスワード変更】パスワードリセットのタイミングをパスワード再発行のタイミングとする" - EC-CUBE/ec-cube - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — experimental/sf (#3434)

unknown

created 2018-08-02 03:58 UTC

ForgotController::reset() C

↳ Parent: ForgotController

Complexity

Conditions	9
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	23.0805

Importance

Changes

Metric	Value
cc	9
nc	8
nop	2
dl	0
loc	87
rs	6.728
c	0
b	0
f	0
ccs	19
cts	43
cp	0.4419
crap	23.0805

How to fix Long Method

<?php

/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Eccube\Controller;

use Eccube\Event\EccubeEvents;
use Eccube\Event\EventArgs;
use Eccube\Form\Type\Front\ForgotType;
use Eccube\Form\Type\Front\PassowrdResetType;
use Eccube\Repository\CustomerRepository;
use Eccube\Service\MailService;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception as HttpException;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Security\Core\Encoder\EncoderFactoryInterface;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Validator\ValidatorInterface;

class ForgotController extends AbstractController
{
    /**
     * @var ValidatorInterface
     */
    protected $recursiveValidator;

    /**
     * @var MailService
     */
    protected $mailService;

    /**
     * @var CustomerRepository
     */
    protected $customerRepository;

    /**
     * @var EncoderFactoryInterface
     */
    protected $encoderFactory;

    /**
     * ForgotController constructor.
     *
     * @param ValidatorInterface $recursiveValidator
     * @param MailService $mailService
     * @param CustomerRepository $customerRepository
     * @param EncoderFactoryInterface $encoderFactory
     */
    public function __construct(
        ValidatorInterface $recursiveValidator,
        MailService $mailService,
        CustomerRepository $customerRepository,
        EncoderFactoryInterface $encoderFactory
    ) {
        $this->recursiveValidator = $recursiveValidator;
        $this->mailService = $mailService;
        $this->customerRepository = $customerRepository;
        $this->encoderFactory = $encoderFactory;
    }

    /**
     * パスワードリマインダ.
     *
     * @Route("/forgot", name="forgot")
     * @Template("Forgot/index.twig")
     */
    public function index(Request $request)
    {
        if ($this->isGranted('ROLE_USER')) {
            throw new HttpException\NotFoundHttpException();
        }

        $builder = $this->formFactory
            ->createNamedBuilder('', ForgotType::class);

        $event = new EventArgs(
            [
                'builder' => $builder,
            ],
            $request
        );
        $this->eventDispatcher->dispatch(EccubeEvents::FRONT_FORGOT_INDEX_INITIALIZE, $event);

        $form = $builder->getForm();
        $form->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {
            $Customer = $this->customerRepository
                ->getRegularCustomerByEmail($form->get('login_email')->getData());

            if (!is_null($Customer)) {
                // リセットキーの発行・有効期限の設定
                $Customer
                    ->setResetKey($this->customerRepository->getUniqueResetKey())
                    ->setResetExpire(new \DateTime('+'.$this->eccubeConfig['eccube_customer_reset_expire'].' min'));

                // リセットキーを更新
                $this->entityManager->persist($Customer);
                $this->entityManager->flush();

                $event = new EventArgs(
                    [
                        'form' => $form,
                        'Customer' => $Customer,
                    ],
                    $request
                );
                $this->eventDispatcher->dispatch(EccubeEvents::FRONT_FORGOT_INDEX_COMPLETE, $event);

                // 完了URLの生成
                $reset_url = $this->generateUrl('forgot_reset', ['reset_key' => $Customer->getResetKey()], UrlGeneratorInterface::ABSOLUTE_URL);

                // メール送信
                $this->mailService->sendPasswordResetNotificationMail($Customer, $reset_url);

                // ログ出力
                log_info('send reset password mail to:'."{$Customer->getId()} {$Customer->getEmail()} {$request->getClientIp()}");
            } else {
                log_warning(
                    'Un active customer try send reset password email: ',
                    ['Enter email' => $form->get('login_email')->getData()]
                );
            }

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

        return [
            'form' => $form->createView(),
        ];
    }

    /**
     * 再設定URL送信完了画面.
     *
     * @Route("/forgot/complete", name="forgot_complete")
     * @Template("Forgot/complete.twig")
     */
    public function complete(Request $request)

    {
        if ($this->isGranted('ROLE_USER')) {
            throw new HttpException\NotFoundHttpException();
        }

        return [];
    }

    /**
     * パスワード再発行実行画面.
     *
     * @Route("/forgot/reset/{reset_key}", name="forgot_reset")
     * @Template("Forgot/reset.twig")
     */
    public function reset(Request $request, $reset_key)
    {
        if ($this->isGranted('ROLE_USER')) {
            throw new HttpException\NotFoundHttpException();
        }

        $errors = $this->recursiveValidator->validate(
            $reset_key,
            [
                new Assert\NotBlank(),
                new Assert\Regex(
                    [
                        'pattern' => '/^[a-zA-Z0-9]+$/',
                    ]
                ),
            ]
        );

        $builder = $this->formFactory
            ->createNamedBuilder('', PassowrdResetType::class);

        $form = $builder->getForm();
        $form->handleRequest($request);
        $credential_error = null;

        if ('GET' === $request->getMethod()) {
            if (count($errors) > 0) {
                // リセットキーに異常がある場合
                throw new HttpException\AccessDeniedHttpException(trans('forgotcontroller.text.error.authorization'));
            }

            $Customer = $this->customerRepository
                ->getRegularCustomerByResetKey($reset_key);

            if (is_null($Customer)) {
                // リセットキーから会員データが取得できない場合
                throw new HttpException\NotFoundHttpException(trans('forgotcontroller.text.error.url'));
            }
        } elseif ($form->isSubmitted() && $form->isValid()) {
            // リセットキー・入力メールアドレスで会員情報検索
            $Customer = $this->customerRepository
                ->getRegularCustomerByResetKey($reset_key, $form->get('login_email')->getData());
            if (!is_null($Customer)) {
                // パスワードの発行・更新
                $encoder = $this->encoderFactory->getEncoder($Customer);
                $pass = $form->get('password')->getData();
                $Customer->setPassword($pass);

                // 発行したパスワードの暗号化
                if ($Customer->getSalt() === null) {
                    $Customer->setSalt($this->encoderFactory->getEncoder($Customer)->createSalt());
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.
    }
}
                }
                $encPass = $encoder->encodePassword($pass, $Customer->getSalt());

                // パスワードを更新
                $Customer->setPassword($encPass);
                // リセットキーをクリア
                $Customer->setResetKey(null);

                // パスワードを更新
                $this->entityManager->persist($Customer);
                $this->entityManager->flush();

                $event = new EventArgs(
                    [
                        'Customer' => $Customer,
                    ],
                    $request
                );
                $this->eventDispatcher->dispatch(EccubeEvents::FRONT_FORGOT_RESET_COMPLETE, $event);

                // 完了メッセージを設定
                $this->addFlash('password_reset_complete', trans('forgotcontroller.text.complete'));

                // ログインページへリダイレクト
                return $this->redirectToRoute('mypage_login');
            } else {
                // リセットキー・メールアドレスから会員データが取得できない場合
                $credential_error = trans('forgotcontroller.text.error.credentials');
            }
        }

        return [
            'error' => $credential_error,
            'form' => $form->createView(),
        ];
    }
}


1		<?php
2
3		/*
4		* This file is part of EC-CUBE
5		*
6		* Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
7		*
8		* http://www.lockon.co.jp/
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace Eccube\Controller;
15
16		use Eccube\Event\EccubeEvents;
17		use Eccube\Event\EventArgs;
18		use Eccube\Form\Type\Front\ForgotType;
19		use Eccube\Form\Type\Front\PassowrdResetType;
20		use Eccube\Repository\CustomerRepository;
21		use Eccube\Service\MailService;
22		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
23		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
24		use Symfony\Component\HttpFoundation\Request;
25		use Symfony\Component\HttpKernel\Exception as HttpException;
26		use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
27		use Symfony\Component\Security\Core\Encoder\EncoderFactoryInterface;
28		use Symfony\Component\Validator\Constraints as Assert;
29		use Symfony\Component\Validator\Validator\ValidatorInterface;
30
31		class ForgotController extends AbstractController
32		{
33		/**
34		* @var ValidatorInterface
35		*/
36		protected $recursiveValidator;
37
38		/**
39		* @var MailService
40		*/
41		protected $mailService;
42
43		/**
44		* @var CustomerRepository
45		*/
46		protected $customerRepository;
47
48		/**
49		* @var EncoderFactoryInterface
50		*/
51		protected $encoderFactory;
52
53		/**
54		* ForgotController constructor.
55		*
56		* @param ValidatorInterface $recursiveValidator
57		* @param MailService $mailService
58		* @param CustomerRepository $customerRepository
59		* @param EncoderFactoryInterface $encoderFactory
60		*/
61	3	public function __construct(
62		ValidatorInterface $recursiveValidator,
63		MailService $mailService,
64		CustomerRepository $customerRepository,
65		EncoderFactoryInterface $encoderFactory
66		) {
67	3	$this->recursiveValidator = $recursiveValidator;
68	3	$this->mailService = $mailService;
69	3	$this->customerRepository = $customerRepository;
70	3	$this->encoderFactory = $encoderFactory;
71		}
72
73		/**
74		* パスワードリマインダ.
75		*
76		* @Route("/forgot", name="forgot")
77		* @Template("Forgot/index.twig")
78		*/
79	1	public function index(Request $request)
80		{
81	1	if ($this->isGranted('ROLE_USER')) {
82		throw new HttpException\NotFoundHttpException();
83		}
84
85	1	$builder = $this->formFactory
86	1	->createNamedBuilder('', ForgotType::class);
87
88	1	$event = new EventArgs(
89		[
90	1	'builder' => $builder,
91		],
92	1	$request
93		);
94	1	$this->eventDispatcher->dispatch(EccubeEvents::FRONT_FORGOT_INDEX_INITIALIZE, $event);
95
96	1	$form = $builder->getForm();
97	1	$form->handleRequest($request);
98
99	1	if ($form->isSubmitted() && $form->isValid()) {
100		$Customer = $this->customerRepository
101		->getRegularCustomerByEmail($form->get('login_email')->getData());
102
103		if (!is_null($Customer)) {
104		// リセットキーの発行・有効期限の設定
105		$Customer
106		->setResetKey($this->customerRepository->getUniqueResetKey())
107		->setResetExpire(new \DateTime('+'.$this->eccubeConfig['eccube_customer_reset_expire'].' min'));
108
109		// リセットキーを更新
110		$this->entityManager->persist($Customer);
111		$this->entityManager->flush();
112
113		$event = new EventArgs(
114		[
115		'form' => $form,
116		'Customer' => $Customer,
117		],
118		$request
119		);
120		$this->eventDispatcher->dispatch(EccubeEvents::FRONT_FORGOT_INDEX_COMPLETE, $event);
121
122		// 完了URLの生成
123		$reset_url = $this->generateUrl('forgot_reset', ['reset_key' => $Customer->getResetKey()], UrlGeneratorInterface::ABSOLUTE_URL);
124
125		// メール送信
126		$this->mailService->sendPasswordResetNotificationMail($Customer, $reset_url);
127
128		// ログ出力
129		log_info('send reset password mail to:'."{$Customer->getId()} {$Customer->getEmail()} {$request->getClientIp()}");
130		} else {
131		log_warning(
132		'Un active customer try send reset password email: ',
133		['Enter email' => $form->get('login_email')->getData()]
134		);
135		}
136
137		return $this->redirectToRoute('forgot_complete');
138		}
139
140		return [
141	1	'form' => $form->createView(),
142		];
143		}
144
145		/**
146		* 再設定URL送信完了画面.
147		*
148		* @Route("/forgot/complete", name="forgot_complete")
149		* @Template("Forgot/complete.twig")
150		*/
151		public function complete(Request $request)
		0 ignored issues – show Unused Code introduced 2018-07-17 02:08 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
152		{
153		if ($this->isGranted('ROLE_USER')) {
154		throw new HttpException\NotFoundHttpException();
155		}
156
157		return [];
158		}
159
160		/**
161		* パスワード再発行実行画面.
162		*
163		* @Route("/forgot/reset/{reset_key}", name="forgot_reset")
164		* @Template("Forgot/reset.twig")
165		*/
166	2	public function reset(Request $request, $reset_key)
167		{
168	2	if ($this->isGranted('ROLE_USER')) {
169		throw new HttpException\NotFoundHttpException();
170		}
171
172	2	$errors = $this->recursiveValidator->validate(
173	2	$reset_key,
174		[
175	2	new Assert\NotBlank(),
176	2	new Assert\Regex(
177		[
178	2	'pattern' => '/^[a-zA-Z0-9]+$/',
179		]
180		),
181		]
182		);
183
184	2	$builder = $this->formFactory
185	2	->createNamedBuilder('', PassowrdResetType::class);
186
187	2	$form = $builder->getForm();
188	2	$form->handleRequest($request);
189	2	$credential_error = null;
190
191	2	if ('GET' === $request->getMethod()) {
192	2	if (count($errors) > 0) {
193		// リセットキーに異常がある場合
194	1	throw new HttpException\AccessDeniedHttpException(trans('forgotcontroller.text.error.authorization'));
195		}
196
197	1	$Customer = $this->customerRepository
198	1	->getRegularCustomerByResetKey($reset_key);
199
200	1	if (is_null($Customer)) {
201		// リセットキーから会員データが取得できない場合
202	1	throw new HttpException\NotFoundHttpException(trans('forgotcontroller.text.error.url'));
203		}
204		} elseif ($form->isSubmitted() && $form->isValid()) {
205		// リセットキー・入力メールアドレスで会員情報検索
206		$Customer = $this->customerRepository
207		->getRegularCustomerByResetKey($reset_key, $form->get('login_email')->getData());
208		if (!is_null($Customer)) {
209		// パスワードの発行・更新
210		$encoder = $this->encoderFactory->getEncoder($Customer);
211		$pass = $form->get('password')->getData();
212		$Customer->setPassword($pass);
213
214		// 発行したパスワードの暗号化
215		if ($Customer->getSalt() === null) {
216		$Customer->setSalt($this->encoderFactory->getEncoder($Customer)->createSalt());
		0 ignored issues – show Bug introduced 2017-09-25 09:08 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Securi...asswordEncoderInterface` as the method `createSalt()` does only exist in the following implementations of said interface: `Eccube\Security\Core\Encoder\PasswordEncoder`. 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...
217		}
218		$encPass = $encoder->encodePassword($pass, $Customer->getSalt());
219
220		// パスワードを更新
221		$Customer->setPassword($encPass);
222		// リセットキーをクリア
223		$Customer->setResetKey(null);
224
225		// パスワードを更新
226		$this->entityManager->persist($Customer);
227		$this->entityManager->flush();
228
229		$event = new EventArgs(
230		[
231		'Customer' => $Customer,
232		],
233		$request
234		);
235		$this->eventDispatcher->dispatch(EccubeEvents::FRONT_FORGOT_RESET_COMPLETE, $event);
236
237		// 完了メッセージを設定
238		$this->addFlash('password_reset_complete', trans('forgotcontroller.text.complete'));
239
240		// ログインページへリダイレクト
241		return $this->redirectToRoute('mypage_login');
242		} else {
243		// リセットキー・メールアドレスから会員データが取得できない場合
244		$credential_error = trans('forgotcontroller.text.error.credentials');
245		}
246		}
247
248		return [
249		'error' => $credential_error,
250		'form' => $form->createView(),
251		];
252		}
253		}
254

EC-CUBE / ec-cube

Pull Request — experimental/sf (#3434)

ForgotController::reset() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like