initial commit: barebones bot model plus bot_mode implementation details

Author: dr7ana

sogs/model/bot.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+from .. import crypto, db, config
+from ..db import query
+from ..web import app
+from .exc import NoSuchUser, BadPermission
+from sogs.model.user import User
+from .exc import (InvalidData)
+
+from typing import Optional, List
+import time
+import contextlib
+
+
+class Bot:
+    """
+    Class representing a simple bot to manage open group server
+
+    Object Properties:
+        id - database primary key for user row
+        session_id - jex encoded session_id of the bot
+        banned - default to false
+        global_admin - default to true for bot
+        global_moderator - default to true for bot
+        visible_mod - default to true for bot
+    """
+
+    def __init__(
+        self,
+        row = None,
+        *,
+        id: Optional[int] = None,
+        session_id: Optional[int] = None) -> None:
+
+        # immutable attributes
+        self._banned = False
+        self._global_admin = False
+        self._global_moderator = False
+        self._visible_mod = False
+
+        # operational attributes
+        self.current_message = None
+        self.nlp_model = None
+        self.language = "English"
+        self.word_blacklist = ['placeholderlist', 'until', 'we', 'decide', 'naughty', 'words']
+
+
+    def __setattr__(self, __name: str, __value) -> None:
+        if __name in ['_banned', '_global_admin', '_global_moderator', '_visible_mod']:
+            raise AttributeError("Cannot modify bots")
+        else:
+            setattr(self, __name, __value)
+
+    def __delattr__(self, __name: str) -> None:
+        if __name in ['_banned', '_global_admin', '_global_moderator', '_visible_mod']:
+            raise AttributeError("Cannot modify bots")
+        else:
+            delattr(self, __name)
+
+    def receive_message(self,  
+        user: User,
+        data: bytes,
+        sig: bytes,
+        *,
+        files: List[int] = []):
+
+        if data is None or sig is None or len(sig) != 64:
+            raise InvalidData()
+
+        

sogs/model/room.py

@@ -17,6 +17,7 @@
     PostRateLimited,
     InvalidData,
 )
+from model.bot import Bot
 
 import os
 import random
@@ -71,6 +72,9 @@ class Room:
         default_accessible - True if default user permissions include accessible permission
         default_write - True if default user permissions includes write permission
         default_upload - True if default user permissions includes file upload permission
+        
+        NEW:
+        bot_mode - true if bot moderator is actively on patrol
     """
 
     def __init__(self, row=None, *, id=None, token=None):
@@ -79,6 +83,12 @@ def __init__(self, row=None, *, id=None, token=None):
         looking up this raises a NoSuchRoom if no room with that token/id exists.
         """
         self._refresh(id=id, token=token, row=row)
+        self.bot_mode = False
+        self.bot = None
+
+    def add_bot(self, _bot: Bot):
+        self.bot = _bot
+        self.bot_mode = True
 
     def _refresh(self, *, id=None, token=None, row=None, perms=False):
         """

sogs/routes/messages.py

@@ -1,5 +1,6 @@
 from .. import http, utils
 from . import auth
+from model.room import Room
 
 from flask import abort, jsonify, g, Blueprint, request
 
@@ -15,7 +16,7 @@ def qs_reactors():
 
 @messages.get("/room/<Room:room>/messages/since/<int:seqno>")
 @auth.read_required
-def messages_since(room, seqno):
+def messages_since(room: Room, seqno):
     """
     Retrieves message *updates* from a room.  This is the main message polling endpoint in SOGS.
 
@@ -99,7 +100,7 @@ def messages_since(room, seqno):
 
 @messages.get("/room/<Room:room>/messages/before/<int:msg_id>")
 @auth.read_required
-def messages_before(room, msg_id):
+def messages_before(room: Room, msg_id):
     """
     Retrieves messages from the room preceding a given id.
 
@@ -142,7 +143,7 @@ def messages_before(room, msg_id):
 
 @messages.get("/room/<Room:room>/messages/recent")
 @auth.read_required
-def messages_recent(room):
+def messages_recent(room: Room):
     """
     Retrieves recent messages posted to this room.
 
@@ -181,7 +182,7 @@ def messages_recent(room):
 
 @messages.get("/room/<Room:room>/message/<int:msg_id>")
 @auth.read_required
-def message_single(room, msg_id):
+def message_single(room: Room, msg_id):
     """
     Returns a single message by ID.
 
@@ -310,7 +311,7 @@ def message_single(room, msg_id):
 
 @messages.post("/room/<Room:room>/message")
 @auth.user_required
-def post_message(room):
+def post_message(room: Room):
     """
     Posts a new message to a room.
 
@@ -359,21 +360,28 @@ def post_message(room):
     """
     req = request.json
 
-    msg = room.add_post(
-        g.user,
-        data=utils.decode_base64(req.get('data')),
-        sig=utils.decode_base64(req.get('signature')),
-        whisper_to=req.get('whisper_to'),
-        whisper_mods=bool(req.get('whisper_mods')),
-        files=[int(x) for x in req.get('files', [])],
-    )
+    if room.bot_mode:
+      room.bot.receive_message(
+          user = g.user,
+          data = utils.decode_base64(req.get('data')),
+          sig = utils.decode_base64(req.get('signature')),
+          files = [int(x) for x in req.get('files', [])])
+    else:
+      msg = room.add_post(
+          g.user,
+          data=utils.decode_base64(req.get('data')),
+          sig=utils.decode_base64(req.get('signature')),
+          whisper_to=req.get('whisper_to'),
+          whisper_mods=bool(req.get('whisper_mods')),
+          files=[int(x) for x in req.get('files', [])],
+      )
 
     return utils.jsonify_with_base64(msg), http.CREATED
 
 
 @messages.put("/room/<Room:room>/message/<int:msg_id>")
 @auth.user_required
-def edit_message(room, msg_id):
+def edit_message(room: Room, msg_id):
     """
     Edits a message, replacing its existing content with new content and a new signature.
 
@@ -420,7 +428,7 @@ def edit_message(room, msg_id):
 
 @messages.delete("/room/<Room:room>/message/<int:msg_id>")
 @auth.user_required
-def remove_message(room, msg_id):
+def remove_message(room: Room, msg_id):
     """
     Remove a message by its message id
 
@@ -447,7 +455,7 @@ def remove_message(room, msg_id):
 
 
 @messages.post("/room/<Room:room>/pin/<int:msg_id>")
-def message_pin(room, msg_id):
+def message_pin(room: Room, msg_id):
     """
     Adds a pinned message to this room.
 
@@ -490,7 +498,7 @@ def message_pin(room, msg_id):
 
 
 @messages.post("/room/<Room:room>/unpin/<int:msg_id>")
-def message_unpin(room, msg_id):
+def message_unpin(room: Room, msg_id):
     """
     Remove a message from this room's pinned message list.
 
@@ -524,7 +532,7 @@ def message_unpin(room, msg_id):
 
 
 @messages.post("/room/<Room:room>/unpin/all")
-def message_unpin_all(room):
+def message_unpin_all(room: Room):
     """
     Removes *all* pinned messages from this room.
 
@@ -553,7 +561,7 @@ def message_unpin_all(room):
 @messages.put("/room/<Room:room>/reaction/<int:msg_id>/<path:reaction>")
 @auth.user_required
 @auth.read_required
-def message_react(room, msg_id, reaction):
+def message_react(room: Room, msg_id, reaction):
     """
     Adds a reaction to the given message in this room.  The user must have read access in the room.
 
@@ -606,7 +614,7 @@ def message_react(room, msg_id, reaction):
 @messages.delete("/room/<Room:room>/reaction/<int:msg_id>/<path:reaction>")
 @auth.user_required
 @auth.read_required
-def message_unreact(room, msg_id, reaction):
+def message_unreact(room: Room, msg_id, reaction):
     """
     Removes a reaction from a post this room.  The user must have read access in the room.  This
     only removes the user's own reaction but does not affect the reactions of other users.
@@ -642,7 +650,7 @@ def message_unreact(room, msg_id, reaction):
 @messages.delete("/room/<Room:room>/reactions/<int:msg_id>/<path:reaction>")
 @messages.delete("/room/<Room:room>/reactions/<int:msg_id>")
 @auth.mod_required
-def message_delete_reactions(room, msg_id, reaction=None):
+def message_delete_reactions(room: Room, msg_id, reaction=None):
     """
     Removes all reactions of all users from a post in this room.  The calling must have moderator
     permissions in the room.  This endpoint can either remove a single reaction (e.g. remove all 🍆
@@ -677,7 +685,7 @@ def message_delete_reactions(room, msg_id, reaction=None):
 
 @messages.get("/room/<Room:room>/reactors/<int:msg_id>/<path:reaction>")
 @auth.read_required
-def message_get_reactors(room, msg_id, reaction):
+def message_get_reactors(room: Room, msg_id, reaction):
     """
     Returns the list of all reactors who have added a particular reaction to a particular message.