Extract view-in-browser logic to a controller

[MAILPOET-2430]
2020-02-06 12:24:38 +01:00
parent 077591ae3c
commit edb18399a1
3 changed files with 97 additions and 72 deletions
--- a/lib/Newsletter/ViewInBrowser/ViewInBrowserController.php
+++ b/lib/Newsletter/ViewInBrowser/ViewInBrowserController.php
@ -0,0 +1,86 @@
+<?php
+
+namespace MailPoet\Newsletter\ViewInBrowser;
+
+use MailPoet\Config\AccessControl;
+use MailPoet\Models\Newsletter;
+use MailPoet\Models\SendingQueue;
+use MailPoet\Models\Subscriber;
+use MailPoet\Newsletter\Url as NewsletterUrl;
+use MailPoet\Newsletter\ViewInBrowser as NewsletterViewInBrowser;
+use MailPoet\Subscribers\LinkTokens;
+
+class ViewInBrowserController {
+  /** @var AccessControl */
+  private $accessControl;
+
+  /** @var LinkTokens */
+  private $linkTokens;
+
+  /** @var NewsletterViewInBrowser */
+  private $newsletterViewInBrowser;
+
+  public function __construct(
+    AccessControl $accessControl,
+    LinkTokens $linkTokens,
+    NewsletterViewInBrowser $newsletterViewInBrowser
+  ) {
+    $this->accessControl = $accessControl;
+    $this->linkTokens = $linkTokens;
+    $this->newsletterViewInBrowser = $newsletterViewInBrowser;
+  }
+
+  public function view(array $data) {
+    $data = NewsletterUrl::transformUrlDataObject($data);
+    $isPreview = !empty($data['preview']);
+
+    // newsletter - ID is mandatory hash must be set and valid
+    $newsletter = empty($data['newsletter_id']) ? null : Newsletter::findOne($data['newsletter_id']);
+    if (!$newsletter || empty($data['newsletter_hash']) || $data['newsletter_hash'] !== $newsletter->hash) {
+      throw new \InvalidArgumentException();
+    }
+
+    // subscriber is optional; if exists, token must validate
+    $subscriber = empty($data['subscriber_id']) ? null : Subscriber::findOne($data['subscriber_id']);
+    $subscriberToken = $data['subscriber_token'] ?? null;
+    if ($subscriber && (!$subscriberToken || !$this->linkTokens->verifyToken($subscriber, $subscriberToken))) {
+      throw new \InvalidArgumentException();
+    }
+
+    // if this is a preview and subscriber does not exist,
+    // attempt to set subscriber to the current logged-in WP user
+    if (!$subscriber && $isPreview) {
+      $subscriber = Subscriber::getCurrentWPUser();
+    }
+
+    // allow users with permission to manage emails to preview any newsletter
+    $canView = $isPreview && $this->accessControl->validatePermission(AccessControl::PERMISSION_MANAGE_EMAILS);
+
+    // if queue and subscriber exist, subscriber must have received the newsletter
+    $queue = $this->getQueue($newsletter, $data);
+    if (!$canView && $queue && $subscriber && !$queue->isSubscriberProcessed($subscriber->id)) {
+      throw new \InvalidArgumentException();
+    }
+
+    return $this->newsletterViewInBrowser->view($isPreview, $newsletter, $subscriber, $queue);
+  }
+
+
+  private function getQueue(Newsletter $newsletter, array $data) {
+    // queue is optional; try to find it if it's not defined and this is not a welcome email
+    if ($newsletter->type === Newsletter::TYPE_WELCOME) {
+      return null;
+    }
+
+    // reset queue when automatic email is being previewed
+    if ($newsletter->type === Newsletter::TYPE_AUTOMATIC && !empty($data['preview'])) {
+      return null;
+    }
+
+    $queue = !empty($data['queue_id'])
+      ? SendingQueue::findOne($data['queue_id'])
+      : SendingQueue::where('newsletter_id', $newsletter->id)->findOne();
+
+    return $queue ?: null;
+  }
+}