Helper.php
7.75 KB
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
<?php
namespace mdm\admin\components;
use mdm\admin\models\Route;
use Yii;
use yii\caching\TagDependency;
use yii\helpers\ArrayHelper;
use yii\web\User;
/**
* Description of Helper
*
* @author Misbahul D Munir <misbahuldmunir@gmail.com>
* @since 2.3
*/
class Helper
{
private static $_userRoutes = [];
private static $_defaultRoutes;
private static $_routes;
public static function getRegisteredRoutes()
{
if (self::$_routes === null) {
self::$_routes = [];
$manager = Configs::authManager();
foreach ($manager->getPermissions() as $item) {
if ($item->name[0] === '/') {
self::$_routes[$item->name] = $item->name;
}
}
}
return self::$_routes;
}
/**
* Get assigned routes by default roles
* @return array
*/
protected static function getDefaultRoutes()
{
if (self::$_defaultRoutes === null) {
$manager = Configs::authManager();
$roles = $manager->defaultRoles;
$cache = Configs::cache();
if ($cache && ($routes = $cache->get($roles)) !== false) {
self::$_defaultRoutes = $routes;
} else {
$permissions = self::$_defaultRoutes = [];
foreach ($roles as $role) {
$permissions = array_merge($permissions, $manager->getPermissionsByRole($role));
}
foreach ($permissions as $item) {
if ($item->name[0] === '/') {
self::$_defaultRoutes[$item->name] = true;
}
}
if ($cache) {
$cache->set($roles, self::$_defaultRoutes, Configs::cacheDuration(), new TagDependency([
'tags' => Configs::CACHE_TAG,
]));
}
}
}
return self::$_defaultRoutes;
}
/**
* Get assigned routes of user.
* @param integer $userId
* @return array
*/
public static function getRoutesByUser($userId)
{
if (!isset(self::$_userRoutes[$userId])) {
$cache = Configs::cache();
if ($cache && ($routes = $cache->get([__METHOD__, $userId])) !== false) {
self::$_userRoutes[$userId] = $routes;
} else {
$routes = static::getDefaultRoutes();
$manager = Configs::authManager();
foreach ($manager->getPermissionsByUser($userId) as $item) {
if ($item->name[0] === '/') {
$routes[$item->name] = true;
}
}
self::$_userRoutes[$userId] = $routes;
if ($cache) {
$cache->set([__METHOD__, $userId], $routes, Configs::cacheDuration(), new TagDependency([
'tags' => Configs::CACHE_TAG,
]));
}
}
}
return self::$_userRoutes[$userId];
}
/**
* Check access route for user.
* @param string|array $route
* @param integer|User $user
* @return boolean
*/
public static function checkRoute($route, $params = [], $user = null)
{
$config = Configs::instance();
$r = static::normalizeRoute($route, $config->advanced);
if ($config->onlyRegisteredRoute && !isset(static::getRegisteredRoutes()[$r])) {
return true;
}
if ($user === null) {
$user = Yii::$app->getUser();
}
$userId = $user instanceof User ? $user->getId() : $user;
if ($config->strict) {
if ($user->can($r, $params)) {
return true;
}
while (($pos = strrpos($r, '/')) > 0) {
$r = substr($r, 0, $pos);
if ($user->can($r . '/*', $params)) {
return true;
}
}
return $user->can('/*', $params);
} else {
$routes = static::getRoutesByUser($userId);
if (isset($routes[$r])) {
return true;
}
while (($pos = strrpos($r, '/')) > 0) {
$r = substr($r, 0, $pos);
if (isset($routes[$r . '/*'])) {
return true;
}
}
return isset($routes['/*']);
}
}
/**
* Normalize route
* @param string $route Plain route string
* @param boolean|array $advanced Array containing the advanced configuration. Defaults to false.
* @return string Normalized route string
*/
protected static function normalizeRoute($route, $advanced = false)
{
if ($route === '') {
$normalized = '/' . Yii::$app->controller->getRoute();
} elseif (strncmp($route, '/', 1) === 0) {
$normalized = $route;
} elseif (strpos($route, '/') === false) {
$normalized = '/' . Yii::$app->controller->getUniqueId() . '/' . $route;
} elseif (($mid = Yii::$app->controller->module->getUniqueId()) !== '') {
$normalized = '/' . $mid . '/' . $route;
} else {
$normalized = '/' . $route;
}
// Prefix @app-id to route.
if ($advanced) {
$normalized = Route::PREFIX_ADVANCED . Yii::$app->id . $normalized;
}
return $normalized;
}
/**
* Filter menu items
* @param array $items
* @param integer|User $user
*/
public static function filter($items, $user = null)
{
if ($user === null) {
$user = Yii::$app->getUser();
}
return static::filterRecursive($items, $user);
}
/**
* Filter menu recursive
* @param array $items
* @param integer|User $user
* @return array
*/
protected static function filterRecursive($items, $user)
{
$result = [];
foreach ($items as $i => $item) {
$url = ArrayHelper::getValue($item, 'url', '#');
$allow = is_array($url) ? static::checkRoute($url[0], array_slice($url, 1), $user) : true;
if (isset($item['items']) && is_array($item['items'])) {
$subItems = self::filterRecursive($item['items'], $user);
if (count($subItems)) {
$allow = true;
}
$item['items'] = $subItems;
}
if ($allow && !($url == '#' && empty($item['items']))) {
$result[$i] = $item;
}
}
return $result;
}
/**
* Filter action column button. Use with [[yii\grid\GridView]]
* ```php
* 'columns' => [
* ...
* [
* 'class' => 'yii\grid\ActionColumn',
* 'template' => Helper::filterActionColumn(['view','update','activate'])
* ]
* ],
* ```
* @param array|string $buttons
* @param integer|User $user
* @return string
*/
public static function filterActionColumn($buttons = [], $user = null)
{
if (is_array($buttons)) {
$result = [];
foreach ($buttons as $button) {
if (static::checkRoute($button, [], $user)) {
$result[] = "{{$button}}";
}
}
return implode(' ', $result);
}
return preg_replace_callback('/\\{([\w\-\/]+)\\}/', function ($matches) use ($user) {
return static::checkRoute($matches[1], [], $user) ? "{{$matches[1]}}" : '';
}, $buttons);
}
/**
* Use to invalidate cache.
*/
public static function invalidate()
{
if (Configs::cache() !== null) {
TagDependency::invalidate(Configs::cache(), Configs::CACHE_TAG);
}
}
}