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
|
<?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\UserCountry\LocationProvider;
use Matomo\Network\IP;
use Piwik\Common;
use Piwik\Config;
use Piwik\Container\StaticContainer;
use Piwik\Intl\Data\Provider\RegionDataProvider;
use Piwik\Piwik;
use Piwik\Plugin\Manager;
use Piwik\Plugins\PrivacyManager\Config as PrivacyManagerConfig;
use Piwik\Plugins\Provider\Provider as ProviderProvider;
use Piwik\Plugins\UserCountry\LocationProvider;
use Piwik\Tracker\TrackerConfig;
use Piwik\Url;
/**
* The default LocationProvider, this LocationProvider guesses a visitor's country
* using the language they use. This provider is not very accurate.
*
*/
class DefaultProvider extends LocationProvider
{
public const ID = 'default';
public const TITLE = 'General_Default';
/**
* Guesses a visitor's location using a visitor's browser language.
*
* @param array $info Contains 'ip' & 'lang' keys.
* @return array Contains the guessed country code mapped to LocationProvider::COUNTRY_CODE_KEY.
*/
public function getLocation($info)
{
$country = $this->getCountryUsingProviderExtensionIfAvailable($info['ip']);
if (empty($country)) {
$enableLanguageToCountryGuess = Config::getInstance()->Tracker['enable_language_to_country_guess'];
if (empty($info['lang'])) {
$info['lang'] = Common::getBrowserLanguage();
}
$country = Common::getCountry($info['lang'], $enableLanguageToCountryGuess, $info['ip']);
}
$location = [parent::COUNTRY_CODE_KEY => $country];
$this->completeLocationResult($location);
return $location;
}
private function getCountryUsingProviderExtensionIfAvailable($ipAddress)
{
if (
!Manager::getInstance()->isPluginInstalled('Provider')
|| !class_exists('Piwik\Plugins\Provider\Provider')
|| Common::getRequestVar('dp', 0, 'int') === 1
) {
return false;
}
$privacyConfig = new PrivacyManagerConfig();
// when using anonymized ip for enrichment we skip this check
if ($privacyConfig->useAnonymizedIpForVisitEnrichment) {
return false;
}
$hostname = $this->getHost($ipAddress);
$hostnameExtension = ProviderProvider::getCleanHostname($hostname);
$hostnameDomain = substr($hostnameExtension, 1 + strrpos($hostnameExtension, '.'));
if ($hostnameDomain == 'uk') {
$hostnameDomain = 'gb';
}
/** @var RegionDataProvider $regionDataProvider */
$regionDataProvider = StaticContainer::get('Piwik\Intl\Data\Provider\RegionDataProvider');
if (array_key_exists($hostnameDomain, $regionDataProvider->getCountryList())) {
return $hostnameDomain;
}
return false;
}
/**
* Returns the hostname given the IP address string
*
* @param string $ipStr IP Address
* @return string hostname (or human-readable IP address)
*/
protected function getHost($ipStr)
{
$ip = IP::fromStringIP($ipStr);
$host = $ip->getHostname();
$host = ($host === null ? $ipStr : $host);
return trim(strtolower($host));
}
/**
* Returns whether this location provider is available.
*
* @return bool
*/
public function isAvailable()
{
return !!TrackerConfig::getConfigValue('enable_default_location_provider');
}
/**
* Returns whether this location provider is visible.
*
* @return bool
*/
public function isVisible()
{
return !!TrackerConfig::getConfigValue('enable_default_location_provider');
}
/**
* Returns whether this location provider is working correctly.
*
* This implementation is always working correctly.
*
* @return bool always true
*/
public function isWorking()
{
return true;
}
/**
* Returns an array describing the types of location information this provider will
* return.
*
* This provider supports the following types of location info:
* - continent code
* - continent name
* - country code
* - country name
*
* @return array
*/
public function getSupportedLocationInfo()
{
return [self::CONTINENT_CODE_KEY => true,
self::CONTINENT_NAME_KEY => true,
self::COUNTRY_CODE_KEY => true,
self::COUNTRY_NAME_KEY => true];
}
/**
* Returns information about this location provider. Contains an id, title & description:
*
* array(
* 'id' => 'default',
* 'title' => '...',
* 'description' => '...'
* );
*
* @return array
*/
public function getInfo()
{
$desc = '<p>' . Piwik::translate('UserCountry_DefaultLocationProviderDesc1') . ' '
. Piwik::translate(
'UserCountry_DefaultLocationProviderDesc2',
['<strong>', '', '', '</strong>']
)
. '</p><p>' . Url::getExternalLinkTag('https://matomo.org/faq/how-to/faq_163')
. Piwik::translate('UserCountry_HowToInstallGeoIPDatabases')
. '</a></p>';
return ['id' => self::ID, 'title' => self::TITLE, 'description' => $desc, 'order' => 1];
}
public function getUsageWarning(): ?string
{
$comment = Piwik::translate('UserCountry_DefaultLocationProviderDesc1') . ' ';
$comment .= Piwik::translate('UserCountry_DefaultLocationProviderDesc2', [
Url::getExternalLinkTag('https://matomo.org/docs/geo-locate/'), '', '', '</a>',
]);
return $comment;
}
}
|
