* add future permissions

* make permissions and future permissions an attribute
* add unit tests

Author: Jeff

sogs/model/room.py

@@ -1503,15 +1503,12 @@ def url(self):
         """
         return utils.server_url(self.token)
 
-    def export_permissions(self, mod):
+    @property
+    def permissions(self):
         """
         export room permissions in full,
         returns a dict of session_id -> permissions dict (a dict of permission type to bool)
         """
-        if not self.check_moderator(mod):
-            app.logger.warning("unable to get room permissions for user")
-            raise BadPermission()
-
         ret = dict()
         for row in query(
             """SELECT session_id, upo.* FROM user_permission_overrides upo
@@ -1528,6 +1525,33 @@ def export_permissions(self, mod):
             ret[row['session_id']] = data
         return ret
 
+    @property
+    def future_permissions(self):
+        """
+        returns a list of future permission changes in this room
+        """
+        ret = list()
+        for row in query(
+            """SELECT session_id, futures.* FROM (
+        SELECT "user", at, read, write, upload, null AS banned
+        FROM user_permission_futures WHERE room = :r
+        UNION ALL
+        SELECT "user", at, null AS read, null AS write, null AS banned, banned
+        FROM user_ban_futures WHERE room = :r
+        ) futures JOIN users ON futures."user" = users.id""",
+            r=self.id,
+        ):
+            data = dict()
+            for k in row.keys():
+                if k in ('room', 'user'):
+                    continue
+                if k in ('at', 'session_id'):
+                    data[k] = row[k]
+                else:
+                    data[k] = bool(row[k])
+            ret.append(data)
+        return ret
+
 
 def get_rooms():
     """Get a list of all rooms; does not check permissions."""

sogs/routes/rooms.py

@@ -278,6 +278,24 @@ def update_room(room):
     return jsonify({})
 
 
+def compact_permissions(perms):
+    """ take a dict of user permssions and convert them into a compact form """
+    compact = str()
+    keys = list(perms.keys())
+    keys.sort()
+    for k in keys:
+        if not perms[k]:
+            compact += '-'
+        if k == 'admin':
+            compact += 'A'
+        else:
+            compact += k[0]
+        compact += ','
+    if keys:
+        compact = compact[:-1]
+    return compact
+
+
 @rooms.get("/room/<Room:room>/permInfo")
 @auth.mod_required
 def get_permission_info(room):
@@ -286,14 +304,33 @@ def get_permission_info(room):
 
     # Query Parameters
 
-    TODO: implement me
+    - `compact` — Set to 1 if we should we send each permission as a "compacted" string.
 
     # Return Value
 
-    dict of session_id to current permission info
+    dict of session_id to current permissions,
+    if compact is set to 1 this will be a string,
+    otherwise it will be a dict containing the name of the permission mapped to a boolean value.
+    """
+    transform = lambda x: x  # noqa: E731
+    if request.args.get("compact", type=int, default=0):
+        transform = compact_permissions
+    return jsonify(transform(room.permissions))
+
 
+@rooms.get("/room/<Room:room>/futurePermInfo")
+@auth.mod_required
+def get_future_permission_info(room):
     """
-    return jsonify(room.export_permissions(g.user))
+    Fetches permission changes scheduled in the future.
+
+    # Return Value
+
+    list of all future permission changes scheduled
+
+    """
+
+    return jsonify(room.future_permissions)
 
 
 @rooms.get("/room/<Room:room>/pollInfo/<int:info_updated>")

sogs/utils.py

@@ -182,3 +182,21 @@ def add_session_message_padding(data: Union[bytes, memoryview], length):
             data = bytes(data)
         data += b'\x80' + b'\x00' * (length - len(data) - 1)
     return data
+
+
+def compact_permissions(perms):
+    """ take a dict of user permssions and convert them into a compact form """
+    compact = str()
+    keys = list(perms.keys())
+    keys.sort()
+    for k in keys:
+        if not perms[k]:
+            compact += '-'
+        if k == 'admin':
+            compact += 'A'
+        else:
+            compact += k[0]
+        compact += ','
+    if keys:
+        compact = compact[:-1]
+    return compact

tests/test_room_routes.py

@@ -1160,3 +1160,14 @@ def test_get_room_perms_as_admin(client, room, admin):
     assert admin.session_id in r.json
     perm_info = r.json[admin.session_id]
     assert perm_info['admin'] is True
+
+
+def test_get_room_future_perms(client, room, mod):
+    r = sogs_get(client, f'/room/{room.token}/futurePermInfo', mod)
+    assert r.status_code == 200
+    assert r.json == []
+
+
+def test_get_room_future_perms_not_allowed(client, room, user):
+    r = sogs_get(client, f'/room/{room.token}/futurePermInfo', user)
+    assert r.status_code == 403