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
|
<?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\Tracker;
use Piwik\Config;
use Piwik\Container\StaticContainer;
use Piwik\Date;
use Piwik\Tracker;
use Piwik\DeviceDetector\DeviceDetectorFactory;
use Piwik\SettingsPiwik;
class Settings // TODO: merge w/ visitor recognizer or make it it's own service. the class name is required for BC.
{
public const OS_BOT = 'BOT';
/**
* If `true`, the config ID for a visitor will be the same no matter what site is being tracked.
* If `false, the config ID will be different.
*
* @var bool
*/
private $isSameFingerprintsAcrossWebsites;
public function __construct($isSameFingerprintsAcrossWebsites)
{
$this->isSameFingerprintsAcrossWebsites = $isSameFingerprintsAcrossWebsites;
}
public function getConfigId(Request $request, $ipAddress): string
{
list($plugin_Flash, $plugin_Java, $plugin_Quicktime, $plugin_RealPlayer, $plugin_PDF,
$plugin_WindowsMedia, $plugin_Silverlight, $plugin_Cookie) = $request->getPlugins();
$userAgent = $request->getUserAgent();
$deviceDetector = StaticContainer::get(DeviceDetectorFactory::class)->makeInstance($userAgent, $request->getClientHints());
$aBrowserInfo = $deviceDetector->getClient();
if (empty($aBrowserInfo['type']) || 'browser' !== $aBrowserInfo['type']) {
// for now only track browsers
unset($aBrowserInfo);
}
$browserName = !empty($aBrowserInfo['short_name']) ? $aBrowserInfo['short_name'] : 'UNK';
$browserVersion = !empty($aBrowserInfo['version']) ? $aBrowserInfo['version'] : '';
if ($deviceDetector->isBot()) {
$os = self::OS_BOT;
} else {
$os = $deviceDetector->getOS();
$os = empty($os['short_name']) ? 'UNK' : $os['short_name'];
}
$client = $deviceDetector->getClient();
if (!empty($client['name']) && $client['name'] === 'Internet Explorer') {
// we assume cookies are disabled... when in tracker cookies are disabled, this ensures when upgrading to this version
// that no fingerprint changes in the 30min window during the upgrade...
// We don't include it anymore as it otherwise may cause new visits to be created when switching between
// cookies disabled and enabled in IE11 or older. Before Matomo 3.13.7 when cookies were disabled, then
// this value was set to 0. For people with cookies enabled the fingerprint is not as relevant as the visitorId
// is used to identify a visitor
$plugin_Cookie = '0';
}
$browserLang = substr($request->getBrowserLanguage(), 0, 20); // limit the length of this string to match db
$trackerConfig = Config::getInstance()->Tracker;
$fingerprintSalt = '';
// fingerprint salt won't work when across multiple sites since all sites could have different timezones
// also cant add fingerprint salt for a specific day when we dont create new visit after midnight
if (!$this->isSameFingerprintsAcrossWebsites && !empty($trackerConfig['create_new_visit_after_midnight'])) {
$cache = Cache::getCacheWebsiteAttributes($request->getIdSite());
$date = Date::factory((int) $request->getCurrentTimestamp());
$fingerprintSaltKey = new FingerprintSalt();
$dateString = $fingerprintSaltKey->getDateString($date, $cache['timezone']);
if (!empty($cache[FingerprintSalt::OPTION_PREFIX . $dateString])) {
$fingerprintSalt = $cache[FingerprintSalt::OPTION_PREFIX . $dateString];
} else {
// we query the DB directly for requests older than 2-3 days...
$fingerprintSalt = $fingerprintSaltKey->getSalt($dateString, $request->getIdSite());
}
$fingerprintSalt .= $dateString;
if (defined('PIWIK_TEST_MODE') && PIWIK_TEST_MODE) {
$fingerprintSalt = ''; // use fixed value so they don't change randomly in tests
}
}
return $this->getConfigHash(
$request,
$os,
$browserName,
$browserVersion,
$plugin_Flash,
$plugin_Java,
$plugin_Quicktime,
$plugin_RealPlayer,
$plugin_PDF,
$plugin_WindowsMedia,
$plugin_Silverlight,
$plugin_Cookie,
$ipAddress,
$browserLang,
$fingerprintSalt
);
}
public function getRandomConfigId(): string
{
return $this->getRandomConfigHash();
}
/**
* Returns a 64-bit hash that attempts to identify a user.
* Maintaining some privacy by default, eg. prevents the merging of several Piwik serve together for matching across instances..
*
* @param $os
* @param $browserName
* @param $browserVersion
* @param $plugin_Flash
* @param $plugin_Java
* @param $plugin_Quicktime
* @param $plugin_RealPlayer
* @param $plugin_PDF
* @param $plugin_WindowsMedia
* @param $plugin_Silverlight
* @param $plugin_Cookie
* @param $ip
* @param $browserLang
* @param $fingerprintHash
*/
protected function getConfigHash(
Request $request,
$os,
$browserName,
$browserVersion,
$plugin_Flash,
$plugin_Java,
$plugin_Quicktime,
$plugin_RealPlayer,
$plugin_PDF,
$plugin_WindowsMedia,
$plugin_Silverlight,
$plugin_Cookie,
$ip,
$browserLang,
$fingerprintHash
): string {
// prevent the config hash from being the same, across different Piwik instances
// (limits ability of different Piwik instances to cross-match users)
$salt = SettingsPiwik::getSalt();
$configString =
$os
. $browserName . $browserVersion
. $plugin_Flash . $plugin_Java . '0' . $plugin_Quicktime . $plugin_RealPlayer . $plugin_PDF
. $plugin_WindowsMedia . '0' . $plugin_Silverlight . $plugin_Cookie
. $ip
. $browserLang
. $salt
. $fingerprintHash;
if (!$this->isSameFingerprintsAcrossWebsites) {
$configString .= $request->getIdSite();
}
return $this->createHashOfConfigString($configString);
}
protected function getRandomConfigHash(): string
{
return $this->createHashOfConfigString(random_bytes(64));
}
private function createHashOfConfigString(string $configString): string
{
$hash = md5($configString, $raw_output = true);
return substr($hash, 0, Tracker::LENGTH_BINARY_ID);
}
}
|
