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
|
<?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_UserSettings
*/
/**
* @see plugins/UserSettings/functions.php
*/
require_once PIWIK_INCLUDE_PATH . '/plugins/UserSettings/functions.php';
/**
* The UserSettings API lets you access reports about your Visitors technical settings: browsers, browser types (rendering engine),
* operating systems, plugins supported in their browser, Screen resolution and Screen types (normal, widescreen, dual screen or mobile).
*
* @package Piwik_UserSettings
*/
class Piwik_UserSettings_API
{
static private $instance = null;
static public function getInstance()
{
if (self::$instance == null)
{
self::$instance = new self;
}
return self::$instance;
}
protected function getDataTable($name, $idSite, $period, $date, $segment)
{
Piwik::checkUserHasViewAccess( $idSite );
$archive = Piwik_Archive::build($idSite, $period, $date, $segment );
$dataTable = $archive->getDataTable($name);
$dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS));
$dataTable->queueFilter('ReplaceColumnNames');
$dataTable->queueFilter('ReplaceSummaryRowLabel');
return $dataTable;
}
public function getResolution( $idSite, $period, $date, $segment = false )
{
$dataTable = $this->getDataTable('UserSettings_resolution', $idSite, $period, $date, $segment);
return $dataTable;
}
public function getConfiguration( $idSite, $period, $date, $segment = false )
{
$dataTable = $this->getDataTable('UserSettings_configuration', $idSite, $period, $date, $segment);
$dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_getConfigurationLabel'));
return $dataTable;
}
public function getOS( $idSite, $period, $date, $segment = false, $addShortLabel = true )
{
$dataTable = $this->getDataTable('UserSettings_os', $idSite, $period, $date, $segment);
// these filters are applied directly so other API methods can use GroupBy on the result of this method
$dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getOSLogo'));
if ($addShortLabel)
{
$dataTable->filter(
'ColumnCallbackAddMetadata', array( 'label', 'shortLabel', 'Piwik_getOSShortLabel') );
}
$dataTable->filter('ColumnCallbackReplace', array( 'label', 'Piwik_getOSLabel') );
return $dataTable;
}
/**
* Gets a DataTable displaying number of visits by operating system family. The operating
* system families are listed in /libs/UserAgentParser/UserAgentParser.php.
*/
public function getOSFamily( $idSite, $period, $date, $segment = false )
{
$dataTable = $this->getOS($idSite, $period, $date, $segment, $addShortLabel = false);
$dataTable->filter('GroupBy', array('label', 'Piwik_UserSettings_getOSFamily'));
$dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_Translate'));
return $dataTable;
}
/**
* Gets a DataTable displaying number of visits by device type (mobile vs. desktop).
*/
public function getMobileVsDesktop( $idSite, $period, $date, $segment = false )
{
$dataTable = $this->getOS($idSite, $period, $date, $segment, $addShortLabel = false);
$dataTable->filter('GroupBy', array('label', 'Piwik_UserSettings_getDeviceTypeFromOS'));
// make sure the datatable has a row for mobile & desktop (if it has rows)
$dataTables = array($dataTable);
if ($dataTable instanceof Piwik_DataTable_Array) {
$dataTables = $dataTable->getArray();
}
$requiredRows = array(
'General_Desktop' => Piwik_Archive::INDEX_NB_VISITS,
'General_Mobile' => Piwik_Archive::INDEX_NB_VISITS
);
foreach ($dataTables AS $table) {
if ($table->getRowsCount() == 0) {
continue;
}
foreach ($requiredRows AS $requiredRow => $key) {
$row = $table->getRowFromLabel($requiredRow);
if (empty($row)) {
$table->addRowsFromSimpleArray(array(
array('label' => $requiredRow, $key => 0)
));
}
}
}
// set the logo metadata
$dataTable->queueFilter('MetadataCallbackReplace',
array('logo', 'Piwik_UserSettings_getDeviceTypeImg', null, array('label')));
// translate the labels
$dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_Translate'));
return $dataTable;
}
public function getBrowserVersion( $idSite, $period, $date, $segment = false )
{
$dataTable = $this->getDataTable('UserSettings_browser', $idSite, $period, $date, $segment);
$dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getBrowsersLogo'));
$dataTable->filter('ColumnCallbackAddMetadata', array('label', 'shortLabel', 'Piwik_getBrowserShortLabel'));
$dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getBrowserLabel'));
return $dataTable;
}
/**
* Gets a DataTable displaying number of visits by browser (ie, Firefox, Chrome, etc.).
* The browser version is not included in this report.
*/
public function getBrowser( $idSite, $period, $date, $segment = false )
{
$dataTable = $this->getDataTable('UserSettings_browser', $idSite, $period, $date, $segment);
$dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getBrowsersLogo'));
$dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getBrowserLabel'));
$getBrowserFromBrowserVersion = 'Piwik_UserSettings_getBrowserFromBrowserVersion';
$dataTable->filter('GroupBy', array('label', $getBrowserFromBrowserVersion));
return $dataTable;
}
public function getBrowserType( $idSite, $period, $date, $segment = false )
{
$dataTable = $this->getDataTable('UserSettings_browserType', $idSite, $period, $date, $segment);
$dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'shortLabel', 'ucfirst'));
$dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_getBrowserTypeLabel'));
return $dataTable;
}
public function getWideScreen( $idSite, $period, $date, $segment = false )
{
$dataTable = $this->getDataTable('UserSettings_wideScreen', $idSite, $period, $date, $segment);
$dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getScreensLogo'));
$dataTable->queueFilter('ColumnCallbackReplace', array('label', 'ucfirst'));
return $dataTable;
}
public function getPlugin( $idSite, $period, $date, $segment = false )
{
// fetch all archive data required
$dataTable = $this->getDataTable('UserSettings_plugin', $idSite, $period, $date, $segment);
$browserTypes = $this->getDataTable('UserSettings_browserType', $idSite, $period, $date, $segment);
$archive = Piwik_Archive::build($idSite, $period, $date, $segment);
$visitsSums = $archive->getNumeric('nb_visits');
// check whether given tables are arrays
if($dataTable instanceof Piwik_DataTable_Array) {
$tableArray = $dataTable->getArray();
$browserTypesArray = $browserTypes->getArray();
$visitSumsArray = $visitsSums->getArray();
} else {
$tableArray = Array($dataTable);
$browserTypesArray = Array($browserTypes);
$visitSumsArray = Array($visitsSums);
}
// walk through the results and calculate the percentage
foreach($tableArray as $key => $table) {
// get according browserType table
foreach($browserTypesArray AS $k => $browsers) {
if($k == $key) {
$browserType = $browsers;
}
}
// get according visitsSum
foreach($visitSumsArray AS $k => $visits) {
if($k == $key) {
if(is_object($visits)) {
$visitsSumTotal = (float)$visits->getFirstRow()->getColumn(0);
} else {
$visitsSumTotal = (float)$visits;
}
}
}
// Calculate percentage, but ignore IE users because plugin detection doesn't work on IE
$ieVisits = 0;
$ieStats = $browserType->getRowFromLabel('ie');
if($ieStats !== false)
{
$ieVisits = $ieStats->getColumn(Piwik_Archive::INDEX_NB_VISITS);
}
$visitsSum = $visitsSumTotal - $ieVisits;
// The filter must be applied now so that the new column can
// be sorted by the generic filters (applied right after this loop exits)
$table->filter('ColumnCallbackAddColumnPercentage', array('nb_visits_percentage', Piwik_Archive::INDEX_NB_VISITS, $visitsSum, 1));
$table->filter('RangeCheck', array('nb_visits_percentage'));
}
$dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getPluginsLogo'));
$dataTable->queueFilter('ColumnCallbackReplace', array('label', 'ucfirst'));
return $dataTable;
}
public function getLanguage( $idSite, $period, $date, $segment = false )
{
$dataTable = $this->getDataTable('UserSettings_language', $idSite, $period, $date, $segment);
$dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_LanguageTranslate'));
$dataTable->filter('ReplaceColumnNames');
return $dataTable;
}
}
|
