Source code for aj.plugins.core.api.sidebar
from jadi import interface, service
from aj.auth import authorize, SecurityError
[docs]@interface
class SidebarItemProvider():
"""
Interface for providing sidebar items.
"""
def __init__(self, context):
pass
[docs] def provide(self):
"""
Should return a list of sidebar items, each in the following format::
{
'id': 'optional-id',
'attach': 'category:general', # id of the attachment point or None for top level
'name': 'Dashboard',
'icon': 'bar-chart',
'url': '/view/dashboard',
'children': [
...
]
}
:returns: list(dict)
"""
return []
[docs]@service
class Sidebar():
def __init__(self, context):
self.context = context
[docs] def build(self):
"""
Returns a complete tree of sidebar items.
:returns: dict
"""
sidebar = {
'id': None,
'children': [],
}
def find_id(_id, e=sidebar):
if 'id' in e and e['id'] == _id:
return e
for c in e.get('children', []):
f = find_id(_id, e=c)
if f:
return f
for provider in SidebarItemProvider.all(self.context):
for item in provider.provide():
if 'url' in item:
try:
authorize(f'sidebar:view:{item["url"]}').check()
except SecurityError:
continue
attach_to = find_id(item['attach'])
if not attach_to:
raise Exception(f'Attachment point not found: {item["attach"]}')
attach_to['children'].append(item)
return sidebar