RecoveryService.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\FrontendLogin\Service;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ServerRequestInterface;
use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;
use ‪TYPO3\CMS\Core\Mail\FluidEmail;
use ‪TYPO3\CMS\Core\Mail\Mailer;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManager;
use ‪TYPO3\CMS\Extbase\Configuration\Exception\InvalidConfigurationTypeException;
use ‪TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder;
use ‪TYPO3\CMS\Extbase\Utility\LocalizationUtility;
use ‪TYPO3\CMS\FrontendLogin\Configuration\RecoveryConfiguration;
use ‪TYPO3\CMS\FrontendLogin\Domain\Repository\FrontendUserRepository;
use ‪TYPO3\CMS\FrontendLogin\Event\SendRecoveryEmailEvent;
 
class ‪RecoveryService implements ‪RecoveryServiceInterface
{
    protected ‪$recoveryConfiguration;
 
    protected ‪$eventDispatcher;
 
    protected ‪$mailer;
 
    protected ‪$settings;
 
    protected ‪$uriBuilder;
 
    protected ‪$userRepository;
 
    public function ‪__construct(
        ‪Mailer ‪$mailer,
        EventDispatcherInterface ‪$eventDispatcher,
        ‪ConfigurationManager $configurationManager,
        ‪RecoveryConfiguration ‪$recoveryConfiguration,
        ‪UriBuilder ‪$uriBuilder,
        ‪FrontendUserRepository ‪$userRepository
    ) {
        $this->mailer = ‪$mailer;
        $this->eventDispatcher = ‪$eventDispatcher;
        $this->settings = $configurationManager->‪getConfiguration(‪ConfigurationManager::CONFIGURATION_TYPE_SETTINGS);
        $this->recoveryConfiguration = ‪$recoveryConfiguration;
        $this->uriBuilder = ‪$uriBuilder;
        $this->userRepository = ‪$userRepository;
    }
 
    public function ‪sendRecoveryEmail(string $emailAddress): void
    {
        $hash = $this->recoveryConfiguration->getForgotHash();
        // @todo: This repository method call should be moved to PasswordRecoveryController, since its
        // @todo: unexpected that it happens here. Would also drop the dependency to FrontendUserRepository
        // @todo: in this sendRecoveryEmail() method and the class.
        $this->userRepository->updateForgotHashForUserByEmail($emailAddress, GeneralUtility::hmac($hash));
        $userInformation = $this->userRepository->fetchUserInformationByEmail($emailAddress);
        $receiver = new Address($emailAddress, $this->‪getReceiverName($userInformation));
        $email = $this->‪prepareMail($receiver, $hash);
 
        $event = new ‪SendRecoveryEmailEvent($email, $userInformation);
        $this->eventDispatcher->dispatch($event);
        $this->mailer->send($event->getEmail());
    }
 
    protected function ‪getReceiverName(array $userInformation): string
    {
        $displayName = trim(
            sprintf(
                '%s%s%s',
                $userInformation['first_name'],
                $userInformation['middle_name'] ? " {$userInformation['middle_name']}" : '',
                $userInformation['last_name'] ? " {$userInformation['last_name']}" : ''
            )
        );
 
        return $displayName ? $displayName . ' (' . $userInformation['username'] . ')' : $userInformation['username'];
    }
 
    protected function ‪prepareMail(Address $receiver, string $hash): Email
    {
        $url = $this->uriBuilder
            ->reset()
            ->setCreateAbsoluteUri(true)
            ->uriFor(
                'showChangePassword',
                ['hash' => $hash],
                'PasswordRecovery',
                'felogin',
                'Login'
            );
 
        $variables = [
            'receiverName' => $receiver->getName(),
            'url' => $url,
            'validUntil' => date($this->settings['dateFormat'], $this->recoveryConfiguration->getLifeTimeTimestamp()),
        ];
 
        $mailTemplatePaths = $this->recoveryConfiguration->getMailTemplatePaths();
 
        $mail = GeneralUtility::makeInstance(FluidEmail::class, $mailTemplatePaths);
        $mail->subject($this->‪getEmailSubject())
            ->from($this->recoveryConfiguration->getSender())
            ->to($receiver)
            ->assignMultiple($variables)
            ->setTemplate($this->recoveryConfiguration->getMailTemplateName());
 
        $replyTo = $this->recoveryConfiguration->getReplyTo();
        if ($replyTo) {
            $mail->addReplyTo($replyTo);
        }
 
        if ((‪$GLOBALS['TYPO3_REQUEST'] ?? null) instanceof ServerRequestInterface) {
            $mail->setRequest(‪$GLOBALS['TYPO3_REQUEST']);
        }
 
        return $mail;
    }
 
    protected function ‪getEmailSubject(): string
    {
        return ‪LocalizationUtility::translate('password_recovery_mail_header', 'felogin');
    }
}