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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugin;
use Piwik\CacheId;
use Piwik\Category\CategoryList;
use Piwik\Plugin;
use Piwik\Cache as PiwikCache;
/**
* Get reports that are defined by plugins.
*/
class ReportsProvider
{
private $categoryList;
/**
* Get an instance of a specific report belonging to the given module and having the given action.
* @param string $module
* @param string $action
* @return null|\Piwik\Plugin\Report
* @api
*/
public static function factory($module, $action)
{
$listApiToReport = self::getMapOfModuleActionsToReport();
$api = $module . '.' . ucfirst($action);
if (!array_key_exists($api, $listApiToReport)) {
return null;
}
$klassName = $listApiToReport[$api];
return new $klassName;
}
private static function getMapOfModuleActionsToReport()
{
$cacheId = CacheId::pluginAware('ReportFactoryMap');
$cache = PiwikCache::getEagerCache();
if ($cache->contains($cacheId)) {
$mapApiToReport = $cache->fetch($cacheId);
} else {
$reports = new static();
$reports = $reports->getAllReports();
$mapApiToReport = array();
foreach ($reports as $report) {
$key = $report->getModule() . '.' . ucfirst($report->getAction());
if (isset($mapApiToReport[$key]) && $report->getParameters()) {
// sometimes there are multiple reports with same module/action but different parameters.
// we might pick the "wrong" one. At some point we should compare all parameters and if there is
// a report which parameters mach $_REQUEST then we should prefer that report
continue;
}
$mapApiToReport[$key] = get_class($report);
}
$cache->save($cacheId, $mapApiToReport);
}
return $mapApiToReport;
}
/**
* Returns a list of all available reports. Even not enabled reports will be returned. They will be already sorted
* depending on the order and category of the report.
* @return \Piwik\Plugin\Report[]
* @api
*/
public function getAllReports()
{
$reports = $this->getAllReportClasses();
$cacheId = CacheId::languageAware('Reports' . md5(implode('', $reports)));
$cache = PiwikCache::getTransientCache();
if (!$cache->contains($cacheId)) {
$instances = array();
foreach ($reports as $report) {
$instances[] = new $report();
}
usort($instances, array($this, 'sort'));
$cache->save($cacheId, $instances);
}
return $cache->fetch($cacheId);
}
/**
* API metadata are sorted by category/name,
* with a little tweak to replicate the standard Piwik category ordering
*
* @param Report $a
* @param Report $b
* @return int
*/
private function sort($a, $b)
{
return $this->compareCategories($a->getCategoryId(), $a->getSubcategoryId(), $a->getOrder(), $b->getCategoryId(), $b->getSubcategoryId(), $b->getOrder());
}
public function compareCategories($catIdA, $subcatIdA, $orderA, $catIdB, $subcatIdB, $orderB)
{
if (!isset($this->categoryList)) {
$this->categoryList = CategoryList::get();
}
$catA = $this->categoryList->getCategory($catIdA);
$catB = $this->categoryList->getCategory($catIdB);
// in case there is a category class for both reports
if (isset($catA) && isset($catB)) {
if ($catA->getOrder() == $catB->getOrder()) {
// same category order, compare subcategory order
$subcatA = $catA->getSubcategory($subcatIdA);
$subcatB = $catB->getSubcategory($subcatIdB);
// both reports have a subcategory with custom subcategory class
if ($subcatA && $subcatB) {
if ($subcatA->getOrder() == $subcatB->getOrder()) {
// same subcategory order, compare order of report
if ($orderA == $orderB) {
return 0;
}
return $orderA < $orderB ? -1 : 1;
}
return $subcatA->getOrder() < $subcatB->getOrder() ? -1 : 1;
} elseif ($subcatA) {
return 1;
} elseif ($subcatB) {
return -1;
}
if ($orderA == $orderB) {
return 0;
}
return $orderA < $orderB ? -1 : 1;
}
return $catA->getOrder() < $catB->getOrder() ? -1 : 1;
} elseif (isset($catA)) {
return -1;
} elseif (isset($catB)) {
return 1;
}
if ($catIdA === $catIdB) {
// both have same category, compare order
if ($orderA == $orderB) {
return 0;
}
return $orderA < $orderB ? -1 : 1;
}
return strnatcasecmp($catIdA, $catIdB);
}
/**
* Returns class names of all Report metadata classes.
*
* @return string[]
* @api
*/
public function getAllReportClasses()
{
return Plugin\Manager::getInstance()->findMultipleComponents('Reports', '\\Piwik\\Plugin\\Report');
}
}
|
