added active member endpoint

added api endpoint for validating if user is an active member

Author: agmes4

pycroft/lib/user/info.py

@@ -19,6 +19,7 @@ class UserStatus(t.NamedTuple):
     member: bool
     traffic_exceeded: bool
     network_access: bool
+    is_active: bool
     wifi_access: bool
     account_balanced: bool
     violation: bool
@@ -29,10 +30,12 @@ class UserStatus(t.NamedTuple):
 def status(user: User) -> UserStatus:
     has_interface = any(h.interfaces for h in user.hosts)
     has_access = user.has_property("network_access")
+    is_active = user.has_property("active_member")
     return UserStatus(
         member=user.has_property("member"),
         traffic_exceeded=user.has_property("traffic_limit_exceeded"),
         network_access=has_access and has_interface,
+        is_active=is_active,
         wifi_access=user.has_wifi_access and has_access,
         account_balanced=user_has_paid(user),
         violation=user.has_property("violation"),

web/api/v0/__init__.py

@@ -60,6 +60,7 @@
 from pycroft.model.types import IPAddress, InvalidMACAddressException
 from pycroft.model.user import User, IllegalEmailError, IllegalLoginError
 from web.blueprints.mpskclient import get_mpsk_client_or_404
+from web.template_filters import require
 
 api = Api()
 
@@ -940,3 +941,44 @@ def patch(self, token: str, password: str) -> ResponseReturnValue:
 
 
 api.add_resource(ResetPasswordResource, '/user/reset-password')
+
+
+class UserActiveResource(Resource):
+    @use_kwargs(
+        {
+            "name": fields.Str(required=True),
+            "byear": fields.Int(required=False, missing=None),
+            "uid": fields.Int(required=True),
+        },
+        location="form",
+    )
+    def get(self, name: str, byear: int, uid: int) -> ResponseReturnValue:
+        """
+        Validates whether the given combination of username, user ID, and optional birth year belongs to a user who is part of the `active_member` group.
+
+        Parameters:
+            name (str): The username to validate.
+            byear (int, optional): The user's birth year. Can be omitted.
+            uid (int): User ID.
+
+        Returns:
+            ResponseReturnValue: A JSON-encoded string with {"response": True} if the user belongs to the
+                     `active_member` group, otherwise {"response": False}.
+        """
+        user = session.session.get(User, uid)
+
+        if user is None:
+            return jsonify({"response": False})
+        user_status = status(user)
+        has_birthday = not bool(byear)
+        if user.birthdate and byear:
+            if user.birthdate.year == byear:
+                has_birthday = True
+
+        if user_status.is_active and name == user.name and has_birthday:
+            return jsonify({"response": True})
+
+        return jsonify({"response": False})
+
+
+api.add_resource(UserActiveResource, "/user/active")