feat(plugins): pass bound plugin to as_navigation_spec()

esnvutbrno · Aug 17, 2023 · caeeb38 · caeeb38
1 parent de17871
commit caeeb38
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 9 deletions.
diff --git a/fiesta/apps/buddy_system/apps.py b/fiesta/apps/buddy_system/apps.py
@@ -10,6 +10,7 @@
 
 if typing.TYPE_CHECKING:
     from apps.plugins.middleware.plugin import HttpRequest
+    from apps.plugins.models import Plugin
 
 
 class BuddySystemConfig(PluginAppConfig):
@@ -26,8 +27,8 @@ class BuddySystemConfig(PluginAppConfig):
 
     membership_not_required_urls = ("new-request",)
 
-    def as_navigation_item(self, request: HttpRequest) -> NavigationItemSpec | None:
-        base = super().as_navigation_item(request)
+    def as_navigation_item(self, request: HttpRequest, bound_plugin: Plugin) -> NavigationItemSpec | None:
+        base = super().as_navigation_item(request, bound_plugin)
         if not request.membership.is_privileged:
             return base
 

diff --git a/fiesta/apps/dashboard/apps.py b/fiesta/apps/dashboard/apps.py
@@ -9,6 +9,7 @@
 
 if typing.TYPE_CHECKING:
     from apps.plugins.middleware.plugin import HttpRequest
+    from apps.plugins.models.plugin import Plugin
 
 
 class DashboardConfig(PluginAppConfig):
@@ -18,7 +19,7 @@ class DashboardConfig(PluginAppConfig):
 
     configuration_model = "dashboard.DashboardConfiguration"
 
-    def as_navigation_item(self, request: HttpRequest) -> NavigationItemSpec | None:
+    def as_navigation_item(self, request: HttpRequest, bound_plugin: Plugin) -> NavigationItemSpec | None:
         # do not display in menu, since it's the home button link if the plugin is enabled
         return None
 

diff --git a/fiesta/apps/esncards/apps.py b/fiesta/apps/esncards/apps.py
@@ -10,6 +10,7 @@
 
 if typing.TYPE_CHECKING:
     from apps.plugins.middleware.plugin import HttpRequest
+    from apps.plugins.models import Plugin
 
 
 class ESNcardsConfig(PluginAppConfig):
@@ -20,8 +21,8 @@ class ESNcardsConfig(PluginAppConfig):
 
     verbose_name = _("ESNcard")
 
-    def as_navigation_item(self, request: HttpRequest) -> NavigationItemSpec | None:
-        base = super().as_navigation_item(request)
+    def as_navigation_item(self, request: HttpRequest, bound_plugin: Plugin) -> NavigationItemSpec | None:
+        base = super().as_navigation_item(request, bound_plugin)
         if not request.membership.is_privileged:
             return base
 

diff --git a/fiesta/apps/pages/apps.py b/fiesta/apps/pages/apps.py
@@ -8,6 +8,7 @@
 
 if typing.TYPE_CHECKING:
     from apps.plugins.middleware.plugin import HttpRequest
+    from apps.plugins.models.plugin import Plugin
     from apps.utils.templatetags.navigation import NavigationItemSpec
 
 
@@ -25,7 +26,7 @@ class PagesConfig(PluginAppConfig):
     def url_prefix(self) -> str:
         return "_/"
 
-    def as_navigation_item(self, request: HttpRequest) -> NavigationItemSpec | None:
+    def as_navigation_item(self, request: HttpRequest, bound_plugin: Plugin) -> NavigationItemSpec | None:
         return None
 
 

diff --git a/fiesta/apps/plugins/plugin.py b/fiesta/apps/plugins/plugin.py
@@ -13,6 +13,7 @@
 
 if typing.TYPE_CHECKING:
     from apps.plugins.middleware.plugin import HttpRequest
+    from apps.plugins.models.plugin import Plugin
 
 
 class PluginAppConfig(AppConfig, metaclass=ABCMeta):
@@ -65,7 +66,7 @@ def url_prefix(self) -> str:
         """Defines prefix, under which are all urls included."""
         return self.label.replace("_", "-") + "/"
 
-    def as_navigation_item(self, request: HttpRequest) -> NavigationItemSpec | None:
+    def as_navigation_item(self, request: HttpRequest, bound_plugin: Plugin) -> NavigationItemSpec | None:
         return NavigationItemSpec(
             self.verbose_name,
             f"/{self.url_prefix}",

diff --git a/fiesta/apps/sections/apps.py b/fiesta/apps/sections/apps.py
@@ -10,6 +10,7 @@
 
 if typing.TYPE_CHECKING:
     from apps.plugins.middleware.plugin import HttpRequest
+    from apps.plugins.models import Plugin
 
 
 class SectionsConfig(PluginAppConfig):
@@ -24,11 +25,11 @@ class SectionsConfig(PluginAppConfig):
         "choose-space",
     ]
 
-    def as_navigation_item(self, request: HttpRequest) -> NavigationItemSpec | None:
+    def as_navigation_item(self, request: HttpRequest, bound_plugin: Plugin) -> NavigationItemSpec | None:
         if request.membership.is_privileged:
             return (
                 super()
-                .as_navigation_item(request)
+                .as_navigation_item(request, bound_plugin)
                 ._replace(
                     url="",
                     children=[