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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
|
<?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\Tests\Integration\Tracker;
use Piwik\Cache;
use Piwik\Container\StaticContainer;
use Piwik\Date;
use Matomo\Network\IPUtils;
use Piwik\Plugin\Manager;
use Piwik\Plugins\SitesManager\API;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\Mock\FakeAccess;
use Piwik\Tests\Framework\Mock\Tracker\RequestAuthenticated;
use Piwik\Tracker\Request;
use Piwik\Tracker\Visit;
use Piwik\Tracker\VisitExcluded;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
/**
* @group Core
*/
class VisitTest extends IntegrationTestCase
{
public function setUp(): void
{
parent::setUp();
// setup the access layer
FakeAccess::$superUser = true;
Fixture::createSuperUser(true);
Manager::getInstance()->loadTrackerPlugins();
$pluginNames = array_keys(Manager::getInstance()->getLoadedPlugins());
$pluginNames[] = 'SitesManager';
$pluginNames[] = 'WebsiteMeasurable';
$pluginNames[] = 'TagManager';// needed because we create a site in Tracker mode...
$pluginNames[] = 'API'; // needed because we create a site in Tracker mode...
Manager::getInstance()->loadPlugins($pluginNames);
Visit::$dimensions = null;
}
/**
* Dataprovider
*/
public function getExcludedIpTestData()
{
return array(
array('12.12.12.12', array(
'12.12.12.12' => true,
'12.12.12.11' => false,
'12.12.12.13' => false,
'0.0.0.0' => false,
'255.255.255.255' => false
)),
array('12.12.12.12/32', array(
'12.12.12.12' => true,
'12.12.12.11' => false,
'12.12.12.13' => false,
'0.0.0.0' => false,
'255.255.255.255' => false
)),
array('12.12.12.*', array(
'12.12.12.0' => true,
'12.12.12.255' => true,
'12.12.12.12' => true,
'12.12.11.255' => false,
'12.12.13.0' => false,
'0.0.0.0' => false,
'255.255.255.255' => false,
)),
array('12.12.12.0/24', array(
'12.12.12.0' => true,
'12.12.12.255' => true,
'12.12.12.12' => true,
'12.12.11.255' => false,
'12.12.13.0' => false,
'0.0.0.0' => false,
'255.255.255.255' => false,
)),
// add some ipv6 addresses!
);
}
public function test_worksWhenSiteDoesNotExist()
{
$request = new RequestAuthenticated(array('idsite' => 99999999, 'rec' => 1));
$excluded = new VisitExcluded($request);
$this->assertSame(false, $excluded->isExcluded());
}
/**
* @dataProvider getExcludedIpTestData
*/
public function testIsVisitorIpExcluded($excludedIp, $tests)
{
$idsite = API::getInstance()->addSite("name", "http://piwik.net/", $ecommerce = 0,
$siteSearch = 1, $searchKeywordParameters = null, $searchCategoryParameters = null, $excludedIp);
$request = new RequestAuthenticated(array('idsite' => $idsite));
// test that IPs within the range, or the given IP, are excluded
foreach ($tests as $ip => $expected) {
$request->setParam('cip', $ip);
$excluded = new VisitExcluded_public($request);
$this->assertSame($expected, $excluded->public_isVisitorIpExcluded($ip));
}
}
public function getExcludeByUrlData()
{
return array(
array(array('http://test.com'), true, array(
'http://test.com' => true,
'https://test.com' => true,
'http://test.com/uri' => true,
'http://test.com/?query' => true,
'http://xtest.com' => false,
)),
array(array('http://test.com', 'http://localhost'), true, array(
'http://test.com' => true,
'http://localhost' => true,
'http://x.com' => false,
)),
array(array('http://test.com'), false, array(
'http://x.com' => true,
)),
array(array('http://test.com', 'http://sub.test2.com'), true, array(
'http://sub.test.com' => false, // we do not match subdomains
'http://sub.sub.test.com' => false,
'http://subtest.com' => false,
'http://test.com.org' => false,
'http://test2.com' => false,
'http://sub.test2.com' => true,
'http://test.com' => true,
'http://x.sub.test2.com' => false,
'http://xsub.test2.com' => false,
'http://sub.test2.com.org' => false,
)),
array(array('http://test.com/path', 'http://test2.com/sub/dir'), true, array(
'http://test.com/path' => true, // test matching path
'http://test.com/path/' => true,
'http://test.com/path/test' => true,
'http://test.com/path1' => false,
'http://test.com/' => false,
'http://test.com' => false,
'http://test.com/foo' => false,
'http://sub.test.com/path' => false, // we still do not match subdomains
'http://test2.com/sub/dir' => true,
'http://test2.com/sub/dir/' => true,
'http://test2.com/sub/dir/test' => true,
'http://test2.com/sub/foo/' => false,
'http://test2.com/sub/' => false,
'http://test2.com/' => false,
'http://test2.com/dir/sub' => false,
)),
);
}
/**
* @dataProvider getExcludeByUrlData
*/
public function testExcludeByUrl($siteUrls, $excludeUnknownUrls, array $urlsTracked)
{
$siteId = API::getInstance()->addSite('name', $siteUrls, $ecommerce = null, $siteSearch = null, $searchKeywordParameters = null, $searchCategoryParameters = null, null, null, null, null, null, null, null, null, null, null, $excludeUnknownUrls);
foreach ($urlsTracked as $url => $isTracked) {
$visitExclude = new VisitExcluded(new Request(array(
'idsite' => $siteId,
'rec' => 1,
'url' => $url
)));
$this->assertEquals($isTracked, !$visitExclude->isExcluded(), $url . ' is not returning expected result');
}
}
/**
* @dataProvider getChromeDataSaverData
*/
public function testVisitShouldNotBeExcluded_IfMadeViaChromeDataSaverCompressionProxy($ip, $isNonHumanBot)
{
$idsite = API::getInstance()->addSite("name", "http://piwik.net/", $ecommerce = 0,
$siteSearch = 1, $searchKeywordParameters = null, $searchCategoryParameters = null);
$request = new RequestAuthenticated(array('idsite' => $idsite, 'cip' => $ip));
$_SERVER['HTTP_VIA'] = '1.1 Chrome-Compression-Proxy';
$excluded = new VisitExcluded_public($request);
$isBot = $excluded->public_isNonHumanBot();
unset($_SERVER['HTTP_VIA']);
$this->assertSame($isNonHumanBot, $isBot);
}
public function getChromeDataSaverData()
{
return array(
array('216.239.32.0', $isNonHumanBot = false), // false because google ips
array('66.249.93.251', $isNonHumanBot = false),
array('173.194.0.1', $isNonHumanBot = false),
array('72.30.198.1', $isNonHumanBot = true), // not a google bot, a yahoo bot
array('64.4.0.1', $isNonHumanBot = true), // a MSN bot
);
}
/**
* Dataprovider for testIsVisitorUserAgentExcluded.
*/
public function getExcludedUserAgentTestData()
{
return array(
array('', array(
'whatever' => false,
'' => false,
'nlksdjfsldkjfsa' => false,
)),
array('mozilla', array(
'this has mozilla in it' => true,
'this doesn\'t' => false,
'partial presence: mozi' => false,
)),
array('cHrOmE,notinthere,&^%', array(
'chrome is here' => true,
'CHROME is here' => true,
'12&^%345' => true,
'sfasdf' => false,
)),
);
}
/**
* @dataProvider getExcludedUserAgentTestData
*/
public function testIsVisitorUserAgentExcluded($excludedUserAgent, $tests)
{
$idsite = API::getInstance()->addSite("name", "http://piwik.net/", $ecommerce = 0,
$siteSearch = 1, $searchKeywordParameters = null, $searchCategoryParameters = null, $excludedIp = null,
$excludedQueryParameters = null, $timezone = null, $currency = null, $group = null, $startDate = null,
$excludedUserAgent);
$request = new Request(array('idsite' => $idsite));
// test that user agents that contain excluded user agent strings are excluded
foreach ($tests as $ua => $expected) {
$request->setParam('ua', $ua);
$excluded = new VisitExcluded_public($request);
$this->assertSame($expected, $excluded->public_isUserAgentExcluded(), "Result if isUserAgentExcluded('$ua') was not " . ($expected ? 'true' : 'false') . ".");
}
}
/**
* @group referrerIsKnownSpam
*/
public function testIsVisitor_referrerIsKnownSpam()
{
$knownSpammers = array(
'http://semalt.com' => true,
'http://semalt.com/random/sub/page' => true,
'http://semalt.com/out/of/here?mate' => true,
'http://buttons-for-website.com/out/of/here?mate' => true,
'https://buttons-for-website.com' => true,
'https://make-money-online.7makemoneyonline.com' => true,
'https://7makemoneyonline.com' => true,
'http://valid.domain/' => false,
'http://valid.domain/page' => false,
'https://valid.domain/page' => false,
);
$idsite = API::getInstance()->addSite("name", "http://piwik.net/");
// test that user agents that contain excluded user agent strings are excluded
foreach ($knownSpammers as $spamUrl => $expectedIsReferrerSpam) {
$spamUrl = urlencode($spamUrl);
$request = new Request(array(
'idsite' => $idsite,
'urlref' => $spamUrl
));
$excluded = new VisitExcluded_public($request);
$this->assertSame($expectedIsReferrerSpam, $excluded->public_isReferrerSpamExcluded(), $spamUrl);
}
}
/**
* @group IpIsKnownBot
*/
public function testIsVisitor_ipIsKnownBot()
{
$isIpBot = array(
// Source: http://forum.piwik.org/read.php?3,108926
'66.249.85.36' => true,
'66.249.91.150' => true,
'64.233.172.1' => true,
'64.233.172.200' => true,
'66.249.88.216' => true,
'66.249.83.204' => true,
'64.233.172.6' => true,
// ddos bot
'1.202.218.8' => true,
// Not bots
'66.248.91.150' => false,
'66.250.91.150' => false,
// almost google range but not google
'66.249.2.1' => false,
'66.249.60.1' => false,
);
$idsite = API::getInstance()->addSite("name", "http://piwik.net/");
$request = new RequestAuthenticated(array('idsite' => $idsite, 'bots' => 0));
foreach ($isIpBot as $ip => $isBot) {
$request->setParam('cip', $ip);
$excluded = new VisitExcluded_public($request);
$this->assertSame($isBot, $excluded->public_isNonHumanBot(), $ip);
}
}
/**
* @group UserAgentIsKnownBot
*/
public function testIsVisitor_userAgentIsKnownBot()
{
$isUserAgentBot = array(
'baiduspider' => true,
'bingbot' => true,
'BINGBOT' => true,
'x BingBot x' => true,
'BingPreview' => true,
'facebookexternalhit' => true,
'YottaaMonitor' => true,
'Mozilla/5.0 (compatible; CloudFlare-AlwaysOnline/1.0; +http://www.cloudflare.com/always-online) XXXX' => true,
'Pingdom.com_bot_version_1.4_(http://www.pingdom.com/)' => true,
'Mozilla/5.0 (compatible; YandexBot/3.0; +http://yandex.com/bots)' => true,
'Exabot/2.0' => true,
'sogou spider' => true,
'Mozilla/5.0(compatible;Sosospider/2.0;+http://help.soso.com/webspider.htm)' => true,
'AdsBot-Google (+http://www.google.com/adsbot.html)' => true,
'Google Page Speed Insights' => true,
// Web snippets
'Mozilla/5.0 (Windows NT 6.1; rv:6.0) Gecko/20110814 Firefox/6.0 Google (+https://developers.google.com/+/web/snippet/)' => true,
// Google Web Preview
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/534.51 (KHTML, like Gecko; Google Web Preview) Chrome/12.0.742 Safari/534.51' => true,
'Googlebot-Video/1.0' => true,
'Googlebot' => true,
'random' => false,
'hello world' => false,
'this is a user agent' => false,
'Mozilla' => false,
);
$idsite = API::getInstance()->addSite("name", "http://piwik.net/");
foreach ($isUserAgentBot as $userAgent => $isBot) {
$request = new Request(array(
'idsite' => $idsite,
'bots' => 0,
'ua' => $userAgent,
));
$excluded = new VisitExcluded_public($request);
$this->assertSame($isBot, $excluded->public_isNonHumanBot(), $userAgent);
}
}
public function test_markArchivedReportsAsInvalidIfArchiveAlreadyFinished_ShouldRemember_IfRequestWasDoneLongAgo()
{
$currentActionTime = '2012-01-02 08:12:45';
$idsite = API::getInstance()->addSite('name', 'http://piwik.net/');
$expectedRemembered = array('2012-01-02' => array($idsite));
$this->assertRememberedArchivedReportsThatShouldBeInvalidated($idsite, $currentActionTime, $expectedRemembered);
}
public function test_markArchivedReportsAsInvalidIfArchiveAlreadyFinished_ShouldNotRemember_IfRequestWasDoneJustAtStartOfTheDay()
{
$currentActionTime = Date::today()->getDatetime();
$idsite = API::getInstance()->addSite('name', 'http://piwik.net/');
$expectedRemembered = array();
$this->assertRememberedArchivedReportsThatShouldBeInvalidated($idsite, $currentActionTime, $expectedRemembered);
}
public function test_markArchivedReportsAsInvalidIfArchiveAlreadyFinished_ShouldRemember_IfRequestWasDoneAt11PMTheDayBefore()
{
$currentActionTime = Date::today()->subHour(1)->getDatetime();
$idsite = API::getInstance()->addSite('name', 'http://piwik.net/');
$expectedRemembered = array(
substr($currentActionTime, 0, 10) => array($idsite)
);
$this->assertRememberedArchivedReportsThatShouldBeInvalidated($idsite, $currentActionTime, $expectedRemembered);
}
public function test_markArchivedReportsAsInvalidIfArchiveAlreadyFinished_shouldConsiderWebsitesTimezone()
{
// The double-handling below is needed to work around weird behaviour when UTC and UTC+5 are different dates
// Example: 4:32am on 1 April in UTC+5 is 11:32pm on 31 March in UTC
$midnight = Date::factoryInTimezone('today', 'UTC+5')->setTimezone('UTC+5');
$oneHourAfterMidnight = $midnight->addHour(1)->getDatetime();
$oneHourBeforeMidnight = $midnight->subHour(1)->getDatetime();
$idsite = API::getInstance()->addSite('name', 'http://piwik.net/', $ecommerce = null,
$siteSearch = null,
$searchKeywordParameters = null,
$searchCategoryParameters = null,
$excludedIps = null,
$excludedQueryParameters = null,
$timezone = 'UTC+5');
$expectedRemembered = array(
substr($oneHourAfterMidnight, 0, 10) => array($idsite),
);
// if website timezone was von considered both would be today (expected = array())
$this->assertRememberedArchivedReportsThatShouldBeInvalidated($idsite, $oneHourAfterMidnight, array());
$this->assertRememberedArchivedReportsThatShouldBeInvalidated($idsite, $oneHourBeforeMidnight, $expectedRemembered);
}
private function assertRememberedArchivedReportsThatShouldBeInvalidated($idsite, $requestDate, $expectedRemeberedArchivedReports)
{
/** @var Visit $visit */
list($visit) = $this->prepareVisitWithRequest(array(
'idsite' => $idsite,
'rec' => 1,
'cip' => '156.146.156.146',
'token_auth' => Fixture::getTokenAuth()
), $requestDate);
$visit->handle();
$archive = StaticContainer::get('Piwik\Archive\ArchiveInvalidator');
$remembered = $archive->getRememberedArchivedReportsThatShouldBeInvalidated();
$this->assertSameReportsInvalidated($expectedRemeberedArchivedReports, $remembered);
}
private function assertSameReportsInvalidated($expected, $actual)
{
$keys1 = array_keys($expected);
$keys2 = array_keys($actual);
sort($keys1);
sort($keys2);
$this->assertSame($keys1, $keys2);
foreach ($expected as $index => $values) {
sort($values);
sort($actual[$index]);
$this->assertSame($values, $actual[$index]);
}
}
private function prepareVisitWithRequest($requestParams, $requestDate)
{
$request = new Request($requestParams);
$request->setCurrentTimestamp(Date::factory($requestDate)->getTimestamp());
$visit = new Visit();
$visit->setRequest($request);
$visit->handle();
return array($visit, $request);
}
public function provideContainerConfig()
{
return array(
'Piwik\Access' => new FakeAccess()
);
}
}
class VisitExcluded_public extends VisitExcluded
{
public function public_isVisitorIpExcluded($ip)
{
return $this->isVisitorIpExcluded($ip);
}
public function public_isUserAgentExcluded()
{
return $this->isUserAgentExcluded();
}
public function public_isReferrerSpamExcluded()
{
return $this->isReferrerSpamExcluded();
}
public function public_isNonHumanBot()
{
return $this->isNonHumanBot();
}
}
|