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
|
<?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_Plugins
* @package Piwik_UserCountry
*/
/**
* Return the flag image path for a given country
*
* @param string $code ISO country code
* @return string Flag image path
*/
function Piwik_getFlagFromCode($code)
{
$pathInPiwik = 'plugins/UserCountry/images/flags/%s.png';
$pathWithCode = sprintf($pathInPiwik, $code);
$absolutePath = PIWIK_INCLUDE_PATH . '/' . $pathWithCode;
if (file_exists($absolutePath)) {
return $pathWithCode;
}
return sprintf($pathInPiwik, Piwik_Tracker_Visit::UNKNOWN_CODE);
}
/**
* Returns the translated continent name for a given continent code
*
* @param string $label Continent code
* @return string Continent name
*/
function Piwik_ContinentTranslate($label)
{
if ($label == 'unk' || $label == '') {
return Piwik_Translate('General_Unknown');
}
return Piwik_Translate('UserCountry_continent_' . $label);
}
/**
* Returns the translated country name for a given country code
*
* @param string $label country code
* @return string Country name
*/
function Piwik_CountryTranslate($label)
{
if ($label == Piwik_Tracker_Visit::UNKNOWN_CODE || $label == '') {
return Piwik_Translate('General_Unknown');
}
return Piwik_Translate('UserCountry_country_' . $label);
}
/**
* Splits a label by a certain separator and returns the N-th element.
*
* @param string $label
* @param string $separator eg. ',' or '|'
* @param int $index The element index to extract.
* @param mixed $emptyValue The value to remove if the element is absent. Defaults to false,
* so no new metadata/column is added.
* @return string|false Returns false if $label == DataTable::LABEL_SUMMARY_ROW, otherwise
* explode($separator, $label)[$index].
*/
function Piwik_UserCountry_getElementFromStringArray($label, $separator, $index, $emptyValue = false)
{
if ($label == Piwik_DataTable::LABEL_SUMMARY_ROW) {
return false; // so no metadata/column is added
}
$segments = explode($separator, $label);
return empty($segments[$index]) ? $emptyValue : $segments[$index];
}
/**
* Returns the region name using the label of a Visits by Region report.
*
* @param string $label A label containing a region code followed by '|' and a country code, eg,
* 'P3|GB'.
* @return string|false The region name or false if $label == Piwik_DataTable::LABEL_SUMMARY_ROW.
*/
function Piwik_UserCountry_getRegionName($label)
{
if ($label == Piwik_DataTable::LABEL_SUMMARY_ROW) {
return false; // so no metadata/column is added
}
if ($label == '') {
return Piwik_Translate('General_Unknown');
}
list($regionCode, $countryCode) = explode(Piwik_UserCountry_Archiver::LOCATION_SEPARATOR, $label);
return Piwik_UserCountry_LocationProvider_GeoIp::getRegionNameFromCodes($countryCode, $regionCode);
}
/**
* Returns the name of a region + the name of the region's country using the label of
* a Visits by Region report.
*
* @param string $label A label containing a region code followed by '|' and a country code, eg,
* 'P3|GB'.
* @return string|false eg. 'Ile de France, France' or false if $label == Piwik_DataTable::LABEL_SUMMARY_ROW.
*/
function Piwik_UserCountry_getPrettyRegionName($label)
{
if ($label == Piwik_DataTable::LABEL_SUMMARY_ROW) {
return $label;
}
if ($label == '') {
return Piwik_Translate('General_Unknown');
}
list($regionCode, $countryCode) = explode(Piwik_UserCountry_Archiver::LOCATION_SEPARATOR, $label);
$result = Piwik_UserCountry_LocationProvider_GeoIp::getRegionNameFromCodes($countryCode, $regionCode);
if ($countryCode != Piwik_Tracker_Visit::UNKNOWN_CODE && $countryCode != '') {
$result .= ', ' . Piwik_CountryTranslate($countryCode);
}
return $result;
}
/**
* Returns the name of a city + the name of its region + the name of its country using
* the label of a Visits by City report.
*
* @param string $label A label containing a city name, region code + country code,
* separated by two '|' chars: 'Paris|A8|FR'
* @return string|false eg. 'Paris, Ile de France, France' or false if $label ==
* Piwik_DataTable::LABEL_SUMMARY_ROW.
*/
function Piwik_UserCountry_getPrettyCityName($label)
{
if ($label == Piwik_DataTable::LABEL_SUMMARY_ROW) {
return $label;
}
if ($label == '') {
return Piwik_Translate('General_Unknown');
}
// get city name, region code & country code
$parts = explode(Piwik_UserCountry_Archiver::LOCATION_SEPARATOR, $label);
$cityName = $parts[0];
$regionCode = $parts[1];
$countryCode = $parts[2];
if ($cityName == Piwik_Tracker_Visit::UNKNOWN_CODE || $cityName == '') {
$cityName = Piwik_Translate('General_Unknown');
}
$result = $cityName;
if ($countryCode != Piwik_Tracker_Visit::UNKNOWN_CODE && $countryCode != '') {
if ($regionCode != '' && $regionCode != Piwik_Tracker_Visit::UNKNOWN_CODE) {
$regionName = Piwik_UserCountry_LocationProvider_GeoIp::getRegionNameFromCodes($countryCode, $regionCode);
$result .= ', ' . $regionName;
}
$result .= ', ' . Piwik_CountryTranslate($countryCode);
}
return $result;
}
|
