API: Allow to block/unblock seats in bulk (#4668)

* API: Allow to block/unblock seats in bulk * Update doc/api/resources/seats.rst Co-authored-by: Richard Schreiber <schreiber@rami.io> * Update doc/api/resources/seats.rst Co-authored-by: Richard Schreiber <schreiber@rami.io> * Update doc/api/resources/seats.rst Co-authored-by: Richard Schreiber <schreiber@rami.io> * Update src/pretix/api/views/event.py Co-authored-by: Richard Schreiber <schreiber@rami.io> --------- Co-authored-by: Richard Schreiber <schreiber@rami.io>
2026-05-03 14:54:04 +00:00 · 2024-12-02 16:03:11 +01:00
parent e99ee91573
commit cc4fbfe4c7
4 changed files with 247 additions and 5 deletions
--- a/src/pretix/api/serializers/event.py
+++ b/src/pretix/api/serializers/event.py
@@ -989,6 +989,40 @@ def prefetch_by_id(items, qs, id_attr, target_attr):
            setattr(item, target_attr, result.get(getattr(item, id_attr)))


+class SeatBulkBlockInputSerializer(serializers.Serializer):
+    ids = serializers.ListField(child=serializers.IntegerField(), required=False, allow_empty=True)
+    seat_guids = serializers.ListField(child=serializers.CharField(), required=False, allow_empty=True)
+
+    def to_internal_value(self, data):
+        data = super().to_internal_value(data)
+
+        if data.get("seat_guids") and data.get("ids"):
+            raise ValidationError("Please pass either seat_guids or ids.")
+
+        if data.get("seat_guids"):
+            seat_ids = data["seat_guids"]
+            if len(seat_ids) > 10000:
+                raise ValidationError({"seat_guids": ["Please do not pass over 10000 seats."]})
+
+            seats = {s.seat_guid: s for s in self.context["queryset"].filter(seat_guid__in=seat_ids)}
+            for s in seat_ids:
+                if s not in seats:
+                    raise ValidationError({"seat_guids": [f"The seat '{s}' does not exist."]})
+        elif data.get("ids"):
+            seat_ids = data["ids"]
+            if len(seat_ids) > 10000:
+                raise ValidationError({"ids": ["Please do not pass over 10000 seats."]})
+
+            seats = self.context["queryset"].in_bulk(seat_ids)
+            for s in seat_ids:
+                if s not in seats:
+                    raise ValidationError({"ids": [f"The seat '{s}' does not exist."]})
+        else:
+            raise ValidationError("Please pass either seat_guids or ids.")
+
+        return {"seats": seats.values()}
+
+
 class SeatSerializer(I18nAwareModelSerializer):
    orderposition = serializers.IntegerField(source='orderposition_id')
    cartposition = serializers.IntegerField(source='cartposition_id')
--- a/src/pretix/api/views/event.py
+++ b/src/pretix/api/views/event.py
@@ -40,6 +40,7 @@ from django.utils.timezone import now
 from django_filters.rest_framework import DjangoFilterBackend, FilterSet
 from django_scopes import scopes_disabled
 from rest_framework import serializers, views, viewsets
+from rest_framework.decorators import action
 from rest_framework.exceptions import (
    NotFound, PermissionDenied, ValidationError,
 )
@@ -50,8 +51,9 @@ from pretix.api.auth.permission import EventCRUDPermission
 from pretix.api.pagination import TotalOrderingFilter
 from pretix.api.serializers.event import (
    CloneEventSerializer, DeviceEventSettingsSerializer, EventSerializer,
-    EventSettingsSerializer, ItemMetaPropertiesSerializer, SeatSerializer,
-    SubEventSerializer, TaxRuleSerializer,
+    EventSettingsSerializer, ItemMetaPropertiesSerializer,
+    SeatBulkBlockInputSerializer, SeatSerializer, SubEventSerializer,
+    TaxRuleSerializer,
 )
 from pretix.api.views import ConditionalListView
 from pretix.base.models import (
@@ -237,9 +239,9 @@ class EventViewSet(viewsets.ModelViewSet):
            disabled = {m: 'disabled' for m in current_plugins_value if m not in updated_plugins_value}
            changed = merge_dicts(enabled, disabled)

-            for module, action in changed.items():
+            for module, operation in changed.items():
                serializer.instance.log_action(
-                    'pretix.event.plugins.' + action,
+                    'pretix.event.plugins.' + operation,
                    user=self.request.user,
                    auth=self.request.auth,
                    data={'plugin': module}
@@ -744,3 +746,24 @@ class SeatViewSet(ConditionalListView, viewsets.ModelViewSet):
            auth=self.request.auth,
            data={"seats": [serializer.instance.pk]},
        )
+
+    def bulk_change_blocked(self, blocked):
+        s = SeatBulkBlockInputSerializer(
+            data=self.request.data,
+            context={"event": self.request.event, "queryset": self.get_queryset()},
+        )
+        s.is_valid(raise_exception=True)
+
+        seats = s.validated_data["seats"]
+        for seat in seats:
+            seat.blocked = blocked
+        Seat.objects.bulk_update(seats, ["blocked"], batch_size=1000)
+        return Response({})
+
+    @action(methods=["POST"], detail=False)
+    def bulk_block(self, request, *args, **kwargs):
+        return self.bulk_change_blocked(True)
+
+    @action(methods=["POST"], detail=False)
+    def bulk_unblock(self, request, *args, **kwargs):
+        return self.bulk_change_blocked(False)
--- a/src/tests/api/test_events.py
+++ b/src/tests/api/test_events.py
@@ -1601,6 +1601,80 @@ def test_event_block_unblock_seat(token_client, organizer, event, seatingplan, i
    assert resp.data['blocked'] is False


+@pytest.mark.django_db
+def test_event_block_unblock_seat_bulk(token_client, organizer, event, seatingplan, item):
+    resp = token_client.patch(
+        '/api/v1/organizers/{}/events/{}/'.format(organizer.slug, event.slug),
+        {
+            "seating_plan": seatingplan.pk,
+            "seat_category_mapping": {
+                "Stalls": item.pk
+            }
+        },
+        format='json'
+    )
+    assert resp.status_code == 200
+    event.refresh_from_db()
+
+    s1 = event.seats.first()
+    s2 = event.seats.last()
+    resp = token_client.post(
+        '/api/v1/organizers/{}/events/{}/seats/bulk_block/'.format(organizer.slug, event.slug),
+        {
+            "ids": [s1.pk, s2.pk],
+        },
+        format='json'
+    )
+    assert resp.status_code == 200
+
+    s1.refresh_from_db()
+    s2.refresh_from_db()
+    assert s1.blocked
+    assert s2.blocked
+
+    resp = token_client.post(
+        '/api/v1/organizers/{}/events/{}/seats/bulk_unblock/'.format(organizer.slug, event.slug),
+        {
+            "ids": [s1.pk, s2.pk],
+        },
+        format='json'
+    )
+    assert resp.status_code == 200
+
+    s1.refresh_from_db()
+    s2.refresh_from_db()
+    assert not s1.blocked
+    assert not s2.blocked
+
+    resp = token_client.post(
+        '/api/v1/organizers/{}/events/{}/seats/bulk_block/'.format(organizer.slug, event.slug),
+        {
+            "seat_guids": [s1.seat_guid, s2.seat_guid],
+        },
+        format='json'
+    )
+    assert resp.status_code == 200
+
+    s1.refresh_from_db()
+    s2.refresh_from_db()
+    assert s1.blocked
+    assert s2.blocked
+
+    resp = token_client.post(
+        '/api/v1/organizers/{}/events/{}/seats/bulk_unblock/'.format(organizer.slug, event.slug),
+        {
+            "seat_guids": [s1.seat_guid, s2.seat_guid],
+        },
+        format='json'
+    )
+    assert resp.status_code == 200
+
+    s1.refresh_from_db()
+    s2.refresh_from_db()
+    assert not s1.blocked
+    assert not s2.blocked
+
+
@pytest.mark.django_db
 def test_event_expand_seat_filter_and_querycount(token_client, organizer, event, seatingplan, item):
    event.settings.seating_minimal_distance = 2