NewsletterEmbedService.php
321 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Newsletter\Embed; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\NewsletterEntity; |
| 9 | use MailPoet\Entities\SendingQueueEntity; |
| 10 | use MailPoet\Newsletter\NewslettersRepository; |
| 11 | use MailPoet\Newsletter\Sending\SendingQueuesRepository; |
| 12 | use MailPoet\Newsletter\Url as NewsletterUrl; |
| 13 | use MailPoet\Router\Endpoints\ViewInBrowser as ViewInBrowserEndpoint; |
| 14 | use MailPoet\Router\Router; |
| 15 | use MailPoet\WP\Functions as WPFunctions; |
| 16 | |
| 17 | class NewsletterEmbedService { |
| 18 | public const DEFAULT_HEIGHT = 800; |
| 19 | public const MIN_HEIGHT = 200; |
| 20 | public const MAX_HEIGHT = 3000; |
| 21 | public const DEFAULT_WIDTH = 640; |
| 22 | public const MIN_WIDTH = 320; |
| 23 | public const MAX_WIDTH = 1200; |
| 24 | public const DEFAULT_SELECTOR_LIMIT = 20; |
| 25 | public const MAX_SELECTOR_LIMIT = 100; |
| 26 | |
| 27 | /** @var NewslettersRepository */ |
| 28 | private $newslettersRepository; |
| 29 | |
| 30 | /** @var SendingQueuesRepository */ |
| 31 | private $sendingQueuesRepository; |
| 32 | |
| 33 | /** @var NewsletterUrl */ |
| 34 | private $newsletterUrl; |
| 35 | |
| 36 | /** @var WPFunctions */ |
| 37 | private $wp; |
| 38 | |
| 39 | public function __construct( |
| 40 | NewslettersRepository $newslettersRepository, |
| 41 | SendingQueuesRepository $sendingQueuesRepository, |
| 42 | NewsletterUrl $newsletterUrl, |
| 43 | WPFunctions $wp |
| 44 | ) { |
| 45 | $this->newslettersRepository = $newslettersRepository; |
| 46 | $this->sendingQueuesRepository = $sendingQueuesRepository; |
| 47 | $this->newsletterUrl = $newsletterUrl; |
| 48 | $this->wp = $wp; |
| 49 | } |
| 50 | |
| 51 | public function render(array $rawSettings = []): string { |
| 52 | $settings = $this->sanitizeAttributes($rawSettings); |
| 53 | return $this->renderSanitized($settings); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * @param array{newsletterId: int, height: int, width: int, showFallbackLink: bool, fallbackLinkAlignment: string, iframeAlignment: string, showEmailBackground: bool, align: string} $settings |
| 58 | */ |
| 59 | private function renderSanitized(array $settings): string { |
| 60 | $newsletterId = $settings['newsletterId']; |
| 61 | if ($newsletterId <= 0) { |
| 62 | return ''; |
| 63 | } |
| 64 | |
| 65 | $newsletter = $this->getEmbeddableNewsletter($newsletterId); |
| 66 | if (!$newsletter instanceof NewsletterEntity) { |
| 67 | return ''; |
| 68 | } |
| 69 | |
| 70 | $queue = $this->getLatestCompletedQueue($newsletter); |
| 71 | if (!$queue instanceof SendingQueueEntity) { |
| 72 | return ''; |
| 73 | } |
| 74 | |
| 75 | $url = $this->getEmbedUrl($newsletter, $queue, $settings); |
| 76 | $height = $settings['height']; |
| 77 | $width = $settings['width']; |
| 78 | $subject = $newsletter->getSubject(); |
| 79 | if ($subject !== null && $subject !== '') { |
| 80 | // translators: %s is the newsletter subject. |
| 81 | $title = sprintf(__('MailPoet newsletter: %s', 'mailpoet'), $subject); |
| 82 | } else { |
| 83 | $title = __('MailPoet newsletter', 'mailpoet'); |
| 84 | } |
| 85 | |
| 86 | $classNames = 'mailpoet-newsletter-embed'; |
| 87 | if ($settings['align'] !== '') { |
| 88 | $classNames .= ' align' . $settings['align']; |
| 89 | } |
| 90 | |
| 91 | $html = '<div' |
| 92 | . ' class="' . $this->wp->escAttr($classNames) . '"' |
| 93 | . ' style="' . $this->wp->escAttr('text-align:' . $settings['iframeAlignment'] . ';') . '"' |
| 94 | . '>'; |
| 95 | $html .= '<iframe' |
| 96 | . ' class="mailpoet-newsletter-embed-iframe"' |
| 97 | . ' src="' . $this->wp->escUrl($url) . '"' |
| 98 | . ' width="' . $this->wp->escAttr((string)$width) . '"' |
| 99 | . ' height="' . $this->wp->escAttr((string)$height) . '"' |
| 100 | . ' title="' . $this->wp->escAttr($title) . '"' |
| 101 | . ' loading="lazy"' |
| 102 | . ' sandbox="allow-same-origin allow-popups allow-popups-to-escape-sandbox"' |
| 103 | . ' style="' . $this->wp->escAttr('width:100%;max-width:' . $width . 'px;height:' . $height . 'px;border:0;background:transparent;') . '"' |
| 104 | . '></iframe>'; |
| 105 | |
| 106 | if ($settings['showFallbackLink']) { |
| 107 | $html .= '<p' |
| 108 | . ' class="mailpoet-newsletter-embed-fallback"' |
| 109 | . ' style="' . $this->wp->escAttr('text-align:' . $settings['fallbackLinkAlignment'] . ';') . '"' |
| 110 | . '>' |
| 111 | . '<a href="' . $this->wp->escUrl($url) . '">' |
| 112 | . $this->wp->escHtml(__('View full newsletter', 'mailpoet')) |
| 113 | . '</a>' |
| 114 | . '</p>'; |
| 115 | } |
| 116 | |
| 117 | $html .= '</div>'; |
| 118 | return $html; |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * @return array{newsletterId: int, height: int, width: int, showFallbackLink: bool, fallbackLinkAlignment: string, iframeAlignment: string, showEmailBackground: bool, align: string} |
| 123 | */ |
| 124 | public function sanitizeAttributes(array $attributes): array { |
| 125 | return [ |
| 126 | 'newsletterId' => $this->sanitizePositiveId($attributes['newsletterId'] ?? null), |
| 127 | 'height' => $this->sanitizeHeight($attributes['height'] ?? null), |
| 128 | 'width' => $this->sanitizeWidth($attributes['width'] ?? null), |
| 129 | 'showFallbackLink' => $this->sanitizeBoolean($attributes['showFallbackLink'] ?? true), |
| 130 | 'fallbackLinkAlignment' => $this->sanitizeTextAlignment($attributes['fallbackLinkAlignment'] ?? 'center'), |
| 131 | 'iframeAlignment' => $this->sanitizeTextAlignment($attributes['iframeAlignment'] ?? 'center'), |
| 132 | 'showEmailBackground' => $this->sanitizeBoolean($attributes['showEmailBackground'] ?? true), |
| 133 | 'align' => $this->sanitizeAlign($attributes['align'] ?? ''), |
| 134 | ]; |
| 135 | } |
| 136 | |
| 137 | public function getEmbeddableNewsletter(int $newsletterId): ?NewsletterEntity { |
| 138 | if ($newsletterId <= 0) { |
| 139 | return null; |
| 140 | } |
| 141 | return $this->newslettersRepository->findEmbeddableNewsletterById($newsletterId); |
| 142 | } |
| 143 | |
| 144 | public function getLatestCompletedQueue(NewsletterEntity $newsletter): ?SendingQueueEntity { |
| 145 | return $this->sendingQueuesRepository->findLatestCompletedByNewsletter($newsletter); |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * @return array<int, array{id: int, label: string, subject: string, sentAt: ?string, type: string, wpPostId?: int}> |
| 150 | */ |
| 151 | public function getSelectorItems(string $search = '', ?int $limit = null): array { |
| 152 | $limit = $this->sanitizeSelectorLimit($limit); |
| 153 | $rows = $this->newslettersRepository->findEmbeddableNewsletterRows($this->wp->sanitizeTextField($search), $limit); |
| 154 | |
| 155 | return array_map(function(array $row): array { |
| 156 | $sentAt = $this->formatSentAt($row['sentAt'] ?? null); |
| 157 | $subject = (string)($row['subject'] ?? ''); |
| 158 | $label = $subject; |
| 159 | if ($sentAt !== null) { |
| 160 | $label .= ' - ' . $sentAt; |
| 161 | } |
| 162 | |
| 163 | $item = [ |
| 164 | 'id' => (int)$row['id'], |
| 165 | 'label' => $label, |
| 166 | 'subject' => $subject, |
| 167 | 'sentAt' => $sentAt, |
| 168 | 'type' => (string)($row['type'] ?? ''), |
| 169 | ]; |
| 170 | |
| 171 | if (!empty($row['wpPostId'])) { |
| 172 | $item['wpPostId'] = (int)$row['wpPostId']; |
| 173 | } |
| 174 | |
| 175 | return $item; |
| 176 | }, $rows); |
| 177 | } |
| 178 | |
| 179 | /** |
| 180 | * @param mixed $value |
| 181 | */ |
| 182 | private function sanitizePositiveId($value): int { |
| 183 | if (!is_scalar($value) || $value === '' || !is_numeric($value)) { |
| 184 | return 0; |
| 185 | } |
| 186 | |
| 187 | $id = (int)$value; |
| 188 | return $id > 0 ? $id : 0; |
| 189 | } |
| 190 | |
| 191 | /** |
| 192 | * @param mixed $value |
| 193 | */ |
| 194 | private function sanitizeHeight($value): int { |
| 195 | if (!is_scalar($value) || $value === '' || !is_numeric($value)) { |
| 196 | return self::DEFAULT_HEIGHT; |
| 197 | } |
| 198 | |
| 199 | $height = (int)$value; |
| 200 | if ($height <= 0) { |
| 201 | return self::DEFAULT_HEIGHT; |
| 202 | } |
| 203 | if ($height < self::MIN_HEIGHT) { |
| 204 | return self::MIN_HEIGHT; |
| 205 | } |
| 206 | if ($height > self::MAX_HEIGHT) { |
| 207 | return self::MAX_HEIGHT; |
| 208 | } |
| 209 | return $height; |
| 210 | } |
| 211 | |
| 212 | /** |
| 213 | * @param mixed $value |
| 214 | */ |
| 215 | private function sanitizeWidth($value): int { |
| 216 | if (!is_scalar($value) || $value === '' || !is_numeric($value)) { |
| 217 | return self::DEFAULT_WIDTH; |
| 218 | } |
| 219 | |
| 220 | $width = (int)$value; |
| 221 | if ($width <= 0) { |
| 222 | return self::DEFAULT_WIDTH; |
| 223 | } |
| 224 | if ($width < self::MIN_WIDTH) { |
| 225 | return self::MIN_WIDTH; |
| 226 | } |
| 227 | if ($width > self::MAX_WIDTH) { |
| 228 | return self::MAX_WIDTH; |
| 229 | } |
| 230 | return $width; |
| 231 | } |
| 232 | |
| 233 | /** |
| 234 | * @param mixed $value |
| 235 | */ |
| 236 | private function sanitizeBoolean($value): bool { |
| 237 | if (is_bool($value)) { |
| 238 | return $value; |
| 239 | } |
| 240 | |
| 241 | if (is_scalar($value)) { |
| 242 | $normalized = strtolower(trim((string)$value)); |
| 243 | return !in_array($normalized, ['0', 'false', 'no', 'off'], true); |
| 244 | } |
| 245 | |
| 246 | return true; |
| 247 | } |
| 248 | |
| 249 | /** |
| 250 | * @param mixed $value |
| 251 | */ |
| 252 | private function sanitizeTextAlignment($value): string { |
| 253 | if (!is_string($value)) { |
| 254 | return 'center'; |
| 255 | } |
| 256 | |
| 257 | return in_array($value, ['left', 'center', 'right'], true) ? $value : 'center'; |
| 258 | } |
| 259 | |
| 260 | /** |
| 261 | * @param mixed $value |
| 262 | */ |
| 263 | private function sanitizeAlign($value): string { |
| 264 | if (!is_string($value)) { |
| 265 | return ''; |
| 266 | } |
| 267 | |
| 268 | return in_array($value, ['wide', 'full'], true) ? $value : ''; |
| 269 | } |
| 270 | |
| 271 | /** |
| 272 | * @param mixed $value |
| 273 | */ |
| 274 | private function formatSentAt($value): ?string { |
| 275 | if ($value instanceof \DateTimeInterface) { |
| 276 | $timestamp = $value->getTimestamp(); |
| 277 | } elseif (is_string($value) && $value !== '') { |
| 278 | $timestamp = strtotime($value); |
| 279 | if ($timestamp === false) { |
| 280 | return $value; |
| 281 | } |
| 282 | } else { |
| 283 | return null; |
| 284 | } |
| 285 | |
| 286 | $dateFormat = (string)$this->wp->getOption('date_format', 'F j, Y'); |
| 287 | $timeFormat = (string)$this->wp->getOption('time_format', 'g:i a'); |
| 288 | return $this->wp->dateI18n(trim($dateFormat . ' ' . $timeFormat), $timestamp); |
| 289 | } |
| 290 | |
| 291 | private function sanitizeSelectorLimit(?int $limit): int { |
| 292 | if (!$limit || $limit < 1) { |
| 293 | return self::DEFAULT_SELECTOR_LIMIT; |
| 294 | } |
| 295 | return min($limit, self::MAX_SELECTOR_LIMIT); |
| 296 | } |
| 297 | |
| 298 | /** |
| 299 | * @param array{newsletterId: int, height: int, width: int, showFallbackLink: bool, fallbackLinkAlignment: string, iframeAlignment: string, showEmailBackground: bool, align: string} $attributes |
| 300 | */ |
| 301 | private function getEmbedUrl(NewsletterEntity $newsletter, SendingQueueEntity $queue, array $attributes): string { |
| 302 | if ($attributes['showEmailBackground']) { |
| 303 | return $this->newsletterUrl->getViewInBrowserUrl($newsletter, null, $queue, true); |
| 304 | } |
| 305 | |
| 306 | return Router::buildRequest( |
| 307 | ViewInBrowserEndpoint::ENDPOINT, |
| 308 | ViewInBrowserEndpoint::ACTION_VIEW, |
| 309 | [ |
| 310 | 'newsletter_id' => $newsletter->getId(), |
| 311 | 'newsletter_hash' => $newsletter->getHash(), |
| 312 | 'subscriber_id' => false, |
| 313 | 'subscriber_token' => false, |
| 314 | 'queue_id' => $queue->getId(), |
| 315 | 'preview' => true, |
| 316 | 'embed_hide_background' => true, |
| 317 | ] |
| 318 | ); |
| 319 | } |
| 320 | } |
| 321 |