plugins/CustomAlerts/tests/Integration/NotifierTest.php

<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\CustomAlerts\tests\Integration;

use PHPMailer\PHPMailer\PHPMailer;
use Piwik\Date;
use Piwik\Mail;
use Piwik\Plugin;
use Piwik\Plugins\CustomAlerts\Notifier;
use Piwik\Tests\Framework\Fixture;
use Piwik\Version;

class CustomNotifier extends Notifier
{
    private $alerts = array();

    public function setTriggeredAlerts($alerts)
    {
        $this->alerts = $alerts;
    }

    public function sendAlertsPerEmailToRecipient($alerts, \Piwik\Mail $mail, $recipient, $period, $idSite)
    {
        parent::sendAlertsPerEmailToRecipient($alerts, $mail, $recipient, $period, $idSite);
    }

    public function sendAlertsPerSmsToRecipient($alerts, $mobileMessagingAPI, $phoneNumber)
    {
        parent::sendAlertsPerSmsToRecipient($alerts, $mobileMessagingAPI, $phoneNumber);
    }

    protected function getToday()
    {
        return Date::factory('2010-01-01');
    }

    protected function getTriggeredAlerts($period, $idSite)
    {
        return $this->alerts;
    }
}

/**
 * @group CustomAlerts
 * @group NotifierTest
 * @group Plugins
 */
class NotifierTest extends BaseTest
{
    /**
     * @var CustomNotifier
     */
    private $notifier;

    /**
     * @var PHPMailer
     */
    private $mail;

    public function setUp(): void
    {
        parent::setUp();

        // make sure templates will be found
        Plugin\Manager::getInstance()->loadPlugin('CustomAlerts');
        Plugin\Manager::getInstance()->loadPlugin('Morpheus');

        Fixture::loadAllTranslations();

        \Piwik\Plugins\UsersManager\API::getInstance()->addUser('login1', 'p2kK2msAw1', 'test1@example.com');
        \Piwik\Plugins\UsersManager\API::getInstance()->addUser('login2', 'p2kK2msAw1', 'test2@example.com');
        \Piwik\Plugins\UsersManager\API::getInstance()->addUser('login3', 'p2kK2msAw1', 'test3@example.com');

        $this->notifier = new CustomNotifier();
    }

    public function tearDown(): void
    {
        parent::tearDown();

        Fixture::resetTranslations();
    }

    public function test_sendAlertsPerEmailToRecipient()
    {
        $alerts = $this->getTriggeredAlerts();
        $mail   = new Mail();

        $this->notifier->sendAlertsPerEmailToRecipient($alerts, $mail, 'test@example.com', 'day', 1);

        $expectedHtml = <<<HTML
Content-Type: text/html; charset=utf-8
Content-Transfer-Encoding: quoted-printable

<html style=3D"background-color:#edecec">

<head>
    <meta charset=3D"utf-8">
    <meta name=3D"robots" content=3D"noindex,nofollow">
    <meta name=3D"generator" content=3D"Matomo Analytics">
</head>
HTML;

        $expectedText = 'Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable

Hello,=0A=0AThe triggered alerts are listed in the table below. To adjust y=';

        $renderedBody = html_entity_decode($this->mail->createBody(), ENT_COMPAT | ENT_HTML401, 'UTF-8');
        $this->assertStringContainsString(str_replace("\n", PHPMailer::getLE(), $expectedHtml), $renderedBody);
        $this->assertStringContainsString(str_replace("\n", PHPMailer::getLE(), $expectedText), $renderedBody);
        $this->assertEquals(array('test@example.com'), array_keys($mail->getRecipients()));
    }

    /**
     * @return array
     */
    private function getTriggeredAlerts()
    {
        $alerts = array(
            $this->buildAlert(1, 'MyName1'),
            $this->buildAlert(2, 'MyName2'),
        );
        return $alerts;
    }

    private function buildAlert(
        $id,
        $name,
        $period = 'week',
        $idSite = 1,
        $siteName = 'Piwik test',
        $login = 'superUserLogin',
        $metric = 'nb_visits',
        $metricCondition = 'decrease_more_than',
        $metricMatched = 5000,
        $report = 'MultiSites_getOne',
        $reportCondition = 'matches_exactly',
        $reportMatched = 'Piwik'
    ) {
        return array(
            'idtriggered'       => 1,
            'idalert'           => $id,
            'idsite'            => $idSite,
            'name'              => $name,
            'period'            => $period,
            'login'             => $login,
            'report'            => $report,
            'report_condition'  => $reportCondition,
            'report_matched'    => $reportMatched,
            'metric'            => $metric,
            'metric_condition'  => $metricCondition,
            'metric_matched'    => $metricMatched,
            'additional_emails' => array('test5@example.com'),
            'phone_numbers'     => array('+1234567890', '232'),
            'email_me'          => 1,
            'value_new'         => '4493.000',
            'value_old'         => '228.128',
            'ts_triggered'      => time()
        );
    }

    public function test_sendAlertsPerEmailToRecipient_shouldUseDifferentSubjectDependingOnPeriod()
    {
        if (version_compare(Version::VERSION, '4.13.0-rc1', '<')) {
            // intl format changed in 4.13.0
            $this->assertDateInSubject('week', 'week December 21 - 27, 2009');
        } else {
            $this->assertDateInSubject('week', 'week December 21 - 27, 2009');
        }
        $this->assertDateInSubject('day', 'Thursday, December 31, 2009');
        $this->assertDateInSubject('month', 'December 2009');
    }

    private function assertDateInSubject($period, $expectedDate)
    {
        $alerts = $this->getTriggeredAlerts();

        $mail = new Mail();
        $this->notifier->sendAlertsPerEmailToRecipient($alerts, $mail, 'test@example.com', $period, 1);

        $expected = 'New alert for website Piwik test [' . $expectedDate . ']';
        $this->assertEquals($expected, $mail->getSubject());
    }

    public function test_sendNewAlerts()
    {
        $methods = array('sendAlertsPerEmailToRecipient', 'sendAlertsPerSmsToRecipient', 'markAlertAsSent');
        $mock    = $this->getMockBuilder('Piwik\Plugins\CustomAlerts\tests\Integration\CustomNotifier')
            ->onlyMethods($methods)
            ->getMock();

        $alerts = array(
            $this->buildAlert(1, 'Alert1', 'week', 4, 'Test', 'login1'),
            $this->buildAlert(2, 'Alert2', 'week', 4, 'Test', 'login2'),
            $this->buildAlert(3, 'Alert3', 'week', 4, 'Test', 'login1'),
            $this->buildAlert(4, 'Alert4', 'week', 4, 'Test', 'login3'),
        );

        $alerts[2]['phone_numbers'] = array('232');

        $idSite = 1;
        $period = 'week';

        $mock->setTriggeredAlerts($alerts);

        $mock->expects($this->at(0))
            ->method('sendAlertsPerEmailToRecipient')
            ->with(
                $this->equalTo($alerts),
                $this->isInstanceOf('\Piwik\Mail'),
                $this->equalTo('test5@example.com'),
                $this->equalTo($period),
                $this->equalTo($idSite)
            );

        $mock->expects($this->at(1))
            ->method('sendAlertsPerEmailToRecipient')
            ->with(
                $this->equalTo(array($alerts[0], $alerts[2])),
                $this->isInstanceOf('\Piwik\Mail'),
                $this->equalTo('test1@example.com'),
                $this->equalTo($period),
                $this->equalTo($idSite)
            );

        $mock->expects($this->at(2))
            ->method('sendAlertsPerEmailToRecipient')
            ->with(
                $this->equalTo(array($alerts[1])),
                $this->isInstanceOf('\Piwik\Mail'),
                $this->equalTo('test2@example.com'),
                $this->equalTo($period),
                $this->equalTo($idSite)
            );

        $mock->expects($this->at(3))
            ->method('sendAlertsPerEmailToRecipient')
            ->with(
                $this->equalTo(array($alerts[3])),
                $this->isInstanceOf('\Piwik\Mail'),
                $this->equalTo('test3@example.com'),
                $this->equalTo($period),
                $this->equalTo($idSite)
            );

        $mock->expects($this->at(4))
            ->method('sendAlertsPerSmsToRecipient')
            ->with(
                $this->equalTo(array($alerts[0], $alerts[1], $alerts[3])),
                $this->isInstanceOf('\Piwik\Plugins\MobileMessaging\Model'),
                $this->equalTo('+1234567890')
            );

        $mock->expects($this->at(5))
            ->method('sendAlertsPerSmsToRecipient')
            ->with(
                $this->equalTo($alerts),
                $this->isInstanceOf('\Piwik\Plugins\MobileMessaging\Model'),
                $this->equalTo('232')
            );

        foreach ($alerts as $index => $alert) {
            $mock->expects($this->at(6 + $index))->method('markAlertAsSent')->with($this->equalTo($alert));
        }

        $mock->sendNewAlerts($period, $idSite);
    }

    public function provideContainerConfig()
    {
        return [
            'observers.global' => \Piwik\DI::add([
                [
                    'Test.Mail.send', \Piwik\DI::value(function (PHPMailer $mail) {
                        $this->mail = $mail;
                        $this->mail->preSend();
                    })
                ],
            ]),
        ];
    }
}