remove a few unused mixins, rename some permission mixins to make it more clear what they do

Author: tykling

src/backoffice/views/backoffice.py

@@ -6,7 +6,7 @@
 from django.http import HttpResponse
 from django.views.generic import TemplateView
 
-from utils.mixins import TeamMemberRequiredMixin
+from utils.mixins import AnyTeamMemberRequiredMixin
 from utils.mixins import RaisePermissionRequiredMixin
 from camps.mixins import CampViewMixin
 from facilities.models import FacilityFeedback
@@ -16,7 +16,7 @@
 logger = logging.getLogger("bornhack.%s" % __name__)
 
 
-class BackofficeIndexView(CampViewMixin, TeamMemberRequiredMixin, TemplateView):
+class BackofficeIndexView(CampViewMixin, AnyTeamMemberRequiredMixin, TemplateView):
     """
     The Backoffice index view is available to anyone who is an approved member of any team for the current camp.
     """

src/backoffice/views/facilities.py

@@ -29,7 +29,7 @@
 from facilities.models import FacilityType
 from teams.models import Team
 from utils.widgets import IconPickerWidget
-from utils.mixins import TeamFacilitatorRequiredMixin
+from utils.mixins import AnyTeamFacilitatorRequiredMixin
 
 logger = logging.getLogger("bornhack.%s" % __name__)
 
@@ -214,7 +214,7 @@ def get_success_url(self):
 # ########### FACILITIES ######################
 
 
-class FacilityListView(CampViewMixin, TeamFacilitatorRequiredMixin, ListView):
+class FacilityListView(CampViewMixin, AnyTeamFacilitatorRequiredMixin, ListView):
     model = Facility
     template_name = "facility_list_backoffice.html"
 
@@ -251,7 +251,7 @@ def get_context_data(self, **kwargs):
         return context
 
 
-class FacilityDetailView(TeamFacilitatorRequiredMixin, DetailView):
+class FacilityDetailView(AnyTeamFacilitatorRequiredMixin, DetailView):
     model = Facility
     template_name = "facility_detail_backoffice.html"
     pk_url_kwarg = "facility_uuid"
@@ -281,7 +281,7 @@ def get_queryset(self, *args, **kwargs):
         return qs.prefetch_related("opening_hours")
 
 
-class FacilityCreateView(CampViewMixin, TeamFacilitatorRequiredMixin, CreateView):
+class FacilityCreateView(CampViewMixin, AnyTeamFacilitatorRequiredMixin, CreateView):
     model = Facility
     template_name = "facility_form.html"
     fields = ["facility_type", "name", "description", "location"]

src/backoffice/views/maps.py

@@ -23,7 +23,7 @@
 from maps.models import Layer
 from teams.models import Team
 from utils.widgets import IconPickerWidget
-from utils.mixins import TeamMapperRequiredMixin
+from utils.mixins import AnyTeamMapperRequiredMixin
 from maps.mixins import LayerMapperViewMixin
 from maps.mixins import ExternalLayerMapperViewMixin
 
@@ -33,7 +33,7 @@
 # ################# LAYERS ########################
 
 
-class MapLayerListView(CampViewMixin, TeamMapperRequiredMixin, ListView):
+class MapLayerListView(CampViewMixin, AnyTeamMapperRequiredMixin, ListView):
     model = Layer
     template_name = "maps_layer_list_backoffice.html"
     context_object_name = "maps_layer_list"
@@ -164,7 +164,7 @@ def create_feature_object(self, feature_uuid, props, layer, geom):
             self.error_count += 1
 
 
-class MapLayerCreateView(CampViewMixin, TeamMapperRequiredMixin, CreateView):
+class MapLayerCreateView(CampViewMixin, AnyTeamMapperRequiredMixin, CreateView):
     model = Layer
     template_name = "maps_layer_form.html"
     fields = [
@@ -389,7 +389,7 @@ def get_success_url(self):
 # ################# EXTERNAL LAYERS ################
 
 
-class MapExternalLayerCreateView(CampViewMixin, TeamMapperRequiredMixin, CreateView):
+class MapExternalLayerCreateView(CampViewMixin, AnyTeamMapperRequiredMixin, CreateView):
     model = ExternalLayer
     template_name = "maps_external_layer_form.html"
     fields = [

src/backoffice/views/pos.py

@@ -1,5 +1,5 @@
 import json
-from utils.mixins import TeamPosRequiredMixin
+from utils.mixins import AnyTeamPosRequiredMixin
 import logging
 
 from django.contrib import messages
@@ -41,7 +41,7 @@
 logger = logging.getLogger("bornhack.%s" % __name__)
 
 
-class PosListView(CampViewMixin, TeamPosRequiredMixin, ListView):
+class PosListView(CampViewMixin, AnyTeamPosRequiredMixin, ListView):
     """Show a list of Pos this user has access to (through team pos permissions)."""
 
     model = Pos
@@ -270,7 +270,7 @@ def setup(self, *args, **kwargs):
 
 class PosTransactionListView(
     CampViewMixin,
-    TeamPosRequiredMixin,
+    AnyTeamPosRequiredMixin,
     SingleTableMixin,
     FilterView,
 ):
@@ -306,7 +306,7 @@ def get_context_data(self, *args, **kwargs):
 
 class PosSaleListView(
     CampViewMixin,
-    TeamPosRequiredMixin,
+    AnyTeamPosRequiredMixin,
     SingleTableMixin,
     FilterView,
 ):
@@ -354,7 +354,7 @@ def form_valid(self, form):
 
 class PosProductListView(
     CampViewMixin,
-    TeamPosRequiredMixin,
+    AnyTeamPosRequiredMixin,
     SingleTableMixin,
     FilterView,
 ):
@@ -424,7 +424,7 @@ def get_context_data(self, **kwargs):
 
 class PosProductCostListView(
     CampViewMixin,
-    TeamPosRequiredMixin,
+    AnyTeamPosRequiredMixin,
     SingleTableMixin,
     FilterView,
 ):

src/utils/mixins.py

@@ -45,44 +45,43 @@ def dispatch(self, request, *args, **kwargs):
         user_perms = self.request.user.get_all_permissions()
         for perm in user_perms:
             if perm.endswith(f"_team_{self.perm}"):
-                # user has the permissio n in some team
+                # user has the permission in some team
                 return super().dispatch(request, *args, **kwargs)
         messages.error(request, "No thanks")
         raise PermissionDenied()
 
 
-class TeamLeadRequiredMixin(BaseTeamPermRequiredMixin):
-    """Mixin for views available to anyone with a "camps.<team>_team_lead" permission for any team."""
 
-    perm = "lead"
+class AnyTeamMemberRequiredMixin(BaseTeamPermRequiredMixin):
+    """Mixin for views available to anyone with a "camps.<team>_team_member" permission for any team.
 
-
-class TeamMemberRequiredMixin(BaseTeamPermRequiredMixin):
-    """Mixin for views available to anyone with a "camps.<team>_team_member" permission for any team."""
+    Currently only used to control backoffice access.
+    """
 
     perm = "member"
 
 
-class TeamMapperRequiredMixin(BaseTeamPermRequiredMixin):
-    """Mixin for views available to anyone with a "camps.<team>_team_mapper" permission for any team."""
+class AnyTeamMapperRequiredMixin(BaseTeamPermRequiredMixin):
+    """Mixin for views available to anyone with a "camps.<team>_team_mapper" permission for any team.
 
-    perm = "mapper"
+    Currently only used in backoffice map layer list and create views.
+    """
 
+    perm = "mapper"
 
-class TeamFacilitatorRequiredMixin(BaseTeamPermRequiredMixin):
-    """Mixin for views available to anyone with a "camps.<team>_team_facilitator" permission for any team."""
 
-    perm = "facilitator"
+class AnyTeamFacilitatorRequiredMixin(BaseTeamPermRequiredMixin):
+    """Mixin for views available to anyone with a "camps.<team>_team_facilitator" permission for any team.
 
+    Currently only used in backoffice facility list, create, and detail views."""
 
-class TeamInfopagerRequiredMixin(BaseTeamPermRequiredMixin):
-    """Mixin for views available to anyone with a "camps.<team>_team_infopager" permission for any team."""
+    perm = "facilitator"
 
-    perm = "infopager"
 
+class AnyTeamPosRequiredMixin(BaseTeamPermRequiredMixin):
+    """Mixin for views available to anyone with a "camps.<team>_team_pos" permission for any team.
 
-class TeamPosRequiredMixin(BaseTeamPermRequiredMixin):
-    """Mixin for views available to anyone with a "camps.<team>_team_pos" permission for any team."""
+    Currently used to control access to the backoffice POS list, POS Transaction List, POS sale list, POS product list, and POS Product Cost List views."""
 
     perm = "pos"