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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugins\CoreVisualizations\JqplotDataGenerator;
use Piwik\Archive\DataTableFactory;
use Piwik\Common;
use Piwik\DataTable;
use Piwik\DataTable\DataTableInterface;
use Piwik\DataTable\Row;
use Piwik\Date;
use Piwik\Metrics;
use Piwik\Period;
use Piwik\Period\Factory;
use Piwik\Plugins\API\Filter\DataComparisonFilter;
use Piwik\Plugins\CoreVisualizations\JqplotDataGenerator;
use Piwik\Url;
/**
* Generates JQPlot JSON data/config for evolution graphs.
*/
class Evolution extends JqplotDataGenerator
{
protected function getUnitsForColumnsToDisplay()
{
$idSite = Common::getRequestVar('idSite', null, 'int');
$units = [];
foreach ($this->properties['columns_to_display'] as $columnName) {
$derivedUnit = Metrics::getUnit($columnName, $idSite);
$units[$columnName] = empty($derivedUnit) ? false : $derivedUnit;
}
return $units;
}
/**
* @param DataTable|DataTable\Map $dataTable
* @param Chart $visualization
*/
protected function initChartObjectData($dataTable, $visualization)
{
// if the loaded datatable is a simple DataTable, it is most likely a plugin plotting some custom data
// we don't expect plugin developers to return a well defined Set
if ($dataTable instanceof DataTable) {
parent::initChartObjectData($dataTable, $visualization);
return;
}
$dataTables = $dataTable->getDataTables();
// determine x labels based on both the displayed date range and the compared periods
/** @var Period[][] $xLabels */
$xLabels = [
[], // placeholder for first series
];
$this->addComparisonXLabels($xLabels, reset($dataTables));
$this->addSelectedSeriesXLabels($xLabels, $dataTables);
$units = $this->getUnitsForColumnsToDisplay();
// if rows to display are not specified, default to all rows (TODO: perhaps this should be done elsewhere?)
$rowsToDisplay = $this->properties['rows_to_display']
? : array_unique($dataTable->getColumn('label'))
? : array(false) // make sure that a series is plotted even if there is no data
;
$columnsToDisplay = array_values($this->properties['columns_to_display']);
list($seriesMetadata, $seriesUnits, $seriesLabels, $seriesToXAxis) =
$this->getSeriesMetadata($rowsToDisplay, $columnsToDisplay, $units, $dataTables);
// collect series data to show. each row-to-display/column-to-display permutation creates a series.
$allSeriesData = array();
foreach ($rowsToDisplay as $rowLabel) {
foreach ($columnsToDisplay as $columnName) {
if (!$this->isComparing) {
$this->setNonComparisonSeriesData($allSeriesData, $rowLabel, $columnName, $dataTable);
} else {
$this->setComparisonSeriesData($allSeriesData, $seriesLabels, $rowLabel, $columnName, $dataTable);
}
}
}
$visualization->dataTable = $dataTable;
$visualization->properties = $this->properties;
$visualization->setAxisYValues($allSeriesData, $seriesMetadata);
$visualization->setAxisYUnits($seriesUnits);
$xLabelStrs = [];
$xAxisTicks = [];
foreach ($xLabels as $index => $seriesXLabels) {
$xLabelStrs[$index] = array_map(function (Period $p) { return $p->getLocalizedLongString(); }, $seriesXLabels);
$xAxisTicks[$index] = array_map(function (Period $p) { return $p->getLocalizedShortString(); }, $seriesXLabels);
}
$visualization->setAxisXLabelsMultiple($xLabelStrs, $seriesToXAxis, $xAxisTicks);
if ($this->isLinkEnabled()) {
$idSite = Common::getRequestVar('idSite', null, 'int');
$periodLabel = reset($dataTables)->getMetadata(DataTableFactory::TABLE_METADATA_PERIOD_INDEX)->getLabel();
$axisXOnClick = array();
foreach ($dataTable->getDataTables() as $metadataDataTable) {
$dateInUrl = $metadataDataTable->getMetadata(DataTableFactory::TABLE_METADATA_PERIOD_INDEX)->getDateStart();
$parameters = array(
'idSite' => $idSite,
'period' => $periodLabel,
'date' => $dateInUrl->toString(),
'segment' => \Piwik\API\Request::getRawSegmentFromRequest()
);
$link = Url::getQueryStringFromParameters($parameters);
$axisXOnClick[] = $link;
}
$visualization->setAxisXOnClick($axisXOnClick);
}
}
private function getSeriesData($rowLabel, $columnName, DataTable\Map $dataTable)
{
$seriesData = array();
foreach ($dataTable->getDataTables() as $childTable) {
// get the row for this label (use the first if $rowLabel is false)
if ($rowLabel === false) {
$row = $childTable->getFirstRow();
} else {
$row = $childTable->getRowFromLabel($rowLabel);
}
// get series data point. defaults to 0 if no row or no column value.
if ($row === false) {
$seriesData[] = 0;
} else {
$seriesData[] = $row->getColumn($columnName) ? : 0;
}
}
return $seriesData;
}
/**
* Derive the series label from the row label and the column name.
* If the row label is set, both the label and the column name are displayed.
* @param string $rowLabel
* @param string $columnName
* @return string
*/
private function getSeriesLabel($rowLabel, $columnName)
{
$metricLabel = @$this->properties['translations'][$columnName];
if ($rowLabel !== false) {
// eg. "Yahoo! (Visits)"
$label = "$rowLabel ($metricLabel)";
} else {
// eg. "Visits"
$label = $metricLabel;
}
return $label;
}
private function isLinkEnabled()
{
static $linkEnabled;
if (!isset($linkEnabled)) {
// 1) Custom Date Range always have link disabled, otherwise
// the graph data set is way too big and fails to display
// 2) disableLink parameter is set in the Widgetize "embed" code
$linkEnabled = !Common::getRequestVar('disableLink', 0, 'int')
&& Common::getRequestVar('period', 'day') != 'range';
}
return $linkEnabled;
}
/**
* Each period comparison shows data over different data points than the main series (eg, 2014-02-03,1014-02-06 compared w/ 2015-03-04,2015-03-15).
* Though we only display the selected period's x labels, we need to both have the labels for all these data points for tooltips and to stretch
* out the selected period x axis, in case it is shorter than one of the compared periods (as in the example above).
*/
private function addComparisonXLabels(array &$xLabels, DataTable $table)
{
$comparePeriods = $table->getMetadata('comparePeriods') ?: [];
$compareDates = $table->getMetadata('compareDates') ?: [];
// get rid of selected period
array_shift($comparePeriods);
array_shift($compareDates);
foreach (array_values($comparePeriods) as $index => $period) {
$date = $compareDates[$index];
$range = Factory::build($period, $date);
foreach ($range->getSubperiods() as $subperiod) {
$xLabels[$index + 1][] = $subperiod;
}
}
}
/**
* @param array $xLabels
* @param DataTable[] $dataTables
* @throws \Exception
*/
protected function addSelectedSeriesXLabels(array &$xLabels, array $dataTables)
{
$xTicksCount = count($dataTables);
foreach ($xLabels as $labelSeries) {
$xTicksCount = max(count($labelSeries), $xTicksCount);
}
/** @var Date $startDate */
$startDate = reset($dataTables)->getMetadata(DataTableFactory::TABLE_METADATA_PERIOD_INDEX)->getDateStart();
$periodType = reset($dataTables)->getMetadata(DataTableFactory::TABLE_METADATA_PERIOD_INDEX)->getLabel();
for ($i = 0; $i < $xTicksCount; ++$i) {
$period = Factory::build($periodType, $startDate->addPeriod($i, $periodType));
$xLabels[0][] = $period;
}
}
private function setNonComparisonSeriesData(array &$allSeriesData, $rowLabel, $columnName, DataTable\Map $dataTable)
{
$seriesLabel = $this->getSeriesLabel($rowLabel, $columnName);
$seriesData = $this->getSeriesData($rowLabel, $columnName, $dataTable);
$allSeriesData[$seriesLabel] = $seriesData;
}
private function setComparisonSeriesData(array &$allSeriesData, array $seriesLabels, $rowLabel, $columnName, DataTable\Map $dataTable)
{
foreach ($dataTable->getDataTables() as $label => $childTable) {
// get the row for this label (use the first if $rowLabel is false)
if ($rowLabel === false) {
$row = $childTable->getFirstRow();
} else {
$row = $childTable->getRowFromLabel($rowLabel);
}
if (empty($row)
|| empty($row->getComparisons())
) {
foreach ($seriesLabels as $seriesIndex => $seriesLabelPrefix) {
$wholeSeriesLabel = $this->getComparisonSeriesLabelFromCompareSeries($seriesLabelPrefix, $columnName, $rowLabel);
$allSeriesData[$wholeSeriesLabel][] = 0;
}
continue;
}
/** @var DataTable $comparisonTable */
$comparisonTable = $row->getComparisons();
foreach ($comparisonTable->getRows() as $compareRow) {
$seriesLabel = $this->getComparisonSeriesLabel($compareRow, $columnName, $rowLabel);
$allSeriesData[$seriesLabel][] = $compareRow->getColumn($columnName);
}
$totalsRow = $comparisonTable->getTotalsRow();
if ($totalsRow) {
$seriesLabel = $this->getComparisonSeriesLabel($totalsRow, $columnName, $rowLabel);
$allSeriesData[$seriesLabel][] = $totalsRow->getColumn($columnName);
}
}
}
private function getSeriesMetadata(array $rowsToDisplay, array $columnsToDisplay, array $units, array $dataTables)
{
$seriesMetadata = null; // maps series labels to any metadata of the series
$seriesUnits = array(); // maps series labels to unit labels
$seriesToXAxis = []; // maps series index to x-axis index (groups of metrics for a single comparison will use the same x-axis)
$table = reset($dataTables);
$seriesLabels = $table->getMetadata('comparisonSeries') ?: [];
foreach ($rowsToDisplay as $rowIndex => $rowLabel) {
foreach ($columnsToDisplay as $columnIndex => $columnName) {
if ($this->isComparing) {
foreach ($seriesLabels as $seriesIndex => $seriesLabel) {
$wholeSeriesLabel = $this->getComparisonSeriesLabelFromCompareSeries($seriesLabel, $columnName, $rowLabel);
$allSeriesData[$wholeSeriesLabel] = [];
$metricIndex = $rowIndex * count($columnsToDisplay) + $columnIndex;
$seriesMetadata[$wholeSeriesLabel] = [
'metricIndex' => $metricIndex,
'seriesIndex' => $seriesIndex,
];
$seriesUnits[$wholeSeriesLabel] = $units[$columnName];
list($periodIndex, $segmentIndex) = DataComparisonFilter::getIndividualComparisonRowIndices($table, $seriesIndex);
$seriesToXAxis[] = $periodIndex;
}
} else {
$seriesLabel = $this->getSeriesLabel($rowLabel, $columnName);
$seriesUnits[$seriesLabel] = $units[$columnName];
}
}
}
return [$seriesMetadata, $seriesUnits, $seriesLabels, $seriesToXAxis];
}
}
|