FEAT: Private and Global chats (#96)

* FEAT: add private chats for each user

* add tests

* add more tests

* comment out tests that cause bugs

* update docs

Author: dborodin836

.github/workflows/ci.yml

@@ -28,3 +28,6 @@ jobs:
 
       - name: Run pytest
         run: pytest . --cov .
+
+      - name: Run pytest (Random)
+        run: pytest . --random-order --count 10 --capture=no --cov .

README.md

@@ -13,8 +13,8 @@
 - [Usage](#usage)
     - [GUI Commands](#gui-commands)
     - [Chat Commands](#chat-commands)
-        - [!gpt3, !gpt4, !gpt4l](#gpt3--gpt4--gpt4l)
-        - [!cgpt](#cgpt)
+        - [!gpt3, !gpt4, !gpt4l, !ai](#gpt3--gpt4--gpt4l--ai)
+        - [!cgpt, !chat, !pc, !pcc](#cgpt--chat--pc--pcc)
         - [!clear](#clear)
         - [!rtd](#rtd)
     - [Custom Models](#custom-language-models-oobabooga--text-generation-webui)
@@ -121,7 +121,6 @@ pip install -r requirements.txt
 Edit configuration file named config.ini and set the required configuration variables in GENERAL section, such as API
 keys and file paths. You can leave the rest as it is.
 
-
 ```
 [GENERAL]
 TF2_LOGFILE_PATH=H:\Programs\Steam\steamapps\common\Team Fortress 2\tf\console.log
@@ -175,14 +174,17 @@ pyinstaller --onefile --clean -n TF2-GPTChatBot --icon icon.ico -w --add-data "i
 
 Commands can be changed in `config.ini` file.
 
-#### !gpt3 & !gpt4 & !gpt4l
+#### !gpt3 & !gpt4 & !gpt4l & !ai
 
 Model used for !gpt3: `gpt-3.5-turbo`
 
 Model used for !gpt4: `gpt-4-1106-preview`
 
 Model used for !gpt4l: `gpt-4`
 
+Unlike other commands, the `!ai` command utilizes a custom model, as detailed in
+the [Custom Models](#custom-language-models-oobabooga--text-generation-webui) section.
+
 ```
 Command: !gpt3 [roleplay options] [\l long] [prompt]
 
@@ -208,8 +210,8 @@ Prompt:
   A required argument specifying the text prompt for generating text.
 ```
 
-`\stats` Must be enabled in `config.ini`. Also, you must set a [Steam Web API Key](https://steamcommunity.com/dev/apikey).
-
+`\stats` Must be enabled in `config.ini`. Also, you must set
+a [Steam Web API Key](https://steamcommunity.com/dev/apikey).
 
 #### !gpt Usage examples
 
@@ -223,9 +225,15 @@ response: Oy, laddie! Yer lookin' for some advice? Well, let me tell ye, blastin
           always a fine solution! Just remember to always have a bottle of scrumpy on hand, and never trust a Spy.
 ```
 
-#### !cgpt
+#### !cgpt & !chat & !pc & !pcc
 
-Used model: `gpt-3.5-turbo`
+Model used for !cgpt & !pc: `gpt-3.5-turbo`
+
+The commands `!pc` (Private Chat) and `!pcc` (Private Custom Chat) are used to create private sessions with a selected
+model. This is in contrast to the `!cgpt` command, which allows for interactions that anyone can join.
+
+Unlike other commands, the `!pcc` and `!chat` commands utilize a custom model (
+see [Custom Models](#custom-language-models-oobabooga--text-generation-webui)).
 
 ```
 Command: !cgpt [roleplay options] [\l long] [prompt]
@@ -255,8 +263,8 @@ Prompt:
   A required argument specifying the text prompt for generating text.
 ```
 
-`\stats` Must be enabled in `config.ini`. Also, you must set a [Steam Web API Key](https://steamcommunity.com/dev/apikey).
-
+`\stats` Must be enabled in `config.ini`. Also, you must set
+a [Steam Web API Key](https://steamcommunity.com/dev/apikey).
 
 #### !cgpt Usage examples
 
@@ -276,8 +284,15 @@ Command: !clear
 
 Description: Clears the chat history.
 
-This command takes no arguments or options. Simply type !clear in the chat to clear the history. Be careful, this action 
-cannot be undone.
+Options are not required and can be used in any combination.
+
+Calling without arguments clears own private chat history for any user.
+
+Global Option (admin only):
+  \global  Clears global chat history.
+  
+User Option (admin only):
+  \user='username'  Clears private chat history for the specified user.
 ```
 
 #### !rtd
@@ -306,22 +321,25 @@ Mode 2: Sends a random link to a YouTube meme.
 
 ### Custom language models (oobabooga / text-generation-webui)
 
-Please follow these steps to set up a custom model for text generation using the [oobabooga/text-generation-webui](https://github.com/oobabooga/text-generation-webui) project:
+Please follow these steps to set up a custom model for text generation using
+the [oobabooga/text-generation-webui](https://github.com/oobabooga/text-generation-webui) project:
 
 1. Open the `config.ini` file and set the `ENABLE_CUSTOM_MODEL` variable to `1`.
 
-2. Next, install the `oobabooga/text-generation-webui` using installer. You can find the installation instructions 
+2. Next, install the `oobabooga/text-generation-webui` using installer. You can find the installation instructions
    easily in the README.md file of that repository.
 
 3. Download the model of your choice for text generation.
 
-4. Launch the `text-generation-webui` application, ensuring that you include the `--api` option in the launch settings (`CMD_FLAGS.txt` file).
+4. Launch the `text-generation-webui` application, ensuring that you include the `--api` option in the launch
+   settings (`CMD_FLAGS.txt` file).
 
 > **NOTE**: If you're running the api on a remote server you might try `--public-api` option.
 
 5. After the application starts, copy the **OpenAI-compatible API URL** provided by the application.
 
-6. Open the `config.ini` file once more and find the `CUSTOM_MODEL_HOST` variable. Paste the previously copied URL as the value for this variable.
+6. Open the `config.ini` file once more and find the `CUSTOM_MODEL_HOST` variable. Paste the previously copied URL as
+   the value for this variable.
 
 7. Save the changes made to the `config.ini` file.
 
@@ -371,14 +389,14 @@ Hi chatGPT, you are going to pretend to be MEDIC from Team Fortress 2. You can d
 If you want to know more here are listed some things that were left unexplained, and some tips and tricks:
 [unexplained_explained.md](docs/unexplained_explained.md)
 
-
 ## Screenshots
 
 [![image.png](https://ucarecdn.com/655e590a-1664-4424-8123-ae3a4e546ee3/)](https://ucarecdn.com/655e590a-1664-4424-8123-ae3a4e546ee3/)
 
 ## Known Issues
 
 ### Nickname Limitations
+
 You cannot have a nickname that starts with a command name, such as !cgpt <your prompt>.
 
 ## FAQ
@@ -419,11 +437,12 @@ the future. At the moment, I am not aware of any limitations that could pose a p
 ### TF2 Bot Detector Cooperation (TF2BD)
 
 To successfully launch the applications, you need to start TF2-GptChatBot and TF2 Bot Detector
- (do **NOT** launch TF2 via TF2BD). Set the following launch parameters in Steam: 
+(do **NOT** launch TF2 via TF2BD). Set the following launch parameters in Steam:
 
 ```
 -rpt -high -usercon +developer 1 +contimes 0 +sv_rcon_whitelist_address 127.0.0.1 +sv_quota_stringcmdspersecond 1000000 +alias cl_reload_localization_files +ip 0.0.0.0 +rcon_password password +hostport 42465 +con_timestamp 1 +net_start +con_timestamp 1 -condebug
 ```
+
 And then launch TF2 through Steam.
 
 _NOTE: TF2BD may partially work without setting the launch parameters, but some features may not function properly._

config.ini

@@ -4,12 +4,14 @@ OPENAI_API_KEY=
 
 [COMMANDS]
 GPT_COMMAND=!gpt3
-CHATGPT_COMMAND=!cgpt
+; Private chat
+CHATGPT_COMMAND=!pc
 CLEAR_CHAT_COMMAND=!clear
 RTD_COMMAND=!rtd
 GPT4_ADMIN_ONLY=False
 GPT4_COMMAND=!gpt4
 GPT4_LEGACY_COMMAND=!gpt4l
+GLOBAL_CHAT_COMMAND=!cgpt
 GPT3_MODEL=gpt-3.5-turbo-1106
 GPT3_CHAT_MODEL=gpt-3.5-turbo-1106
 GPT4_MODEL=gpt-4-1106-preview
@@ -98,7 +100,9 @@ STEAM_WEBAPI_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 ENABLE_SOFT_LIMIT_FOR_CUSTOM_MODEL=True
 ENABLE_CUSTOM_MODEL=False
 CUSTOM_MODEL_COMMAND=!ai
-CUSTOM_MODEL_CHAT_COMMAND=!chat
+GLOBAL_CUSTOM_CHAT_COMMAND=!chat
+; Private custom chat
+CUSTOM_MODEL_CHAT_COMMAND=!pcc
 ; Adds the first message on behalf of AI,
 ; does the same thing as the "greeting" in text generation webui.
 ; Should help with the way you want the AI to talk.

config.py

@@ -52,6 +52,7 @@ class Config(BaseModel):
     CHATGPT_COMMAND: str
     CLEAR_CHAT_COMMAND: str
     RTD_COMMAND: str
+    GLOBAL_CHAT_COMMAND: str
     GPT4_ADMIN_ONLY: bool
 
     CUSTOM_PROMPT: str
@@ -74,6 +75,7 @@ class Config(BaseModel):
     CUSTOM_MODEL_HOST: str
     CUSTOM_MODEL_COMMAND: str
     CUSTOM_MODEL_CHAT_COMMAND: str
+    GLOBAL_CUSTOM_CHAT_COMMAND: str
     GREETING: str
 
     CONFIRMABLE_QUEUE: bool

modules/chat.py

@@ -2,13 +2,12 @@
 from modules.api.github import check_for_updates
 from modules.bans import bans_manager
 from modules.bot_state import state_manager
-from modules.command_controllers import CommandController
+from modules.command_controllers import CommandController, InitializerConfig
 from modules.commands.clear_chat import handle_clear
 from modules.commands.github import handle_gh_command
-from modules.commands.openai import handle_cgpt, handle_gpt3, handle_gpt4, handle_gpt4l
+from modules.commands.openai import handle_user_chat, handle_gpt3, handle_gpt4, handle_gpt4l, handle_global_chat
 from modules.commands.rtd import handle_rtd
-from modules.commands.textgen_webui import handle_custom_chat, handle_custom_model
-from modules.conversation_history import ConversationHistory
+from modules.commands.textgen_webui import handle_custom_user_chat, handle_custom_model, handle_custom_global_chat
 from modules.logs import get_logger
 from modules.message_queueing import messaging_queue_service
 from modules.servers.tf2 import check_connection, set_host_username
@@ -48,19 +47,21 @@ def parse_console_logs_and_build_conversation_history() -> None:
     """
     setup()
 
-    controller = CommandController({"CHAT_CONVERSATION_HISTORY": ConversationHistory()})
+    controller = CommandController(InitializerConfig())
 
     # Commands
     controller.register_command("!gh", handle_gh_command)
     controller.register_command(config.GPT4_COMMAND, handle_gpt4)
     controller.register_command(config.GPT4_LEGACY_COMMAND, handle_gpt4l)
     controller.register_command(config.RTD_COMMAND, handle_rtd)
     controller.register_command(config.GPT_COMMAND, handle_gpt3)
-    controller.register_command(config.CHATGPT_COMMAND, handle_cgpt)
+    controller.register_command(config.CHATGPT_COMMAND, handle_user_chat)
     controller.register_command(config.CLEAR_CHAT_COMMAND, handle_clear)
+    controller.register_command(config.GLOBAL_CHAT_COMMAND, handle_global_chat)
     if config.ENABLE_CUSTOM_MODEL:
         controller.register_command(config.CUSTOM_MODEL_COMMAND, handle_custom_model)
-        controller.register_command(config.CUSTOM_MODEL_CHAT_COMMAND, handle_custom_chat)
+        controller.register_command(config.CUSTOM_MODEL_CHAT_COMMAND, handle_custom_user_chat)
+        controller.register_command(config.GLOBAL_CUSTOM_CHAT_COMMAND, handle_custom_global_chat)
 
     # Services
     controller.register_service(messaging_queue_service)

modules/command_controllers.py

@@ -1,15 +1,49 @@
 from typing import Callable, Optional
 
+import pydantic
 from ordered_set import OrderedSet
+from pydantic import BaseModel, BaseConfig
 
-from modules.logs import get_logger, get_time_stamp
+from modules.conversation_history import ConversationHistory
+from modules.logs import get_logger
 from modules.set_once_dict import SetOnceDictionary
 from modules.typing import Command, LogLine
 
+main_logger = get_logger("main")
 combo_logger = get_logger("combo")
 gui_logger = get_logger("gui")
 
 
+class ChatHistoryManager(BaseModel):
+    GLOBAL = ConversationHistory()
+
+    def set_conversation_history_by_name(self, username: str, conv_history: ConversationHistory) -> None:
+        attr_name = self._get_conv_history_attr_name(username)
+
+        setattr(self, attr_name, conv_history)
+
+    def get_conversation_history_by_name(self, username: str) -> ConversationHistory:
+        attr_name = self._get_conv_history_attr_name(username)
+
+        if hasattr(self, attr_name):
+            return getattr(self, attr_name)
+        else:
+            main_logger.info(f"Conversation history for username '{username}' doesn't exist. Creating...")
+            setattr(self, attr_name, ConversationHistory())
+            return getattr(self, attr_name)
+
+    def _get_conv_history_attr_name(self, username: str) -> str:
+        return f"USER_{username}_CH"
+
+    class Config(BaseConfig):
+        extra = "allow"
+        arbitrary_types_allowed = "allow"
+
+
+class InitializerConfig(BaseModel):
+    CHAT_CONVERSATION_HISTORY: ChatHistoryManager = pydantic.Field(default_factory=ChatHistoryManager)
+
+
 class GuiCommandController:
     def __init__(self, initializer_config: dict = None, disable_help: bool = False) -> None:
         self.__named_commands_registry: SetOnceDictionary[str, Command] = SetOnceDictionary()
@@ -47,13 +81,13 @@ def help(self, command: str, shared_dict: dict):
 
 
 class CommandController:
-    def __init__(self, initializer_config: dict = None) -> None:
+    def __init__(self, initializer_config: InitializerConfig = None) -> None:
         self.__services = OrderedSet()
         self.__named_commands_registry: SetOnceDictionary[str, Callable] = SetOnceDictionary()
-        self.__shared = dict()
+        self.__shared = InitializerConfig()
 
         if initializer_config is not None:
-            self.__shared.update(initializer_config)
+            self.__shared.__dict__.update(initializer_config)
 
     def register_command(self, name: str, function: Callable) -> None:
         self.__named_commands_registry[name] = function

modules/commands/clear_chat.py

@@ -1,5 +1,62 @@
+from modules.command_controllers import InitializerConfig
 from modules.typing import LogLine
+from modules.utils.text import get_args
+from modules.logs import get_logger
+from config import config
 
+main_logger = get_logger("main")
+combo_logger = get_logger("combo")
 
-def handle_clear(logline: LogLine, shared_dict: dict):
-    shared_dict["CHAT_CONVERSATION_HISTORY"].reset()
+
+def handle_clear(logline: LogLine, shared_dict: InitializerConfig):
+    if logline.username == config.HOST_USERNAME:
+        args = get_args(logline.prompt.removeprefix(config.CLEAR_CHAT_COMMAND).strip())
+
+        if len(args) == 0:
+            combo_logger.info(f"Clearing chat history for user '{logline.username}'.")
+            conv_history = shared_dict.CHAT_CONVERSATION_HISTORY.get_conversation_history_by_name(logline.username)
+            conv_history.reset()
+            shared_dict.CHAT_CONVERSATION_HISTORY.set_conversation_history_by_name(logline.username, conv_history)
+            return
+
+        if r"\global" in args:
+            shared_dict.CHAT_CONVERSATION_HISTORY.GLOBAL.reset()
+            args.remove(r"\global")
+            combo_logger.info("Clearing global chat!")
+
+        for arg in args:
+            try:
+                parts = arg.split("=")
+                if len(parts) != 2:
+                    combo_logger.error(r'Wrong syntax! e.g. !clear \global \user="username"')
+                    continue
+
+                name: str
+                arg: str
+                arg, name = parts
+
+                if arg != r"\user":
+                    combo_logger.error(r'Wrong syntax! e.g. !clear \global \user="username"')
+                    continue
+
+                if not (name.startswith("'") and name.endswith("'")):
+                    combo_logger.error(r'Wrong syntax! e.g. !clear \global \user="username"')
+                    continue
+
+                name = name.removeprefix("'")
+                name = name.removesuffix("'")
+
+                combo_logger.info(f"Clearing chat history for user '{name}'.")
+                conv_history = shared_dict.CHAT_CONVERSATION_HISTORY.get_conversation_history_by_name(name)
+                conv_history.reset()
+                shared_dict.CHAT_CONVERSATION_HISTORY.set_conversation_history_by_name(name, conv_history)
+
+            except Exception as e:
+                main_logger.trace(f"Failed to parse arg in clear chat command. [{e}]")
+                continue
+
+    else:
+        combo_logger.info(f"Clearing chat history for user '{logline.username}'.")
+        conv_history = shared_dict.CHAT_CONVERSATION_HISTORY.get_conversation_history_by_name(logline.username)
+        conv_history.reset()
+        shared_dict.CHAT_CONVERSATION_HISTORY.set_conversation_history_by_name(logline.username, conv_history)

modules/commands/github.py

@@ -1,14 +1,15 @@
 import time
 
 from config import config
+from modules.command_controllers import InitializerConfig
 from modules.servers.tf2 import send_say_command_to_tf2
 from modules.typing import LogLine
 from modules.utils.text import get_shortened_username
 
 GITHUB_LINK = "bit.ly/tf2-gpt3"
 
 
-def handle_gh_command(logline: LogLine, shared_dict: dict) -> None:
+def handle_gh_command(logline: LogLine, shared_dict: InitializerConfig) -> None:
     time.sleep(1)
 
     if config.ENABLE_SHORTENED_USERNAMES_RESPONSE: