Move formatting to when score is retrieved.

cogs/message_listener/__init__.py

@@ -2,11 +2,16 @@
 Defines cog for on message listener.
 """
 
+import re
+
 from nextcord.ext import commands
 import nextcord
 
-from highscores import submission_messages  # pylint: disable=import-error
+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_config  # 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"):
@@ -16,29 +21,68 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
         self.bot = bot
 
     @commands.Cog.listener()
-    async def on_message(self, proof_message: nextcord.Message):
+    async def on_message(self, message: nextcord.Message):
         """Listener for message creation. Adds score and attachments to submission."""
-        if proof_message.author.id in submission_messages:
+        if message.author.id in submission_objects:
-            message_id = submission_messages[proof_message.author.id]
+            message_id = submission_objects[message.author.id]["message_id"]
             submission_message: nextcord.Message = await self.bot.get_channel(
                 highscores_data["submission_channel_id"]
             ).fetch_message(message_id)
 
             # need check if correct user and correct channel
-            if proof_message.channel.id == highscores_data["submission_channel_id"]:
+            if message.channel.id == highscores_data["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_config["categories"][
+                        submission_objects[message.author.id]["category"]
+                    ]["is_time_record"]
+
+                    time_regex = re.search(
+                        "([0-9]{2}:)?[0-9]{2}(\.[0-9])?",  # pylint: disable=anomalous-backslash-in-string
+                        message.content,
+                    )
+                    int_regex = re.search("[0-9]+", message.content)
+                    if time_regex is None and is_time_record:
                         embed = submission_message.embeds[0]
-                if proof_message.content:
+                        embed.add_field(
-                    embed.add_field(name="Score", value=proof_message.content, inline=False)
+                            name="Error",
+                            value="Time record must follow format MM:SS.ms or 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.
+                            # add colon if its not there
+                            if score.find(":") == -1:
+                                score = "00:" + score
+                            # add a 0 if there isn't 2 digits before a colon
+                            elif len(score.split(":", maxsplit=1)[0]) < 2:
+                                score = "0" + score
+                        submission_objects[message.author.id]["score"] = score
+                        embed = get_submission_embed(message.author.id)
+
                     await submission_message.edit(
                         embed=embed,
                     )
-                if len(proof_message.attachments) > 0:
+                elif state == SubmissionState.PROOF and len(message.attachments) > 0:
                     await submission_message.edit(
-                        files=[await attch.to_file() for attch in proof_message.attachments],
+                        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["username_length"]
+                    ]
+                    embed = get_submission_embed(message.author.id)
+                    await submission_message.edit(
+                        embed=embed,
                     )
 
-                await proof_message.delete()
+                await message.delete()
 
 
 # This function will be called when this extension is loaded.

cogs/post_highscores/__init__.py

@@ -5,7 +5,7 @@ Bot command to post the highscores
 from nextcord.ext import commands
 import nextcord
 
-from cogs.submission.submission_views import SubmissionButton  # pylint: disable=import-error
+from cogs.submission.submission_views import SubmissionCreateButton  # pylint: disable=import-error
 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
@@ -41,7 +41,7 @@ class PostHighscores(commands.Cog, name="Post Highscores"):
             "highscore_table"
         ].items():
             message: nextcord.Message = await send_highscore_message(channel, boss)
-            await message.edit(view=SubmissionButton(self.bot))
+            await message.edit(view=SubmissionCreateButton(self.bot))
 
         save_highscores_data(highscores_data)
 

cogs/submission/__init__.py

@@ -4,7 +4,7 @@ Cog for creating submission process.
 
 from nextcord.ext import commands
 
-from .submission_views import SubmissionButton
+from .submission_views import SubmissionCreateButton
 from .verification_view import VerificationView
 
 
@@ -17,7 +17,7 @@ class SubmissionCog(commands.Cog, name="Submission Cog"):
     @commands.Cog.listener()
     async def on_ready(self):
         """Called when cog is loaded"""
-        self.bot.add_view(SubmissionButton(self.bot))
+        self.bot.add_view(SubmissionCreateButton(self.bot))
         self.bot.add_view(VerificationView())
 
 

cogs/submission/submission_views.py

@@ -1,47 +1,60 @@
 """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 utilities.data_storage import open_message_map  # pylint: disable=import-error
 from highscores import highscores_data  # pylint: disable=import-error
-from highscores import submission_messages  # pylint: disable=import-error
+from highscores import submission_objects  # pylint: disable=import-error
 from .verification_view import VerificationView
 
 
-class SubmissionButton(nextcord.ui.View):
+class SubmissionState(Enum):
-    """Defines view for score submission button."""
+    """Enum for which state a submission is in"""
 
-    def __init__(self, bot: commands.Bot):
+    CATEGORY = 1
-        super().__init__(timeout=None)
+    SCORE = 2
-        self._bot = bot
+    PROOF = 3
+    NAME = 4
+    SUBMIT = 5
+    VERIFY = 6
 
-    @nextcord.ui.button(label="Submit", style=nextcord.ButtonStyle.primary, custom_id="submit")
-    async def submit_button(
-        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
-    ):  # pylint: disable=unused-argument
-        """Button for score submission."""
-        highscores_message_map = open_message_map()
-        boss_name = highscores_message_map[str(interaction.message.id)]
-        embed = nextcord.Embed(title="Highscores Submission")
-        embed.add_field(name="Boss", value=boss_name, inline=False)
-        embed.add_field(name="User", value=interaction.user.display_name, inline=False)
-        channel = self._bot.get_channel(highscores_data["submission_channel_id"])
-        submission_message = await channel.send(
-            f"<@{interaction.user.id}>",
-            view=SubmissionDropdownView(
-                self._bot, interaction, await self._category_select_options(boss_name)
-            ),
-            embed=embed,
-        )
 
-        # a user should only have 1 submission active at once.
+def get_submission_embed(userid: int) -> nextcord.Embed:
-        submission_messages[interaction.user.id] = submission_message.id
+    """Creates an embed based off of the submission state and fields filled out."""
+    usersubmission: dict = submission_objects[userid]
+    state: SubmissionState = usersubmission["submission_state"]
 
-    async def _category_select_options(self, boss_name: str) -> "list[nextcord.SelectOption]":
+    if state is SubmissionState.CATEGORY:
-        options: list[nextcord.SelectOption] = []  # pylint: disable=unsubscriptable-object
+        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(boss_name: str) -> "list[nextcord.SelectOption]":
+    """Returns list of categories for a given boss."""
+    options: "list[nextcord.SelectOption]" = []
     boss_dict = highscores_data[boss_name]
     for category in boss_dict["categories"].items():
         options.append(nextcord.SelectOption(label=category[0]))
@@ -49,6 +62,9 @@ class SubmissionButton(nextcord.ui.View):
     return options
 
 
+############ Items used in submission process ############
+
+
 class SubmissionDropdown(nextcord.ui.Select):
     """Defines dropdown menu for submission"""
 
@@ -63,60 +79,180 @@ class SubmissionDropdown(nextcord.ui.Select):
         self._bot = bot
 
     async def callback(self, interaction: nextcord.Interaction):
-        embed = interaction.message.embeds[0]
+        submission_objects[interaction.user.id]["category"] = self.values[0]
-        embed.add_field(name="Category", value=self.values[0], inline=False)
+        embed = get_submission_embed(interaction.user.id)
         await interaction.message.edit(
             embed=embed,
         )
 
 
-class SubmissionDropdownView(nextcord.ui.View):
+class BackButton(nextcord.ui.Button):
-    """Defines submission dropdown process view"""
+    """Defines view for back button."""
 
-    def __init__(
+    def __init__(self, bot: commands.Bot):
-        self,
+        super().__init__(label="Back", style=nextcord.ButtonStyle.primary, custom_id="back")
-        bot: commands.Bot,
+        self._bot = bot
-        prev_interaction: nextcord.Interaction,
+
-        options: "list[nextcord.SelectOption]",
+    async def callback(self, interaction: nextcord.Interaction):
-        *,
+        state: SubmissionState = submission_objects[interaction.user.id]["submission_state"]
-        timeout: Optional[float] = 180,
+        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"]
         ):
-        super().__init__(timeout=timeout)
+            await interaction.send("Please choose a category.", ephemeral=True)
-        self.add_item(SubmissionDropdown(bot, options))
+        elif (
-        self._prev_interaction = prev_interaction
+            state == SubmissionState.SCORE and not submission_objects[interaction.user.id]["score"]
-        self.bot = bot
+        ):
+            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))
 
-    async def interaction_check(self, interaction: nextcord.Interaction) -> bool:
-        return self._prev_interaction.user == interaction.user
 
-    @nextcord.ui.button(
+class SubmitButton(nextcord.ui.Button):
-        label="Submit Score", style=nextcord.ButtonStyle.green, custom_id="submit-score"
-    )
-    async def submit_button(
-        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
-    ):  # pylint: disable=unused-argument
     """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["verification_channel_id"]
-        channel = self.bot.get_channel(verification_channel_id)
+        channel = self._bot.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=interaction.message.embeds[0],
+            embed=embed,
+            content=f"Submission from {interaction.user.display_name}",
         )
         await interaction.message.edit(content=f"<@{interaction.user.id}> Submitted!", view=None)
-        submission_messages.pop(interaction.user.id)
+        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="Cancel", style=nextcord.ButtonStyle.red, custom_id="cancel-submission"
+        label="Submit", style=nextcord.ButtonStyle.primary, custom_id="submitcreate"
     )
-    async def cancel_button(
+    async def submitcreate_button(
         self, button: nextcord.ui.Button, interaction: nextcord.Interaction
     ):  # pylint: disable=unused-argument
-        """Deletes message to cancel interaction."""
+        """Button for score submission."""
-        submission_messages.pop(interaction.user.id)
+        highscores_message_map = open_message_map()
-        await interaction.message.delete()
+        boss_name = highscores_message_map[str(interaction.message.id)]
+        # embed = nextcord.Embed(title="Highscores Submission")
+        # embed.add_field(name="Boss", value=boss_name, inline=False)
+        # embed.add_field(name="User", value=interaction.user.display_name, inline=False)
+        channel = self._bot.get_channel(highscores_data["submission_channel_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,
+            "submission_state": SubmissionState.CATEGORY,
+            "boss_name": boss_name,
+            "score": "",
+            "category": "",
+            "username": interaction.user.display_name.split("|")[0][
+                : highscores_data["username_length"]
+            ],
+        }
+
+        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"]
+
+        # add items depending on given state
+        if self._state is SubmissionState.CATEGORY:
+            self.add_item(SubmissionDropdown(bot, category_select_options(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

@@ -10,6 +10,15 @@ class VerificationView(nextcord.ui.View):
     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"
     )
@@ -26,7 +35,7 @@ class VerificationView(nextcord.ui.View):
                 category = field["value"]
             elif field["name"] == "Score":
                 score = field["value"]
-            elif field["name"] == "User":
+            elif field["name"] == "User Name":
                 user = field["value"]
 
         try:
@@ -35,12 +44,3 @@ class VerificationView(nextcord.ui.View):
         except UnboundLocalError:
             await interaction.send("Instruct user to submit with all fields.")
             await interaction.message.edit(view=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()

example_config/runescape_bosses.json

@@ -212,8 +212,8 @@
             "Spooned Log"
         ],
         "Taraket the Necromancer": [
-            "Kill Count",
+            "Solo Kill Count",
-            "Kill Time",
+            "Solo Kill Time",
             "Group Kill Count",
             "Group Kill Time",
             "Spooned Log"
@@ -244,8 +244,8 @@
             "Spooned Log"
         ],
         "Verak Lith": [
-            "Kill Count",
+            "Solo Kill Count",
-            "Kill Time",
+            "Solo Kill Time",
             "Group Kill Count",
             "Group Kill Time",
             "Spooned Log"
@@ -318,6 +318,14 @@
             "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

highscores.py

@@ -24,7 +24,7 @@ highscores_config = open_highscores_config()
 highscores_data = open_highscores_data()
 highscores_message_map = open_message_map()
 
-submission_messages: dict = {}
+submission_objects: dict = {}
 
 
 def main():

utilities/data_storage.py

@@ -28,7 +28,7 @@ def open_highscores_data():
             data = json.load(file)
     else:
         # create the json object
-        data = {"highscore_channel_id": -1, "verification_channel_id": -1}
+        data = {"highscore_channel_id": -1, "verification_channel_id": -1, "username_length": 12}
         config: dict = open_highscores_config()
         for boss, categories in config["highscore_table"].items():
             data[boss] = {"message_id": 0}

utilities/utils.py

@@ -21,7 +21,7 @@ def format_highscore_message(boss_name: str):
 
     # Gather all categories and add to string
     for key, value in boss_data["categories"].items():
-        ret_string += f"{key}".ljust(25, " ")
+        ret_string += f"{key}".ljust(26, " ")
     ret_string += "\n"
 
     highscore_size = highscores_config["highscore_size"]
@@ -30,10 +30,21 @@ def format_highscore_message(boss_name: str):
     for i in range(highscore_size):
         for key, value in boss_data["categories"].items():
             if len(value) > i:
-                score = value[i]
+                score_pair = value[i]
-                ret_string += f"{i+1}: {score[0]} - {score[1]}".ljust(25, " ")
+
+                # pad username to max length.
+                username: str = score_pair[0].ljust(highscores_data["username_length"], " ")
+                score: str = str(score_pair[1])
+
+                if highscores_config["categories"][key]["is_time_record"]:
+                    # pad score to correct length
+                    # MM:SS.ms is 7 characters long
+                    score = score.ljust(7, " ")
+
+                line_str = f"{i+1}: {username} - "
+                ret_string += line_str + score.rjust(26 - len(line_str) - 1) + " "
             else:
-                ret_string += f"{i+1}: submit your score".ljust(25, " ")
+                ret_string += f"{i+1}: submit your score".ljust(26, " ")
         ret_string += "\n"
 
     return ret_string + "```"
@@ -77,13 +88,6 @@ async def submit_score(
 
     boss_category_config = highscores_config["categories"][category]
 
-    # capping to 12 characters because runescape names are 12 characters long.
-    # Splitting on pipe. My discord has multiple names on account split by pipe.
-    user = user.split("|")[0][:12]
-
-    # strip leading zeros and colon from score
-    score = score.lstrip("0:")
-
     # create score tuple for either time or int
     # define sort index
     if boss_category_config["is_time_record"]: