Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Use array instead of \stdClass, fix coding style

Browse Source 
[MAILPOET-2430]
This commit is contained in:
Jan Jakeš
2020-02-04 16:50:26 +01:00
committed by Jack Kitterhing
parent 923dc0d1dd
commit ddfc9647dd
3 changed files with 57 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
lib/Newsletter/ViewInBrowser.php
View File

@ -19,15 +19,16 @@ class ViewInBrowser {
$this->emoji = $emoji; $this->emoji = $emoji;
} }
public function view($data) { public function view(array $data) {
$wpUserPreview = ( $wpUserPreview = (
($data->subscriber && $data->subscriber->isWPUser() && $data->preview) || ($data['subscriber'] && $data['subscriber']->isWPUser() && $data['preview'])
($data->preview && $data->newsletter_hash) // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps ||
($data['preview'] && $data['newsletter_hash'])
); );
return $this->renderNewsletter( return $this->renderNewsletter(
$data->newsletter, $data['newsletter'],
$data->subscriber, $data['subscriber'],
$data->queue, $data['queue'],
$wpUserPreview $wpUserPreview
); );
} }

81
lib/Router/Endpoints/ViewInBrowser.php
View File

@ -45,70 +45,73 @@ class ViewInBrowser {
return $this->_displayNewsletter($viewInBrowser->view($data)); return $this->_displayNewsletter($viewInBrowser->view($data));
} }
public function _processBrowserPreviewData($data) { public function _processBrowserPreviewData(array $data) {
$data = (object)NewsletterUrl::transformUrlDataObject($data); $data = NewsletterUrl::transformUrlDataObject($data);
return ($this->_validateBrowserPreviewData($data)) ? return $this->_validateBrowserPreviewData($data) ?: $this->_abort();
$data :
$this->_abort();
} }
/** /**
* @param \stdClass $data * @param array $data
* @return bool|\stdClass * @return array|false
*/ */
public function _validateBrowserPreviewData($data) { public function _validateBrowserPreviewData(array $data) {
// either newsletter ID or hash must be defined, and newsletter must exist // either newsletter ID or hash must be defined, and newsletter must exist
if (empty($data->newsletter_id) && empty($data->newsletter_hash)) return false; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps if (empty($data['newsletter_id']) && empty($data['newsletter_hash'])) {
$data->newsletter = (!empty($data->newsletter_hash)) ? // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps return false;
Newsletter::getByHash($data->newsletter_hash) : // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps }
Newsletter::findOne($data->newsletter_id); // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
if (!$data->newsletter) return false; $data['newsletter'] = (!empty($data['newsletter_hash']))
? Newsletter::getByHash($data['newsletter_hash'])
: Newsletter::findOne($data['newsletter_id']);
if (!$data['newsletter']) {
return false;
}
// subscriber is optional; if exists, token must validate // subscriber is optional; if exists, token must validate
$data->subscriber = (!empty($data->subscriber_id)) ? // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps $data['subscriber'] = !empty($data['subscriber_id']) ? Subscriber::findOne($data['subscriber_id']) : false;
Subscriber::findOne($data->subscriber_id) : // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps if ($data['subscriber']) {
false; if (empty($data['subscriber_token']) || !$this->linkTokens->verifyToken($data['subscriber'], $data['subscriber_token'])) {
if ($data->subscriber) { return false;
if (empty($data->subscriber_token) || // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps }
!$this->linkTokens->verifyToken($data->subscriber, $data->subscriber_token) // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps } else if (!$data['subscriber'] && !empty($data['preview'])) {
) return false;
} else if (!$data->subscriber && !empty($data->preview)) {
// if this is a preview and subscriber does not exist, // if this is a preview and subscriber does not exist,
// attempt to set subscriber to the current logged-in WP user // attempt to set subscriber to the current logged-in WP user
$data->subscriber = Subscriber::getCurrentWPUser(); $data['subscriber'] = Subscriber::getCurrentWPUser();
} }
// if newsletter hash is not provided but newsletter ID is defined then subscriber must exist // if newsletter hash is not provided but newsletter ID is defined then subscriber must exist
if (empty($data->newsletter_hash) && $data->newsletter_id && !$data->subscriber) return false; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps if (empty($data['newsletter_hash']) && $data['newsletter_id'] && !$data['subscriber']) {
return false;
}
// queue is optional; try to find it if it's not defined and this is not a welcome email // queue is optional; try to find it if it's not defined and this is not a welcome email
if ($data->newsletter->type !== Newsletter::TYPE_WELCOME) { if ($data['newsletter']->type !== Newsletter::TYPE_WELCOME) {
$data->queue = (!empty($data->queue_id)) ? // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps $data['queue'] = (!empty($data['queue_id']))
SendingQueue::findOne($data->queue_id) : // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps ? SendingQueue::findOne($data['queue_id'])
SendingQueue::where('newsletter_id', $data->newsletter->id) : SendingQueue::where('newsletter_id', $data['newsletter']->id)->findOne();
->findOne();
} else { } else {
$data->queue = false; $data['queue'] = false;
} }
// reset queue when automatic email is being previewed // reset queue when automatic email is being previewed
if ($data->newsletter->type === Newsletter::TYPE_AUTOMATIC && !empty($data->preview)) { if ($data['newsletter']->type === Newsletter::TYPE_AUTOMATIC && !empty($data['preview'])) {
$data->queue = false; $data['queue'] = false;
} }
// allow users with permission to manage emails to preview any newsletter // allow users with permission to manage emails to preview any newsletter
if (!empty($data->preview) && $this->accessControl->validatePermission(AccessControl::PERMISSION_MANAGE_EMAILS) if (!empty($data['preview']) && $this->accessControl->validatePermission(AccessControl::PERMISSION_MANAGE_EMAILS)) {
) return $data; return $data;
}
// allow others to preview newsletters only when newsletter hash is defined // allow others to preview newsletters only when newsletter hash is defined
if (!empty($data->preview) && empty($data->newsletter_hash) // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps if (!empty($data['preview']) && empty($data['newsletter_hash'])) {
) return false; return false;
}
// if queue and subscriber exist, subscriber must have received the newsletter // if queue and subscriber exist, subscriber must have received the newsletter
if ($data->queue instanceof SendingQueue && if ($data['queue'] instanceof SendingQueue && $data['subscriber'] && !$data['queue']->isSubscriberProcessed($data['subscriber']->id)) {
$data->subscriber && return false;
!$data->queue->isSubscriberProcessed($data->subscriber->id) }
) return false;
return $data; return $data;
} }

16
tests/integration/Router/Endpoints/ViewInBrowserTest.php
View File

@ -92,7 +92,7 @@ class ViewInBrowserTest extends \MailPoetTest {
$subscriber = $this->subscriber; $subscriber = $this->subscriber;
$subscriber->email = 'random@email.com'; $subscriber->email = 'random@email.com';
$subscriber->save(); $subscriber->save();
$data = (object)array_merge( $data = array_merge(
$this->browserPreviewData, $this->browserPreviewData,
[ [
'queue' => $this->queue, 'queue' => $this->queue,
@ -105,7 +105,7 @@ class ViewInBrowserTest extends \MailPoetTest {
} }
public function testItFailsValidationWhenNewsletterIdIsProvidedButSubscriberDoesNotExist() { public function testItFailsValidationWhenNewsletterIdIsProvidedButSubscriberDoesNotExist() {
$data = (object)$this->browserPreviewData; $data = $this->browserPreviewData;
$data->subscriber_id = false; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps $data->subscriber_id = false; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
expect($this->viewInBrowser->_validateBrowserPreviewData($data))->false(); expect($this->viewInBrowser->_validateBrowserPreviewData($data))->false();
} }
@ -115,7 +115,7 @@ class ViewInBrowserTest extends \MailPoetTest {
$newsletter2 = Newsletter::create(); $newsletter2 = Newsletter::create();
$newsletter2->type = 'type'; $newsletter2->type = 'type';
$newsletter2 = $newsletter2->save(); $newsletter2 = $newsletter2->save();
$data = (object)$this->browserPreviewData; $data = $this->browserPreviewData;
$data->newsletter_hash = $newsletter2->hash; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps $data->newsletter_hash = $newsletter2->hash; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
$result = $this->viewInBrowser->_validateBrowserPreviewData($data); $result = $this->viewInBrowser->_validateBrowserPreviewData($data);
expect($result->newsletter->id)->equals($newsletter2->id); expect($result->newsletter->id)->equals($newsletter2->id);
@ -125,14 +125,14 @@ class ViewInBrowserTest extends \MailPoetTest {
} }
public function testItFailsValidationWhenPreviewIsEnabledButNewsletterHashNotProvided() { public function testItFailsValidationWhenPreviewIsEnabledButNewsletterHashNotProvided() {
$data = (object)$this->browserPreviewData; $data = $this->browserPreviewData;
$data->newsletter_hash = false; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps $data->newsletter_hash = false; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
$data->preview = true; $data->preview = true;
expect($this->viewInBrowser->_validateBrowserPreviewData($data))->false(); expect($this->viewInBrowser->_validateBrowserPreviewData($data))->false();
} }
public function testItFailsValidationWhenSubscriberIsNotOnProcessedList() { public function testItFailsValidationWhenSubscriberIsNotOnProcessedList() {
$data = (object)$this->browserPreviewData; $data = $this->browserPreviewData;
$result = $this->viewInBrowser->_validateBrowserPreviewData($data); $result = $this->viewInBrowser->_validateBrowserPreviewData($data);
expect($result)->notEmpty(); expect($result)->notEmpty();
$queue = $this->queue; $queue = $this->queue;
@ -145,7 +145,7 @@ class ViewInBrowserTest extends \MailPoetTest {
public function testItDoesNotRequireWpAdministratorToBeOnProcessedListWhenPreviewIsEnabled() { public function testItDoesNotRequireWpAdministratorToBeOnProcessedListWhenPreviewIsEnabled() {
$viewInBrowser = $this->viewInBrowser; $viewInBrowser = $this->viewInBrowser;
$data = (object)array_merge( $data = array_merge(
$this->browserPreviewData, $this->browserPreviewData,
[ [
'queue' => $this->queue, 'queue' => $this->queue,
@ -172,7 +172,7 @@ class ViewInBrowserTest extends \MailPoetTest {
public function testItSetsSubscriberToLoggedInWPUserWhenPreviewIsEnabled() { public function testItSetsSubscriberToLoggedInWPUserWhenPreviewIsEnabled() {
$viewInBrowser = $this->viewInBrowser; $viewInBrowser = $this->viewInBrowser;
$data = (object)array_merge( $data = array_merge(
$this->browserPreviewData, $this->browserPreviewData,
[ [
'queue' => $this->queue, 'queue' => $this->queue,
@ -188,7 +188,7 @@ class ViewInBrowserTest extends \MailPoetTest {
} }
public function testItGetsOrFindsQueueWhenItIsNotAWelcomeEmail() { public function testItGetsOrFindsQueueWhenItIsNotAWelcomeEmail() {
$data = (object)$this->browserPreviewData; $data = $this->browserPreviewData;
// queue will be found when not defined // queue will be found when not defined
$data->queueId = null; $data->queueId = null;
$result = $this->viewInBrowser->_validateBrowserPreviewData($data); $result = $this->viewInBrowser->_validateBrowserPreviewData($data);