Skip to content

Commit

Permalink
FIX Notification job marked as broken
Browse files Browse the repository at this point in the history
  • Loading branch information
sabina-talipova committed Apr 14, 2023
1 parent 77bb69f commit c39e588
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 1 deletion.
39 changes: 38 additions & 1 deletion src/Tasks/ContentReviewEmails.php
Expand Up @@ -3,6 +3,7 @@
namespace SilverStripe\ContentReview\Tasks;

use Page;
use RuntimeException;
use SilverStripe\ContentReview\Compatibility\ContentReviewCompatability;
use SilverStripe\Control\Email\Email;
use SilverStripe\Control\HTTPRequest;
Expand All @@ -15,18 +16,29 @@
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\View\ArrayData;
use SilverStripe\View\SSViewer;
use SilverStripe\ContentReview\Models\ContentReviewLog;

/**
* Daily task to send emails to the owners of content items when the review date rolls around.
*/
class ContentReviewEmails extends BuildTask
{
private array $invalid_emails = [];

/**
* @param HTTPRequest $request
* @throws RuntimeException
*/
public function run($request)
{
if (!$this->isValidEmail($senderEmail = SiteConfig::current_site_config()->ReviewFrom)) {
throw new RuntimeException(
sprintf(
'Provided sender email address is invalid: "%s".',
$senderEmail
)
);
}

$compatibility = ContentReviewCompatability::start();

// First grab all the pages with a custom setting
Expand All @@ -42,6 +54,16 @@ public function run($request)
}

ContentReviewCompatability::done($compatibility);

if (is_array($this->invalid_emails) && count($this->invalid_emails) > 0) {
$plural = count($this->invalid_emails) > 1 ? 's are' : ' is';
throw new RuntimeException(
sprintf(
'Provided email' . $plural . ' invalid: "%s".',
implode(', ', $this->invalid_emails)
)
);
}
}

/**
Expand Down Expand Up @@ -93,6 +115,13 @@ protected function notifyOwner($ownerID, SS_List $pages)
// Prepare variables
$siteConfig = SiteConfig::current_site_config();
$owner = Member::get()->byID($ownerID);

if (!$this->isValidEmail($owner->Email)) {
$this->invalid_emails[] = $owner->Name . ': ' . $owner->Email;

return;
}

$templateVariables = $this->getTemplateVariables($owner, $siteConfig, $pages);

// Build email
Expand Down Expand Up @@ -159,4 +188,12 @@ protected function getTemplateVariables($recipient, $config, $pages)
'ToEmail' => $recipient->Email,
];
}

/**
* Check validity of email
*/
protected function isValidEmail(?string $email): bool
{
return (bool) filter_var($email, FILTER_VALIDATE_EMAIL);
}
}
21 changes: 21 additions & 0 deletions tests/php/ContentReviewNotificationTest.php
Expand Up @@ -3,6 +3,7 @@
namespace SilverStripe\ContentReview\Tests;

use Page;
use ReflectionClass;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\CMS\Controllers\CMSPageEditController;
use SilverStripe\ContentReview\Extensions\ContentReviewCMSExtension;
Expand Down Expand Up @@ -132,6 +133,26 @@ public function testContentReviewNeeded()
DBDatetime::clear_mock_now();
}

/**
* Test that provided email is valid
*/
public function testIsValidEmail()
{
$class = new ReflectionClass(ContentReviewEmails::class);
$method = $class->getMethod('isValidEmail');
$method->setAccessible(true);

$member = $this->objFromFixture(Member::class, 'author');
$task = new ContentReviewEmails();

$this->assertTrue($method->invokeArgs($task, [$member->Email]));
$this->assertTrue($method->invokeArgs($task, ['correct.email@example.com']));

$this->assertFalse($method->invokeArgs($task, [null]));
$this->assertFalse($method->invokeArgs($task, ['broken.email']));
$this->assertFalse($method->invokeArgs($task, ['broken@email']));
}

/**
* Deletes all pages except those passes in to the $ids parameter
*
Expand Down

0 comments on commit c39e588

Please sign in to comment.