diff --git a/config/parameters.yml.dist b/config/parameters.yml.dist index 92b33bed..3498ef8e 100644 --- a/config/parameters.yml.dist +++ b/config/parameters.yml.dist @@ -31,6 +31,8 @@ parameters: env(APP_DEV_EMAIL): 'dev@dev.com' app.powered_by_phplist: '%%env(APP_POWERED_BY_PHPLIST)%%' env(APP_POWERED_BY_PHPLIST): '0' + app.preference_page_show_private_lists: '%%env(PREFERENCEPAGE_SHOW_PRIVATE_LISTS)%%' + env(PREFERENCEPAGE_SHOW_PRIVATE_LISTS): '0' # Email configuration app.mailer_from: '%%env(MAILER_FROM)%%' @@ -115,6 +117,10 @@ parameters: env(EXTERNALIMAGE_TIMEOUT): '30' messaging.external_image_max_size: '%%env(EXTERNALIMAGE_MAXSIZE)%%' env(EXTERNALIMAGE_MAXSIZE): '204800' + messaging.forward_alternative_content: '%%env(FORWARD_ALTERNATIVE_CONTENT)%%' + env(FORWARD_ALTERNATIVE_CONTENT): '0' + messaging.email_text_credits: '%%env(EMAILTEXTCREDITS)%%' + env(EMAILTEXTCREDITS): '0' phplist.upload_images_dir: '%%env(PHPLIST_UPLOADIMAGES_DIR)%%' env(PHPLIST_UPLOADIMAGES_DIR): 'images' diff --git a/config/services/builders.yml b/config/services/builders.yml index 10a994a4..5254d92b 100644 --- a/config/services/builders.yml +++ b/config/services/builders.yml @@ -23,3 +23,28 @@ services: PhpList\Core\Domain\Messaging\Service\Builder\MessageOptionsBuilder: autowire: true autoconfigure: true + + # Concrete mail constructors + PhpList\Core\Domain\Messaging\Service\Constructor\SystemMailConstructor: ~ + PhpList\Core\Domain\Messaging\Service\Constructor\CampaignMailConstructor: ~ + + # Two EmailBuilder services with different constructors injected + Core.EmailBuilder.system: + class: PhpList\Core\Domain\Messaging\Service\Builder\EmailBuilder + arguments: + $mailConstructor: '@PhpList\Core\Domain\Messaging\Service\Constructor\SystemMailConstructor' + $googleSenderId: '%messaging.google_sender_id%' + $useAmazonSes: '%messaging.use_amazon_ses%' + $usePrecedenceHeader: '%messaging.use_precedence_header%' + $devVersion: '%app.dev_version%' + $devEmail: '%app.dev_email%' + + Core.EmailBuilder.campaign: + class: PhpList\Core\Domain\Messaging\Service\Builder\EmailBuilder + arguments: + $mailConstructor: '@MailConstructor' + $googleSenderId: '%messaging.google_sender_id%' + $useAmazonSes: '%messaging.use_amazon_ses%' + $usePrecedenceHeader: '%messaging.use_precedence_header%' + $devVersion: '%app.dev_version%' + $devEmail: '%app.dev_email%' diff --git a/config/services/messenger.yml b/config/services/messenger.yml index 3c8f27bb..f5b1f3ea 100644 --- a/config/services/messenger.yml +++ b/config/services/messenger.yml @@ -31,6 +31,10 @@ services: PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessorMessageHandler: autowire: true + autoconfigure: true + arguments: + $emailBuilder: '@Core.EmailBuilder.system' + $messageEnvelope: '%app.config.message_from_address%' PhpList\Core\Domain\Subscription\MessageHandler\DynamicTableMessageHandler: autowire: true diff --git a/config/services/parameters.yml b/config/services/parameters.yml index ebf1d99b..18aa6ccf 100644 --- a/config/services/parameters.yml +++ b/config/services/parameters.yml @@ -1,4 +1,9 @@ parameters: + # Flattened parameters for direct DI usage (Symfony does not support dot access into arrays) + app.config.message_from_address: 'news@example.com' + app.config.default_message_age: 15768000 + + # Keep original grouped array for legacy/config-provider usage app.config: message_from_address: 'news@example.com' admin_address: 'admin@example.com' diff --git a/config/services/repositories.yml b/config/services/repositories.yml index ea1f0001..e67a2ed8 100644 --- a/config/services/repositories.yml +++ b/config/services/repositories.yml @@ -22,6 +22,11 @@ services: arguments: - PhpList\Core\Domain\Configuration\Model\EventLog + PhpList\Core\Domain\Configuration\Repository\UrlCacheRepository: + parent: PhpList\Core\Domain\Common\Repository\AbstractRepository + arguments: + - PhpList\Core\Domain\Configuration\Model\UrlCache + PhpList\Core\Domain\Identity\Repository\AdministratorRepository: parent: PhpList\Core\Domain\Common\Repository\AbstractRepository diff --git a/config/services/resolvers.yml b/config/services/resolvers.yml index 99c08356..558f8ba3 100644 --- a/config/services/resolvers.yml +++ b/config/services/resolvers.yml @@ -13,3 +13,7 @@ services: PhpList\Core\Bounce\Service\BounceActionResolver: arguments: - !tagged_iterator { tag: 'phplist.bounce_action_handler' } + + _instanceof: + PhpList\Core\Domain\Configuration\Service\Placeholder\PlaceholderValueResolverInterface: + tags: ['phplist.placeholder_resolver'] diff --git a/config/services/services.yml b/config/services/services.yml index cf298621..721fe117 100644 --- a/config/services/services.yml +++ b/config/services/services.yml @@ -43,6 +43,39 @@ services: autowire: true autoconfigure: true + # Html to Text converter used by mail constructors + PhpList\Core\Domain\Common\Html2Text: + autowire: true + autoconfigure: true + + # Rewrites relative asset URLs in fetched HTML to absolute ones + PhpList\Core\Domain\Common\HtmlUrlRewriter: + autowire: true + autoconfigure: true + + # External image caching/downloading helper used by TemplateImageEmbedder + PhpList\Core\Domain\Common\ExternalImageService: + autowire: true + autoconfigure: true + arguments: + $tempDir: '%kernel.cache_dir%' + # Use literal defaults if parameters are not defined in this environment + $externalImageMaxAge: 0 + $externalImageMaxSize: 204800 + $externalImageTimeout: 30 + + # Embed images from templates and filesystem into HTML emails + PhpList\Core\Domain\Messaging\Service\TemplateImageEmbedder: + autowire: true + autoconfigure: true + arguments: + $documentRoot: '%kernel.project_dir%/public' + # Reuse upload_images_dir for editorImagesDir if a dedicated parameter is absent + $editorImagesDir: '%phplist.upload_images_dir%' + $embedExternalImages: '%messaging.embed_external_images%' + $embedUploadedImages: '%messaging.embed_uploaded_images%' + $uploadImagesDir: '%phplist.upload_images_dir%' + PhpList\Core\Domain\Messaging\Service\RateLimitedCampaignMailer: autowire: true autoconfigure: true @@ -123,6 +156,9 @@ services: PhpList\Core\Domain\Configuration\Service\UserPersonalizer: autowire: true autoconfigure: true + arguments: + $preferencePageShowPrivateLists: '%app.preference_page_show_private_lists%' + $placeholderResolvers: !tagged_iterator phplist.placeholder_resolver PhpList\Core\Domain\Configuration\Service\LegacyUrlBuilder: autowire: true @@ -139,3 +175,28 @@ services: autoconfigure: true arguments: $maxMailSize: '%messaging.max_mail_size%' + + # Loads and normalises message data for campaigns + PhpList\Core\Domain\Messaging\Service\MessageDataLoader: + autowire: true + autoconfigure: true + arguments: + $defaultMessageAge: '%app.config.default_message_age%' + + # Common helpers required by precache/message building + PhpList\Core\Domain\Common\TextParser: + autowire: true + autoconfigure: true + + PhpList\Core\Domain\Common\RemotePageFetcher: + autowire: true + autoconfigure: true + + # Pre-caches base message content (HTML/Text/template) for campaigns + PhpList\Core\Domain\Messaging\Service\MessagePrecacheService: + autowire: true + autoconfigure: true + arguments: + $useManualTextPart: '%messaging.use_manual_text_part%' + $uploadImageDir: '%phplist.upload_images_dir%' + $publicSchema: '%phplist.public_schema%' diff --git a/resources/translations/messages.en.xlf b/resources/translations/messages.en.xlf index 40a24785..d216c1d7 100644 --- a/resources/translations/messages.en.xlf +++ b/resources/translations/messages.en.xlf @@ -750,6 +750,26 @@ Thank you. phplist has started sending the campaign with subject %subject% __phplist has started sending the campaign with subject %subject% + + Unsubscribe + __Unsubscribe + + + This link + __This link + + + Confirm + __Confirm + + + Update preferences + __Update preferences + + + Sorry, you are not subscribed to any of our newsletters with this email address. + __Sorry, you are not subscribed to any of our newsletters with this email address. + diff --git a/src/Domain/Common/RemotePageFetcher.php b/src/Domain/Common/RemotePageFetcher.php index 0d37b76e..74d31a7a 100644 --- a/src/Domain/Common/RemotePageFetcher.php +++ b/src/Domain/Common/RemotePageFetcher.php @@ -28,7 +28,7 @@ public function __construct( ) { } - public function __invoke(string $url, array $userData): string + public function __invoke(string $url, array $userData): ?string { $url = $this->prepareUrl($url, $userData); @@ -78,7 +78,7 @@ public function __invoke(string $url, array $userData): string return $content; } - private function fetchUrlDirect(string $url): string + private function fetchUrlDirect(string $url): ?string { try { $response = $this->httpClient->request('GET', $url, [ @@ -88,7 +88,7 @@ private function fetchUrlDirect(string $url): string return $response->getContent(false); } catch (Throwable $e) { - return ''; + return null; } } diff --git a/src/Domain/Configuration/Model/ConfigOption.php b/src/Domain/Configuration/Model/ConfigOption.php index 9222a24b..d9e5cfbf 100644 --- a/src/Domain/Configuration/Model/ConfigOption.php +++ b/src/Domain/Configuration/Model/ConfigOption.php @@ -10,6 +10,8 @@ enum ConfigOption: string case SubscribeMessage = 'subscribemessage'; case SubscribeEmailSubject = 'subscribesubject'; case UnsubscribeUrl = 'unsubscribeurl'; + case BlacklistUrl = 'blacklisturl'; + case ForwardUrl = 'forwardurl'; case ConfirmationUrl = 'confirmationurl'; case PreferencesUrl = 'preferencesurl'; case SubscribeUrl = 'subscribeurl'; @@ -33,4 +35,7 @@ enum ConfigOption: string case PoweredByText = 'PoweredByText'; case UploadImageRoot = 'uploadimageroot'; case PageRoot = 'pageroot'; + case OrganisationName = 'organisation_name'; + case VCardUrl = 'vcardurl'; + case HtmlEmailStyle = 'html_email_style'; } diff --git a/src/Domain/Configuration/Model/Dto/PlaceholderContext.php b/src/Domain/Configuration/Model/Dto/PlaceholderContext.php new file mode 100644 index 00000000..8190f6a9 --- /dev/null +++ b/src/Domain/Configuration/Model/Dto/PlaceholderContext.php @@ -0,0 +1,44 @@ +format === OutputFormat::Html; + } + + public function isText(): bool + { + return $this->format === OutputFormat::Text; + } + + public function forwardedBy(): ?string + { + return $this->forwardedBy; + } + + public function messageId(): ?int + { + return $this->messageId; + } + + public function getUser(): Subscriber + { + return $this->user; + } +} diff --git a/src/Domain/Configuration/Model/OutputFormat.php b/src/Domain/Configuration/Model/OutputFormat.php new file mode 100644 index 00000000..c413d3ed --- /dev/null +++ b/src/Domain/Configuration/Model/OutputFormat.php @@ -0,0 +1,11 @@ +withQueryParam($baseUrl, 'uid', $uid); + } + + public function withEmail(string $baseUrl, string $email): string + { + return $this->withQueryParam($baseUrl, 'email', $email); + } + + private function withQueryParam(string $baseUrl, string $paramName, string $paramValue): string { $parts = parse_url($baseUrl) ?: []; $query = []; if (!empty($parts['query'])) { parse_str($parts['query'], $query); } - $query['uid'] = $uid; + $query[$paramName] = $paramValue; $parts['query'] = http_build_query($query); diff --git a/src/Domain/Configuration/Service/Placeholder/BlacklistUrlValueResolver.php b/src/Domain/Configuration/Service/Placeholder/BlacklistUrlValueResolver.php new file mode 100644 index 00000000..fbe2b545 --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/BlacklistUrlValueResolver.php @@ -0,0 +1,35 @@ +config->getValue(ConfigOption::UnsubscribeUrl) ?? ''; + $url = $this->urlBuilder->withEmail($base, $ctx->getUser()->getEmail()); + + if ($ctx->isHtml()) { + return htmlspecialchars($url, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + } + + return $url; + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/BlacklistValueResolver.php b/src/Domain/Configuration/Service/Placeholder/BlacklistValueResolver.php new file mode 100644 index 00000000..6973e6ff --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/BlacklistValueResolver.php @@ -0,0 +1,41 @@ +config->getValue(ConfigOption::BlacklistUrl) ?? ''; + $url = $this->urlBuilder->withEmail($base, $ctx->getUser()->getEmail()); + + if ($ctx->isHtml()) { + $label = $this->translator->trans('Unsubscribe'); + $safeLabel = htmlspecialchars($label, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + $safeUrl = htmlspecialchars($url, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + + return '' . $safeLabel . ''; + } + + return $url; + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/ConfirmationUrlValueResolver.php b/src/Domain/Configuration/Service/Placeholder/ConfirmationUrlValueResolver.php new file mode 100644 index 00000000..01571a64 --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/ConfirmationUrlValueResolver.php @@ -0,0 +1,33 @@ +config->getValue(ConfigOption::SubscribeUrl) ?? ''; + $sep = !str_contains($url, '?') ? '?' : '&'; + + if ($ctx->isHtml()) { + return sprintf('%s%suid=%s', $url, htmlspecialchars($sep), $ctx->getUser()->getUniqueId()); + } + + return sprintf('%s%suid=%s', $url, $sep, $ctx->getUser()->getUniqueId()); + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/ForwardUrlValueResolver.php b/src/Domain/Configuration/Service/Placeholder/ForwardUrlValueResolver.php new file mode 100644 index 00000000..6774205b --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/ForwardUrlValueResolver.php @@ -0,0 +1,39 @@ +config->getValue(ConfigOption::ForwardUrl) ?? ''; + $sep = !str_contains($url, '?') ? '?' : '&'; + + if ($ctx->isHtml()) { + return sprintf( + '%s%suid=%s&mid=%d', + htmlspecialchars($url, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'), + htmlspecialchars($sep), + $ctx->getUser()->getUniqueId(), + $ctx->messageId(), + ); + } + + return sprintf('%s%suid=%s&mid=%d ', $url, $sep, $ctx->getUser()->getUniqueId(), $ctx->messageId()); + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/ForwardValueResolver.php b/src/Domain/Configuration/Service/Placeholder/ForwardValueResolver.php new file mode 100644 index 00000000..c252aecc --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/ForwardValueResolver.php @@ -0,0 +1,46 @@ +config->getValue(ConfigOption::ForwardUrl) ?? ''; + $sep = !str_contains($url, '?') ? '?' : '&'; + + if ($ctx->isHtml()) { + $label = $this->translator->trans('This link'); + $safeLabel = htmlspecialchars($label, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + $safeUrl = htmlspecialchars($url, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + + return sprintf( + '%s ', + $safeUrl, + htmlspecialchars($sep), + $ctx->getUser()->getUniqueId(), + $ctx->messageId(), + $safeLabel + ); + } + + return sprintf('%s%suid=%s&mid=%d ', $url, $sep, $ctx->getUser()->getUniqueId(), $ctx->messageId()); + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/JumpoffUrlValueResolver.php b/src/Domain/Configuration/Service/Placeholder/JumpoffUrlValueResolver.php new file mode 100644 index 00000000..44780d6b --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/JumpoffUrlValueResolver.php @@ -0,0 +1,13 @@ +config->getValue(ConfigOption::UnsubscribeUrl) ?? ''; + $url = $this->urlBuilder->withUid($base, $ctx->getUser()->getUniqueId()); + + if ($ctx->isHtml()) { + return ''; + } + + return $url . '&jo=1'; + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/ListsValueResolver.php b/src/Domain/Configuration/Service/Placeholder/ListsValueResolver.php new file mode 100644 index 00000000..bc2daac5 --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/ListsValueResolver.php @@ -0,0 +1,47 @@ +subscriberListRepository->getActiveListNamesForSubscriber( + subscriber: $ctx->getUser(), + showPrivate: $this->preferencePageShowPrivateLists + ); + + if ($names === []) { + return $this->translator + ->trans('Sorry, you are not subscribed to any of our newsletters with this email address.'); + } + + $separator = $ctx->isHtml() ? '
' : "\n"; + + if ($ctx->isHtml()) { + $names = array_map( + static fn(string $name) => htmlspecialchars($name, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'), + $names + ); + } + + return implode($separator, $names); + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/PlaceholderValueResolverInterface.php b/src/Domain/Configuration/Service/Placeholder/PlaceholderValueResolverInterface.php new file mode 100644 index 00000000..256a912c --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/PlaceholderValueResolverInterface.php @@ -0,0 +1,13 @@ +config->getValue(ConfigOption::PreferencesUrl) ?? ''; + $sep = !str_contains($url, '?') ? '?' : '&'; + + if ($ctx->isHtml()) { + return sprintf('%s%suid=%s', $url, htmlspecialchars($sep), $ctx->getUser()->getUniqueId()); + } + + return sprintf('%s%suid=%s', $url, $sep, $ctx->getUser()->getUniqueId()); + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/PreferencesValueResolver.php b/src/Domain/Configuration/Service/Placeholder/PreferencesValueResolver.php new file mode 100644 index 00000000..199cb644 --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/PreferencesValueResolver.php @@ -0,0 +1,45 @@ +config->getValue(ConfigOption::PreferencesUrl) ?? ''; + $sep = !str_contains($url, '?') ? '?' : '&'; + + if ($ctx->isHtml()) { + $label = $this->translator->trans('This link'); + $safeLabel = htmlspecialchars($label, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + $safeUrl = htmlspecialchars($url, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + + return sprintf( + '%s ', + $safeUrl, + htmlspecialchars($sep), + $ctx->getUser()->getUniqueId(), + $safeLabel, + ); + } + + return sprintf('%s%suid=%s', $url, $sep, $ctx->getUser()->getUniqueId()); + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/SignatureValueResolver.php b/src/Domain/Configuration/Service/Placeholder/SignatureValueResolver.php new file mode 100644 index 00000000..33edaaae --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/SignatureValueResolver.php @@ -0,0 +1,39 @@ +isHtml()) { + if ($this->emailTextCredits) { + return $this->config->getValue(ConfigOption::PoweredByText); + } + + return preg_replace( + '/src=".*power-phplist.png"/', + 'src="powerphplist.png"', + $this->config->getValue(ConfigOption::PoweredByImage) + ); + } + + return "\n\n-- powered by phpList, www.phplist.com --\n\n"; + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/SubscribeUrlValueResolver.php b/src/Domain/Configuration/Service/Placeholder/SubscribeUrlValueResolver.php new file mode 100644 index 00000000..9ab3c151 --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/SubscribeUrlValueResolver.php @@ -0,0 +1,32 @@ +config->getValue(ConfigOption::SubscribeUrl) ?? ''; + + if ($ctx->isHtml()) { + return htmlspecialchars($url, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + } + + return $url; + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/SubscribeValueResolver.php b/src/Domain/Configuration/Service/Placeholder/SubscribeValueResolver.php new file mode 100644 index 00000000..53f5cfb4 --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/SubscribeValueResolver.php @@ -0,0 +1,38 @@ +config->getValue(ConfigOption::SubscribeUrl) ?? ''; + + if ($ctx->isHtml()) { + $label = $this->translator->trans('This link'); + $safeLabel = htmlspecialchars($label, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + $safeUrl = htmlspecialchars($url, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + + return '' . $safeLabel . ''; + } + + return $url; + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/UnsubscribeUrlValueResolver.php b/src/Domain/Configuration/Service/Placeholder/UnsubscribeUrlValueResolver.php new file mode 100644 index 00000000..ac725f05 --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/UnsubscribeUrlValueResolver.php @@ -0,0 +1,35 @@ +config->getValue(ConfigOption::UnsubscribeUrl) ?? ''; + $url = $this->urlBuilder->withUid($base, $ctx->getUser()->getUniqueId()); + + if ($ctx->isHtml()) { + return htmlspecialchars($url, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + } + + return $url; + } +} diff --git a/src/Domain/Configuration/Service/Placeholder/UnsubscribeValueResolver.php b/src/Domain/Configuration/Service/Placeholder/UnsubscribeValueResolver.php new file mode 100644 index 00000000..26ec462d --- /dev/null +++ b/src/Domain/Configuration/Service/Placeholder/UnsubscribeValueResolver.php @@ -0,0 +1,45 @@ +config->getValue(ConfigOption::UnsubscribeUrl) ?? ''; + if ($ctx->forwardedBy()) { + //0013076: Problem found during testing: message part must be parsed correctly as well. + $base = $this->config->getValue(ConfigOption::BlacklistUrl) ?? ''; + } + $url = $this->urlBuilder->withUid($base, $ctx->getUser()->getUniqueId()); + + if ($ctx->isHtml()) { + $label = $this->translator->trans('Unsubscribe'); + $safeLabel = htmlspecialchars($label, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + $safeUrl = htmlspecialchars($url, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); + + return '' . $safeLabel . ''; + } + + return $url; + } +} diff --git a/src/Domain/Configuration/Service/PlaceholderResolver.php b/src/Domain/Configuration/Service/PlaceholderResolver.php index 3a0a3464..3f14978d 100644 --- a/src/Domain/Configuration/Service/PlaceholderResolver.php +++ b/src/Domain/Configuration/Service/PlaceholderResolver.php @@ -4,30 +4,36 @@ namespace PhpList\Core\Domain\Configuration\Service; +use PhpList\Core\Domain\Configuration\Model\Dto\PlaceholderContext; + class PlaceholderResolver { - /** @var array */ - private array $providers = []; + /** @var array */ + private array $resolvers = []; - public function register(string $token, callable $provider): void + public function register(string $name, callable $resolver): void { - // tokens like [UNSUBSCRIBEURL] (case-insensitive) - $this->providers[strtoupper($token)] = $provider; + $this->resolvers[$name] = $resolver; } - public function resolve(?string $input): ?string + public function resolve(string $value, PlaceholderContext $context): string { - if ($input === null || $input === '') { - return $input; + if (!str_contains($value, '[')) { + return $value; } - // Replace [TOKEN] (case-insensitive) - return preg_replace_callback('/\[(\w+)\]/i', function ($map) { - $key = strtoupper($map[1]); - if (!isset($this->providers[$key])) { - return $map[0]; - } - return (string) ($this->providers[$key])(); - }, $input); + return preg_replace_callback( + '/\[([A-Z0-9_]+)\]/', + function (array $m) use ($context) { + $key = $m[1]; + + if (!isset($this->resolvers[$key])) { + return $m[0]; + } + + return (string) ($this->resolvers[$key])($context); + }, + $value + ); } } diff --git a/src/Domain/Configuration/Service/UserPersonalizer.php b/src/Domain/Configuration/Service/UserPersonalizer.php index 7aedf1d8..6c2a8049 100644 --- a/src/Domain/Configuration/Service/UserPersonalizer.php +++ b/src/Domain/Configuration/Service/UserPersonalizer.php @@ -5,65 +5,78 @@ namespace PhpList\Core\Domain\Configuration\Service; use PhpList\Core\Domain\Configuration\Model\ConfigOption; +use PhpList\Core\Domain\Configuration\Model\OutputFormat; use PhpList\Core\Domain\Configuration\Service\Provider\ConfigProvider; +use PhpList\Core\Domain\Configuration\Model\Dto\PlaceholderContext; +use PhpList\Core\Domain\Configuration\Service\Placeholder\PlaceholderValueResolverInterface; use PhpList\Core\Domain\Subscription\Repository\SubscriberAttributeValueRepository; use PhpList\Core\Domain\Subscription\Repository\SubscriberRepository; use PhpList\Core\Domain\Subscription\Service\Resolver\AttributeValueResolver; class UserPersonalizer { - private const PHP_SPACE = ' '; - public function __construct( private readonly ConfigProvider $config, - private readonly LegacyUrlBuilder $urlBuilder, private readonly SubscriberRepository $subscriberRepository, private readonly SubscriberAttributeValueRepository $attributesRepository, - private readonly AttributeValueResolver $attributeValueResolver + private readonly AttributeValueResolver $attributeValueResolver, + /** @var iterable */ + private readonly iterable $placeholderResolvers, ) { } - public function personalize(string $value, string $email): string - { + public function personalize( + string $value, + string $email, + OutputFormat $format, + ?int $messageId = null, + ?string $forwardedBy = null, + ): string { $user = $this->subscriberRepository->findOneByEmail($email); if (!$user) { return $value; } $resolver = new PlaceholderResolver(); - $resolver->register('EMAIL', fn() => $user->getEmail()); - - $resolver->register('UNSUBSCRIBEURL', function () use ($user) { - $base = $this->config->getValue(ConfigOption::UnsubscribeUrl) ?? ''; - return $this->urlBuilder->withUid($base, $user->getUniqueId()) . self::PHP_SPACE; - }); - - $resolver->register('CONFIRMATIONURL', function () use ($user) { - $base = $this->config->getValue(ConfigOption::ConfirmationUrl) ?? ''; - return $this->urlBuilder->withUid($base, $user->getUniqueId()) . self::PHP_SPACE; - }); - $resolver->register('PREFERENCESURL', function () use ($user) { - $base = $this->config->getValue(ConfigOption::PreferencesUrl) ?? ''; - return $this->urlBuilder->withUid($base, $user->getUniqueId()) . self::PHP_SPACE; - }); - + $resolver->register('EMAIL', fn(PlaceholderContext $ctx) => $ctx->user->getEmail()); + $resolver->register('FORWARDEDBY', fn(PlaceholderContext $ctx) => $ctx->forwardedBy()); + $resolver->register('MESSAGEID', fn(PlaceholderContext $ctx) => $ctx->messageId()); + $resolver->register('FORWARDFORM', fn(PlaceholderContext $ctx) => ''); + $resolver->register('USERID', fn(PlaceholderContext $ctx) => $ctx->user->getUniqueId()); + $resolver->register( + name: 'WEBSITE', + resolver: fn(PlaceholderContext $ctx) => $this->config->getValue(ConfigOption::Website) ?? '' + ); + $resolver->register( + name: 'DOMAIN', + resolver: fn(PlaceholderContext $ctx) => $this->config->getValue(ConfigOption::Domain) ?? '' + ); + $resolver->register( + name: 'ORGANIZATION_NAME', + resolver: fn(PlaceholderContext $ctx) => $this->config->getValue(ConfigOption::OrganisationName) ?? '' + ); $resolver->register( - 'SUBSCRIBEURL', - fn() => ($this->config->getValue(ConfigOption::SubscribeUrl) ?? '') . self::PHP_SPACE + name: 'CONTACTURL', + resolver: fn(PlaceholderContext $ctx) => htmlspecialchars( + $this->config->getValue(ConfigOption::VCardUrl) ?? '' + ) ); - $resolver->register('DOMAIN', fn() => $this->config->getValue(ConfigOption::Domain) ?? ''); - $resolver->register('WEBSITE', fn() => $this->config->getValue(ConfigOption::Website) ?? ''); + + foreach ($this->placeholderResolvers as $placeholderResolver) { + $resolver->register($placeholderResolver->name(), $placeholderResolver); + } $userAttributes = $this->attributesRepository->getForSubscriber($user); foreach ($userAttributes as $userAttribute) { $resolver->register( - strtoupper($userAttribute->getAttributeDefinition()->getName()), - fn() => $this->attributeValueResolver->resolve($userAttribute) + name: strtoupper($userAttribute->getAttributeDefinition()->getName()), + resolver: fn(PlaceholderContext $ctx) => $this->attributeValueResolver->resolve($userAttribute) ); } - $out = $resolver->resolve($value); - - return (string) $out; + return $resolver->resolve( + value: $value, + context: new PlaceholderContext(user: $user, format: $format, forwardedBy: $forwardedBy, messageId: $messageId) + ); } } diff --git a/src/Domain/Messaging/Exception/RemotePageFetchException.php b/src/Domain/Messaging/Exception/RemotePageFetchException.php new file mode 100644 index 00000000..3aa0c074 --- /dev/null +++ b/src/Domain/Messaging/Exception/RemotePageFetchException.php @@ -0,0 +1,15 @@ +emailService = $emailService; } /** diff --git a/src/Domain/Messaging/MessageHandler/CampaignProcessorMessageHandler.php b/src/Domain/Messaging/MessageHandler/CampaignProcessorMessageHandler.php index 35b4c841..7845a084 100644 --- a/src/Domain/Messaging/MessageHandler/CampaignProcessorMessageHandler.php +++ b/src/Domain/Messaging/MessageHandler/CampaignProcessorMessageHandler.php @@ -8,7 +8,6 @@ use DateTimeImmutable; use Doctrine\DBAL\Exception\UniqueConstraintViolationException; use Doctrine\ORM\EntityManagerInterface; -use PhpList\Core\Domain\Configuration\Service\UserPersonalizer; use PhpList\Core\Domain\Messaging\Exception\MessageCacheMissingException; use PhpList\Core\Domain\Messaging\Exception\MessageSizeLimitExceededException; use PhpList\Core\Domain\Messaging\Message\CampaignProcessorMessage; @@ -22,6 +21,7 @@ use PhpList\Core\Domain\Messaging\Repository\MessageRepository; use PhpList\Core\Domain\Messaging\Repository\UserMessageRepository; use PhpList\Core\Domain\Messaging\Service\Builder\EmailBuilder; +use PhpList\Core\Domain\Messaging\Service\Constructor\MailConstructor; use PhpList\Core\Domain\Messaging\Service\Handler\RequeueHandler; use PhpList\Core\Domain\Messaging\Service\MailSizeChecker; use PhpList\Core\Domain\Messaging\Service\MaxProcessTimeLimiter; @@ -63,10 +63,10 @@ public function __construct( private readonly SubscriberHistoryManager $subscriberHistoryManager, private readonly MessageRepository $messageRepository, private readonly MessagePrecacheService $precacheService, - private readonly UserPersonalizer $userPersonalizer, private readonly MessageDataLoader $messageDataLoader, private readonly EmailBuilder $emailBuilder, private readonly MailSizeChecker $mailSizeChecker, + private readonly MailConstructor $mailConstructor, private readonly string $messageEnvelope, ) { } @@ -195,19 +195,19 @@ private function handleEmailSending( MessagePrecacheDto $precachedContent, ): void { $processed = $this->messagePreparator->processMessageLinks( - $campaign->getId(), - $precachedContent, - $subscriber + campaignId: $campaign->getId(), + cachedMessageDto: $precachedContent, + subscriber: $subscriber ); - $processed->textContent = $this->userPersonalizer->personalize( - $processed->textContent, - $subscriber->getEmail(), - ); - $processed->footer = $this->userPersonalizer->personalize($processed->footer, $subscriber->getEmail()); try { - $email = $this->rateLimitedCampaignMailer->composeEmail($campaign, $subscriber, $processed); - $this->mailer->send($email); + // todo: use correct service + $email = $this->mailConstructor->build( + message: $campaign, + subscriber: $subscriber, + messagePrecacheDto: $processed + ); + $this->rateLimitedCampaignMailer->send($email); ($this->mailSizeChecker)($campaign, $email, $subscriber->hasHtmlEmail()); $this->updateUserMessageStatus($userMessage, UserMessageStatus::Sent); } catch (MessageSizeLimitExceededException $e) { diff --git a/src/Domain/Messaging/MessageHandler/PasswordResetMessageHandler.php b/src/Domain/Messaging/MessageHandler/PasswordResetMessageHandler.php index 7d2a3096..ceedf35a 100644 --- a/src/Domain/Messaging/MessageHandler/PasswordResetMessageHandler.php +++ b/src/Domain/Messaging/MessageHandler/PasswordResetMessageHandler.php @@ -13,15 +13,11 @@ #[AsMessageHandler] class PasswordResetMessageHandler { - private EmailService $emailService; - private TranslatorInterface $translator; - private string $passwordResetUrl; - - public function __construct(EmailService $emailService, TranslatorInterface $translator, string $passwordResetUrl) - { - $this->emailService = $emailService; - $this->translator = $translator; - $this->passwordResetUrl = $passwordResetUrl; + public function __construct( + private readonly EmailService $emailService, + private readonly TranslatorInterface $translator, + private readonly string $passwordResetUrl + ) { } /** diff --git a/src/Domain/Messaging/MessageHandler/SubscriberConfirmationMessageHandler.php b/src/Domain/Messaging/MessageHandler/SubscriberConfirmationMessageHandler.php index 69ec42cb..4a9e3c07 100644 --- a/src/Domain/Messaging/MessageHandler/SubscriberConfirmationMessageHandler.php +++ b/src/Domain/Messaging/MessageHandler/SubscriberConfirmationMessageHandler.php @@ -16,15 +16,11 @@ #[AsMessageHandler] class SubscriberConfirmationMessageHandler { - private EmailService $emailService; - private TranslatorInterface $translator; - private string $confirmationUrl; - - public function __construct(EmailService $emailService, TranslatorInterface $translator, string $confirmationUrl) - { - $this->emailService = $emailService; - $this->translator = $translator; - $this->confirmationUrl = $confirmationUrl; + public function __construct( + private readonly EmailService $emailService, + private readonly TranslatorInterface $translator, + private readonly string $confirmationUrl + ) { } /** diff --git a/src/Domain/Messaging/MessageHandler/SubscriptionConfirmationMessageHandler.php b/src/Domain/Messaging/MessageHandler/SubscriptionConfirmationMessageHandler.php index 6ecb965b..73f2fda0 100644 --- a/src/Domain/Messaging/MessageHandler/SubscriptionConfirmationMessageHandler.php +++ b/src/Domain/Messaging/MessageHandler/SubscriptionConfirmationMessageHandler.php @@ -5,6 +5,7 @@ namespace PhpList\Core\Domain\Messaging\MessageHandler; use PhpList\Core\Domain\Configuration\Model\ConfigOption; +use PhpList\Core\Domain\Configuration\Model\OutputFormat; use PhpList\Core\Domain\Configuration\Service\Provider\ConfigProvider; use PhpList\Core\Domain\Configuration\Service\UserPersonalizer; use PhpList\Core\Domain\Messaging\Message\SubscriptionConfirmationMessage; @@ -20,24 +21,13 @@ #[AsMessageHandler] class SubscriptionConfirmationMessageHandler { - private EmailService $emailService; - private ConfigProvider $configProvider; - private LoggerInterface $logger; - private UserPersonalizer $userPersonalizer; - private SubscriberListRepository $subscriberListRepository; - public function __construct( - EmailService $emailService, - ConfigProvider $configProvider, - LoggerInterface $logger, - UserPersonalizer $userPersonalizer, - SubscriberListRepository $subscriberListRepository, + private readonly EmailService $emailService, + private readonly ConfigProvider $configProvider, + private readonly LoggerInterface $logger, + private readonly UserPersonalizer $userPersonalizer, + private readonly SubscriberListRepository $subscriberListRepository, ) { - $this->emailService = $emailService; - $this->configProvider = $configProvider; - $this->logger = $logger; - $this->userPersonalizer = $userPersonalizer; - $this->subscriberListRepository = $subscriberListRepository; } /** @@ -47,14 +37,19 @@ public function __invoke(SubscriptionConfirmationMessage $message): void { $subject = $this->configProvider->getValue(ConfigOption::SubscribeEmailSubject); $textContent = $this->configProvider->getValue(ConfigOption::SubscribeMessage); - $personalizedTextContent = $this->userPersonalizer->personalize($textContent, $message->getUniqueId()); $listOfLists = $this->getListNames($message->getListIds()); - $replacedTextContent = str_replace('[LISTS]', $listOfLists, $personalizedTextContent); + $replacedTextContent = str_replace('[LISTS]', $listOfLists, $textContent); + + $personalizedTextContent = $this->userPersonalizer->personalize( + value: $replacedTextContent, + email: $message->getUniqueId(), + format: OutputFormat::Text, + ); $email = (new Email()) ->to($message->getEmail()) ->subject($subject) - ->text($replacedTextContent); + ->text($personalizedTextContent); $this->emailService->sendEmail($email); @@ -63,14 +58,6 @@ public function __invoke(SubscriptionConfirmationMessage $message): void private function getListNames(array $listIds): string { - $listNames = []; - foreach ($listIds as $id) { - $list = $this->subscriberListRepository->find($id); - if ($list) { - $listNames[] = $list->getName(); - } - } - - return implode(', ', $listNames); + return implode(', ', $this->subscriberListRepository->getListNames($listIds)); } } diff --git a/src/Domain/Messaging/Service/Builder/EmailBuilder.php b/src/Domain/Messaging/Service/Builder/EmailBuilder.php index 87bb9c8f..32930fc4 100644 --- a/src/Domain/Messaging/Service/Builder/EmailBuilder.php +++ b/src/Domain/Messaging/Service/Builder/EmailBuilder.php @@ -8,7 +8,7 @@ use PhpList\Core\Domain\Configuration\Service\Manager\EventLogManager; use PhpList\Core\Domain\Configuration\Service\Provider\ConfigProvider; use PhpList\Core\Domain\Messaging\Exception\DevEmailNotConfiguredException; -use PhpList\Core\Domain\Messaging\Service\SystemMailConstructor; +use PhpList\Core\Domain\Messaging\Service\Constructor\MailConstructorInterface; use PhpList\Core\Domain\Messaging\Service\TemplateImageEmbedder; use PhpList\Core\Domain\Subscription\Repository\SubscriberRepository; use PhpList\Core\Domain\Subscription\Repository\UserBlacklistRepository; @@ -26,7 +26,7 @@ public function __construct( private readonly UserBlacklistRepository $blacklistRepository, private readonly SubscriberHistoryManager $subscriberHistoryManager, private readonly SubscriberRepository $subscriberRepository, - private readonly SystemMailConstructor $systemMailConstructor, + private readonly MailConstructorInterface $mailConstructor, private readonly TemplateImageEmbedder $templateImageEmbedder, private readonly LoggerInterface $logger, private readonly string $googleSenderId, @@ -60,15 +60,15 @@ public function buildPhplistEmail( [$destinationEmail, $message] = $this->resolveDestinationEmailAndMessage($to, $message); - [$htmlMessage, $textMessage] = ($this->systemMailConstructor)($message, $subject); + [$htmlMessage, $textMessage] = ($this->mailConstructor)($message, $subject); $email = $this->createBaseEmail( - $messageId, - $destinationEmail, - $fromEmail, - $fromName, - $subject, - $inBlast + messageId: $messageId, + destinationEmail: $destinationEmail, + fromEmail: $fromEmail, + fromName: $fromName, + subject: $subject, + inBlast: $inBlast ); $this->applyContentAndFormatting($email, $htmlMessage, $textMessage, $messageId); diff --git a/src/Domain/Messaging/Service/Constructor/MailConstructor.php b/src/Domain/Messaging/Service/Constructor/MailConstructor.php new file mode 100644 index 00000000..a389daca --- /dev/null +++ b/src/Domain/Messaging/Service/Constructor/MailConstructor.php @@ -0,0 +1,136 @@ +configProvider->getValue(ConfigOption::HtmlEmailStyle); + $adddefaultstyle = 0; + + $content = $messagePrecacheDto->content; + $text = []; + $html = []; + if ($messagePrecacheDto->userSpecificUrl) { + $userData = $this->subscriberRepository->getDataById($subscriber->getId()); + $this->replaceUserSpecificRemoteContent($messagePrecacheDto, $subscriber, $userData); + } + + if ($hash !== 'forwarded') { + $text['footer'] = $messagePrecacheDto->textFooter; + $html['footer'] = $messagePrecacheDto->htmlFooter; + } else { + //0013076: different content when forwarding 'to a friend' + if ($this->forwardAlternativeContent) { + $text['footer'] = stripslashes($messagePrecacheDto->footer); + } else { + $text['footer'] = $this->configProvider->getValue(ConfigOption::ForwardFooter); + } + $html['footer'] = $text['footer']; + } + + $hasText = !empty($messagePrecacheDto->textContent); + if ($messagePrecacheDto->htmlFormatted) { + $textcontent = $hasText ? $messagePrecacheDto->textContent : ($this->html2Text)($content); + $htmlcontent = $content; + } else { + $textcontent = $hasText ? $content : $messagePrecacheDto->textContent; + $htmlcontent = ($this->textParser)($content); + } + + if ($messagePrecacheDto->template) { + // template used + // use only the content of the body element if it is present + if (preg_match('|(.+)|is', $htmlcontent, $matches)) { + $htmlcontent = $matches[1]; + } + $htmlmessage = str_replace('[CONTENT]', $htmlcontent, $messagePrecacheDto->template); + } else { + // no template used + $htmlmessage = $htmlcontent; + $adddefaultstyle = 1; + } + if ($messagePrecacheDto->templateText) { + // text template used + $textmessage = str_replace('[CONTENT]', $textcontent, $messagePrecacheDto->templateText); + } else { + // no text template used + $textmessage = $textcontent; + } + + + $mail = new Email(); + return $mail; + } + + private function replaceUserSpecificRemoteContent( + MessagePrecacheDto $messagePrecacheDto, + Subscriber $subscriber, + array $userData + ): void { + if (!preg_match_all('/\[URL:([^\s]+)\]/i', $messagePrecacheDto->content, $matches, PREG_SET_ORDER)) { + return; + } + + $content = $messagePrecacheDto->content; + foreach ($matches as $match) { + $token = $match[0]; + $rawUrl = $match[1]; + + if (!$rawUrl) { + continue; + } + + $url = preg_match('/^https?:\/\//i', $rawUrl) ? $rawUrl : 'http://' . $rawUrl; + + $remoteContent = ($this->remotePageFetcher)($url, $userData); + + if ($remoteContent === null) { + $this->eventLogManager->log( + '', + sprintf('Error fetching URL: %s to send to %s', $rawUrl, $subscriber->getEmail()) + ); + + throw new RemotePageFetchException(); + } + + $content = str_replace($token, '' . $remoteContent, $content); + } + + $messagePrecacheDto->content = $content; + $messagePrecacheDto->htmlFormatted = strip_tags($content) !== $content; + } +} diff --git a/src/Domain/Messaging/Service/Constructor/MailConstructorInterface.php b/src/Domain/Messaging/Service/Constructor/MailConstructorInterface.php new file mode 100644 index 00000000..121ef432 --- /dev/null +++ b/src/Domain/Messaging/Service/Constructor/MailConstructorInterface.php @@ -0,0 +1,18 @@ +poweredByText = $configProvider->getValue(ConfigOption::PoweredByText); } - public function __invoke($message, string $subject = ''): array + public function __invoke(string $content, string $subject = ''): array { - [$htmlMessage, $textMessage] = $this->buildMessageBodies($message); + [$htmlMessage, $textMessage] = $this->buildMessageBodies($content); $htmlContent = $htmlMessage; $textContent = $textMessage; @@ -72,7 +72,7 @@ public function __invoke($message, string $subject = ''): array return [$htmlContent, $textContent]; } - private function buildMessageBodies($message): array + private function buildMessageBodies(string $message): array { $hasHTML = strip_tags($message) !== $message; diff --git a/src/Domain/Messaging/Service/MessagePrecacheService.php b/src/Domain/Messaging/Service/MessagePrecacheService.php index 2a0f6b28..39caaab5 100644 --- a/src/Domain/Messaging/Service/MessagePrecacheService.php +++ b/src/Domain/Messaging/Service/MessagePrecacheService.php @@ -68,10 +68,8 @@ public function precacheMessage(Message $campaign, $loadedMessageData, ?bool $fo //# but that has quite some impact on speed. So check if that's the case and apply $messagePrecacheDto->userSpecificUrl = preg_match('/\[.+\]/', $loadedMessageData['sendurl']); - if (!$messagePrecacheDto->userSpecificUrl) { - if (!$this->applyRemoteContentIfPresent($messagePrecacheDto, $loadedMessageData)) { - return false; - } + if (!$this->applyRemoteContentIfPresent($messagePrecacheDto, $loadedMessageData)) { + return false; } $messagePrecacheDto->googleTrack = $loadedMessageData['google_track']; @@ -181,27 +179,31 @@ private function applyTemplate(MessagePrecacheDto $messagePrecacheDto, $loadedMe private function applyRemoteContentIfPresent(MessagePrecacheDto $messagePrecacheDto, $loadedMessageData): bool { - if (preg_match('/\[URL:([^\s]+)\]/i', $messagePrecacheDto->content, $regs)) { - $remoteContent = ($this->remotePageFetcher)($regs[1], []); - - if ($remoteContent) { - $messagePrecacheDto->content = str_replace($regs[0], $remoteContent, $messagePrecacheDto->content); - $messagePrecacheDto->htmlFormatted = $this->isHtml($remoteContent); - - //# 17086 - disregard any template settings when we have a valid remote URL - $messagePrecacheDto->template = null; - $messagePrecacheDto->templateText = null; - $messagePrecacheDto->templateId = null; - } else { - $this->eventLogManager->log( - page: 'unknown page', - entry: 'Error fetching URL: '.$loadedMessageData['sendurl'].' cannot proceed', - ); - - return false; - } + if ( + $messagePrecacheDto->userSpecificUrl + || !preg_match('/\[URL:([^\s]+)\]/i', $messagePrecacheDto->content, $regs) + ) { + return true; + } + + $remoteContent = ($this->remotePageFetcher)($regs[1], []); + if (!$remoteContent) { + $this->eventLogManager->log( + page: 'unknown page', + entry: 'Error fetching URL: ' . $loadedMessageData['sendurl'] . ' cannot proceed', + ); + + return false; } + $messagePrecacheDto->content = str_replace($regs[0], $remoteContent, $messagePrecacheDto->content); + $messagePrecacheDto->htmlFormatted = $this->isHtml($remoteContent); + + //# 17086 - disregard any template settings when we have a valid remote URL + $messagePrecacheDto->template = null; + $messagePrecacheDto->templateText = null; + $messagePrecacheDto->templateId = null; + return true; } diff --git a/src/Domain/Messaging/Service/RateLimitedCampaignMailer.php b/src/Domain/Messaging/Service/RateLimitedCampaignMailer.php index fe1c64eb..c4fa0037 100644 --- a/src/Domain/Messaging/Service/RateLimitedCampaignMailer.php +++ b/src/Domain/Messaging/Service/RateLimitedCampaignMailer.php @@ -4,29 +4,40 @@ namespace PhpList\Core\Domain\Messaging\Service; +use PhpList\Core\Domain\Common\RemotePageFetcher; +use PhpList\Core\Domain\Configuration\Service\Manager\EventLogManager; +use PhpList\Core\Domain\Messaging\Exception\RemotePageFetchException; use PhpList\Core\Domain\Messaging\Model\Dto\MessagePrecacheDto; use PhpList\Core\Domain\Messaging\Model\Message; use PhpList\Core\Domain\Subscription\Model\Subscriber; +use PhpList\Core\Domain\Subscription\Repository\SubscriberRepository; use Symfony\Component\Mailer\Exception\TransportExceptionInterface; use Symfony\Component\Mailer\MailerInterface; use Symfony\Component\Mime\Email; class RateLimitedCampaignMailer { - private MailerInterface $mailer; - private SendRateLimiter $limiter; - public function __construct(MailerInterface $mailer, SendRateLimiter $limiter) - { - $this->mailer = $mailer; - $this->limiter = $limiter; + public function __construct( + private readonly MailerInterface $mailer, + private readonly SendRateLimiter $limiter, + private readonly RemotePageFetcher $remotePageFetcher, + private readonly SubscriberRepository $subscriberRepository, + private readonly EventLogManager $eventLogManager, + ) { } + // todo: remove this method public function composeEmail( Message $message, Subscriber $subscriber, MessagePrecacheDto $messagePrecacheDto, ): Email { $email = new Email(); + if ($messagePrecacheDto->userSpecificUrl) { + $userData = $this->subscriberRepository->getDataById($subscriber->getId()); + $this->replaceUserSpecificRemoteContent($messagePrecacheDto, $subscriber, $userData); + } + if ($message->getOptions()->getFromField() !== '') { $email->from($message->getOptions()->getFromField()); } @@ -53,4 +64,42 @@ public function send(Email $email): void $this->mailer->send($email); $this->limiter->afterSend(); } + + private function replaceUserSpecificRemoteContent( + MessagePrecacheDto $messagePrecacheDto, + Subscriber $subscriber, + array $userData + ): void { + if (!preg_match_all('/\[URL:([^\s]+)\]/i', $messagePrecacheDto->content, $matches, PREG_SET_ORDER)) { + return; + } + + $content = $messagePrecacheDto->content; + foreach ($matches as $match) { + $token = $match[0]; + $rawUrl = $match[1]; + + if (!$rawUrl) { + continue; + } + + $url = preg_match('/^https?:\/\//i', $rawUrl) ? $rawUrl : 'http://' . $rawUrl; + + $remoteContent = ($this->remotePageFetcher)($url, $userData); + + if ($remoteContent === null) { + $this->eventLogManager->log( + '', + sprintf('Error fetching URL: %s to send to %s', $rawUrl, $subscriber->getEmail()) + ); + + throw new RemotePageFetchException(); + } + + $content = str_replace($token, '' . $remoteContent, $content); + } + + $messagePrecacheDto->content = $content; + $messagePrecacheDto->htmlFormatted = strip_tags($content) !== $content; + } } diff --git a/src/Domain/Subscription/Repository/SubscriberListRepository.php b/src/Domain/Subscription/Repository/SubscriberListRepository.php index d8910751..988c23e3 100644 --- a/src/Domain/Subscription/Repository/SubscriberListRepository.php +++ b/src/Domain/Subscription/Repository/SubscriberListRepository.php @@ -9,6 +9,7 @@ use PhpList\Core\Domain\Common\Repository\Interfaces\PaginatableRepositoryInterface; use PhpList\Core\Domain\Identity\Model\Administrator; use PhpList\Core\Domain\Messaging\Model\Message; +use PhpList\Core\Domain\Subscription\Model\Subscriber; use PhpList\Core\Domain\Subscription\Model\SubscriberList; /** @@ -53,4 +54,41 @@ public function getAllActive(): array ->getQuery() ->getResult(); } + + public function getListNames(array $listIds): array + { + if ($listIds === []) { + return []; + } + + $lists = $this->createQueryBuilder('l') + ->select('l.name') + ->where('l.id IN (:ids)') + ->setParameter('ids', $listIds) + ->getQuery() + ->getScalarResult(); + + return array_column($lists, 'name'); + } + + /** + * Returns the names of lists the given subscriber is subscribed to. + * If $showPrivate is false, only active/public lists are included. + */ + public function getActiveListNamesForSubscriber(Subscriber $subscriber, bool $showPrivate): array + { + $qb = $this->createQueryBuilder('l') + ->select('l.name') + ->innerJoin('l.subscriptions', 's') + ->where('IDENTITY(s.subscriber) = :subscriberId') + ->setParameter('subscriberId', $subscriber->getId()); + + if (!$showPrivate) { + $qb->andWhere('l.active = true'); + } + + $rows = $qb->getQuery()->getScalarResult(); + + return array_column($rows, 'name'); + } } diff --git a/src/Domain/Subscription/Repository/SubscriberRepository.php b/src/Domain/Subscription/Repository/SubscriberRepository.php index af776a75..dd939dad 100644 --- a/src/Domain/Subscription/Repository/SubscriberRepository.php +++ b/src/Domain/Subscription/Repository/SubscriberRepository.php @@ -205,4 +205,14 @@ public function decrementBounceCount(Subscriber $subscriber): void ->getQuery() ->execute(); } + + public function getDataById(int $subscriberId): array + { + return $this->createQueryBuilder('s') + ->select('s') + ->where('s.id = :subscriberId') + ->setParameter('subscriberId', $subscriberId) + ->getQuery() + ->getArrayResult(); + } } diff --git a/src/Domain/Subscription/Service/SubscriberCsvImporter.php b/src/Domain/Subscription/Service/SubscriberCsvImporter.php index f962c9ab..f9db822a 100644 --- a/src/Domain/Subscription/Service/SubscriberCsvImporter.php +++ b/src/Domain/Subscription/Service/SubscriberCsvImporter.php @@ -34,36 +34,17 @@ */ class SubscriberCsvImporter { - private SubscriberManager $subscriberManager; - private SubscriberAttributeManager $attributeManager; - private SubscriptionManager $subscriptionManager; - private SubscriberRepository $subscriberRepository; - private CsvToDtoImporter $csvToDtoImporter; - private EntityManagerInterface $entityManager; - private TranslatorInterface $translator; - private MessageBusInterface $messageBus; - private SubscriberHistoryManager $subscriberHistoryManager; - public function __construct( - SubscriberManager $subscriberManager, - SubscriberAttributeManager $attributeManager, - SubscriptionManager $subscriptionManager, - SubscriberRepository $subscriberRepository, - CsvToDtoImporter $csvToDtoImporter, - EntityManagerInterface $entityManager, - TranslatorInterface $translator, - MessageBusInterface $messageBus, - SubscriberHistoryManager $subscriberHistoryManager, + private readonly SubscriberManager $subscriberManager, + private readonly SubscriberAttributeManager $attributeManager, + private readonly SubscriptionManager $subscriptionManager, + private readonly SubscriberRepository $subscriberRepository, + private readonly CsvToDtoImporter $csvToDtoImporter, + private readonly EntityManagerInterface $entityManager, + private readonly TranslatorInterface $translator, + private readonly MessageBusInterface $messageBus, + private readonly SubscriberHistoryManager $subscriberHistoryManager, ) { - $this->subscriberManager = $subscriberManager; - $this->attributeManager = $attributeManager; - $this->subscriptionManager = $subscriptionManager; - $this->subscriberRepository = $subscriberRepository; - $this->csvToDtoImporter = $csvToDtoImporter; - $this->entityManager = $entityManager; - $this->translator = $translator; - $this->messageBus = $messageBus; - $this->subscriberHistoryManager = $subscriberHistoryManager; } /** diff --git a/tests/Unit/Domain/Messaging/MessageHandler/CampaignProcessorMessageHandlerTest.php b/tests/Unit/Domain/Messaging/MessageHandler/CampaignProcessorMessageHandlerTest.php index 9fa4b4f6..38198ab2 100644 --- a/tests/Unit/Domain/Messaging/MessageHandler/CampaignProcessorMessageHandlerTest.php +++ b/tests/Unit/Domain/Messaging/MessageHandler/CampaignProcessorMessageHandlerTest.php @@ -31,6 +31,7 @@ use PHPUnit\Framework\TestCase; use Psr\Log\LoggerInterface; use Psr\SimpleCache\CacheInterface; +use ReflectionClass; use Symfony\Component\Mailer\MailerInterface; use Symfony\Component\Mime\Email; use Symfony\Component\Translation\Translator; @@ -229,29 +230,24 @@ public function testInvokeWithValidSubscriberEmail(): void ->with(1, $precached, $subscriber) ->willReturn($precached); - $this->mailer->expects($this->once()) - ->method('composeEmail') - ->with( - $this->identicalTo($campaign), - $this->identicalTo($subscriber), - $this->identicalTo($precached) - ) - ->willReturnCallback(function ($camp, $sub, $proc) use ($campaign, $subscriber, $precached) { - $this->assertSame($campaign, $camp); - $this->assertSame($subscriber, $sub); - $this->assertSame($precached, $proc); + // campaign emails are built via campaignEmailBuilder and sent via RateLimitedCampaignMailer + $campaignEmailBuilder = (new ReflectionClass($this->handler)) + ->getProperty("campaignEmailBuilder"); + /** @var EmailBuilder|MockObject $campaignBuilderMock */ + $campaignBuilderMock = $campaignEmailBuilder->getValue($this->handler); - return (new Email()) + $campaignBuilderMock->expects($this->once()) + ->method('buildPhplistEmail') + ->willReturn( + (new Email()) ->from('news@example.com') ->to('test@example.com') ->subject('Test Subject') ->text('Test text message') - ->html('

Test HTML message

'); - }); + ->html('

Test HTML message

') + ); - $this->symfonyMailer->expects($this->once()) - ->method('send') - ->with($this->isInstanceOf(Email::class)); + $this->mailer->expects($this->any())->method('send'); $metadata->expects($this->atLeastOnce()) ->method('setStatus'); @@ -300,8 +296,18 @@ public function testInvokeWithMailerException(): void ->with(123, $precached, $subscriber) ->willReturn($precached); + // Build email and throw on rate-limited sender + $campaignEmailBuilder = (new ReflectionClass($this->handler)) + ->getProperty("campaignEmailBuilder"); + $campaignEmailBuilder->setAccessible(true); + /** @var EmailBuilder|MockObject $campaignBuilderMock */ + $campaignBuilderMock = $campaignEmailBuilder->getValue($this->handler); + $campaignBuilderMock->expects($this->once()) + ->method('buildPhplistEmail') + ->willReturn((new Email())->to('test@example.com')->subject('Test Subject')->text('x')); + $exception = new Exception('Test exception'); - $this->symfonyMailer->expects($this->once()) + $this->mailer->expects($this->once()) ->method('send') ->willThrowException($exception); @@ -369,7 +375,19 @@ public function testInvokeWithMultipleSubscribers(): void ) ->willReturnOnConsecutiveCalls($precached, $precached); - $this->symfonyMailer->expects($this->exactly(2)) + // Configure builder to return emails for first two subscribers + $campaignEmailBuilder = (new ReflectionClass($this->handler)) + ->getProperty("campaignEmailBuilder"); + /** @var EmailBuilder|MockObject $campaignBuilderMock */ + $campaignBuilderMock = $campaignEmailBuilder->getValue($this->handler); + $campaignBuilderMock->expects($this->exactly(2)) + ->method('buildPhplistEmail') + ->willReturnOnConsecutiveCalls( + (new Email())->to('test1@example.com')->subject('Test Subject')->text('x'), + (new Email())->to('test2@example.com')->subject('Test Subject')->text('x') + ); + + $this->mailer->expects($this->exactly(2)) ->method('send'); $metadata->expects($this->atLeastOnce()) diff --git a/tests/Unit/Domain/Messaging/Service/Builder/EmailBuilderTest.php b/tests/Unit/Domain/Messaging/Service/Builder/EmailBuilderTest.php index 1c7e809e..8cc066e9 100644 --- a/tests/Unit/Domain/Messaging/Service/Builder/EmailBuilderTest.php +++ b/tests/Unit/Domain/Messaging/Service/Builder/EmailBuilderTest.php @@ -8,7 +8,7 @@ use PhpList\Core\Domain\Configuration\Service\Manager\EventLogManager; use PhpList\Core\Domain\Configuration\Service\Provider\ConfigProvider; use PhpList\Core\Domain\Messaging\Service\Builder\EmailBuilder; -use PhpList\Core\Domain\Messaging\Service\SystemMailConstructor; +use PhpList\Core\Domain\Messaging\Service\Constructor\SystemMailConstructor; use PhpList\Core\Domain\Messaging\Service\TemplateImageEmbedder; use PhpList\Core\Domain\Subscription\Model\Subscriber; use PhpList\Core\Domain\Subscription\Repository\SubscriberRepository; @@ -69,7 +69,7 @@ private function createBuilder( blacklistRepository: $this->blacklistRepository, subscriberHistoryManager: $this->subscriberHistoryManager, subscriberRepository: $this->subscriberRepository, - systemMailConstructor: $this->systemMailConstructor, + mailConstructor: $this->systemMailConstructor, templateImageEmbedder: $this->templateImageEmbedder, logger: $this->logger, googleSenderId: $googleSenderId, diff --git a/tests/Unit/Domain/Messaging/Service/SystemMailConstructorTest.php b/tests/Unit/Domain/Messaging/Service/SystemMailConstructorTest.php index de7f09c9..e7f3c1b0 100644 --- a/tests/Unit/Domain/Messaging/Service/SystemMailConstructorTest.php +++ b/tests/Unit/Domain/Messaging/Service/SystemMailConstructorTest.php @@ -9,8 +9,8 @@ use PhpList\Core\Domain\Configuration\Service\Provider\ConfigProvider; use PhpList\Core\Domain\Messaging\Model\Template; use PhpList\Core\Domain\Messaging\Repository\TemplateRepository; +use PhpList\Core\Domain\Messaging\Service\Constructor\SystemMailConstructor; use PhpList\Core\Domain\Messaging\Service\Manager\TemplateImageManager; -use PhpList\Core\Domain\Messaging\Service\SystemMailConstructor; use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase;