Add IPEI to DECT registrations (#1825)

* Add IPEI to DECT registrations

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update src/phonebook/views.py

* Fixed review remarks

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update src/phonebook/dectutils.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update src/phonebook/views.py

* Update scope description

* Update src/bornhack/settings.py

* Update src/phonebook/views.py

* Add the forgotten migration

* Removed unused

* One more

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Thomas Steen Rasmussen <tykling@bornhack.org>

Author: 3 people

src/bornhack/settings.py

@@ -233,7 +233,7 @@
         "permissions:read": "Allow the remote site to read a list of your assigned permissions (scope: permissions:read).",
         "teams:read": "Allow the remote site to read a list of your team memberships and team lead status (scope: teams)",
         # api scopes
-        "phonebook:admin": "Allow the remote site to read the camp phonebook including service numbers and unlisted numbers. Only relevant for POC team leads (scope: phonebook:admin).",
+        "phonebook:admin": "Allow the remote site to read the camp phonebook including service numbers and unlisted numbers. Also allows access to the POC API. Only relevant for POC team leads (scope: phonebook:admin).",
         "phonebook:read": "Allow the remote site to read the camp phonebook (scope: phonebook:read).",
     },
     "PKCE_REQUIRED": True,

src/phonebook/dectutils.py

@@ -53,3 +53,23 @@ def letters_to_number(self, letters):
         for letter in letters:
             result += self.REVERSE_DECT_MATRIX[letter.upper()]
         return result
+
+    def hex_ipui_ipei(self, ipui):
+        """
+        Convert a hexidecimal IPUI to a IPEI notation
+        """
+        if len(ipui) == 10:
+            emc_hex = ipui[:5]
+            psn_hex = ipui[-5:]
+            emc = int(emc_hex, 16)
+            psn = int(psn_hex, 16)
+            return [emc, psn]
+        return []
+
+    def format_ipei(self, emc, psn):
+        """
+        Format the IPEI stored as ints to the standard notation.
+        """
+        emc_s = str(emc).zfill(5)
+        psn_s = str(psn).zfill(7)
+        return f"{emc_s} {psn_s}"

src/phonebook/forms.py

@@ -0,0 +1,65 @@
+"""
+Forms for the phonebook
+"""
+
+import re
+
+from django import forms
+
+from django.core.exceptions import ValidationError
+
+from .models import DectRegistration
+from .dectutils import DectUtils
+
+dectutil = DectUtils()
+
+
+class DectRegistrationForm(forms.ModelForm):
+    """
+    Dect Registration Form used in the phonebook registration create view
+    """
+
+    ipei_help_text = """
+    Optional: Enter your IPEI (03562 0900847) or IPUI (00DEADBEEF)<br>
+    Entering this will enable you to register your handset directly when you arrive<br>
+    You can find your IPUI on most Siemens handsets by going to menu and dailing *#06#
+    """
+    ipei = forms.CharField(
+        max_length=13,
+        help_text=ipei_help_text,
+        required=False,
+        label="IPEI/IPUI",
+    )
+
+    class Meta:
+        model = DectRegistration
+        fields = ["number", "letters", "description", "publish_in_phonebook", "ipei"]
+
+    def clean_ipei(self):
+        """
+        Detect IPEI type and convert both IPEI or IPUI to a array of ints
+        """
+        ipei_s = self.cleaned_data["ipei"]
+        if len(ipei_s) == 10:
+            ipei = dectutil.hex_ipui_ipei(ipei_s)
+        elif len(ipei_s) == 13:
+            if re.match(r"^\d{5} \d{7}$", ipei_s):
+                ipei = [int(a) for a in ipei_s.split(" ")]
+            else:
+                raise ValidationError("Unrecognized IPEI format")
+        elif ipei_s == "":
+            return None
+        else:
+            raise ValidationError("Unable to recognize IPEI/IPUI format")
+
+        if not ipei:
+            raise ValidationError(f"unable to process {ipei}.")
+        return ipei
+
+    def clean(self):
+        cleaned_data = super().clean()
+        ipei = cleaned_data.get("ipei")
+
+        if ipei and len(ipei) != 2:
+            self.add_error("ipei", f"The ipei is incorrect. {ipei}")
+        return cleaned_data

src/phonebook/migrations/0004_dectregistration_ipei.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.2.20 on 2025-04-20 07:23
+
+import django.contrib.postgres.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('phonebook', '0003_auto_20200310_1923'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='dectregistration',
+            name='ipei',
+            field=django.contrib.postgres.fields.ArrayField(base_field=models.IntegerField(), blank=True, help_text='DECT phone IPEI (EMC+PSN)', null=True, size=2),
+        ),
+    ]

src/phonebook/migrations/0005_alter_dectregistration_ipei.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.2.20 on 2025-04-21 12:28
+
+import django.contrib.postgres.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('phonebook', '0004_dectregistration_ipei'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='dectregistration',
+            name='ipei',
+            field=django.contrib.postgres.fields.ArrayField(base_field=models.IntegerField(), blank=True, help_text='DECT phone IPEI (03562,0900847)', null=True, size=2),
+        ),
+    ]

src/phonebook/models.py

@@ -3,6 +3,7 @@
 from django.contrib.auth.models import User
 from django.core.exceptions import ValidationError
 from django.db import models
+from django.contrib.postgres.fields import ArrayField
 from django_prometheus.models import ExportModelOperationsMixin
 
 from .dectutils import DectUtils
@@ -63,15 +64,36 @@ class Meta:
         help_text="Check to list this registration in the phonebook",
     )
 
+    ipei = ArrayField(
+        models.IntegerField(),
+        blank=True,
+        null=True,
+        size=2,
+        help_text="DECT phone IPEI (03562,0900847)",
+    )
+
     def save(self, *args, **kwargs):
         """
         This is just here so we get the validation in the admin as well.
         """
         # validate that the phonenumber and letters are valid and then save()
         self.clean_number()
         self.clean_letters()
+        self.check_unique_ipei()
         super().save(*args, **kwargs)
 
+    def check_unique_ipei(self):
+        if self.ipei and len(self.ipei) == 2:
+            # check for conflicts with the same IPEI
+            if (
+                DectRegistration.objects.filter(camp=self.camp, ipei=self.ipei)
+                .exclude(pk=self.pk)
+                .exists()
+            ):
+                raise ValidationError(
+                    f"The IPEI {dectutil.format_ipei(self.ipei[0], self.ipei[1])} is in use",
+                )
+
     def clean_number(self):
         """
         We call this from the views form_valid() so we have a Camp object available for the validation.

src/phonebook/templates/dectregistration_list.html

@@ -23,6 +23,7 @@
             <th>Description</th>
             <th>Publish in Phonebook</th>
             <th>Activation Code</th>
+            <th>IPEI</th>
             <th>Created</th>
             <th>Modified</th>
             <th>Actions</th>
@@ -34,6 +35,7 @@
               <td>{{ entry.description|default:"N/A" }}</td>
               <td>{{ entry.publish_in_phonebook|yesno }}</td>
               <td>{{ entry.activation_code }}</td>
+              <td><nobr>{{ entry.ipei.0|stringformat:"05d" }} {{ entry.ipei.1|stringformat:"07d" }}</nobr></td>
               <td>{{ entry.created }}</td>
               <td>{{ entry.updated }}</td>
               <td>

src/phonebook/urls.py

@@ -8,6 +8,7 @@
 from .views import DectRegistrationListView
 from .views import DectRegistrationUpdateView
 from .views import PhonebookListView
+from .views import ApiDectUpdateIPEI
 
 app_name = "phonebook"
 urlpatterns = [
@@ -31,6 +32,11 @@
                     r"^(?P<dect_number>\d{4,9})/",
                     include(
                         [
+                            path(
+                                "update/ipei/",
+                                ApiDectUpdateIPEI.as_view(),
+                                name="dectregistration_api_update_ipei",
+                            ),
                             path(
                                 "update/",
                                 DectRegistrationUpdateView.as_view(),

src/phonebook/views.py

@@ -1,26 +1,34 @@
 import logging
 import secrets
 import string
+import json
 
 from django.contrib import messages
 from django.contrib.auth.mixins import LoginRequiredMixin
 from django.core.exceptions import ValidationError
 from django.shortcuts import redirect
+from django.shortcuts import get_object_or_404
 from django.urls import reverse
+from django.http import JsonResponse
+from django.utils.decorators import method_decorator
+from django.views.decorators.csrf import csrf_exempt
 from django.views.generic import CreateView
 from django.views.generic import DeleteView
 from django.views.generic import ListView
 from django.views.generic import UpdateView
+from django.views.generic import View
 from jsonview.views import JsonView
 from oauth2_provider.views.generic import ScopedProtectedResourceView
 
 from .mixins import DectRegistrationViewMixin
 from .models import DectRegistration
+from .dectutils import DectUtils
+from .forms import DectRegistrationForm
 from camps.mixins import CampViewMixin
-from teams.models import Team
 from utils.mixins import UserIsObjectOwnerMixin
 
 logger = logging.getLogger("bornhack.%s" % __name__)
+dectutil = DectUtils()
 
 
 class DectExportJsonView(
@@ -36,8 +44,9 @@ class DectExportJsonView(
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
-        team = Team.objects.get(name="POC", camp=self.camp)
-        poc = self.request.user in team.leads and self.request.access_token.is_valid(
+        poc = self.request.user.has_perm(
+            "camps.poc_team_lead",
+        ) and self.request.access_token.is_valid(
             ["phonebook:admin"],
         )
         context["phonebook"] = self.dump_phonebook(poc=poc)
@@ -59,16 +68,58 @@ def dump_phonebook(self, poc: bool) -> list[DectRegistration]:
             }
             if poc:
                 # POC member, include extra info
+                if dect.ipei:
+                    ipei = dectutil.format_ipei(dect.ipei[0], dect.ipei[1])
+                else:
+                    ipei = None
                 entry.update(
                     {
                         "activation_code": dect.activation_code,
                         "publish_in_phonebook": dect.publish_in_phonebook,
+                        "ipei": ipei,
                     },
                 )
             phonebook.append(entry)
         return phonebook
 
 
+@method_decorator(csrf_exempt, name="dispatch")
+class ApiDectUpdateIPEI(
+    CampViewMixin,
+    ScopedProtectedResourceView,
+    View,
+):
+    """
+    API endpoint to update IPEI after user registered their phone on the network. Used by the POC system.
+    """
+
+    required_scopes = ["phonebook:admin"]
+
+    def post(self, request, dect_number, *args, **kwargs):
+        if not self.request.user.has_perm(
+            "camps.poc_team_lead",
+        ) and self.request.access_token.is_valid(
+            ["phonebook:admin"],
+        ):
+            return JsonResponse({"error": "Authentication failed"}, status=403)
+        try:
+            data = json.loads(request.body)
+        except json.JSONDecodeError:
+            return JsonResponse({"error": "Invalid JSON"}, status=400)
+
+        instance = get_object_or_404(
+            DectRegistration,
+            number=dect_number,
+            camp=self.camp,
+        )
+        instance.ipei = data["ipei"]
+        instance.save()
+        return JsonResponse(
+            {"message": "Record updated successfully", "data": data},
+            status=200,
+        )
+
+
 class PhonebookListView(CampViewMixin, ListView):
     """
     Our phonebook view currently only shows DectRegistration entries,
@@ -98,7 +149,7 @@ def get_queryset(self, *args, **kwargs):
 
 class DectRegistrationCreateView(LoginRequiredMixin, CampViewMixin, CreateView):
     model = DectRegistration
-    fields = ["number", "letters", "description", "publish_in_phonebook"]
+    form_class = DectRegistrationForm
     template_name = "dectregistration_form.html"
 
     def form_valid(self, form):
@@ -118,6 +169,12 @@ def form_valid(self, form):
             form.add_error("letters", E)
             return super().form_invalid(form)
 
+        try:
+            dect.check_unique_ipei()
+        except ValidationError as E:
+            form.add_error("ipei", E)
+            return super().form_invalid(form)
+
         # this check needs to be in this form, but not in model.save(), because then we cant save service numbers from the admin
         if len(dect.number) < 4:
             form.add_error(