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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Tracker;
use Piwik\Cache as PiwikCache;
use Piwik\Common;
use Piwik\Container\StaticContainer;
use Piwik\DeviceDetector\DeviceDetectorFactory;
use Piwik\Exception\UnexpectedWebsiteFoundException;
use Matomo\Network\IP;
use Piwik\Piwik;
use Piwik\Plugins\SitesManager\SiteUrls;
use Piwik\Tracker\Visit\ReferrerSpamFilter;
use Piwik\Config;
/**
* This class contains the logic to exclude some visitors from being tracked as per user settings
*/
class VisitExcluded
{
/**
* @var ReferrerSpamFilter
*/
private $spamFilter;
private $siteCache = array();
/**
* @param Request $request
*/
public function __construct(Request $request)
{
$this->spamFilter = new ReferrerSpamFilter();
$this->request = $request;
try {
$this->idSite = $request->getIdSite();
} catch (UnexpectedWebsiteFoundException $e){
// most checks will still work on a global scope and we still want to be able to test if this is a valid
// visit or not
$this->idSite = 0;
}
$userAgent = $request->getUserAgent();
$this->userAgent = Common::unsanitizeInputValue($userAgent);
$this->ip = $request->getIp();
}
/**
* Test if the current visitor is excluded from the statistics.
*
* Plugins can for example exclude visitors based on the
* - IP
* - If a given cookie is found
*
* @return bool True if the visit must not be saved, false otherwise
*/
public function isExcluded()
{
$excluded = false;
if ($this->isNonHumanBot()) {
Common::printDebug('Search bot detected, visit excluded');
$excluded = true;
}
/*
* Requests built with piwik.js will contain a rec=1 parameter. This is used as
* an indication that the request is made by a JS enabled device. By default, Piwik
* doesn't track non-JS visitors.
*/
if (!$excluded) {
$toRecord = $this->request->getParam($parameterForceRecord = 'rec');
if (!$toRecord) {
Common::printDebug(@$_SERVER['REQUEST_METHOD'] . ' parameter ' . $parameterForceRecord . ' not found in URL, request excluded');
$excluded = true;
Common::printDebug("'$parameterForceRecord' parameter not found.");
}
}
/**
* Triggered on every tracking request.
*
* This event can be used to tell the Tracker not to record this particular action or visit.
*
* @param bool &$excluded Whether the request should be excluded or not. Initialized
* to `false`. Event subscribers should set it to `true` in
* order to exclude the request.
* @param Request $request The request object which contains all of the request's information
*
*/
Piwik::postEvent('Tracker.isExcludedVisit', array(&$excluded, $this->request));
/*
* Following exclude operations happen after the hook.
* These are of higher priority and should not be overwritten by plugins.
*/
// Checking if the Piwik ignore cookie is set
if (!$excluded) {
$excluded = $this->isIgnoreCookieFound();
if ($excluded) {
Common::printDebug("Ignore cookie found.");
}
}
// Checking for excluded IPs
if (!$excluded) {
$excluded = $this->isVisitorIpExcluded();
if ($excluded) {
Common::printDebug("IP excluded.");
}
}
// Check if user agent should be excluded
if (!$excluded) {
$excluded = $this->isUserAgentExcluded();
if ($excluded) {
Common::printDebug("User agent excluded.");
}
}
// Check if Referrer URL is a known spam
$generalConfig = Config::getInstance()->Tracker;
if ($generalConfig['enable_spam_filter']) {
if (!$excluded) {
$excluded = $this->isReferrerSpamExcluded();
if ($excluded) {
Common::printDebug("Referrer URL is blacklisted as spam.");
}
}
} else {
Common::printDebug("Spam blacklist is disabled.");
}
// Check if request URL is excluded
if (!$excluded) {
$excluded = $this->isUrlExcluded();
if ($excluded) {
Common::printDebug("Unknown URL is not allowed to track.");
}
}
if (!$excluded) {
if ($this->isPrefetchDetected()) {
$excluded = true;
Common::printDebug("Prefetch request detected, not a real visit so we Ignore this visit/pageview");
}
}
if ($excluded) {
Common::printDebug("Visitor excluded.");
return true;
}
return false;
}
protected function isPrefetchDetected()
{
return (isset($_SERVER["HTTP_X_PURPOSE"])
&& in_array($_SERVER["HTTP_X_PURPOSE"], array("preview", "instant")))
|| (isset($_SERVER['HTTP_X_MOZ'])
&& $_SERVER['HTTP_X_MOZ'] == "prefetch");
}
/**
* Live/Bing/MSN bot and Googlebot are evolving to detect cloaked websites.
* As a result, these sophisticated bots exhibit characteristics of
* browsers (cookies enabled, executing JavaScript, etc).
*
* @see \DeviceDetector\Parser\Bot
*
* @return boolean
*/
protected function isNonHumanBot()
{
$allowBots = $this->request->getParam('bots');
$deviceDetector = StaticContainer::get(DeviceDetectorFactory::class)->makeInstance($this->userAgent );
return !$allowBots
&& ($deviceDetector->isBot() || $this->isIpInRange());
}
private function isIpInRange()
{
$cache = PiwikCache::getTransientCache();
$ip = IP::fromBinaryIP($this->ip);
$key = 'VisitExcludedIsIpInRange' . $ip->toString();
if ($cache->contains($key)) {
$isInRanges = $cache->fetch($key);
} else {
if ($this->isChromeDataSaverUsed($ip)) {
$isInRanges = false;
} else {
$isInRanges = $ip->isInRanges($this->getBotIpRanges());
}
$cache->save($key, $isInRanges);
}
return $isInRanges;
}
private function isChromeDataSaverUsed(IP $ip)
{
// see https://github.com/piwik/piwik/issues/7733
return !empty($_SERVER['HTTP_VIA'])
&& false !== strpos(strtolower($_SERVER['HTTP_VIA']), 'chrome-compression-proxy')
&& $ip->isInRanges($this->getGoogleBotIpRanges());
}
protected function getBotIpRanges()
{
return array_merge($this->getGoogleBotIpRanges(), array(
// Live/Bing/MSN
'64.4.0.0/18',
'65.52.0.0/14',
'157.54.0.0/15',
'157.56.0.0/14',
'157.60.0.0/16',
'207.46.0.0/16',
'207.68.128.0/18',
'207.68.192.0/20',
'131.253.26.0/20',
'131.253.24.0/20',
// Yahoo
'72.30.198.0/20',
'72.30.196.0/20',
'98.137.207.0/20',
// Chinese bot hammering websites
'1.202.218.8'
));
}
private function getGoogleBotIpRanges()
{
return array(
'216.239.32.0/19',
'64.233.160.0/19',
'66.249.80.0/20',
'72.14.192.0/18',
'209.85.128.0/17',
'66.102.0.0/20',
'74.125.0.0/16',
'64.18.0.0/20',
'207.126.144.0/20',
'173.194.0.0/16'
);
}
/**
* Looks for the ignore cookie that users can set in the Piwik admin screen.
* @return bool
*/
protected function isIgnoreCookieFound()
{
if (IgnoreCookie::isIgnoreCookieFound()) {
Common::printDebug('Matomo ignore cookie was found, visit not tracked.');
return true;
}
return false;
}
/**
* Checks if the visitor ip is in the excluded list
*
* @return bool
*/
protected function isVisitorIpExcluded()
{
$excludedIps = $this->getAttributes('excluded_ips', 'global_excluded_ips');
if (!empty($excludedIps)) {
$ip = IP::fromBinaryIP($this->ip);
if ($ip->isInRanges($excludedIps)) {
Common::printDebug('Visitor IP ' . $ip->toString() . ' is excluded from being tracked');
return true;
}
}
return false;
}
private function getAttributes($siteAttribute, $globalAttribute)
{
if (!isset($this->siteCache[$this->idSite])) {
$this->siteCache[$this->idSite] = array();
}
try {
if (empty($this->siteCache[$this->idSite])) {
$this->siteCache[$this->idSite] = Cache::getCacheWebsiteAttributes($this->idSite);
}
if (isset($this->siteCache[$this->idSite][$siteAttribute])) {
return $this->siteCache[$this->idSite][$siteAttribute];
}
} catch (UnexpectedWebsiteFoundException $e) {
$cached = Cache::getCacheGeneral();
if ($globalAttribute && isset($cached[$globalAttribute])) {
return $cached[$globalAttribute];
}
}
}
/**
* Checks if request URL is excluded
* @return bool
*/
protected function isUrlExcluded()
{
$excludedUrls = $this->getAttributes('exclude_unknown_urls', null);
$siteUrls = $this->getAttributes('urls', null);
if (!empty($excludedUrls) && !empty($siteUrls)) {
$url = $this->request->getParam('url');
$parsedUrl = parse_url($url);
$trackingUrl = new SiteUrls();
$urls = $trackingUrl->groupUrlsByHost(array($this->idSite => $siteUrls));
$idSites = $trackingUrl->getIdSitesMatchingUrl($parsedUrl, $urls);
$isUrlExcluded = !isset($idSites) || !in_array($this->idSite, $idSites);
return $isUrlExcluded;
}
return false;
}
/**
* Returns true if the specified user agent should be excluded for the current site or not.
*
* Visits whose user agent string contains one of the excluded_user_agents strings for the
* site being tracked (or one of the global strings) will be excluded.
*
* @internal param string $this ->userAgent The user agent string.
* @return bool
*/
protected function isUserAgentExcluded()
{
$excludedAgents = $this->getAttributes('excluded_user_agents', 'global_excluded_user_agents');
if (!empty($excludedAgents)) {
foreach ($excludedAgents as $excludedUserAgent) {
// if the excluded user agent string part is in this visit's user agent, this visit should be excluded
if (stripos($this->userAgent, $excludedUserAgent) !== false) {
return true;
}
}
}
return false;
}
/**
* Returns true if the Referrer is a known spammer.
*
* @return bool
*/
protected function isReferrerSpamExcluded()
{
return $this->spamFilter->isSpam($this->request);
}
}
|