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
|
<?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\API;
use Piwik\Category\CategoryList;
use Piwik\Piwik;
use Piwik\Plugins\CoreHome\CoreHome;
use Piwik\Report\ReportWidgetConfig;
use Piwik\Category\Category;
use Piwik\Category\Subcategory;
use Piwik\Widget\WidgetContainerConfig;
use Piwik\Widget\WidgetConfig;
use Piwik\Widget\WidgetsList;
class WidgetMetadata
{
public function getPagesMetadata(CategoryList $categoryList, WidgetsList $widgetsList)
{
$this->createMissingCategoriesAndSubcategories($categoryList, $widgetsList->getWidgetConfigs());
return $this->buildPagesMetadata($categoryList, $widgetsList);
}
public function getWidgetMetadata(CategoryList $categoryList, WidgetsList $widgetsList)
{
$this->createMissingCategoriesAndSubcategories($categoryList, $widgetsList->getWidgetConfigs());
$flat = array();
foreach ($widgetsList->getWidgetConfigs() as $widgetConfig) {
$metadataOverrides = [];
/** @var WidgetConfig[] $widgets */
$widgets = array($widgetConfig);
if ($widgetConfig instanceof WidgetContainerConfig) {
// so far we go only one level down, in theory these widgetConfigs could have again containers containing configs
$widgets = array_merge($widgets, $widgetConfig->getWidgetConfigs());
}
foreach ($widgets as $widget) {
// make sure to include only widgetizable widgets
if (!$widget->isWidgetizeable() || !$widget->getName()) {
continue;
}
// widgets in containers with ByDimension layout have a special, unrecognized category/subcategory
// (eg, "Sales by Referrer Type"). we change it to the container's category/subcategory so the widget
// will appear in the dashboard manager.
if ($widgetConfig instanceof WidgetContainerConfig
&& $widgetConfig->getLayout() == CoreHome::WIDGET_CONTAINER_LAYOUT_BY_DIMENSION
) {
$metadataOverrides = [
'category' => $widgetConfig->getCategoryId(),
'subcategory' => $widgetConfig->getSubcategoryId(),
'name' => Piwik::translate($widget->getCategoryId()) . ': '
. Piwik::translate($widget->getName()),
];
}
$flat[] = $this->buildWidgetMetadata($widget, $categoryList, $metadataOverrides);
}
}
usort($flat, array($this, 'sortWidgets'));
return $flat;
}
/**
* @param WidgetConfig $widget
* @param CategoryList|null $categoryList If null, no category information will be added to the widgets in first
* level (they will be added to nested widgets as potentially needed eg for
* widgets in ByDimensionView where they are needed to build the left menu)
* @param array $metadataOverrides Overrides for data in `$widget`. Currently only 'name', 'category', 'subcategory'
* are recognized.
* @return array
*/
public function buildWidgetMetadata(WidgetConfig $widget, $categoryList = null, array $metadataOverrides = [])
{
$widgetName = !empty($metadataOverrides['name']) ? $metadataOverrides['name'] : $widget->getName();
$item = array(
'name' => Piwik::translate($widgetName),
);
if (isset($categoryList)) {
$widgetCategory = !empty($metadataOverrides['category'])
? $metadataOverrides['category'] : $widget->getCategoryId();
$widgetSubcategory = !empty($metadataOverrides['subcategory'])
? $metadataOverrides['subcategory'] : $widget->getSubcategoryId();
$category = $categoryList->getCategory($widgetCategory);
$subcategory = $category ? $category->getSubcategory($widgetSubcategory) : null;
$item['category'] = $this->buildCategoryMetadata($category);
$item['subcategory'] = $this->buildSubcategoryMetadata($subcategory);
}
$item['module'] = $widget->getModule();
$item['action'] = $widget->getAction();
$item['order'] = $widget->getOrder();
$item['parameters'] = $widget->getParameters();
$item['uniqueId'] = $widget->getUniqueId();
$item['isWide'] = $widget->isWide();
$middleware = $widget->getMiddlewareParameters();
if (!empty($middleware)) {
$item['middlewareParameters'] = $middleware;
}
if ($widget instanceof ReportWidgetConfig) {
$item['viewDataTable'] = $widget->getViewDataTable();
$item['isReport'] = true;
}
if ($widget instanceof WidgetContainerConfig) {
$item['layout'] = $widget->getLayout();
$item['isContainer'] = true;
// we do not want to create categories to the initial categoryList. Otherwise we'd maybe display more pages
// etc.
$subCategoryList = new CategoryList();
$this->createMissingCategoriesAndSubcategories($subCategoryList, $widget->getWidgetConfigs());
$children = array();
foreach ($widget->getWidgetConfigs() as $widgetConfig) {
$children[] = $this->buildWidgetMetadata($widgetConfig, $subCategoryList);
}
$item['widgets'] = $children;
}
return $item;
}
private function sortWidgets($widgetA, $widgetB) {
$orderA = $widgetA['category']['order'];
$orderB = $widgetB['category']['order'];
if ($orderA === $orderB) {
if (!empty($widgetA['subcategory']['order']) && !empty($widgetB['subcategory']['order'])) {
$subOrderA = $widgetA['subcategory']['order'];
$subOrderB = $widgetB['subcategory']['order'];
if ($subOrderA === $subOrderB) {
return $this->compareWidgetIds($widgetA, $widgetB);
}
return $subOrderA > $subOrderB ? 1 : -1;
} else if (empty($widgetA['subcategory']['order']) && empty($widgetB['subcategory']['order'])) {
return $this->compareWidgetIds($widgetA, $widgetB);
} elseif (!empty($widgetA['subcategory']['order'])) {
return 1;
}
return -1;
}
return $orderA > $orderB ? 1 : -1;
}
private function compareWidgetIds($widgetA, $widgetB)
{
if ($widgetA['uniqueId'] == $widgetB['uniqueId']) {
return 0;
}
return $widgetA['uniqueId'] > $widgetB['uniqueId'] ? 1 : -1;
}
/**
* @param Category|null $category
* @return array
*/
private function buildCategoryMetadata($category)
{
if (!isset($category)) {
return null;
}
return array(
'id' => (string) $category->getId(),
'name' => $category->getDisplayName(),
'order' => $category->getOrder(),
'icon' => $category->getIcon(),
);
}
/**
* @param Subcategory|null $subcategory
* @return array
*/
private function buildSubcategoryMetadata($subcategory)
{
if (!isset($subcategory)) {
return null;
}
return array(
'id' => (string) $subcategory->getId(),
'name' => Piwik::translate($subcategory->getName()),
'order' => $subcategory->getOrder(),
);
}
/**
* @param CategoryList $categoryList
* @param WidgetConfig[] $widgetConfigs
*/
private function createMissingCategoriesAndSubcategories($categoryList, $widgetConfigs)
{
// move reports into categories/subcategories and create missing ones if needed
foreach ($widgetConfigs as $widgetConfig) {
$categoryId = $widgetConfig->getCategoryId();
$subcategoryId = $widgetConfig->getSubcategoryId();
if (!$categoryId) {
continue;
}
if ($widgetConfig instanceof WidgetContainerConfig && !$widgetConfig->getWidgetConfigs()) {
// if a container does not contain any widgets, ignore it
continue;
}
if (!$categoryList->hasCategory($categoryId)) {
$categoryList->addCategory($this->createCategory($categoryId));
}
if (!$subcategoryId) {
continue;
}
$category = $categoryList->getCategory($categoryId);
if (!$category->hasSubcategory($subcategoryId)) {
$category->addSubcategory($this->createSubcategory($categoryId, $subcategoryId));
}
}
}
private function createCategory($categoryId)
{
$category = new Category();
$category->setId($categoryId);
return $category;
}
private function createSubcategory($categoryId, $subcategoryId)
{
$subcategory = new Subcategory();
$subcategory->setCategoryId($categoryId);
$subcategory->setId($subcategoryId);
return $subcategory;
}
/**
* @param CategoryList $categoryList
* @param WidgetsList $widgetsList
* @return array
*/
private function buildPagesMetadata(CategoryList $categoryList, WidgetsList $widgetsList)
{
$pages = array();
$widgets = array();
foreach ($widgetsList->getWidgetConfigs() as $config) {
$pageId = $this->buildPageId($config->getCategoryId(), $config->getSubcategoryId());
if (!isset($widgets[$pageId])) {
$widgets[$pageId] = array();
}
$widgets[$pageId][] = $config;
}
foreach ($categoryList->getCategories() as $category) {
foreach ($category->getSubcategories() as $subcategory) {
$pageId = $this->buildPageId($category->getId(), $subcategory->getId());
if (!empty($widgets[$pageId])) {
$pages[] = $this->buildPageMetadata($category, $subcategory, $widgets[$pageId]);
}
}
}
return $pages;
}
private function buildPageId($categoryId, $subcategoryId)
{
return $categoryId . '.' . $subcategoryId;
}
public function buildPageMetadata(Category $category, Subcategory $subcategory, $widgetConfigs)
{
$ca = array(
'uniqueId' => $this->buildPageId($category->getId(), $subcategory->getId()),
'category' => $this->buildCategoryMetadata($category),
'subcategory' => $this->buildSubcategoryMetadata($subcategory),
'widgets' => array()
);
foreach ($widgetConfigs as $config) {
$ca['widgets'][] = $this->buildWidgetMetadata($config);
}
return $ca;
}
}
|