mirror of
https://github.com/netbox-community/netbox.git
synced 2026-03-28 04:12:10 +01:00
af27bf5eff
* 15049 add missing gettext to error strings * 15049 add missing gettext to error strings * 15094 review change * 15094 review change * Formatting cleanup --------- Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>
84 lines
2.9 KiB
Python
84 lines
2.9 KiB
Python
import inspect
|
|
|
|
from django.utils.translation import gettext_lazy as _
|
|
from netbox.registry import registry
|
|
from .navigation import PluginMenu, PluginMenuButton, PluginMenuItem
|
|
from .templates import PluginTemplateExtension
|
|
|
|
__all__ = (
|
|
'register_graphql_schema',
|
|
'register_menu',
|
|
'register_menu_items',
|
|
'register_template_extensions',
|
|
'register_user_preferences',
|
|
)
|
|
|
|
|
|
def register_template_extensions(class_list):
|
|
"""
|
|
Register a list of PluginTemplateExtension classes
|
|
"""
|
|
# Validation
|
|
for template_extension in class_list:
|
|
if not inspect.isclass(template_extension):
|
|
raise TypeError(
|
|
_("PluginTemplateExtension class {template_extension} was passed as an instance!").format(
|
|
template_extension=template_extension
|
|
)
|
|
)
|
|
if not issubclass(template_extension, PluginTemplateExtension):
|
|
raise TypeError(
|
|
_("{template_extension} is not a subclass of netbox.plugins.PluginTemplateExtension!").format(
|
|
template_extension=template_extension
|
|
)
|
|
)
|
|
if template_extension.model is None:
|
|
raise TypeError(
|
|
_("PluginTemplateExtension class {template_extension} does not define a valid model!").format(
|
|
template_extension=template_extension
|
|
)
|
|
)
|
|
|
|
registry['plugins']['template_extensions'][template_extension.model].append(template_extension)
|
|
|
|
|
|
def register_menu(menu):
|
|
if not isinstance(menu, PluginMenu):
|
|
raise TypeError(_("{item} must be an instance of netbox.plugins.PluginMenuItem").format(
|
|
item=menu_link
|
|
))
|
|
registry['plugins']['menus'].append(menu)
|
|
|
|
|
|
def register_menu_items(section_name, class_list):
|
|
"""
|
|
Register a list of PluginMenuItem instances for a given menu section (e.g. plugin name)
|
|
"""
|
|
# Validation
|
|
for menu_link in class_list:
|
|
if not isinstance(menu_link, PluginMenuItem):
|
|
raise TypeError(_("{menu_link} must be an instance of netbox.plugins.PluginMenuItem").format(
|
|
menu_link=menu_link
|
|
))
|
|
for button in menu_link.buttons:
|
|
if not isinstance(button, PluginMenuButton):
|
|
raise TypeError(_("{button} must be an instance of netbox.plugins.PluginMenuButton").format(
|
|
button=button
|
|
))
|
|
|
|
registry['plugins']['menu_items'][section_name] = class_list
|
|
|
|
|
|
def register_graphql_schema(graphql_schema):
|
|
"""
|
|
Register a GraphQL schema class for inclusion in NetBox's GraphQL API.
|
|
"""
|
|
registry['plugins']['graphql_schemas'].append(graphql_schema)
|
|
|
|
|
|
def register_user_preferences(plugin_name, preferences):
|
|
"""
|
|
Register a list of user preferences defined by a plugin.
|
|
"""
|
|
registry['plugins']['preferences'][plugin_name] = preferences
|