Create delete-score command.

.gitignore

@@ -134,3 +134,4 @@ nextcord.log
 highscores_data.json
 highscores_message_map.json
 highscores_config.json
+deleted_backups/

cogs/delete_scores/__init__.py

@@ -0,0 +1,49 @@
+"""
+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.data_storage import save_highscores_data  # pylint: disable=import-error
+from utilities.data_storage import create_highscore_skeleton  # 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 registers current channel as for various uses.
+        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:
+            guild_data: dict = highscores_data[str(ctx.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
+
+            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 function to bot"""
+    bot.add_cog(DeleteScores(bot))

cogs/guild_listener/__init__.py

@@ -0,0 +1,54 @@
+"""
+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
+from utilities.data_storage import create_highscore_skeleton  # pylint: disable=import-error
+from utilities.data_storage import save_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[str(guild.id)] = create_highscore_skeleton()
+        save_highscores_data(highscores_data)
+
+        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}).")
+        old_data = highscores_data.pop(str(guild.id))
+        save_highscores_data(highscores_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))
+
+
+# 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/message_listener/__init__.py

@@ -2,11 +2,14 @@
 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_config  # pylint: disable=import-error
 from highscores import highscores_data  # pylint: disable=import-error
 from highscores import submission_objects  # pylint: disable=import-error
 
@@ -20,18 +23,53 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
     @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
+        guild_data = highscores_data[str(guild_id)]
         if message.author.id in submission_objects:
             message_id = submission_objects[message.author.id]["message_id"]
-            submission_message: nextcord.Message = await self.bot.get_channel(
+            submission_message: nextcord.Message = (
-                highscores_data["submission_channel_id"]
+                await self.bot.get_guild(guild_id)
-            ).fetch_message(message_id)
+                .get_channel(guild_data["submission_channel_id"])
+                .fetch_message(message_id)
+            )
 
             # need check if correct user and correct channel
-            if message.channel.id == highscores_data["submission_channel_id"]:
+            if message.channel.id == guild_data["submission_channel_id"]:
                 state = submission_objects[message.author.id]["submission_state"]
                 if state == SubmissionState.SCORE and message.content:
-                    submission_objects[message.author.id]["score"] = message.content
+
-                    embed = get_submission_embed(message.author.id)
+                    # 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]{1,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]
+                        embed.add_field(
+                            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,
                     )
@@ -41,7 +79,7 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
                     )
                 elif state == SubmissionState.NAME and message.content:
                     submission_objects[message.author.id]["username"] = message.content[
-                        : highscores_data["username_length"]
+                        : guild_data["username_length"]
                     ]
                     embed = get_submission_embed(message.author.id)
                     await submission_message.edit(

cogs/post_highscores/__init__.py

@@ -29,20 +29,22 @@ class PostHighscores(commands.Cog, name="Post Highscores"):
         ?post-scores
         ```
         """
-        highscore_channel_id = highscores_data["highscore_channel_id"]
+        guild_data = highscores_data[str(ctx.guild.id)]
+        highscore_channel_id = guild_data["highscore_channel_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. \n\
                 Register with "?register" command.'
         assert channel is not None, await ctx.send(error_response)
 
         for boss, categories in highscores_config[  # pylint: disable=unused-variable
-            "highscore_table"
+            "tables"
         ].items():
-            message: nextcord.Message = await send_highscore_message(channel, boss)
+            message: nextcord.Message = await send_highscore_message(channel, boss, guild_data)
             await message.edit(view=SubmissionCreateButton(self.bot))
 
+        # Saving in case new message was sent.
         save_highscores_data(highscores_data)
 
 

cogs/register/__init__.py

@@ -29,16 +29,17 @@ class RegisterVerificationChannel(commands.Cog, name="Register"):
         """
         # respond to the message
         channel_id = ctx.channel.id
+        guild_data = highscores_data[str(ctx.guild.id)]
 
         if registration_type == "verify":
             await ctx.send(f"Registered <#{channel_id}> as channel to post verifications in.")
-            highscores_data["verification_channel_id"] = channel_id
+            guild_data["verification_channel_id"] = channel_id
         elif registration_type == "highscore":
             await ctx.send(f"Registered <#{channel_id}> as channel to post highscores in.")
-            highscores_data["highscore_channel_id"] = channel_id
+            guild_data["highscore_channel_id"] = channel_id
         elif registration_type == "submission":
             await ctx.send(f"Registered <#{channel_id}> as channel to post submissions in.")
-            highscores_data["submission_channel_id"] = channel_id
+            guild_data["submission_channel_id"] = channel_id
         else:
             embed = Embed(
                 title="Register command help", description="How to use the register command."

cogs/score/__init__.py

@@ -5,7 +5,6 @@ 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
 
 
@@ -30,11 +29,12 @@ class Score(commands.Cog, name="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}"

cogs/submission/submission_views.py

@@ -7,8 +7,9 @@ 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_config  # pylint: disable=import-error
 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
 
@@ -55,9 +56,9 @@ def get_submission_embed(userid: int) -> nextcord.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]
+    category_list = highscores_config["tables"][boss_name]
-    for category in boss_dict["categories"].items():
+    for category in category_list:
-        options.append(nextcord.SelectOption(label=category[0]))
+        options.append(nextcord.SelectOption(label=category))
 
     return options
 
@@ -148,8 +149,10 @@ class SubmitButton(nextcord.ui.Button):
         self._bot = bot
 
     async def callback(self, interaction: nextcord.Interaction):
-        verification_channel_id = highscores_data["verification_channel_id"]
+        verification_channel_id = highscores_data[str(interaction.guild.id)][
-        channel = self._bot.get_channel(verification_channel_id)
+            "verification_channel_id"
+        ]
+        channel = interaction.guild.get_channel(verification_channel_id)
 
         error_response = "Registered Verification channel does not exist or was never registered. \
                 Contact server admins."
@@ -186,15 +189,15 @@ class SubmissionCreateButton(nextcord.ui.View):
         self, button: nextcord.ui.Button, interaction: nextcord.Interaction
     ):  # pylint: disable=unused-argument
         """Button for score submission."""
-        highscores_message_map = open_message_map()
+        guild_id_str = str(interaction.guild.id)
-        boss_name = highscores_message_map[str(interaction.message.id)]
+        guild_data = highscores_data[guild_id_str]
-        # embed = nextcord.Embed(title="Highscores Submission")
+
-        # embed.add_field(name="Boss", value=boss_name, inline=False)
+        boss_name = highscores_message_map[guild_id_str][interaction.message.id]
-        # embed.add_field(name="User", value=interaction.user.display_name, inline=False)
+        channel = interaction.guild.get_channel(guild_data["submission_channel_id"])
-        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,
@@ -202,7 +205,7 @@ class SubmissionCreateButton(nextcord.ui.View):
             "score": "",
             "category": "",
             "username": interaction.user.display_name.split("|")[0][
-                : highscores_data["username_length"]
+                : guild_data["username_length"]
             ],
         }
 

example_config/runescape_bosses.json

@@ -1,5 +1,5 @@
 {
-    "highscore_table": {
+    "tables": {
         "The Ambassador": [
             "Kill Count",
             "Kill Time",
@@ -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

@@ -11,7 +11,7 @@ from nextcord.ext import commands
 import config
 from utilities.data_storage import open_highscores_config
 from utilities.data_storage import open_highscores_data
-from utilities.data_storage import open_message_map
+from utilities.data_storage import create_message_map
 
 logger = logging.getLogger("nextcord")
 logger.setLevel(logging.DEBUG)
@@ -22,7 +22,7 @@ logger.addHandler(handler)
 
 highscores_config = open_highscores_config()
 highscores_data = open_highscores_data()
-highscores_message_map = open_message_map()
+highscores_message_map = create_message_map(highscores_data)
 
 submission_objects: dict = {}
 
@@ -35,7 +35,6 @@ def main():
 
     # Required in order to read messages (eg. prefix commands)
     intents.message_content = True  # pylint: disable=assigning-non-slot
-    intents.messages = True  # pylint: disable=assigning-non-slot
 
     # To enable the guilds priveleged intent:
     # intents.guilds = True

utilities/data_storage.py

@@ -5,7 +5,46 @@ import json
 
 HIGHSCORES_CONFIG_FILE = "highscores_config.json"
 HIGHSCORES_DATA_FILE = "highscores_data.json"
-HIGHSCORES_MESSAGE_MAP_FILE = "highscores_message_map.json"
+
+
+def create_highscore_skeleton() -> dict:
+    """
+    Creates a skeleton entry for new highscores data
+
+    @return: dict skeleton entry
+    """
+    # 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
+
+    return skeleton
+
+
+def create_message_map(data: dict):
+    """
+    Creates a message map from input highscores data.
+
+    @param data: highscores_data dict to create map from.
+    @return: dict message_map of message to boss.
+    """
+
+    message_map = {}
+
+    # guild id will be a string. Json object keys are strings.
+    for guild, guild_scores in data.items():
+        message_map[guild] = {}
+        for boss, info in guild_scores["tables"].items():
+            message_map[guild][info["message_id"]] = boss
+
+    return message_map
 
 
 def open_highscores_config():
@@ -20,53 +59,21 @@ def open_highscores_config():
 
 def open_highscores_data():
     """
-    Opens a highscores_data.json file if one exists, otherwise creates a skeleton of the 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:
-        # create the json object
+        data = {}
-        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}
-            boss_categories = {}
-            for category in categories:  # pylint: disable=unused-variable
-                rank_list = []
-                boss_categories[category] = rank_list
-            data[boss]["categories"] = boss_categories
     return data
 
 
-def open_message_map():
+def save_highscores_data(data: dict):
-    """
-    Opens a highscore_message_map.json file if one exists. Otherwise returns empty dict.
-    @return: dict message_map of message to boss.
-    """
-    if os.path.exists(HIGHSCORES_MESSAGE_MAP_FILE):
-        with open(HIGHSCORES_MESSAGE_MAP_FILE, encoding="utf-8", mode="r") as file:
-            message_map = json.load(file)
-    else:
-        # create the json object
-        message_map = {}
-    return message_map
-
-
-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))
-
-
-def save_message_map(message_map):
-    """
-    Saves the highscores message mao data dict into a json file.
-    @param map: dict map of message to boss.
-    """
-    with open(HIGHSCORES_MESSAGE_MAP_FILE, encoding="utf-8", mode="w") as file:
-        file.write(json.dumps(message_map, indent=4))

utilities/utils.py

@@ -7,17 +7,17 @@ from highscores import highscores_config  # pylint: disable=import-error
 from highscores import highscores_data  # pylint: disable=import-error
 from highscores import highscores_message_map  # pylint: disable=import-error
 from utilities.data_storage import save_highscores_data  # pylint: disable=import-error
-from utilities.data_storage import save_message_map  # pylint: disable=import-error
 
 
-def format_highscore_message(boss_name: str):
+def format_highscore_message(boss_name: str, guild_data: dict):
     """
     returns a formatted string for a boss's highscore
     @param boss: the dictionary object for the boss
+    @param guild_data: the guild's highscore data
     @return the formatted string
     """
     ret_string = f"**{boss_name}**\n```"
-    boss_data = highscores_data[boss_name]
+    boss_data = guild_data["tables"][boss_name]
 
     # Gather all categories and add to string
     for key, value in boss_data["categories"].items():
@@ -33,18 +33,14 @@ def format_highscore_message(boss_name: str):
                 score_pair = value[i]
 
                 # pad username to max length.
-                username: str = score_pair[0].ljust(highscores_data["username_length"], " ")
+                username: str = score_pair[0].ljust(guild_data["username_length"], " ")
                 score: str = str(score_pair[1])
 
-                # standardize time score format.
                 if highscores_config["categories"][key]["is_time_record"]:
-                    if score.find(":") == -1:
+                    # pad score to correct length
-                        score = "00:" + score
+                    # MM:SS.ms is 7 characters long
-                    elif len(score.split(":", maxsplit=1)[0]) < 2:
+                    score = score.ljust(7, " ")
-                        score = "0" + score
+
-                    if score.find(".") == -1:
-                        # insert 2 spaces to make up for period and ms
-                        score = score + "  "
                 line_str = f"{i+1}: {username} - "
                 ret_string += line_str + score.rjust(26 - len(line_str) - 1) + " "
             else:
@@ -54,16 +50,20 @@ def format_highscore_message(boss_name: str):
     return ret_string + "```"
 
 
-async def send_highscore_message(channel, boss_name: str) -> nextcord.Message:
+async def send_highscore_message(
+    channel: nextcord.TextChannel, boss_name: str, guild_data: dict
+) -> 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_data: the guild's highscore data
+    @return: The nextcord message
     """
-    highscore_string = format_highscore_message(boss_name)
+    highscore_string = format_highscore_message(boss_name, guild_data)
 
-    message_id = highscores_data[boss_name]["message_id"]
+    message_id = guild_data["tables"][boss_name]["message_id"]
     try:
         message: nextcord.Message = await channel.fetch_message(message_id)
         await message.edit(content=highscore_string)
@@ -71,10 +71,14 @@ async def send_highscore_message(channel, boss_name: str) -> nextcord.Message:
         # message doesn't exist.
         message: nextcord.Message = await channel.send(highscore_string)
         message_id = message.id
-        highscores_data[boss_name]["message_id"] = message_id
+        guild_data["tables"][boss_name]["message_id"] = message_id
         # save message -> boss_name in message_map
-        highscores_message_map[str(message_id)] = boss_name
+        # get guild id from channel
-        save_message_map(highscores_message_map)
+        # channel should come from the guild that is requesting this highscores message anyways.
+        # check if guild is in message map already
+        if not str(channel.guild.id) in highscores_message_map:
+            highscores_message_map[str(channel.guild.id)] = {}
+        highscores_message_map[str(channel.guild.id)][message_id] = boss_name
 
     return message
 
@@ -91,13 +95,7 @@ async def submit_score(
     """
 
     boss_category_config = highscores_config["categories"][category]
-
+    guild_data = highscores_data[str(interaction.guild.id)]
-    # Splitting on pipe. My discord has multiple names on account split by pipe.
-    # cap length to data defined length.
-    user = user.split("|")[0][: highscores_data["username_length"]]
-
-    # strip leading zeros and colon from score
-    score = score.lstrip("0:")
 
     # create score tuple for either time or int
     # define sort index
@@ -115,7 +113,7 @@ async def submit_score(
         score_tuple = (user, int(score))
         sort_index = 1
 
-    scores: "list[tuple]" = highscores_data[boss_name]["categories"][category]
+    scores: "list[tuple]" = guild_data["tables"][boss_name]["categories"][category]
 
     # if user is in an existing tuple, delete it.
     users_scores: "list[tuple]" = [score_tuple]
@@ -149,18 +147,19 @@ async def submit_score(
     # enforce highscore size
     while len(scores) > highscores_config["highscore_size"]:
         scores.pop()
-    highscores_data[boss_name]["categories"][category] = scores
+    guild_data["tables"][boss_name]["categories"][category] = scores
 
     # edit message
-    highscore_channel_id = highscores_data["highscore_channel_id"]
+    highscore_channel_id = guild_data["highscore_channel_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, ephemeral=True)
 
-    await send_highscore_message(channel, boss_name)
+    await send_highscore_message(channel, boss_name, guild_data)
 
     # save data
+    highscores_data[str(interaction.guild.id)] = guild_data
     save_highscores_data(highscores_data)