126 lines
3.8 KiB
PHP
126 lines
3.8 KiB
PHP
<?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\Core\Mail;
|
|
|
|
use Psr\Log\LoggerInterface;
|
|
use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
|
|
use Symfony\Component\Mailer\SentMessage;
|
|
use Symfony\Component\Mailer\Transport\AbstractTransport;
|
|
use Symfony\Component\Mailer\Transport\TransportInterface;
|
|
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
|
|
use TYPO3\CMS\Core\Security\BlockSerializationTrait;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
|
|
/**
|
|
* Because TYPO3 doesn't offer a terminate signal or hook,
|
|
* and taking in account the risk that extensions do some redirects or even exit,
|
|
* we simply use the destructor of a singleton class which should be pretty much
|
|
* at the end of a request.
|
|
*
|
|
* To have only one memory spool per request seems to be more appropriate anyway.
|
|
*
|
|
* @internal This class is handled internally in TransportFactory
|
|
*/
|
|
class MemorySpool extends AbstractTransport implements DelayedTransportInterface
|
|
{
|
|
use BlockSerializationTrait;
|
|
|
|
/**
|
|
* @var SentMessage[]
|
|
*/
|
|
protected array $queuedMessages = [];
|
|
|
|
/**
|
|
* Maximum number of retries when the real transport has failed.
|
|
*/
|
|
protected int $retries = 3;
|
|
|
|
/**
|
|
* Create a new MemorySpool
|
|
*/
|
|
public function __construct(
|
|
?EventDispatcherInterface $dispatcher = null,
|
|
protected readonly ?LoggerInterface $logger = null
|
|
) {
|
|
parent::__construct($dispatcher, $logger);
|
|
|
|
$this->setMaxPerSecond(0);
|
|
}
|
|
|
|
/**
|
|
* Sends out the messages in the memory
|
|
*/
|
|
public function __destruct()
|
|
{
|
|
// TODO: DI should be used to inject the MailerInterface
|
|
$mailer = GeneralUtility::makeInstance(MailerInterface::class);
|
|
try {
|
|
$this->flushQueue($mailer->getRealTransport());
|
|
} catch (\Throwable $exception) {
|
|
if ($this->logger instanceof LoggerInterface) {
|
|
$this->logger->error('An Exception occurred while flushing email queue: {message}', ['exception' => $exception, 'message' => $exception->getMessage()]);
|
|
}
|
|
}
|
|
}
|
|
|
|
public function flushQueue(TransportInterface $transport): int
|
|
{
|
|
if ($this->queuedMessages === []) {
|
|
return 0;
|
|
}
|
|
|
|
$retries = $this->retries;
|
|
$message = null;
|
|
$count = 0;
|
|
while ($retries--) {
|
|
try {
|
|
while ($message = array_pop($this->queuedMessages)) {
|
|
$transport->send($message->getMessage(), $message->getEnvelope());
|
|
$count++;
|
|
}
|
|
} catch (TransportExceptionInterface $exception) {
|
|
if ($retries) {
|
|
// re-queue the message at the end of the queue to give a chance
|
|
// to the other messages to be sent, in case the failure was due to
|
|
// this message and not just the transport failing
|
|
array_unshift($this->queuedMessages, $message);
|
|
|
|
// wait half a second before we try again
|
|
usleep(500000);
|
|
} else {
|
|
throw $exception;
|
|
}
|
|
}
|
|
}
|
|
return $count;
|
|
}
|
|
|
|
/**
|
|
* Stores a message in the queue.
|
|
*/
|
|
protected function doSend(SentMessage $message): void
|
|
{
|
|
$this->queuedMessages[] = $message;
|
|
}
|
|
|
|
public function __toString(): string
|
|
{
|
|
return 'MemorySpool';
|
|
}
|
|
}
|