Fixed single digit second submissions. Covered bases to ensure time format is consistant.

.gitignore

@@ -132,3 +132,6 @@ nextcord.log
 
 # data file for bot
 highscores_data.json
+highscores_message_map.json
+highscores_config.json
+deleted_backups/

cogs/delete_scores/__init__.py

@@ -0,0 +1,40 @@
+"""
+Bot command for deleting the guild's scores.
+"""
+
+from nextcord import Embed
+from nextcord.ext import commands
+
+from highscores import highscores_data  # pylint: disable=import-error
+from utilities.highscores_data import save_highscores_data  # pylint: disable=import-error
+
+
+class DeleteScores(commands.Cog, name="Delete Scores"):
+    """
+    Warning: This command only works for developers.
+    Deletes this guild's scores.
+    """
+
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.command(name="delete-scores")
+    @commands.has_permissions(administrator=True)
+    async def delete_scores(self, ctx: commands.Context):
+        """A command which deletes all scores for this guild.
+        Usage:
+        ```
+        ?delete_scores
+        ```
+        """
+        # only allow AlwaysCompiling to use.
+        # If you are a developer and want to use command, can add name to list
+        if ctx.author.id == 206602713511886849:
+            highscores_data.reset_guild_data(ctx.guild.id)
+
+
+# This function will be called when this extension is loaded.
+# It is necessary to add these functions to the bot.
+def setup(bot: commands.Bot):
+    """Adds function to bot"""
+    bot.add_cog(DeleteScores(bot))

cogs/guild_listener/__init__.py

@@ -0,0 +1,44 @@
+"""
+Defines cog for guild listeners. Contains functions for various guild events.
+"""
+
+import os
+import json
+
+from nextcord.ext import commands
+import nextcord
+
+from highscores import highscores_data  # pylint: disable=import-error
+
+
+class GuildListener(commands.Cog, name="Guild Listener"):
+    """Sets up message listener."""
+
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_guild_join(self, guild: nextcord.Guild):
+        """Listener for Guild Join. Creates skeleton for new guild joined and saves it."""
+        # turning guild id into string because json doesn't support ints as object keys.
+        highscores_data.add_new_server(guild.id)
+
+        welcome_message: str = "Hello, I keep track of Highscores for you!"
+        welcome_message += " Currently only supporting RuneScape boss highscores,"
+        welcome_message += " but will be more dynamic support in future."
+        welcome_message += ' For assistance on getting started, use "?register help".'
+
+        await guild.system_channel.send(content=welcome_message)
+
+    @commands.Cog.listener()
+    async def on_guild_remove(self, guild: nextcord.Guild):
+        """Listener for Guild Remove. Removes data from highscores_data."""
+        print(f"Removing data for guild {guild.name} (id {guild.id}).")
+        highscores_data.remove_guild(guild.id, guild.name)
+
+
+# This function will be called when this extension is loaded.
+# It is necessary to add these functions to the bot.
+def setup(bot: commands.Bot):
+    """Adds function to bot"""
+    bot.add_cog(GuildListener(bot))

cogs/help/__init__.py

@@ -22,5 +22,5 @@ class HelpCog(commands.Cog):
 
 # setup functions for bot
 def setup(bot: commands.Bot):
-    """Adds functon to bot"""
+    """Adds function to bot"""
     bot.add_cog(HelpCog(bot))

cogs/message_listener/__init__.py

@@ -0,0 +1,100 @@
+"""
+Defines cog for on message listener.
+"""
+
+import re
+
+from nextcord.ext import commands
+import nextcord
+
+from cogs.submission.submission_views import SubmissionState  # pylint: disable=import-error
+from cogs.submission.submission_views import get_submission_embed  # pylint: disable=import-error
+from highscores import highscores_data  # pylint: disable=import-error
+from highscores import submission_objects  # pylint: disable=import-error
+
+
+class SubmissionListener(commands.Cog, name="Message Listener"):
+    """Sets up message listener."""
+
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_message(self, message: nextcord.Message):
+        """Listener for message creation. Adds score and attachments to submission."""
+        guild_id = message.guild.id
+        if message.author.id in submission_objects:
+            message_id = submission_objects[message.author.id]["message_id"]
+            submission_channel_id = highscores_data.get_guild_submission_channel(guild_id)
+            submission_message: nextcord.Message = (
+                await self.bot.get_guild(guild_id)
+                .get_channel(submission_channel_id)
+                .fetch_message(message_id)
+            )
+
+            # need check if correct user and correct channel
+            if message.channel.id == submission_channel_id:
+                state = submission_objects[message.author.id]["submission_state"]
+                if state == SubmissionState.SCORE and message.content:
+
+                    # check with regex if score matches correctly
+                    is_time_record = highscores_data.get_config_time_record(
+                        submission_objects[message.author.id]["category"]
+                    )
+
+                    time_regex = re.search(
+                        "^([0-9]{1,2}:[0-9]|[0-9])?[0-9](\\.[0-9])?$", message.content
+                    )
+                    int_regex = re.search("^[0-9]+$", message.content)
+                    if time_regex is None and is_time_record:
+                        embed = submission_message.embeds[0]
+                        embed.add_field(
+                            name="Error",
+                            value="Time record must follow format MM:SS.ms, SS.ms, or SS.",
+                        )
+                    elif int_regex is None and not is_time_record:
+                        embed = submission_message.embeds[0]
+                        embed.add_field(name="Error", value="Number record must only be number.")
+                    else:
+                        score = message.content
+                        if is_time_record:
+                            # standardize time score format.
+                            if re.search("^[1-9]?[0-9]:[0-9]{2}(\\.[0-9])?$", score):
+                                # score is already fine.
+                                pass
+                            elif re.search("^[0-9]{2}(\\.[0-9])?$", score):
+                                # need to add leading colon and 0
+                                score = "0:" + score
+                            elif re.search("^[0-9](\\.[0-9])?$", score):
+                                # need to add 0 in seconds and leading colon and 0
+                                score = "0:0" + score
+                            elif re.search("^[0]?[0-9]:[0-9]{2}(\\.[0-9])?$", score):
+                                # if there is a minute 10ths place 0, remove
+                                score = score.lstrip("0")
+                        submission_objects[message.author.id]["score"] = score
+                        embed = get_submission_embed(message.author.id)
+
+                    await submission_message.edit(
+                        embed=embed,
+                    )
+                elif state == SubmissionState.PROOF and len(message.attachments) > 0:
+                    await submission_message.edit(
+                        files=[await attch.to_file() for attch in message.attachments],
+                    )
+                elif state == SubmissionState.NAME and message.content:
+                    submission_objects[message.author.id]["username"] = message.content[
+                        : highscores_data.get_guild_username_length(guild_id)
+                    ]
+                    embed = get_submission_embed(message.author.id)
+                    await submission_message.edit(
+                        embed=embed,
+                    )
+
+                await message.delete()
+
+
+# This function will be called when this extension is loaded.
+# It is necessary to add these functions to the bot.
+def setup(bot: commands.Bot):
+    """Adds function to bot"""
+    bot.add_cog(SubmissionListener(bot))

cogs/post_highscores/__init__.py

@@ -3,9 +3,10 @@ Bot command to post the highscores
 """
 
 from nextcord.ext import commands
-from highscores import highscores_config  # pylint: disable=import-error
+import nextcord
+
+from cogs.submission.submission_views import SubmissionCreateButton  # pylint: disable=import-error
 from highscores import highscores_data  # pylint: disable=import-error
-from utilities.data_storage import save_highscores_data  # pylint: disable=import-error
 from utilities.utils import send_highscore_message  # pylint: disable=import-error
 
 
@@ -16,6 +17,7 @@ class PostHighscores(commands.Cog, name="Post Highscores"):
         self.bot = bot
 
     @commands.command(name="post-scores")
+    @commands.has_permissions(administrator=True)
     async def post_highscores(self, ctx: commands.Context):
         """
         A command which posts the highscore in the designated channel.
@@ -25,22 +27,21 @@ class PostHighscores(commands.Cog, name="Post Highscores"):
         ?post-scores
         ```
         """
-        highscore_channel_id = highscores_data["highscore_channel_id"]
+        highscore_channel_id = highscores_data.get_guild_highscores_channel(ctx.guild.id)
         print(f"Printing out highscores information in channel {highscore_channel_id}")
-        channel = self.bot.get_channel(highscore_channel_id)
+        channel = ctx.guild.get_channel(highscore_channel_id)
 
-        error_response = 'Registered Highscores channel does not exist or was never registered. \
+        error_response = "Registered Highscores channel does not exist or was never registered. "
-                Register with "?register" command.'
+        error_response += 'Register with "?register" command.'
         assert channel is not None, await ctx.send(error_response)
 
-        for boss in highscores_config["bosses"]:
+        for table in highscores_data.get_table_names(ctx.guild.id):
-            await send_highscore_message(channel, boss["boss"])
+            message: nextcord.Message = await send_highscore_message(channel, table, ctx.guild.id)
-
+            await message.edit(view=SubmissionCreateButton(self.bot))
-        save_highscores_data(highscores_data)
 
 
 # This function will be called when this extension is loaded.
 # It is necessary to add these functions to the bot.
 def setup(bot: commands.Bot):
-    """Adds functon to bot"""
+    """Adds function to bot"""
     bot.add_cog(PostHighscores(bot))

cogs/register/__init__.py

@@ -0,0 +1,64 @@
+"""
+Bot command for registering various channels to the bot.
+"""
+
+from nextcord import Embed
+from nextcord.ext import commands
+
+from highscores import highscores_data  # pylint: disable=import-error
+
+
+class RegisterVerificationChannel(commands.Cog, name="Register"):
+    """Bot command for registering various channels to the bot."""
+
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.command(name="register")
+    @commands.has_permissions(administrator=True)
+    async def register_highscores(self, ctx: commands.Context, registration_type: str):
+        """A command which registers current channel as for various uses.
+        Usage:
+        ```
+        ?register verify (Use in channel you want to verify submissions in.)
+        ?register highscore (Use in channel you want to show highscore messages in.)
+        ?register submission (Use in channel you want submission messages to be send it.)
+        ?register help (Shows help message.)
+        ```
+        """
+        # respond to the message
+        channel_id = ctx.channel.id
+
+        if registration_type == "verify":
+            await ctx.send(f"Registered <#{channel_id}> as channel to post verifications in.")
+            highscores_data.set_guild_verification_channel(ctx.guild.id, channel_id)
+        elif registration_type == "highscore":
+            await ctx.send(f"Registered <#{channel_id}> as channel to post highscores in.")
+            highscores_data.set_guild_highscore_channel(ctx.guild.id, channel_id)
+        elif registration_type == "submission":
+            await ctx.send(f"Registered <#{channel_id}> as channel to post submissions in.")
+            highscores_data.set_guild_submission_channel(ctx.guild.id, channel_id)
+        else:
+            embed = Embed(
+                title="Register command help", description="How to use the register command."
+            )
+            embed.add_field(
+                name="?register verify", value="Use in channel you want to verify submissions in."
+            )
+            embed.add_field(
+                name="?register highscore",
+                value="Use in channel you want to show highscore messages in.",
+            )
+            embed.add_field(
+                name="?register submission",
+                value="Use in channel you want submission messages to be send it.",
+            )
+            embed.add_field(name="?register help", value="Use to show this message.")
+            await ctx.reply(embed=embed)
+
+
+# This function will be called when this extension is loaded.
+# It is necessary to add these functions to the bot.
+def setup(bot: commands.Bot):
+    """Adds function to bot"""
+    bot.add_cog(RegisterVerificationChannel(bot))

cogs/register_highscore_channel/__init__.py

@@ -1,35 +0,0 @@
-"""
-Bot command to register the highscores channel
-"""
-
-from nextcord.ext import commands
-from highscores import highscores_data  # pylint: disable=import-error
-from utilities.data_storage import save_highscores_data  # pylint: disable=import-error
-
-
-class RegisterHighscoreChannel(commands.Cog, name="Register HighScore Channel"):
-    """Registers Highscore channel"""
-
-    def __init__(self, bot: commands.Bot):
-        self.bot = bot
-
-    @commands.command(name="register-highscore")
-    async def register_highscores(self, ctx: commands.Context):
-        """A command which registers current channel as channel to post highscores in.
-        Usage:
-        ```
-        ?register-highscore (in channel to post highscores in)
-        ```
-        """
-        print(f"Registering {ctx.channel.id} for highscores.")
-        # respond to the message
-        await ctx.send(f"Registered <#{ctx.channel.id}> as channel to post highscores in.")
-        highscores_data["highscore_channel_id"] = ctx.channel.id
-        save_highscores_data(highscores_data)
-
-
-# This function will be called when this extension is loaded.
-# It is necessary to add these functions to the bot.
-def setup(bot: commands.Bot):
-    """Adds functon to bot"""
-    bot.add_cog(RegisterHighscoreChannel(bot))

cogs/register_verification_channel/__init__.py

@@ -1,35 +0,0 @@
-"""
-Bot command to register the verification channel
-"""
-
-from nextcord.ext import commands
-from highscores import highscores_data  # pylint: disable=import-error
-from utilities.data_storage import save_highscores_data  # pylint: disable=import-error
-
-
-class RegisterVerificationChannel(commands.Cog, name="Register Verify Channel"):
-    """Registers Verification channel"""
-
-    def __init__(self, bot: commands.Bot):
-        self.bot = bot
-
-    @commands.command(name="register-verify")
-    async def register_highscores(self, ctx: commands.Context):
-        """A command which registers current channel as channel to post verifications in.
-        Usage:
-        ```
-        ?register-verify (in channel to post highscores in)
-        ```
-        """
-        print(f"Registering {ctx.channel.id} for verification.")
-        # respond to the message
-        await ctx.send(f"Registered <#{ctx.channel.id}> as channel to post verifications in.")
-        highscores_data["verification_channel_id"] = ctx.channel.id
-        save_highscores_data(highscores_data)
-
-
-# This function will be called when this extension is loaded.
-# It is necessary to add these functions to the bot.
-def setup(bot: commands.Bot):
-    """Adds functon to bot"""
-    bot.add_cog(RegisterVerificationChannel(bot))

cogs/score/__init__.py

@@ -3,8 +3,8 @@ Bot command to submit a score
 """
 
 from nextcord.ext import commands
+
 from highscores import highscores_data  # pylint: disable=import-error
-from utilities.utils import submit_score  # pylint: disable=import-error
 from .verification_view import VerificationView
 
 
@@ -26,13 +26,15 @@ class Score(commands.Cog, name="Score"):
         Usage:
         ```
         ?score "Boss Name" "Category" "score"
+        This command still works if you prefer to use it over the ui.
         ```
         """
-        verification_channel_id = highscores_data["verification_channel_id"]
+        guild_data = highscores_data[str(ctx.guild.id)]
-        channel = self.bot.get_channel(verification_channel_id)
+        verification_channel_id = guild_data["verification_channel_id"]
+        channel = ctx.guild.get_channel(verification_channel_id)
 
-        error_response = "Registered Verification channel does not exist or was never registered. \
+        error_response = "Registered Verification channel does not exist or was never registered."
-                Contact server admins."
+        error_response += "Contact server admins."
         assert channel is not None, await ctx.send(error_response)
 
         verification_string = f"{ctx.author.display_name}:{boss_name}:{category}:{score}"
@@ -47,5 +49,5 @@ class Score(commands.Cog, name="Score"):
 # This function will be called when this extension is loaded.
 # It is necessary to add these functions to the bot.
 def setup(bot: commands.Bot):
-    """Adds functon to bot"""
+    """Adds function to bot"""
     bot.add_cog(Score(bot))

cogs/score/verification_view.py

@@ -10,7 +10,9 @@ class VerificationView(nextcord.ui.View):
     def __init__(self):
         super().__init__(timeout=None)
 
-    @nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green, custom_id="approve")
+    @nextcord.ui.button(
+        label="Approve", style=nextcord.ButtonStyle.green, custom_id="approve-score-command"
+    )
     async def approve_button(
         self, button: nextcord.ui.Button, interaction: nextcord.Interaction
     ):  # pylint: disable=unused-argument
@@ -28,7 +30,9 @@ class VerificationView(nextcord.ui.View):
             files=[await attch.to_file() for attch in interaction.message.attachments],
         )
 
-    @nextcord.ui.button(label="Deny", style=nextcord.ButtonStyle.red, custom_id="deny")
+    @nextcord.ui.button(
+        label="Deny", style=nextcord.ButtonStyle.red, custom_id="deny-score-command"
+    )
     async def deny_button(
         self, button: nextcord.ui.Button, interaction: nextcord.Interaction
     ):  # pylint: disable=unused-argument

cogs/submission/__init__.py

@@ -0,0 +1,28 @@
+"""
+Cog for creating submission process.
+"""
+
+from nextcord.ext import commands
+
+from .submission_views import SubmissionCreateButton
+from .verification_view import VerificationView
+
+
+class SubmissionCog(commands.Cog, name="Submission Cog"):
+    """Constructs submission method."""
+
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        """Called when cog is loaded"""
+        self.bot.add_view(SubmissionCreateButton(self.bot))
+        self.bot.add_view(VerificationView())
+
+
+# This function will be called when this extension is loaded.
+# It is necessary to add these functions to the bot.
+def setup(bot: commands.Bot):
+    """Adds function to bot"""
+    bot.add_cog(SubmissionCog(bot))

cogs/submission/submission_views.py

@@ -0,0 +1,267 @@
+"""Views used for submission process."""
+
+from typing import Optional
+from enum import Enum
+
+import nextcord
+from nextcord import Embed
+from nextcord.ext import commands
+
+from highscores import highscores_data  # pylint: disable=import-error
+from highscores import highscores_message_map  # pylint: disable=import-error
+from highscores import submission_objects  # pylint: disable=import-error
+from .verification_view import VerificationView
+
+
+class SubmissionState(Enum):
+    """Enum for which state a submission is in"""
+
+    CATEGORY = 1
+    SCORE = 2
+    PROOF = 3
+    NAME = 4
+    SUBMIT = 5
+    VERIFY = 6
+
+
+def get_submission_embed(userid: int) -> nextcord.Embed:
+    """Creates an embed based off of the submission state and fields filled out."""
+    usersubmission: dict = submission_objects[userid]
+    state: SubmissionState = usersubmission["submission_state"]
+
+    if state is SubmissionState.CATEGORY:
+        description = "Step 1: Choose your category!"
+    elif state is SubmissionState.SCORE:
+        description = "Step 2: Input your score!"
+    elif state is SubmissionState.PROOF:
+        description = "Step 3: Submit your proof!"
+    elif state is SubmissionState.NAME:
+        description = "Step 4 (Optional): Change name on submission! (proceed to next if skipping)"
+    elif state is SubmissionState.SUBMIT:
+        description = "Step 5: Submit if everything looks correct!"
+    elif state is SubmissionState.VERIFY:
+        description = "Review fields and accept."
+
+    embed = Embed(title="Highscores Submission", description=description)
+    embed.add_field(name="User Name", value=usersubmission["username"], inline=False)
+    embed.add_field(name="Boss", value=usersubmission["boss_name"], inline=False)
+    if usersubmission["category"]:
+        embed.add_field(name="Category", value=usersubmission["category"], inline=False)
+    if usersubmission["score"]:
+        embed.add_field(name="Score", value=usersubmission["score"], inline=False)
+    return embed
+
+
+def category_select_options(guild_id: int, boss_name: str) -> "list[nextcord.SelectOption]":
+    """Returns list of categories for a given boss."""
+    options: "list[nextcord.SelectOption]" = []
+    category_list = highscores_data.get_table_categories(guild_id, boss_name)
+    for category in category_list:
+        options.append(nextcord.SelectOption(label=category))
+
+    return options
+
+
+############ Items used in submission process ############
+
+
+class SubmissionDropdown(nextcord.ui.Select):
+    """Defines dropdown menu for submission"""
+
+    def __init__(
+        self,
+        bot: commands.Bot,
+        options: "list[nextcord.SelectOption]",
+    ):
+        super().__init__(
+            placeholder="Choose submission category.", min_values=1, max_values=1, options=options
+        )
+        self._bot = bot
+
+    async def callback(self, interaction: nextcord.Interaction):
+        submission_objects[interaction.user.id]["category"] = self.values[0]
+        embed = get_submission_embed(interaction.user.id)
+        await interaction.message.edit(
+            embed=embed,
+        )
+
+
+class BackButton(nextcord.ui.Button):
+    """Defines view for back button."""
+
+    def __init__(self, bot: commands.Bot):
+        super().__init__(label="Back", style=nextcord.ButtonStyle.primary, custom_id="back")
+        self._bot = bot
+
+    async def callback(self, interaction: nextcord.Interaction):
+        state: SubmissionState = submission_objects[interaction.user.id]["submission_state"]
+        state = SubmissionState(state.value - 1)
+        submission_objects[interaction.user.id]["submission_state"] = state
+        embed = get_submission_embed(interaction.user.id)
+        await interaction.edit(embed=embed, view=SubmissionView(self._bot, interaction.user.id))
+
+
+class CancelButton(nextcord.ui.Button):
+    """Deletes message to cancel interaction.."""
+
+    def __init__(self):
+        super().__init__(label="Cancel", style=nextcord.ButtonStyle.red, custom_id="cancel")
+
+    async def callback(self, interaction: nextcord.Interaction):
+        submission_objects.pop(interaction.user.id)
+        await interaction.message.delete()
+
+
+class NextButton(nextcord.ui.Button):
+    """Defines view for next button."""
+
+    def __init__(self, bot: commands.Bot):
+        super().__init__(label="Next", style=nextcord.ButtonStyle.primary, custom_id="next")
+        self._bot = bot
+
+    async def callback(self, interaction: nextcord.Interaction):
+        # check if fields have been filled out for each state
+        state: SubmissionState = submission_objects[interaction.user.id]["submission_state"]
+        if (
+            state == SubmissionState.CATEGORY
+            and not submission_objects[interaction.user.id]["category"]
+        ):
+            await interaction.send("Please choose a category.", ephemeral=True)
+        elif (
+            state == SubmissionState.SCORE and not submission_objects[interaction.user.id]["score"]
+        ):
+            await interaction.send("Please send a score.", ephemeral=True)
+        elif state == SubmissionState.PROOF and not len(interaction.message.attachments) > 0:
+            await interaction.send("Please attach picture for proof.", ephemeral=True)
+        else:
+            state = SubmissionState(state.value + 1)
+            submission_objects[interaction.user.id]["submission_state"] = state
+            embed = get_submission_embed(interaction.user.id)
+            await interaction.edit(embed=embed, view=SubmissionView(self._bot, interaction.user.id))
+
+
+class SubmitButton(nextcord.ui.Button):
+    """Defines button to submit a user's score."""
+
+    def __init__(self, bot: commands.Bot):
+        super().__init__(label="Submit", style=nextcord.ButtonStyle.green, custom_id="submit")
+        self._bot = bot
+
+    async def callback(self, interaction: nextcord.Interaction):
+        verification_channel_id = highscores_data.get_guild_verification_channel(
+            interaction.guild_id
+        )
+        channel = interaction.guild.get_channel(verification_channel_id)
+
+        error_response = "Registered Verification channel does not exist or was never registered. \
+                Contact server admins."
+        assert channel is not None, await channel.send(error_response)
+
+        submission_objects[interaction.user.id]["submission_state"] = SubmissionState.VERIFY
+
+        embed = get_submission_embed(interaction.user.id)
+
+        await channel.send(
+            files=[await attch.to_file() for attch in interaction.message.attachments],
+            view=VerificationView(),
+            embed=embed,
+            content=f"Submission from {interaction.user.display_name}",
+        )
+        await interaction.message.edit(content=f"<@{interaction.user.id}> Submitted!", view=None)
+        submission_objects.pop(interaction.user.id)
+
+
+############ Submission Views ############
+
+
+class SubmissionCreateButton(nextcord.ui.View):
+    """Defines view for score submission button."""
+
+    def __init__(self, bot: commands.Bot):
+        super().__init__(timeout=None)
+        self._bot = bot
+
+    @nextcord.ui.button(
+        label="Submit", style=nextcord.ButtonStyle.primary, custom_id="submitcreate"
+    )
+    async def submitcreate_button(
+        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
+    ):  # pylint: disable=unused-argument
+        """Button for score submission."""
+        # Don't allow a user to start a new submission if one already exists
+        if interaction.user.id in submission_objects:
+            await interaction.send("Please finish in progress submission first.", ephemeral=True)
+            return
+
+        boss_name = highscores_message_map[interaction.guild.id][interaction.message.id]
+        channel = interaction.guild.get_channel(
+            highscores_data.get_guild_submission_channel(interaction.guild_id)
+        )
+
+        # a user should only have 1 submission active at once.
+        # submitting with dummy message_id until message created
+        # split username on pipe.
+        submission_objects[interaction.user.id] = {
+            "message_id": 0,
+            "guild_id": interaction.guild_id,
+            "submission_state": SubmissionState.CATEGORY,
+            "boss_name": boss_name,
+            "score": "",
+            "category": "",
+            "username": interaction.user.display_name.split("|")[0][
+                : highscores_data.get_guild_username_length(interaction.guild_id)
+            ],
+        }
+
+        embed = get_submission_embed(interaction.user.id)
+
+        submission_message = await channel.send(
+            f"<@{interaction.user.id}>",
+            view=SubmissionView(
+                self._bot,
+                interaction.user.id,
+            ),
+            embed=embed,
+        )
+
+        # update the message_id once its created
+        submission_objects[interaction.user.id]["message_id"] = submission_message.id
+
+
+class SubmissionView(nextcord.ui.View):
+    """Defines view submitting. Adjusts to all states."""
+
+    def __init__(
+        self,
+        bot: commands.Bot,
+        submission_user: int,
+        *,
+        timeout: Optional[float] = 180,
+    ):
+        super().__init__(timeout=timeout)
+        self._submission_user = submission_user
+        self._bot = bot
+        self._state = submission_objects[self._submission_user]["submission_state"]
+        self._boss_name = submission_objects[self._submission_user]["boss_name"]
+        self._guild_id = submission_objects[self._submission_user]["guild_id"]
+
+        # add items depending on given state
+        if self._state is SubmissionState.CATEGORY:
+            self.add_item(
+                SubmissionDropdown(bot, category_select_options(self._guild_id, self._boss_name))
+            )
+            self.add_item(CancelButton())
+            self.add_item(NextButton(self._bot))
+        elif (
+            self._state is SubmissionState.SCORE
+            or self._state is SubmissionState.PROOF
+            or self._state is SubmissionState.NAME
+        ):
+            self.add_item(BackButton(self._bot))
+            self.add_item(NextButton(self._bot))
+        elif self._state is SubmissionState.SUBMIT:
+            self.add_item(BackButton(self._bot))
+            self.add_item(SubmitButton(self._bot))
+
+    async def interaction_check(self, interaction: nextcord.Interaction) -> bool:
+        return self._submission_user == interaction.user.id

cogs/submission/verification_view.py

@@ -0,0 +1,46 @@
+"""View for verification buttons"""
+
+import nextcord
+from utilities.utils import submit_score  # pylint: disable=import-error
+
+
+class VerificationView(nextcord.ui.View):
+    """Defines views for verifying score submissions"""
+
+    def __init__(self):
+        super().__init__(timeout=None)
+
+    @nextcord.ui.button(
+        label="Deny", style=nextcord.ButtonStyle.red, custom_id="deny-button-submission"
+    )
+    async def deny_button(
+        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
+    ):  # pylint: disable=unused-argument
+        """Button for denying score submission."""
+        await interaction.message.delete()
+
+    @nextcord.ui.button(
+        label="Approve", style=nextcord.ButtonStyle.green, custom_id="approve-button-submission"
+    )
+    async def approve_button(
+        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
+    ):  # pylint: disable=unused-argument
+        """Button for approving score submission."""
+        content = interaction.message.embeds[0].to_dict()
+
+        for field in content["fields"]:
+            if field["name"] == "Boss":
+                boss_name = field["value"]
+            elif field["name"] == "Category":
+                category = field["value"]
+            elif field["name"] == "Score":
+                score = field["value"]
+            elif field["name"] == "User Name":
+                user = field["value"]
+
+        try:
+            await submit_score(interaction, user, boss_name, category, score)
+            await interaction.message.edit(f"Approved by <@{interaction.user.id}>.", view=None)
+        except UnboundLocalError:
+            await interaction.send("Instruct user to submit with all fields.")
+            await interaction.message.edit(view=None)

example_config/runescape_bosses.json

@@ -0,0 +1,335 @@
+{
+    "tables": {
+        "The Ambassador": [
+            "Kill Count",
+            "Kill Time",
+            "Group Kill Count",
+            "Group Kill Time",
+            "Spooned Log"
+        ],
+        "Araxxi": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Arch-Glacor": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Enrage",
+            "Spooned Log"
+        ],
+        "Astellarn": [
+            "Kill Count",
+            "Kill Time",
+            "Group Kill Count",
+            "Group Kill Time",
+            "Spooned Log"
+        ],
+        "The Barrows Brothers": [
+            "Kill Count",
+            "Spooned Log"
+        ],
+        "The Barrows: Rise of the Six": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Beastmaster Durzag": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Black Stone Dragon": [
+            "Kill Count",
+            "Kill Time",
+            "Group Kill Count",
+            "Group Kill Time",
+            "Spooned Log"
+        ],
+        "Chaos Elemental": [
+            "Kill Count",
+            "Spooned Log"
+        ],
+        "Commander Zilyana": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "Corporeal Beast": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Crassian Leviathan": [
+            "Kill Count",
+            "Kill Time",
+            "Group Kill Count",
+            "Group Kill Time",
+            "Spooned Log"
+        ],
+        "Croesus": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Dagannoth Kings": [
+            "Kill Count",
+            "Spooned Log"
+        ],
+        "General Graardor": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "Giant Mole": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "Gregorovic": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "Har-Aken": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Helwyr": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "Kalphite King": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Kalphite Queen": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Kerapac": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "King Black Dragon": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Kree'arra": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "K'ril Tsutsaroth": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "Legiones": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "The Magister": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Masuta the Ascended": [
+            "Kill Count",
+            "Kill Time",
+            "Group Kill Count",
+            "Group Kill Time",
+            "Spooned Log"
+        ],
+        "Nex": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Nex - Angel of Death": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Queen Black Dragon": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Raksha": [
+            "Solo Kill Count",
+            "Solo Kill Time",
+            "Duo Kill Count",
+            "Duo Kill Time",
+            "Spooned Log"
+        ],
+        "Rex Matriarchs": [
+            "Kill Count",
+            "Spooned Log"
+        ],
+        "The Sanctum Guardian": [
+            "Kill Count",
+            "Kill Time",
+            "Group Kill Count",
+            "Group Kill Time",
+            "Spooned Log"
+        ],
+        "Seiryu the Azure Serpent": [
+            "Kill Count",
+            "Kill Time",
+            "Group Kill Count",
+            "Group Kill Time",
+            "Spooned Log"
+        ],
+        "Solak": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Taraket the Necromancer": [
+            "Solo Kill Count",
+            "Solo Kill Time",
+            "Group Kill Count",
+            "Group Kill Time",
+            "Spooned Log"
+        ],
+        "Telos": [
+            "Kill Count",
+            "Kill Time",
+            "Enrage",
+            "Spooned Log"
+        ],
+        "The Twin Furies": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "TzKal-Zuk": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "TzTok-Jad": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Verak Lith": [
+            "Solo Kill Count",
+            "Solo Kill Time",
+            "Group Kill Count",
+            "Group Kill Time",
+            "Spooned Log"
+        ],
+        "Vindicta & Gorvek": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "Vorago": [
+            "Kill Count",
+            "Kill Time",
+            "Hardmode Kill Count",
+            "Hardmode Kill Time",
+            "Spooned Log"
+        ],
+        "Yakamaru": [
+            "Kill Count",
+            "Kill Time",
+            "Spooned Log"
+        ],
+        "Zamorak, Lord of Chaos (solo)": [
+            "Kill Count",
+            "Kill Time",
+            "Enrage",
+            "Spooned Log"
+        ],
+        "Zamorak, Lord of Chaos (group)": [
+            "Kill Count",
+            "Kill Time",
+            "Enrage"
+        ]
+    },
+    "categories": {
+        "Duo Kill Count": {
+            "ascending": false,
+            "is_time_record": false
+        },
+        "Duo Kill Time": {
+            "ascending": true,
+            "is_time_record": true
+        },
+        "Enrage": {
+            "ascending": false,
+            "is_time_record": false
+        },
+        "Group Kill Count": {
+            "ascending": false,
+            "is_time_record": false
+        },
+        "Group Kill Time": {
+            "ascending": true,
+            "is_time_record": true
+        },
+        "Hardmode Kill Count": {
+            "ascending": false,
+            "is_time_record": false
+        },
+        "Hardmode Kill Time": {
+            "ascending": true,
+            "is_time_record": true
+        },
+        "Kill Count": {
+            "ascending": false,
+            "is_time_record": false
+        },
+        "Kill Time": {
+            "ascending": true,
+            "is_time_record": true
+        },
+        "Solo Kill Count": {
+            "ascending": false,
+            "is_time_record": false
+        },
+        "Solo Kill Time": {
+            "ascending": true,
+            "is_time_record": true
+        },
+        "Spooned Log": {
+            "ascending": true,
+            "is_time_record": false
+        }
+    },
+    "highscore_size": 3
+}

highscores.py

@@ -9,8 +9,7 @@ import nextcord
 from nextcord.ext import commands
 
 import config
-from utilities.data_storage import open_highscores_config
+from utilities.highscores_data import HighscoresData
-from utilities.data_storage import open_highscores_data
 
 logger = logging.getLogger("nextcord")
 logger.setLevel(logging.DEBUG)
@@ -19,8 +18,16 @@ handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(me
 logger.addHandler(handler)
 
 
-highscores_config = open_highscores_config()
+highscores_data: HighscoresData = HighscoresData()
-highscores_data = open_highscores_data()
+highscores_message_map = {}
+
+for guild in highscores_data.get_guilds():
+    highscores_message_map[guild] = {}
+    for table in highscores_data.get_table_names(guild):
+        message_id = highscores_data.get_table_message_id(guild, table)
+        highscores_message_map[guild][message_id] = table
+
+submission_objects: dict = {}
 
 
 def main():
@@ -30,7 +37,7 @@ def main():
     intents = nextcord.Intents.default()
 
     # Required in order to read messages (eg. prefix commands)
-    intents.message_content = True
+    intents.message_content = True  # pylint: disable=assigning-non-slot
 
     # To enable the guilds priveleged intent:
     # intents.guilds = True

highscores_config.json

@@ -1,202 +0,0 @@
-{
-    "bosses": [
-        {
-            "boss": "The Ambassador",
-            "hardmode": true
-        },
-        {
-            "boss": "Araxxi",
-            "hardmode": false
-        },
-        {
-            "boss": "Arch-Glacor",
-            "hardmode": true
-        },
-        {
-            "boss": "Astellarn",
-            "hardmode": true
-        },
-        {
-            "boss": "The Barrows Brothers",
-            "hardmode": false
-        },
-        {
-            "boss": "The Barrows: Rise of the Six",
-            "hardmode": false
-        },
-        {
-            "boss": "Beastmaster Durzag",
-            "hardmode": false
-        },
-        {
-            "boss": "Black Stone Dragon",
-            "hardmode": true
-        },
-        {
-            "boss": "Chaos Elemental",
-            "hardmode": false
-        },
-        {
-            "boss": "Commander Zilyana",
-            "hardmode": true
-        },
-        {
-            "boss": "Corporeal Beast",
-            "hardmode": false
-        },
-        {
-            "boss": "Crassian Leviathan",
-            "hardmode": true
-        },
-        {
-            "boss": "Croesus",
-            "hardmode": false
-        },
-        {
-            "boss": "Dagannoth Kings",
-            "hardmode": false
-        },
-        {
-            "boss": "General Graardor",
-            "hardmode": true
-        },
-        {
-            "boss": "Giant Mole",
-            "hardmode": true
-        },
-        {
-            "boss": "Gregorovic",
-            "hardmode": true
-        },
-        {
-            "boss": "Har-Aken",
-            "hardmode": false
-        },
-        {
-            "boss": "Helwyr",
-            "hardmode": true
-        },
-        {
-            "boss": "Kalphite King",
-            "hardmode": false
-        },
-        {
-            "boss": "Kalphite Queen",
-            "hardmode": false
-        },
-        {
-            "boss": "Kerapac",
-            "hardmode": true
-        },
-        {
-            "boss": "King Black Dragon",
-            "hardmode": false
-        },
-        {
-            "boss": "Kree'arra",
-            "hardmode": true
-        },
-        {
-            "boss": "K'ril Tsutsaroth",
-            "hardmode": true
-        },
-        {
-            "boss": "Legiones",
-            "hardmode": false
-        },
-        {
-            "boss": "The Magister",
-            "hardmode": false
-        },
-        {
-            "boss": "Masuta the Ascended",
-            "hardmode": true
-        },
-        {
-            "boss": "Nex",
-            "hardmode": false
-        },
-        {
-            "boss": "Nex - Angel of Death",
-            "hardmode": false
-        },
-        {
-            "boss": "Queen Black Dragon",
-            "hardmode": false
-        },
-        {
-            "boss": "Raksha",
-            "hardmode": true
-        },
-        {
-            "boss": "Rex Matriarchs",
-            "hardmode": false
-        },
-        {
-            "boss": "The Sanctum Guardian",
-            "hardmode": true
-        },
-        {
-            "boss": "Seiryu the Azure Serpent",
-            "hardmode": true
-        },
-        {
-            "boss": "Solak",
-            "hardmode": false
-        },
-        {
-            "boss": "Taraket the Necromancer",
-            "hardmode": true
-        },
-        {
-            "boss": "Telos",
-            "hardmode": false
-        },
-        {
-            "boss": "The Twin Furies",
-            "hardmode": true
-        },
-        {
-            "boss": "TzKal-Zuk",
-            "hardmode": true
-        },
-        {
-            "boss": "TzTok-Jad",
-            "hardmode": false
-        },
-        {
-            "boss": "Verak Lith",
-            "hardmode": true
-        },
-        {
-            "boss": "Vindicta & Gorvek",
-            "hardmode": true
-        },
-        {
-            "boss": "Vorago",
-            "hardmode": true
-        },
-        {
-            "boss": "Yakamaru",
-            "hardmode": false
-        }
-    ],
-    "categories": {
-        "Kill Count": {
-            "hardmode": true,
-            "ascending": false,
-            "is_time_record": false
-        },
-        "Kill Time": {
-            "hardmode": true,
-            "ascending": true,
-            "is_time_record": true
-        },
-        "Spooned Log": {
-            "hardmode": false,
-            "ascending": true,
-            "is_time_record": false
-        }
-    },
-    "highscore_size": 3
-}

utilities/data_storage.py

@@ -1,51 +0,0 @@
-"""Functions for retreiving and storing highscores data and configurations."""
-
-import os
-import json
-
-HIGHSCORES_CONFIG_FILE = "highscores_config.json"
-HIGHSCORES_DATA_FILE = "highscores_data.json"
-
-
-def open_highscores_config():
-    """
-    Opens the highscores config file and returns.
-    @return: dict of highscores config.
-    """
-    # Load bot config
-    with open(HIGHSCORES_CONFIG_FILE, encoding="utf-8", mode="r") as file:
-        return json.load(file)
-
-
-def open_highscores_data():
-    """
-    Opens a highscores_data.json file if one exists, otherwise creates a skeleton of the data.
-    @return: dict of highscores data.
-    """
-    if os.path.exists(HIGHSCORES_DATA_FILE):
-        with open(HIGHSCORES_DATA_FILE, encoding="utf-8", mode="r") as file:
-            data = json.load(file)
-    else:
-        # create the json object
-        data = {"highscore_channel_id": -1, "verification_channel_id": -1}
-        config = open_highscores_config()
-        for boss in config["bosses"]:
-            data[boss["boss"]] = {"message_id": 0}
-            boss_categories = {}
-            for key, value in config["categories"].items():
-                rank_list = []
-                boss_categories[key] = rank_list
-                if boss["hardmode"] and value["hardmode"]:
-                    rank_list = []
-                    boss_categories["Hardmode " + key] = rank_list
-            data[boss["boss"]]["categories"] = boss_categories
-    return data
-
-
-def save_highscores_data(data):
-    """
-    Saves the highscores data dict into a json file.
-    @param data: dict of highscores data.
-    """
-    with open(HIGHSCORES_DATA_FILE, encoding="utf-8", mode="w") as file:
-        file.write(json.dumps(data, indent=4))

utilities/highscores_data.py

@@ -0,0 +1,327 @@
+"""Class and functions for storing and retrieving highscores data."""
+
+import os
+import json
+
+HIGHSCORES_CONFIG_FILE = "highscores_config.json"
+HIGHSCORES_DATA_FILE = "highscores_data.json"
+
+
+class HighscoresData:
+    """Class for storing and retrieving highscores data."""
+
+    def __init__(self) -> None:
+        self._config = open_highscores_config()
+        self._data = open_highscores_data()
+
+    def add_new_server(self, guild_id: int):
+        """
+        Creates new skeleton data dict and adds to self for new guild.
+
+        @param guild_id: guild_id to add.
+        """
+        # create the dict
+        skeleton = {
+            "highscore_channel_id": -1,
+            "verification_channel_id": -1,
+            "username_length": 12,
+        }
+        config: dict = open_highscores_config()
+        skeleton["tables"] = {}
+        for boss, categories in config["tables"].items():
+            skeleton["tables"][boss] = {"message_id": 0}
+            boss_categories = {}
+            for category in categories:
+                rank_list = []
+                boss_categories[category] = rank_list
+            skeleton["tables"][boss]["categories"] = boss_categories
+
+        self._data[str(guild_id)] = skeleton
+
+    def add_score(
+        self, guild_id: int, boss_name: str, category: str, user: str, score: str
+    ) -> None:
+        """
+        Adds a new score to guilds highscore data.
+        Ensures that there is no user duplicate and then sorts the scores
+
+        @param guild_id: guild id to retrieve from.
+        @param boss_name: boss to add score to.
+        @param category: category to add score to.
+        @param user: user that submitted score.
+        @param score: score to add.
+        """
+        scores: "list[tuple]" = self._data[str(guild_id)]["tables"][boss_name]["categories"][
+            category
+        ]
+        ascending: bool = self._config["categories"][category]["ascending"]
+        time_record: bool = self._config["categories"][category]["is_time_record"]
+
+        # create score tuple for either time or int
+        # define sort index
+        if time_record:
+            if score.find(":") == -1:
+                score_seconds = float(score)
+            else:
+                minutes = score.split(":")[0]
+                seconds = score.split(":")[1]
+                score_seconds = int(minutes) * 60 + float(seconds)
+            score_tuple = (user, score, score_seconds)
+            sort_index = 2
+        else:
+            score_tuple = (user, int(score))
+            sort_index = 1
+
+        # if user is in an existing tuple, delete it.
+        users_scores: "list[tuple]" = [score_tuple]
+        for tup in scores:
+            if user == tup[0]:
+                # Add tup to users_scores, remove from scores
+                users_scores.append(tup)
+
+        # sort users_scores
+        users_scores.sort(
+            key=lambda x: x[sort_index],
+            reverse=not ascending,
+        )
+
+        for index, tup in enumerate(users_scores):
+            if index == 0:
+                # first score is the best score.
+                if tup not in scores:
+                    scores.append(tup)
+            else:
+                # discard all other scores from scores list.
+                if tup in scores:
+                    scores.remove(tup)
+
+        # sort scores.
+        scores.sort(
+            key=lambda x: x[sort_index],
+            reverse=not ascending,
+        )
+
+        self._data[str(guild_id)]["tables"][boss_name]["categories"][category] = scores
+        save_highscores_data(self._data)
+
+    def get_categories_data(self, guild_id: int, table: str) -> "list[tuple]":
+        """
+        Returns categories data in a list of tuples. Calls dict function items().
+
+        @param guild_id: guild's id to retrieve from.
+        @param table: table to get category data from
+        @returns: list of tuples containing all category and relative score data.
+        """
+        return self._data[str(guild_id)]["tables"][table]["categories"].items()
+
+    def get_config_highscore_size(self) -> int:
+        """
+        Gets the defined size of highscore for config.
+
+        @returns: int highscore size
+        """
+        return self._config["highscore_size"]
+
+    def get_config_time_record(self, category: str) -> bool:
+        """
+        Tells if the category is a time record
+
+        @param category: category name to retrieve from.
+        @returns: bool indicating time record or not.
+        """
+        return self._config["categories"][category]["is_time_record"]
+
+    def get_guilds(self) -> "list[int]":
+        """
+        Gets a list of guilds tracked by data
+
+        @returns: list of ints representing guild ids
+        """
+        guilds: "list[int]" = []
+
+        for guild, data in self._data.items():  # pylint: disable=unused-variable
+            guilds.append(int(guild))
+
+        return guilds
+
+    def get_guild_highscores_channel(self, guild_id: int) -> int:
+        """
+        Returns the channel id to post highscore messages to.
+
+        @param guild_id: guild id to retrieve from.
+        @returns: channel id of highscores channel.
+        """
+        return self._data[str(guild_id)]["highscore_channel_id"]
+
+    def get_guild_submission_channel(self, guild_id: int) -> int:
+        """
+        Returns the channel id to post submission messages to.
+
+        @param guild_id: guild id to retrieve from.
+        @returns: channel id of submission channel.
+        """
+        return self._data[str(guild_id)]["submission_channel_id"]
+
+    def get_guild_username_length(self, guild_id: int) -> int:
+        """
+        Returns username length as set by each guild.
+
+        @param guild_id: guild id to retrieve from.
+        @returns: int of username length.
+        """
+        return self._data[str(guild_id)]["username_length"]
+
+    def get_guild_verification_channel(self, guild_id: int) -> int:
+        """
+        Returns the channel id to post verification messages to.
+
+        @param guild_id: guild id to retrieve from.
+        @returns: channel id of verification channel.
+        """
+        return self._data[str(guild_id)]["verification_channel_id"]
+
+    def get_table_categories(self, guild_id: int, table: str) -> "list[str]":
+        """
+        Returns list of categories for a guild's table
+
+        @param guild_id: guild id to retrieve from.
+        @param table: the table to retreive from.
+        @returns: string list of categories in given table.
+        """
+        categories: "list[str]" = []
+
+        for category, data in self._data[str(guild_id)][  # pylint: disable=unused-variable
+            "tables"
+        ][table]["categories"].items():
+            categories.append(category)
+
+        return categories
+
+    def get_table_message_id(self, guild_id: int, table: str) -> int:
+        """
+        Returns the message id for given guild's table.
+
+        @param guild_id: guild id to retrieve from.
+        @param table: the table to retrieve from.
+        @returns: int id of message for table's highscores.
+        """
+        return self._data[str(guild_id)]["tables"][table]["message_id"]
+
+    def get_table_names(self, guild_id) -> "list[str]":
+        """
+        Returns a list of table names.
+
+        @param guild_id: guild id to retrieve from.
+        @returns: list of table names
+        """
+        tables: "list[str]" = []
+
+        for table, data in self._data[str(guild_id)][  # pylint: disable=unused-variable
+            "tables"
+        ].items():
+            tables.append(table)
+
+        return tables
+
+    def remove_guild(self, guild_id: int, guild_name: str) -> None:
+        """
+        Removes a guild's data from object. Saves backup.
+
+        @param guild_id: guild id to remove.
+        @param guild_name: name of guild for backup.
+        """
+        old_data = self._data.pop(str(guild_id))
+        save_highscores_data(self._data)
+
+        if not os.path.exists("deleted_backups"):
+            os.mkdir("deleted_backups")
+
+        with open(f"deleted_backups/{guild_name}_backup.json", encoding="utf-8", mode="w") as file:
+            file.write(json.dumps(old_data, indent=4))
+
+    def reset_guild_data(self, guild_id: int) -> None:
+        """
+        Resets highscore data for a guild. Should only be used for development really...
+
+        @param guild_id: guild id to reset data for
+        """
+        guild_data: dict = self._data[str(guild_id)]
+
+        for boss, boss_data in guild_data["tables"].items():
+            for category, category_data in boss_data["categories"].items():
+                category_data = []
+                boss_data["categories"][category] = category_data
+            guild_data["tables"][boss] = boss_data
+        self._data[str(guild_id)] = guild_data
+        save_highscores_data(self._data)
+
+    def set_guild_highscore_channel(self, guild_id: int, channel_id: int) -> None:
+        """
+        Sets the guild's highscores channel.
+
+        @param guild_id: guild id to set to.
+        @param channel_id: channel id to set.
+        """
+        self._data[str(guild_id)]["highscore_channel_id"] = channel_id
+
+    def set_guild_submission_channel(self, guild_id: int, channel_id: int) -> None:
+        """
+        Sets the guild's submission channel.
+
+        @param guild_id: guild id to set to.
+        @param channel_id: channel id to set.
+        """
+        self._data[str(guild_id)]["submission_channel_id"] = channel_id
+
+    def set_guild_verification_channel(self, guild_id: int, channel_id: int) -> None:
+        """
+        Sets the guild's verification channel.
+
+        @param guild_id: guild id to set to.
+        @param channel_id: channel id to set.
+        """
+        self._data[str(guild_id)]["verification_channel_id"] = channel_id
+
+    def set_table_message_id(self, guild_id: int, table: str, message_id: int) -> None:
+        """
+        Sets the message id for given guild's table.
+        Saves highscores data.
+
+        @param guild_id: guild id to set to.
+        @param table: the table to set to.
+        @param message_id: message id to set.
+        """
+        self._data[str(guild_id)]["tables"][table]["message_id"] = message_id
+        save_highscores_data(self._data)
+
+
+def open_highscores_config():
+    """
+    Opens the highscores config file and returns.
+    @return: dict of highscores config.
+    """
+    # Load bot config
+    with open(HIGHSCORES_CONFIG_FILE, encoding="utf-8", mode="r") as file:
+        return json.load(file)
+
+
+def open_highscores_data():
+    """
+    Opens a highscores_data.json file if one exists, otherwise returns empty dict.
+    @return: dict of highscores data.
+    """
+    if os.path.exists(HIGHSCORES_DATA_FILE):
+        with open(HIGHSCORES_DATA_FILE, encoding="utf-8", mode="r") as file:
+            data = json.load(file)
+    else:
+        data = {}
+    return data
+
+
+def save_highscores_data(data: dict):
+    """
+    Saves the highscores data dict into a json file.
+    @param data: dict of highscores data.
+    """
+    with open(HIGHSCORES_DATA_FILE, encoding="utf-8", mode="w") as file:
+        file.write(json.dumps(data, indent=4))

utilities/utils.py

@@ -3,58 +3,86 @@ Contains various utlity functions for highscores bot
 """
 
 import nextcord
-from highscores import highscores_config  # pylint: disable=import-error
 from highscores import highscores_data  # pylint: disable=import-error
-from utilities.data_storage import save_highscores_data  # pylint: disable=import-error
+from highscores import highscores_message_map  # pylint: disable=import-error
 
 
-def format_highscore_message(boss_name: str):
+def format_highscore_message(boss_name: str, guild_id: int):
     """
     returns a formatted string for a boss's highscore
     @param boss: the dictionary object for the boss
+    @param guild_id: the guild id the message is for
     @return the formatted string
     """
     ret_string = f"**{boss_name}**\n```"
-    boss_data = highscores_data[boss_name]
 
     # Gather all categories and add to string
-    for key, value in boss_data["categories"].items():
+    for key, value in highscores_data.get_categories_data(guild_id, boss_name):
-        ret_string += f"{key}".ljust(30, " ")
+        ret_string += f"{key}".ljust(26, " ")
     ret_string += "\n"
 
-    highscore_size = highscores_config["highscore_size"]
+    highscore_size = highscores_data.get_config_highscore_size()
 
     # list rankings in a single line. Start with first place for each category and then continue
     for i in range(highscore_size):
-        for key, value in boss_data["categories"].items():
+        for key, value in highscores_data.get_categories_data(guild_id, boss_name):
             if len(value) > i:
-                score = value[i]
+                score_pair = value[i]
-                ret_string += f"{i+1}: {score[0]} - {score[1]}".ljust(30, " ")
+
+                # pad username to max length.
+                username: str = score_pair[0].ljust(
+                    highscores_data.get_guild_username_length(guild_id), " "
+                )
+                score: str = str(score_pair[1])
+
+                # pad score to correct length
+                # MM:SS.ms is 7 characters long
+                if highscores_data.get_config_time_record(key):
+                    # if there are single digit minutes, add a space for formatting.
+                    if score.find(":") and len(score.split(":", maxsplit=1)[0]) < 2:
+                        score = " " + score
+                else:
+                    score = score.rjust(7, " ")
+
+                ret_string += f"{i+1}: {username} - {score}".ljust(26, " ")
             else:
-                ret_string += f"{i+1}: submit your score".ljust(30, " ")
+                ret_string += f"{i+1}: submit your score".ljust(26, " ")
         ret_string += "\n"
 
     return ret_string + "```"
 
 
-async def send_highscore_message(channel, boss_name: str):
+async def send_highscore_message(
+    channel: nextcord.TextChannel, boss_name: str, guild_id: int
+) -> nextcord.Message:
     """
     Function takes care of checking if a message exists for a boss, then
     creating and sending/editing the message
     @param channel: the channel to send the message in/search for message id
     @param boss: the boss to send the message about
+    @param guild_id: the guild id to send message to
+    @return: The nextcord message
     """
-    highscore_string = format_highscore_message(boss_name)
+    highscore_string = format_highscore_message(boss_name, guild_id)
 
-    message_id = highscores_data[boss_name]["message_id"]
+    message_id = highscores_data.get_table_message_id(guild_id, boss_name)
     try:
-        message = await channel.fetch_message(message_id)
+        message: nextcord.Message = await channel.fetch_message(message_id)
         await message.edit(content=highscore_string)
     except nextcord.NotFound:
         # message doesn't exist.
-        message = await channel.send(highscore_string)
+        message: nextcord.Message = await channel.send(highscore_string)
         message_id = message.id
-        highscores_data[boss_name]["message_id"] = message_id
+        highscores_data.set_table_message_id(guild_id, boss_name, message_id)
+        # save message -> boss_name in message_map
+        # get guild id from channel
+        # channel should come from the guild that is requesting this highscores message anyways.
+        # check if guild is in message map already
+        if not channel.guild.id in highscores_message_map:
+            highscores_message_map[channel.guild.id] = {}
+        highscores_message_map[channel.guild.id][message_id] = boss_name
+
+    return message
 
 
 async def submit_score(
@@ -65,47 +93,18 @@ async def submit_score(
     @param boss: the boss to add score to
     @param category: the category to add score to
     @param user: user who submitted score
-    @param score: score (int) to add
+    @param score: score to add
     """
-    # TODO update user submission to not have dupe users
 
-    # create score tuple for either time or int
+    highscores_data.add_score(interaction.guild_id, boss_name, category, user, score)
-    # define sort index
-    if highscores_config["categories"][category]["is_time_record"]:
-        minutes = score.split(":")[0]
-        seconds = score.split(":")[1]
-        score_seconds = int(minutes) * 60 + int(seconds)
-        score_tuple = (user, score, score_seconds)
-        sort_index = 2
-
-    else:
-        score_tuple = (user, int(score))
-        sort_index = 1
-
-    scores = highscores_data[boss_name]["categories"][category]
-    scores.append(score_tuple)
-
-    # sort scores.
-    scores.sort(
-        key=lambda x: x[sort_index],
-        reverse=not highscores_config["categories"][category]["ascending"],
-    )
-
-    # enforce highscore size
-    while len(scores) > highscores_config["highscore_size"]:
-        scores.pop()
-    highscores_data[boss_name]["categories"][category] = scores
 
     # edit message
-    highscore_channel_id = highscores_data["highscore_channel_id"]
+    highscore_channel_id = highscores_data.get_guild_highscores_channel(interaction.guild_id)
     print(f"Editting message {highscore_channel_id}")
     channel = interaction.guild.get_channel(highscore_channel_id)
 
-    error_response = 'Registered Highscores channel does not exist or was never registered. \
+    error_response = "Registered Highscores channel does not exist or was never registered."
-            Register with "?register" command.'
+    error_response += 'Register with "?register" command.'
-    assert channel is not None, await interaction.send(error_response)
+    assert channel is not None, await interaction.send(error_response, ephemeral=True)
 
-    await send_highscore_message(channel, boss_name)
+    await send_highscore_message(channel, boss_name, interaction.guild_id)
-
-    # save data
-    save_highscores_data(highscores_data)