/
menu.py
242 lines (216 loc) · 7.46 KB
/
menu.py
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
from typing import List
from flask import current_app, url_for
from flask_babel import gettext as __
from .api import BaseApi, expose
from .basemanager import BaseManager
from .security.decorators import permission_name, protect
class MenuItem(object):
def __init__(
self, name, href="", icon="", label="", childs=None, baseview=None, cond=None
):
self.name = name
self.href = href
self.icon = icon
self.label = label
self.childs = childs or []
self.baseview = baseview
self.cond = cond
def should_render(self) -> bool:
return bool(self.cond()) if self.cond is not None else True
def get_url(self):
if not self.href:
if not self.baseview:
return ""
else:
return url_for(f"{self.baseview.endpoint}.{self.baseview.default_view}")
else:
try:
return url_for(self.href)
except Exception:
return self.href
def __repr__(self):
return self.name
class Menu(object):
def __init__(self, reverse=True, extra_classes=""):
self.menu = []
if reverse:
extra_classes = extra_classes + "navbar-inverse"
self.extra_classes = extra_classes
@property
def reverse(self):
return "navbar-inverse" in self.extra_classes
def get_list(self):
return self.menu
def get_flat_name_list(self, menu: "Menu" = None, result: List = None) -> List:
menu = menu or self.menu
result = result or []
for item in menu:
result.append(item.name)
if item.childs:
result.extend(self.get_flat_name_list(menu=item.childs, result=result))
return result
def get_data(self, menu=None):
menu = menu or self.menu
ret_list = []
allowed_menus = current_app.appbuilder.sm.get_user_menu_access(
self.get_flat_name_list()
)
for i, item in enumerate(menu):
if not item.should_render():
continue
if item.name == "-" and not i == len(menu) - 1:
ret_list.append("-")
elif item.name not in allowed_menus:
continue
elif item.childs:
ret_list.append(
{
"name": item.name,
"icon": item.icon,
"label": __(str(item.label)),
"childs": self.get_data(menu=item.childs),
}
)
else:
ret_list.append(
{
"name": item.name,
"icon": item.icon,
"label": __(str(item.label)),
"url": item.get_url(),
}
)
return ret_list
def find(self, name, menu=None):
"""
Finds a menu item by name and returns it.
:param name:
The menu item name.
"""
menu = menu or self.menu
for i in menu:
if i.name == name:
return i
else:
if i.childs:
ret_item = self.find(name, menu=i.childs)
if ret_item:
return ret_item
def add_category(self, category, icon="", label="", parent_category=""):
label = label or category
if parent_category == "":
self.menu.append(MenuItem(name=category, icon=icon, label=label))
else:
self.find(category).childs.append(
MenuItem(name=category, icon=icon, label=label)
)
def add_link(
self,
name,
href="",
icon="",
label="",
category="",
category_icon="",
category_label="",
baseview=None,
cond=None,
):
label = label or name
category_label = category_label or category
if category == "":
self.menu.append(
MenuItem(
name=name,
href=href,
icon=icon,
label=label,
baseview=baseview,
cond=cond,
)
)
else:
menu_item = self.find(category)
if menu_item:
new_menu_item = MenuItem(
name=name,
href=href,
icon=icon,
label=label,
baseview=baseview,
cond=cond,
)
menu_item.childs.append(new_menu_item)
else:
self.add_category(
category=category, icon=category_icon, label=category_label
)
new_menu_item = MenuItem(
name=name,
href=href,
icon=icon,
label=label,
baseview=baseview,
cond=cond,
)
self.find(category).childs.append(new_menu_item)
def add_separator(self, category="", cond=None):
menu_item = self.find(category)
if menu_item:
menu_item.childs.append(MenuItem("-", cond=cond))
else:
raise Exception(
"Menu separator does not have correct category {}".format(category)
)
class MenuApi(BaseApi):
resource_name = "menu"
openapi_spec_tag = "Menu"
@expose("/", methods=["GET"])
@protect(allow_browser_login=True)
@permission_name("get")
def get_menu_data(self):
"""An endpoint for retreiving the menu.
---
get:
description: >-
Get the menu data structure.
Returns a forest like structure with the menu the user has access to
responses:
200:
description: Get menu data
content:
application/json:
schema:
type: object
properties:
result:
description: Menu items in a forest like data structure
type: array
items:
type: object
properties:
name:
description: >-
The internal menu item name, maps to permission_name
type: string
label:
description: Pretty name for the menu item
type: string
icon:
description: Icon name to show for this menu item
type: string
url:
description: The URL for the menu item
type: string
childs:
type: array
items:
type: object
401:
$ref: '#/components/responses/401'
"""
return self.response(200, result=current_app.appbuilder.menu.get_data())
class MenuApiManager(BaseManager):
def register_views(self):
if self.appbuilder.app.config.get("FAB_ADD_MENU_API", True):
self.appbuilder.add_api(MenuApi)