Fetch room perminssions routes. Basic unit tests and basic functionality.

Author: Jeff

sogs/model/room.py

@@ -1498,8 +1498,34 @@ def unpin(self, msg_id: int, admin: User):
 
     @property
     def url(self):
+        """
+        URL of the web based room viewer for this room
+        """
         return utils.server_url(self.token)
 
+    def export_permissions(self, mod):
+        """
+        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()
+        with db.transaction():
+            ret = dict()
+            for row in query(
+                """SELECT session_id, upo.* FROM user_permission_overrides upo
+                JOIN users ON "user" = users.id WHERE room = :r""",
+                r=self.id,
+            ):
+                data = dict()
+                for k in row.keys():
+                    if k not in ('session_id', 'room', 'user'):
+                        if row[k] is not None:
+                            data[k] = bool(row[k])
+                ret[row['session_id']] = 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({})
 
 
+@rooms.get("/room/<Room:room>/permInfo")
+@auth.mod_required
+def get_permission_info(room):
+    """
+    Fetches permissions about the room, like ban info etc.
+
+    # Query Parameters
+
+    TODO: implement me
+
+    # Return Value
+
+    dict of session_id to current permission info
+
+    """
+    return jsonify(room.export_permissions(g.user))
+
+
 @rooms.get("/room/<Room:room>/pollInfo/<int:info_updated>")
 @auth.read_required
 def poll_room_info(room, info_updated):

tests/test_room_routes.py

@@ -1139,3 +1139,24 @@ def test_remove_all_self_posts_from_room(client, room, mod, user, no_rate_limit)
         assert r.status_code == 200
         assert len(room.get_messages_for(u, recent=True)) == 0
         assert room.check_unbanned(u)
+
+
+def test_get_room_perms(client, room, user):
+    r = sogs_get(client, f'/room/{room.token}/permInfo', user)
+    assert r.status_code == 403
+
+
+def test_get_room_perms_as_mod(client, room, mod):
+    r = sogs_get(client, f'/room/{room.token}/permInfo', mod)
+    assert r.status_code == 200
+    assert mod.session_id in r.json
+    perm_info = r.json[mod.session_id]
+    assert perm_info['visible_mod'] is True
+
+
+def test_get_room_perms_as_admin(client, room, admin):
+    r = sogs_get(client, f'/room/{room.token}/permInfo', admin)
+    assert r.status_code == 200
+    assert admin.session_id in r.json
+    perm_info = r.json[admin.session_id]
+    assert perm_info['admin'] is True