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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugin;
use Piwik\API\DataTablePostProcessor;
use Piwik\API\Proxy;
use Piwik\API\Request;
use Piwik\API\Request as ApiRequest;
use Piwik\API\ResponseBuilder;
use Piwik\Common;
use Piwik\Container\StaticContainer;
use Piwik\DataTable;
use Piwik\Date;
use Piwik\Http\BadRequestException;
use Piwik\Log;
use Piwik\Metrics\Formatter\Html as HtmlFormatter;
use Piwik\NoAccessException;
use Piwik\Option;
use Piwik\Period;
use Piwik\Piwik;
use Piwik\Plugins\API\API as ApiApi;
use Piwik\Plugins\API\Filter\DataComparisonFilter;
use Piwik\Plugins\PrivacyManager\PrivacyManager;
use Piwik\SettingsPiwik;
use Piwik\View;
use Piwik\ViewDataTable\Manager as ViewDataTableManager;
use Piwik\Plugin\Manager as PluginManager;
use Psr\Log\LoggerInterface;
/**
* The base class for report visualizations that output HTML and use JavaScript.
*
* Report visualizations that extend from this class will be displayed like all others in
* the Piwik UI. The following extra UI controls will be displayed around the visualization
* itself:
*
* - report documentation,
* - a header message (if {@link Piwik\ViewDataTable\Config::$show_header_message} is set),
* - a footer message (if {@link Piwik\ViewDataTable\Config::$show_footer_message} is set),
* - a list of links to related reports (if {@link Piwik\ViewDataTable\Config::$related_reports} is set),
* - a button that allows users to switch visualizations,
* - a control that allows users to export report data in different formats,
* - a limit control that allows users to change the amount of rows displayed (if
* {@link Piwik\ViewDataTable\Config::$show_limit_control} is true),
* - and more depending on the visualization.
*
* ### Rendering Process
*
* The following process is used to render reports:
*
* - The report is loaded through Piwik's Reporting API.
* - The display and request properties that require report data in order to determine a default
* value are defaulted. These properties are:
*
* - {@link Piwik\ViewDataTable\Config::$columns_to_display}
* - {@link Piwik\ViewDataTable\RequestConfig::$filter_sort_column}
* - {@link Piwik\ViewDataTable\RequestConfig::$filter_sort_order}
*
* - Priority filters are applied to the report (see {@link Piwik\ViewDataTable\Config::$filters}).
* - The filters that are applied to every report in the Reporting API (called **generic filters**)
* are applied. (see {@link Piwik\API\Request})
* - The report's queued filters are applied.
* - A {@link Piwik\View} instance is created and rendered.
*
* ### Rendering Hooks
*
* The Visualization class defines several overridable methods that are called at specific
* points during the rendering process. Derived classes can override these methods change
* the data that is displayed or set custom properties.
*
* The overridable methods (called **rendering hooks**) are as follows:
*
* - **beforeLoadDataTable**: Called at the start of the rendering process before any data
* is loaded.
* - **beforeGenericFiltersAreAppliedToLoadedDataTable**: Called after data is loaded and after priority
* filters are called, but before other filters. This
* method should be used if you need the report's
* entire dataset.
* - **afterGenericFiltersAreAppliedToLoadedDataTable**: Called after generic filters are applied, but before
* queued filters are applied.
* - **afterAllFiltersAreApplied**: Called after data is loaded and all filters are applied.
* - **beforeRender**: Called immediately before a {@link Piwik\View} is created and rendered.
* - **isThereDataToDisplay**: Called after a {@link Piwik\View} is created to determine if the report has
* data or not. If not, a message is displayed to the user.
*
* ### The DataTable JavaScript class
*
* In the UI, visualization behavior is provided by logic in the **DataTable** JavaScript class.
* When creating new visualizations, the **DataTable** JavaScript class (or one of its existing
* descendants) should be extended.
*
* To learn more read the [Visualizing Report Data](/guides/visualizing-report-data#creating-new-visualizations)
* guide.
*
* ### Examples
*
* **Changing the data that is loaded**
*
* class MyVisualization extends Visualization
* {
* // load the previous period's data as well as the requested data. this will change
* // $this->dataTable from a DataTable instance to a DataTable\Map instance.
* public function beforeLoadDataTable()
* {
* $date = Common::getRequestVar('date');
* list($previousDate, $ignore) = Range::getLastDate($date, $period);
*
* $this->requestConfig->request_parameters_to_modify['date'] = $previousDate . ',' . $date;
* }
*
* // since we load the previous period's data too, we need to override the logic to
* // check if there is data or not.
* public function isThereDataToDisplay()
* {
* $tables = $this->dataTable->getDataTables()
* $requestedDataTable = end($tables);
*
* return $requestedDataTable->getRowsCount() != 0;
* }
* }
*
* **Force properties to be set to certain values**
*
* class MyVisualization extends Visualization
* {
* // ensure that some properties are set to certain values before rendering.
* // this will overwrite any changes made by plugins that use this visualization.
* public function beforeRender()
* {
* $this->config->max_graph_elements = false;
* $this->config->datatable_js_type = 'MyVisualization';
* $this->config->show_flatten_table = false;
* $this->config->show_pagination_control = false;
* $this->config->show_offset_information = false;
* }
* }
*/
class Visualization extends ViewDataTable
{
/**
* The Twig template file to use when rendering, eg, `"@MyPlugin/_myVisualization.twig"`.
*
* Must be defined by classes that extend Visualization.
*
* @api
*/
const TEMPLATE_FILE = '';
private $templateVars = array();
private $reportLastUpdatedMessage = null;
private $metadata = null;
protected $metricsFormatter = null;
/**
* @var Report
*/
protected $report;
final public function __construct($controllerAction, $apiMethodToRequestDataTable, $params = array())
{
$templateFile = static::TEMPLATE_FILE;
if (empty($templateFile)) {
throw new \Exception('You have not defined a constant named TEMPLATE_FILE in your visualization class.');
}
$this->metricsFormatter = new HtmlFormatter();
parent::__construct($controllerAction, $apiMethodToRequestDataTable, $params);
$this->report = ReportsProvider::factory($this->requestConfig->getApiModuleToRequest(), $this->requestConfig->getApiMethodToRequest());
}
public function render()
{
$this->overrideSomeConfigPropertiesIfNeeded();
try {
$this->beforeLoadDataTable();
$this->loadDataTableFromAPI();
$this->postDataTableLoadedFromAPI();
$requestPropertiesAfterLoadDataTable = $this->requestConfig->getProperties();
$this->applyFilters();
$this->addVisualizationInfoFromMetricMetadata();
$this->afterAllFiltersAreApplied();
$this->beforeRender();
$this->fireBeforeRenderHook();
$this->logMessageIfRequestPropertiesHaveChanged($requestPropertiesAfterLoadDataTable);
} catch (NoAccessException $e) {
throw $e;
} catch (\Exception $e) {
StaticContainer::get(LoggerInterface::class)->error('Failed to get data from API: {exception}', [
'exception' => $e,
'ignoreInScreenWriter' => true,
]);
$message = $e->getMessage();
if (\Piwik_ShouldPrintBackTraceWithMessage()) {
$message .= "\n" . $e->getTraceAsString();
}
$loadingError = array('message' => $message);
}
$view = new View("@CoreHome/_dataTable");
$view->assign($this->templateVars);
if (!empty($loadingError)) {
$view->error = $loadingError;
}
$view->visualization = $this;
$view->visualizationTemplate = static::TEMPLATE_FILE;
$view->visualizationCssClass = $this->getDefaultDataTableCssClass();
$view->reportMetdadata = $this->getReportMetadata();
if (null === $this->dataTable) {
$view->dataTable = null;
} else {
$view->dataTableHasNoData = !$this->isThereDataToDisplay();
$view->dataTable = $this->dataTable;
// if it's likely that the report data for this data table has been purged,
// set whether we should display a message to that effect.
$view->showReportDataWasPurgedMessage = $this->hasReportBeenPurged();
$view->deleteReportsOlderThan = Option::get('delete_reports_older_than');
}
$view->idSubtable = $this->requestConfig->idSubtable;
$clientSideParameters = $this->getClientSideParametersToSet();
if (isset($clientSideParameters['showtitle'])) {
unset($clientSideParameters['showtitle']);
}
$view->clientSideParameters = $clientSideParameters;
$view->clientSideProperties = $this->getClientSidePropertiesToSet();
$view->properties = array_merge($this->requestConfig->getProperties(), $this->config->getProperties());
$view->reportLastUpdatedMessage = $this->reportLastUpdatedMessage;
$view->footerIcons = $this->config->footer_icons;
$view->isWidget = Common::getRequestVar('widget', 0, 'int');
$view->notifications = [];
$view->isComparing = $this->isComparing();
if (!$this->supportsComparison()
&& DataComparisonFilter::isCompareParamsPresent()
&& empty($view->dataTableHasNoData)
) {
if (empty($view->properties['show_footer_message'])) {
$view->properties['show_footer_message'] = '';
}
$view->properties['show_footer_message'] .= '<br/>' . Piwik::translate('General_VisualizationDoesNotSupportComparison');
}
if (empty($this->dataTable) || !$this->hasAnyData($this->dataTable)) {
/**
* @ignore
*/
Piwik::postEvent('Visualization.onNoData', [$view]);
}
return $view->render();
}
protected function checkRequestIsNotForMultiplePeriods()
{
$date = $this->requestConfig->getRequestParam('date');
$period = $this->requestConfig->getRequestParam('period');
if (Period::isMultiplePeriod($date, $period)) {
throw new BadRequestException("The '" . static::ID . "' visualization does not support multiple periods.");
}
}
protected function checkRequestIsOnlyForMultiplePeriods()
{
try {
$this->checkRequestIsNotForMultiplePeriods();
} catch (BadRequestException $ex) {
return; // ignore
}
throw new BadRequestException("The '" . static::ID . "' visualization does not support single periods.");
}
private function hasAnyData(DataTable\DataTableInterface $dataTable)
{
$hasData = false;
$dataTable->filter(function (DataTable $table) use (&$hasData) {
if ($hasData || $table->getRowsCount() == 0) {
return;
}
foreach ($table->getRows() as $row) {
foreach ($row->getColumns() as $column => $value) {
if ($value != 0 && $value !== '0%') {
$hasData = true;
return;
}
}
}
});
return $hasData;
}
/**
* @internal
*/
protected function loadDataTableFromAPI()
{
if (!is_null($this->dataTable)) {
// data table is already there
// this happens when setDataTable has been used
return $this->dataTable;
}
// we build the request (URL) to call the API
$request = $this->buildApiRequestArray();
$module = $this->requestConfig->getApiModuleToRequest();
$method = $this->requestConfig->getApiMethodToRequest();
list($module, $method) = Request::getRenamedModuleAndAction($module, $method);
PluginManager::getInstance()->checkIsPluginActivated($module);
$proxyRequestParams = $request;
if ($this->isComparing()) {
$proxyRequestParams = array_merge($proxyRequestParams, [
'disable_root_datatable_post_processor' => 1,
]);
}
$class = ApiRequest::getClassNameAPI($module);
$dataTable = Proxy::getInstance()->call($class, $method, $proxyRequestParams);
$response = new ResponseBuilder($format = 'original', $request);
$response->disableSendHeader();
$response->disableDataTablePostProcessor();
$this->dataTable = $response->getResponse($dataTable, $module, $method);
}
private function getReportMetadata()
{
$request = $this->request->getRequestArray() + $_GET + $_POST;
$idSite = Common::getRequestVar('idSite', null, 'int', $request);
$module = $this->requestConfig->getApiModuleToRequest();
$action = $this->requestConfig->getApiMethodToRequest();
$apiParameters = array();
$entityNames = StaticContainer::get('entities.idNames');
foreach ($entityNames as $entityName) {
$idEntity = Common::getRequestVar($entityName, 0, 'int');
if ($idEntity > 0) {
$apiParameters[$entityName] = $idEntity;
}
}
$metadata = ApiApi::getInstance()->getMetadata($idSite, $module, $action, $apiParameters);
if (!empty($metadata)) {
return array_shift($metadata);
}
return false;
}
private function overrideSomeConfigPropertiesIfNeeded()
{
if (empty($this->config->footer_icons)) {
$this->config->footer_icons = ViewDataTableManager::configureFooterIcons($this);
}
if (!$this->isPluginActivated('Goals')) {
$this->config->show_goals = false;
}
}
private function isPluginActivated($pluginName)
{
return PluginManager::getInstance()->isPluginActivated($pluginName);
}
/**
* Assigns a template variable making it available in the Twig template specified by
* {@link TEMPLATE_FILE}.
*
* @param array|string $vars One or more variable names to set.
* @param mixed $value The value to set each variable to.
* @api
*/
public function assignTemplateVar($vars, $value = null)
{
if (is_string($vars)) {
$this->templateVars[$vars] = $value;
} elseif (is_array($vars)) {
foreach ($vars as $key => $value) {
$this->templateVars[$key] = $value;
}
}
}
/**
* Returns `true` if there is data to display, `false` if otherwise.
*
* Derived classes should override this method if they change the amount of data that is loaded.
*
* @api
*/
protected function isThereDataToDisplay()
{
return !empty($this->dataTable) && 0 < $this->dataTable->getRowsCount();
}
/**
* Hook called after the dataTable has been loaded from the API
* Can be used to add, delete or modify the data freshly loaded
*
* @return bool
*/
private function postDataTableLoadedFromAPI()
{
$columns = $this->dataTable->getColumns();
$hasNbVisits = in_array('nb_visits', $columns);
$hasNbUniqVisitors = in_array('nb_uniq_visitors', $columns);
// if any comparison period doesn't support unique visitors, we can't display it for the main table
if ($this->isComparing()) {
$request = $this->getRequestArray();
if (!empty($request['comparePeriods'])) {
foreach ($request['comparePeriods'] as $comparePeriod) {
if (!SettingsPiwik::isUniqueVisitorsEnabled($comparePeriod)) {
$hasNbUniqVisitors = false;
break;
}
}
}
}
// default columns_to_display to label, nb_uniq_visitors/nb_visits if those columns exist in the
// dataset. otherwise, default to all columns in dataset.
if (empty($this->config->columns_to_display)) {
$this->config->setDefaultColumnsToDisplay($columns, $hasNbVisits, $hasNbUniqVisitors);
}
if (!empty($this->dataTable)) {
$this->removeEmptyColumnsFromDisplay();
}
if (empty($this->requestConfig->filter_sort_column)) {
$this->requestConfig->setDefaultSort($this->config->columns_to_display, $hasNbUniqVisitors, $columns);
}
// deal w/ table metadata
if ($this->dataTable instanceof DataTable) {
$this->metadata = $this->dataTable->getAllTableMetadata();
if (isset($this->metadata[DataTable::ARCHIVED_DATE_METADATA_NAME])) {
$this->reportLastUpdatedMessage = $this->makePrettyArchivedOnText();
}
}
$pivotBy = Common::getRequestVar('pivotBy', false) ?: $this->requestConfig->pivotBy;
if (empty($pivotBy)
&& $this->dataTable instanceof DataTable
) {
$this->config->disablePivotBySubtableIfTableHasNoSubtables($this->dataTable);
}
}
private function addVisualizationInfoFromMetricMetadata()
{
$dataTable = $this->dataTable instanceof DataTable\Map ? $this->dataTable->getFirstRow() : $this->dataTable;
$metrics = Report::getMetricsForTable($dataTable, $this->report);
// TODO: instead of iterating & calling translate everywhere, maybe we can get all translated names in one place.
// may be difficult, though, since translated metrics are specific to the report.
foreach ($metrics as $metric) {
$name = $metric->getName();
if (empty($this->config->translations[$name])) {
$this->config->translations[$name] = $metric->getTranslatedName();
}
if (empty($this->config->metrics_documentation[$name])) {
$this->config->metrics_documentation[$name] = $metric->getDocumentation();
}
}
}
private function applyFilters()
{
$postProcessor = $this->makeDataTablePostProcessor(); // must be created after requestConfig is final
$self = $this;
$postProcessor->setCallbackBeforeGenericFilters(function (DataTable\DataTableInterface $dataTable) use ($self, $postProcessor) {
$self->setDataTable($dataTable);
// First, filters that delete rows
foreach ($self->config->getPriorityFilters() as $filter) {
$dataTable->filter($filter[0], $filter[1]);
}
$self->beforeGenericFiltersAreAppliedToLoadedDataTable();
if (!in_array($self->requestConfig->filter_sort_column, $self->config->columns_to_display)) {
$hasNbUniqVisitors = in_array('nb_uniq_visitors', $self->config->columns_to_display);
$columns = $dataTable->getColumns();
$self->requestConfig->setDefaultSort($self->config->columns_to_display, $hasNbUniqVisitors, $columns);
}
$postProcessor->setRequest($self->buildApiRequestArray());
});
$postProcessor->setCallbackAfterGenericFilters(function (DataTable\DataTableInterface $dataTable) use ($self) {
$self->setDataTable($dataTable);
$self->afterGenericFiltersAreAppliedToLoadedDataTable();
// queue other filters so they can be applied later if queued filters are disabled
foreach ($self->config->getPresentationFilters() as $filter) {
$dataTable->queueFilter($filter[0], $filter[1]);
}
});
$this->dataTable = $postProcessor->process($this->dataTable);
}
private function removeEmptyColumnsFromDisplay()
{
if ($this->dataTable instanceof DataTable\Map) {
$emptyColumns = $this->dataTable->getMetadataIntersectArray(DataTable::EMPTY_COLUMNS_METADATA_NAME);
} else {
$emptyColumns = $this->dataTable->getMetadata(DataTable::EMPTY_COLUMNS_METADATA_NAME);
}
if (is_array($emptyColumns)) {
foreach ($emptyColumns as $emptyColumn) {
$key = array_search($emptyColumn, $this->config->columns_to_display);
if ($key !== false) {
unset($this->config->columns_to_display[$key]);
}
}
$this->config->columns_to_display = array_values($this->config->columns_to_display);
}
}
/**
* Returns prettified and translated text that describes when a report was last updated.
*
* @return string
*/
private function makePrettyArchivedOnText()
{
$dateText = $this->metadata[DataTable::ARCHIVED_DATE_METADATA_NAME];
$date = Date::factory($dateText);
$today = mktime(0, 0, 0);
if ($date->getTimestamp() > $today) {
$elapsedSeconds = time() - $date->getTimestamp();
$timeAgo = $this->metricsFormatter->getPrettyTimeFromSeconds($elapsedSeconds);
return Piwik::translate('CoreHome_ReportGeneratedXAgo', $timeAgo);
}
$prettyDate = $date->getLocalized(Date::DATE_FORMAT_SHORT);
$timezoneAppend = ' (UTC)';
return Piwik::translate('CoreHome_ReportGeneratedOn', $prettyDate) . $timezoneAppend;
}
/**
* Returns true if it is likely that the data for this report has been purged and if the
* user should be told about that.
*
* In order for this function to return true, the following must also be true:
* - The data table for this report must either be empty or not have been fetched.
* - The period of this report is not a multiple period.
* - The date of this report must be older than the delete_reports_older_than config option.
* @return bool
*/
private function hasReportBeenPurged()
{
if (!$this->isPluginActivated('PrivacyManager')) {
return false;
}
return PrivacyManager::hasReportBeenPurged($this->dataTable);
}
/**
* Returns array of properties that should be visible to client side JavaScript. The data
* will be available in the data-props HTML attribute of the .dataTable div.
*
* @return array Maps property names w/ property values.
*/
private function getClientSidePropertiesToSet()
{
$result = array();
foreach ($this->config->clientSideProperties as $name) {
if (property_exists($this->requestConfig, $name)) {
$result[$name] = $this->getIntIfValueIsBool($this->requestConfig->$name);
} elseif (property_exists($this->config, $name)) {
$result[$name] = $this->getIntIfValueIsBool($this->config->$name);
}
}
return $result;
}
private function getIntIfValueIsBool($value)
{
return is_bool($value) ? (int)$value : $value;
}
/**
* This functions reads the customization values for the DataTable and returns an array (name,value) to be printed in Javascript.
* This array defines things such as:
* - name of the module & action to call to request data for this table
* - optional filters information, eg. filter_limit and filter_offset
* - etc.
*
* The values are loaded:
* - from the generic filters that are applied by default @see Piwik\API\DataTableGenericFilter::getGenericFiltersInformation()
* - from the values already available in the GET array
* - from the values set using methods from this class (eg. setSearchPattern(), setLimit(), etc.)
*
* @return array eg. array('show_offset_information' => 0, 'show_...
*/
protected function getClientSideParametersToSet()
{
// build javascript variables to set
$javascriptVariablesToSet = array();
foreach ($this->config->custom_parameters as $name => $value) {
$javascriptVariablesToSet[$name] = $value;
}
foreach ($_GET as $name => $value) {
try {
$requestValue = Common::getRequestVar($name);
} catch (\Exception $e) {
$requestValue = '';
}
$javascriptVariablesToSet[$name] = $requestValue;
}
foreach ($this->requestConfig->clientSideParameters as $name) {
if (isset($javascriptVariablesToSet[$name])) {
continue;
}
$valueToConvert = false;
if (property_exists($this->requestConfig, $name)) {
$valueToConvert = $this->requestConfig->$name;
} elseif (property_exists($this->config, $name)) {
$valueToConvert = $this->config->$name;
}
if (false !== $valueToConvert) {
$javascriptVariablesToSet[$name] = $this->getIntIfValueIsBool($valueToConvert);
}
}
$javascriptVariablesToSet['module'] = $this->config->controllerName;
$javascriptVariablesToSet['action'] = $this->config->controllerAction;
if (!isset($javascriptVariablesToSet['viewDataTable'])) {
$javascriptVariablesToSet['viewDataTable'] = static::getViewDataTableId();
}
if ($this->dataTable &&
// Set doesn't have the method
!($this->dataTable instanceof DataTable\Map)
&& empty($javascriptVariablesToSet['totalRows'])
) {
$javascriptVariablesToSet['totalRows'] =
$this->dataTable->getMetadata(DataTable::TOTAL_ROWS_BEFORE_LIMIT_METADATA_NAME) ?: $this->dataTable->getRowsCount();
}
$deleteFromJavascriptVariables = array(
'filter_excludelowpop',
'filter_excludelowpop_value',
);
foreach ($deleteFromJavascriptVariables as $name) {
if (isset($javascriptVariablesToSet[$name])) {
unset($javascriptVariablesToSet[$name]);
}
}
$rawSegment = \Piwik\API\Request::getRawSegmentFromRequest();
if (!empty($rawSegment)) {
$javascriptVariablesToSet['segment'] = $rawSegment;
}
if (isset($javascriptVariablesToSet['compareSegments'])) {
$javascriptVariablesToSet['compareSegments'] = Common::unsanitizeInputValues($javascriptVariablesToSet['compareSegments']);
}
return $javascriptVariablesToSet;
}
/**
* Hook that is called before loading report data from the API.
*
* Use this method to change the request parameters that is sent to the API when requesting
* data.
*
* @api
*/
public function beforeLoadDataTable()
{
}
/**
* Hook that is executed before generic filters are applied.
*
* Use this method if you need access to the entire dataset (since generic filters will
* limit and truncate reports).
*
* @api
*/
public function beforeGenericFiltersAreAppliedToLoadedDataTable()
{
}
/**
* Hook that is executed after generic filters are applied.
*
* @api
*/
public function afterGenericFiltersAreAppliedToLoadedDataTable()
{
}
/**
* Hook that is executed after the report data is loaded and after all filters have been applied.
* Use this method to format the report data before the view is rendered.
*
* @api
*/
public function afterAllFiltersAreApplied()
{
}
/**
* Hook that is executed directly before rendering. Use this hook to force display properties to
* be a certain value, despite changes from plugins and query parameters.
*
* @api
*/
public function beforeRender()
{
// eg $this->config->showFooterColumns = true;
}
private function fireBeforeRenderHook()
{
/**
* Posted immediately before rendering the view. Plugins can use this event to perform last minute
* configuration of the view based on it's data or the report being viewed.
*
* @param Visualization $view The instance to configure.
*/
Piwik::postEvent('Visualization.beforeRender', [$this]);
}
private function makeDataTablePostProcessor()
{
$request = $this->buildApiRequestArray();
$module = $this->requestConfig->getApiModuleToRequest();
$method = $this->requestConfig->getApiMethodToRequest();
$processor = new DataTablePostProcessor($module, $method, $request);
$processor->setFormatter($this->metricsFormatter);
return $processor;
}
private function logMessageIfRequestPropertiesHaveChanged(array $requestPropertiesBefore)
{
$requestProperties = $this->requestConfig->getProperties();
$diff = array_diff_assoc($this->makeSureArrayContainsOnlyStrings($requestProperties),
$this->makeSureArrayContainsOnlyStrings($requestPropertiesBefore));
if (!empty($diff['filter_sort_column'])) {
// this here might be ok as it can be changed after data loaded but before filters applied
unset($diff['filter_sort_column']);
}
if (!empty($diff['filter_sort_order'])) {
// this here might be ok as it can be changed after data loaded but before filters applied
unset($diff['filter_sort_order']);
}
if (empty($diff)) {
return;
}
$details = array(
'changedProperties' => $diff,
'apiMethod' => $this->requestConfig->apiMethodToRequestDataTable,
'controller' => $this->config->controllerName . '.' . $this->config->controllerAction,
'viewDataTable' => static::getViewDataTableId()
);
$message = 'Some ViewDataTable::requestConfig properties have changed after requesting the data table. '
. 'That means the changed values had probably no effect. For instance in beforeRender() hook. '
. 'Probably a bug? Details:'
. print_r($details, 1);
Log::warning($message);
}
private function makeSureArrayContainsOnlyStrings($array)
{
$result = array();
foreach ($array as $key => $value) {
$result[$key] = json_encode($value);
}
return $result;
}
/**
* @internal
*
* @return array
*/
public function buildApiRequestArray()
{
$request = $this->getRequestArray();
if (false === $this->config->enable_sort) {
$request['filter_sort_column'] = '';
$request['filter_sort_order'] = '';
}
if (!array_key_exists('format_metrics', $request) || $request['format_metrics'] === 'bc') {
$request['format_metrics'] = '1';
}
if (!$this->requestConfig->disable_queued_filters && array_key_exists('disable_queued_filters', $request)) {
unset($request['disable_queued_filters']);
}
if ($this->isComparing()) {
$request['compare'] = '1';
}
return $request;
}
}
|