matomo/tests/PHPUnit/Fixtures/ManyVisitsWithMockLocationProvider.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\Tests\Fixtures;

use Piwik\Date;
use Piwik\Plugins\CustomDimensions;
use Piwik\Plugins\UserCountry\LocationProvider;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\Mock\LocationProvider as MockLocationProvider;

require_once PIWIK_INCLUDE_PATH . '/tests/PHPUnit/Framework/Mock/LocationProvider.php';

/**
 * Adds one site and tracks 60 visits (15 visitors, one action per visit).
 */
class ManyVisitsWithMockLocationProvider extends Fixture
{
    public $idSite = 1;
    public $dateTime = '2010-01-03 01:22:33';
    public $nextDay = null;
    public $customDimensionId = 1;
    public $actionCustomDimensionId = 2;

    public $trackVisitsForDaysInPast = 0;

    public $trackVisitsForDeterministicCustomDimensions = false;

    public function __construct()
    {
        $this->nextDay = Date::factory($this->dateTime)->addDay(1)->getDatetime();
    }

    public function setUp(): void
    {
        $this->setUpWebsitesAndGoals();
        $this->customDimensionId = CustomDimensions\API::getInstance()->configureNewCustomDimension($this->idSite, 'testdim', 'visit', '1');
        $this->actionCustomDimensionId = CustomDimensions\API::getInstance()->configureNewCustomDimension($this->idSite, 'testdim2', 'action', '1');

        $this->setMockLocationProvider();
        $this->trackVisits();

        if ($this->trackVisitsForDeterministicCustomDimensions) {
            $this->trackVisitsForDeterministicCustomDimensions();
        }

        $dateTime = $this->dateTime;
        for ($i = 0; $i < $this->trackVisitsForDaysInPast; $i++) {
            $this->dateTime = Date::factory($this->dateTime)->subDay(1)->getDatetime();
            $this->trackVisits(($i + 1) * 20);
        }
        $this->dateTime = $dateTime;

        // track ecommerce product orders
        $this->trackOrders();

        $this->trackVisitsForNegativeOneRowAndSummary();
        $this->trackVisitsForInsightsOverview();

        ManyVisitsWithGeoIP::unsetLocationProvider();
    }

    public function tearDown(): void
    {
        ManyVisitsWithGeoIP::unsetLocationProvider();
    }

    private function setUpWebsitesAndGoals()
    {
        if (!self::siteCreated($idSite = 1)) {
            self::createWebsite($this->dateTime, 1);
        }
    }

    private function trackVisitsForNegativeOneRowAndSummary()
    {
        $t = self::getTracker($this->idSite, '2015-02-03 00:00:00');
        $t->enableBulkTracking();

        $t->setUrl('http://piwik.net/page');
        $t->doTrackEvent('-1', '-1', '-1');

        for ($i = 0; $i != 20; ++$i) {
            $t->setUrl('http://piwik.net/page');
            $t->setIp('120.34.5.' . $i);
            $t->doTrackEvent('event category ' . $i, 'event action ' . $i, 'event name ' . $i);
        }

        Fixture::checkBulkTrackingResponse($t->doBulkTrack());
    }

    private function trackVisits($random = 0)
    {
        $linuxFirefoxA = "Mozilla/5.0 (X11; Linux i686; rv:6.0) Gecko/20100101 Firefox/6.0";
        $win7FirefoxA = "Mozilla/5.0 (Windows; U; Windows NT 6.1; fr; rv:1.9.1.6) Gecko/20100101 Firefox/6.0";
        $win7ChromeA = "Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US) AppleWebKit/532.0 (KHTML, like Gecko) Chrome/3.0.195.38 Safari/532.0";
        $linuxChromeA = "Mozilla/5.0 (X11; Linux i686; rv:6.0) AppleWebKit/532.0 (KHTML, like Gecko) Chrome/3.0.195.38 Safari/532.0";
        $linuxSafariA = "Mozilla/5.0 (X11; U; Linux x86_64; en-us) AppleWebKit/531.2+ (KHTML, like Gecko) Version/5.0 Safari/531.2+";
        $iPadSafariA = "Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) AppleWebKit/531.2+ (KHTML, like Gecko) Version/5.0 Safari/531.2+";
        $iPadFirefoxB = "Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) Gecko/20100101 Firefox/14.0.1";
        $androidFirefoxB = "Mozilla/5.0 (Linux; U; Android 4.0.3; ko-kr; LG-L160L Build/IML74K) Gecko/20100101 Firefox/14.0.1";
        $androidChromeB = "Mozilla/5.0 (Linux; U; Android 4.0.3; ko-kr; LG-L160L Build/IML74K) AppleWebKit/537.1 (KHTML, like Gecko) Chrome/22.0.1207.1 Safari/537.1";
        $androidIEA = "Mozilla/5.0 (compatible; MSIE 10.6; Linux; U; Android 4.0.3; ko-kr; LG-L160L Build/IML74K; Trident/5.0; InfoPath.2; SLCC1; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729; .NET CLR 2.0.50727) 3gpp-gba UNTRUSTED/1.0";
        $iPhoneOperaA = "Opera/9.80 (iPod; U; CPU iPhone OS 4_3_3 like Mac OS X; ja-jp) Presto/2.9.181 Version/12.00";
        $win8IEB = "Mozilla/5.0 (compatible; MSIE 10.0; Windows 8; Trident/5.0)";
        $winVistaIEB = "Mozilla/5.0 (compatible; MSIE 10.0; Windows Vista; Trident/5.0)";
        $osxOperaB = "Opera/9.80 (Macintosh; Intel Mac OS X 10.6.8; U; fr) Presto/2.9.168 Version/11.52";
        $userAgents = [
            $linuxFirefoxA, $linuxFirefoxA, $win7FirefoxA, $win7ChromeA, $linuxChromeA, $linuxSafariA,
            $iPadSafariA, $iPadFirefoxB, $androidFirefoxB, $androidChromeB, $androidIEA, $iPhoneOperaA,
            $win8IEB, $winVistaIEB, $osxOperaB
        ];

        $resolutions = [
            "1920x1080", "1920x1080", "1920x1080", "1920x1080", "1366x768", "1366x768", "1366x768",
            "1280x1024", "1280x1024", "1280x1024", "1680x1050", "1680x1050", "1024x768", "800x600",
            "320x480"
        ];

        $referrers = [
            // website referrers (8)
            'http://whatever0.com/0', 'http://whatever0.com/0', 'http://whatever0.com/1', 'http://whatever0.com/2',
            'http://whatever1.com/0', 'http://whatever.com1/1', 'http://whatever1.com/2', 'http://whatever3.com/3',

            // search engines w/ keyword (12)
            'http://www.google.com/search?q=this+search+term',
            'http://www.google.com/search?q=that+search+term',
            'http://search.yahoo.com/search?p=this+search+term',
            'http://search.yahoo.com/search?p=that+search+term',
            'http://www.ask.com/web?q=this+search+term',
            'http://www.bing.com/search?q=search+term+1',
            'http://search.babylon.com/?q=search+term+2',
            'http://alexa.com/search?q=search+term+2',
            'http://www.google.com/search?q=search+term+3',
            'http://search.yahoo.com/search?p=search+term+4',
            'http://www.ask.com/web?q=search+term+3',
            'http://www.bing.com/search?q=search+term+4',
        ];

        $customVars = [
            'name'    => ['thing0', 'thing1', 'thing2', 'thing3', 'thing4', 'thing5', 'thing6', 'thing7',
                               'thing8', 'thing9', 'thing10', 'thing11', 'thing12', 'thing13', 'thing14',
                               'thing15', 'thing16', 'thing17', 'thing18', 'thing19'],
            'rating'  => [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 1, 2, 3, 4, 5, 6, 7, 8, 9, 20],
            'tweeted' => ['y', 'n', 'm', 'n', 'y', 'n', 'y', 'n', 'y', 'n', 'y', 'n', 'y', 'n', 'y', 'n',
                               'm', 'n', 'm', 'n'],
            'liked'   => ['yes', 'y', 'y', 'no', 'y', 'y', 'y', 'y', 'y', 'y', 'y', 'y', 'y', 'y', 'y', 'y',
                               'y', 'y', 'no', 'n'],
        ];
        $downloadCustomVars = [
            'size' => [1024, 1024, 1024, 2048, 2048, 3072, 3072, 3072, 3072, 4096, 4096, 4096,
                            512, 512, 256, 128, 64, 32, 48, 48]
        ];

        $visitorCounter = $random;
        $t = self::getTracker($this->idSite, $this->dateTime, $defaultInit = true, $useLocal = true);

        // track regular actions
        $this->trackActions($t, $visitorCounter, $random, 'pageview', $userAgents, $resolutions, $referrers, $customVars);

        // track downloads
        $this->trackActions($t, $visitorCounter, $random, 'download', $userAgents, $resolutions, null, $downloadCustomVars);

        // track outlinks
        $this->trackActions($t, $visitorCounter, $random, 'outlink', $userAgents, $resolutions);

        // track events
        $this->trackActions($t, $visitorCounter, $random, 'event', $userAgents, $resolutions);

        // track events
        $this->trackActions($t, $visitorCounter, $random, 'content', $userAgents, $resolutions);
    }

    private function trackActions(
        \MatomoTracker $t,
        &$visitorCounter,
        $random,
        $actionType,
        $userAgents,
        $resolutions,
        $referrers = null,
        $customVars = null
    ) {
        for ($i = $random; $i != $random + 5; ++$i, ++$visitorCounter) {
            $visitDate = Date::factory($this->dateTime);

            $t->setNewVisitorId();
            $t->setUserId('user' . $visitorCounter);
            $t->setIp("156.5.3.$visitorCounter");

            $t->setUserAgent($userAgents[$visitorCounter % count($userAgents)]);
            list($w, $h) = explode('x', $resolutions[$visitorCounter % count($resolutions)]);
            $t->setResolution((int)$w, (int)$h);

            // one visit to root url
            $t->setUrl("http://piwik.net/$visitorCounter/");
            $t->setUrlReferrer(false);
            $t->setForceVisitDateTime($visitDate->getDatetime());
            $t->setCustomDimension('' . $this->customDimensionId, $i * 5);
            $this->trackAction($t, $actionType, $visitorCounter, null);

            for ($j = 0; $j != 4; ++$j) {
                // NOTE: to test referrers w/o creating too many visits, we don't actually track 4 actions, but
                //       4 separate visits
                $actionDate = $visitDate->addHour($j + 1);

                $actionIdx = $i * 4 + $j;
                $actionNum = $visitorCounter * 4 + $j;

                $t->setUrl("http://piwik.net/$visitorCounter/$actionNum");
                $t->setForceVisitDateTime($actionDate->getDatetime());
                $t->setCustomDimension('' . $this->actionCustomDimensionId, $i * 5 + $j);

                if (!is_null($referrers)) {
                    $t->setUrlReferrer($referrers[$actionIdx % count($referrers)]);
                } else {
                    $t->setUrlReferrer(false);
                }

                if (!is_null($customVars)) {
                    $k = 1;
                    foreach ($customVars as $name => $values) {
                        $value = $values[$actionIdx % count($values)];
                        $t->setCustomVariable($k, $name, $value, $scope = 'page');

                        ++$k;
                    }
                }

                $this->trackAction($t, $actionType, $visitorCounter, $actionNum);
            }
        }
    }

    private function trackOrders()
    {
        $t = self::getTracker($this->idSite, $this->nextDay, $defaultInit = true, $useLocal = true);

        for ($i = 0; $i != 25; ++$i) {
            $cat = $i % 5;

            $t->setNewVisitorId();
            $t->setUserId('user' . ($i + 10000));
            $t->setIp("155.5.4.$i");
            $t->setEcommerceView("id_book$i", "Book$i", "Books Cat #$cat", 7.50);
            self::checkResponse($t->doTrackPageView('bought book'));
        }
    }

    private function trackAction(\MatomoTracker $t, $actionType, $visitorCounter, $actionNum)
    {
        if ($actionType == 'pageview') {
            self::checkResponse($t->doTrackPageView(
                is_null($actionNum) ? "title_$visitorCounter" : "title_$visitorCounter / title_$actionNum"
            ));
        } elseif ($actionType == 'download') {
            $root = is_null($actionNum) ? "http://cloudsite$visitorCounter.com"
                : "http://cloudsite$visitorCounter.com/$actionNum";

            self::checkResponse($t->doTrackAction("$root/download", 'download'));
        } elseif ($actionType == 'outlink') {
            self::checkResponse($t->doTrackAction(is_null($actionNum) ? "http://othersite$visitorCounter.com/"
                : "http://othersite$visitorCounter.com/$actionNum/", 'link'));
        } elseif ($actionType == 'event') {
            self::checkResponse($t->doTrackEvent('event category ' . ($visitorCounter % 6), 'event action ' . ($visitorCounter % 7), 'event name' . ($visitorCounter % 5)));
        } elseif ($actionType == 'content') {
            self::checkResponse($t->doTrackContentImpression('content name ' . $visitorCounter, 'content piece ' . $visitorCounter));

            if ($visitorCounter % 2 == 0) {
                self::checkResponse($t->doTrackContentInteraction('click', 'content name ' . $visitorCounter, 'content piece ' . $visitorCounter));
            }
        }

        // Add a site search to some visits
        if (in_array($actionType, ['download', 'outlink'])) {
            self::checkResponse($t->doTrackSiteSearch(is_null($actionNum) ? "keyword" : "keyword$actionNum"));
        }
    }

    private function setMockLocationProvider()
    {
        LocationProvider::$providers = [];
        LocationProvider::$providers[] = new MockLocationProvider();
        LocationProvider::setCurrentProvider('mock_provider');
        MockLocationProvider::$locations = [
            self::makeLocation('Toronto', 'ON', 'CA', $lat = null, $long = null, $isp = 'comcast.net'),

            self::makeLocation('Nice', 'PAC', 'FR', $lat = null, $long = null, $isp = 'comcast.net'),

            self::makeLocation('Melbourne', 'VIC', 'AU', $lat = null, $long = null, $isp = 'awesomeisp.com'),

            self::makeLocation('Yokohama', '14', 'JP'),
        ];
    }

    private function trackVisitsForInsightsOverview()
    {
        $t = Fixture::getTracker($this->idSite, '2015-03-03 06:00:00');
        $t->enableBulkTracking();
        $datesVisits = ['2015-03-03 06:00:00' => 700, '2015-03-04 06:00:00' => 1000];
        foreach ($datesVisits as $dateTime => $visitCount) {
            $t->setForceVisitDateTime($dateTime);
            for ($i = 0; $i != $visitCount; ++$i) {
                $t->setNewVisitorId();
                $t->setUrl('http://somesite.com/' . $i);
                $t->doTrackPageView('page title ' . $i);
            }
        }
        Fixture::checkBulkTrackingResponse($t->doBulkTrack());
    }

    private function trackVisitsForDeterministicCustomDimensions()
    {
        $t = Fixture::getTracker($this->idSite, '2015-03-03 06:00:00');
        $t->enableBulkTracking();

        $visitDate = Date::factory($this->dateTime);

        for ($i = 1; $i <= 8; $i++) {
            for ($j = 0; $j <= 3; ++$j) {
                $actionDate = $visitDate;
                $actionNum = $i * 4 + $j;

                for ($k = 1; $k <= $i; $k++) {
                    $t->setUserId('user' . ($i + $k + $j + 100000));
                    $t->setIp("155.5.4.$i");
                    $t->setNewVisitorId();
                    $t->setUrl("http://piwik.net/$i/$actionNum");
                    $t->setForceVisitDateTime($actionDate->getDatetime());
                    $t->setCustomDimension('' . $this->actionCustomDimensionId, $i * 5 + $j);

                    $this->trackAction($t, 'pageview', $i, $actionNum);
                }
            }
        }

        Fixture::checkBulkTrackingResponse($t->doBulkTrack());
    }
}