mirror of
https://github.com/inventree/InvenTree.git
synced 2025-04-29 20:16:44 +00:00
1b8ad70fb6
* add mixin order ref * move import * fix import order * reorder import * move activation/deactivation to mixins * move loaded/unloaded mixins out into seperate modules * fix deactivation sequence * switch to classmethods for loading * only run (de)activation if defined for mixin Fixes #4184 * fix deactivating * move reloading back to registry * fix merge error * move app mixin deactivation * fix migration reloading * reverse deactivation sequence * Revert "reverse deactivation sequence" This reverts commit aff17dd07d3c991549acf3ffa34002ccec2b6123.
74 lines
2.4 KiB
Python
74 lines
2.4 KiB
Python
"""Plugin mixin class for UrlsMixin."""
|
|
import logging
|
|
|
|
from django.conf import settings
|
|
from django.urls import include, re_path
|
|
|
|
from plugin.urls import PLUGIN_BASE
|
|
|
|
logger = logging.getLogger('inventree')
|
|
|
|
|
|
class UrlsMixin:
|
|
"""Mixin that enables custom URLs for the plugin."""
|
|
|
|
class MixinMeta:
|
|
"""Meta options for this mixin."""
|
|
|
|
MIXIN_NAME = 'URLs'
|
|
|
|
def __init__(self):
|
|
"""Register mixin."""
|
|
super().__init__()
|
|
self.add_mixin('urls', 'has_urls', __class__)
|
|
self.urls = self.setup_urls()
|
|
|
|
@classmethod
|
|
def _activate_mixin(cls, registry, plugins, force_reload=False, full_reload: bool = False):
|
|
"""Activate UrlsMixin plugins - add custom urls .
|
|
|
|
Args:
|
|
registry (PluginRegistry): The registry that should be used
|
|
plugins (dict): List of IntegrationPlugins that should be installed
|
|
force_reload (bool, optional): Only reload base apps. Defaults to False.
|
|
full_reload (bool, optional): Reload everything - including plugin mechanism. Defaults to False.
|
|
"""
|
|
from common.models import InvenTreeSetting
|
|
if settings.PLUGIN_TESTING or InvenTreeSetting.get_setting('ENABLE_PLUGINS_URL'):
|
|
logger.info('Registering UrlsMixin Plugin')
|
|
urls_changed = False
|
|
# check whether an activated plugin extends UrlsMixin
|
|
for _key, plugin in plugins:
|
|
if plugin.mixin_enabled('urls'):
|
|
urls_changed = True
|
|
# if apps were changed or force loading base apps -> reload
|
|
if urls_changed or force_reload or full_reload:
|
|
# update urls - must be last as models must be registered for creating admin routes
|
|
registry._update_urls()
|
|
|
|
def setup_urls(self):
|
|
"""Setup url endpoints for this plugin."""
|
|
return getattr(self, 'URLS', None)
|
|
|
|
@property
|
|
def base_url(self):
|
|
"""Base url for this plugin."""
|
|
return f'{PLUGIN_BASE}/{self.slug}/'
|
|
|
|
@property
|
|
def internal_name(self):
|
|
"""Internal url pattern name."""
|
|
return f'plugin:{self.slug}:'
|
|
|
|
@property
|
|
def urlpatterns(self):
|
|
"""Urlpatterns for this plugin."""
|
|
if self.has_urls:
|
|
return re_path(f'^{self.slug}/', include((self.urls, self.slug)), name=self.slug)
|
|
return None
|
|
|
|
@property
|
|
def has_urls(self):
|
|
"""Does this plugin use custom urls."""
|
|
return bool(self.urls)
|