1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<?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\CustomDimensions\tests\Fixtures;
use Piwik\Context;
use Piwik\Date;
use Piwik\Plugins\CustomDimensions\CustomDimensions;
use Piwik\Plugins\CustomDimensions\Dao\Configuration;
use Piwik\Plugins\CustomDimensions\Dimension\Extraction;
use Piwik\Plugins\Goals;
use Piwik\Plugins\ScheduledReports\API as APIScheduledReports;
use Piwik\Plugins\ScheduledReports\ScheduledReports;
use Piwik\ReportRenderer;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tracker\Cache;
/**
* Generates tracker testing data for our ApiTest
*
* This Simple fixture adds one website and tracks one visit with couple pageviews and an ecommerce conversion
*/
class TrackVisitsWithCustomDimensionsFixture extends Fixture
{
public $dateTime = '2013-01-23 01:23:45';
public $idSite = 1;
public $idSite2 = 2;
public $idSite3 = 3;
public function setUp(): void
{
$this->setUpWebsites();
$this->addGoals();
$this->configureSomeDimensions();
$this->configureScheduledReport();
$this->trackFirstVisit();
$this->trackSecondVisit();
$this->trackThirdVisit();
$this->trackFourthVisit();
}
public function tearDown(): void
{
// empty
}
private function setUpWebsites()
{
foreach ([$this->idSite, $this->idSite2, $this->idSite3] as $idSite) {
if (!self::siteCreated($idSite)) {
self::createWebsite($this->dateTime);
}
}
}
private function addGoals()
{
Goals\API::getInstance()->addGoal($this->idSite, 'Has sub_en', 'url', 'sub_en', 'contains');
}
private function configureSomeDimensions()
{
$configuration = new Configuration();
$configuration->configureNewDimension($this->idSite, 'MyName1', CustomDimensions::SCOPE_VISIT, 1, $active = true, $extractions = array(), $caseSensitive = true);
$configuration->configureNewDimension($this->idSite, 'MyName2', CustomDimensions::SCOPE_VISIT, 2, $active = true, $extractions = array(), $caseSensitive = true);
$configuration->configureNewDimension($this->idSite2, 'MyName1', CustomDimensions::SCOPE_VISIT, 1, $active = true, $extractions = array(), $caseSensitive = true);
$configuration->configureNewDimension($this->idSite3, 'MyName1', CustomDimensions::SCOPE_ACTION, 1, $active = true, $extractions = array(), $caseSensitive = true);
$extraction1 = new Extraction('urlparam', 'test');
$extraction2 = new Extraction('urlparam', 'param');
$extraction3 = new Extraction('url', '/sub_(.{2})/page');
$configuration->configureNewDimension($this->idSite, 'MyName3', CustomDimensions::SCOPE_ACTION, 1, $active = true, $extractions = array($extraction3->toArray()), $caseSensitive = true);
$configuration->configureNewDimension($this->idSite, 'MyName4', CustomDimensions::SCOPE_ACTION, 2, $active = false, $extractions = array(), $caseSensitive = true);
$configuration->configureNewDimension($this->idSite, 'MyName5', CustomDimensions::SCOPE_ACTION, 3, $active = true, $extractions = array($extraction1->toArray(), $extraction2->toArray()), $caseSensitive = true);
$configuration->configureNewDimension($this->idSite, 'MyName6', CustomDimensions::SCOPE_VISIT, 4, $active = true, $extractions = array(), $caseSensitive = true);
Cache::deleteCacheWebsiteAttributes(1);
Cache::deleteCacheWebsiteAttributes(2);
Cache::clearCacheGeneral();
}
protected function configureScheduledReport()
{
// Context change is needed, as adding the custom dimensions reports looks for the idSite in the request params
Context::changeIdSite(1, function () {
APIScheduledReports::getInstance()->addReport(
$idSite = 1,
'ScheduledReport',
'month',
0,
ScheduledReports::EMAIL_TYPE,
ReportRenderer::PDF_FORMAT,
['VisitsSummary_get', 'CustomDimensions_getCustomDimension_idDimension--1', 'CustomDimensions_getCustomDimension_idDimension--2'],
[ScheduledReports::DISPLAY_FORMAT_PARAMETER => ScheduledReports::DISPLAY_FORMAT_TABLES_AND_GRAPHS]
);
});
}
protected function trackFirstVisit()
{
$t = self::getTracker($this->idSite, $this->dateTime, $defaultInit = true);
$t->setCustomDimension('1', 'value1');
$t->setCustomDimension('2', 'value2');
$t->setCustomDimension('3', 'value3');
$t->setCustomDimension('4', 'value4');
$t->setCustomDimension('5', 'value5');
$t->setCustomDimension('6', 'value6');
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.1)->getDatetime());
$t->setUrl('http://example.com/');
self::checkResponse($t->doTrackPageView('Viewing homepage'));
$t->setCustomDimension('1', 'value5 1');
$t->setCustomDimension('2', 'dim 2');
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.2)->getDatetime());
$t->setUrl('http://example.com/sub_en/page?test=%22%3E%3Cimg+src%3Dx+onerror%3D%22document.write%28%27test%27%29%22%3E¶m=23');
self::checkResponse($t->doTrackPageView('Second page view'));
$t->setCustomDimension('2', 'en_US');
$t->setCustomDimension('3', 'value5 3');
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.3)->getDatetime());
$t->setUrl('http://example.com/sub_en/page?param=en_US');
self::checkResponse($t->doTrackPageView('Third page view'));
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.4)->getDatetime());
$t->setUrl('http://example.com/sub_en/page?param=en_US');
self::checkResponse($t->doTrackPageView('Fourth page view'));
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addDay(0.4)->getDatetime());
$t->setUrl('http://example.com/sub_en/page?param=en_US');
self::checkResponse($t->doTrackPageView('Fourth page view'));
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addDay(2)->getDatetime());
$t->setUrl('http://example.com/sub_en/page?param=en_US');
self::checkResponse($t->doTrackPageView('Fifth page view'));
$t->setCustomDimension('1', 'value1');
$t->setCustomDimension('2', 'value2');
$t->setCustomDimension('5', 'value5 5');
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addDay(3)->getDatetime());
$t->setUrl('http://example.com/sub_en/page?param=en_US');
self::checkResponse($t->doTrackPageView('Sixth page view'));
}
protected function trackSecondVisit()
{
$t = self::getTracker($this->idSite2, $this->dateTime, $defaultInit = true);
$t->setIp('56.11.55.73');
$t->setCustomDimension('1', 'site2 value1');
$t->setCustomDimension('2', 'site2 value2');
$t->setCustomDimension('3', 'site2 value3');
$t->setCustomDimension('4', 'site2 value4');
$t->setCustomDimension('5', 'site2 value5');
$t->setCustomDimension('6', 'site2 value6');
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.1)->getDatetime());
$t->setUrl('http://example.com/sub_en/page');
self::checkResponse($t->doTrackPageView('Viewing homepage'));
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.2)->getDatetime());
$t->setUrl('http://example.com/?search=this is a site search query');
self::checkResponse($t->doTrackPageView('Site search query'));
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.3)->getDatetime());
$t->addEcommerceItem($sku = 'SKU_ID2', $name = 'A durable item', $category = 'Best seller', $price = 321);
self::checkResponse($t->doTrackEcommerceCartUpdate($grandTotal = 33 * 77));
}
// tracking visit with empty dimension values
protected function trackThirdVisit()
{
$t = self::getTracker($this->idSite, $this->dateTime, $defaultInit = true);
$t->setIp('56.11.55.79');
$t->setCustomDimension('1', '');
$t->setCustomDimension('3', '');
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.1)->getDatetime());
$t->setUrl('http://example.com/sub_en/page');
self::checkResponse($t->doTrackPageView('Viewing homepage'));
}
protected function trackFourthVisit()
{
$baseTime = Date::factory($this->dateTime);
$t = self::getTracker($this->idSite3, $this->dateTime, $defaultInit = true);
$t->setIp('56.11.55.99');
$t->enableBulkTracking();
for ($i = 1; $i <= 5; $i++) {
for ($j = 1; $j <= $i; $j++) {
$dateTime = $baseTime->addHour($i)->addHour($j * 0.1)->getDatetime();
$t->setForceNewVisit();
for ($k = 1; $k <= ($i * 5) + $j; $k++) {
$t->setCustomDimension("1", "site3 group$i");
$t->setForceVisitDateTime($dateTime);
$t->setUrl("http://example.com/page/$i/$j");
$t->doTrackPageView("Page $i $j");
}
}
}
self::checkBulkTrackingResponse($t->doBulkTrack());
}
}
|
