StageChangeNotification.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\Workspaces\Notification;
 
use Psr\Http\Message\ServerRequestInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Symfony\Component\Mailer\Exception\TransportException;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Exception\RfcComplianceException;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Mail\FluidEmail;
use ‪TYPO3\CMS\Core\Mail\Mailer;
use ‪TYPO3\CMS\Core\Routing\UnableToLinkToPageException;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Fluid\View\TemplatePaths;
use ‪TYPO3\CMS\Workspaces\Preview\PreviewUriBuilder;
use ‪TYPO3\CMS\Workspaces\Service\StagesService;
 
class ‪StageChangeNotification implements LoggerAwareInterface
{
    use LoggerAwareTrait;
 
    protected ‪$stagesService;
 
    protected ‪$previewUriBuilder;
 
    protected ‪$mailer;
 
    public function ‪__construct()
    {
        $this->stagesService = GeneralUtility::makeInstance(StagesService::class);
        $this->previewUriBuilder = GeneralUtility::makeInstance(PreviewUriBuilder::class);
        $this->mailer = GeneralUtility::makeInstance(Mailer::class);
    }
 
    public function ‪notifyStageChange(array $workspaceRecord, int $stageId, array $affectedElements, string $comment, array $recipients, ‪BackendUserAuthentication $currentUser): void
    {
        [$elementTable, $elementUid] = reset($affectedElements);
        $elementUid = (int)$elementUid;
        $elementRecord = (array)BackendUtility::getRecord($elementTable, $elementUid, '*', '', false);
        $recordTitle = BackendUtility::getRecordTitle($elementTable, $elementRecord);
        $pageUid = $this->‪findFirstPageId($elementTable, $elementUid, $elementRecord);
        $emailConfig = BackendUtility::getPagesTSconfig($pageUid)['tx_workspaces.']['emails.'] ?? [];
        $emailConfig = GeneralUtility::removeDotsFromTS($emailConfig);
 
        $previewLink = '';
        try {
            $languageId = $elementRecord[‪$GLOBALS['TCA'][$elementTable]['ctrl']['languageField'] ?? ''] ?? 0;
            $previewLink = $this->previewUriBuilder->buildUriForPage($pageUid, $languageId);
        } catch (‪UnableToLinkToPageException $e) {
            // Generating a preview for a page that is is a delete placeholder
            // in workspaces fails. No preview link in this case.
        }
 
        $viewPlaceholders = [
            'pageId' => $pageUid,
            'workspace' => $workspaceRecord,
            'rootLine' => BackendUtility::getRecordPath($pageUid, '', 20),
            'currentUser' => $currentUser->user,
            'additionalMessage' => $comment,
            'recordTitle' => $recordTitle,
            'affectedElements' => $affectedElements,
            'nextStage' => $this->stagesService->getStageTitle($stageId),
            'previewLink' => $previewLink,
        ];
 
        $sentEmails = [];
        foreach ($recipients as $recipientData) {
            // don't send an email twice
            if (in_array($recipientData['email'], $sentEmails, true)) {
                continue;
            }
            $sentEmails[] = $recipientData['email'];
            try {
                $this->‪sendEmail($recipientData, $emailConfig, $viewPlaceholders);
            } catch (TransportException $e) {
                $this->logger->warning('Could not send notification email to "{recipient}" due to mailer settings error', [
                    'recipient' => $recipientData['email'],
                    'recipientList' => array_column($recipients, 'email'),
                    'exception' => $e,
                ]);
                // At this point we break since the next attempts will also fail due to the invalid mailer settings
                break;
            } catch (RfcComplianceException $e) {
                $this->logger->warning('Could not send notification email to "{recipient}" due to invalid email address', [
                    'recipient' => $recipientData['email'],
                    'exception' => $e,
                ]);
            }
        }
    }
 
    protected function ‪findFirstPageId(string $elementTable, int $elementUid, array $elementRecord): int
    {
        if ($elementTable === 'pages') {
            return $elementUid;
        }
        $pageId = $elementRecord['pid'];
        BackendUtility::workspaceOL($elementTable, $elementRecord);
        return (int)($elementRecord['pid'] ?? $pageId);
    }
 
    protected function ‪sendEmail(array $recipientData, array $emailConfig, array $variablesForView): void
    {
        $templatePaths = new ‪TemplatePaths(array_replace_recursive(‪$GLOBALS['TYPO3_CONF_VARS']['MAIL'], $emailConfig));
        $emailObject = GeneralUtility::makeInstance(FluidEmail::class, $templatePaths);
        $emailObject
            ->to(new Address($recipientData['email'], $recipientData['realName'] ?? ''))
            // Will be overridden by the template
            ->subject('TYPO3 Workspaces: Stage Change')
            ->setTemplate('StageChangeNotification')
            ->assignMultiple($variablesForView)
            ->assign('language', $recipientData['lang'] ?? 'default');
 
        // Injecting normalized params
        if (‪$GLOBALS['TYPO3_REQUEST'] instanceof ServerRequestInterface) {
            $emailObject->setRequest(‪$GLOBALS['TYPO3_REQUEST']);
        }
        if ($emailConfig['format']) {
            $emailObject->format($emailConfig['format']);
        }
        if (!empty($emailConfig['senderEmail']) && GeneralUtility::validEmail($emailConfig['senderEmail'])) {
            $emailObject->from(new Address($emailConfig['senderEmail'], $emailConfig['senderName'] ?? ''));
        }
        $this->mailer->send($emailObject);
    }
}