Refactor Navigation Signals for Dashboard Separation (#528)

* FMT Fix

* Undoing Initial PR code

---------

Co-authored-by: Daksh Bhayana <[email protected]>

Author: Daksh2000

src/pretix/eventyay_common/navigation.py

@@ -6,7 +6,8 @@
 
 from pretix.base.models import Event
 from pretix.control.navigation import merge_in
-from pretix.control.signals import nav_event, nav_global
+from pretix.control.signals import nav_global
+from pretix.eventyay_common.signals import nav_event_common
 
 
 def get_global_navigation(request: HttpRequest) -> List[Dict[str, Any]]:
@@ -92,7 +93,7 @@ def get_event_navigation(request: HttpRequest, event: Event) -> List[Dict[str, A
     ]
 
     # Merge plugin-provided navigation items
-    plugin_responses = nav_event.send(event, request=request)
+    plugin_responses = nav_event_common.send(event, request=request)
     plugin_nav_items = []
     for receiver, response in plugin_responses:
         if response:

src/pretix/eventyay_common/signals.py

@@ -0,0 +1,26 @@
+from pretix.base.signals import EventPluginSignal
+
+nav_event_common = EventPluginSignal()
+"""
+Arguments: ``request``
+
+This signal allows you to add additional views to the common sidebar navigation.
+You will get the request as a keyword argument ``request``.
+Receivers are expected to return a list of dictionaries. The dictionaries
+should contain at least the keys ``label`` and ``url``. You can also return
+a fontawesome icon name with the key ``icon``, it will be respected depending
+on the type of navigation. You should also return an ``active`` key with a boolean
+set to ``True``, when this item should be marked as active. The ``request`` object
+will have an attribute ``event``.
+
+You can optionally create sub-items to create hierarchical navigation. There are two
+ways to achieve this: Either you specify a key ``children`` on your top navigation item
+that contains a list of navigation items (as dictionaries), or you specify a ``parent``
+key with the ``url`` value of the designated parent item.
+The latter method also allows you to register navigation items as a sub-item of existing ones.
+
+If you use this, you should read the documentation on :ref:`how to deal with URLs <urlconf>`
+in pretix.
+
+As with all plugin signals, the ``sender`` keyword argument will contain the event.
+"""

src/pretix/plugins/webcheckin/signals.py

@@ -3,10 +3,10 @@
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 
-from pretix.control.signals import nav_event
+from pretix.eventyay_common.signals import nav_event_common
 
 
-@receiver(nav_event, dispatch_uid='webcheckin_nav_event')
+@receiver(nav_event_common, dispatch_uid='webcheckin_nav_event')
 def navbar_entry(sender, request, **kwargs):
     url = request.resolver_match
     if not request.user.has_event_permission(request.organizer, request.event, ('can_change_orders', 'can_checkin_orders'), request=request):