Add gates (groups of check-in devices) (#1825)

src/pretix/base/migrations/0168_auto_20201023_1447.py

@@ -0,0 +1,33 @@
+# Generated by Django 3.0.9 on 2020-10-23 14:47
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('pretixbase', '0167_checkinlist_exit_all_at'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Gate',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=190)),
+                ('identifier', models.CharField(max_length=190)),
+                ('organizer', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, related_name='gates', to='pretixbase.Organizer')),
+            ],
+        ),
+        migrations.AddField(
+            model_name='checkin',
+            name='gate',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='checkins', to='pretixbase.Gate'),
+        ),
+        migrations.AddField(
+            model_name='device',
+            name='gate',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='devices', to='pretixbase.Gate'),
+        ),
+    ]

src/pretix/base/models/__init__.py

@@ -2,7 +2,7 @@ from ..settings import GlobalSettingsObject_SettingsStore
 from .auth import U2FDevice, User, WebAuthnDevice
 from .base import CachedFile, LoggedModel, cachedfile_name
 from .checkin import Checkin, CheckinList
-from .devices import Device
+from .devices import Device, Gate
 from .event import (
     Event, Event_SettingsStore, EventLock, EventMetaProperty, EventMetaValue,
     RequiredAction, SubEvent, SubEventMetaValue, generate_invite_token,
@@ -19,8 +19,8 @@ from .notifications import NotificationSetting
 from .orders import (
     AbstractPosition, CachedCombinedTicket, CachedTicket, CartPosition,
     InvoiceAddress, Order, OrderFee, OrderPayment, OrderPosition, OrderRefund,
-    QuestionAnswer, cachedcombinedticket_name, cachedticket_name,
-    generate_position_secret, generate_secret,
+    QuestionAnswer, RevokedTicketSecret, cachedcombinedticket_name,
+    cachedticket_name, generate_position_secret, generate_secret,
 )
 from .organizer import (
     Organizer, Organizer_SettingsStore, Team, TeamAPIToken, TeamInvite,

src/pretix/base/models/checkin.py

@@ -159,6 +159,9 @@ class Checkin(models.Model):
     device = models.ForeignKey(
         'pretixbase.Device', related_name='checkins', on_delete=models.PROTECT, null=True, blank=True
     )
+    gate = models.ForeignKey(
+        'pretixbase.Gate', related_name='checkins', on_delete=models.SET_NULL, null=True, blank=True
+    )
     auto_checked_in = models.BooleanField(default=False)
 
     objects = ScopedManager(organizer='position__order__event__organizer')

src/pretix/base/models/devices.py

@@ -1,5 +1,6 @@
 import string
 
+from django.core.exceptions import ValidationError
 from django.db import models
 from django.db.models import Max
 from django.utils.crypto import get_random_string
@@ -34,12 +35,64 @@ def generate_api_token():
     return token
 
 
+class Gate(LoggedModel):
+    organizer = models.ForeignKey(
+        'pretixbase.Organizer',
+        on_delete=models.PROTECT,
+        related_name='gates'
+    )
+    name = models.CharField(
+        verbose_name=_("Name"),
+        max_length=190,
+    )
+    identifier = models.CharField(
+        max_length=190, blank=True,
+        verbose_name=_("Internal identifier"),
+        help_text=_('You can enter any value here to make it easier to match the data with other sources. If you do '
+                    'not input one, we will generate one automatically.')
+    )
+
+    class Meta:
+        ordering = ('name',)
+
+    def __str__(self):
+        return self.name
+
+    def clean_identifier(self, code):
+        Gate._clean_identifier(self.organizer, code, self)
+
+    @staticmethod
+    def _clean_identifier(organizer, code, instance=None):
+        qs = Gate.objects.filter(organizer=organizer, identifier__iexact=code)
+        if instance:
+            qs = qs.exclude(pk=instance.pk)
+        if qs.exists():
+            raise ValidationError(_('This identifier is already used for a different question.'))
+
+    def save(self, *args, **kwargs):
+        if not self.identifier:
+            charset = list('ABCDEFGHJKLMNPQRSTUVWXYZ3789')
+            while True:
+                code = get_random_string(length=8, allowed_chars=charset)
+                if not Gate.objects.filter(organizer=self.organizer, identifier=code).exists():
+                    self.identifier = code
+                    break
+        return super().save(*args, **kwargs)
+
+
 class Device(LoggedModel):
     organizer = models.ForeignKey(
         'pretixbase.Organizer',
         on_delete=models.PROTECT,
         related_name='devices'
     )
+    gate = models.ForeignKey(
+        'pretixbase.Gate',
+        verbose_name=_('Gate'),
+        on_delete=models.SET_NULL,
+        null=True, blank=True,
+        related_name='devices'
+    )
     device_id = models.PositiveIntegerField()
     unique_serial = models.CharField(max_length=190, default=generate_serial, unique=True)
     initialization_token = models.CharField(max_length=190, default=generate_initialization_token, unique=True)

src/pretix/base/services/checkin.py

@@ -230,6 +230,7 @@ def perform_checkin(op: OrderPosition, clist: CheckinList, given_answers: dict,
             list=clist,
             datetime=dt,
             device=device,
+            gate=device.gate if device else None,
             nonce=nonce,
             forced=force and not entry_allowed,
         )