matomo/plugins/ScheduledReports/tests/Integration/ApiTest.php

<?php

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

namespace Piwik\Plugins\ScheduledReports\tests\Integration;

use Piwik\API\Proxy;
use Piwik\API\Request;
use Piwik\Container\StaticContainer;
use Piwik\DataTable;
use Piwik\Date;
use Piwik\Piwik;
use Piwik\Plugins\MobileMessaging\API as APIMobileMessaging;
use Piwik\Plugins\MobileMessaging\MobileMessaging;
use Piwik\Plugins\ScheduledReports\API as APIScheduledReports;
use Piwik\Plugins\ScheduledReports\Menu;
use Piwik\Plugins\ScheduledReports\ScheduledReports;
use Piwik\Plugins\ScheduledReports\Tasks;
use Piwik\Plugins\SitesManager\API as APISitesManager;
use Piwik\ReportRenderer;
use Piwik\Scheduler\Schedule\Monthly;
use Piwik\Scheduler\Schedule\Schedule;
use Piwik\Scheduler\Task;
use Piwik\Site;
use Piwik\Tests\Framework\Mock\FakeAccess;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
use Exception;
use ReflectionMethod;

require_once PIWIK_INCLUDE_PATH . '/plugins/ScheduledReports/ScheduledReports.php';

/**
 * Class Plugins_ScheduledReportsTest
 *
 * @group Plugins
 * @group ScheduledReportsTest
 */
class ApiTest extends IntegrationTestCase
{
    private $idSite = 1;

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

        // setup the access layer
        self::setSuperUser();
        \Piwik\Plugin\Manager::getInstance()->loadPlugins(array('API', 'UserCountry', 'ScheduledReports',
            'MobileMessaging', 'VisitsSummary', 'Referrers'));
        \Piwik\Plugin\Manager::getInstance()->installLoadedPlugins();

        APISitesManager::getInstance()->addSite("Test", array("http://piwik.net"));

        APISitesManager::getInstance()->addSite("Test", array("http://piwik.net"));
        FakeAccess::setIdSitesView(array($this->idSite, 2));
        APIScheduledReports::$cache = array();
    }

    public function testSendReportOverridesParametersCorrectly()
    {
        $reportIds = [
            'UserCountry_getCity',
            'DevicesDetection_getType',
        ];

        Piwik::addAction(APIScheduledReports::GET_REPORT_TYPES_EVENT, function (&$reportTypes) {
            $reportTypes['dummyreporttype'] = 'dummyreporttype.png';
        });

        Piwik::addAction(APIScheduledReports::GET_REPORT_FORMATS_EVENT, function (&$reportFormats) {
            $reportFormats['dummyreportformat'] = 'dummyreportformat.png';
        });

        Piwik::addAction(APIScheduledReports::GET_REPORT_METADATA_EVENT, function (&$availableReportData, $reportType, $idSite) {
            if ($reportType == 'dummyreporttype') {
                $availableReportData = \Piwik\Plugins\API\API::getInstance()->getReportMetadata($idSite);
            }
        });

        Piwik::addAction(APIScheduledReports::GET_RENDERER_INSTANCE_EVENT, function (&$reportRenderer, $reportType, $outputType, $report) {
            if ($reportType == 'dummyrepor') { // apparently this gets cut off
                $reportRenderer = new class () extends ReportRenderer {
                    public function setLocale($locale)
                    {
                    }
                    public function sendToDisk($filename)
                    {
                        $path = PIWIK_INCLUDE_PATH . '/tmp/' . $filename;
                        file_put_contents($path, 'dummyreportdata');
                        return $path;
                    }
                    public function sendToBrowserDownload($filename)
                    {
                    }
                    public function sendToBrowserInline($filename)
                    {
                    }
                    public function getRenderedReport()
                    {
                    }
                    public function renderFrontPage($reportTitle, $prettyDate, $description, $reportMetadata, $segment)
                    {
                    }
                    public function renderReport($processedReport)
                    {
                    }
                    public function getAttachments($report, $processedReports, $prettyDate)
                    {
                        return [];
                    }
                };
            }
        });

        $idReport = APIScheduledReports::getInstance()->addReport(
            $this->idSite,
            'send report',
            'never',
            6,
            'dummyreporttype',
            'dummyreportformat',
            $reportIds,
            [ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY]
        );

        $eventCalledWith = [];
        Piwik::addAction(APIScheduledReports::SEND_REPORT_EVENT, function (
            &$reportType,
            $report,
            $contents,
            $filename,
            $prettyDate,
            $reportSubject,
            $reportTitle,
            $additionalFiles,
            $period,
            $force
        ) {
            $eventCalledWith[] = [$reportType, $report, $contents, $filename, $prettyDate, $reportSubject, $reportTitle, $additionalFiles,
                $period->getLabel() . ' ' . $period->getRangeString(), $force];
        });

        Request::processRequest('ScheduledReports.sendReport', [
            'idReport' => $idReport,
            'period' => 'year',
            'date' => '2018-02-04',
        ]);

        $expectedEventArgs = [];
        $this->assertEquals($expectedEventArgs, $eventCalledWith);
    }

    /**
     * @group Plugins
     */
    public function testAddReportGetReports()
    {
        $data = array(
            'idsite'      => $this->idSite,
            'description' => 'test description"',
            'type'        => 'email',
            'period'      => Schedule::PERIOD_DAY,
            'period_param' => 'month',
            'hour'        => '4',
            'format'      => 'pdf',
            'reports'     => array('UserCountry_getCountry'),
            'parameters'  => array(
                'displayFormat'    => '1',
                'emailMe'          => true,
                'additionalEmails' => array('test@test.com', 't2@test.com'),
                'evolutionGraph'   => true
            )
        );

        $dataWebsiteTwo = $data;
        $dataWebsiteTwo['idsite'] = 2;
        $dataWebsiteTwo['period'] = Schedule::PERIOD_MONTH;

        self::addReport($dataWebsiteTwo);

        // Testing getReports without parameters
        $tmp = APIScheduledReports::getInstance()->getReports();
        $report = reset($tmp);
        $this->assertReportsEqual($report, $dataWebsiteTwo);

        $idReport = self::addReport($data);

        // Passing 3 parameters
        $tmp = APIScheduledReports::getInstance()->getReports($this->idSite, $data['period'], $idReport);
        $report = reset($tmp);
        $this->assertReportsEqual($report, $data);

        // Passing only idsite
        $tmp = APIScheduledReports::getInstance()->getReports($this->idSite);
        $report = reset($tmp);
        $this->assertReportsEqual($report, $data);

        // Passing only period
        $tmp = APIScheduledReports::getInstance()->getReports($idSite = false, $data['period']);
        $report = reset($tmp);
        $this->assertReportsEqual($report, $data);

        // Passing only idreport
        $tmp = APIScheduledReports::getInstance()->getReports($idSite = false, $period = false, $idReport);
        $report = reset($tmp);
        $this->assertReportsEqual($report, $data);
    }

    /**
     * @group Plugins
     */
    public function testGetReportsIdReportNotFound()
    {
        $this->expectException(Exception::class);
        APIScheduledReports::getInstance()->getReports($idSite = false, $period = false, $idReport = 1);
    }

    /**
     * @group Plugins
     */
    public function testGetReportsInvalidPermission()
    {
        $this->expectException(Exception::class);
        APIScheduledReports::getInstance()->getReports(
            $idSite = 44,
            $period = false,
            self::addReport(self::getDailyPDFReportData($this->idSite))
        );
    }

    /**
     * @group Plugins
     */
    public function testAddReportInvalidWebsite()
    {
        $this->expectException(Exception::class);
        self::addReport(self::getDailyPDFReportData(33));
    }

    /**
     * @group Plugins
     */
    public function testAddReportInvalidPeriod()
    {
        $this->expectException(Exception::class);
        $data = self::getDailyPDFReportData($this->idSite);
        $data['period'] = 'dx';
        self::addReport($data);
    }

    /**
     * @group Plugins
     */
    public function testUpdateReport()
    {
        $idReport = self::addReport(self::getDailyPDFReportData($this->idSite));
        $dataAfter = self::getMonthlyEmailReportData($this->idSite);

        self::updateReport($idReport, $dataAfter);

        $reports = APIScheduledReports::getInstance()->getReports($idSite = false, $period = false, $idReport);

        $this->assertReportsEqual(
            reset($reports),
            $dataAfter
        );
    }

    /**
     * @group Plugins
     */
    public function testDeleteReport()
    {
        // Deletes non existing report throws exception
        try {
            APIScheduledReports::getInstance()->deleteReport($idReport = 1);
            $this->fail('Exception not raised');
        } catch (Exception $e) {
        }

        $idReport = self::addReport(self::getMonthlyEmailReportData($this->idSite));
        $this->assertEquals(1, count(APIScheduledReports::getInstance()->getReports()));
        APIScheduledReports::getInstance()->deleteReport($idReport);
        $this->assertEquals(0, count(APIScheduledReports::getInstance()->getReports()));
    }

    /**
     * @group Plugins
     */
    public function testGetTopMenuTranslationKeyMobileMessagingInactive()
    {
        // unload MobileMessaging plugin
        \Piwik\Plugin\Manager::getInstance()->loadPlugins(array('ScheduledReports'));

        $pdfReportPlugin = new Menu();
        $this->assertEquals(
            Menu::PDF_REPORTS_TOP_MENU_TRANSLATION_KEY,
            $pdfReportPlugin->getTopMenuTranslationKey()
        );
    }

    /**
     * @group Plugins
     */
    public function testGetTopMenuTranslationKeyUserIsAnonymous()
    {
        $this->setAnonymous();

        $pdfReportPlugin = new Menu();
        $this->assertEquals(
            Menu::MOBILE_MESSAGING_TOP_MENU_TRANSLATION_KEY,
            $pdfReportPlugin->getTopMenuTranslationKey()
        );
    }

    /**
     * top menu should display 'Email & SMS reports' when the user has set-up a valid mobile provider account
     * even though there is no sms reports configured
     *
     * @group Plugins
     */
    public function testGetTopMenuTranslationKeyNoReportMobileAccountOK()
    {
        // set mobile provider account
        self::setSuperUser();
        APIMobileMessaging::getInstance()->setSMSAPICredential('StubbedProvider', []);

        $pdfReportPlugin = new Menu();
        $this->assertEquals(
            Menu::MOBILE_MESSAGING_TOP_MENU_TRANSLATION_KEY,
            $pdfReportPlugin->getTopMenuTranslationKey()
        );
    }

    /**
     * top menu should display 'Email reports' when the user has not set-up a valid mobile provider account
     * and no reports at all have been configured
     *
     * @group Plugins
     */
    public function testGetTopMenuTranslationKeyNoReportMobileAccountKO()
    {
        $pdfReportPlugin = new Menu();
        $this->assertEquals(
            Menu::PDF_REPORTS_TOP_MENU_TRANSLATION_KEY,
            $pdfReportPlugin->getTopMenuTranslationKey()
        );
    }

    /**
     * top menu should display 'Email & SMS reports' if there is at least one sms report
     * whatever the status of the mobile provider account
     *
     * @group Plugins
     */
    public function testGetTopMenuTranslationKeyOneSMSReportMobileAccountKO()
    {
        APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            MobileMessaging::MOBILE_TYPE,
            MobileMessaging::SMS_FORMAT,
            [],
            [
                 MobileMessaging::PHONE_NUMBERS_PARAMETER => []
            ]
        );

        $pdfReportPlugin = new Menu();
        $this->assertEquals(
            Menu::MOBILE_MESSAGING_TOP_MENU_TRANSLATION_KEY,
            $pdfReportPlugin->getTopMenuTranslationKey()
        );
    }

    /**
     * top menu should display 'Email reports' if there are no SMS reports and at least one email report
     * whatever the status of the mobile provider account
     *
     * @group Plugins
     */
    public function testGetTopMenuTranslationKeyNoSMSReportAccountOK()
    {
        // set mobile provider account
        self::setSuperUser();
        APIMobileMessaging::getInstance()->setSMSAPICredential('StubbedProvider', []);

        self::addReport(self::getMonthlyEmailReportData($this->idSite));

        $pdfReportPlugin = new Menu();
        $this->assertEquals(
            Menu::PDF_REPORTS_TOP_MENU_TRANSLATION_KEY,
            $pdfReportPlugin->getTopMenuTranslationKey()
        );
    }

    /**
     * @group Plugins
     */
    public function testGetScheduledTasks()
    {
        // stub API to control getReports() return values
        $report1 = self::getDailyPDFReportData($this->idSite);
        $report1['idreport'] = 1;
        $report1['hour'] = 0;
        $report1['deleted'] = 0;

        $report2 = self::getMonthlyEmailReportData($this->idSite);
        $report2['idreport'] = 2;
        $report2['idsite'] = 2;
        $report2['hour'] = 0;
        $report2['deleted'] = 0;

        $report3 = self::getMonthlyEmailReportData($this->idSite);
        $report3['idreport'] = 3;
        $report3['deleted'] = 1; // should not be scheduled

        $report4 = self::getMonthlyEmailReportData($this->idSite);
        $report4['idreport'] = 4;
        $report4['idsite'] = 1;
        $report4['hour'] = 8;
        $report4['deleted'] = 0;

        $report5 = self::getMonthlyEmailReportData($this->idSite);
        $report5['idreport'] = 5;
        $report5['idsite'] = 2;
        $report5['hour'] = 8;
        $report5['deleted'] = 0;

        // test no exception is raised when a scheduled report is set to never send
        $report6 = self::getMonthlyEmailReportData($this->idSite);
        $report6['idreport'] = 6;
        $report6['period'] = Schedule::PERIOD_NEVER;
        $report6['deleted'] = 0;

        $stubbedAPIScheduledReports = $this->getMockBuilder('\\Piwik\\Plugins\\ScheduledReports\\API')
                                           ->setMethods(array('getReports', 'getInstance'))
                                           ->disableOriginalConstructor()
                                           ->getMock();
        $stubbedAPIScheduledReports->expects($this->any())->method('getReports')->will($this->returnValue(
            array($report1, $report2, $report3, $report4, $report5, $report6)
        ));
        \Piwik\Plugins\ScheduledReports\API::setSingletonInstance($stubbedAPIScheduledReports);

        // initialize sites 1 and 2
        Site::setSites(array(
            1 => array('timezone' => 'Europe/Paris'),
            2 => array('timezone' => 'UTC-6.5'),
        ));

        // expected tasks
        // NOTE: scheduled reports are always saved with UTC, to avoid daylight saving issues
        $scheduleTask1 = Schedule::factory('daily');
        $scheduleTask1->setHour(0);
        $scheduleTask1->setTimezone('UTC');

        $scheduleTask2 = new Monthly();
        $scheduleTask2->setHour(0);
        $scheduleTask2->setTimezone('UTC');

        $scheduleTask3 = new Monthly();
        $scheduleTask3->setHour(8);
        $scheduleTask3->setTimezone('UTC');

        $scheduleTask4 = new Monthly();
        $scheduleTask4->setHour(8);
        $scheduleTask4->setTimezone('UTC');

        $expectedTasks = array(
            new Task(APIScheduledReports::getInstance(), 'sendReport', 1, $scheduleTask1),
            new Task(APIScheduledReports::getInstance(), 'sendReport', 2, $scheduleTask2),
            new Task(APIScheduledReports::getInstance(), 'sendReport', 4, $scheduleTask3),
            new Task(APIScheduledReports::getInstance(), 'sendReport', 5, $scheduleTask4),
        );

        $pdfReportPlugin = new Tasks();
        $pdfReportPlugin->schedule();
        $tasks = $pdfReportPlugin->getScheduledTasks();
        $this->assertEquals($expectedTasks, $tasks);

        \Piwik\Plugins\ScheduledReports\API::unsetInstance();
    }

    /**
     * Dataprovider for testGetReportSubjectAndReportTitle
     */
    public function getGetReportSubjectAndReportTitleTestCases()
    {
        return array(
            array('<Piwik.org>', '<Piwik.org>', '<Piwik.org>', array('DevicesDetection_getBrowserEngines')),
            array('Piwik.org', 'Piwik.org', 'Piwik.org', array('MultiSites_getAll', 'DevicesDetection_getBrowserEngines')),
            array('General_MultiSitesSummary', 'General_MultiSitesSummary', 'Piwik.org', array('MultiSites_getAll')),
        );
    }

    /**
     * @group Plugins
     *
     * @dataProvider getGetReportSubjectAndReportTitleTestCases
     */
    public function testGetReportSubjectAndReportTitle($expectedReportSubject, $expectedReportTitle, $websiteName, $reports)
    {
        $getReportSubjectAndReportTitle = new ReflectionMethod(
            '\\Piwik\\Plugins\\ScheduledReports\\API',
            'getReportSubjectAndReportTitle'
        );
        $getReportSubjectAndReportTitle->setAccessible(true);

        [$reportSubject, $reportTitle] = $getReportSubjectAndReportTitle->invoke(APIScheduledReports::getInstance(), $websiteName, $reports);
        $this->assertEquals($expectedReportSubject, $reportSubject);
        $this->assertEquals($expectedReportTitle, $reportTitle);
    }

    public function testGenerateReportCatchesIndividualReportProcessExceptionsWithoutFailingToGenerateWholeReport()
    {
        $realProxy = new Proxy();

        $mockProxy = $this->getMockBuilder('Piwik\API\Proxy')->setMethods(array('call'))->getMock();
        $mockProxy->expects($this->any())->method('call')->willReturnCallback(function ($className, $methodName, $parametersRequest) use ($realProxy) {
            switch ($className) {
                case '\Piwik\Plugins\VisitsSummary\API':
                    $result = new DataTable();
                    $result->addRowFromSimpleArray(array('label' => 'visits label', 'nb_visits' => 1));
                    return $result;
                case '\Piwik\Plugins\UserCountry\API':
                    throw new \Exception("error");
                case '\Piwik\Plugins\Referrers\API':
                    $result = new DataTable();
                    $result->addRowFromSimpleArray(array('label' => 'referrers label', 'nb_visits' => 1));
                    return $result;
                case '\Piwik\Plugins\API\API':
                case '\Piwik\Plugins\LanguagesManager\API':
                    return $realProxy->call($className, $methodName, $parametersRequest);
                default:
                    throw new \Exception("Unexpected method $className::$methodName.");
            }
        });
        StaticContainer::getContainer()->set(Proxy::class, $mockProxy);

        $idReport = APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY)
        );

        ob_start();
        $result = APIScheduledReports::getInstance()->generateReport(
            $idReport,
            Date::factory('now')->toString(),
            $language = false,
            $outputType = APIScheduledReports::OUTPUT_RETURN
        );
        ob_end_clean();

        self::assertStringContainsString('id="VisitsSummary_get"', $result);
        self::assertStringContainsString('id="Referrers_getWebsites"', $result);
        self::assertStringNotContainsString('id="UserCountry_getCountry"', $result);
    }

    /**
     * @dataProvider getValidDatePeriodCombinationsForGenerateReport
     *
     * @param string|false $period
     */
    public function testGenerateReportGeneratesAReportForAllValidDatePeriodCombinations(
        string $date,
        $period
    ): void {
        $idReport = APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            [
                'VisitsSummary_get',
            ],
            [
                ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY
            ]
        );

        $result = APIScheduledReports::getInstance()->generateReport(
            $idReport,
            $date,
            false,
            APIScheduledReports::OUTPUT_RETURN,
            $period
        );

        self::assertStringContainsString('id="VisitsSummary_get"', $result);
    }

    /**
     * @return iterable<string, array{string, string|false}>
     */
    public function getValidDatePeriodCombinationsForGenerateReport(): iterable
    {
        yield 'default period' => [
            '2024-01-01',
            false,
        ];

        yield 'single day' => [
            '2024-01-01',
            'day',
        ];

        yield 'single week' => [
            '2024-01-01',
            'week',
        ];

        yield 'single month' => [
            '2024-01-01',
            'month',
        ];

        yield 'single year' => [
            '2024-01-01',
            'year',
        ];

        yield 'custom range' => [
            '2024-01-01,2024-01-02',
            'range',
        ];

        yield 'named range' => [
            'last7',
            'range',
        ];
    }

    public function testGenerateReportThrowsIfMultiplePeriodsRequested()
    {
        $this->expectException(\Piwik\Http\BadRequestException::class);
        $this->expectExceptionMessage('This API method does not support multiple periods.');

        $idReport = APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY)
        );

        APIScheduledReports::getInstance()->generateReport(
            $idReport,
            '2012-03-03,2012-03-23',
            $language = false,
            $outputType = APIScheduledReports::OUTPUT_RETURN
        );
    }

    /**
     * @dataProvider getInvalidDatePeriodCombinationsForGenerateReport
     *
     * @param string|false $period
     */
    public function testGenerateReportThrowsIfInvalidDatePeriodCombinationRequested(
        string $date,
        $period
    ): void {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('General_ExceptionInvalidDateFormat');

        $idReport = APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            [
                'VisitsSummary_get',
            ],
            [
                ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY
            ]
        );

        APIScheduledReports::getInstance()->generateReport(
            $idReport,
            $date,
            false,
            APIScheduledReports::OUTPUT_RETURN,
            $period
        );
    }

    /**
     * @return iterable<string, array{string, string|false}>
     */
    public function getInvalidDatePeriodCombinationsForGenerateReport(): iterable
    {
        yield 'invalid default period' => [
            '2024-xx-01',
            false,
        ];

        yield 'invalid day' => [
            '2024.01.01',
            'day',
        ];

        yield 'invalid range format' => [
            '2024-01-01//2024-01-02',
            'range',
        ];

        yield 'invalid named range' => [
            'lastTen',
            'range',
        ];
    }

    public function testGenerateReportThrowsIfInvalidReportRequested(): void
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage("Requested report couldn't be found.");

        APIScheduledReports::getInstance()->generateReport(
            1234567890,
            Date::factory('now')->toString(),
            false,
            APIScheduledReports::OUTPUT_RETURN
        );
    }

    public function testAddReportValidatesEvolutionPeriodForParam()
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('Invalid evolutionPeriodFor value');

        self::setSuperUser();

        APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY),
            false,
            'garbage'
        );
    }

    public function testAddReportValidatesPeriodParam()
    {
        $invalidPeriod = 'tomorrow';

        $this->expectException(\Exception::class);
        $this->expectExceptionMessage(
            'Report period must be one of the following: day, week, month, year (got ' . $invalidPeriod . ')'
        );

        self::setSuperUser();

        APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            [
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ],
            [ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY],
            false,
            'each',
            null,
            $invalidPeriod
        );
    }

    public function testAddReportValidatesEvolutionPeriodNParam()
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('Evolution period amount must be a positive number');

        self::setSuperUser();

        APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY),
            false,
            'prev',
            -5
        );
    }

    public function testAddReportThrowsIfEvolutionPeriodNParamIsEachAndLastNSupplied()
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('The evolutionPeriodN param has no effect when evolutionPeriodFor is "each".');

        self::setSuperUser();

        APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY),
            false,
            'each',
            5
        );
    }

    public function testUpdateReportValidatesPeriodParam()
    {
        $invalidPeriod = 'tomorrow';

        $this->expectException(\Exception::class);
        $this->expectExceptionMessage(
            'Report period must be one of the following: day, week, month, year (got ' . $invalidPeriod . ')'
        );

        self::setSuperUser();

        $idReport = APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            [
                'VisitsSummary_get',
            ],
            [ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY]
        );

        APIScheduledReports::getInstance()->updateReport(
            $idReport,
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            [
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ],
            [ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY],
            false,
            'each',
            null,
            $invalidPeriod
        );
    }

    public function testUpdateReportValidatesEvolutionPeriodForParam()
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('Invalid evolutionPeriodFor value');

        self::setSuperUser();

        $idReport = APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY)
        );

        APIScheduledReports::getInstance()->updateReport(
            $idReport,
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY),
            false,
            'garbage'
        );
    }

    public function testUpdateReportValidatesEvolutionPeriodNParam()
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('Evolution period amount must be a positive number');

        self::setSuperUser();

        $idReport = APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY)
        );

        APIScheduledReports::getInstance()->updateReport(
            $idReport,
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY),
            false,
            'prev',
            -5
        );
    }

    public function testUpdateReportThrowsIfEvolutionPeriodNParamIsEachAndLastNSupplied()
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('The evolutionPeriodN param has no effect when evolutionPeriodFor is "each".');

        self::setSuperUser();

        $idReport = APIScheduledReports::getInstance()->addReport(
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY)
        );

        APIScheduledReports::getInstance()->updateReport(
            $idReport,
            1,
            '',
            Schedule::PERIOD_DAY,
            0,
            ScheduledReports::EMAIL_TYPE,
            ReportRenderer::HTML_FORMAT,
            array(
                'VisitsSummary_get',
                'UserCountry_getCountry',
                'Referrers_getWebsites',
            ),
            array(ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_ONLY),
            false,
            'each',
            5
        );
    }

    public function testAddReportOnlySavesUniqueEmailAddresses()
    {
        $data = array(
            'idsite'      => $this->idSite,
            'description' => 'test description"',
            'type'        => 'email',
            'period'      => Schedule::PERIOD_DAY,
            'period_param' => 'month',
            'hour'        => '4',
            'format'      => 'pdf',
            'reports'     => array('UserCountry_getCountry'),
            'parameters'  => array(
                'displayFormat'    => '1',
                'emailMe'          => true,
                'additionalEmails' => array('test@test.com', 'test@test.com', 't2@test.com', 'test@test.com'),
                'evolutionGraph'   => true
            )
        );

        self::addReport($data);

        // Testing getReports without parameters
        $tmp = APIScheduledReports::getInstance()->getReports();
        $report = reset($tmp);
        $additionalEmails = $report['parameters']['additionalEmails'];
        $expectedEmails = array('test@test.com', 't2@test.com');
        $this->assertReportsEqual($expectedEmails, $additionalEmails);
    }

    private function assertReportsEqual($report, $data)
    {
        foreach ($data as $key => $value) {
            if ($key == 'description') {
                $value = substr($value, 0, 250);
            }
            $this->assertEquals($value, $report[$key], "Error for $key for report " . var_export($report, true) . " and data " . var_export($data, true));
        }
    }

    private static function addReport($data)
    {
        $idReport = APIScheduledReports::getInstance()->addReport(
            $data['idsite'],
            $data['description'],
            $data['period'],
            $data['hour'],
            $data['type'],
            $data['format'],
            $data['reports'],
            $data['parameters'],
            $idSegment = false,
            $evolutionPeriodFor = 'prev',
            $evolutionPeriodN = null,
            $periodParam = isset($data['period_param']) ? $data['period_param'] : null
        );
        return $idReport;
    }

    private static function getDailyPDFReportData($idSite)
    {
        return array(
            'idsite'      => $idSite,
            'description' => 'test description"',
            'period'      => Schedule::PERIOD_DAY,
            'hour'        => '7',
            'type'        => 'email',
            'format'      => 'pdf',
            'reports'     => array('UserCountry_getCountry'),
            'parameters'  => array(
                'displayFormat'    => '1',
                'emailMe'          => true,
                'additionalEmails' => array('test@test.com', 't2@test.com'),
                'evolutionGraph'   => false
            )
        );
    }

    private static function getMonthlyEmailReportData($idSite)
    {
        return array(
            'idsite'      => $idSite,
            'description' => 'very very long and possibly truncated description. very very long and possibly truncated description. very very long and possibly truncated description. very very long and possibly truncated description. very very long and possibly truncated description. ',
            'period'      => Schedule::PERIOD_MONTH,
            'hour'        => '0',
            'type'        => 'email',
            'format'      => 'pdf',
            'reports'     => array('UserCountry_getContinent'),
            'parameters'  => array(
                'displayFormat'    => '1',
                'emailMe'          => false,
                'additionalEmails' => array('blabla@ec.fr'),
                'evolutionGraph'   => false
            )
        );
    }

    private static function updateReport($idReport, $data)
    {
        APIScheduledReports::getInstance()->updateReport(
            $idReport,
            $data['idsite'],
            $data['description'],
            $data['period'],
            $data['hour'],
            $data['type'],
            $data['format'],
            $data['reports'],
            $data['parameters']
        );
        return $idReport;
    }

    private static function setSuperUser()
    {
        FakeAccess::$superUser = true;
    }

    public function provideContainerConfig()
    {
        return array(
            'Piwik\Access' => new FakeAccess()
        );
    }

    private function setAnonymous()
    {
        FakeAccess::clearAccess();
        FakeAccess::$identity = 'anonymous';
    }
}