Vouchers: Allow to bulk-update (#6096)

* Vouchers: Allow to bulk-delete larger numbers

* [DRAFT] voucher bulk update

* untested draft

* Minor fixes

* some tests and fixes

* More tests

* Bulk vouchers - refactor (#6353)

* Reuse parse_itemvar from VoucherForm

* Refactor: Method for _bulk update check

* remove unused parameter

* Refactor: Deduplicate get_affected_quotas code

* Remove unused delete button

* Prevent accidental update of *all* vouchers (cf PR #4960)

* Make sure we actually edit the selected items

* Use dataclass for bulk-edit data, deduplicate quota-blocking logic

* Move dataclass to models.py

* Fix linter errors

* Fix tests

* Fix tests

---------

Co-authored-by: luelista <weller@rami.io>

src/tests/control/test_vouchers.py

@@ -35,6 +35,7 @@
 import datetime
 import decimal
 import json
+from decimal import Decimal
 
 from django.core import mail as djmail
 from django.test import TransactionTestCase
@@ -43,8 +44,8 @@ from django_scopes import scopes_disabled
 from tests.base import SoupTestMixin, extract_form_fields
 
 from pretix.base.models import (
-    Event, Item, ItemVariation, Order, OrderPosition, Organizer, Quota, Team,
-    User, Voucher, WaitingListEntry,
+    Event, Item, ItemVariation, Order, OrderPosition, Organizer, Quota,
+    SeatingPlan, Team, User, Voucher, WaitingListEntry,
 )
 
 
@@ -134,49 +135,49 @@ class VoucherFormTest(SoupTestMixin, TransactionTestCase):
     def test_filter_status_valid(self):
         with scopes_disabled():
             v = self.event.vouchers.create(item=self.ticket)
-        doc = self.client.get('/control/event/%s/%s/vouchers/?status=v' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-status=v' % (self.orga.slug, self.event.slug))
         assert v.code in doc.content.decode()
         v.redeemed = 1
         v.save()
-        doc = self.client.get('/control/event/%s/%s/vouchers/?status=v' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-status=v' % (self.orga.slug, self.event.slug))
         assert v.code not in doc.content.decode()
 
     def test_filter_status_redeemed(self):
         with scopes_disabled():
             v = self.event.vouchers.create(item=self.ticket, redeemed=1)
-        doc = self.client.get('/control/event/%s/%s/vouchers/?status=r' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-status=r' % (self.orga.slug, self.event.slug))
         assert v.code in doc.content.decode()
         v.redeemed = 0
         v.save()
-        doc = self.client.get('/control/event/%s/%s/vouchers/?status=r' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-status=r' % (self.orga.slug, self.event.slug))
         assert v.code not in doc.content.decode()
 
     def test_filter_status_expired(self):
         with scopes_disabled():
             v = self.event.vouchers.create(item=self.ticket, valid_until=now() + datetime.timedelta(days=1))
-        doc = self.client.get('/control/event/%s/%s/vouchers/?status=e' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-status=e' % (self.orga.slug, self.event.slug))
         assert v.code not in doc.content.decode()
         v.valid_until = now() - datetime.timedelta(days=1)
         v.save()
-        doc = self.client.get('/control/event/%s/%s/vouchers/?status=e' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-status=e' % (self.orga.slug, self.event.slug))
         assert v.code in doc.content.decode()
 
     def test_filter_tag(self):
         with scopes_disabled():
             self.event.vouchers.create(item=self.ticket, code='ABCDEFG', comment='Foo', tag='bar')
-        doc = self.client.get('/control/event/%s/%s/vouchers/?tag=bar' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-tag=bar' % (self.orga.slug, self.event.slug))
         assert 'ABCDEFG' in doc.content.decode()
-        doc = self.client.get('/control/event/%s/%s/vouchers/?tag=baz' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-tag=baz' % (self.orga.slug, self.event.slug))
         assert 'ABCDEFG' not in doc.content.decode()
 
     def test_search_code(self):
         with scopes_disabled():
             self.event.vouchers.create(item=self.ticket, code='ABCDEFG', comment='Foo')
-        doc = self.client.get('/control/event/%s/%s/vouchers/?search=ABCDEFG' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-search=ABCDEFG' % (self.orga.slug, self.event.slug))
         assert 'ABCDEFG' in doc.content.decode()
-        doc = self.client.get('/control/event/%s/%s/vouchers/?search=Foo' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-search=Foo' % (self.orga.slug, self.event.slug))
         assert 'ABCDEFG' in doc.content.decode()
-        doc = self.client.get('/control/event/%s/%s/vouchers/?search=12345' % (self.orga.slug, self.event.slug))
+        doc = self.client.get('/control/event/%s/%s/vouchers/?filter-search=12345' % (self.orga.slug, self.event.slug))
         assert 'ABCDEFG' not in doc.content.decode()
 
     def test_bulk_rng(self):
@@ -806,3 +807,426 @@ class VoucherFormTest(SoupTestMixin, TransactionTestCase):
 
         assert 'walk-ins' in names
         assert 'waiting-list' not in names
+
+
+class VoucherBulkEditFormTest(SoupTestMixin, TransactionTestCase):
+    @scopes_disabled()
+    def setUp(self):
+        super().setUp()
+        self.user = User.objects.create_user('dummy@dummy.dummy', 'dummy')
+        self.orga = Organizer.objects.create(name='CCC', slug='ccc')
+        self.event = Event.objects.create(
+            organizer=self.orga, name='30C3', slug='30c3',
+            date_from=datetime.datetime(2013, 12, 26, tzinfo=datetime.timezone.utc),
+        )
+        t = Team.objects.create(organizer=self.orga, all_event_permissions=True)
+        t.members.add(self.user)
+        t.limit_events.add(self.event)
+        self.client.login(email='dummy@dummy.dummy', password='dummy')
+
+        self.quota_shirts = Quota.objects.create(event=self.event, name='Shirts', size=2)
+        self.shirt = Item.objects.create(event=self.event, name='T-Shirt', default_price=12)
+        self.quota_shirts.items.add(self.shirt)
+        self.shirt_red = ItemVariation.objects.create(item=self.shirt, default_price=14, value='Red')
+        self.shirt_blue = ItemVariation.objects.create(item=self.shirt, value='Blue')
+        self.quota_shirts.variations.add(self.shirt_red)
+        self.quota_shirts.variations.add(self.shirt_blue)
+
+        self.quota_tickets = Quota.objects.create(event=self.event, name='Tickets', size=2)
+        self.ticket = Item.objects.create(event=self.event, name='Early-bird ticket',
+                                          default_price=23)
+        self.quota_tickets.items.add(self.ticket)
+        self.url = f'/control/event/{self.orga.slug}/{self.event.slug}/vouchers/bulk_edit'
+
+    def test_simple_edit(self):
+        with scopes_disabled():
+            self.event.vouchers.create(
+                quota=self.quota_tickets,
+                max_usages=10,
+                price_mode="set",
+                value=13,
+            )
+            self.event.vouchers.create(
+                item=self.ticket,
+                max_usages=10,
+                price_mode="set",
+                value=12,
+            )
+
+        doc = self.post_doc(self.url, {
+            '__ALL': 'on',
+        }, follow=True)
+        fields = extract_form_fields(doc)
+        assert fields.get('bulkedit-max_usages') == '10'
+        assert fields.get('bulkedit-price_mode') == 'set'
+        assert not fields.get('bulkedit-value')
+        fields.update({
+            '_bulk': ['bulkedit__price', 'bulkeditmin_usages', 'bulkedittag', 'bulkeditshow_hidden_items'],
+            'bulkedit-price_mode': 'percent',
+            'bulkedit-value': '15',
+            'bulkedit-min_usages': '3',
+            'bulkedit-tag': 'tagged',
+            'bulkedit-comment': 'This is a comment',  # will be ignored, as not included in _bulk
+            'bulkedit-show_hidden_items': '',
+        })
+        doc = self.post_doc(self.url, fields, follow=True)
+        assert doc.select(".alert-success")
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.price_mode == "percent"
+                assert v.value == Decimal("15.00")
+                assert v.min_usages == 3
+                assert v.tag == "tagged"
+                assert v.comment == ""
+                assert v.show_hidden_items is False
+
+    def _update_all(self, data: dict, expect_error: str=None):
+        doc = self.post_doc(self.url, {
+            '__ALL': 'on',
+        }, follow=True)
+        fields = extract_form_fields(doc)
+        fields.update(data)
+        doc = self.post_doc(self.url, fields, follow=True)
+        error_texts = [el.text for el in doc.select(".alert-danger, .has-error")]
+        if expect_error:
+            assert doc.select(".alert-danger")
+            assert any(expect_error in t for t in error_texts), error_texts
+        else:
+            assert doc.select(".alert-success"), error_texts
+
+    def test_change_itemvar_to_product(self):
+        with scopes_disabled():
+            self.event.vouchers.create(quota=self.quota_tickets)
+            self.event.vouchers.create(item=self.ticket)
+
+        self._update_all({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': f'{self.ticket.pk}',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.item == self.ticket
+                assert not v.variation
+                assert not v.quota
+
+    def test_change_itemvar_to_variation(self):
+        with scopes_disabled():
+            self.event.vouchers.create(quota=self.quota_tickets)
+            self.event.vouchers.create(item=self.ticket)
+
+        self._update_all({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': f'{self.shirt.pk}-{self.shirt_red.pk}',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.item == self.shirt
+                assert v.variation == self.shirt_red
+                assert not v.quota
+
+    def test_change_itemvar_to_quota(self):
+        with scopes_disabled():
+            self.event.vouchers.create(quota=self.quota_tickets)
+            self.event.vouchers.create(item=self.ticket)
+
+        self._update_all({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': f'q-{self.quota_tickets.pk}',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert not v.item
+                assert not v.variation
+                assert v.quota == self.quota_tickets
+
+    def test_change_itemvar_to_all(self):
+        with scopes_disabled():
+            self.event.vouchers.create(quota=self.quota_tickets)
+            self.event.vouchers.create(item=self.ticket)
+
+        self._update_all({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': '',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert not v.item
+                assert not v.variation
+                assert not v.quota
+
+    def test_change_max_usages(self):
+        with scopes_disabled():
+            self.event.vouchers.create(quota=self.quota_tickets, max_usages=15, redeemed=4)
+            self.event.vouchers.create(item=self.ticket, max_usages=15, redeemed=2)
+
+        self._update_all({
+            '_bulk': ['bulkeditmax_usages'],
+            'bulkedit-max_usages': '3',
+        }, expect_error="already been redeemed 4 times")
+        self._update_all({
+            '_bulk': ['bulkeditmax_usages'],
+            'bulkedit-max_usages': '4',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.max_usages == 4
+
+    def _requires_one_more_quota(self, data: dict, quota=None):
+        self._update_all(data, expect_error="no sufficient quota")
+        quota = quota or self.quota_tickets
+        quota.size += 1
+        quota.save()
+        self._update_all(data)
+
+    def test_quota_check_change_item(self):
+        with scopes_disabled():
+            self.event.vouchers.create(item=self.shirt, block_quota=True, max_usages=2, redeemed=1)
+            self.event.vouchers.create(item=self.shirt, block_quota=True, max_usages=3, redeemed=1)
+        self._requires_one_more_quota({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': f'{self.ticket.pk}',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.item == self.ticket
+
+    def test_quota_check_change_variation(self):
+        with scopes_disabled():
+            self.event.vouchers.create(item=self.ticket, block_quota=True, max_usages=2, redeemed=1)
+            self.event.vouchers.create(item=self.ticket, block_quota=True, max_usages=3, redeemed=1)
+        self._requires_one_more_quota({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': f'{self.shirt.pk}-{self.shirt_red.pk}',
+        }, quota=self.quota_shirts)
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.item == self.shirt
+                assert v.variation == self.shirt_red
+
+    def test_quota_check_change_item_with_variations(self):
+        with scopes_disabled():
+            self.event.vouchers.create(item=self.ticket, block_quota=True, max_usages=2, redeemed=1)
+            self.event.vouchers.create(item=self.ticket, block_quota=True, max_usages=3, redeemed=1)
+        self._requires_one_more_quota({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': f'{self.shirt.pk}',
+        }, quota=self.quota_shirts)
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.item == self.shirt
+                assert not v.variation
+
+    def test_quota_check_change_expired_to_valid(self):
+        with scopes_disabled():
+            self.event.vouchers.create(item=self.ticket, block_quota=True, max_usages=2)
+            self.event.vouchers.create(item=self.ticket, block_quota=True, max_usages=1, valid_until=now() - datetime.timedelta(days=1))
+        self._requires_one_more_quota({
+            '_bulk': ['bulkeditvalid_until'],
+            'bulkedit-valid_until_0': '',
+            'bulkedit-valid_until_1': '',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert not v.valid_until
+
+    def test_quota_check_change_max_usages(self):
+        with scopes_disabled():
+            self.event.vouchers.create(item=self.ticket, block_quota=True, max_usages=2)
+            self.event.vouchers.create(item=self.ticket, block_quota=True, max_usages=1, redeemed=1)
+        self._requires_one_more_quota({
+            '_bulk': ['bulkeditmax_usages'],
+            'bulkedit-max_usages': '2',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.max_usages == 2
+
+    def test_quota_check_no_change(self):
+        with scopes_disabled():
+            # Technically overbooked, but we don't have a diff in quota
+            self.event.vouchers.create(item=self.shirt, variation=self.shirt_red, block_quota=True)
+            self.event.vouchers.create(item=self.shirt, variation=self.shirt_red, block_quota=True)
+            self.event.vouchers.create(item=self.shirt, variation=self.shirt_red, block_quota=True)
+        self._update_all({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': f'{self.shirt.pk}-{self.shirt_blue.pk}',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.variation == self.shirt_blue
+
+    def test_quota_check_change_subevent(self):
+        with scopes_disabled():
+            self.event.has_subevents = True
+            self.event.save()
+            se1 = self.event.subevents.create(name="Foo", date_from=now())
+            se2 = self.event.subevents.create(name="Bar", date_from=now())
+            self.quota_tickets.subevent = se1
+            self.quota_tickets.save()
+            Quota.objects.create(event=self.event, subevent=se2, name='Tickets', size=3)
+            self.event.vouchers.create(item=self.ticket, block_quota=True, subevent=se2)
+            self.event.vouchers.create(item=self.ticket, block_quota=True, subevent=se2)
+            self.event.vouchers.create(item=self.ticket, block_quota=True, subevent=se2)
+        self._requires_one_more_quota({
+            '_bulk': ['bulkeditsubevent'],
+            'bulkedit-subevent': f'{se1.pk}',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.subevent == se1
+
+    def test_change_subevent_quota_invalid(self):
+        with scopes_disabled():
+            self.event.has_subevents = True
+            self.event.save()
+            se1 = self.event.subevents.create(name="Foo", date_from=now())
+            se2 = self.event.subevents.create(name="Bar", date_from=now())
+            self.quota_tickets.subevent = se1
+            self.quota_tickets.save()
+            v1 = self.event.vouchers.create(quota=self.quota_tickets, block_quota=True, subevent=se1)
+        self._update_all({
+            '_bulk': ['bulkeditsubevent'],
+            'bulkedit-subevent': f'{se2.pk}',
+        }, expect_error="selected quota does not match the selected subevent")
+        self._update_all({
+            '_bulk': ['bulkeditsubevent'],
+            'bulkedit-subevent': '',
+        }, expect_error="has no date selected")
+        v1.quota = None
+        v1.item = self.ticket
+        v1.save()
+        self._update_all({
+            '_bulk': ['bulkeditsubevent'],
+            'bulkedit-subevent': '',
+        }, expect_error="If you want this voucher to block quota, you need to select a specific date")
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.subevent == se1
+
+    def test_change_missing_itemvar_with_block_quota(self):
+        with scopes_disabled():
+            self.event.vouchers.create(quota=self.quota_tickets, block_quota=True)
+            self.event.vouchers.create(quota=self.quota_tickets, block_quota=True)
+        self._update_all({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': '',
+        }, expect_error="You need to select a specific product or quota if this voucher should reserve")
+        self._update_all({
+            '_bulk': ['bulkedititemvar', 'bulkeditblock_quota'],
+            'bulkedit-itemvar': '',
+            'bulkedit-block_quota': '',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert not v.subevent
+                assert not v.block_quota
+
+    def test_change_subevent_and_quota(self):
+        with scopes_disabled():
+            self.event.has_subevents = True
+            self.event.save()
+            se1 = self.event.subevents.create(name="Foo", date_from=now())
+            se2 = self.event.subevents.create(name="Bar", date_from=now())
+            self.quota_tickets.subevent = se1
+            self.quota_tickets.save()
+            q2 = Quota.objects.create(event=self.event, subevent=se2, name='Tickets', size=3)
+            self.event.vouchers.create(quota=self.quota_tickets, block_quota=True, subevent=se1)
+        self._update_all({
+            '_bulk': ['bulkedititemvar', 'bulkeditsubevent'],
+            'bulkedit-subevent': f'{se2.pk}',
+            'bulkedit-itemvar': f'q-{q2.pk}',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.subevent == se2
+                assert v.quota == q2
+
+    def test_quota_check_change_block_quota(self):
+        with scopes_disabled():
+            self.event.vouchers.create(item=self.ticket, max_usages=3)
+        self._requires_one_more_quota({
+            '_bulk': ['bulkeditblock_quota'],
+            'bulkedit-block_quota': 'on',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.block_quota
+
+    def test_ignore_quota(self):
+        with scopes_disabled():
+            self.event.vouchers.create(item=self.ticket, max_usages=3)
+        self._update_all({
+            '_bulk': ['bulkeditblock_quota', 'bulkeditallow_ignore_quota'],
+            'bulkedit-block_quota': 'on',
+            'bulkedit-allow_ignore_quota': 'on',
+        })
+        with scopes_disabled():
+            for v in self.event.vouchers.all():
+                assert v.block_quota
+                assert v.allow_ignore_quota
+
+    @scopes_disabled()
+    def _create_seat(self, **kwargs):
+        plan = SeatingPlan.objects.create(
+            name="Plan", organizer=self.orga, layout="{}"
+        )
+        self.event.seating_plan = plan
+        self.event.save()
+        return self.event.seats.create(seat_number="A1", product=self.ticket, seat_guid="A1", **kwargs)
+
+    def test_seated_unsupported(self):
+        with scopes_disabled():
+            self.event.vouchers.create(item=self.ticket, max_usages=1, seat=self._create_seat())
+        self._update_all({
+            '_bulk': ['bulkeditmax_usages'],
+            'bulkedit-max_usages': '2',
+        }, expect_error="Changing the maximum number of usages in bulk is not supported")
+        self._update_all({
+            '_bulk': ['bulkeditsubevent'],
+            'bulkedit-subevent': '',
+        }, expect_error="Changing the date in bulk is not supported")
+        self._update_all({
+            '_bulk': ['bulkedititemvar'],
+            'bulkedit-itemvar': f'q-{self.quota_tickets.pk}',
+        }, expect_error="Changing the product to a quota is not supported")
+
+    def test_seat_changed_to_valid_needs_to_be_available(self):
+        with scopes_disabled():
+            seat = self._create_seat(blocked=True)
+            self.event.vouchers.create(item=self.ticket, max_usages=1, valid_until=now() - datetime.timedelta(days=1), seat=seat)
+
+        self._update_all({
+            '_bulk': ['bulkeditvalid_until'],
+            'bulkedit-valid_until_0': '',
+            'bulkedit-valid_until_1': '',
+        }, expect_error="not all assigned seats of the vouchers are still available")
+
+        seat.blocked = False
+        seat.save()
+        self._update_all({
+            '_bulk': ['bulkeditvalid_until'],
+            'bulkedit-valid_until_0': '',
+            'bulkedit-valid_until_1': '',
+        })
+
+    def test_seat_changed_to_valid_needs_to_be_available_subevents(self):
+        with scopes_disabled():
+            self.event.has_subevents = True
+            self.event.save()
+            se1 = self.event.subevents.create(name="Foo", date_from=now())
+            seat = self._create_seat(subevent=se1, blocked=True)
+            self.event.vouchers.create(item=self.ticket, max_usages=1, valid_until=now() - datetime.timedelta(days=1), seat=seat, subevent=se1)
+
+        self._update_all({
+            '_bulk': ['bulkeditvalid_until'],
+            'bulkedit-valid_until_0': '',
+            'bulkedit-valid_until_1': '',
+        }, expect_error="not all assigned seats of the vouchers are still available")
+
+        seat.blocked = False
+        seat.save()
+        self._update_all({
+            '_bulk': ['bulkeditvalid_until'],
+            'bulkedit-valid_until_0': '',
+            'bulkedit-valid_until_1': '',
+        })