From eda0e74cb41a6674e636c86bb039c7582bc773d1 Mon Sep 17 00:00:00 2001
From: Bben <47628473+Bbillyben@users.noreply.github.com>
Date: Wed, 21 Dec 2022 00:21:07 +0100
Subject: [PATCH] UrlsMixin plugin update custom urls on load (#4065)

* For pure UrlsMixin plugin, invalidate the url to be able to trigger the update

* Delete stock.json

* Add UrlsMixin Plugin activation methods

* whitespace / breakline removal

* whitespace?

* whitespace again

* linebreak

* Delete .pre-commit-config.yaml

* restore .pre-comiit.yaml
---
 InvenTree/plugin/registry.py | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/InvenTree/plugin/registry.py b/InvenTree/plugin/registry.py
index d8a96709d3..1b81c22a98 100644
--- a/InvenTree/plugin/registry.py
+++ b/InvenTree/plugin/registry.py
@@ -462,6 +462,7 @@ class PluginsRegistry:
         self.activate_plugin_settings(plugins)
         self.activate_plugin_schedule(plugins)
         self.activate_plugin_app(plugins, force_reload=force_reload, full_reload=full_reload)
+        self.activate_plugin_url(plugins, force_reload=force_reload, full_reload=full_reload)
 
     def _deactivate_plugins(self):
         """Run deactivation functions for all plugins."""
@@ -564,7 +565,6 @@ class PluginsRegistry:
                         settings.INSTALLED_APPS += [plugin_path]
                         self.installed_apps += [plugin_path]
                         apps_changed = True
-
             # if apps were changed or force loading base apps -> reload
             if apps_changed or force_reload:
                 # first startup or force loading of base apps -> registry is prob false
@@ -580,6 +580,27 @@ class PluginsRegistry:
                 # update urls - must be last as models must be registered for creating admin routes
                 self._update_urls()
 
+    def activate_plugin_url(self, plugins, force_reload=False, full_reload: bool = False):
+        """Activate UrlsMixin plugins - add custom urls .
+
+        Args:
+            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
+                self._update_urls()
+
     def _reregister_contrib_apps(self):
         """Fix reloading of contrib apps - models and admin.