fix docstrings

Author: majestrate

sogs/http.py

@@ -8,7 +8,7 @@
 TOO_MANY_REQUESTS = 429
 ERROR_INTERNAL_SERVER_ERROR = 500
 ERROR_INSUFFICIENT_STORAGE = 507
-
+OK = 200
 
 # HTTP methods containing bodies
 BODY_METHODS = ('POST', 'PUT')

sogs/legacy_routes.py

@@ -430,47 +430,19 @@ def ban_checks():
 @app.post("/legacy/block_list")
 def handle_legacy_ban():
     user, room, to_ban = ban_checks()
-
+    code = http.OK
     if not model.ban_user(user, room, to_ban):
-        abort(http.FORBIDDEN)
-
-    return jsonify({"status_code": 200})
+        code = http.FORBIDDEN
+    return jsonify({"status_code": code})
 
 
 @app.post("/legacy/ban_and_delete_all")
 def handle_legacy_banhammer():
     user, room, to_ban = ban_checks()
-    if not model.ban_user(user, room, to_ban):
-        abort(http.FORBIDDEN)
-
-    with db.conn as conn:
-        cur = conn.cursor()
-        cur.execute(
-            """
-            UPDATE messages SET data = NULL, data_size = NULL, signature = NULL
-            WHERE room = ? AND user = ?
-            """,
-            (room.id, to_ban.id),
-        )
-
-        posts_removed = cur.rowcount
-
-        # We don't actually delete from disk right now, but clear the room (so that they aren't
-        # retrievable) and set them to be expired (so that the next file pruning will delete them
-        # from disk).
-        cur.execute(
-            "UPDATE files SET room = NULL, expiry = ? WHERE room = ? AND uploader = ?",
-            (time.time(), room.id, to_ban.id),
-        )
-        files_removed = cur.rowcount
-
-    app.logger.info(
-        "Banned {} from room {}: {} messages and {} files deleted".format(
-            to_ban.session_id, room.token, posts_removed, files_removed
-        )
-    )
-
-    return jsonify({"status_code": 200})
+    code = http.OK
+    if not model.ban_user(user, room, to_ban, also_delete_posts=True):
+        code = http.FORBIDDEN
+    return jsonify({"status_code": code})
 
 
 @app.delete("/legacy/block_list/<SessionID:session_id>")
@@ -491,7 +463,7 @@ def handle_legacy_unban(session_id):
         updated = cur.rowcount
 
     if updated > 0:
-        return jsonify({"status_code": 200})
+        return jsonify({"status_code": http.OK})
 
     abort(http.NOT_FOUND)
 

sogs/model.py

@@ -394,8 +394,8 @@ def __init__(self, row=None, *, id=None, session_id=None, autovivify=True, touch
 
     @property
     def rooms(self):
-        result = list()
         """ return the rooms this user is in by their id """
+        result = list()
         with db.conn as conn:
             rows = conn.execute("SELECT room FROM room_users WHERE user = ?", (self.id,))
             for row in rows:
@@ -636,7 +636,7 @@ def get_message_deprecated(room_id, since, limit=256):
     return msgs
 
 
-def ban_user(mod_user, room, ban_user):
+def ban_user(mod_user, room, ban_user, also_delete_posts=False):
     """as a moderator mod_user ban a user from a room
     return True if the user was banned, otherwise return False
     """
@@ -669,4 +669,31 @@ def ban_user(mod_user, room, ban_user):
             """,
             (room.id, ban_user.id),
         )
+        if also_delete_posts:
+            cur = conn.cursor()
+            cur.execute(
+                """
+                UPDATE messages SET data = NULL, data_size = NULL, signature = NULL
+                WHERE room = ? AND user = ?
+                """,
+                (room.id, ban_user.id),
+            )
+
+            posts_removed = cur.rowcount
+
+            # We don't actually delete from disk right now, but clear the room (so that they aren't
+            # retrievable) and set them to be expired (so that the next file pruning will delete them
+            # from disk).
+            cur.execute(
+                "UPDATE files SET room = NULL, expiry = ? WHERE room = ? AND uploader = ?",
+                (time.time(), room.id, ban_user.id),
+            )
+            files_removed = cur.rowcount
+
+            app.logger.info(
+                "Banned {} from room {}: {} messages and {} files deleted".format(
+                    to_ban.session_id, room.token, posts_removed, files_removed
+                )
+            )
+
     return True