ResetPasswordCommand::execute() - Code Metrics - Inspection of "[FEATURE] Reset password for backend users" - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 4ec39a...24c59a )

unknown
created 2020-03-06 20:57 UTC
ResetPasswordCommand::execute() A

↳ Parent: ResetPasswordCommand
Complexity

Conditions	4
Paths	4
Size

Total Lines	24
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	4
eloc	19
nc	4
nop	2
dl	0
loc	24
rs	9.6333
c	1
b	0
f	0
<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Backend\Command;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use Psr\Http\Message\ServerRequestInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use TYPO3\CMS\Backend\Authentication\PasswordReset;
use TYPO3\CMS\Core\Context\Context;
use TYPO3\CMS\Core\Core\Environment;
use TYPO3\CMS\Core\Http\NormalizedParams;
use TYPO3\CMS\Core\Http\ServerRequest;
use TYPO3\CMS\Core\Http\Uri;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Triggers the workflow to request a new password for a user.
 */
class ResetPasswordCommand extends Command
{
    /**
     * Configure the command by defining the name, options and arguments
     */
    protected function configure()
    {
        $this
            ->setDescription('Trigger a password reset for a backend user.')
            ->addArgument(
                'backendurl',
                InputArgument::REQUIRED,
                'The URL of the TYPO3 Backend, e.g. https://www.example.com/typo3/'
            )->addArgument(
                'email',
                InputArgument::REQUIRED,
                'The email address of a valid backend user'
            );
    }
    /**
     * Executes the command for sending out an email to reset the password.
     *
     * @inheritDoc
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $io = new SymfonyStyle($input, $output);
        $email = $input->getArgument('email');
        if (!GeneralUtility::validEmail($email)) {
        if (!GeneralUtility::validEmail(/** @scrutinizer ignore-type */ $email)) {
            $io->error('The given email "' . $email . '" is not a valid email address.');
            $io->error('The given email "' . /** @scrutinizer ignore-type */ $email . '" is not a valid email address.');
            return 1;
        }
        $backendUrl = $input->getArgument('backendurl');
        if (!GeneralUtility::isValidUrl($backendUrl)) {
        if (!GeneralUtility::isValidUrl(/** @scrutinizer ignore-type */ $backendUrl)) {
            $io->error('The given backend URL "' . $backendUrl . '" is not a valid URL.');
            $io->error('The given backend URL "' . /** @scrutinizer ignore-type */ $backendUrl . '" is not a valid URL.');
            return 1;
        }
        $reset = GeneralUtility::makeInstance(PasswordReset::class);
        if (!$reset->isEnabled()) {
            $io->error('Password reset functionality is disabled');
            return 1;
        }
        $context = GeneralUtility::makeInstance(Context::class);
        $request = $this->createFakeWebRequest($backendUrl);
        $request = $this->createFakeWebRequest(/** @scrutinizer ignore-type */ $backendUrl);
        $GLOBALS['TYPO3_REQUEST'] = $request;
        $reset->initiateReset($request, $context, $email);
        $io->success('Sent out an email to "' . $email . '" requesting to set a new password.');
        return 0;
    }

    /**
     * This is needed to create a link to the backend properly.
     *
     * @param string $backendUrl
     * @return ServerRequestInterface
     */
    protected function createFakeWebRequest(string $backendUrl): ServerRequestInterface
    {
        $uri = new Uri($backendUrl);
        $request = new ServerRequest(
            $uri,
            'GET',
            'php://input',
            [],
            [
                'HTTP_HOST' => $uri->getHost(),
                'SERVER_NAME' => $uri->getHost(),
                'HTTPS' => $uri->getScheme() === 'https',
                'SCRIPT_FILENAME' => __FILE__,
                'SCRIPT_NAME' => rtrim($uri->getPath(), '/') . '/'
            ]
        );
        $backedUpEnvironment = $this->simulateEnvironmentForBackendEntryPoint();
        $normalizedParams = NormalizedParams::createFromRequest($request);

        // Restore the environment
        Environment::initialize(
            Environment::getContext(),
            Environment::isCli(),
            Environment::isComposerMode(),
            Environment::getProjectPath(),
            Environment::getPublicPath(),
            Environment::getVarPath(),
            Environment::getConfigPath(),
            $backedUpEnvironment['currentScript'],
            Environment::isWindows() ? 'WINDOWS' : 'UNIX'
        );

        return $request->withAttribute('normalizedParams', $normalizedParams);
    }

    /**
     * This is a workaround to use "PublicPath . /typo3/index.php" instead of "publicPath . /typo3/sysext/core/bin/typo3"
     * so the the web root is detected properly in normalizedParams.
     */
    protected function simulateEnvironmentForBackendEntryPoint(): array
    {
        $currentEnvironment = Environment::toArray();
        Environment::initialize(
            Environment::getContext(),
            Environment::isCli(),
            Environment::isComposerMode(),
            Environment::getProjectPath(),
            Environment::getPublicPath(),
            Environment::getVarPath(),
            Environment::getConfigPath(),
            // This is ugly, as this change fakes the directory
            dirname(Environment::getCurrentScript(), 4) . DIRECTORY_SEPARATOR . 'index.php',
            Environment::isWindows() ? 'WINDOWS' : 'UNIX'
        );
        return $currentEnvironment;
    }
}

TYPO3 / TYPO3.CMS

Push — master ( 4ec39a...24c59a )

ResetPasswordCommand::execute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
