139 lines
4.9 KiB
Python
139 lines
4.9 KiB
Python
import dataclasses # Copyright (C) 2016-2024 RhodeCode GmbH
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License, version 3
|
|
# (only), as published by the Free Software Foundation.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# This program is dual-licensed. If you wish to learn more about the
|
|
# RhodeCode Enterprise Edition, including its added features, Support services,
|
|
# and proprietary license terms, please see https://rhodecode.com/licenses/
|
|
|
|
|
|
import logging
|
|
import collections
|
|
|
|
from zope.interface import implementer
|
|
|
|
from rhodecode.apps._base.interfaces import IAdminNavigationRegistry
|
|
from rhodecode.lib.utils2 import str2bool
|
|
from rhodecode.translation import _
|
|
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
@dataclasses.dataclass
|
|
class NavListEntry:
|
|
key: str
|
|
name: str
|
|
url: str
|
|
active_list: list
|
|
|
|
|
|
class NavEntry(object):
|
|
"""
|
|
Represents an entry in the admin navigation.
|
|
|
|
:param key: Unique identifier used to store reference in an OrderedDict.
|
|
:param name: Display name, usually a translation string.
|
|
:param view_name: Name of the view, used generate the URL.
|
|
:param active_list: list of urls that we select active for this element
|
|
"""
|
|
|
|
def __init__(self, key, name, view_name, active_list=None):
|
|
self.key = key
|
|
self.name = name
|
|
self.view_name = view_name
|
|
self._active_list = active_list or []
|
|
|
|
def generate_url(self, request):
|
|
return request.route_path(self.view_name)
|
|
|
|
def get_localized_name(self, request):
|
|
return request.translate(self.name)
|
|
|
|
@property
|
|
def active_list(self):
|
|
active_list = [self.key]
|
|
if self._active_list:
|
|
active_list = self._active_list
|
|
return active_list
|
|
|
|
|
|
@implementer(IAdminNavigationRegistry)
|
|
class NavigationRegistry(object):
|
|
_base_entries = [
|
|
NavEntry("global", _("Global"), "admin_settings_global"),
|
|
NavEntry("ai", _("AI features"), "admin_settings_ai"),
|
|
NavEntry("vcs", _("VCS"), "admin_settings_vcs"),
|
|
NavEntry("visual", _("Visual"), "admin_settings_visual"),
|
|
NavEntry("mapping", _("Remap and Rescan"), "admin_settings_mapping"),
|
|
NavEntry("issuetracker", _("Issue Tracker"), "admin_settings_issuetracker"),
|
|
NavEntry("email", _("Email"), "admin_settings_email"),
|
|
NavEntry("hooks", _("Hooks"), "admin_settings_hooks"),
|
|
NavEntry("search", _("Full Text Search"), "admin_settings_search"),
|
|
NavEntry("system", _("System Info"), "admin_settings_system"),
|
|
NavEntry(
|
|
"exceptions",
|
|
_("Exceptions Tracker"),
|
|
"admin_settings_exception_tracker",
|
|
active_list=["exceptions", "exceptions_browse"],
|
|
),
|
|
NavEntry("process_management", _("Processes"), "admin_settings_process_management"),
|
|
NavEntry("sessions", _("User Sessions"), "admin_settings_sessions"),
|
|
NavEntry("open_source", _("Open Source Licenses"), "admin_settings_open_source"),
|
|
NavEntry("user_quotas", _("User Quotas"), "admin_settings_user_quotas"),
|
|
]
|
|
|
|
_labs_entry = NavEntry("labs", _("Labs"), "admin_settings_labs")
|
|
|
|
def __init__(self, labs_active=False):
|
|
self._registered_entries = collections.OrderedDict()
|
|
for item in self.__class__._base_entries:
|
|
self.add_entry(item)
|
|
|
|
if labs_active:
|
|
self.add_entry(self._labs_entry)
|
|
|
|
def add_entry(self, entry):
|
|
self._registered_entries[entry.key] = entry
|
|
|
|
def get_navlist(self, request):
|
|
nav_list = [
|
|
NavListEntry(i.key, i.get_localized_name(request), i.generate_url(request), i.active_list)
|
|
for i in self._registered_entries.values()
|
|
]
|
|
return nav_list
|
|
|
|
|
|
def navigation_registry(request, registry=None):
|
|
"""
|
|
Helper that returns the admin navigation registry.
|
|
"""
|
|
pyramid_registry = registry or request.registry
|
|
nav_registry = pyramid_registry.queryUtility(IAdminNavigationRegistry)
|
|
return nav_registry
|
|
|
|
|
|
def navigation_list(request):
|
|
"""
|
|
Helper that returns the admin navigation as list of NavListEntry objects.
|
|
"""
|
|
return navigation_registry(request).get_navlist(request)
|
|
|
|
|
|
def includeme(config):
|
|
# Create admin navigation registry and add it to the pyramid registry.
|
|
settings = config.get_settings()
|
|
labs_active = str2bool(settings.get("labs_settings_active", False))
|
|
navigation_registry_instance = NavigationRegistry(labs_active=labs_active)
|
|
config.registry.registerUtility(navigation_registry_instance)
|
|
log.debug("Created new navigation instance, %s", navigation_registry_instance)
|