inital commit

Author: 0xMRTT

.gitignore

@@ -0,0 +1,3 @@
+run.sh
+faqbot.service
+session.txt

README.md

@@ -0,0 +1,7 @@
+# Matrix FAQ Bot
+
+## Install
+
+## Usage
+
+- Edit/add faq in `faq.json`

faq.json

@@ -0,0 +1,3 @@
+{
+    "nightly": "You can download Gradience nightly builds from <a href='https://github.com/GradienceTeam/Gradience/actions/workflows/build.yml'>here</a>."
+}

faqbot/__init__.py

@@ -0,0 +1,96 @@
+import simplematrixbotlib as botlib
+import os
+import subprocess
+import json
+import sys
+
+PREFIX = "!"
+
+USERNAME = os.environ.get("MATRIX_USERNAME", "oxmrtt")
+SERVER = os.environ.get("MATRIX_SERVER", "https://mtrx.vern.cc")
+PASSWORD = os.environ.get("MATRIX_PASSWORD", None)
+ALIASES = os.environ.get("ALIASES", "faq, f").split(", ")
+FAQ_CONFIG = os.environ.get("FAQ_CONFIG", "faq.json")
+SYSTEMD_SERVICE_NAME = os.environ.get("SYSTEMD_SERVICE_NAME", "faqbot")
+
+HELP = f"""
+Help Message:
+    prefix: {PREFIX}
+    commands:
+        faq:
+            command: {", ".join(ALIASES)}
+            description: display faq for an argument
+            example: {PREFIX}faq nightly
+
+        help:
+            command: {", ".join(ALIASES)} help, {", ".join(ALIASES)} ?, {", ".join(ALIASES)} h
+            description: display help command
+
+        faq all:
+            command: {", ".join(ALIASES)} all
+            description: display all faq
+        
+"""
+
+
+def run():
+    if not USERNAME or not SERVER or not PASSWORD:
+        print(
+            "Please set the environment variables MATRIX_USERNAME(optional), MATRIX_SERVER(optional), and MATRIX_PASSWORD(required)"
+        )
+        return
+
+    creds = botlib.Creds(SERVER, USERNAME, PASSWORD)
+    bot = botlib.Bot(creds)
+
+    FAQ = {}
+
+    @bot.listener.on_message_event
+    async def faq(room, message):
+        match = botlib.MessageMatch(room, message, bot, PREFIX)
+
+        if match.is_not_from_this_bot() and match.prefix() and ALIASES:
+            for alias in ALIASES:
+                if match.command(alias):
+                    break
+            else:
+                return
+
+            try:
+                prompt = " ".join(arg for arg in match.args())
+
+                global FAQ
+                if not FAQ:
+                    with open(FAQ_CONFIG) as f:
+                        FAQ = json.load(f)
+
+                if prompt == "help" or prompt == "h" or prompt == "?":
+                    await bot.api.send_markdown_message(room.room_id, HELP)
+                    return
+
+                elif prompt == "all":
+                    for key, value in FAQ.items():
+                        await bot.api.send_markdown_message(
+                            room.room_id, f"> {key}\n\n{value}"
+                        )
+                else:
+                    if prompt in FAQ:
+                        response = FAQ[prompt]
+                    else:
+                        response = "I don't know the answer to that question."
+
+                    await bot.api.send_markdown_message(room.room_id, f"{response}")
+            except Exception as e:
+                print(e)
+                await bot.api.send_markdown_message(room.room_id, f"> {prompt}\n\n{e}")
+
+    try:
+        bot.run()
+    except Exception as e:
+        subprocess.run(["systemctl", "restart", "--user", SYSTEMD_SERVICE_NAME])
+        print("Restarting bot due to {e}")
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(run())

poetry.lock

@@ -0,0 +1,15 @@
+[tool.poetry]
+name = "faqbot"
+version = "0.1.0"
+description = ""
+authors = ["0xMRTT <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+simplematrixbotlib = "^2.8.0"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -0,0 +1,6 @@
+cd /home/0xmrtt/faqbot
+
+export MATRIX_PASSWORD="secret password"
+
+python faqbot/__init__.py
+