ViewInBrowserController.php
162 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Newsletter\ViewInBrowser; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\EmailEditor\Integrations\MailPoet\DependencyNotice; |
| 9 | use MailPoet\Entities\SubscriberEntity; |
| 10 | use MailPoet\Newsletter\NewslettersRepository; |
| 11 | use MailPoet\Newsletter\Sending\SendingQueuesRepository; |
| 12 | use MailPoet\Newsletter\Sharing\ShareMetadataBuilder; |
| 13 | use MailPoet\Newsletter\Sharing\ShareVisibility; |
| 14 | use MailPoet\Newsletter\Url as NewsletterUrl; |
| 15 | use MailPoet\Subscribers\LinkTokens; |
| 16 | use MailPoet\Subscribers\SubscribersRepository; |
| 17 | |
| 18 | class ViewInBrowserController { |
| 19 | /** @var LinkTokens */ |
| 20 | private $linkTokens; |
| 21 | |
| 22 | /** @var NewsletterUrl */ |
| 23 | private $newsletterUrl; |
| 24 | |
| 25 | /** @var ViewInBrowserRenderer */ |
| 26 | private $viewInBrowserRenderer; |
| 27 | |
| 28 | /** @var SubscribersRepository */ |
| 29 | private $subscribersRepository; |
| 30 | |
| 31 | /** @var SendingQueuesRepository */ |
| 32 | private $sendingQueuesRepository; |
| 33 | |
| 34 | /** @var NewslettersRepository */ |
| 35 | private $newslettersRepository; |
| 36 | |
| 37 | /** @var DependencyNotice */ |
| 38 | private $dependencyNotice; |
| 39 | |
| 40 | /** @var ShareVisibility */ |
| 41 | private $shareVisibility; |
| 42 | |
| 43 | /** @var ShareMetadataBuilder */ |
| 44 | private $shareMetadataBuilder; |
| 45 | |
| 46 | public function __construct( |
| 47 | LinkTokens $linkTokens, |
| 48 | NewsletterUrl $newsletterUrl, |
| 49 | NewslettersRepository $newslettersRepository, |
| 50 | ViewInBrowserRenderer $viewInBrowserRenderer, |
| 51 | SendingQueuesRepository $sendingQueuesRepository, |
| 52 | DependencyNotice $dependencyNotice, |
| 53 | SubscribersRepository $subscribersRepository, |
| 54 | ShareVisibility $shareVisibility, |
| 55 | ShareMetadataBuilder $shareMetadataBuilder |
| 56 | ) { |
| 57 | $this->linkTokens = $linkTokens; |
| 58 | $this->viewInBrowserRenderer = $viewInBrowserRenderer; |
| 59 | $this->subscribersRepository = $subscribersRepository; |
| 60 | $this->sendingQueuesRepository = $sendingQueuesRepository; |
| 61 | $this->newsletterUrl = $newsletterUrl; |
| 62 | $this->dependencyNotice = $dependencyNotice; |
| 63 | $this->newslettersRepository = $newslettersRepository; |
| 64 | $this->shareVisibility = $shareVisibility; |
| 65 | $this->shareMetadataBuilder = $shareMetadataBuilder; |
| 66 | } |
| 67 | |
| 68 | public function view(array $data) { |
| 69 | $data = $this->newsletterUrl->transformUrlDataObject($data); |
| 70 | $isPreview = !empty($data['preview']); |
| 71 | $newsletter = $this->getNewsletter($data); |
| 72 | $subscriber = $this->getSubscriber($data); |
| 73 | if ($newsletter->getWpPostId() && $this->dependencyNotice->checkDependenciesAndEventuallyShowNotice()) { |
| 74 | return ''; |
| 75 | } |
| 76 | |
| 77 | // the queue must belong to the validated newsletter; otherwise its stored |
| 78 | // body is content the requester's newsletter/hash pair does not authorise |
| 79 | $queue = isset($data['queue_id']) ? $this->sendingQueuesRepository->findOneById($data['queue_id']) : null; |
| 80 | if ($queue && (!$queue->getNewsletter() || $queue->getNewsletter()->getId() !== $newsletter->getId())) { |
| 81 | throw new \InvalidArgumentException("Invalid 'queue_id'"); |
| 82 | } |
| 83 | |
| 84 | // if queue and subscriber exist, subscriber must have received the newsletter |
| 85 | if (!$isPreview && $queue && $subscriber->getId() && !$this->sendingQueuesRepository->isSubscriberProcessed($queue, $subscriber)) { |
| 86 | throw new \InvalidArgumentException("Subscriber did not receive the newsletter yet"); |
| 87 | } |
| 88 | |
| 89 | $html = $this->viewInBrowserRenderer->render($isPreview, $newsletter, $subscriber, $queue); |
| 90 | if (!empty($data['embed_hide_background'])) { |
| 91 | // Public embed URLs may request this cosmetic-only presentation variant. |
| 92 | $html = $this->hideEmbedBackground($html); |
| 93 | } |
| 94 | if (!$isPreview && $this->shareVisibility->canShare($newsletter)) { |
| 95 | $publicUrl = $this->newsletterUrl->getPublicShareUrl($newsletter); |
| 96 | // Pass $publicUrl as both the share target and the replaceState target so the |
| 97 | // tokenised view-in-browser URL is scrubbed from the address bar on load. |
| 98 | return $this->shareMetadataBuilder->injectShareToolbar($html, $newsletter, $publicUrl, $publicUrl); |
| 99 | } |
| 100 | return $html; |
| 101 | } |
| 102 | |
| 103 | private function hideEmbedBackground(string $html): string { |
| 104 | $style = '<style id="mailpoet-newsletter-embed-background">html,body{background:transparent!important;}body{padding:0!important;}</style>'; |
| 105 | $headPosition = stripos($html, '</head>'); |
| 106 | if ($headPosition !== false) { |
| 107 | return substr_replace($html, $style, $headPosition, 0); |
| 108 | } |
| 109 | |
| 110 | $matches = []; |
| 111 | if (preg_match('/<html\b[^>]*>/i', $html, $matches, PREG_OFFSET_CAPTURE)) { |
| 112 | $position = $matches[0][1] + strlen($matches[0][0]); |
| 113 | return substr_replace($html, $style, $position, 0); |
| 114 | } |
| 115 | |
| 116 | return $style . $html; |
| 117 | } |
| 118 | |
| 119 | private function getNewsletter(array $data) { |
| 120 | // newsletter - ID is mandatory, hash must be set and valid |
| 121 | if (empty($data['newsletter_id'])) { |
| 122 | throw new \InvalidArgumentException("Missing 'newsletter_id'"); |
| 123 | } |
| 124 | if (empty($data['newsletter_hash'])) { |
| 125 | throw new \InvalidArgumentException("Missing 'newsletter_hash'"); |
| 126 | } |
| 127 | |
| 128 | $newsletter = $this->newslettersRepository->findOneById($data['newsletter_id']); |
| 129 | if (!$newsletter) { |
| 130 | throw new \InvalidArgumentException("Invalid 'newsletter_id'"); |
| 131 | } |
| 132 | |
| 133 | if ($data['newsletter_hash'] !== $newsletter->getHash()) { |
| 134 | throw new \InvalidArgumentException("Invalid 'newsletter_hash'"); |
| 135 | } |
| 136 | return $newsletter; |
| 137 | } |
| 138 | |
| 139 | private function getSubscriber(array $data): SubscriberEntity { |
| 140 | // subscriber is optional; if exists, token must validate |
| 141 | $subscriber = null; |
| 142 | if (!empty($data['subscriber_id'])) { |
| 143 | $subscriber = $this->subscribersRepository->findOneById($data['subscriber_id']); |
| 144 | } |
| 145 | if ($subscriber && empty($data['subscriber_token'])) { |
| 146 | throw new \InvalidArgumentException("Missing 'subscriber_token'"); |
| 147 | } |
| 148 | |
| 149 | if ($subscriber && !$this->linkTokens->verifyToken($subscriber, $data['subscriber_token'])) { |
| 150 | throw new \InvalidArgumentException("Invalid 'subscriber_token'"); |
| 151 | } |
| 152 | |
| 153 | // if this is a preview and subscriber does not exist, |
| 154 | // attempt to set subscriber to the current logged-in WP user |
| 155 | if (!$subscriber && !empty($data['preview'])) { |
| 156 | $subscriber = $this->subscribersRepository->getCurrentWPUser(); |
| 157 | } |
| 158 | |
| 159 | return $subscriber ?? new SubscriberEntity(); |
| 160 | } |
| 161 | } |
| 162 |