DexScript - v1.0

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -12,7 +12,7 @@ body:
       label: Error Page
       description: The [error page](https://github.com/Dotsian/DexScript/wiki/Errors) explains what common errors mean and how to solve them.
       options:
-        - label: Did you read the error page and view the common errors?
+        - label: Did you read the error page and take a look at the common errors?
           required: true
   - type: dropdown
     id: location
@@ -46,15 +46,6 @@ body:
       placeholder: Version number...
     validations:
       required: true
-  - type: dropdown
-    id: platform
-    attributes:
-      label: What fork are you using?
-      options:
-        - Ballsdex
-        - CarFigures
-    validations:
-      required: true
   - type: textarea
     id: error
     attributes:

DATAPOLICY.md

@@ -8,10 +8,7 @@ We do not collect, store, or access any data from your application. DexScript on
 
 ## File Modifications
 
-During the DexScript installation process, DexScript will modify the following based on the Ballsdex version:
-
-- **2.22.0-** - `ballsdex/core/bot.py`.
-- **2.22.0+** - `config.yml`
+During the DexScript installation process, DexScript will modify your application's `config.yml` file.
 
 DexScript will add a single line of code to allow the DexScript extension to load when your application starts. This modification is solely for the purpose of running DexScript. You can view the code added by checking the `DexScript/github/installer.py` file in the official DexScript GitHub repository.
 

DexScript/github/installer.py

@@ -6,6 +6,7 @@
 #  An explanation of the code will be provided below. #
 #                                                     #
 #      THIS CODE IS RAN VIA THE `EVAL` COMMAND.       #
+# # # # # # # # # # # # # # # # # # # # # # # # # # # #
 
 
 import os
@@ -15,7 +16,6 @@
 from dataclasses import dataclass
 from dataclasses import field as datafield
 from datetime import datetime
-from enum import Enum
 from io import StringIO
 from traceback import format_exc
 
@@ -25,11 +25,7 @@
 from discord.ext import commands
 
 UPDATING = os.path.isdir("ballsdex/packages/dexscript")
-
-
-class MigrationType(Enum):
-    APPEND = 1
-    REPLACE = 2
+ASSET_PATH = "https://raw.githubusercontent.com/Dotsian/DexScript/refs/heads/main/assets"
 
 
 @dataclass
@@ -38,25 +34,13 @@ class InstallerConfig:
     Configuration class for the installer.
     """
 
-    github = ["Dotsian/DexScript", "main"]
-    files = ["__init__.py", "cog.py", "commands.py", "parser.py", "utils.py"]
+    github = ["Dotsian/DexScript", "dev"]
+    files = ["__init__.py", "cog.py", "commands.py", "parser.py", "utils.py", "config.toml"]
     appearance = {
-        "logo": "https://raw.githubusercontent.com/Dotsian/DexScript/refs/heads/dev/assets/DexScriptLogo.png",
-        "logo_error": "https://raw.githubusercontent.com/Dotsian/DexScript/refs/heads/dev/assets/DexScriptLogoError.png",
-        "banner": "https://raw.githubusercontent.com/Dotsian/DexScript/refs/heads/dev/assets/DexScriptPromo.png",
+        "logo": f"{ASSET_PATH}/DexScriptLogo.png",
+        "logo_error": f"{ASSET_PATH}/DexScriptLogoError.png",
+        "banner": f"{ASSET_PATH}/DexScriptPromo.png",
     }
-    install_migrations = [
-        (
-            "||await self.add_cog(Core(self))",
-            '||await self.load_extension("ballsdex.packages.dexscript")\n',
-            MigrationType.APPEND,
-        ),
-        (
-            '||await self.load_extension("ballsdex.core.dexscript")\n',
-            '||await self.load_extension("ballsdex.packages.dexscript")\n',
-            MigrationType.REPLACE,
-        ),
-    ]
     uninstall_migrations = [
         '||await self.load_extension("ballsdex.core.dexscript")\n',
         '||await self.load_extension("ballsdex.packages.dexscript")\n',
@@ -87,15 +71,10 @@ def __init__(self, installer, embed_type="setup"):
 
         self.installer = installer
 
-        match embed_type:
-            case "setup":
-                self.setup()
-            case "error":
-                self.error()
-            case "installed":
-                self.installed()
-            case "uninstalled":
-                self.uninstalled()
+        if not hasattr(self, embed_type):
+            return
+
+        getattr(self, embed_type)()
 
     def setup(self):
         self.title = "DexScript Installation"
@@ -125,7 +104,12 @@ def error(self):
         self.timestamp = datetime.now()
 
         if logger.output != []:
-            self.description += f"\n```{logger.output[-1]}```"
+            output = logger.output[-1]
+
+            if len(output) >= 750:
+                output = logger.output[-1][:750] + "..."
+
+            self.description += f"\n```{output}```"
 
         self.installer.interface.attachments = [logger.file("DexScript.log")]
 
@@ -150,6 +134,15 @@ def uninstalled(self):
 
         self.set_thumbnail(url=config.appearance["logo"])
 
+    def config(self):
+        with open(f"{config.path}/config.toml") as file:
+            file_contents = file.read()
+
+        self.title = "DexScript Configuration"
+        self.description = f"```toml\n{file_contents}\n```"
+        self.color = discord.Color.from_str("#03BAFC")
+        self.timestamp = datetime.now()
+
 
 class InstallerView(discord.ui.View):
     def __init__(self, installer):
@@ -188,11 +181,153 @@ async def uninstall_button(self, interaction: discord.Interaction, _: discord.ui
         await interaction.message.edit(**self.installer.interface.fields)
         await interaction.response.defer()
 
+    @discord.ui.button(
+        style=discord.ButtonStyle.secondary,
+        label="Config",
+        disabled=not os.path.isfile(f"{config.path}/config.toml")
+    )
+    async def config_button(self, interaction: discord.Interaction, _: discord.ui.Button):
+        self.installer.interface.embed = InstallerEmbed(self.installer, "config")
+        self.installer.interface.view = ConfigView(self.installer)
+
+        await interaction.message.edit(**self.installer.interface.fields)
+        await interaction.response.defer()
+
     @discord.ui.button(style=discord.ButtonStyle.red, label="Exit")
     async def quit_button(self, interaction: discord.Interaction, _: discord.ui.Button):
-        self.install_button.disabled = True
-        self.uninstall_button.disabled = True
-        self.quit_button.disabled = True
+        for item in self.children:
+            item.disabled = True
+
+        await interaction.message.edit(**self.installer.interface.fields)
+        await interaction.response.defer()
+
+
+class ConfigModal(discord.ui.Modal):
+    def __init__(self, installer, setting: str):
+        self.installer = installer
+        self.setting = setting
+
+        super().__init__(title=f"Editing `{setting}`")
+
+    value = discord.ui.TextInput(label="New value", required=True)
+
+    async def on_submit(self, interaction: discord.Interaction):
+        with open(f"{config.path}/config.toml") as file:
+            lines = [x.strip() for x in file.readlines()]
+            new_lines = []
+
+            for line in lines:
+                if not line.startswith(self.setting):
+                    new_lines.append(line + "\n")
+                    continue
+
+                full_value = self.value.value
+                new_value = f'"{full_value}"'
+
+                if full_value.lower() in ["true", "false"]:
+                    new_value = full_value.lower()
+                elif full_value.startswith("[") and full_value.endswith("]"):
+                    new_value = full_value
+
+                new_lines.append(f"{self.setting} = {new_value}\n")
+
+            with open(f"{config.path}/config.toml", "w") as write_file:
+                write_file.writelines(new_lines)
+
+        self.installer.interface.embed = InstallerEmbed(self.installer, "config")
+
+        await interaction.message.edit(**self.installer.interface.fields)
+
+        await interaction.response.send_message(
+            f"Updated `{self.setting}` to `{self.value.value}`!",
+            ephemeral=True
+        )
+
+
+class ConfigSelect(discord.ui.Select):
+    def __init__(self, installer):
+        self.installer = installer
+
+        options = []
+
+        with open(f"{config.path}/config.toml") as file:
+            description = ""
+
+            for line in file.readlines():
+                if line.rstrip() in ["\n", "", "]"] or line.startswith(" "):
+                    continue
+
+                if line.startswith("#"):
+                    description = line[2:]
+                    continue
+
+                name = line.split(" ")[0]
+
+                options.append(
+                    discord.SelectOption(label=name, value=name, description=description)
+                )
+
+                description = ""
+
+        super().__init__(placeholder="Edit setting", max_values=1, min_values=1, options=options)
+
+    async def callback(self, interaction: discord.Interaction):
+        await interaction.response.send_modal(ConfigModal(self.installer, self.values[0]))
+
+
+class ConfigView(discord.ui.View):
+    def __init__(self, installer):
+        super().__init__()
+        self.installer = installer
+
+        back_button = discord.ui.Button(label="Back", style=discord.ButtonStyle.primary)
+        reset_button = discord.ui.Button(label="Reset", style=discord.ButtonStyle.grey)
+        quit_button = discord.ui.Button(label="Exit", style=discord.ButtonStyle.red)
+
+        back_button.callback = self.back_button
+        reset_button.callback = self.reset_button
+        quit_button.callback = self.quit_button
+
+        self.add_item(back_button)
+        self.add_item(ConfigSelect(installer))
+        self.add_item(reset_button)
+        self.add_item(quit_button)
+
+    async def back_button(self, interaction: discord.Interaction):
+        self.installer.interface.embed = InstallerEmbed(self.installer, "setup")
+        self.installer.interface.view = InstallerView(self.installer)
+
+        await interaction.message.edit(**self.installer.interface.fields)
+        await interaction.response.defer()
+
+    async def reset_button(self, interaction: discord.Interaction):
+        request = requests.get(
+            f"https://api.github.com/repos/{config.github[0]}/"
+            "contents/DexScript/package/config.toml",
+            {"ref": config.github[1]}
+        )
+
+        if request.status_code != requests.codes.ok:
+            await interaction.response.send_message(
+                f"Failed to reset config file `({request.status_code})`", ephemeral=True
+            )
+            return
+
+        request = request.json()
+        content = b64decode(request["content"])
+
+        with open(f"{config.path}/config.toml", "w") as opened_file:
+            opened_file.write(content.decode())
+
+        self.installer.interface.embed = InstallerEmbed(self.installer, "config")
+
+        await interaction.message.edit(**self.installer.interface.fields)
+
+        await interaction.response.send_message("Successfully reset config file", ephemeral=True)
+
+    async def quit_button(self, interaction: discord.Interaction):
+        for item in self.children:
+            item.disabled = True
 
         await interaction.message.edit(**self.installer.interface.fields)
         await interaction.response.defer()
@@ -232,6 +367,12 @@ class Installer:
     def __init__(self):
         self.interface = InstallerGUI(self)
 
+    def has_package_config(self) -> bool:
+        with open("config.yml", "r") as file:
+            lines = file.readlines()
+
+        return "packages:\n" in lines
+
     def add_package(self, package: str) -> bool:
         with open("config.yml", "r") as file:
             lines = file.readlines()
@@ -270,41 +411,24 @@ def uninstall_migrate(self):
         with open("ballsdex/core/bot.py", "w") as write_file:
             write_file.writelines(lines)
 
-    def install_migrate(self):
-        with open("ballsdex/core/bot.py", "r") as read_file:
-            lines = read_file.readlines()
-
-        for index, line in enumerate(lines):
-            for migration in config.install_migrations:
-                original = self.format_migration(migration[0])
-                new = self.format_migration(migration[1])
-
-                match migration[2]:
-                    case MigrationType.REPLACE:
-                        if line.rstrip() != original:
-                            continue
-
-                        lines[index] = new
-                    case MigrationType.APPEND:
-                        if line.rstrip() != original or new in lines:
-                            continue
-
-                        lines.insert(index + 1, new)
-
-        with open("ballsdex/core/bot.py", "w") as write_file:
-            write_file.writelines(lines)
-
     async def install(self):
+        if not self.has_package_config():
+            raise Exception("Your Ballsdex version is no longer compatible with DexScript")
+
         if os.path.isfile("ballsdex/core/dexscript.py"):
             os.remove("ballsdex/core/dexscript.py")
 
             await bot.remove_cog("DexScript")  # type: ignore
 
-        link = f"https://api.github.com/repos/{config.github[0]}/contents/"
+        link = f"https://api.github.com/repos/{config.github[0]}/contents"
 
         os.makedirs(config.path, exist_ok=True)
 
         for file in config.files:
+            if file.endswith(".toml") and os.path.isfile(f"{config.path}/{file}"):
+                logger.log(f"{file} already exists, skipping", "INFO")
+                continue
+
             logger.log(f"Fetching {file} from '{link}/DexScript/package'", "INFO")
 
             request = requests.get(f"{link}/DexScript/package/{file}", {"ref": config.github[1]})
@@ -319,16 +443,13 @@ async def install(self):
             content = b64decode(request["content"])
 
             with open(f"{config.path}/{file}", "w") as opened_file:
-                opened_file.write(content.decode("UTF-8"))
+                opened_file.write(content.decode())
 
             logger.log(f"Installed {file} from '{link}/DexScript/package'", "INFO")
 
         logger.log("Applying bot.py migrations", "INFO")
 
-        if self.add_package(config.path.replace("/", ".")):
-            self.uninstall_migrate()
-        else:
-            self.install_migrate()
+        self.add_package(config.path.replace("/", "."))
 
         logger.log("Loading DexScript extension", "INFO")
 
@@ -363,7 +484,7 @@ def latest_version(self):
         if pyproject_request.status_code != requests.codes.ok:
             return
 
-        toml_content = b64decode(pyproject_request.json()["content"]).decode("UTF-8")
+        toml_content = b64decode(pyproject_request.json()["content"]).decode()
         new_version = re.search(r'version\s*=\s*"(.*?)"', toml_content)
 
         if not new_version: