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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @category Piwik
* @package Piwik
*/
use Piwik\Common;
use Piwik\IP;
/**
* This class contains the logic to exclude some visitors from being tracked as per user settings
*/
class Piwik_Tracker_VisitExcluded
{
public function __construct(Piwik_Tracker_Request $request, $ip = false, $userAgent = false)
{
if ($ip === false) {
$ip = $request->getIp();
}
if ($userAgent === false) {
$userAgent = $request->getUserAgent();
}
$this->request = $request;
$this->idSite = $request->getIdSite();
$this->userAgent = $userAgent;
$this->ip = $ip;
}
/**
* 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.");
}
}
/* custom filters can override the built-in filters above */
Piwik_PostEvent('Tracker.Visit.isExcluded', array(&$excluded));
/*
* 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.");
}
}
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).
*
* @return boolean
*/
protected function isNonHumanBot()
{
$allowBots = Common::getRequestVar('bots', false) != false;
return !$allowBots
&& (strpos($this->userAgent, 'Googlebot') !== false // Googlebot
|| strpos($this->userAgent, 'Google Web Preview') !== false // Google Instant
|| strpos($this->userAgent, 'Google Page Speed Insights') !== false // #4049
|| strpos($this->userAgent, 'bingbot') !== false // Bingbot
|| strpos($this->userAgent, 'YottaaMonitor') !== false // Yottaa
|| IP::isIpInRange($this->ip, $this->getBotIpRanges()));
}
protected function getBotIpRanges()
{
return 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'
);
}
/**
* Looks for the ignore cookie that users can set in the Piwik admin screen.
* @return bool
*/
protected function isIgnoreCookieFound()
{
if (Piwik_Tracker_IgnoreCookie::isIgnoreCookieFound()) {
Common::printDebug('Piwik 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()
{
$websiteAttributes = Piwik_Tracker_Cache::getCacheWebsiteAttributes($this->idSite);
if (!empty($websiteAttributes['excluded_ips'])) {
if (IP::isIpInRange($this->ip, $websiteAttributes['excluded_ips'])) {
Common::printDebug('Visitor IP ' . IP::N2P($this->ip) . ' is excluded from being tracked');
return true;
}
}
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()
{
$websiteAttributes = Piwik_Tracker_Cache::getCacheWebsiteAttributes($this->idSite);
if (!empty($websiteAttributes['excluded_user_agents'])) {
foreach ($websiteAttributes['excluded_user_agents'] 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;
}
}
|
